-
-
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+
1.7.5.1
+ - Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:50 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- File List -
- File Members + - + + +
- Generated on Tue Oct 4 2011 14:38:50 for VampPluginSDK by
+
+ 1.7.5.1
+
- Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- Class List -
- Class Hierarchy -
- Class Members +
- Generated on Tue Oct 4 2011 14:38:50 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- Class List -
- Class Hierarchy -
- Class Members +
- Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- Class List -
- Class Hierarchy -
- Class Members +
- Enumerator:
-
-
-
TimeDomain + - Definition at line 152 of file vamp-sdk/Plugin.h.
+Definition at line 152 of file vamp-sdk/Plugin.h.
--
Constructor & Destructor Documentation
- + +Constructor & Destructor Documentation
+- AmplitudeFollower::AmplitudeFollower +AmplitudeFollower::AmplitudeFollower ( -float -inputSampleRate -) +float +inputSampleRate ) ---An implementation of SuperCollider's amplitude-follower algorithm as a simple Vamp plugin. -
+
An implementation of SuperCollider's amplitude-follower algorithm as a simple Vamp plugin.
-Definition at line 55 of file AmplitudeFollower.cpp.
+Definition at line 55 of file AmplitudeFollower.cpp.
- AmplitudeFollower::~AmplitudeFollower +AmplitudeFollower::~AmplitudeFollower ( -) +) [virtual]--- -
Definition at line 64 of file AmplitudeFollower.cpp.
+Definition at line 64 of file AmplitudeFollower.cpp.
-
Member Function Documentation
- + +Member Function Documentation
+- bool AmplitudeFollower::initialise +bool AmplitudeFollower::initialise ( -size_t -inputChannels, +size_t +inputChannels, - size_t -stepSize, +size_t +stepSize, - size_t -blockSize size_t +blockSize ) -[virtual][virtual]---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). -
-The input sample rate should have been already specified at construction time.
-Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. -
Implements Vamp::Plugin.
+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).
+The input sample rate should have been already specified at construction time.
+Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
-Definition at line 105 of file AmplitudeFollower.cpp.
+Implements Vamp::Plugin.
-References Vamp::Plugin::getMaxChannelCount(), Vamp::Plugin::getMinChannelCount(), m_clampcoef, Vamp::Plugin::m_inputSampleRate, m_relaxcoef, and m_stepSize.
+Definition at line 105 of file AmplitudeFollower.cpp.
+ +References Vamp::Plugin::getMaxChannelCount(), Vamp::Plugin::getMinChannelCount(), m_clampcoef, Vamp::Plugin::m_inputSampleRate, m_relaxcoef, and m_stepSize.
- void AmplitudeFollower::reset +void AmplitudeFollower::reset ( -) +) [virtual]---Reset the plugin after use, to prepare it for another clean run. -
-Not called for the first initialisation (i.e. initialise must also do a reset). -
Implements Vamp::Plugin.
+Reset the plugin after use, to prepare it for another clean run.
+Not called for the first initialisation (i.e. initialise must also do a reset).
-Definition at line 122 of file AmplitudeFollower.cpp.
+Implements Vamp::Plugin.
-References m_previn.
+Definition at line 122 of file AmplitudeFollower.cpp.
+ +References m_previn.
- InputDomain AmplitudeFollower::getInputDomain +InputDomain AmplitudeFollower::getInputDomain ( -) +) const [inline, virtual]---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. -
Implements Vamp::Plugin.
+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.
-Definition at line 56 of file AmplitudeFollower.h.
+Implements Vamp::Plugin.
-References Vamp::Plugin::TimeDomain.
+Definition at line 56 of file AmplitudeFollower.h.
+ +References Vamp::Plugin::TimeDomain.
- string AmplitudeFollower::getIdentifier +string AmplitudeFollower::getIdentifier ( -) +) const [virtual]---Get the computer-usable name of the plugin. -
-This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.
-This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).
-Example: "zero_crossings" -
Implements Vamp::PluginBase.
+Get the computer-usable name of the plugin.
+This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.
+This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).
+Example: "zero_crossings"
-Definition at line 69 of file AmplitudeFollower.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 69 of file AmplitudeFollower.cpp.
- string AmplitudeFollower::getName +string AmplitudeFollower::getName ( -) +) const [virtual]---Get a human-readable name or title of the plugin. -
-This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").
-Example: "Zero Crossings" -
Implements Vamp::PluginBase.
+Get a human-readable name or title of the plugin.
+This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").
+Example: "Zero Crossings"
-Definition at line 75 of file AmplitudeFollower.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 75 of file AmplitudeFollower.cpp.
- string AmplitudeFollower::getDescription +string AmplitudeFollower::getDescription ( -) +) const [virtual]---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". -
-May be empty if the name has said it all already.
-Example: "Detect and count zero crossing points" -
Implements Vamp::PluginBase.
+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".
+May be empty if the name has said it all already.
+Example: "Detect and count zero crossing points"
-Definition at line 81 of file AmplitudeFollower.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 81 of file AmplitudeFollower.cpp.
- string AmplitudeFollower::getMaker +string AmplitudeFollower::getMaker ( -) +) const [virtual]---Get the name of the author or vendor of the plugin in human-readable form. -
-This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. -
Implements Vamp::PluginBase.
+Get the name of the author or vendor of the plugin in human-readable form.
+This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar.
-Definition at line 87 of file AmplitudeFollower.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 87 of file AmplitudeFollower.cpp.
- int AmplitudeFollower::getPluginVersion +int AmplitudeFollower::getPluginVersion ( -) +) const [virtual]---Get the version number of the plugin. -
+
Get the version number of the plugin.
-Implements Vamp::PluginBase.
+Implements Vamp::PluginBase.
-Definition at line 93 of file AmplitudeFollower.cpp.
+Definition at line 93 of file AmplitudeFollower.cpp.
- string AmplitudeFollower::getCopyright +string AmplitudeFollower::getCopyright ( -) +) const [virtual]---Get the copyright statement or licensing summary for the plugin. -
-This can be an informative text, without the same presentation constraints as mentioned for getMaker above. -
Implements Vamp::PluginBase.
+Get the copyright statement or licensing summary for the plugin.
+This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
-Definition at line 99 of file AmplitudeFollower.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 99 of file AmplitudeFollower.cpp.
- AmplitudeFollower::OutputList AmplitudeFollower::getOutputDescriptors +AmplitudeFollower::OutputList AmplitudeFollower::getOutputDescriptors ( -) +) const [virtual]---Get the outputs of this plugin. -
-An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the process() call. -
Implements Vamp::Plugin.
+Get the outputs of this plugin.
+An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the process() call.
-Definition at line 128 of file AmplitudeFollower.cpp.
+Implements Vamp::Plugin.
-References Vamp::Plugin::Plugin::OutputDescriptor::binCount, Vamp::Plugin::Plugin::OutputDescriptor::description, Vamp::Plugin::Plugin::OutputDescriptor::hasFixedBinCount, Vamp::Plugin::Plugin::OutputDescriptor::hasKnownExtents, Vamp::Plugin::Plugin::OutputDescriptor::identifier, Vamp::Plugin::Plugin::OutputDescriptor::isQuantized, Vamp::Plugin::Plugin::OutputDescriptor::name, Vamp::Plugin::Plugin::OutputDescriptor::OneSamplePerStep, Vamp::Plugin::Plugin::OutputDescriptor::sampleType, and Vamp::Plugin::Plugin::OutputDescriptor::unit.
+Definition at line 128 of file AmplitudeFollower.cpp.
+ +References Vamp::Plugin::OutputDescriptor::binCount, Vamp::Plugin::OutputDescriptor::description, Vamp::Plugin::OutputDescriptor::hasFixedBinCount, Vamp::Plugin::OutputDescriptor::hasKnownExtents, Vamp::Plugin::OutputDescriptor::identifier, Vamp::Plugin::OutputDescriptor::isQuantized, Vamp::Plugin::OutputDescriptor::name, Vamp::Plugin::OutputDescriptor::OneSamplePerStep, Vamp::Plugin::OutputDescriptor::sampleType, and Vamp::Plugin::OutputDescriptor::unit.
- AmplitudeFollower::ParameterList AmplitudeFollower::getParameterDescriptors +AmplitudeFollower::ParameterList AmplitudeFollower::getParameterDescriptors ( -) +) const [virtual]---Get the controllable parameters of this plugin. -
+
Get the controllable parameters of this plugin.
-Reimplemented from Vamp::PluginBase.
+Reimplemented from Vamp::PluginBase.
-Definition at line 148 of file AmplitudeFollower.cpp.
+Definition at line 148 of file AmplitudeFollower.cpp.
-References Vamp::PluginBase::PluginBase::ParameterDescriptor::defaultValue, Vamp::PluginBase::PluginBase::ParameterDescriptor::description, Vamp::PluginBase::PluginBase::ParameterDescriptor::identifier, Vamp::PluginBase::PluginBase::ParameterDescriptor::isQuantized, Vamp::PluginBase::PluginBase::ParameterDescriptor::maxValue, Vamp::PluginBase::PluginBase::ParameterDescriptor::minValue, Vamp::PluginBase::PluginBase::ParameterDescriptor::name, and Vamp::PluginBase::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.
- float AmplitudeFollower::getParameter +float AmplitudeFollower::getParameter ( -std::string -) +std::string +) const [virtual]---Get the value of a named parameter. -
-The argument is the identifier field from that parameter's descriptor. -
Reimplemented from Vamp::PluginBase.
+Get the value of a named parameter.
+The argument is the identifier field from that parameter's descriptor.
-Definition at line 188 of file AmplitudeFollower.cpp.
+Reimplemented from Vamp::PluginBase.
-References m_clampcoef, and m_relaxcoef.
+Definition at line 188 of file AmplitudeFollower.cpp.
+ +References m_clampcoef, and m_relaxcoef.
- void AmplitudeFollower::setParameter +void AmplitudeFollower::setParameter ( -std::string +std::string , - float -float +) -[virtual][virtual]---Set a named parameter. -
-The first argument is the identifier field from that parameter's descriptor. -
Reimplemented from Vamp::PluginBase.
+Set a named parameter.
+The first argument is the identifier field from that parameter's descriptor.
-Definition at line 179 of file AmplitudeFollower.cpp.
+Reimplemented from Vamp::PluginBase.
-References m_clampcoef, and m_relaxcoef.
+Definition at line 179 of file AmplitudeFollower.cpp.
+ +References m_clampcoef, and m_relaxcoef.
- AmplitudeFollower::FeatureSet AmplitudeFollower::process +AmplitudeFollower::FeatureSet AmplitudeFollower::process ( -const float *const * -inputBuffers, +const float *const * +inputBuffers, - Vamp::RealTime -timestamp Vamp::RealTime +timestamp ) -[virtual][virtual]---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).
-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.
+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).
+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.)
-Definition at line 200 of file AmplitudeFollower.cpp.
+Implements Vamp::Plugin.
-References Vamp::Plugin::Plugin::Feature::hasTimestamp, m_clampcoef, m_previn, m_relaxcoef, m_stepSize, and Vamp::Plugin::Plugin::Feature::values.
+Definition at line 200 of file AmplitudeFollower.cpp.
+ +References Vamp::Plugin::Feature::hasTimestamp, m_clampcoef, m_previn, m_relaxcoef, m_stepSize, and Vamp::Plugin::Feature::values.
- AmplitudeFollower::FeatureSet AmplitudeFollower::getRemainingFeatures +AmplitudeFollower::FeatureSet AmplitudeFollower::getRemainingFeatures ( -) +) [virtual]---After all blocks have been processed, calculate and return any remaining features derived from the complete input. -
+
After all blocks have been processed, calculate and return any remaining features derived from the complete input.
-Implements Vamp::Plugin.
+Implements Vamp::Plugin.
-Definition at line 243 of file AmplitudeFollower.cpp.
+Definition at line 243 of file AmplitudeFollower.cpp.
- virtual size_t Vamp::Plugin::getPreferredBlockSize +virtual size_t Vamp::Plugin::getPreferredBlockSize ( -) +) const [inline, virtual, inherited]---Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function). -
-This should be called before initialise().
-A plugin that can handle any block size may return 0. The final block size will be set in the initialise() call. -
Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, Vamp::HostExt::PluginInputDomainAdapter, Vamp::HostExt::PluginWrapper, FixedTempoEstimator, and PercussionOnsetDetector.
+Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
+This should be called before initialise().
+A plugin that can handle any block size may return 0. The final block size will be set in the initialise() call.
-Definition at line 179 of file vamp-sdk/Plugin.h.
+Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::HostExt::PluginInputDomainAdapter, Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, FixedTempoEstimator, and PercussionOnsetDetector.
-Referenced by enumeratePlugins(), and runPlugin().
+Definition at line 179 of file vamp-sdk/Plugin.h.
+ +Referenced by enumeratePlugins(), and runPlugin().
- virtual size_t Vamp::Plugin::getPreferredStepSize +virtual size_t Vamp::Plugin::getPreferredStepSize ( -) +) const [inline, virtual, inherited]---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. -
-This should be called before initialise().
-A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the initialise() call. -
Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, Vamp::HostExt::PluginInputDomainAdapter, Vamp::HostExt::PluginWrapper, FixedTempoEstimator, and PercussionOnsetDetector.
+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.
+This should be called before initialise().
+A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the initialise() call.
-Definition at line 194 of file vamp-sdk/Plugin.h.
+Reimplemented in Vamp::HostExt::PluginInputDomainAdapter, Vamp::PluginHostAdapter, Vamp::HostExt::PluginBufferingAdapter, Vamp::HostExt::PluginWrapper, FixedTempoEstimator, and PercussionOnsetDetector.
-Referenced by enumeratePlugins(), and runPlugin().
+Definition at line 194 of file vamp-sdk/Plugin.h.
+ +Referenced by enumeratePlugins(), and runPlugin().
- virtual size_t Vamp::Plugin::getMinChannelCount +virtual size_t Vamp::Plugin::getMinChannelCount ( -) +) const [inline, virtual, inherited]---Get the minimum supported number of input channels. -
+
Get the minimum supported number of input channels.
-Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
-Definition at line 199 of file vamp-sdk/Plugin.h.
+Definition at line 199 of file vamp-sdk/Plugin.h.
-Referenced by enumeratePlugins(), ZeroCrossing::initialise(), SpectralCentroid::initialise(), PowerSpectrum::initialise(), PercussionOnsetDetector::initialise(), FixedTempoEstimator::initialise(), initialise(), and runPlugin().
+Referenced by enumeratePlugins(), FixedTempoEstimator::initialise(), PercussionOnsetDetector::initialise(), initialise(), SpectralCentroid::initialise(), ZeroCrossing::initialise(), PowerSpectrum::initialise(), and runPlugin().
- virtual size_t Vamp::Plugin::getMaxChannelCount +virtual size_t Vamp::Plugin::getMaxChannelCount ( -) +) const [inline, virtual, inherited]---Get the maximum supported number of input channels. -
+
Get the maximum supported number of input channels.
-Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
-Definition at line 204 of file vamp-sdk/Plugin.h.
+Definition at line 204 of file vamp-sdk/Plugin.h.
-Referenced by enumeratePlugins(), ZeroCrossing::initialise(), SpectralCentroid::initialise(), PowerSpectrum::initialise(), PercussionOnsetDetector::initialise(), FixedTempoEstimator::initialise(), initialise(), and runPlugin().
+Referenced by enumeratePlugins(), FixedTempoEstimator::initialise(), PercussionOnsetDetector::initialise(), initialise(), SpectralCentroid::initialise(), ZeroCrossing::initialise(), PowerSpectrum::initialise(), and runPlugin().
- virtual std::string Vamp::Plugin::getType +virtual std::string Vamp::Plugin::getType ( -) +) const [inline, virtual, inherited]---Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase. -
-Do not reimplement this function in your subclass. -
Implements Vamp::PluginBase.
+Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
+Do not reimplement this function in your subclass.
-Definition at line 430 of file vamp-sdk/Plugin.h.
+Implements Vamp::PluginBase.
+ +Definition at line 430 of file vamp-sdk/Plugin.h.
- virtual unsigned int Vamp::PluginBase::getVampApiVersion +virtual unsigned int Vamp::PluginBase::getVampApiVersion ( -) +) const [inline, virtual, inherited]---Get the Vamp API compatibility level of the plugin. -
+
Get the Vamp API compatibility level of the plugin.
-Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
-Definition at line 72 of file vamp-sdk/PluginBase.h.
+Definition at line 72 of file vamp-sdk/PluginBase.h.
-Referenced by enumeratePlugins().
+Referenced by enumeratePlugins().
- virtual ProgramList Vamp::PluginBase::getPrograms +virtual ProgramList Vamp::PluginBase::getPrograms ( -) +) const [inline, virtual, inherited]---Get the program settings available in this plugin. -
-A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.
-The programs must have unique names. -
Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Get the program settings available in this plugin.
+A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.
+The programs must have unique names.
-Definition at line 237 of file vamp-sdk/PluginBase.h.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+ +Definition at line 237 of file vamp-sdk/PluginBase.h.
- virtual std::string Vamp::PluginBase::getCurrentProgram +virtual std::string Vamp::PluginBase::getCurrentProgram ( -) +) const [inline, virtual, inherited]---Get the current program. -
+
Get the current program.
-Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
-Definition at line 242 of file vamp-sdk/PluginBase.h.
+Definition at line 242 of file vamp-sdk/PluginBase.h.
- virtual void Vamp::PluginBase::selectProgram +virtual void Vamp::PluginBase::selectProgram ( -std::string -) +std::string +) [inline, virtual, inherited]---Select a program. -
-(If the given program name is not one of the available programs, do nothing.) -
Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Select a program.
+(If the given program name is not one of the available programs, do nothing.)
-Definition at line 248 of file vamp-sdk/PluginBase.h.
+Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+ +Definition at line 248 of file vamp-sdk/PluginBase.h.
-
Member Data Documentation
- + +Member Data Documentation
+- size_t AmplitudeFollower::m_stepSize +[protected]size_t AmplitudeFollower::m_stepSize [protected]--+
Definition at line 77 of file AmplitudeFollower.h.
-Definition at line 77 of file AmplitudeFollower.h.
- -Referenced by initialise(), and process().
+Referenced by initialise(), and process().
- float AmplitudeFollower::m_previn +[protected]float AmplitudeFollower::m_previn [protected]--+
Definition at line 78 of file AmplitudeFollower.h.
-Definition at line 78 of file AmplitudeFollower.h.
- - +- float AmplitudeFollower::m_clampcoef +[protected]float AmplitudeFollower::m_clampcoef [protected]--+
Definition at line 79 of file AmplitudeFollower.h.
-Definition at line 79 of file AmplitudeFollower.h.
- -Referenced by getParameter(), initialise(), process(), and setParameter().
+Referenced by getParameter(), initialise(), process(), and setParameter().
- float AmplitudeFollower::m_relaxcoef +[protected]float AmplitudeFollower::m_relaxcoef [protected]--+
Definition at line 80 of file AmplitudeFollower.h.
-Definition at line 80 of file AmplitudeFollower.h.
- -Referenced by getParameter(), initialise(), process(), and setParameter().
+Referenced by getParameter(), initialise(), process(), and setParameter().
- float Vamp::Plugin::m_inputSampleRate +[protected, inherited]float Vamp::Plugin::m_inputSampleRate [protected, inherited]--+
Definition at line 436 of file vamp-sdk/Plugin.h.
-Definition at line 436 of file vamp-sdk/Plugin.h.
- -Referenced by ZeroCrossing::getOutputDescriptors(), PercussionOnsetDetector::getOutputDescriptors(), initialise(), ZeroCrossing::process(), SpectralCentroid::process(), and PercussionOnsetDetector::process().
+Referenced by FixedTempoEstimator::D::assembleFeatures(), FixedTempoEstimator::D::calculate(), FixedTempoEstimator::D::getOutputDescriptors(), ZeroCrossing::getOutputDescriptors(), PercussionOnsetDetector::getOutputDescriptors(), initialise(), FixedTempoEstimator::D::initialise(), FixedTempoEstimator::D::lag2tempo(), SpectralCentroid::process(), ZeroCrossing::process(), PercussionOnsetDetector::process(), and FixedTempoEstimator::D::tempo2lag().
-
The documentation for this class was generated from the following files: -
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - - 1.5.8
+
The documentation for this class was generated from the following files: + + +++ + diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classAmplitudeFollower__inherit__graph.map --- a/code-doc/classAmplitudeFollower__inherit__graph.map Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classAmplitudeFollower__inherit__graph.map Tue Oct 04 13:47:23 2011 +0000 @@ -1,2 +1,4 @@ - - + diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classAmplitudeFollower__inherit__graph.md5 --- a/code-doc/classAmplitudeFollower__inherit__graph.md5 Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classAmplitudeFollower__inherit__graph.md5 Tue Oct 04 13:47:23 2011 +0000 @@ -1,1 +1,1 @@ -287616fc7db89a55da22ac4b6d5aa5fe \ No newline at end of file +378861f0015413e8059212a2b0322a82 \ No newline at end of file diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classAmplitudeFollower__inherit__graph.png Binary file code-doc/classAmplitudeFollower__inherit__graph.png has changed diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classFixedTempoEstimator-members.html --- a/code-doc/classFixedTempoEstimator-members.html Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classFixedTempoEstimator-members.html Tue Oct 04 13:47:23 2011 +0000 @@ -1,72 +1,132 @@ - - + + + +-
+
+
+
- Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
+
+ 1.7.5.1
+
VampPluginSDK: Member List - - - - ----
-
- Main Page + + + + + + + + + + + + +
- Class List -
- Class Hierarchy -
- Class Members +
- Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- Class List -
- Class Hierarchy -
- Class Members +
- Enumerator:
-
-
-
TimeDomain + - Definition at line 152 of file vamp-sdk/Plugin.h.
+Definition at line 152 of file vamp-sdk/Plugin.h.
--
Constructor & Destructor Documentation
- + +Constructor & Destructor Documentation
+- FixedTempoEstimator::FixedTempoEstimator +FixedTempoEstimator::FixedTempoEstimator ( -float -inputSampleRate -) +float +inputSampleRate ) --- -
Definition at line 616 of file FixedTempoEstimator.cpp.
+Definition at line 617 of file FixedTempoEstimator.cpp.
- FixedTempoEstimator::~FixedTempoEstimator +FixedTempoEstimator::~FixedTempoEstimator ( -) +) [virtual]--+
Definition at line 623 of file FixedTempoEstimator.cpp.
-Definition at line 622 of file FixedTempoEstimator.cpp.
- -References m_d.
+References m_d.
-
Member Function Documentation
- + +Member Function Documentation
+- bool FixedTempoEstimator::initialise +bool FixedTempoEstimator::initialise ( -size_t -inputChannels, +size_t +inputChannels, - size_t -stepSize, +size_t +stepSize, - size_t -blockSize size_t +blockSize ) -[virtual][virtual]---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). -
-The input sample rate should have been already specified at construction time.
-Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. -
Implements Vamp::Plugin.
+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).
+The input sample rate should have been already specified at construction time.
+Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
-Definition at line 676 of file FixedTempoEstimator.cpp.
+Implements Vamp::Plugin.
-References Vamp::Plugin::getMaxChannelCount(), Vamp::Plugin::getMinChannelCount(), FixedTempoEstimator::FixedTempoEstimator::D::initialise(), and m_d.
+Definition at line 677 of file FixedTempoEstimator.cpp.
+ +References Vamp::Plugin::getMaxChannelCount(), Vamp::Plugin::getMinChannelCount(), FixedTempoEstimator::D::initialise(), and m_d.
- void FixedTempoEstimator::reset +void FixedTempoEstimator::reset ( -) +) [virtual]---Reset the plugin after use, to prepare it for another clean run. -
-Not called for the first initialisation (i.e. initialise must also do a reset). -
Implements Vamp::Plugin.
+Reset the plugin after use, to prepare it for another clean run.
+Not called for the first initialisation (i.e. initialise must also do a reset).
-Definition at line 685 of file FixedTempoEstimator.cpp.
+Implements Vamp::Plugin.
-References m_d, and FixedTempoEstimator::FixedTempoEstimator::D::reset().
+Definition at line 686 of file FixedTempoEstimator.cpp.
+ +References m_d, and FixedTempoEstimator::D::reset().
- InputDomain FixedTempoEstimator::getInputDomain +InputDomain FixedTempoEstimator::getInputDomain ( -) +) const [inline, virtual]---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. -
Implements Vamp::Plugin.
+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.
-Definition at line 55 of file FixedTempoEstimator.h.
+Implements Vamp::Plugin.
-References Vamp::Plugin::FrequencyDomain.
+Definition at line 55 of file FixedTempoEstimator.h.
+ +References Vamp::Plugin::FrequencyDomain.
- string FixedTempoEstimator::getIdentifier +string FixedTempoEstimator::getIdentifier ( -) +) const [virtual]---Get the computer-usable name of the plugin. -
-This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.
-This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).
-Example: "zero_crossings" -
Implements Vamp::PluginBase.
+Get the computer-usable name of the plugin.
+This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.
+This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).
+Example: "zero_crossings"
-Definition at line 628 of file FixedTempoEstimator.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 629 of file FixedTempoEstimator.cpp.
- string FixedTempoEstimator::getName +string FixedTempoEstimator::getName ( -) +) const [virtual]---Get a human-readable name or title of the plugin. -
-This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").
-Example: "Zero Crossings" -
Implements Vamp::PluginBase.
+Get a human-readable name or title of the plugin.
+This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").
+Example: "Zero Crossings"
-Definition at line 634 of file FixedTempoEstimator.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 635 of file FixedTempoEstimator.cpp.
- string FixedTempoEstimator::getDescription +string FixedTempoEstimator::getDescription ( -) +) const [virtual]---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". -
-May be empty if the name has said it all already.
-Example: "Detect and count zero crossing points" -
Implements Vamp::PluginBase.
+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".
+May be empty if the name has said it all already.
+Example: "Detect and count zero crossing points"
-Definition at line 640 of file FixedTempoEstimator.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 641 of file FixedTempoEstimator.cpp.
- string FixedTempoEstimator::getMaker +string FixedTempoEstimator::getMaker ( -) +) const [virtual]---Get the name of the author or vendor of the plugin in human-readable form. -
-This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. -
Implements Vamp::PluginBase.
+Get the name of the author or vendor of the plugin in human-readable form.
+This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar.
-Definition at line 646 of file FixedTempoEstimator.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 647 of file FixedTempoEstimator.cpp.
- int FixedTempoEstimator::getPluginVersion +int FixedTempoEstimator::getPluginVersion ( -) +) const [virtual]---Get the version number of the plugin. -
+
Get the version number of the plugin.
-Implements Vamp::PluginBase.
+Implements Vamp::PluginBase.
-Definition at line 652 of file FixedTempoEstimator.cpp.
+Definition at line 653 of file FixedTempoEstimator.cpp.
- string FixedTempoEstimator::getCopyright +string FixedTempoEstimator::getCopyright ( -) +) const [virtual]---Get the copyright statement or licensing summary for the plugin. -
-This can be an informative text, without the same presentation constraints as mentioned for getMaker above. -
Implements Vamp::PluginBase.
+Get the copyright statement or licensing summary for the plugin.
+This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
-Definition at line 658 of file FixedTempoEstimator.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 659 of file FixedTempoEstimator.cpp.
- size_t FixedTempoEstimator::getPreferredStepSize +size_t FixedTempoEstimator::getPreferredStepSize ( -) +) const [virtual]---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. -
-This should be called before initialise().
-A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the initialise() call. -
Reimplemented from Vamp::Plugin.
+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.
+This should be called before initialise().
+A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the initialise() call.
-Definition at line 664 of file FixedTempoEstimator.cpp.
+Reimplemented from Vamp::Plugin.
-References FixedTempoEstimator::FixedTempoEstimator::D::getPreferredStepSize(), and m_d.
+Definition at line 665 of file FixedTempoEstimator.cpp.
+ +References FixedTempoEstimator::D::getPreferredStepSize(), and m_d.
- size_t FixedTempoEstimator::getPreferredBlockSize +size_t FixedTempoEstimator::getPreferredBlockSize ( -) +) const [virtual]---Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function). -
-This should be called before initialise().
-A plugin that can handle any block size may return 0. The final block size will be set in the initialise() call. -
Reimplemented from Vamp::Plugin.
+Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
+This should be called before initialise().
+A plugin that can handle any block size may return 0. The final block size will be set in the initialise() call.
-Definition at line 670 of file FixedTempoEstimator.cpp.
+Reimplemented from Vamp::Plugin.
-References FixedTempoEstimator::FixedTempoEstimator::D::getPreferredBlockSize(), and m_d.
+Definition at line 671 of file FixedTempoEstimator.cpp.
+ +References FixedTempoEstimator::D::getPreferredBlockSize(), and m_d.
+ +Referenced by FixedTempoEstimator::D::getOutputDescriptors().
- FixedTempoEstimator::ParameterList FixedTempoEstimator::getParameterDescriptors +FixedTempoEstimator::ParameterList FixedTempoEstimator::getParameterDescriptors ( -) +) const [virtual]---Get the controllable parameters of this plugin. -
+
Get the controllable parameters of this plugin.
-Reimplemented from Vamp::PluginBase.
+Reimplemented from Vamp::PluginBase.
-Definition at line 691 of file FixedTempoEstimator.cpp.
+Definition at line 692 of file FixedTempoEstimator.cpp.
-References FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors(), and m_d.
+References FixedTempoEstimator::D::getParameterDescriptors(), and m_d.
- float FixedTempoEstimator::getParameter +float FixedTempoEstimator::getParameter ( -std::string -) +std::string +) const [virtual]---Get the value of a named parameter. -
-The argument is the identifier field from that parameter's descriptor. -
Reimplemented from Vamp::PluginBase.
+Get the value of a named parameter.
+The argument is the identifier field from that parameter's descriptor.
-Definition at line 697 of file FixedTempoEstimator.cpp.
+Reimplemented from Vamp::PluginBase.
-References FixedTempoEstimator::FixedTempoEstimator::D::getParameter(), and m_d.
+Definition at line 698 of file FixedTempoEstimator.cpp.
+ +References FixedTempoEstimator::D::getParameter(), and m_d.
- void FixedTempoEstimator::setParameter +void FixedTempoEstimator::setParameter ( -std::string +std::string , - float -float +) -[virtual][virtual]---Set a named parameter. -
-The first argument is the identifier field from that parameter's descriptor. -
Reimplemented from Vamp::PluginBase.
+Set a named parameter.
+The first argument is the identifier field from that parameter's descriptor.
-Definition at line 703 of file FixedTempoEstimator.cpp.
+Reimplemented from Vamp::PluginBase.
-References m_d, and FixedTempoEstimator::FixedTempoEstimator::D::setParameter().
+Definition at line 704 of file FixedTempoEstimator.cpp.
+ +References m_d, and FixedTempoEstimator::D::setParameter().
- FixedTempoEstimator::OutputList FixedTempoEstimator::getOutputDescriptors +FixedTempoEstimator::OutputList FixedTempoEstimator::getOutputDescriptors ( -) +) const [virtual]---Get the outputs of this plugin. -
-An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the process() call. -
Implements Vamp::Plugin.
+Get the outputs of this plugin.
+An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the process() call.
-Definition at line 709 of file FixedTempoEstimator.cpp.
+Implements Vamp::Plugin.
-References FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors(), and m_d.
+Definition at line 710 of file FixedTempoEstimator.cpp.
+ +References FixedTempoEstimator::D::getOutputDescriptors(), and m_d.
- FixedTempoEstimator::FeatureSet FixedTempoEstimator::process +FixedTempoEstimator::FeatureSet FixedTempoEstimator::process ( -const float *const * -inputBuffers, +const float *const * +inputBuffers, - Vamp::RealTime -timestamp Vamp::RealTime +timestamp ) -[virtual][virtual]---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).
-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.
+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).
+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.)
-Definition at line 715 of file FixedTempoEstimator.cpp.
+Implements Vamp::Plugin.
-References m_d, and FixedTempoEstimator::FixedTempoEstimator::D::process().
+Definition at line 716 of file FixedTempoEstimator.cpp.
+ +References m_d, and FixedTempoEstimator::D::process().
- FixedTempoEstimator::FeatureSet FixedTempoEstimator::getRemainingFeatures +FixedTempoEstimator::FeatureSet FixedTempoEstimator::getRemainingFeatures ( -) +) [virtual]---After all blocks have been processed, calculate and return any remaining features derived from the complete input. -
+
After all blocks have been processed, calculate and return any remaining features derived from the complete input.
-Implements Vamp::Plugin.
+Implements Vamp::Plugin.
-Definition at line 721 of file FixedTempoEstimator.cpp.
+Definition at line 722 of file FixedTempoEstimator.cpp.
-References FixedTempoEstimator::FixedTempoEstimator::D::getRemainingFeatures(), and m_d.
+References FixedTempoEstimator::D::getRemainingFeatures(), and m_d.
- virtual size_t Vamp::Plugin::getMinChannelCount +virtual size_t Vamp::Plugin::getMinChannelCount ( -) +) const [inline, virtual, inherited]---Get the minimum supported number of input channels. -
+
Get the minimum supported number of input channels.
-Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
-Definition at line 199 of file vamp-sdk/Plugin.h.
+Definition at line 199 of file vamp-sdk/Plugin.h.
-Referenced by enumeratePlugins(), ZeroCrossing::initialise(), SpectralCentroid::initialise(), PowerSpectrum::initialise(), PercussionOnsetDetector::initialise(), initialise(), AmplitudeFollower::initialise(), and runPlugin().
+Referenced by enumeratePlugins(), initialise(), PercussionOnsetDetector::initialise(), AmplitudeFollower::initialise(), SpectralCentroid::initialise(), ZeroCrossing::initialise(), PowerSpectrum::initialise(), and runPlugin().
- virtual size_t Vamp::Plugin::getMaxChannelCount +virtual size_t Vamp::Plugin::getMaxChannelCount ( -) +) const [inline, virtual, inherited]---Get the maximum supported number of input channels. -
+
Get the maximum supported number of input channels.
-Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
-Definition at line 204 of file vamp-sdk/Plugin.h.
+Definition at line 204 of file vamp-sdk/Plugin.h.
-Referenced by enumeratePlugins(), ZeroCrossing::initialise(), SpectralCentroid::initialise(), PowerSpectrum::initialise(), PercussionOnsetDetector::initialise(), initialise(), AmplitudeFollower::initialise(), and runPlugin().
+Referenced by enumeratePlugins(), initialise(), PercussionOnsetDetector::initialise(), AmplitudeFollower::initialise(), SpectralCentroid::initialise(), ZeroCrossing::initialise(), PowerSpectrum::initialise(), and runPlugin().
- virtual std::string Vamp::Plugin::getType +virtual std::string Vamp::Plugin::getType ( -) +) const [inline, virtual, inherited]---Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase. -
-Do not reimplement this function in your subclass. -
Implements Vamp::PluginBase.
+Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
+Do not reimplement this function in your subclass.
-Definition at line 430 of file vamp-sdk/Plugin.h.
+Implements Vamp::PluginBase.
+ +Definition at line 430 of file vamp-sdk/Plugin.h.
- virtual unsigned int Vamp::PluginBase::getVampApiVersion +virtual unsigned int Vamp::PluginBase::getVampApiVersion ( -) +) const [inline, virtual, inherited]---Get the Vamp API compatibility level of the plugin. -
+
Get the Vamp API compatibility level of the plugin.
-Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
-Definition at line 72 of file vamp-sdk/PluginBase.h.
+Definition at line 72 of file vamp-sdk/PluginBase.h.
-Referenced by enumeratePlugins().
+Referenced by enumeratePlugins().
- virtual ProgramList Vamp::PluginBase::getPrograms +virtual ProgramList Vamp::PluginBase::getPrograms ( -) +) const [inline, virtual, inherited]---Get the program settings available in this plugin. -
-A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.
-The programs must have unique names. -
Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Get the program settings available in this plugin.
+A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.
+The programs must have unique names.
-Definition at line 237 of file vamp-sdk/PluginBase.h.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+ +Definition at line 237 of file vamp-sdk/PluginBase.h.
- virtual std::string Vamp::PluginBase::getCurrentProgram +virtual std::string Vamp::PluginBase::getCurrentProgram ( -) +) const [inline, virtual, inherited]---Get the current program. -
+
Get the current program.
-Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
-Definition at line 242 of file vamp-sdk/PluginBase.h.
+Definition at line 242 of file vamp-sdk/PluginBase.h.
- virtual void Vamp::PluginBase::selectProgram +virtual void Vamp::PluginBase::selectProgram ( -std::string -) +std::string +) [inline, virtual, inherited]---Select a program. -
-(If the given program name is not one of the available programs, do nothing.) -
Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Select a program.
+(If the given program name is not one of the available programs, do nothing.)
-Definition at line 248 of file vamp-sdk/PluginBase.h.
+Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+ +Definition at line 248 of file vamp-sdk/PluginBase.h.
-
Member Data Documentation
- + +Member Data Documentation
+- D* FixedTempoEstimator::m_d +[protected]D* FixedTempoEstimator::m_d [protected]--+
Definition at line 79 of file FixedTempoEstimator.h.
-Definition at line 79 of file FixedTempoEstimator.h.
- -Referenced by getOutputDescriptors(), getParameter(), getParameterDescriptors(), getPreferredBlockSize(), getPreferredStepSize(), getRemainingFeatures(), initialise(), process(), reset(), setParameter(), and ~FixedTempoEstimator().
+Referenced by getOutputDescriptors(), getParameter(), getParameterDescriptors(), getPreferredBlockSize(), getPreferredStepSize(), getRemainingFeatures(), initialise(), process(), reset(), setParameter(), and ~FixedTempoEstimator().
- float Vamp::Plugin::m_inputSampleRate +[protected, inherited]float Vamp::Plugin::m_inputSampleRate [protected, inherited]--+
Definition at line 436 of file vamp-sdk/Plugin.h.
-Definition at line 436 of file vamp-sdk/Plugin.h.
- -Referenced by ZeroCrossing::getOutputDescriptors(), PercussionOnsetDetector::getOutputDescriptors(), AmplitudeFollower::initialise(), ZeroCrossing::process(), SpectralCentroid::process(), and PercussionOnsetDetector::process().
+Referenced by FixedTempoEstimator::D::assembleFeatures(), FixedTempoEstimator::D::calculate(), FixedTempoEstimator::D::getOutputDescriptors(), ZeroCrossing::getOutputDescriptors(), PercussionOnsetDetector::getOutputDescriptors(), AmplitudeFollower::initialise(), FixedTempoEstimator::D::initialise(), FixedTempoEstimator::D::lag2tempo(), ZeroCrossing::process(), SpectralCentroid::process(), PercussionOnsetDetector::process(), and FixedTempoEstimator::D::tempo2lag().
-
The documentation for this class was generated from the following files: -
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - - 1.5.8
+
The documentation for this class was generated from the following files: + + +++ + diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classFixedTempoEstimator_1_1D-members.html --- a/code-doc/classFixedTempoEstimator_1_1D-members.html Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classFixedTempoEstimator_1_1D-members.html Tue Oct 04 13:47:23 2011 +0000 @@ -1,64 +1,124 @@ - - + + + +-
+
+
+
- Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
+
+ 1.7.5.1
+
VampPluginSDK: Member List - - - - ----
-
- Main Page + + + + + + + + + + + + +
- Class List -
- Class Hierarchy -
- Class Members +
- Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + +
- Class List -
- Class Hierarchy -
- Class Members + - + + +
- Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- Class List -
- Class Hierarchy -
- Class Members +
- Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- Class List -
- Class Hierarchy -
- Class Members +
- Enumerator:
-
-
-
TimeDomain + - Definition at line 152 of file vamp-sdk/Plugin.h.
+Definition at line 152 of file vamp-sdk/Plugin.h.
--
Constructor & Destructor Documentation
- + +Constructor & Destructor Documentation
+- PercussionOnsetDetector::PercussionOnsetDetector +PercussionOnsetDetector::PercussionOnsetDetector ( -float -inputSampleRate -) +float +inputSampleRate ) --- -
Definition at line 47 of file PercussionOnsetDetector.cpp.
+Definition at line 47 of file PercussionOnsetDetector.cpp.
- PercussionOnsetDetector::~PercussionOnsetDetector +PercussionOnsetDetector::~PercussionOnsetDetector ( -) +) [virtual]--+
Definition at line 59 of file PercussionOnsetDetector.cpp.
-Definition at line 59 of file PercussionOnsetDetector.cpp.
- -References m_priorMagnitudes.
+References m_priorMagnitudes.
-
Member Function Documentation
- + +Member Function Documentation
+- bool PercussionOnsetDetector::initialise +bool PercussionOnsetDetector::initialise ( -size_t -inputChannels, +size_t +inputChannels, - size_t -stepSize, +size_t +stepSize, - size_t -blockSize size_t +blockSize ) -[virtual][virtual]---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). -
-The input sample rate should have been already specified at construction time.
-Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. -
Implements Vamp::Plugin.
+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).
+The input sample rate should have been already specified at construction time.
+Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
-Definition at line 113 of file PercussionOnsetDetector.cpp.
+Implements Vamp::Plugin.
-References Vamp::Plugin::getMaxChannelCount(), Vamp::Plugin::getMinChannelCount(), m_blockSize, m_dfMinus1, m_dfMinus2, m_priorMagnitudes, and m_stepSize.
+Definition at line 113 of file PercussionOnsetDetector.cpp.
+ +References Vamp::Plugin::getMaxChannelCount(), Vamp::Plugin::getMinChannelCount(), m_blockSize, m_dfMinus1, m_dfMinus2, m_priorMagnitudes, and m_stepSize.
- void PercussionOnsetDetector::reset +void PercussionOnsetDetector::reset ( -) +) [virtual]---Reset the plugin after use, to prepare it for another clean run. -
-Not called for the first initialisation (i.e. initialise must also do a reset). -
Implements Vamp::Plugin.
+Reset the plugin after use, to prepare it for another clean run.
+Not called for the first initialisation (i.e. initialise must also do a reset).
-Definition at line 134 of file PercussionOnsetDetector.cpp.
+Implements Vamp::Plugin.
-References m_blockSize, m_dfMinus1, m_dfMinus2, and m_priorMagnitudes.
+Definition at line 134 of file PercussionOnsetDetector.cpp.
+ +References m_blockSize, m_dfMinus1, m_dfMinus2, and m_priorMagnitudes.
- InputDomain PercussionOnsetDetector::getInputDomain +InputDomain PercussionOnsetDetector::getInputDomain ( -) +) const [inline, virtual]---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. -
Implements Vamp::Plugin.
+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.
-Definition at line 55 of file PercussionOnsetDetector.h.
+Implements Vamp::Plugin.
-References Vamp::Plugin::FrequencyDomain.
+Definition at line 55 of file PercussionOnsetDetector.h.
+ +References Vamp::Plugin::FrequencyDomain.
- string PercussionOnsetDetector::getIdentifier +string PercussionOnsetDetector::getIdentifier ( -) +) const [virtual]---Get the computer-usable name of the plugin. -
-This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.
-This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).
-Example: "zero_crossings" -
Implements Vamp::PluginBase.
+Get the computer-usable name of the plugin.
+This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.
+This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).
+Example: "zero_crossings"
-Definition at line 65 of file PercussionOnsetDetector.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 65 of file PercussionOnsetDetector.cpp.
- string PercussionOnsetDetector::getName +string PercussionOnsetDetector::getName ( -) +) const [virtual]---Get a human-readable name or title of the plugin. -
-This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").
-Example: "Zero Crossings" -
Implements Vamp::PluginBase.
+Get a human-readable name or title of the plugin.
+This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").
+Example: "Zero Crossings"
-Definition at line 71 of file PercussionOnsetDetector.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 71 of file PercussionOnsetDetector.cpp.
- string PercussionOnsetDetector::getDescription +string PercussionOnsetDetector::getDescription ( -) +) const [virtual]---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". -
-May be empty if the name has said it all already.
-Example: "Detect and count zero crossing points" -
Implements Vamp::PluginBase.
+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".
+May be empty if the name has said it all already.
+Example: "Detect and count zero crossing points"
-Definition at line 77 of file PercussionOnsetDetector.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 77 of file PercussionOnsetDetector.cpp.
- string PercussionOnsetDetector::getMaker +string PercussionOnsetDetector::getMaker ( -) +) const [virtual]---Get the name of the author or vendor of the plugin in human-readable form. -
-This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. -
Implements Vamp::PluginBase.
+Get the name of the author or vendor of the plugin in human-readable form.
+This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar.
-Definition at line 83 of file PercussionOnsetDetector.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 83 of file PercussionOnsetDetector.cpp.
- int PercussionOnsetDetector::getPluginVersion +int PercussionOnsetDetector::getPluginVersion ( -) +) const [virtual]---Get the version number of the plugin. -
+
Get the version number of the plugin.
-Implements Vamp::PluginBase.
+Implements Vamp::PluginBase.
-Definition at line 89 of file PercussionOnsetDetector.cpp.
+Definition at line 89 of file PercussionOnsetDetector.cpp.
- string PercussionOnsetDetector::getCopyright +string PercussionOnsetDetector::getCopyright ( -) +) const [virtual]---Get the copyright statement or licensing summary for the plugin. -
-This can be an informative text, without the same presentation constraints as mentioned for getMaker above. -
Implements Vamp::PluginBase.
+Get the copyright statement or licensing summary for the plugin.
+This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
-Definition at line 95 of file PercussionOnsetDetector.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 95 of file PercussionOnsetDetector.cpp.
- size_t PercussionOnsetDetector::getPreferredStepSize +size_t PercussionOnsetDetector::getPreferredStepSize ( -) +) const [virtual]---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. -
-This should be called before initialise().
-A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the initialise() call. -
Reimplemented from Vamp::Plugin.
+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.
+This should be called before initialise().
+A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the initialise() call.
-Definition at line 101 of file PercussionOnsetDetector.cpp.
+Reimplemented from Vamp::Plugin.
+ +Definition at line 101 of file PercussionOnsetDetector.cpp.
- size_t PercussionOnsetDetector::getPreferredBlockSize +size_t PercussionOnsetDetector::getPreferredBlockSize ( -) +) const [virtual]---Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function). -
-This should be called before initialise().
-A plugin that can handle any block size may return 0. The final block size will be set in the initialise() call. -
Reimplemented from Vamp::Plugin.
+Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
+This should be called before initialise().
+A plugin that can handle any block size may return 0. The final block size will be set in the initialise() call.
-Definition at line 107 of file PercussionOnsetDetector.cpp.
+Reimplemented from Vamp::Plugin.
+ +Definition at line 107 of file PercussionOnsetDetector.cpp.
- PercussionOnsetDetector::ParameterList PercussionOnsetDetector::getParameterDescriptors +PercussionOnsetDetector::ParameterList PercussionOnsetDetector::getParameterDescriptors ( -) +) const [virtual]---Get the controllable parameters of this plugin. -
+
Get the controllable parameters of this plugin.
-Reimplemented from Vamp::PluginBase.
+Reimplemented from Vamp::PluginBase.
-Definition at line 145 of file PercussionOnsetDetector.cpp.
+Definition at line 145 of file PercussionOnsetDetector.cpp.
-References Vamp::PluginBase::PluginBase::ParameterDescriptor::defaultValue, Vamp::PluginBase::PluginBase::ParameterDescriptor::description, Vamp::PluginBase::PluginBase::ParameterDescriptor::identifier, Vamp::PluginBase::PluginBase::ParameterDescriptor::isQuantized, Vamp::PluginBase::PluginBase::ParameterDescriptor::maxValue, Vamp::PluginBase::PluginBase::ParameterDescriptor::minValue, Vamp::PluginBase::PluginBase::ParameterDescriptor::name, and Vamp::PluginBase::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.
- float PercussionOnsetDetector::getParameter +float PercussionOnsetDetector::getParameter ( -std::string -) +std::string +) const [virtual]---Get the value of a named parameter. -
-The argument is the identifier field from that parameter's descriptor. -
Reimplemented from Vamp::PluginBase.
+Get the value of a named parameter.
+The argument is the identifier field from that parameter's descriptor.
-Definition at line 174 of file PercussionOnsetDetector.cpp.
+Reimplemented from Vamp::PluginBase.
-References m_sensitivity, and m_threshold.
+Definition at line 174 of file PercussionOnsetDetector.cpp.
+ +References m_sensitivity, and m_threshold.
- void PercussionOnsetDetector::setParameter +void PercussionOnsetDetector::setParameter ( -std::string +std::string , - float -float +) -[virtual][virtual]---Set a named parameter. -
-The first argument is the identifier field from that parameter's descriptor. -
Reimplemented from Vamp::PluginBase.
+Set a named parameter.
+The first argument is the identifier field from that parameter's descriptor.
-Definition at line 182 of file PercussionOnsetDetector.cpp.
+Reimplemented from Vamp::PluginBase.
-References m_sensitivity, and m_threshold.
+Definition at line 182 of file PercussionOnsetDetector.cpp.
+ +References m_sensitivity, and m_threshold.
- PercussionOnsetDetector::OutputList PercussionOnsetDetector::getOutputDescriptors +PercussionOnsetDetector::OutputList PercussionOnsetDetector::getOutputDescriptors ( -) +) const [virtual]---Get the outputs of this plugin. -
-An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the process() call. -
Implements Vamp::Plugin.
+Get the outputs of this plugin.
+An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the process() call.
-Definition at line 196 of file PercussionOnsetDetector.cpp.
+Implements Vamp::Plugin.
-References Vamp::Plugin::Plugin::OutputDescriptor::binCount, Vamp::Plugin::Plugin::OutputDescriptor::description, Vamp::Plugin::Plugin::OutputDescriptor::hasFixedBinCount, Vamp::Plugin::Plugin::OutputDescriptor::hasKnownExtents, Vamp::Plugin::Plugin::OutputDescriptor::identifier, Vamp::Plugin::Plugin::OutputDescriptor::isQuantized, Vamp::Plugin::m_inputSampleRate, Vamp::Plugin::Plugin::OutputDescriptor::name, Vamp::Plugin::Plugin::OutputDescriptor::OneSamplePerStep, Vamp::Plugin::Plugin::OutputDescriptor::quantizeStep, Vamp::Plugin::Plugin::OutputDescriptor::sampleRate, Vamp::Plugin::Plugin::OutputDescriptor::sampleType, Vamp::Plugin::Plugin::OutputDescriptor::unit, and Vamp::Plugin::Plugin::OutputDescriptor::VariableSampleRate.
+Definition at line 196 of file PercussionOnsetDetector.cpp.
+ +References Vamp::Plugin::OutputDescriptor::binCount, Vamp::Plugin::OutputDescriptor::description, Vamp::Plugin::OutputDescriptor::hasFixedBinCount, Vamp::Plugin::OutputDescriptor::hasKnownExtents, Vamp::Plugin::OutputDescriptor::identifier, Vamp::Plugin::OutputDescriptor::isQuantized, Vamp::Plugin::m_inputSampleRate, Vamp::Plugin::OutputDescriptor::name, Vamp::Plugin::OutputDescriptor::OneSamplePerStep, Vamp::Plugin::OutputDescriptor::quantizeStep, Vamp::Plugin::OutputDescriptor::sampleRate, Vamp::Plugin::OutputDescriptor::sampleType, Vamp::Plugin::OutputDescriptor::unit, and Vamp::Plugin::OutputDescriptor::VariableSampleRate.
- PercussionOnsetDetector::FeatureSet PercussionOnsetDetector::process +PercussionOnsetDetector::FeatureSet PercussionOnsetDetector::process ( -const float *const * -inputBuffers, +const float *const * +inputBuffers, - Vamp::RealTime -timestamp Vamp::RealTime +timestamp ) -[virtual][virtual]---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).
-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.
+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).
+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.)
-Definition at line 226 of file PercussionOnsetDetector.cpp.
+Implements Vamp::Plugin.
-References Vamp::RealTime::frame2RealTime(), Vamp::Plugin::Plugin::Feature::hasTimestamp, m_blockSize, m_dfMinus1, m_dfMinus2, Vamp::Plugin::m_inputSampleRate, m_priorMagnitudes, m_sensitivity, m_stepSize, m_threshold, Vamp::Plugin::Plugin::Feature::timestamp, and Vamp::Plugin::Plugin::Feature::values.
+Definition at line 226 of file PercussionOnsetDetector.cpp.
+ +References Vamp::RealTime::frame2RealTime(), Vamp::Plugin::Feature::hasTimestamp, m_blockSize, m_dfMinus1, m_dfMinus2, Vamp::Plugin::m_inputSampleRate, m_priorMagnitudes, m_sensitivity, m_stepSize, m_threshold, Vamp::Plugin::Feature::timestamp, and Vamp::Plugin::Feature::values.
- PercussionOnsetDetector::FeatureSet PercussionOnsetDetector::getRemainingFeatures +PercussionOnsetDetector::FeatureSet PercussionOnsetDetector::getRemainingFeatures ( -) +) [virtual]---After all blocks have been processed, calculate and return any remaining features derived from the complete input. -
+
After all blocks have been processed, calculate and return any remaining features derived from the complete input.
-Implements Vamp::Plugin.
+Implements Vamp::Plugin.
-Definition at line 283 of file PercussionOnsetDetector.cpp.
+Definition at line 283 of file PercussionOnsetDetector.cpp.
- virtual size_t Vamp::Plugin::getMinChannelCount +virtual size_t Vamp::Plugin::getMinChannelCount ( -) +) const [inline, virtual, inherited]---Get the minimum supported number of input channels. -
+
Get the minimum supported number of input channels.
-Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
-Definition at line 199 of file vamp-sdk/Plugin.h.
+Definition at line 199 of file vamp-sdk/Plugin.h.
-Referenced by enumeratePlugins(), ZeroCrossing::initialise(), SpectralCentroid::initialise(), PowerSpectrum::initialise(), initialise(), FixedTempoEstimator::initialise(), AmplitudeFollower::initialise(), and runPlugin().
+Referenced by enumeratePlugins(), FixedTempoEstimator::initialise(), initialise(), AmplitudeFollower::initialise(), SpectralCentroid::initialise(), ZeroCrossing::initialise(), PowerSpectrum::initialise(), and runPlugin().
- virtual size_t Vamp::Plugin::getMaxChannelCount +virtual size_t Vamp::Plugin::getMaxChannelCount ( -) +) const [inline, virtual, inherited]---Get the maximum supported number of input channels. -
+
Get the maximum supported number of input channels.
-Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
-Definition at line 204 of file vamp-sdk/Plugin.h.
+Definition at line 204 of file vamp-sdk/Plugin.h.
-Referenced by enumeratePlugins(), ZeroCrossing::initialise(), SpectralCentroid::initialise(), PowerSpectrum::initialise(), initialise(), FixedTempoEstimator::initialise(), AmplitudeFollower::initialise(), and runPlugin().
+Referenced by enumeratePlugins(), FixedTempoEstimator::initialise(), initialise(), AmplitudeFollower::initialise(), SpectralCentroid::initialise(), ZeroCrossing::initialise(), PowerSpectrum::initialise(), and runPlugin().
- virtual std::string Vamp::Plugin::getType +virtual std::string Vamp::Plugin::getType ( -) +) const [inline, virtual, inherited]---Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase. -
-Do not reimplement this function in your subclass. -
Implements Vamp::PluginBase.
+Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
+Do not reimplement this function in your subclass.
-Definition at line 430 of file vamp-sdk/Plugin.h.
+Implements Vamp::PluginBase.
+ +Definition at line 430 of file vamp-sdk/Plugin.h.
- virtual unsigned int Vamp::PluginBase::getVampApiVersion +virtual unsigned int Vamp::PluginBase::getVampApiVersion ( -) +) const [inline, virtual, inherited]---Get the Vamp API compatibility level of the plugin. -
+
Get the Vamp API compatibility level of the plugin.
-Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
-Definition at line 72 of file vamp-sdk/PluginBase.h.
+Definition at line 72 of file vamp-sdk/PluginBase.h.
-Referenced by enumeratePlugins().
+Referenced by enumeratePlugins().
- virtual ProgramList Vamp::PluginBase::getPrograms +virtual ProgramList Vamp::PluginBase::getPrograms ( -) +) const [inline, virtual, inherited]---Get the program settings available in this plugin. -
-A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.
-The programs must have unique names. -
Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Get the program settings available in this plugin.
+A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.
+The programs must have unique names.
-Definition at line 237 of file vamp-sdk/PluginBase.h.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+ +Definition at line 237 of file vamp-sdk/PluginBase.h.
- virtual std::string Vamp::PluginBase::getCurrentProgram +virtual std::string Vamp::PluginBase::getCurrentProgram ( -) +) const [inline, virtual, inherited]---Get the current program. -
+
Get the current program.
-Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
-Definition at line 242 of file vamp-sdk/PluginBase.h.
+Definition at line 242 of file vamp-sdk/PluginBase.h.
- virtual void Vamp::PluginBase::selectProgram +virtual void Vamp::PluginBase::selectProgram ( -std::string -) +std::string +) [inline, virtual, inherited]---Select a program. -
-(If the given program name is not one of the available programs, do nothing.) -
Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Select a program.
+(If the given program name is not one of the available programs, do nothing.)
-Definition at line 248 of file vamp-sdk/PluginBase.h.
+Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+ +Definition at line 248 of file vamp-sdk/PluginBase.h.
-
Member Data Documentation
- + +Member Data Documentation
+- size_t PercussionOnsetDetector::m_stepSize +[protected]size_t PercussionOnsetDetector::m_stepSize [protected]--+
Definition at line 79 of file PercussionOnsetDetector.h.
-Definition at line 79 of file PercussionOnsetDetector.h.
- -Referenced by initialise(), and process().
+Referenced by initialise(), and process().
- size_t PercussionOnsetDetector::m_blockSize +[protected]size_t PercussionOnsetDetector::m_blockSize [protected]--+
Definition at line 80 of file PercussionOnsetDetector.h.
-Definition at line 80 of file PercussionOnsetDetector.h.
- -Referenced by initialise(), process(), and reset().
+Referenced by initialise(), process(), and reset().
- float PercussionOnsetDetector::m_threshold +[protected]float PercussionOnsetDetector::m_threshold [protected]--+
Definition at line 82 of file PercussionOnsetDetector.h.
-Definition at line 82 of file PercussionOnsetDetector.h.
- -Referenced by getParameter(), process(), and setParameter().
+Referenced by getParameter(), process(), and setParameter().
- float PercussionOnsetDetector::m_sensitivity +[protected]float PercussionOnsetDetector::m_sensitivity [protected]--+
Definition at line 83 of file PercussionOnsetDetector.h.
-Definition at line 83 of file PercussionOnsetDetector.h.
- -Referenced by getParameter(), process(), and setParameter().
+Referenced by getParameter(), process(), and setParameter().
- float* PercussionOnsetDetector::m_priorMagnitudes +[protected]float* PercussionOnsetDetector::m_priorMagnitudes [protected]--+
Definition at line 84 of file PercussionOnsetDetector.h.
-Definition at line 84 of file PercussionOnsetDetector.h.
- -Referenced by initialise(), process(), reset(), and ~PercussionOnsetDetector().
+Referenced by initialise(), process(), reset(), and ~PercussionOnsetDetector().
- float PercussionOnsetDetector::m_dfMinus1 +[protected]float PercussionOnsetDetector::m_dfMinus1 [protected]--+
Definition at line 85 of file PercussionOnsetDetector.h.
-Definition at line 85 of file PercussionOnsetDetector.h.
- -Referenced by initialise(), process(), and reset().
+Referenced by initialise(), process(), and reset().
- float PercussionOnsetDetector::m_dfMinus2 +[protected]float PercussionOnsetDetector::m_dfMinus2 [protected]--+
Definition at line 86 of file PercussionOnsetDetector.h.
-Definition at line 86 of file PercussionOnsetDetector.h.
- -Referenced by initialise(), process(), and reset().
+Referenced by initialise(), process(), and reset().
- float Vamp::Plugin::m_inputSampleRate +[protected, inherited]float Vamp::Plugin::m_inputSampleRate [protected, inherited]--+
Definition at line 436 of file vamp-sdk/Plugin.h.
-Definition at line 436 of file vamp-sdk/Plugin.h.
- -Referenced by ZeroCrossing::getOutputDescriptors(), getOutputDescriptors(), AmplitudeFollower::initialise(), ZeroCrossing::process(), SpectralCentroid::process(), and process().
+Referenced by FixedTempoEstimator::D::assembleFeatures(), FixedTempoEstimator::D::calculate(), FixedTempoEstimator::D::getOutputDescriptors(), ZeroCrossing::getOutputDescriptors(), getOutputDescriptors(), AmplitudeFollower::initialise(), FixedTempoEstimator::D::initialise(), FixedTempoEstimator::D::lag2tempo(), SpectralCentroid::process(), ZeroCrossing::process(), process(), and FixedTempoEstimator::D::tempo2lag().
-
The documentation for this class was generated from the following files: -
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - - 1.5.8
+
The documentation for this class was generated from the following files: + + +++ + diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classPercussionOnsetDetector__inherit__graph.map --- a/code-doc/classPercussionOnsetDetector__inherit__graph.map Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classPercussionOnsetDetector__inherit__graph.map Tue Oct 04 13:47:23 2011 +0000 @@ -1,2 +1,4 @@ - - + diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classPercussionOnsetDetector__inherit__graph.md5 --- a/code-doc/classPercussionOnsetDetector__inherit__graph.md5 Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classPercussionOnsetDetector__inherit__graph.md5 Tue Oct 04 13:47:23 2011 +0000 @@ -1,1 +1,1 @@ -21640a585d44703688f08ac14da43465 \ No newline at end of file +65a7ed879a604f7c870b2fede02ff821 \ No newline at end of file diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classPercussionOnsetDetector__inherit__graph.png Binary file code-doc/classPercussionOnsetDetector__inherit__graph.png has changed diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classPowerSpectrum-members.html --- a/code-doc/classPowerSpectrum-members.html Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classPowerSpectrum-members.html Tue Oct 04 13:47:23 2011 +0000 @@ -1,72 +1,132 @@ - - + + + +-
+
+
+
- Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
+
+ 1.7.5.1
+
VampPluginSDK: Member List - - - - ----
-
- Main Page + + + + + + + + + + + + +
- Class List -
- Class Hierarchy -
- Class Members +
- Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
+
+ 1.7.5.1
+
- Main Page + + + + + + + + + + + + +
- Class List -
- Class Hierarchy -
- Class Members +
- Enumerator:
-
-
-
TimeDomain + - Definition at line 152 of file vamp-sdk/Plugin.h.
+Definition at line 152 of file vamp-sdk/Plugin.h.
--
Constructor & Destructor Documentation
- + +Constructor & Destructor Documentation
+- PowerSpectrum::PowerSpectrum +PowerSpectrum::PowerSpectrum ( -float -inputSampleRate -) +float +inputSampleRate ) --- -
Definition at line 45 of file PowerSpectrum.cpp.
+Definition at line 45 of file PowerSpectrum.cpp.
- PowerSpectrum::~PowerSpectrum +PowerSpectrum::~PowerSpectrum ( -) +) [virtual]--- -
Definition at line 51 of file PowerSpectrum.cpp.
+Definition at line 51 of file PowerSpectrum.cpp.
-
Member Function Documentation
- + +Member Function Documentation
+- bool PowerSpectrum::initialise +bool PowerSpectrum::initialise ( -size_t -inputChannels, +size_t +inputChannels, - size_t -stepSize, +size_t +stepSize, - size_t -blockSize size_t +blockSize ) -[virtual][virtual]---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). -
-The input sample rate should have been already specified at construction time.
-Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. -
Implements Vamp::Plugin.
+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).
+The input sample rate should have been already specified at construction time.
+Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
-Definition at line 92 of file PowerSpectrum.cpp.
+Implements Vamp::Plugin.
-References Vamp::Plugin::getMaxChannelCount(), Vamp::Plugin::getMinChannelCount(), and m_blockSize.
+Definition at line 92 of file PowerSpectrum.cpp.
+ +References Vamp::Plugin::getMaxChannelCount(), Vamp::Plugin::getMinChannelCount(), and m_blockSize.
- void PowerSpectrum::reset +void PowerSpectrum::reset ( -) +) [virtual]---Reset the plugin after use, to prepare it for another clean run. -
-Not called for the first initialisation (i.e. initialise must also do a reset). -
Implements Vamp::Plugin.
+Reset the plugin after use, to prepare it for another clean run.
+Not called for the first initialisation (i.e. initialise must also do a reset).
-Definition at line 103 of file PowerSpectrum.cpp.
+Implements Vamp::Plugin.
+ +Definition at line 103 of file PowerSpectrum.cpp.
- InputDomain PowerSpectrum::getInputDomain +InputDomain PowerSpectrum::getInputDomain ( -) +) const [inline, virtual]---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. -
Implements Vamp::Plugin.
+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.
-Definition at line 59 of file PowerSpectrum.h.
+Implements Vamp::Plugin.
-References Vamp::Plugin::FrequencyDomain.
+Definition at line 59 of file PowerSpectrum.h.
+ +References Vamp::Plugin::FrequencyDomain.
- string PowerSpectrum::getIdentifier +string PowerSpectrum::getIdentifier ( -) +) const [virtual]---Get the computer-usable name of the plugin. -
-This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.
-This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).
-Example: "zero_crossings" -
Implements Vamp::PluginBase.
+Get the computer-usable name of the plugin.
+This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.
+This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).
+Example: "zero_crossings"
-Definition at line 56 of file PowerSpectrum.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 56 of file PowerSpectrum.cpp.
- string PowerSpectrum::getName +string PowerSpectrum::getName ( -) +) const [virtual]---Get a human-readable name or title of the plugin. -
-This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").
-Example: "Zero Crossings" -
Implements Vamp::PluginBase.
+Get a human-readable name or title of the plugin.
+This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").
+Example: "Zero Crossings"
-Definition at line 62 of file PowerSpectrum.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 62 of file PowerSpectrum.cpp.
- string PowerSpectrum::getDescription +string PowerSpectrum::getDescription ( -) +) const [virtual]---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". -
-May be empty if the name has said it all already.
-Example: "Detect and count zero crossing points" -
Implements Vamp::PluginBase.
+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".
+May be empty if the name has said it all already.
+Example: "Detect and count zero crossing points"
-Definition at line 68 of file PowerSpectrum.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 68 of file PowerSpectrum.cpp.
- string PowerSpectrum::getMaker +string PowerSpectrum::getMaker ( -) +) const [virtual]---Get the name of the author or vendor of the plugin in human-readable form. -
-This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. -
Implements Vamp::PluginBase.
+Get the name of the author or vendor of the plugin in human-readable form.
+This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar.
-Definition at line 74 of file PowerSpectrum.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 74 of file PowerSpectrum.cpp.
- int PowerSpectrum::getPluginVersion +int PowerSpectrum::getPluginVersion ( -) +) const [virtual]---Get the version number of the plugin. -
+
Get the version number of the plugin.
-Implements Vamp::PluginBase.
+Implements Vamp::PluginBase.
-Definition at line 80 of file PowerSpectrum.cpp.
+Definition at line 80 of file PowerSpectrum.cpp.
- string PowerSpectrum::getCopyright +string PowerSpectrum::getCopyright ( -) +) const [virtual]---Get the copyright statement or licensing summary for the plugin. -
-This can be an informative text, without the same presentation constraints as mentioned for getMaker above. -
Implements Vamp::PluginBase.
+Get the copyright statement or licensing summary for the plugin.
+This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
-Definition at line 86 of file PowerSpectrum.cpp.
+Implements Vamp::PluginBase.
+ +Definition at line 86 of file PowerSpectrum.cpp.
- PowerSpectrum::OutputList PowerSpectrum::getOutputDescriptors +PowerSpectrum::OutputList PowerSpectrum::getOutputDescriptors ( -) +) const [virtual]---Get the outputs of this plugin. -
-An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the process() call. -
Implements Vamp::Plugin.
+Get the outputs of this plugin.
+An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the process() call.
-Definition at line 108 of file PowerSpectrum.cpp.
+Implements Vamp::Plugin.
-References Vamp::Plugin::Plugin::OutputDescriptor::binCount, Vamp::Plugin::Plugin::OutputDescriptor::description, Vamp::Plugin::Plugin::OutputDescriptor::hasFixedBinCount, Vamp::Plugin::Plugin::OutputDescriptor::hasKnownExtents, Vamp::Plugin::Plugin::OutputDescriptor::identifier, Vamp::Plugin::Plugin::OutputDescriptor::isQuantized, m_blockSize, Vamp::Plugin::Plugin::OutputDescriptor::name, Vamp::Plugin::Plugin::OutputDescriptor::OneSamplePerStep, Vamp::Plugin::Plugin::OutputDescriptor::sampleType, and Vamp::Plugin::Plugin::OutputDescriptor::unit.
+Definition at line 108 of file PowerSpectrum.cpp.
+ +References Vamp::Plugin::OutputDescriptor::binCount, Vamp::Plugin::OutputDescriptor::description, Vamp::Plugin::OutputDescriptor::hasFixedBinCount, Vamp::Plugin::OutputDescriptor::hasKnownExtents, Vamp::Plugin::OutputDescriptor::identifier, Vamp::Plugin::OutputDescriptor::isQuantized, m_blockSize, Vamp::Plugin::OutputDescriptor::name, Vamp::Plugin::OutputDescriptor::OneSamplePerStep, Vamp::Plugin::OutputDescriptor::sampleType, and Vamp::Plugin::OutputDescriptor::unit.
- PowerSpectrum::FeatureSet PowerSpectrum::process +PowerSpectrum::FeatureSet PowerSpectrum::process ( -const float *const * -inputBuffers, +const float *const * +inputBuffers, - Vamp::RealTime -timestamp Vamp::RealTime +timestamp ) -[virtual][virtual]---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).
-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.
+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).
+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.)
-Definition at line 136 of file PowerSpectrum.cpp.
+Implements Vamp::Plugin.
-References Vamp::Plugin::Plugin::Feature::hasTimestamp, m_blockSize, and Vamp::Plugin::Plugin::Feature::values.
+Definition at line 136 of file PowerSpectrum.cpp.
+ +References Vamp::Plugin::Feature::hasTimestamp, m_blockSize, and Vamp::Plugin::Feature::values.
- PowerSpectrum::FeatureSet PowerSpectrum::getRemainingFeatures +PowerSpectrum::FeatureSet PowerSpectrum::getRemainingFeatures ( -) +) [virtual]---After all blocks have been processed, calculate and return any remaining features derived from the complete input. -
+
After all blocks have been processed, calculate and return any remaining features derived from the complete input.
-Implements Vamp::Plugin.
+Implements Vamp::Plugin.
-Definition at line 166 of file PowerSpectrum.cpp.
+Definition at line 166 of file PowerSpectrum.cpp.
- virtual size_t Vamp::Plugin::getPreferredBlockSize +virtual size_t Vamp::Plugin::getPreferredBlockSize ( -) +) const [inline, virtual, inherited]---Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function). -
-This should be called before initialise().
-A plugin that can handle any block size may return 0. The final block size will be set in the initialise() call. -
Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, Vamp::HostExt::PluginInputDomainAdapter, Vamp::HostExt::PluginWrapper, FixedTempoEstimator, and PercussionOnsetDetector.
+Get the preferred block size (window size -- the number of sample frames passed in each block to the process() function).
+This should be called before initialise().
+A plugin that can handle any block size may return 0. The final block size will be set in the initialise() call.
-Definition at line 179 of file vamp-sdk/Plugin.h.
+Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::HostExt::PluginInputDomainAdapter, Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, FixedTempoEstimator, and PercussionOnsetDetector.
-Referenced by enumeratePlugins(), and runPlugin().
+Definition at line 179 of file vamp-sdk/Plugin.h.
+ +Referenced by enumeratePlugins(), and runPlugin().
- virtual size_t Vamp::Plugin::getPreferredStepSize +virtual size_t Vamp::Plugin::getPreferredStepSize ( -) +) const [inline, virtual, inherited]---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. -
-This should be called before initialise().
-A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the initialise() call. -
Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, Vamp::HostExt::PluginInputDomainAdapter, Vamp::HostExt::PluginWrapper, FixedTempoEstimator, and PercussionOnsetDetector.
+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.
+This should be called before initialise().
+A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the initialise() call.
-Definition at line 194 of file vamp-sdk/Plugin.h.
+Reimplemented in Vamp::HostExt::PluginInputDomainAdapter, Vamp::PluginHostAdapter, Vamp::HostExt::PluginBufferingAdapter, Vamp::HostExt::PluginWrapper, FixedTempoEstimator, and PercussionOnsetDetector.
-Referenced by enumeratePlugins(), and runPlugin().
+Definition at line 194 of file vamp-sdk/Plugin.h.
+ +Referenced by enumeratePlugins(), and runPlugin().
- virtual size_t Vamp::Plugin::getMinChannelCount +virtual size_t Vamp::Plugin::getMinChannelCount ( -) +) const [inline, virtual, inherited]---Get the minimum supported number of input channels. -
+
Get the minimum supported number of input channels.
-Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
-Definition at line 199 of file vamp-sdk/Plugin.h.
+Definition at line 199 of file vamp-sdk/Plugin.h.
-Referenced by enumeratePlugins(), ZeroCrossing::initialise(), SpectralCentroid::initialise(), initialise(), PercussionOnsetDetector::initialise(), FixedTempoEstimator::initialise(), AmplitudeFollower::initialise(), and runPlugin().
+Referenced by enumeratePlugins(), FixedTempoEstimator::initialise(), PercussionOnsetDetector::initialise(), AmplitudeFollower::initialise(), SpectralCentroid::initialise(), ZeroCrossing::initialise(), initialise(), and runPlugin().
- virtual size_t Vamp::Plugin::getMaxChannelCount +virtual size_t Vamp::Plugin::getMaxChannelCount ( -) +) const [inline, virtual, inherited]---Get the maximum supported number of input channels. -
+
Get the maximum supported number of input channels.
-Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
-Definition at line 204 of file vamp-sdk/Plugin.h.
+Definition at line 204 of file vamp-sdk/Plugin.h.
-Referenced by enumeratePlugins(), ZeroCrossing::initialise(), SpectralCentroid::initialise(), initialise(), PercussionOnsetDetector::initialise(), FixedTempoEstimator::initialise(), AmplitudeFollower::initialise(), and runPlugin().
+Referenced by enumeratePlugins(), FixedTempoEstimator::initialise(), PercussionOnsetDetector::initialise(), AmplitudeFollower::initialise(), SpectralCentroid::initialise(), ZeroCrossing::initialise(), initialise(), and runPlugin().
- virtual std::string Vamp::Plugin::getType +virtual std::string Vamp::Plugin::getType ( -) +) const [inline, virtual, inherited]---Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase. -
-Do not reimplement this function in your subclass. -
Implements Vamp::PluginBase.
+Used to distinguish between Vamp::Plugin and other potential sibling subclasses of PluginBase.
+Do not reimplement this function in your subclass.
-Definition at line 430 of file vamp-sdk/Plugin.h.
+Implements Vamp::PluginBase.
+ +Definition at line 430 of file vamp-sdk/Plugin.h.
- virtual unsigned int Vamp::PluginBase::getVampApiVersion +virtual unsigned int Vamp::PluginBase::getVampApiVersion ( -) +) const [inline, virtual, inherited]---Get the Vamp API compatibility level of the plugin. -
+
Get the Vamp API compatibility level of the plugin.
-Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
-Definition at line 72 of file vamp-sdk/PluginBase.h.
+Definition at line 72 of file vamp-sdk/PluginBase.h.
-Referenced by enumeratePlugins().
+Referenced by enumeratePlugins().
- virtual ParameterList Vamp::PluginBase::getParameterDescriptors +virtual ParameterList Vamp::PluginBase::getParameterDescriptors ( -) +) const [inline, virtual, inherited]---Get the controllable parameters of this plugin. -
+
Get the controllable parameters of this plugin.
-Reimplemented in Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.
+Reimplemented in Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.
-Definition at line 208 of file vamp-sdk/PluginBase.h.
+Definition at line 208 of file vamp-sdk/PluginBase.h.
-Referenced by enumeratePlugins().
+Referenced by enumeratePlugins().
- virtual float Vamp::PluginBase::getParameter +virtual float Vamp::PluginBase::getParameter ( -std::string -) +std::string +) const [inline, virtual, inherited]---Get the value of a named parameter. -
-The argument is the identifier field from that parameter's descriptor. -
Reimplemented in Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.
+Get the value of a named parameter.
+The argument is the identifier field from that parameter's descriptor.
-Definition at line 216 of file vamp-sdk/PluginBase.h.
+Reimplemented in Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.
+ +Definition at line 216 of file vamp-sdk/PluginBase.h.
- virtual void Vamp::PluginBase::setParameter +virtual void Vamp::PluginBase::setParameter ( -std::string +std::string , - float -float +) -[inline, virtual, inherited][inline, virtual, inherited]---Set a named parameter. -
-The first argument is the identifier field from that parameter's descriptor. -
Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.
+Set a named parameter.
+The first argument is the identifier field from that parameter's descriptor.
-Definition at line 222 of file vamp-sdk/PluginBase.h.
+Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, Vamp::HostExt::PluginWrapper, AmplitudeFollower, FixedTempoEstimator, and PercussionOnsetDetector.
+ +Definition at line 222 of file vamp-sdk/PluginBase.h.
- virtual ProgramList Vamp::PluginBase::getPrograms +virtual ProgramList Vamp::PluginBase::getPrograms ( -) +) const [inline, virtual, inherited]---Get the program settings available in this plugin. -
-A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.
-The programs must have unique names. -
Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Get the program settings available in this plugin.
+A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.
+The programs must have unique names.
-Definition at line 237 of file vamp-sdk/PluginBase.h.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+ +Definition at line 237 of file vamp-sdk/PluginBase.h.
- virtual std::string Vamp::PluginBase::getCurrentProgram +virtual std::string Vamp::PluginBase::getCurrentProgram ( -) +) const [inline, virtual, inherited]---Get the current program. -
+
Get the current program.
-Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Reimplemented in Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
-Definition at line 242 of file vamp-sdk/PluginBase.h.
+Definition at line 242 of file vamp-sdk/PluginBase.h.
- virtual void Vamp::PluginBase::selectProgram +virtual void Vamp::PluginBase::selectProgram ( -std::string -) +std::string +) [inline, virtual, inherited]---Select a program. -
-(If the given program name is not one of the available programs, do nothing.) -
Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+Select a program.
+(If the given program name is not one of the available programs, do nothing.)
-Definition at line 248 of file vamp-sdk/PluginBase.h.
+Reimplemented in Vamp::HostExt::PluginBufferingAdapter, Vamp::PluginHostAdapter, and Vamp::HostExt::PluginWrapper.
+ +Definition at line 248 of file vamp-sdk/PluginBase.h.
-
Member Data Documentation
- + +Member Data Documentation
+- size_t PowerSpectrum::m_blockSize +[protected]size_t PowerSpectrum::m_blockSize [protected]--+
Definition at line 76 of file PowerSpectrum.h.
-Definition at line 76 of file PowerSpectrum.h.
- -Referenced by getOutputDescriptors(), initialise(), and process().
+Referenced by getOutputDescriptors(), initialise(), and process().
- float Vamp::Plugin::m_inputSampleRate +[protected, inherited]float Vamp::Plugin::m_inputSampleRate [protected, inherited]--+
Definition at line 436 of file vamp-sdk/Plugin.h.
-Definition at line 436 of file vamp-sdk/Plugin.h.
- -Referenced by ZeroCrossing::getOutputDescriptors(), PercussionOnsetDetector::getOutputDescriptors(), AmplitudeFollower::initialise(), ZeroCrossing::process(), SpectralCentroid::process(), and PercussionOnsetDetector::process().
+Referenced by FixedTempoEstimator::D::assembleFeatures(), FixedTempoEstimator::D::calculate(), FixedTempoEstimator::D::getOutputDescriptors(), ZeroCrossing::getOutputDescriptors(), PercussionOnsetDetector::getOutputDescriptors(), AmplitudeFollower::initialise(), FixedTempoEstimator::D::initialise(), FixedTempoEstimator::D::lag2tempo(), ZeroCrossing::process(), SpectralCentroid::process(), PercussionOnsetDetector::process(), and FixedTempoEstimator::D::tempo2lag().
-
The documentation for this class was generated from the following files: -
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - - 1.5.8
+
The documentation for this class was generated from the following files: + + +++ + diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classPowerSpectrum__inherit__graph.map --- a/code-doc/classPowerSpectrum__inherit__graph.map Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classPowerSpectrum__inherit__graph.map Tue Oct 04 13:47:23 2011 +0000 @@ -1,2 +1,4 @@ - - + diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classPowerSpectrum__inherit__graph.md5 --- a/code-doc/classPowerSpectrum__inherit__graph.md5 Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classPowerSpectrum__inherit__graph.md5 Tue Oct 04 13:47:23 2011 +0000 @@ -1,1 +1,1 @@ -9e7b781fbc92658366d5a5e8b43ba66e \ No newline at end of file +c9f07b131caa51e199fa4d4ebafc8ea7 \ No newline at end of file diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classPowerSpectrum__inherit__graph.png Binary file code-doc/classPowerSpectrum__inherit__graph.png has changed diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classSpectralCentroid-members.html --- a/code-doc/classSpectralCentroid-members.html Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classSpectralCentroid-members.html Tue Oct 04 13:47:23 2011 +0000 @@ -1,73 +1,133 @@ - - + + + +-
+
+
+
- Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
+
+ 1.7.5.1
+
VampPluginSDK: Member List - - - - - - Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
+
+
+ + +++ + + -+ +
++ + + + ++ + + + +VampPluginSDK + 2.1 ++ +-+ + +-
-
++++PowerSpectrum Member List-PowerSpectrum Member List
This is the complete list of members for PowerSpectrum, including all inherited members.-
FeatureList typedef Vamp::Plugin FeatureSet typedef Vamp::Plugin FrequencyDomain enum value Vamp::Plugin getCopyright() const PowerSpectrum [virtual]getCurrentProgram() const Vamp::PluginBase [inline, virtual]getDescription() const PowerSpectrum [virtual]getIdentifier() const PowerSpectrum [virtual]getInputDomain() const PowerSpectrum [inline, virtual]getMaker() const PowerSpectrum [virtual]getMaxChannelCount() const Vamp::Plugin [inline, virtual]getMinChannelCount() const Vamp::Plugin [inline, virtual]getName() const PowerSpectrum [virtual]getOutputDescriptors() const PowerSpectrum [virtual]getParameter(std::string) const Vamp::PluginBase [inline, virtual]getParameterDescriptors() const Vamp::PluginBase [inline, virtual]getPluginVersion() const PowerSpectrum [virtual]getPreferredBlockSize() const Vamp::Plugin [inline, virtual]getPreferredStepSize() const Vamp::Plugin [inline, virtual]getPrograms() const Vamp::PluginBase [inline, virtual]getRemainingFeatures() PowerSpectrum [virtual]getType() const Vamp::Plugin [inline, virtual]getVampApiVersion() const Vamp::PluginBase [inline, virtual]initialise(size_t channels, size_t stepSize, size_t blockSize) PowerSpectrum [virtual]InputDomain enum name Vamp::Plugin m_blockSize PowerSpectrum [protected]m_inputSampleRate Vamp::Plugin [protected]OutputList typedef Vamp::Plugin ParameterList typedef Vamp::PluginBase Plugin(float inputSampleRate) Vamp::Plugin [inline, protected]PowerSpectrum(float inputSampleRate) PowerSpectrum process(const float *const *inputBuffers, Vamp::RealTime timestamp) PowerSpectrum [virtual]ProgramList typedef Vamp::PluginBase reset() PowerSpectrum [virtual]selectProgram(std::string) Vamp::PluginBase [inline, virtual]setParameter(std::string, float) Vamp::PluginBase [inline, virtual]TimeDomain enum value Vamp::Plugin ~Plugin() Vamp::Plugin [inline, virtual]~PluginBase() Vamp::PluginBase [inline, virtual]~PowerSpectrum() PowerSpectrum [virtual]
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - - 1.5.8
+
+ ++ + diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classPowerSpectrum.html --- a/code-doc/classPowerSpectrum.html Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classPowerSpectrum.html Tue Oct 04 13:47:23 2011 +0000 @@ -1,1016 +1,982 @@ - - + + + +-
+
+
VampPluginSDK: PowerSpectrum Class Reference - - - - --+-+-
-
+ + ++++ + + -+ +
++ + + + ++ + + + +VampPluginSDK + 2.1 ++ +-+ + +-
-
+++ +++PowerSpectrum Class Reference-PowerSpectrum Class Reference
Example plugin that returns a power spectrum calculated (trivially) from the frequency domain representation of each block of audio. -More... --
#include <PowerSpectrum.h>-+ +
Example plugin that returns a power spectrum calculated (trivially) from the frequency domain representation of each block of audio. + More...
+ +#include <PowerSpectrum.h>Inheritance diagram for PowerSpectrum:--+
[legend] +-+ +[legend] -
-Public Types
enum InputDomain { TimeDomain, -FrequencyDomain + + +
++Public Types
enum InputDomain { TimeDomain, +FrequencyDomain } typedef std::vector
+< OutputDescriptor >OutputList typedef std::vector< Feature > FeatureList typedef std::map< int,
+FeatureList >FeatureSet typedef std::vector
+< ParameterDescriptor >ParameterList 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. +Protected Attributes
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.
+This is one of the simplest possible Vamp plugins, included as an example of how to return the appropriate value structure for this sort of visualisation.
-typedef std::vector
-< OutputDescriptor >OutputList typedef std::vector< Feature > FeatureList typedef std::map< int,
-FeatureList >FeatureSet 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. Protected Attributes
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. --This is one of the simplest possible Vamp plugins, included as an example of how to return the appropriate value structure for this sort of visualisation. -
Definition at line 50 of file PowerSpectrum.h.
-Member Typedef Documentation
- +Definition at line 50 of file PowerSpectrum.h.
+Member Typedef Documentation
+- typedef std::vector<OutputDescriptor> Vamp::Plugin::OutputList +[inherited]typedef std::vector<OutputDescriptor> Vamp::Plugin::OutputList [inherited]--- -
Definition at line 327 of file vamp-sdk/Plugin.h.
+Definition at line 327 of file vamp-sdk/Plugin.h.
- typedef std::vector<Feature> Vamp::Plugin::FeatureList +[inherited]typedef std::vector<Feature> Vamp::Plugin::FeatureList [inherited]--- -
Definition at line 385 of file vamp-sdk/Plugin.h.
+Definition at line 385 of file vamp-sdk/Plugin.h.
- typedef std::map<int, FeatureList> Vamp::Plugin::FeatureSet +[inherited]typedef std::map<int, FeatureList> Vamp::Plugin::FeatureSet [inherited]--- -
Definition at line 387 of file vamp-sdk/Plugin.h.
+Definition at line 387 of file vamp-sdk/Plugin.h.
- typedef std::vector<ParameterDescriptor> Vamp::PluginBase::ParameterList +[inherited]typedef std::vector<ParameterDescriptor> Vamp::PluginBase::ParameterList [inherited]--- -
Definition at line 203 of file vamp-sdk/PluginBase.h.
+Definition at line 203 of file vamp-sdk/PluginBase.h.
- typedef std::vector<std::string> Vamp::PluginBase::ProgramList +[inherited]typedef std::vector<std::string> Vamp::PluginBase::ProgramList [inherited]--- -
Definition at line 225 of file vamp-sdk/PluginBase.h.
+Definition at line 225 of file vamp-sdk/PluginBase.h.
-
Member Enumeration Documentation
- + +Member Enumeration Documentation
+- enum Vamp::Plugin::InputDomain +[inherited]enum Vamp::Plugin::InputDomain [inherited]- --
- Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
+
+
+ + +++ + + -+ +
++ + + + ++ + + + +VampPluginSDK + 2.1 ++ +-+ + +-
-
++++FixedTempoEstimator::D Member List-FixedTempoEstimator::FixedTempoEstimator::D Member List
This is the complete list of members for FixedTempoEstimator::FixedTempoEstimator::D, including all inherited members.-
assembleFeatures() FixedTempoEstimator::FixedTempoEstimator::D [private]calculate() FixedTempoEstimator::FixedTempoEstimator::D [private]D(float inputSampleRate) FixedTempoEstimator::FixedTempoEstimator::D getOutputDescriptors() const FixedTempoEstimator::FixedTempoEstimator::D getParameter(string id) const FixedTempoEstimator::FixedTempoEstimator::D getParameterDescriptors() const FixedTempoEstimator::FixedTempoEstimator::D getPreferredBlockSize() const FixedTempoEstimator::FixedTempoEstimator::D [inline]getPreferredStepSize() const FixedTempoEstimator::FixedTempoEstimator::D [inline]getRemainingFeatures() FixedTempoEstimator::FixedTempoEstimator::D initialise(size_t channels, size_t stepSize, size_t blockSize) FixedTempoEstimator::FixedTempoEstimator::D lag2tempo(int) FixedTempoEstimator::FixedTempoEstimator::D [private]m_blockSize FixedTempoEstimator::FixedTempoEstimator::D [private]m_df FixedTempoEstimator::FixedTempoEstimator::D [private]m_dfsize FixedTempoEstimator::FixedTempoEstimator::D [private]m_fr FixedTempoEstimator::FixedTempoEstimator::D [private]m_inputSampleRate FixedTempoEstimator::FixedTempoEstimator::D [private]m_lasttime FixedTempoEstimator::FixedTempoEstimator::D [private]m_maxbpm FixedTempoEstimator::FixedTempoEstimator::D [private]m_maxdflen FixedTempoEstimator::FixedTempoEstimator::D [private]m_minbpm FixedTempoEstimator::FixedTempoEstimator::D [private]m_n FixedTempoEstimator::FixedTempoEstimator::D [private]m_priorMagnitudes FixedTempoEstimator::FixedTempoEstimator::D [private]m_r FixedTempoEstimator::FixedTempoEstimator::D [private]m_start FixedTempoEstimator::FixedTempoEstimator::D [private]m_stepSize FixedTempoEstimator::FixedTempoEstimator::D [private]m_t FixedTempoEstimator::FixedTempoEstimator::D [private]process(const float *const *, RealTime) FixedTempoEstimator::FixedTempoEstimator::D reset() FixedTempoEstimator::FixedTempoEstimator::D setParameter(string id, float value) FixedTempoEstimator::FixedTempoEstimator::D tempo2lag(float) FixedTempoEstimator::FixedTempoEstimator::D [private]~D() FixedTempoEstimator::FixedTempoEstimator::D
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - - 1.5.8
+
+ ++ + diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classFixedTempoEstimator_1_1D.html --- a/code-doc/classFixedTempoEstimator_1_1D.html Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classFixedTempoEstimator_1_1D.html Tue Oct 04 13:47:23 2011 +0000 @@ -1,827 +1,738 @@ - - --
+
+
VampPluginSDK: FixedTempoEstimator::FixedTempoEstimator::D Class Reference - - - - ----
-
VampPluginSDK: FixedTempoEstimator::D Class Reference + + + + + + + + + + + + ++ + +++ + + -+ +
++ + + + ++ + + + +VampPluginSDK + 2.1 ++ +--
-
++ +++FixedTempoEstimator::D Class Reference-FixedTempoEstimator::FixedTempoEstimator::D Class Reference
--
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 () Private Member Functions
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 +
-+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 () +Private Member Functions
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 Detailed Description
- -Definition at line 49 of file FixedTempoEstimator.cpp.
-Constructor & Destructor Documentation
- +Detailed Description
++Definition at line 50 of file FixedTempoEstimator.cpp.
+Constructor & Destructor Documentation
+- FixedTempoEstimator::FixedTempoEstimator::D::D +FixedTempoEstimator::D::D ( -float -inputSampleRate -) +float +inputSampleRate ) --- -
Definition at line 98 of file FixedTempoEstimator.cpp.
+Definition at line 99 of file FixedTempoEstimator.cpp.
- FixedTempoEstimator::FixedTempoEstimator::D::~D +FixedTempoEstimator::D::~D ( -) +) --- -
Definition at line 114 of file FixedTempoEstimator.cpp.
- -References FixedTempoEstimator::FixedTempoEstimator::D::m_df, FixedTempoEstimator::FixedTempoEstimator::D::m_fr, FixedTempoEstimator::FixedTempoEstimator::D::m_priorMagnitudes, FixedTempoEstimator::FixedTempoEstimator::D::m_r, and FixedTempoEstimator::FixedTempoEstimator::D::m_t.
+Definition at line 115 of file FixedTempoEstimator.cpp.
-
Member Function Documentation
- + +Member Function Documentation
+- size_t FixedTempoEstimator::FixedTempoEstimator::D::getPreferredStepSize +size_t FixedTempoEstimator::D::getPreferredStepSize ( -) +) const [inline]--+
Definition at line 57 of file FixedTempoEstimator.cpp.
-Definition at line 56 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::getPreferredStepSize().
+Referenced by FixedTempoEstimator::getPreferredStepSize().
- size_t FixedTempoEstimator::FixedTempoEstimator::D::getPreferredBlockSize +size_t FixedTempoEstimator::D::getPreferredBlockSize ( -) +) const [inline]--+
Definition at line 58 of file FixedTempoEstimator.cpp.
-Definition at line 57 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors(), and FixedTempoEstimator::getPreferredBlockSize().
+Referenced by FixedTempoEstimator::getPreferredBlockSize().
- FixedTempoEstimator::ParameterList FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors +FixedTempoEstimator::ParameterList FixedTempoEstimator::D::getParameterDescriptors ( -) +) const --+
Definition at line 125 of file FixedTempoEstimator.cpp.
-Definition at line 124 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::PluginBase::ParameterDescriptor::defaultValue, Vamp::PluginBase::PluginBase::ParameterDescriptor::description, Vamp::PluginBase::PluginBase::ParameterDescriptor::identifier, Vamp::PluginBase::PluginBase::ParameterDescriptor::isQuantized, Vamp::PluginBase::PluginBase::ParameterDescriptor::maxValue, Vamp::PluginBase::PluginBase::ParameterDescriptor::minValue, Vamp::PluginBase::PluginBase::ParameterDescriptor::name, and Vamp::PluginBase::PluginBase::ParameterDescriptor::unit.
- -Referenced by FixedTempoEstimator::getParameterDescriptors().
+Referenced by FixedTempoEstimator::getParameterDescriptors().
- float FixedTempoEstimator::FixedTempoEstimator::D::getParameter +float FixedTempoEstimator::D::getParameter ( -string -id -) +string +id ) const --+
Definition at line 159 of file FixedTempoEstimator.cpp.
-Definition at line 158 of file FixedTempoEstimator.cpp.
- -References FixedTempoEstimator::FixedTempoEstimator::D::m_maxbpm, FixedTempoEstimator::FixedTempoEstimator::D::m_maxdflen, and FixedTempoEstimator::FixedTempoEstimator::D::m_minbpm.
- -Referenced by FixedTempoEstimator::getParameter().
+Referenced by FixedTempoEstimator::getParameter().
- void FixedTempoEstimator::FixedTempoEstimator::D::setParameter +void FixedTempoEstimator::D::setParameter ( -string -id, +string +id, - float -value float +value ) -+ --+
Definition at line 172 of file FixedTempoEstimator.cpp.
-Definition at line 171 of file FixedTempoEstimator.cpp.
- -References FixedTempoEstimator::FixedTempoEstimator::D::m_maxbpm, FixedTempoEstimator::FixedTempoEstimator::D::m_maxdflen, and FixedTempoEstimator::FixedTempoEstimator::D::m_minbpm.
- -Referenced by FixedTempoEstimator::setParameter().
+Referenced by FixedTempoEstimator::setParameter().
- FixedTempoEstimator::OutputList FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors +FixedTempoEstimator::OutputList FixedTempoEstimator::D::getOutputDescriptors ( -) +) const --+
Definition at line 190 of file FixedTempoEstimator.cpp.
-Definition at line 189 of file FixedTempoEstimator.cpp.
+References Vamp::Plugin::OutputDescriptor::binCount, Vamp::Plugin::OutputDescriptor::description, Vamp::Plugin::OutputDescriptor::FixedSampleRate, FixedTempoEstimator::getPreferredBlockSize(), Vamp::Plugin::OutputDescriptor::hasDuration, Vamp::Plugin::OutputDescriptor::hasFixedBinCount, Vamp::Plugin::OutputDescriptor::hasKnownExtents, Vamp::Plugin::OutputDescriptor::identifier, Vamp::Plugin::OutputDescriptor::isQuantized, Vamp::Plugin::m_inputSampleRate, Vamp::Plugin::OutputDescriptor::maxValue, Vamp::Plugin::OutputDescriptor::minValue, Vamp::Plugin::OutputDescriptor::name, Vamp::Plugin::OutputDescriptor::quantizeStep, Vamp::Plugin::OutputDescriptor::sampleRate, Vamp::Plugin::OutputDescriptor::sampleType, Vamp::Plugin::OutputDescriptor::unit, and Vamp::Plugin::OutputDescriptor::VariableSampleRate.
-References Vamp::Plugin::Plugin::OutputDescriptor::binCount, Vamp::Plugin::Plugin::OutputDescriptor::description, Vamp::Plugin::Plugin::OutputDescriptor::FixedSampleRate, FixedTempoEstimator::FixedTempoEstimator::D::getPreferredBlockSize(), Vamp::Plugin::Plugin::OutputDescriptor::hasDuration, Vamp::Plugin::Plugin::OutputDescriptor::hasFixedBinCount, Vamp::Plugin::Plugin::OutputDescriptor::hasKnownExtents, Vamp::Plugin::Plugin::OutputDescriptor::identifier, Vamp::Plugin::Plugin::OutputDescriptor::isQuantized, FixedTempoEstimator::FixedTempoEstimator::D::m_inputSampleRate, FixedTempoEstimator::FixedTempoEstimator::D::m_stepSize, Vamp::Plugin::Plugin::OutputDescriptor::maxValue, Vamp::Plugin::Plugin::OutputDescriptor::minValue, Vamp::Plugin::Plugin::OutputDescriptor::name, Vamp::Plugin::Plugin::OutputDescriptor::quantizeStep, Vamp::Plugin::Plugin::OutputDescriptor::sampleRate, Vamp::Plugin::Plugin::OutputDescriptor::sampleType, Vamp::Plugin::Plugin::OutputDescriptor::unit, and Vamp::Plugin::Plugin::OutputDescriptor::VariableSampleRate.
- -Referenced by FixedTempoEstimator::getOutputDescriptors().
+Referenced by FixedTempoEstimator::getOutputDescriptors().
- bool FixedTempoEstimator::FixedTempoEstimator::D::initialise +bool FixedTempoEstimator::D::initialise ( -size_t -channels, +size_t +channels, - size_t -stepSize, +size_t +stepSize, - size_t -blockSize size_t +blockSize ) -+ --+
Definition at line 252 of file FixedTempoEstimator.cpp.
-Definition at line 251 of file FixedTempoEstimator.cpp.
+References Vamp::Plugin::m_inputSampleRate.
-References FixedTempoEstimator::FixedTempoEstimator::D::m_blockSize, FixedTempoEstimator::FixedTempoEstimator::D::m_df, FixedTempoEstimator::FixedTempoEstimator::D::m_dfsize, FixedTempoEstimator::FixedTempoEstimator::D::m_inputSampleRate, FixedTempoEstimator::FixedTempoEstimator::D::m_maxdflen, FixedTempoEstimator::FixedTempoEstimator::D::m_n, FixedTempoEstimator::FixedTempoEstimator::D::m_priorMagnitudes, and FixedTempoEstimator::FixedTempoEstimator::D::m_stepSize.
- -Referenced by FixedTempoEstimator::initialise().
+Referenced by FixedTempoEstimator::initialise().
- void FixedTempoEstimator::FixedTempoEstimator::D::reset +void FixedTempoEstimator::D::reset ( -) +) --+
Definition at line 276 of file FixedTempoEstimator.cpp.
-Definition at line 275 of file FixedTempoEstimator.cpp.
- -References FixedTempoEstimator::FixedTempoEstimator::D::m_blockSize, FixedTempoEstimator::FixedTempoEstimator::D::m_df, FixedTempoEstimator::FixedTempoEstimator::D::m_dfsize, FixedTempoEstimator::FixedTempoEstimator::D::m_fr, FixedTempoEstimator::FixedTempoEstimator::D::m_lasttime, FixedTempoEstimator::FixedTempoEstimator::D::m_n, FixedTempoEstimator::FixedTempoEstimator::D::m_priorMagnitudes, FixedTempoEstimator::FixedTempoEstimator::D::m_r, FixedTempoEstimator::FixedTempoEstimator::D::m_start, and FixedTempoEstimator::FixedTempoEstimator::D::m_t.
- -Referenced by FixedTempoEstimator::reset().
+Referenced by FixedTempoEstimator::reset().
- FixedTempoEstimator::FeatureSet FixedTempoEstimator::FixedTempoEstimator::D::process +FixedTempoEstimator::FeatureSet FixedTempoEstimator::D::process ( -const float *const * -inputBuffers, +const float *const * +inputBuffers, - RealTime -ts RealTime +ts ) -+ --+
Definition at line 303 of file FixedTempoEstimator.cpp.
-Definition at line 302 of file FixedTempoEstimator.cpp.
- -References FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures(), FixedTempoEstimator::FixedTempoEstimator::D::calculate(), FixedTempoEstimator::FixedTempoEstimator::D::m_blockSize, FixedTempoEstimator::FixedTempoEstimator::D::m_df, FixedTempoEstimator::FixedTempoEstimator::D::m_dfsize, FixedTempoEstimator::FixedTempoEstimator::D::m_lasttime, FixedTempoEstimator::FixedTempoEstimator::D::m_n, FixedTempoEstimator::FixedTempoEstimator::D::m_priorMagnitudes, FixedTempoEstimator::FixedTempoEstimator::D::m_start, and FixedTempoEstimator::FixedTempoEstimator::D::m_stepSize.
- -Referenced by FixedTempoEstimator::process().
+Referenced by FixedTempoEstimator::process().
- FixedTempoEstimator::FeatureSet FixedTempoEstimator::FixedTempoEstimator::D::getRemainingFeatures +FixedTempoEstimator::FeatureSet FixedTempoEstimator::D::getRemainingFeatures ( -) +) --+
Definition at line 352 of file FixedTempoEstimator.cpp.
-Definition at line 351 of file FixedTempoEstimator.cpp.
- -References FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures(), FixedTempoEstimator::FixedTempoEstimator::D::calculate(), FixedTempoEstimator::FixedTempoEstimator::D::m_dfsize, and FixedTempoEstimator::FixedTempoEstimator::D::m_n.
- -Referenced by FixedTempoEstimator::getRemainingFeatures().
+Referenced by FixedTempoEstimator::getRemainingFeatures().
- void FixedTempoEstimator::FixedTempoEstimator::D::calculate +void FixedTempoEstimator::D::calculate ( -) +) [private]--+
Definition at line 375 of file FixedTempoEstimator.cpp.
-Definition at line 374 of file FixedTempoEstimator.cpp.
- -References FixedTempoEstimator::FixedTempoEstimator::D::lag2tempo(), FixedTempoEstimator::FixedTempoEstimator::D::m_df, FixedTempoEstimator::FixedTempoEstimator::D::m_dfsize, FixedTempoEstimator::FixedTempoEstimator::D::m_fr, FixedTempoEstimator::FixedTempoEstimator::D::m_inputSampleRate, FixedTempoEstimator::FixedTempoEstimator::D::m_n, FixedTempoEstimator::FixedTempoEstimator::D::m_r, FixedTempoEstimator::FixedTempoEstimator::D::m_stepSize, and FixedTempoEstimator::FixedTempoEstimator::D::m_t.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::getRemainingFeatures(), and FixedTempoEstimator::FixedTempoEstimator::D::process().
+References Vamp::Plugin::m_inputSampleRate.
- FixedTempoEstimator::FeatureSet FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures +FixedTempoEstimator::FeatureSet FixedTempoEstimator::D::assembleFeatures ( -) +) [private]--+
Definition at line 481 of file FixedTempoEstimator.cpp.
-Definition at line 480 of file FixedTempoEstimator.cpp.
- -References ACFOutput, CandidatesOutput, DFOutput, Vamp::Plugin::Plugin::Feature::duration, FilteredACFOutput, Vamp::Plugin::Plugin::Feature::hasDuration, Vamp::Plugin::Plugin::Feature::hasTimestamp, Vamp::Plugin::Plugin::Feature::label, FixedTempoEstimator::FixedTempoEstimator::D::lag2tempo(), FixedTempoEstimator::FixedTempoEstimator::D::m_df, FixedTempoEstimator::FixedTempoEstimator::D::m_fr, FixedTempoEstimator::FixedTempoEstimator::D::m_inputSampleRate, FixedTempoEstimator::FixedTempoEstimator::D::m_lasttime, FixedTempoEstimator::FixedTempoEstimator::D::m_maxbpm, FixedTempoEstimator::FixedTempoEstimator::D::m_minbpm, FixedTempoEstimator::FixedTempoEstimator::D::m_n, FixedTempoEstimator::FixedTempoEstimator::D::m_r, FixedTempoEstimator::FixedTempoEstimator::D::m_start, FixedTempoEstimator::FixedTempoEstimator::D::m_stepSize, FixedTempoEstimator::FixedTempoEstimator::D::m_t, FixedTempoEstimator::FixedTempoEstimator::D::tempo2lag(), TempoOutput, Vamp::Plugin::Plugin::Feature::timestamp, and Vamp::Plugin::Plugin::Feature::values.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::getRemainingFeatures(), and FixedTempoEstimator::FixedTempoEstimator::D::process().
+References ACFOutput, CandidatesOutput, DFOutput, Vamp::Plugin::Feature::duration, FilteredACFOutput, Vamp::Plugin::Feature::hasDuration, Vamp::Plugin::Feature::hasTimestamp, Vamp::Plugin::Feature::label, Vamp::Plugin::m_inputSampleRate, TempoOutput, Vamp::Plugin::Feature::timestamp, and Vamp::Plugin::Feature::values.
- float FixedTempoEstimator::FixedTempoEstimator::D::lag2tempo +float FixedTempoEstimator::D::lag2tempo ( -int -lag -) +int +lag ) [private]--+
Definition at line 363 of file FixedTempoEstimator.cpp.
-Definition at line 362 of file FixedTempoEstimator.cpp.
- -References FixedTempoEstimator::FixedTempoEstimator::D::m_inputSampleRate, and FixedTempoEstimator::FixedTempoEstimator::D::m_stepSize.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures(), and FixedTempoEstimator::FixedTempoEstimator::D::calculate().
+References Vamp::Plugin::m_inputSampleRate.
- int FixedTempoEstimator::FixedTempoEstimator::D::tempo2lag +int FixedTempoEstimator::D::tempo2lag ( -float -tempo -) +float +tempo ) [private]--+
Definition at line 369 of file FixedTempoEstimator.cpp.
-Definition at line 368 of file FixedTempoEstimator.cpp.
- -References FixedTempoEstimator::FixedTempoEstimator::D::m_inputSampleRate, and FixedTempoEstimator::FixedTempoEstimator::D::m_stepSize.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures().
+References Vamp::Plugin::m_inputSampleRate.
-
Member Data Documentation
- + +Member Data Documentation
+- float FixedTempoEstimator::FixedTempoEstimator::D::m_inputSampleRate +[private]float FixedTempoEstimator::D::m_inputSampleRate [private]--- -
Definition at line 77 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures(), FixedTempoEstimator::FixedTempoEstimator::D::calculate(), FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors(), FixedTempoEstimator::FixedTempoEstimator::D::initialise(), FixedTempoEstimator::FixedTempoEstimator::D::lag2tempo(), and FixedTempoEstimator::FixedTempoEstimator::D::tempo2lag().
+Definition at line 78 of file FixedTempoEstimator.cpp.
- size_t FixedTempoEstimator::FixedTempoEstimator::D::m_stepSize +[private]size_t FixedTempoEstimator::D::m_stepSize [private]--- -
Definition at line 78 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures(), FixedTempoEstimator::FixedTempoEstimator::D::calculate(), FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors(), FixedTempoEstimator::FixedTempoEstimator::D::initialise(), FixedTempoEstimator::FixedTempoEstimator::D::lag2tempo(), FixedTempoEstimator::FixedTempoEstimator::D::process(), and FixedTempoEstimator::FixedTempoEstimator::D::tempo2lag().
+Definition at line 79 of file FixedTempoEstimator.cpp.
- size_t FixedTempoEstimator::FixedTempoEstimator::D::m_blockSize +[private]size_t FixedTempoEstimator::D::m_blockSize [private]--- -
Definition at line 79 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::initialise(), FixedTempoEstimator::FixedTempoEstimator::D::process(), and FixedTempoEstimator::FixedTempoEstimator::D::reset().
+Definition at line 80 of file FixedTempoEstimator.cpp.
- float FixedTempoEstimator::FixedTempoEstimator::D::m_minbpm +[private]float FixedTempoEstimator::D::m_minbpm [private]--- -
Definition at line 81 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures(), FixedTempoEstimator::FixedTempoEstimator::D::getParameter(), and FixedTempoEstimator::FixedTempoEstimator::D::setParameter().
+Definition at line 82 of file FixedTempoEstimator.cpp.
- float FixedTempoEstimator::FixedTempoEstimator::D::m_maxbpm +[private]float FixedTempoEstimator::D::m_maxbpm [private]--- -
Definition at line 82 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures(), FixedTempoEstimator::FixedTempoEstimator::D::getParameter(), and FixedTempoEstimator::FixedTempoEstimator::D::setParameter().
+Definition at line 83 of file FixedTempoEstimator.cpp.
- float FixedTempoEstimator::FixedTempoEstimator::D::m_maxdflen +[private]float FixedTempoEstimator::D::m_maxdflen [private]--- -
Definition at line 83 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::getParameter(), FixedTempoEstimator::FixedTempoEstimator::D::initialise(), and FixedTempoEstimator::FixedTempoEstimator::D::setParameter().
+Definition at line 84 of file FixedTempoEstimator.cpp.
- float* FixedTempoEstimator::FixedTempoEstimator::D::m_priorMagnitudes +[private]float* FixedTempoEstimator::D::m_priorMagnitudes [private]--- -
Definition at line 85 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::initialise(), FixedTempoEstimator::FixedTempoEstimator::D::process(), FixedTempoEstimator::FixedTempoEstimator::D::reset(), and FixedTempoEstimator::FixedTempoEstimator::D::~D().
+Definition at line 86 of file FixedTempoEstimator.cpp.
- size_t FixedTempoEstimator::FixedTempoEstimator::D::m_dfsize +[private]size_t FixedTempoEstimator::D::m_dfsize [private]--- -
Definition at line 87 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::calculate(), FixedTempoEstimator::FixedTempoEstimator::D::getRemainingFeatures(), FixedTempoEstimator::FixedTempoEstimator::D::initialise(), FixedTempoEstimator::FixedTempoEstimator::D::process(), and FixedTempoEstimator::FixedTempoEstimator::D::reset().
+Definition at line 88 of file FixedTempoEstimator.cpp.
- float* FixedTempoEstimator::FixedTempoEstimator::D::m_df +[private]float* FixedTempoEstimator::D::m_df [private]--- -
Definition at line 88 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures(), FixedTempoEstimator::FixedTempoEstimator::D::calculate(), FixedTempoEstimator::FixedTempoEstimator::D::initialise(), FixedTempoEstimator::FixedTempoEstimator::D::process(), FixedTempoEstimator::FixedTempoEstimator::D::reset(), and FixedTempoEstimator::FixedTempoEstimator::D::~D().
+Definition at line 89 of file FixedTempoEstimator.cpp.
- float* FixedTempoEstimator::FixedTempoEstimator::D::m_r +[private]float* FixedTempoEstimator::D::m_r [private]--- -
Definition at line 89 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures(), FixedTempoEstimator::FixedTempoEstimator::D::calculate(), FixedTempoEstimator::FixedTempoEstimator::D::reset(), and FixedTempoEstimator::FixedTempoEstimator::D::~D().
+Definition at line 90 of file FixedTempoEstimator.cpp.
- float* FixedTempoEstimator::FixedTempoEstimator::D::m_fr +[private]float* FixedTempoEstimator::D::m_fr [private]--- -
Definition at line 90 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures(), FixedTempoEstimator::FixedTempoEstimator::D::calculate(), FixedTempoEstimator::FixedTempoEstimator::D::reset(), and FixedTempoEstimator::FixedTempoEstimator::D::~D().
+Definition at line 91 of file FixedTempoEstimator.cpp.
- float* FixedTempoEstimator::FixedTempoEstimator::D::m_t +[private]float* FixedTempoEstimator::D::m_t [private]--- -
Definition at line 91 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures(), FixedTempoEstimator::FixedTempoEstimator::D::calculate(), FixedTempoEstimator::FixedTempoEstimator::D::reset(), and FixedTempoEstimator::FixedTempoEstimator::D::~D().
+Definition at line 92 of file FixedTempoEstimator.cpp.
- size_t FixedTempoEstimator::FixedTempoEstimator::D::m_n +[private]size_t FixedTempoEstimator::D::m_n [private]--- -
Definition at line 92 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures(), FixedTempoEstimator::FixedTempoEstimator::D::calculate(), FixedTempoEstimator::FixedTempoEstimator::D::getRemainingFeatures(), FixedTempoEstimator::FixedTempoEstimator::D::initialise(), FixedTempoEstimator::FixedTempoEstimator::D::process(), and FixedTempoEstimator::FixedTempoEstimator::D::reset().
+Definition at line 93 of file FixedTempoEstimator.cpp.
- Vamp::RealTime FixedTempoEstimator::FixedTempoEstimator::D::m_start +[private]Vamp::RealTime FixedTempoEstimator::D::m_start [private]--- -
Definition at line 94 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures(), FixedTempoEstimator::FixedTempoEstimator::D::process(), and FixedTempoEstimator::FixedTempoEstimator::D::reset().
+Definition at line 95 of file FixedTempoEstimator.cpp.
- Vamp::RealTime FixedTempoEstimator::FixedTempoEstimator::D::m_lasttime +[private]Vamp::RealTime FixedTempoEstimator::D::m_lasttime [private]--- -
Definition at line 95 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures(), FixedTempoEstimator::FixedTempoEstimator::D::process(), and FixedTempoEstimator::FixedTempoEstimator::D::reset().
+Definition at line 96 of file FixedTempoEstimator.cpp.
-
The documentation for this class was generated from the following file: -
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - - 1.5.8
+
The documentation for this class was generated from the following file: + + +++ + diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classFixedTempoEstimator__inherit__graph.map --- a/code-doc/classFixedTempoEstimator__inherit__graph.map Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classFixedTempoEstimator__inherit__graph.map Tue Oct 04 13:47:23 2011 +0000 @@ -1,2 +1,4 @@ - - + diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classFixedTempoEstimator__inherit__graph.md5 --- a/code-doc/classFixedTempoEstimator__inherit__graph.md5 Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classFixedTempoEstimator__inherit__graph.md5 Tue Oct 04 13:47:23 2011 +0000 @@ -1,1 +1,1 @@ -1d36adeb8d0567742a38a2cf7d68b259 \ No newline at end of file +326039cc76da1b1dddbe8c796ad3202b \ No newline at end of file diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classFixedTempoEstimator__inherit__graph.png Binary file code-doc/classFixedTempoEstimator__inherit__graph.png has changed diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classPercussionOnsetDetector-members.html --- a/code-doc/classPercussionOnsetDetector-members.html Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classPercussionOnsetDetector-members.html Tue Oct 04 13:47:23 2011 +0000 @@ -1,78 +1,138 @@ - - + + + +-
+
+
+
+
VampPluginSDK: Member List - - - - ----
-
+ + +++ + + -+ +
++ + + + ++ + + + +VampPluginSDK + 2.1 ++ +-+ + +-
-
++++PercussionOnsetDetector Member List-PercussionOnsetDetector Member List
This is the complete list of members for PercussionOnsetDetector, including all inherited members.-
FeatureList typedef Vamp::Plugin FeatureSet typedef Vamp::Plugin FrequencyDomain enum value Vamp::Plugin getCopyright() const PercussionOnsetDetector [virtual]getCurrentProgram() const Vamp::PluginBase [inline, virtual]getDescription() const PercussionOnsetDetector [virtual]getIdentifier() const PercussionOnsetDetector [virtual]getInputDomain() const PercussionOnsetDetector [inline, virtual]getMaker() const PercussionOnsetDetector [virtual]getMaxChannelCount() const Vamp::Plugin [inline, virtual]getMinChannelCount() const Vamp::Plugin [inline, virtual]getName() const PercussionOnsetDetector [virtual]getOutputDescriptors() const PercussionOnsetDetector [virtual]getParameter(std::string id) const PercussionOnsetDetector [virtual]getParameterDescriptors() const PercussionOnsetDetector [virtual]getPluginVersion() const PercussionOnsetDetector [virtual]getPreferredBlockSize() const PercussionOnsetDetector [virtual]getPreferredStepSize() const PercussionOnsetDetector [virtual]getPrograms() const Vamp::PluginBase [inline, virtual]getRemainingFeatures() PercussionOnsetDetector [virtual]getType() const Vamp::Plugin [inline, virtual]getVampApiVersion() const Vamp::PluginBase [inline, virtual]initialise(size_t channels, size_t stepSize, size_t blockSize) PercussionOnsetDetector [virtual]InputDomain enum name Vamp::Plugin m_blockSize PercussionOnsetDetector [protected]m_dfMinus1 PercussionOnsetDetector [protected]m_dfMinus2 PercussionOnsetDetector [protected]m_inputSampleRate Vamp::Plugin [protected]m_priorMagnitudes PercussionOnsetDetector [protected]m_sensitivity PercussionOnsetDetector [protected]m_stepSize PercussionOnsetDetector [protected]m_threshold PercussionOnsetDetector [protected]OutputList typedef Vamp::Plugin ParameterList typedef Vamp::PluginBase PercussionOnsetDetector(float inputSampleRate) PercussionOnsetDetector Plugin(float inputSampleRate) Vamp::Plugin [inline, protected]process(const float *const *inputBuffers, Vamp::RealTime timestamp) PercussionOnsetDetector [virtual]ProgramList typedef Vamp::PluginBase reset() PercussionOnsetDetector [virtual]selectProgram(std::string) Vamp::PluginBase [inline, virtual]setParameter(std::string id, float value) PercussionOnsetDetector [virtual]TimeDomain enum value Vamp::Plugin ~PercussionOnsetDetector() PercussionOnsetDetector [virtual]~Plugin() Vamp::Plugin [inline, virtual]~PluginBase() Vamp::PluginBase [inline, virtual]
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - - 1.5.8
+
+ ++ + diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classPercussionOnsetDetector.html --- a/code-doc/classPercussionOnsetDetector.html Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classPercussionOnsetDetector.html Tue Oct 04 13:47:23 2011 +0000 @@ -1,1144 +1,1093 @@ - - + + + +-
+
+
VampPluginSDK: PercussionOnsetDetector Class Reference - - - - --+-+-
-
+ + ++++ + + -+ +
++ + + + ++ + + + +VampPluginSDK + 2.1 ++ +-+ + +-
-
+++ +++PercussionOnsetDetector Class Reference-PercussionOnsetDetector Class Reference
Example plugin that detects percussive events. -More... --
#include <PercussionOnsetDetector.h>-+ +
Example plugin that detects percussive events. + More...
+ +#include <PercussionOnsetDetector.h>Inheritance diagram for PercussionOnsetDetector:--+
[legend] +-+ +[legend] -
-Public Types
enum InputDomain { TimeDomain, -FrequencyDomain + + +
++Public Types
enum InputDomain { TimeDomain, +FrequencyDomain } typedef std::vector
+< OutputDescriptor >OutputList typedef std::vector< Feature > FeatureList typedef std::map< int,
+FeatureList >FeatureSet typedef std::vector
+< ParameterDescriptor >ParameterList 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. +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 Detailed Description
+Example plugin that detects percussive events.
-typedef std::vector
-< OutputDescriptor >OutputList typedef std::vector< Feature > FeatureList typedef std::map< int,
-FeatureList >FeatureSet 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. 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 Detailed Description
-Example plugin that detects percussive events. -Definition at line 46 of file PercussionOnsetDetector.h.
-Member Typedef Documentation
- +Definition at line 46 of file PercussionOnsetDetector.h.
+Member Typedef Documentation
+- typedef std::vector<OutputDescriptor> Vamp::Plugin::OutputList +[inherited]typedef std::vector<OutputDescriptor> Vamp::Plugin::OutputList [inherited]--- -
Definition at line 327 of file vamp-sdk/Plugin.h.
+Definition at line 327 of file vamp-sdk/Plugin.h.
- typedef std::vector<Feature> Vamp::Plugin::FeatureList +[inherited]typedef std::vector<Feature> Vamp::Plugin::FeatureList [inherited]--- -
Definition at line 385 of file vamp-sdk/Plugin.h.
+Definition at line 385 of file vamp-sdk/Plugin.h.
- typedef std::map<int, FeatureList> Vamp::Plugin::FeatureSet +[inherited]typedef std::map<int, FeatureList> Vamp::Plugin::FeatureSet [inherited]--- -
Definition at line 387 of file vamp-sdk/Plugin.h.
+Definition at line 387 of file vamp-sdk/Plugin.h.
- typedef std::vector<ParameterDescriptor> Vamp::PluginBase::ParameterList +[inherited]typedef std::vector<ParameterDescriptor> Vamp::PluginBase::ParameterList [inherited]--- -
Definition at line 203 of file vamp-sdk/PluginBase.h.
+Definition at line 203 of file vamp-sdk/PluginBase.h.
- typedef std::vector<std::string> Vamp::PluginBase::ProgramList +[inherited]typedef std::vector<std::string> Vamp::PluginBase::ProgramList [inherited]--- -
Definition at line 225 of file vamp-sdk/PluginBase.h.
+Definition at line 225 of file vamp-sdk/PluginBase.h.
-
Member Enumeration Documentation
- + +Member Enumeration Documentation
+- enum Vamp::Plugin::InputDomain +[inherited]enum Vamp::Plugin::InputDomain [inherited]- --
- Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
+
+
+ + +++ + + -+ +
++ + + + ++ + + + +VampPluginSDK + 2.1 ++ +-+ + +-
-
++++FixedTempoEstimator Member List-FixedTempoEstimator Member List
This is the complete list of members for FixedTempoEstimator, including all inherited members.-
FeatureList typedef Vamp::Plugin FeatureSet typedef Vamp::Plugin FixedTempoEstimator(float inputSampleRate) FixedTempoEstimator FrequencyDomain enum value Vamp::Plugin getCopyright() const FixedTempoEstimator [virtual]getCurrentProgram() const Vamp::PluginBase [inline, virtual]getDescription() const FixedTempoEstimator [virtual]getIdentifier() const FixedTempoEstimator [virtual]getInputDomain() const FixedTempoEstimator [inline, virtual]getMaker() const FixedTempoEstimator [virtual]getMaxChannelCount() const Vamp::Plugin [inline, virtual]getMinChannelCount() const Vamp::Plugin [inline, virtual]getName() const FixedTempoEstimator [virtual]getOutputDescriptors() const FixedTempoEstimator [virtual]getParameter(std::string id) const FixedTempoEstimator [virtual]getParameterDescriptors() const FixedTempoEstimator [virtual]getPluginVersion() const FixedTempoEstimator [virtual]getPreferredBlockSize() const FixedTempoEstimator [virtual]getPreferredStepSize() const FixedTempoEstimator [virtual]getPrograms() const Vamp::PluginBase [inline, virtual]getRemainingFeatures() FixedTempoEstimator [virtual]getType() const Vamp::Plugin [inline, virtual]getVampApiVersion() const Vamp::PluginBase [inline, virtual]initialise(size_t channels, size_t stepSize, size_t blockSize) FixedTempoEstimator [virtual]InputDomain enum name Vamp::Plugin m_d FixedTempoEstimator [protected]m_inputSampleRate Vamp::Plugin [protected]OutputList typedef Vamp::Plugin ParameterList typedef Vamp::PluginBase Plugin(float inputSampleRate) Vamp::Plugin [inline, protected]process(const float *const *inputBuffers, Vamp::RealTime timestamp) FixedTempoEstimator [virtual]ProgramList typedef Vamp::PluginBase reset() FixedTempoEstimator [virtual]selectProgram(std::string) Vamp::PluginBase [inline, virtual]setParameter(std::string id, float value) FixedTempoEstimator [virtual]TimeDomain enum value Vamp::Plugin ~FixedTempoEstimator() FixedTempoEstimator [virtual]~Plugin() Vamp::Plugin [inline, virtual]~PluginBase() Vamp::PluginBase [inline, virtual]
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - - 1.5.8
+
+ ++ + diff -r f75f330aa130 -r 8260c0f4e05b code-doc/classFixedTempoEstimator.html --- a/code-doc/classFixedTempoEstimator.html Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classFixedTempoEstimator.html Tue Oct 04 13:47:23 2011 +0000 @@ -1,1027 +1,997 @@ - - + + + +-
+
+
VampPluginSDK: FixedTempoEstimator Class Reference - - - - --+-+-
-
+ + ++++ + + -+ +
++ + + + ++ + + + +VampPluginSDK + 2.1 ++ +-+ + +-
-
+++ +++FixedTempoEstimator Class Reference-FixedTempoEstimator Class Reference
Example plugin that estimates the tempo of a short fixed-tempo sample. -More... --
#include <FixedTempoEstimator.h>-+ +
Example plugin that estimates the tempo of a short fixed-tempo sample. + More...
+ +#include <FixedTempoEstimator.h>Inheritance diagram for FixedTempoEstimator:--+
[legend] +-+ +[legend] -
-Classes
class D +
++Classes
class D +Public Types
enum InputDomain { TimeDomain, +FrequencyDomain + } typedef std::vector
+< OutputDescriptor >OutputList typedef std::vector< Feature > FeatureList typedef std::map< int,
+FeatureList >FeatureSet typedef std::vector
+< ParameterDescriptor >ParameterList 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. +Protected Attributes
D * m_d float m_inputSampleRate Detailed Description
+Example plugin that estimates the tempo of a short fixed-tempo sample.
-Public Types
enum InputDomain { TimeDomain, -FrequencyDomain - } typedef std::vector
-< OutputDescriptor >OutputList typedef std::vector< Feature > FeatureList typedef std::map< int,
-FeatureList >FeatureSet 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. Protected Attributes
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
- +Definition at line 46 of file FixedTempoEstimator.h.
+Member Typedef Documentation
+- typedef std::vector<OutputDescriptor> Vamp::Plugin::OutputList +[inherited]typedef std::vector<OutputDescriptor> Vamp::Plugin::OutputList [inherited]--- -
Definition at line 327 of file vamp-sdk/Plugin.h.
+Definition at line 327 of file vamp-sdk/Plugin.h.
- typedef std::vector<Feature> Vamp::Plugin::FeatureList +[inherited]typedef std::vector<Feature> Vamp::Plugin::FeatureList [inherited]--- -
Definition at line 385 of file vamp-sdk/Plugin.h.
+Definition at line 385 of file vamp-sdk/Plugin.h.
- typedef std::map<int, FeatureList> Vamp::Plugin::FeatureSet +[inherited]typedef std::map<int, FeatureList> Vamp::Plugin::FeatureSet [inherited]--- -
Definition at line 387 of file vamp-sdk/Plugin.h.
+Definition at line 387 of file vamp-sdk/Plugin.h.
- typedef std::vector<ParameterDescriptor> Vamp::PluginBase::ParameterList +[inherited]typedef std::vector<ParameterDescriptor> Vamp::PluginBase::ParameterList [inherited]--- -
Definition at line 203 of file vamp-sdk/PluginBase.h.
+Definition at line 203 of file vamp-sdk/PluginBase.h.
- typedef std::vector<std::string> Vamp::PluginBase::ProgramList +[inherited]typedef std::vector<std::string> Vamp::PluginBase::ProgramList [inherited]--- -
Definition at line 225 of file vamp-sdk/PluginBase.h.
+Definition at line 225 of file vamp-sdk/PluginBase.h.
-
Member Enumeration Documentation
- + +Member Enumeration Documentation
+- enum Vamp::Plugin::InputDomain +[inherited]enum Vamp::Plugin::InputDomain [inherited]- --
- Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+-
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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 This file copyright 2006 Dan Stowell. +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 #include "AmplitudeFollower.h" +00038 +00039 #include <cmath> +00040 +00041 #include <string> +00042 #include <vector> +00043 #include <iostream> +00044 +00045 using std::string; +00046 using std::vector; +00047 using std::cerr; +00048 using std::endl; +00049 +00055 AmplitudeFollower::AmplitudeFollower(float inputSampleRate) : +00056 Plugin(inputSampleRate), +00057 m_stepSize(0), +00058 m_previn(0.0f), +00059 m_clampcoef(0.01f), +00060 m_relaxcoef(0.01f) +00061 { +00062 } +00063 +00064 AmplitudeFollower::~AmplitudeFollower() +00065 { +00066 } +00067 +00068 string +00069 AmplitudeFollower::getIdentifier() const +00070 { +00071 return "amplitudefollower"; +00072 } +00073 +00074 string +00075 AmplitudeFollower::getName() const +00076 { +00077 return "Amplitude Follower"; +00078 } +00079 +00080 string +00081 AmplitudeFollower::getDescription() const +00082 { +00083 return "Track the amplitude of the audio signal"; +00084 } +00085 +00086 string +00087 AmplitudeFollower::getMaker() const +00088 { +00089 return "Vamp SDK Example Plugins"; +00090 } +00091 +00092 int +00093 AmplitudeFollower::getPluginVersion() const +00094 { +00095 return 1; +00096 } +00097 +00098 string +00099 AmplitudeFollower::getCopyright() const +00100 { +00101 return "Code copyright 2006 Dan Stowell; method from SuperCollider. Freely redistributable (BSD license)"; +00102 } +00103 +00104 bool +00105 AmplitudeFollower::initialise(size_t channels, size_t stepSize, size_t blockSize) +00106 { +00107 if (channels < getMinChannelCount() || +00108 channels > getMaxChannelCount()) return false; +00109 +00110 m_stepSize = std::min(stepSize, blockSize); +00111 +00112 // Translate the coefficients +00113 // from their "convenient" 60dB convergence-time values +00114 // to real coefficients +00115 m_clampcoef = m_clampcoef==0.0 ? 0.0 : exp(log(0.1)/(m_clampcoef * m_inputSampleRate)); +00116 m_relaxcoef = m_relaxcoef==0.0 ? 0.0 : exp(log(0.1)/(m_relaxcoef * m_inputSampleRate)); +00117 +00118 return true; +00119 } +00120 +00121 void +00122 AmplitudeFollower::reset() +00123 { +00124 m_previn = 0.0f; +00125 } +00126 +00127 AmplitudeFollower::OutputList +00128 AmplitudeFollower::getOutputDescriptors() const +00129 { +00130 OutputList list; +00131 +00132 OutputDescriptor sca; +00133 sca.identifier = "amplitude"; +00134 sca.name = "Amplitude"; +00135 sca.description = "The peak tracked amplitude for the current processing block"; +00136 sca.unit = "V"; +00137 sca.hasFixedBinCount = true; +00138 sca.binCount = 1; +00139 sca.hasKnownExtents = false; +00140 sca.isQuantized = false; +00141 sca.sampleType = OutputDescriptor::OneSamplePerStep; +00142 list.push_back(sca); +00143 +00144 return list; +00145 } +00146 +00147 AmplitudeFollower::ParameterList +00148 AmplitudeFollower::getParameterDescriptors() const +00149 { +00150 ParameterList list; +00151 +00152 ParameterDescriptor att; +00153 att.identifier = "attack"; +00154 att.name = "Attack time"; +00155 att.description = "The 60dB convergence time for an increase in amplitude"; +00156 att.unit = "s"; +00157 att.minValue = 0.0f; +00158 att.maxValue = 1.f; +00159 att.defaultValue = 0.01f; +00160 att.isQuantized = false; +00161 +00162 list.push_back(att); +00163 +00164 ParameterDescriptor dec; +00165 dec.identifier = "release"; +00166 dec.name = "Release time"; +00167 dec.description = "The 60dB convergence time for a decrease in amplitude"; +00168 dec.unit = "s"; +00169 dec.minValue = 0.0f; +00170 dec.maxValue = 1.f; +00171 dec.defaultValue = 0.01f; +00172 dec.isQuantized = false; +00173 +00174 list.push_back(dec); +00175 +00176 return list; +00177 } +00178 +00179 void AmplitudeFollower::setParameter(std::string paramid, float newval) +00180 { +00181 if (paramid == "attack") { +00182 m_clampcoef = newval; +00183 } else if (paramid == "release") { +00184 m_relaxcoef = newval; +00185 } +00186 } +00187 +00188 float AmplitudeFollower::getParameter(std::string paramid) const +00189 { +00190 if (paramid == "attack") { +00191 return m_clampcoef; +00192 } else if (paramid == "release") { +00193 return m_relaxcoef; +00194 } +00195 +00196 return 0.0f; +00197 } +00198 +00199 AmplitudeFollower::FeatureSet +00200 AmplitudeFollower::process(const float *const *inputBuffers, +00201 Vamp::RealTime timestamp) +00202 { +00203 if (m_stepSize == 0) { +00204 cerr << "ERROR: AmplitudeFollower::process: " +00205 << "AmplitudeFollower has not been initialised" +00206 << endl; +00207 return FeatureSet(); +00208 } +00209 +00210 float previn = m_previn; +00211 +00212 FeatureSet returnFeatures; +00213 +00214 float val; +00215 float peak = 0.0f; +00216 +00217 for (size_t i = 0; i < m_stepSize; ++i) { +00218 +00219 val = fabs(inputBuffers[0][i]); +00220 +00221 if (val < previn) { +00222 val = val + (previn - val) * m_relaxcoef; +00223 } else { +00224 val = val + (previn - val) * m_clampcoef; +00225 } +00226 +00227 if (val > peak) peak = val; +00228 previn = val; +00229 } +00230 +00231 m_previn = previn; +00232 +00233 // Now store the "feature" (peak amp) for this sample +00234 Feature feature; +00235 feature.hasTimestamp = false; +00236 feature.values.push_back(peak); +00237 returnFeatures[0].push_back(feature); +00238 +00239 return returnFeatures; +00240 } +00241 +00242 AmplitudeFollower::FeatureSet +00243 AmplitudeFollower::getRemainingFeatures() +00244 { +00245 return FeatureSet(); +00246 } +00247 +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
AmplitudeFollower.h File Reference
--Go to the source code of this file.
Classes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| class | AmplitudeFollower | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Example plugin implementing the SuperCollider amplitude follower function. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+Classes | |
| class | AmplitudeFollower |
| Example plugin implementing the SuperCollider amplitude follower function. More... | |
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+
+ -
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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 This file copyright 2006 Dan Stowell. +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 _AMPLITUDE_FOLLOWER_PLUGIN_H_ +00038 #define _AMPLITUDE_FOLLOWER_PLUGIN_H_ +00039 +00040 #include "vamp-sdk/Plugin.h" +00041 +00047 class AmplitudeFollower : public Vamp::Plugin +00048 { +00049 public: +00050 AmplitudeFollower(float inputSampleRate); +00051 virtual ~AmplitudeFollower(); +00052 +00053 bool initialise(size_t channels, size_t stepSize, size_t blockSize); +00054 void reset(); +00055 +00056 InputDomain getInputDomain() const { return TimeDomain; } +00057 +00058 std::string getIdentifier() const; +00059 std::string getName() const; +00060 std::string getDescription() const; +00061 std::string getMaker() const; +00062 int getPluginVersion() const; +00063 std::string getCopyright() const; +00064 +00065 OutputList getOutputDescriptors() const; +00066 +00067 ParameterList getParameterDescriptors() const; +00068 float getParameter(std::string paramid) const; +00069 void setParameter(std::string paramid, float newval); +00070 +00071 FeatureSet process(const float *const *inputBuffers, +00072 Vamp::RealTime timestamp); +00073 +00074 FeatureSet getRemainingFeatures(); +00075 +00076 protected: +00077 size_t m_stepSize; +00078 float m_previn; +00079 float m_clampcoef; +00080 float m_relaxcoef; +00081 }; +00082 +00083 +00084 #endif +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
FixedTempoEstimator.cpp File Reference
--Go to the source code of this file.
Classes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| class | FixedTempoEstimator::FixedTempoEstimator::D | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Variables | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static int | TempoOutput = 0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static int | CandidatesOutput = 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static int | DFOutput = 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static int | ACFOutput = 3 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| static int | FilteredACFOutput = 4 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+Classes | |
| class | FixedTempoEstimator::D |
+Variables | |
| static int | TempoOutput = 0 |
| static int | CandidatesOutput = 1 |
| static int | DFOutput = 2 |
| static int | ACFOutput = 3 |
| static int | FilteredACFOutput = 4 |
Variable Documentation
- +Variable Documentation
+int TempoOutput = 0 [static] |
+ int TempoOutput = 0 [static] |
+
Definition at line 183 of file FixedTempoEstimator.cpp.
-Definition at line 182 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures().
+Referenced by FixedTempoEstimator::D::assembleFeatures().
int CandidatesOutput = 1 [static] |
+ int CandidatesOutput = 1 [static] |
+
Definition at line 184 of file FixedTempoEstimator.cpp.
-Definition at line 183 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures().
+Referenced by FixedTempoEstimator::D::assembleFeatures().
+
Definition at line 185 of file FixedTempoEstimator.cpp.
-Definition at line 184 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures().
+Referenced by FixedTempoEstimator::D::assembleFeatures().
+
Definition at line 186 of file FixedTempoEstimator.cpp.
-Definition at line 185 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures().
+Referenced by FixedTempoEstimator::D::assembleFeatures().
int FilteredACFOutput = 4 [static] |
+ int FilteredACFOutput = 4 [static] |
+
Definition at line 187 of file FixedTempoEstimator.cpp.
-Definition at line 186 of file FixedTempoEstimator.cpp.
- -Referenced by FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures().
+Referenced by FixedTempoEstimator::D::assembleFeatures().
-
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+
+
+ -
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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-2009 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 #include "FixedTempoEstimator.h" +00038 +00039 using std::string; +00040 using std::vector; +00041 using std::cerr; +00042 using std::endl; +00043 +00044 using Vamp::RealTime; +00045 +00046 #include <cmath> +00047 #include <cstdio> +00048 +00049 +00050 class FixedTempoEstimator::D +00051 // this class just avoids us having to declare any data members in the header +00052 { +00053 public: +00054 D(float inputSampleRate); +00055 ~D(); +00056 +00057 size_t getPreferredStepSize() const { return 64; } +00058 size_t getPreferredBlockSize() const { return 256; } +00059 +00060 ParameterList getParameterDescriptors() const; +00061 float getParameter(string id) const; +00062 void setParameter(string id, float value); +00063 +00064 OutputList getOutputDescriptors() const; +00065 +00066 bool initialise(size_t channels, size_t stepSize, size_t blockSize); +00067 void reset(); +00068 FeatureSet process(const float *const *, RealTime); +00069 FeatureSet getRemainingFeatures(); +00070 +00071 private: +00072 void calculate(); +00073 FeatureSet assembleFeatures(); +00074 +00075 float lag2tempo(int); +00076 int tempo2lag(float); +00077 +00078 float m_inputSampleRate; +00079 size_t m_stepSize; +00080 size_t m_blockSize; +00081 +00082 float m_minbpm; +00083 float m_maxbpm; +00084 float m_maxdflen; +00085 +00086 float *m_priorMagnitudes; +00087 +00088 size_t m_dfsize; +00089 float *m_df; +00090 float *m_r; +00091 float *m_fr; +00092 float *m_t; +00093 size_t m_n; +00094 +00095 Vamp::RealTime m_start; +00096 Vamp::RealTime m_lasttime; +00097 }; +00098 +00099 FixedTempoEstimator::D::D(float inputSampleRate) : +00100 m_inputSampleRate(inputSampleRate), +00101 m_stepSize(0), +00102 m_blockSize(0), +00103 m_minbpm(50), +00104 m_maxbpm(190), +00105 m_maxdflen(10), +00106 m_priorMagnitudes(0), +00107 m_df(0), +00108 m_r(0), +00109 m_fr(0), +00110 m_t(0), +00111 m_n(0) +00112 { +00113 } +00114 +00115 FixedTempoEstimator::D::~D() +00116 { +00117 delete[] m_priorMagnitudes; +00118 delete[] m_df; +00119 delete[] m_r; +00120 delete[] m_fr; +00121 delete[] m_t; +00122 } +00123 +00124 FixedTempoEstimator::ParameterList +00125 FixedTempoEstimator::D::getParameterDescriptors() const +00126 { +00127 ParameterList list; +00128 +00129 ParameterDescriptor d; +00130 d.identifier = "minbpm"; +00131 d.name = "Minimum estimated tempo"; +00132 d.description = "Minimum beat-per-minute value which the tempo estimator is able to return"; +00133 d.unit = "bpm"; +00134 d.minValue = 10; +00135 d.maxValue = 360; +00136 d.defaultValue = 50; +00137 d.isQuantized = false; +00138 list.push_back(d); +00139 +00140 d.identifier = "maxbpm"; +00141 d.name = "Maximum estimated tempo"; +00142 d.description = "Maximum beat-per-minute value which the tempo estimator is able to return"; +00143 d.defaultValue = 190; +00144 list.push_back(d); +00145 +00146 d.identifier = "maxdflen"; +00147 d.name = "Input duration to study"; +00148 d.description = "Length of audio input, in seconds, which should be taken into account when estimating tempo. There is no need to supply the plugin with any further input once this time has elapsed since the start of the audio. The tempo estimator may use only the first part of this, up to eight times the slowest beat duration: increasing this value further than that is unlikely to improve results."; +00149 d.unit = "s"; +00150 d.minValue = 2; +00151 d.maxValue = 40; +00152 d.defaultValue = 10; +00153 list.push_back(d); +00154 +00155 return list; +00156 } +00157 +00158 float +00159 FixedTempoEstimator::D::getParameter(string id) const +00160 { +00161 if (id == "minbpm") { +00162 return m_minbpm; +00163 } else if (id == "maxbpm") { +00164 return m_maxbpm; +00165 } else if (id == "maxdflen") { +00166 return m_maxdflen; +00167 } +00168 return 0.f; +00169 } +00170 +00171 void +00172 FixedTempoEstimator::D::setParameter(string id, float value) +00173 { +00174 if (id == "minbpm") { +00175 m_minbpm = value; +00176 } else if (id == "maxbpm") { +00177 m_maxbpm = value; +00178 } else if (id == "maxdflen") { +00179 m_maxdflen = value; +00180 } +00181 } +00182 +00183 static int TempoOutput = 0; +00184 static int CandidatesOutput = 1; +00185 static int DFOutput = 2; +00186 static int ACFOutput = 3; +00187 static int FilteredACFOutput = 4; +00188 +00189 FixedTempoEstimator::OutputList +00190 FixedTempoEstimator::D::getOutputDescriptors() const +00191 { +00192 OutputList list; +00193 +00194 OutputDescriptor d; +00195 d.identifier = "tempo"; +00196 d.name = "Tempo"; +00197 d.description = "Estimated tempo"; +00198 d.unit = "bpm"; +00199 d.hasFixedBinCount = true; +00200 d.binCount = 1; +00201 d.hasKnownExtents = false; +00202 d.isQuantized = false; +00203 d.sampleType = OutputDescriptor::VariableSampleRate; +00204 d.sampleRate = m_inputSampleRate; +00205 d.hasDuration = true; // our returned tempo spans a certain range +00206 list.push_back(d); +00207 +00208 d.identifier = "candidates"; +00209 d.name = "Tempo candidates"; +00210 d.description = "Possible tempo estimates, one per bin with the most likely in the first bin"; +00211 d.unit = "bpm"; +00212 d.hasFixedBinCount = false; +00213 list.push_back(d); +00214 +00215 d.identifier = "detectionfunction"; +00216 d.name = "Detection Function"; +00217 d.description = "Onset detection function"; +00218 d.unit = ""; +00219 d.hasFixedBinCount = 1; +00220 d.binCount = 1; +00221 d.hasKnownExtents = true; +00222 d.minValue = 0.0; +00223 d.maxValue = 1.0; +00224 d.isQuantized = false; +00225 d.quantizeStep = 0.0; +00226 d.sampleType = OutputDescriptor::FixedSampleRate; +00227 if (m_stepSize) { +00228 d.sampleRate = m_inputSampleRate / m_stepSize; +00229 } else { +00230 d.sampleRate = m_inputSampleRate / (getPreferredBlockSize()/2); +00231 } +00232 d.hasDuration = false; +00233 list.push_back(d); +00234 +00235 d.identifier = "acf"; +00236 d.name = "Autocorrelation Function"; +00237 d.description = "Autocorrelation of onset detection function"; +00238 d.hasKnownExtents = false; +00239 d.unit = "r"; +00240 list.push_back(d); +00241 +00242 d.identifier = "filtered_acf"; +00243 d.name = "Filtered Autocorrelation"; +00244 d.description = "Filtered autocorrelation of onset detection function"; +00245 d.unit = "r"; +00246 list.push_back(d); +00247 +00248 return list; +00249 } +00250 +00251 bool +00252 FixedTempoEstimator::D::initialise(size_t, size_t stepSize, size_t blockSize) +00253 { +00254 m_stepSize = stepSize; +00255 m_blockSize = blockSize; +00256 +00257 float dfLengthSecs = m_maxdflen; +00258 m_dfsize = (dfLengthSecs * m_inputSampleRate) / m_stepSize; +00259 +00260 m_priorMagnitudes = new float[m_blockSize/2]; +00261 m_df = new float[m_dfsize]; +00262 +00263 for (size_t i = 0; i < m_blockSize/2; ++i) { +00264 m_priorMagnitudes[i] = 0.f; +00265 } +00266 for (size_t i = 0; i < m_dfsize; ++i) { +00267 m_df[i] = 0.f; +00268 } +00269 +00270 m_n = 0; +00271 +00272 return true; +00273 } +00274 +00275 void +00276 FixedTempoEstimator::D::reset() +00277 { +00278 if (!m_priorMagnitudes) return; +00279 +00280 for (size_t i = 0; i < m_blockSize/2; ++i) { +00281 m_priorMagnitudes[i] = 0.f; +00282 } +00283 for (size_t i = 0; i < m_dfsize; ++i) { +00284 m_df[i] = 0.f; +00285 } +00286 +00287 delete[] m_r; +00288 m_r = 0; +00289 +00290 delete[] m_fr; +00291 m_fr = 0; +00292 +00293 delete[] m_t; +00294 m_t = 0; +00295 +00296 m_n = 0; +00297 +00298 m_start = RealTime::zeroTime; +00299 m_lasttime = RealTime::zeroTime; +00300 } +00301 +00302 FixedTempoEstimator::FeatureSet +00303 FixedTempoEstimator::D::process(const float *const *inputBuffers, RealTime ts) +00304 { +00305 FeatureSet fs; +00306 +00307 if (m_stepSize == 0) { +00308 cerr << "ERROR: FixedTempoEstimator::process: " +00309 << "FixedTempoEstimator has not been initialised" +00310 << endl; +00311 return fs; +00312 } +00313 +00314 if (m_n == 0) m_start = ts; +00315 m_lasttime = ts; +00316 +00317 if (m_n == m_dfsize) { +00318 // If we have seen enough input, do the estimation and return +00319 calculate(); +00320 fs = assembleFeatures(); +00321 ++m_n; +00322 return fs; +00323 } +00324 +00325 // If we have seen more than enough, just discard and return! +00326 if (m_n > m_dfsize) return FeatureSet(); +00327 +00328 float value = 0.f; +00329 +00330 // m_df will contain an onset detection function based on the rise +00331 // in overall power from one spectral frame to the next -- +00332 // simplistic but reasonably effective for our purposes. +00333 +00334 for (size_t i = 1; i < m_blockSize/2; ++i) { +00335 +00336 float real = inputBuffers[0][i*2]; +00337 float imag = inputBuffers[0][i*2 + 1]; +00338 +00339 float sqrmag = real * real + imag * imag; +00340 value += fabsf(sqrmag - m_priorMagnitudes[i]); +00341 +00342 m_priorMagnitudes[i] = sqrmag; +00343 } +00344 +00345 m_df[m_n] = value; +00346 +00347 ++m_n; +00348 return fs; +00349 } +00350 +00351 FixedTempoEstimator::FeatureSet +00352 FixedTempoEstimator::D::getRemainingFeatures() +00353 { +00354 FeatureSet fs; +00355 if (m_n > m_dfsize) return fs; +00356 calculate(); +00357 fs = assembleFeatures(); +00358 ++m_n; +00359 return fs; +00360 } +00361 +00362 float +00363 FixedTempoEstimator::D::lag2tempo(int lag) +00364 { +00365 return 60.f / ((lag * m_stepSize) / m_inputSampleRate); +00366 } +00367 +00368 int +00369 FixedTempoEstimator::D::tempo2lag(float tempo) +00370 { +00371 return ((60.f / tempo) * m_inputSampleRate) / m_stepSize; +00372 } +00373 +00374 void +00375 FixedTempoEstimator::D::calculate() +00376 { +00377 if (m_r) { +00378 cerr << "FixedTempoEstimator::calculate: calculation already happened?" << endl; +00379 return; +00380 } +00381 +00382 if (m_n < m_dfsize / 9 && +00383 m_n < (1.0 * m_inputSampleRate) / m_stepSize) { // 1 second +00384 cerr << "FixedTempoEstimator::calculate: Input is too short" << endl; +00385 return; +00386 } +00387 +00388 // This function takes m_df (the detection function array filled +00389 // out in process()) and calculates m_r (the raw autocorrelation) +00390 // and m_fr (the filtered autocorrelation from whose peaks tempo +00391 // estimates will be taken). +00392 +00393 int n = m_n; // length of actual df array (m_dfsize is the theoretical max) +00394 +00395 m_r = new float[n/2]; // raw autocorrelation +00396 m_fr = new float[n/2]; // filtered autocorrelation +00397 m_t = new float[n/2]; // averaged tempo estimate for each lag value +00398 +00399 for (int i = 0; i < n/2; ++i) { +00400 m_r[i] = 0.f; +00401 m_fr[i] = 0.f; +00402 m_t[i] = lag2tempo(i); +00403 } +00404 +00405 // Calculate the raw autocorrelation of the detection function +00406 +00407 for (int i = 0; i < n/2; ++i) { +00408 +00409 for (int j = i; j < n; ++j) { +00410 m_r[i] += m_df[j] * m_df[j - i]; +00411 } +00412 +00413 m_r[i] /= n - i - 1; +00414 } +00415 +00416 // Filter the autocorrelation and average out the tempo estimates +00417 +00418 float related[] = { 0.5, 2, 4, 8 }; +00419 +00420 for (int i = 1; i < n/2-1; ++i) { +00421 +00422 m_fr[i] = m_r[i]; +00423 +00424 int div = 1; +00425 +00426 for (int j = 0; j < int(sizeof(related)/sizeof(related[0])); ++j) { +00427 +00428 // Check for an obvious peak at each metrically related lag +00429 +00430 int k0 = int(i * related[j] + 0.5); +00431 +00432 if (k0 >= 0 && k0 < int(n/2)) { +00433 +00434 int kmax = 0, kmin = 0; +00435 float kvmax = 0, kvmin = 0; +00436 bool have = false; +00437 +00438 for (int k = k0 - 1; k <= k0 + 1; ++k) { +00439 +00440 if (k < 0 || k >= n/2) continue; +00441 +00442 if (!have || (m_r[k] > kvmax)) { kmax = k; kvmax = m_r[k]; } +00443 if (!have || (m_r[k] < kvmin)) { kmin = k; kvmin = m_r[k]; } +00444 +00445 have = true; +00446 } +00447 +00448 // Boost the original lag according to the strongest +00449 // value found close to this related lag +00450 +00451 m_fr[i] += m_r[kmax] / 5; +00452 +00453 if ((kmax == 0 || m_r[kmax] > m_r[kmax-1]) && +00454 (kmax == n/2-1 || m_r[kmax] > m_r[kmax+1]) && +00455 kvmax > kvmin * 1.05) { +00456 +00457 // The strongest value close to the related lag is +00458 // also a pretty good looking peak, so use it to +00459 // improve our tempo estimate for the original lag +00460 +00461 m_t[i] = m_t[i] + lag2tempo(kmax) * related[j]; +00462 ++div; +00463 } +00464 } +00465 } +00466 +00467 m_t[i] /= div; +00468 +00469 // Finally apply a primitive perceptual weighting (to prefer +00470 // tempi of around 120-130) +00471 +00472 float weight = 1.f - fabsf(128.f - lag2tempo(i)) * 0.005; +00473 if (weight < 0.f) weight = 0.f; +00474 weight = weight * weight * weight; +00475 +00476 m_fr[i] += m_fr[i] * (weight / 3); +00477 } +00478 } +00479 +00480 FixedTempoEstimator::FeatureSet +00481 FixedTempoEstimator::D::assembleFeatures() +00482 { +00483 FeatureSet fs; +00484 if (!m_r) return fs; // No autocorrelation: no results +00485 +00486 Feature feature; +00487 feature.hasTimestamp = true; +00488 feature.hasDuration = false; +00489 feature.label = ""; +00490 feature.values.clear(); +00491 feature.values.push_back(0.f); +00492 +00493 char buffer[40]; +00494 +00495 int n = m_n; +00496 +00497 for (int i = 0; i < n; ++i) { +00498 +00499 // Return the detection function in the DF output +00500 +00501 feature.timestamp = m_start + +00502 RealTime::frame2RealTime(i * m_stepSize, m_inputSampleRate); +00503 feature.values[0] = m_df[i]; +00504 feature.label = ""; +00505 fs[DFOutput].push_back(feature); +00506 } +00507 +00508 for (int i = 1; i < n/2; ++i) { +00509 +00510 // Return the raw autocorrelation in the ACF output, each +00511 // value labelled according to its corresponding tempo +00512 +00513 feature.timestamp = m_start + +00514 RealTime::frame2RealTime(i * m_stepSize, m_inputSampleRate); +00515 feature.values[0] = m_r[i]; +00516 sprintf(buffer, "%.1f bpm", lag2tempo(i)); +00517 if (i == n/2-1) feature.label = ""; +00518 else feature.label = buffer; +00519 fs[ACFOutput].push_back(feature); +00520 } +00521 +00522 float t0 = m_minbpm; // our minimum detected tempo +00523 float t1 = m_maxbpm; // our maximum detected tempo +00524 +00525 int p0 = tempo2lag(t1); +00526 int p1 = tempo2lag(t0); +00527 +00528 std::map<float, int> candidates; +00529 +00530 for (int i = p0; i <= p1 && i+1 < n/2; ++i) { +00531 +00532 if (m_fr[i] > m_fr[i-1] && +00533 m_fr[i] > m_fr[i+1]) { +00534 +00535 // This is a peak in the filtered autocorrelation: stick +00536 // it into the map from filtered autocorrelation to lag +00537 // index -- this sorts our peaks by filtered acf value +00538 +00539 candidates[m_fr[i]] = i; +00540 } +00541 +00542 // Also return the filtered autocorrelation in its own output +00543 +00544 feature.timestamp = m_start + +00545 RealTime::frame2RealTime(i * m_stepSize, m_inputSampleRate); +00546 feature.values[0] = m_fr[i]; +00547 sprintf(buffer, "%.1f bpm", lag2tempo(i)); +00548 if (i == p1 || i == n/2-2) feature.label = ""; +00549 else feature.label = buffer; +00550 fs[FilteredACFOutput].push_back(feature); +00551 } +00552 +00553 if (candidates.empty()) { +00554 cerr << "No tempo candidates!" << endl; +00555 return fs; +00556 } +00557 +00558 feature.hasTimestamp = true; +00559 feature.timestamp = m_start; +00560 +00561 feature.hasDuration = true; +00562 feature.duration = m_lasttime - m_start; +00563 +00564 // The map contains only peaks and is sorted by filtered acf +00565 // value, so the final element in it is our "best" tempo guess +00566 +00567 std::map<float, int>::const_iterator ci = candidates.end(); +00568 --ci; +00569 int maxpi = ci->second; +00570 +00571 if (m_t[maxpi] > 0) { +00572 +00573 // This lag has an adjusted tempo from the averaging process: +00574 // use it +00575 +00576 feature.values[0] = m_t[maxpi]; +00577 +00578 } else { +00579 +00580 // shouldn't happen -- it would imply that this high value was +00581 // not a peak! +00582 +00583 feature.values[0] = lag2tempo(maxpi); +00584 cerr << "WARNING: No stored tempo for index " << maxpi << endl; +00585 } +00586 +00587 sprintf(buffer, "%.1f bpm", feature.values[0]); +00588 feature.label = buffer; +00589 +00590 // Return the best tempo in the main output +00591 +00592 fs[TempoOutput].push_back(feature); +00593 +00594 // And return the other estimates (up to the arbitrarily chosen +00595 // number of 10 of them) in the candidates output +00596 +00597 feature.values.clear(); +00598 feature.label = ""; +00599 +00600 while (feature.values.size() < 10) { +00601 if (m_t[ci->second] > 0) { +00602 feature.values.push_back(m_t[ci->second]); +00603 } else { +00604 feature.values.push_back(lag2tempo(ci->second)); +00605 } +00606 if (ci == candidates.begin()) break; +00607 --ci; +00608 } +00609 +00610 fs[CandidatesOutput].push_back(feature); +00611 +00612 return fs; +00613 } +00614 +00615 +00616 +00617 FixedTempoEstimator::FixedTempoEstimator(float inputSampleRate) : +00618 Plugin(inputSampleRate), +00619 m_d(new D(inputSampleRate)) +00620 { +00621 } +00622 +00623 FixedTempoEstimator::~FixedTempoEstimator() +00624 { +00625 delete m_d; +00626 } +00627 +00628 string +00629 FixedTempoEstimator::getIdentifier() const +00630 { +00631 return "fixedtempo"; +00632 } +00633 +00634 string +00635 FixedTempoEstimator::getName() const +00636 { +00637 return "Simple Fixed Tempo Estimator"; +00638 } +00639 +00640 string +00641 FixedTempoEstimator::getDescription() const +00642 { +00643 return "Study a short section of audio and estimate its tempo, assuming the tempo is constant"; +00644 } +00645 +00646 string +00647 FixedTempoEstimator::getMaker() const +00648 { +00649 return "Vamp SDK Example Plugins"; +00650 } +00651 +00652 int +00653 FixedTempoEstimator::getPluginVersion() const +00654 { +00655 return 1; +00656 } +00657 +00658 string +00659 FixedTempoEstimator::getCopyright() const +00660 { +00661 return "Code copyright 2008 Queen Mary, University of London. Freely redistributable (BSD license)"; +00662 } +00663 +00664 size_t +00665 FixedTempoEstimator::getPreferredStepSize() const +00666 { +00667 return m_d->getPreferredStepSize(); +00668 } +00669 +00670 size_t +00671 FixedTempoEstimator::getPreferredBlockSize() const +00672 { +00673 return m_d->getPreferredBlockSize(); +00674 } +00675 +00676 bool +00677 FixedTempoEstimator::initialise(size_t channels, size_t stepSize, size_t blockSize) +00678 { +00679 if (channels < getMinChannelCount() || +00680 channels > getMaxChannelCount()) return false; +00681 +00682 return m_d->initialise(channels, stepSize, blockSize); +00683 } +00684 +00685 void +00686 FixedTempoEstimator::reset() +00687 { +00688 return m_d->reset(); +00689 } +00690 +00691 FixedTempoEstimator::ParameterList +00692 FixedTempoEstimator::getParameterDescriptors() const +00693 { +00694 return m_d->getParameterDescriptors(); +00695 } +00696 +00697 float +00698 FixedTempoEstimator::getParameter(std::string id) const +00699 { +00700 return m_d->getParameter(id); +00701 } +00702 +00703 void +00704 FixedTempoEstimator::setParameter(std::string id, float value) +00705 { +00706 m_d->setParameter(id, value); +00707 } +00708 +00709 FixedTempoEstimator::OutputList +00710 FixedTempoEstimator::getOutputDescriptors() const +00711 { +00712 return m_d->getOutputDescriptors(); +00713 } +00714 +00715 FixedTempoEstimator::FeatureSet +00716 FixedTempoEstimator::process(const float *const *inputBuffers, RealTime ts) +00717 { +00718 return m_d->process(inputBuffers, ts); +00719 } +00720 +00721 FixedTempoEstimator::FeatureSet +00722 FixedTempoEstimator::getRemainingFeatures() +00723 { +00724 return m_d->getRemainingFeatures(); +00725 } +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
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... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+Classes | |
| class | FixedTempoEstimator |
| Example plugin that estimates the tempo of a short fixed-tempo sample. More... | |
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+
+ -
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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-2009 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 _FIXED_TEMPO_ESTIMATOR_PLUGIN_H_ +00038 #define _FIXED_TEMPO_ESTIMATOR_PLUGIN_H_ +00039 +00040 #include "vamp-sdk/Plugin.h" +00041 +00046 class FixedTempoEstimator : public Vamp::Plugin +00047 { +00048 public: +00049 FixedTempoEstimator(float inputSampleRate); +00050 virtual ~FixedTempoEstimator(); +00051 +00052 bool initialise(size_t channels, size_t stepSize, size_t blockSize); +00053 void reset(); +00054 +00055 InputDomain getInputDomain() const { return FrequencyDomain; } +00056 +00057 std::string getIdentifier() const; +00058 std::string getName() const; +00059 std::string getDescription() const; +00060 std::string getMaker() const; +00061 int getPluginVersion() const; +00062 std::string getCopyright() const; +00063 +00064 size_t getPreferredStepSize() const; +00065 size_t getPreferredBlockSize() const; +00066 +00067 ParameterList getParameterDescriptors() const; +00068 float getParameter(std::string id) const; +00069 void setParameter(std::string id, float value); +00070 +00071 OutputList getOutputDescriptors() const; +00072 +00073 FeatureSet process(const float *const *inputBuffers, +00074 Vamp::RealTime timestamp); +00075 +00076 FeatureSet getRemainingFeatures(); +00077 +00078 protected: +00079 class D; +00080 D *m_d; +00081 }; +00082 +00083 +00084 #endif +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+-
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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 Chris Cannam. +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 #include "PercussionOnsetDetector.h" +00038 +00039 using std::string; +00040 using std::vector; +00041 using std::cerr; +00042 using std::endl; +00043 +00044 #include <cmath> +00045 +00046 +00047 PercussionOnsetDetector::PercussionOnsetDetector(float inputSampleRate) : +00048 Plugin(inputSampleRate), +00049 m_stepSize(0), +00050 m_blockSize(0), +00051 m_threshold(3), +00052 m_sensitivity(40), +00053 m_priorMagnitudes(0), +00054 m_dfMinus1(0), +00055 m_dfMinus2(0) +00056 { +00057 } +00058 +00059 PercussionOnsetDetector::~PercussionOnsetDetector() +00060 { +00061 delete[] m_priorMagnitudes; +00062 } +00063 +00064 string +00065 PercussionOnsetDetector::getIdentifier() const +00066 { +00067 return "percussiononsets"; +00068 } +00069 +00070 string +00071 PercussionOnsetDetector::getName() const +00072 { +00073 return "Simple Percussion Onset Detector"; +00074 } +00075 +00076 string +00077 PercussionOnsetDetector::getDescription() const +00078 { +00079 return "Detect percussive note onsets by identifying broadband energy rises"; +00080 } +00081 +00082 string +00083 PercussionOnsetDetector::getMaker() const +00084 { +00085 return "Vamp SDK Example Plugins"; +00086 } +00087 +00088 int +00089 PercussionOnsetDetector::getPluginVersion() const +00090 { +00091 return 2; +00092 } +00093 +00094 string +00095 PercussionOnsetDetector::getCopyright() const +00096 { +00097 return "Code copyright 2006 Queen Mary, University of London, after Dan Barry et al 2005. Freely redistributable (BSD license)"; +00098 } +00099 +00100 size_t +00101 PercussionOnsetDetector::getPreferredStepSize() const +00102 { +00103 return 0; +00104 } +00105 +00106 size_t +00107 PercussionOnsetDetector::getPreferredBlockSize() const +00108 { +00109 return 1024; +00110 } +00111 +00112 bool +00113 PercussionOnsetDetector::initialise(size_t channels, size_t stepSize, size_t blockSize) +00114 { +00115 if (channels < getMinChannelCount() || +00116 channels > getMaxChannelCount()) return false; +00117 +00118 m_stepSize = stepSize; +00119 m_blockSize = blockSize; +00120 +00121 m_priorMagnitudes = new float[m_blockSize/2]; +00122 +00123 for (size_t i = 0; i < m_blockSize/2; ++i) { +00124 m_priorMagnitudes[i] = 0.f; +00125 } +00126 +00127 m_dfMinus1 = 0.f; +00128 m_dfMinus2 = 0.f; +00129 +00130 return true; +00131 } +00132 +00133 void +00134 PercussionOnsetDetector::reset() +00135 { +00136 for (size_t i = 0; i < m_blockSize/2; ++i) { +00137 m_priorMagnitudes[i] = 0.f; +00138 } +00139 +00140 m_dfMinus1 = 0.f; +00141 m_dfMinus2 = 0.f; +00142 } +00143 +00144 PercussionOnsetDetector::ParameterList +00145 PercussionOnsetDetector::getParameterDescriptors() const +00146 { +00147 ParameterList list; +00148 +00149 ParameterDescriptor d; +00150 d.identifier = "threshold"; +00151 d.name = "Energy rise threshold"; +00152 d.description = "Energy rise within a frequency bin necessary to count toward broadband total"; +00153 d.unit = "dB"; +00154 d.minValue = 0; +00155 d.maxValue = 20; +00156 d.defaultValue = 3; +00157 d.isQuantized = false; +00158 list.push_back(d); +00159 +00160 d.identifier = "sensitivity"; +00161 d.name = "Sensitivity"; +00162 d.description = "Sensitivity of peak detector applied to broadband detection function"; +00163 d.unit = "%"; +00164 d.minValue = 0; +00165 d.maxValue = 100; +00166 d.defaultValue = 40; +00167 d.isQuantized = false; +00168 list.push_back(d); +00169 +00170 return list; +00171 } +00172 +00173 float +00174 PercussionOnsetDetector::getParameter(std::string id) const +00175 { +00176 if (id == "threshold") return m_threshold; +00177 if (id == "sensitivity") return m_sensitivity; +00178 return 0.f; +00179 } +00180 +00181 void +00182 PercussionOnsetDetector::setParameter(std::string id, float value) +00183 { +00184 if (id == "threshold") { +00185 if (value < 0) value = 0; +00186 if (value > 20) value = 20; +00187 m_threshold = value; +00188 } else if (id == "sensitivity") { +00189 if (value < 0) value = 0; +00190 if (value > 100) value = 100; +00191 m_sensitivity = value; +00192 } +00193 } +00194 +00195 PercussionOnsetDetector::OutputList +00196 PercussionOnsetDetector::getOutputDescriptors() const +00197 { +00198 OutputList list; +00199 +00200 OutputDescriptor d; +00201 d.identifier = "onsets"; +00202 d.name = "Onsets"; +00203 d.description = "Percussive note onset locations"; +00204 d.unit = ""; +00205 d.hasFixedBinCount = true; +00206 d.binCount = 0; +00207 d.hasKnownExtents = false; +00208 d.isQuantized = false; +00209 d.sampleType = OutputDescriptor::VariableSampleRate; +00210 d.sampleRate = m_inputSampleRate; +00211 list.push_back(d); +00212 +00213 d.identifier = "detectionfunction"; +00214 d.name = "Detection Function"; +00215 d.description = "Broadband energy rise detection function"; +00216 d.binCount = 1; +00217 d.isQuantized = true; +00218 d.quantizeStep = 1.0; +00219 d.sampleType = OutputDescriptor::OneSamplePerStep; +00220 list.push_back(d); +00221 +00222 return list; +00223 } +00224 +00225 PercussionOnsetDetector::FeatureSet +00226 PercussionOnsetDetector::process(const float *const *inputBuffers, +00227 Vamp::RealTime ts) +00228 { +00229 if (m_stepSize == 0) { +00230 cerr << "ERROR: PercussionOnsetDetector::process: " +00231 << "PercussionOnsetDetector has not been initialised" +00232 << endl; +00233 return FeatureSet(); +00234 } +00235 +00236 int count = 0; +00237 +00238 for (size_t i = 1; i < m_blockSize/2; ++i) { +00239 +00240 float real = inputBuffers[0][i*2]; +00241 float imag = inputBuffers[0][i*2 + 1]; +00242 +00243 float sqrmag = real * real + imag * imag; +00244 +00245 if (m_priorMagnitudes[i] > 0.f) { +00246 float diff = 10.f * log10f(sqrmag / m_priorMagnitudes[i]); +00247 +00248 // std::cout << "i=" << i << ", sqrmag=" << sqrmag << ", prior=" << m_priorMagnitudes[i] << ", diff=" << diff << ", threshold=" << m_threshold << " " << (diff >= m_threshold ? "[*]" : "") << std::endl; +00249 +00250 if (diff >= m_threshold) ++count; +00251 } +00252 +00253 m_priorMagnitudes[i] = sqrmag; +00254 } +00255 +00256 FeatureSet returnFeatures; +00257 +00258 Feature detectionFunction; +00259 detectionFunction.hasTimestamp = false; +00260 detectionFunction.values.push_back(count); +00261 returnFeatures[1].push_back(detectionFunction); +00262 +00263 if (m_dfMinus2 < m_dfMinus1 && +00264 m_dfMinus1 >= count && +00265 m_dfMinus1 > ((100 - m_sensitivity) * m_blockSize) / 200) { +00266 +00267 //std::cout << "result at " << ts << "! (count == " << count << ", prev == " << m_dfMinus1 << ")" << std::endl; +00268 +00269 Feature onset; +00270 onset.hasTimestamp = true; +00271 onset.timestamp = ts - Vamp::RealTime::frame2RealTime +00272 (m_stepSize, int(m_inputSampleRate + 0.5)); +00273 returnFeatures[0].push_back(onset); +00274 } +00275 +00276 m_dfMinus2 = m_dfMinus1; +00277 m_dfMinus1 = count; +00278 +00279 return returnFeatures; +00280 } +00281 +00282 PercussionOnsetDetector::FeatureSet +00283 PercussionOnsetDetector::getRemainingFeatures() +00284 { +00285 return FeatureSet(); +00286 } +00287 +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
PercussionOnsetDetector.h File Reference
--Go to the source code of this file.
Classes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| class | PercussionOnsetDetector | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Example plugin that detects percussive events. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+Classes | |
| class | PercussionOnsetDetector |
| Example plugin that detects percussive events. More... | |
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+
+ -
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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 Chris Cannam. +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 _PERCUSSION_ONSET_DETECTOR_PLUGIN_H_ +00038 #define _PERCUSSION_ONSET_DETECTOR_PLUGIN_H_ +00039 +00040 #include "vamp-sdk/Plugin.h" +00041 +00046 class PercussionOnsetDetector : public Vamp::Plugin +00047 { +00048 public: +00049 PercussionOnsetDetector(float inputSampleRate); +00050 virtual ~PercussionOnsetDetector(); +00051 +00052 bool initialise(size_t channels, size_t stepSize, size_t blockSize); +00053 void reset(); +00054 +00055 InputDomain getInputDomain() const { return FrequencyDomain; } +00056 +00057 std::string getIdentifier() const; +00058 std::string getName() const; +00059 std::string getDescription() const; +00060 std::string getMaker() const; +00061 int getPluginVersion() const; +00062 std::string getCopyright() const; +00063 +00064 size_t getPreferredStepSize() const; +00065 size_t getPreferredBlockSize() const; +00066 +00067 ParameterList getParameterDescriptors() const; +00068 float getParameter(std::string id) const; +00069 void setParameter(std::string id, float value); +00070 +00071 OutputList getOutputDescriptors() const; +00072 +00073 FeatureSet process(const float *const *inputBuffers, +00074 Vamp::RealTime timestamp); +00075 +00076 FeatureSet getRemainingFeatures(); +00077 +00078 protected: +00079 size_t m_stepSize; +00080 size_t m_blockSize; +00081 +00082 float m_threshold; +00083 float m_sensitivity; +00084 float *m_priorMagnitudes; +00085 float m_dfMinus1; +00086 float m_dfMinus2; +00087 }; +00088 +00089 +00090 #endif +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
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... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Namespaces | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| namespace | Vamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+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... | |
+Namespaces | |
| namespace | Vamp |
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+
+ -
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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 Chris Cannam. +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_PLUGIN_ADAPTER_H_ +00038 #define _VAMP_PLUGIN_ADAPTER_H_ +00039 +00040 #include <map> +00041 #include <vamp/vamp.h> +00042 +00043 #include "Plugin.h" +00044 +00045 #include "plugguard.h" +00046 _VAMP_SDK_PLUGSPACE_BEGIN(PluginAdapter.h) +00047 +00048 namespace Vamp { +00049 +00065 class PluginAdapterBase +00066 { +00067 public: +00068 virtual ~PluginAdapterBase(); +00069 +00074 const VampPluginDescriptor *getDescriptor(); +00075 +00076 protected: +00077 PluginAdapterBase(); +00078 +00079 virtual Plugin *createPlugin(float inputSampleRate) = 0; +00080 +00081 class Impl; +00082 Impl *m_impl; +00083 }; +00084 +00094 template <typename P> +00095 class PluginAdapter : public PluginAdapterBase +00096 { +00097 public: +00098 PluginAdapter() : PluginAdapterBase() { } +00099 virtual ~PluginAdapter() { } +00100 +00101 protected: +00102 Plugin *createPlugin(float inputSampleRate) { +00103 P *p = new P(inputSampleRate); +00104 Plugin *plugin = dynamic_cast<Plugin *>(p); +00105 if (!plugin) { +00106 std::cerr << "ERROR: PluginAdapter::createPlugin: " +00107 << "Template type is not a plugin!" +00108 << std::endl; +00109 delete p; +00110 return 0; +00111 } +00112 return plugin; +00113 } +00114 }; +00115 +00116 } +00117 +00118 _VAMP_SDK_PLUGSPACE_END(PluginAdapter.h) +00119 +00120 #endif +00121 +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
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... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Namespaces | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| namespace | Vamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| namespace | Vamp::HostExt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+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... | |
+Namespaces | |
| namespace | Vamp |
| namespace | Vamp::HostExt |
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+
+ -
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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-2009 Chris Cannam and QMUL. +00010 This file by Mark Levy and Chris Cannam, Copyright 2007-2008 QMUL. +00011 +00012 Permission is hereby granted, free of charge, to any person +00013 obtaining a copy of this software and associated documentation +00014 files (the "Software"), to deal in the Software without +00015 restriction, including without limitation the rights to use, copy, +00016 modify, merge, publish, distribute, sublicense, and/or sell copies +00017 of the Software, and to permit persons to whom the Software is +00018 furnished to do so, subject to the following conditions: +00019 +00020 The above copyright notice and this permission notice shall be +00021 included in all copies or substantial portions of the Software. +00022 +00023 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +00024 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +00025 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +00026 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR +00027 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF +00028 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +00029 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +00030 +00031 Except as contained in this notice, the names of the Centre for +00032 Digital Music; Queen Mary, University of London; and Chris Cannam +00033 shall not be used in advertising or otherwise to promote the sale, +00034 use or other dealings in this Software without prior written +00035 authorization. +00036 */ +00037 +00038 #ifndef _VAMP_PLUGIN_BUFFERING_ADAPTER_H_ +00039 #define _VAMP_PLUGIN_BUFFERING_ADAPTER_H_ +00040 +00041 #include "hostguard.h" +00042 #include "PluginWrapper.h" +00043 +00044 _VAMP_SDK_HOSTSPACE_BEGIN(PluginBufferingAdapter.h) +00045 +00046 namespace Vamp { +00047 +00048 namespace HostExt { +00049 +00075 class PluginBufferingAdapter : public PluginWrapper +00076 { +00077 public: +00083 PluginBufferingAdapter(Plugin *plugin); +00084 virtual ~PluginBufferingAdapter(); +00085 +00095 size_t getPreferredStepSize() const; +00096 +00107 size_t getPreferredBlockSize() const; +00108 +00118 bool initialise(size_t channels, size_t stepSize, size_t blockSize); +00119 +00131 size_t getPluginPreferredStepSize() const; +00132 +00139 size_t getPluginPreferredBlockSize() const; +00140 +00148 void setPluginStepSize(size_t stepSize); +00149 +00157 void setPluginBlockSize(size_t blockSize); +00158 +00170 void getActualStepAndBlockSizes(size_t &stepSize, size_t &blockSize); +00171 +00172 void setParameter(std::string, float); +00173 void selectProgram(std::string); +00174 +00175 OutputList getOutputDescriptors() const; +00176 +00177 void reset(); +00178 +00179 FeatureSet process(const float *const *inputBuffers, RealTime timestamp); +00180 +00181 FeatureSet getRemainingFeatures(); +00182 +00183 protected: +00184 class Impl; +00185 Impl *m_impl; +00186 }; +00187 +00188 } +00189 +00190 } +00191 +00192 _VAMP_SDK_HOSTSPACE_END(PluginBufferingAdapter.h) +00193 +00194 #endif +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
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... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Namespaces | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| namespace | Vamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| namespace | Vamp::HostExt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+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... | |
+Namespaces | |
| namespace | Vamp |
| namespace | Vamp::HostExt |
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+
+ -
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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-2009 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_PLUGIN_CHANNEL_ADAPTER_H_ +00038 #define _VAMP_PLUGIN_CHANNEL_ADAPTER_H_ +00039 +00040 #include "hostguard.h" +00041 #include "PluginWrapper.h" +00042 +00043 _VAMP_SDK_HOSTSPACE_BEGIN(PluginChannelAdapter.h) +00044 +00045 namespace Vamp { +00046 +00047 namespace HostExt { +00048 +00112 class PluginChannelAdapter : public PluginWrapper +00113 { +00114 public: +00120 PluginChannelAdapter(Plugin *plugin); +00121 virtual ~PluginChannelAdapter(); +00122 +00123 bool initialise(size_t channels, size_t stepSize, size_t blockSize); +00124 +00125 FeatureSet process(const float *const *inputBuffers, RealTime timestamp); +00126 +00136 FeatureSet processInterleaved(const float *inputBuffer, RealTime timestamp); +00137 +00138 protected: +00139 class Impl; +00140 Impl *m_impl; +00141 }; +00142 +00143 } +00144 +00145 } +00146 +00147 _VAMP_SDK_HOSTSPACE_END(PluginChannelAdapter.h) +00148 +00149 #endif +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
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... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Namespaces | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| namespace | Vamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+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... | |
+Namespaces | |
| namespace | Vamp |
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+
+ -
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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 Chris Cannam. +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_PLUGIN_HOST_ADAPTER_H_ +00038 #define _VAMP_PLUGIN_HOST_ADAPTER_H_ +00039 +00040 #include "hostguard.h" +00041 #include "Plugin.h" +00042 +00043 #include <vamp/vamp.h> +00044 +00045 #include <vector> +00046 +00047 _VAMP_SDK_HOSTSPACE_BEGIN(PluginHostAdapter.h) +00048 +00049 namespace Vamp { +00050 +00068 class PluginHostAdapter : public Plugin +00069 { +00070 public: +00071 PluginHostAdapter(const VampPluginDescriptor *descriptor, +00072 float inputSampleRate); +00073 virtual ~PluginHostAdapter(); +00074 +00075 static std::vector<std::string> getPluginPath(); +00076 +00077 bool initialise(size_t channels, size_t stepSize, size_t blockSize); +00078 void reset(); +00079 +00080 InputDomain getInputDomain() const; +00081 +00082 unsigned int getVampApiVersion() const; +00083 std::string getIdentifier() const; +00084 std::string getName() const; +00085 std::string getDescription() const; +00086 std::string getMaker() const; +00087 int getPluginVersion() const; +00088 std::string getCopyright() const; +00089 +00090 ParameterList getParameterDescriptors() const; +00091 float getParameter(std::string) const; +00092 void setParameter(std::string, float); +00093 +00094 ProgramList getPrograms() const; +00095 std::string getCurrentProgram() const; +00096 void selectProgram(std::string); +00097 +00098 size_t getPreferredStepSize() const; +00099 size_t getPreferredBlockSize() const; +00100 +00101 size_t getMinChannelCount() const; +00102 size_t getMaxChannelCount() const; +00103 +00104 OutputList getOutputDescriptors() const; +00105 +00106 FeatureSet process(const float *const *inputBuffers, RealTime timestamp); +00107 +00108 FeatureSet getRemainingFeatures(); +00109 +00110 protected: +00111 void convertFeatures(VampFeatureList *, FeatureSet &); +00112 +00113 const VampPluginDescriptor *m_descriptor; +00114 VampPluginHandle m_handle; +00115 }; +00116 +00117 } +00118 +00119 _VAMP_SDK_HOSTSPACE_END(PluginHostAdapter.h) +00120 +00121 #endif +00122 +00123 +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
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... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Namespaces | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| namespace | Vamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| namespace | Vamp::HostExt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+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... | |
+Namespaces | |
| namespace | Vamp |
| namespace | Vamp::HostExt |
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+
+ -
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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-2009 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_PLUGIN_INPUT_DOMAIN_ADAPTER_H_ +00038 #define _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_ +00039 +00040 #include "hostguard.h" +00041 #include "PluginWrapper.h" +00042 +00043 _VAMP_SDK_HOSTSPACE_BEGIN(PluginInputDomainAdapter.h) +00044 +00045 namespace Vamp { +00046 +00047 namespace HostExt { +00048 +00087 class PluginInputDomainAdapter : public PluginWrapper +00088 { +00089 public: +00095 PluginInputDomainAdapter(Plugin *plugin); +00096 virtual ~PluginInputDomainAdapter(); +00097 +00098 bool initialise(size_t channels, size_t stepSize, size_t blockSize); +00099 void reset(); +00100 +00101 InputDomain getInputDomain() const; +00102 +00103 size_t getPreferredStepSize() const; +00104 size_t getPreferredBlockSize() const; +00105 +00106 FeatureSet process(const float *const *inputBuffers, RealTime timestamp); +00107 +00142 enum ProcessTimestampMethod { +00143 ShiftTimestamp, +00144 ShiftData, +00145 NoShift +00146 }; +00147 +00156 void setProcessTimestampMethod(ProcessTimestampMethod); +00157 +00163 ProcessTimestampMethod getProcessTimestampMethod() const; +00164 +00190 RealTime getTimestampAdjustment() const; +00191 +00195 enum WindowType { +00196 +00197 RectangularWindow = 0, +00198 +00199 BartlettWindow = 1, +00200 TriangularWindow = 1, +00201 +00202 HammingWindow = 2, +00203 +00204 HanningWindow = 3, +00205 HannWindow = 3, +00206 +00207 BlackmanWindow = 4, +00208 +00209 NuttallWindow = 7, +00210 +00211 BlackmanHarrisWindow = 8 +00212 }; +00213 +00217 WindowType getWindowType() const; +00218 +00222 void setWindowType(WindowType type); +00223 +00224 +00225 protected: +00226 class Impl; +00227 Impl *m_impl; +00228 }; +00229 +00230 } +00231 +00232 } +00233 +00234 _VAMP_SDK_HOSTSPACE_END(PluginInputDomainAdapter.h) +00235 +00236 #endif +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
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... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Namespaces | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| namespace | Vamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| namespace | Vamp::HostExt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+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... | |
+Namespaces | |
| namespace | Vamp |
| namespace | Vamp::HostExt |
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+
+ -
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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-2009 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_PLUGIN_LOADER_H_ +00038 #define _VAMP_PLUGIN_LOADER_H_ +00039 +00040 #include <vector> +00041 #include <string> +00042 #include <map> +00043 +00044 #include "hostguard.h" +00045 #include "PluginWrapper.h" +00046 +00047 _VAMP_SDK_HOSTSPACE_BEGIN(PluginLoader.h) +00048 +00049 namespace Vamp { +00050 +00051 class Plugin; +00052 +00053 namespace HostExt { +00054 +00072 class PluginLoader +00073 { +00074 public: +00079 static PluginLoader *getInstance(); +00080 +00101 typedef std::string PluginKey; +00102 +00107 typedef std::vector<PluginKey> PluginKeyList; +00108 +00119 typedef std::vector<std::string> PluginCategoryHierarchy; +00120 +00125 PluginKeyList listPlugins(); +00126 +00169 enum AdapterFlags { +00170 +00171 ADAPT_INPUT_DOMAIN = 0x01, +00172 ADAPT_CHANNEL_COUNT = 0x02, +00173 ADAPT_BUFFER_SIZE = 0x04, +00174 +00175 ADAPT_ALL_SAFE = 0x03, +00176 +00177 ADAPT_ALL = 0xff +00178 }; +00179 +00197 Plugin *loadPlugin(PluginKey key, +00198 float inputSampleRate, +00199 int adapterFlags = 0); +00200 +00206 PluginKey composePluginKey(std::string libraryName, +00207 std::string identifier); +00208 +00218 PluginCategoryHierarchy getPluginCategory(PluginKey plugin); +00219 +00224 std::string getLibraryPathForPlugin(PluginKey plugin); +00225 +00226 protected: +00227 PluginLoader(); +00228 virtual ~PluginLoader(); +00229 +00230 class Impl; +00231 Impl *m_impl; +00232 +00233 static PluginLoader *m_instance; +00234 }; +00235 +00236 } +00237 +00238 } +00239 +00240 _VAMP_SDK_HOSTSPACE_END(PluginLoader.h) +00241 +00242 #endif +00243 +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
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... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Namespaces | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| namespace | Vamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| namespace | Vamp::HostExt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+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... | |
+Namespaces | |
| namespace | Vamp |
| namespace | Vamp::HostExt |
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+
+ -
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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-2009 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_PLUGIN_SUMMARISING_ADAPTER_H_ +00038 #define _VAMP_PLUGIN_SUMMARISING_ADAPTER_H_ +00039 +00040 #include "hostguard.h" +00041 #include "PluginWrapper.h" +00042 +00043 #include <set> +00044 +00045 _VAMP_SDK_HOSTSPACE_BEGIN(PluginSummarisingAdapter.h) +00046 +00047 namespace Vamp { +00048 +00049 namespace HostExt { +00050 +00086 class PluginSummarisingAdapter : public PluginWrapper +00087 { +00088 public: +00094 PluginSummarisingAdapter(Plugin *plugin); +00095 virtual ~PluginSummarisingAdapter(); +00096 +00097 bool initialise(size_t channels, size_t stepSize, size_t blockSize); +00098 +00099 void reset(); +00100 +00101 FeatureSet process(const float *const *inputBuffers, RealTime timestamp); +00102 FeatureSet getRemainingFeatures(); +00103 +00104 typedef std::set<RealTime> SegmentBoundaries; +00105 +00119 void setSummarySegmentBoundaries(const SegmentBoundaries &); +00120 +00121 enum SummaryType { +00122 Minimum = 0, +00123 Maximum = 1, +00124 Mean = 2, +00125 Median = 3, +00126 Mode = 4, +00127 Sum = 5, +00128 Variance = 6, +00129 StandardDeviation = 7, +00130 Count = 8, +00131 +00132 UnknownSummaryType = 999 +00133 }; +00134 +00157 enum AveragingMethod { +00158 SampleAverage = 0, +00159 ContinuousTimeAverage = 1 +00160 }; +00161 +00170 FeatureList getSummaryForOutput(int output, +00171 SummaryType type, +00172 AveragingMethod method = SampleAverage); +00173 +00183 FeatureSet getSummaryForAllOutputs(SummaryType type, +00184 AveragingMethod method = SampleAverage); +00185 +00186 protected: +00187 class Impl; +00188 Impl *m_impl; +00189 }; +00190 +00191 } +00192 +00193 } +00194 +00195 _VAMP_SDK_HOSTSPACE_END(PluginSummarisingAdapter.h) +00196 +00197 #endif +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
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... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Namespaces | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| namespace | Vamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| namespace | Vamp::HostExt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+Classes | |
| class | Vamp::HostExt::PluginWrapper |
| PluginWrapper is a simple base class for adapter plugins. More... | |
+Namespaces | |
| namespace | Vamp |
| namespace | Vamp::HostExt |
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+
+ -
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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-2009 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_PLUGIN_WRAPPER_H_ +00038 #define _VAMP_PLUGIN_WRAPPER_H_ +00039 +00040 #include "hostguard.h" +00041 #include <vamp-hostsdk/Plugin.h> +00042 +00043 _VAMP_SDK_HOSTSPACE_BEGIN(PluginWrapper.h) +00044 +00045 namespace Vamp { +00046 +00047 namespace HostExt { +00048 +00062 class PluginWrapper : public Plugin +00063 { +00064 public: +00065 virtual ~PluginWrapper(); +00066 +00067 bool initialise(size_t channels, size_t stepSize, size_t blockSize); +00068 void reset(); +00069 +00070 InputDomain getInputDomain() const; +00071 +00072 unsigned int getVampApiVersion() const; +00073 std::string getIdentifier() const; +00074 std::string getName() const; +00075 std::string getDescription() const; +00076 std::string getMaker() const; +00077 int getPluginVersion() const; +00078 std::string getCopyright() const; +00079 +00080 ParameterList getParameterDescriptors() const; +00081 float getParameter(std::string) const; +00082 void setParameter(std::string, float); +00083 +00084 ProgramList getPrograms() const; +00085 std::string getCurrentProgram() const; +00086 void selectProgram(std::string); +00087 +00088 size_t getPreferredStepSize() const; +00089 size_t getPreferredBlockSize() const; +00090 +00091 size_t getMinChannelCount() const; +00092 size_t getMaxChannelCount() const; +00093 +00094 OutputList getOutputDescriptors() const; +00095 +00096 FeatureSet process(const float *const *inputBuffers, RealTime timestamp); +00097 +00098 FeatureSet getRemainingFeatures(); +00099 +00115 template <typename WrapperType> +00116 WrapperType *getWrapper() { +00117 WrapperType *w = dynamic_cast<WrapperType *>(this); +00118 if (w) return w; +00119 PluginWrapper *pw = dynamic_cast<PluginWrapper *>(m_plugin); +00120 if (pw) return pw->getWrapper<WrapperType>(); +00121 return 0; +00122 } +00123 +00124 protected: +00125 PluginWrapper(Plugin *plugin); // I take ownership of plugin +00126 Plugin *m_plugin; +00127 }; +00128 +00129 } +00130 +00131 } +00132 +00133 _VAMP_SDK_HOSTSPACE_END(PluginWrapper.h) +00134 +00135 #endif +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+-
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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 2008 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 #include "PowerSpectrum.h" +00038 +00039 using std::string; +00040 using std::cerr; +00041 using std::endl; +00042 +00043 #include <math.h> +00044 +00045 PowerSpectrum::PowerSpectrum(float inputSampleRate) : +00046 Plugin(inputSampleRate), +00047 m_blockSize(0) +00048 { +00049 } +00050 +00051 PowerSpectrum::~PowerSpectrum() +00052 { +00053 } +00054 +00055 string +00056 PowerSpectrum::getIdentifier() const +00057 { +00058 return "powerspectrum"; +00059 } +00060 +00061 string +00062 PowerSpectrum::getName() const +00063 { +00064 return "Simple Power Spectrum"; +00065 } +00066 +00067 string +00068 PowerSpectrum::getDescription() const +00069 { +00070 return "Return the power spectrum of a signal"; +00071 } +00072 +00073 string +00074 PowerSpectrum::getMaker() const +00075 { +00076 return "Vamp SDK Example Plugins"; +00077 } +00078 +00079 int +00080 PowerSpectrum::getPluginVersion() const +00081 { +00082 return 1; +00083 } +00084 +00085 string +00086 PowerSpectrum::getCopyright() const +00087 { +00088 return "Freely redistributable (BSD license)"; +00089 } +00090 +00091 bool +00092 PowerSpectrum::initialise(size_t channels, size_t stepSize, size_t blockSize) +00093 { +00094 if (channels < getMinChannelCount() || +00095 channels > getMaxChannelCount()) return false; +00096 +00097 m_blockSize = blockSize; +00098 +00099 return true; +00100 } +00101 +00102 void +00103 PowerSpectrum::reset() +00104 { +00105 } +00106 +00107 PowerSpectrum::OutputList +00108 PowerSpectrum::getOutputDescriptors() const +00109 { +00110 OutputList list; +00111 +00112 OutputDescriptor d; +00113 d.identifier = "powerspectrum"; +00114 d.name = "Power Spectrum"; +00115 d.description = "Power values of the frequency spectrum bins calculated from the input signal"; +00116 d.unit = ""; +00117 d.hasFixedBinCount = true; +00118 if (m_blockSize == 0) { +00119 // Just so as not to return "1". This is the bin count that +00120 // would result from a block size of 1024, which is a likely +00121 // default -- but the host should always set the block size +00122 // before querying the bin count for certain. +00123 d.binCount = 513; +00124 } else { +00125 d.binCount = m_blockSize / 2 + 1; +00126 } +00127 d.hasKnownExtents = false; +00128 d.isQuantized = false; +00129 d.sampleType = OutputDescriptor::OneSamplePerStep; +00130 list.push_back(d); +00131 +00132 return list; +00133 } +00134 +00135 PowerSpectrum::FeatureSet +00136 PowerSpectrum::process(const float *const *inputBuffers, Vamp::RealTime timestamp) +00137 { +00138 FeatureSet fs; +00139 +00140 if (m_blockSize == 0) { +00141 cerr << "ERROR: PowerSpectrum::process: Not initialised" << endl; +00142 return fs; +00143 } +00144 +00145 size_t n = m_blockSize / 2 + 1; +00146 const float *fbuf = inputBuffers[0]; +00147 +00148 Feature feature; +00149 feature.hasTimestamp = false; +00150 feature.values.reserve(n); // optional +00151 +00152 for (size_t i = 0; i < n; ++i) { +00153 +00154 double real = fbuf[i * 2]; +00155 double imag = fbuf[i * 2 + 1]; +00156 +00157 feature.values.push_back(real * real + imag * imag); +00158 } +00159 +00160 fs[0].push_back(feature); +00161 +00162 return fs; +00163 } +00164 +00165 PowerSpectrum::FeatureSet +00166 PowerSpectrum::getRemainingFeatures() +00167 { +00168 return FeatureSet(); +00169 } +00170 +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
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... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+Classes | |
| class | PowerSpectrum |
| Example plugin that returns a power spectrum calculated (trivially) from the frequency domain representation of each block of audio. More... | |
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+
+ -
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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 Chris Cannam. +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 _POWER_SPECTRUM_PLUGIN_H_ +00038 #define _POWER_SPECTRUM_PLUGIN_H_ +00039 +00040 #include "vamp-sdk/Plugin.h" +00041 +00050 class PowerSpectrum : public Vamp::Plugin +00051 { +00052 public: +00053 PowerSpectrum(float inputSampleRate); +00054 virtual ~PowerSpectrum(); +00055 +00056 bool initialise(size_t channels, size_t stepSize, size_t blockSize); +00057 void reset(); +00058 +00059 InputDomain getInputDomain() const { return FrequencyDomain; } +00060 +00061 std::string getIdentifier() const; +00062 std::string getName() const; +00063 std::string getDescription() const; +00064 std::string getMaker() const; +00065 int getPluginVersion() const; +00066 std::string getCopyright() const; +00067 +00068 OutputList getOutputDescriptors() const; +00069 +00070 FeatureSet process(const float *const *inputBuffers, +00071 Vamp::RealTime timestamp); +00072 +00073 FeatureSet getRemainingFeatures(); +00074 +00075 protected: +00076 size_t m_blockSize; +00077 }; +00078 +00079 +00080 #endif +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+-
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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 Chris Cannam. +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 #include "SpectralCentroid.h" +00038 +00039 using std::string; +00040 using std::vector; +00041 using std::cerr; +00042 using std::endl; +00043 +00044 #include <math.h> +00045 +00046 #ifdef __SUNPRO_CC +00047 #include <ieeefp.h> +00048 #define isinf(x) (!finite(x)) +00049 #endif +00050 +00051 #ifdef WIN32 +00052 #define isnan(x) false +00053 #define isinf(x) false +00054 #endif +00055 +00056 SpectralCentroid::SpectralCentroid(float inputSampleRate) : +00057 Plugin(inputSampleRate), +00058 m_stepSize(0), +00059 m_blockSize(0) +00060 { +00061 } +00062 +00063 SpectralCentroid::~SpectralCentroid() +00064 { +00065 } +00066 +00067 string +00068 SpectralCentroid::getIdentifier() const +00069 { +00070 return "spectralcentroid"; +00071 } +00072 +00073 string +00074 SpectralCentroid::getName() const +00075 { +00076 return "Spectral Centroid"; +00077 } +00078 +00079 string +00080 SpectralCentroid::getDescription() const +00081 { +00082 return "Calculate the centroid frequency of the spectrum of the input signal"; +00083 } +00084 +00085 string +00086 SpectralCentroid::getMaker() const +00087 { +00088 return "Vamp SDK Example Plugins"; +00089 } +00090 +00091 int +00092 SpectralCentroid::getPluginVersion() const +00093 { +00094 return 2; +00095 } +00096 +00097 string +00098 SpectralCentroid::getCopyright() const +00099 { +00100 return "Freely redistributable (BSD license)"; +00101 } +00102 +00103 bool +00104 SpectralCentroid::initialise(size_t channels, size_t stepSize, size_t blockSize) +00105 { +00106 if (channels < getMinChannelCount() || +00107 channels > getMaxChannelCount()) return false; +00108 +00109 m_stepSize = stepSize; +00110 m_blockSize = blockSize; +00111 +00112 return true; +00113 } +00114 +00115 void +00116 SpectralCentroid::reset() +00117 { +00118 } +00119 +00120 SpectralCentroid::OutputList +00121 SpectralCentroid::getOutputDescriptors() const +00122 { +00123 OutputList list; +00124 +00125 OutputDescriptor d; +00126 d.identifier = "logcentroid"; +00127 d.name = "Log Frequency Centroid"; +00128 d.description = "Centroid of the log weighted frequency spectrum"; +00129 d.unit = "Hz"; +00130 d.hasFixedBinCount = true; +00131 d.binCount = 1; +00132 d.hasKnownExtents = false; +00133 d.isQuantized = false; +00134 d.sampleType = OutputDescriptor::OneSamplePerStep; +00135 list.push_back(d); +00136 +00137 d.identifier = "linearcentroid"; +00138 d.name = "Linear Frequency Centroid"; +00139 d.description = "Centroid of the linear frequency spectrum"; +00140 list.push_back(d); +00141 +00142 return list; +00143 } +00144 +00145 SpectralCentroid::FeatureSet +00146 SpectralCentroid::process(const float *const *inputBuffers, Vamp::RealTime timestamp) +00147 { +00148 if (m_stepSize == 0) { +00149 cerr << "ERROR: SpectralCentroid::process: " +00150 << "SpectralCentroid has not been initialised" +00151 << endl; +00152 return FeatureSet(); +00153 } +00154 +00155 double numLin = 0.0, numLog = 0.0, denom = 0.0; +00156 +00157 for (size_t i = 1; i <= m_blockSize/2; ++i) { +00158 double freq = (double(i) * m_inputSampleRate) / m_blockSize; +00159 double real = inputBuffers[0][i*2]; +00160 double imag = inputBuffers[0][i*2 + 1]; +00161 double scalemag = sqrt(real * real + imag * imag) / (m_blockSize/2); +00162 numLin += freq * scalemag; +00163 numLog += log10f(freq) * scalemag; +00164 denom += scalemag; +00165 } +00166 +00167 FeatureSet returnFeatures; +00168 +00169 if (denom != 0.0) { +00170 float centroidLin = float(numLin / denom); +00171 float centroidLog = powf(10, float(numLog / denom)); +00172 +00173 Feature feature; +00174 feature.hasTimestamp = false; +00175 +00176 if (!isnan(centroidLog) && !isinf(centroidLog)) { +00177 feature.values.push_back(centroidLog); +00178 } +00179 returnFeatures[0].push_back(feature); +00180 +00181 feature.values.clear(); +00182 if (!isnan(centroidLin) && !isinf(centroidLin)) { +00183 feature.values.push_back(centroidLin); +00184 } +00185 returnFeatures[1].push_back(feature); +00186 } +00187 +00188 return returnFeatures; +00189 } +00190 +00191 SpectralCentroid::FeatureSet +00192 SpectralCentroid::getRemainingFeatures() +00193 { +00194 return FeatureSet(); +00195 } +00196 +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
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... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+Classes | |
| class | SpectralCentroid |
| Example plugin that calculates the centre of gravity of the frequency domain representation of each block of audio. More... | |
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+
+ -
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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 Chris Cannam. +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 _SPECTRAL_CENTROID_PLUGIN_H_ +00038 #define _SPECTRAL_CENTROID_PLUGIN_H_ +00039 +00040 #include "vamp-sdk/Plugin.h" +00041 +00047 class SpectralCentroid : public Vamp::Plugin +00048 { +00049 public: +00050 SpectralCentroid(float inputSampleRate); +00051 virtual ~SpectralCentroid(); +00052 +00053 bool initialise(size_t channels, size_t stepSize, size_t blockSize); +00054 void reset(); +00055 +00056 InputDomain getInputDomain() const { return FrequencyDomain; } +00057 +00058 std::string getIdentifier() const; +00059 std::string getName() const; +00060 std::string getDescription() const; +00061 std::string getMaker() const; +00062 int getPluginVersion() const; +00063 std::string getCopyright() const; +00064 +00065 OutputList getOutputDescriptors() const; +00066 +00067 FeatureSet process(const float *const *inputBuffers, +00068 Vamp::RealTime timestamp); +00069 +00070 FeatureSet getRemainingFeatures(); +00071 +00072 protected: +00073 size_t m_stepSize; +00074 size_t m_blockSize; +00075 }; +00076 +00077 +00078 #endif +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+-
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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 Chris Cannam. +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 #include "ZeroCrossing.h" +00038 +00039 using std::string; +00040 using std::vector; +00041 using std::cerr; +00042 using std::endl; +00043 +00044 #include <cmath> +00045 +00046 ZeroCrossing::ZeroCrossing(float inputSampleRate) : +00047 Plugin(inputSampleRate), +00048 m_stepSize(0), +00049 m_previousSample(0.0f) +00050 { +00051 } +00052 +00053 ZeroCrossing::~ZeroCrossing() +00054 { +00055 } +00056 +00057 string +00058 ZeroCrossing::getIdentifier() const +00059 { +00060 return "zerocrossing"; +00061 } +00062 +00063 string +00064 ZeroCrossing::getName() const +00065 { +00066 return "Zero Crossings"; +00067 } +00068 +00069 string +00070 ZeroCrossing::getDescription() const +00071 { +00072 return "Detect and count zero crossing points"; +00073 } +00074 +00075 string +00076 ZeroCrossing::getMaker() const +00077 { +00078 return "Vamp SDK Example Plugins"; +00079 } +00080 +00081 int +00082 ZeroCrossing::getPluginVersion() const +00083 { +00084 return 2; +00085 } +00086 +00087 string +00088 ZeroCrossing::getCopyright() const +00089 { +00090 return "Freely redistributable (BSD license)"; +00091 } +00092 +00093 bool +00094 ZeroCrossing::initialise(size_t channels, size_t stepSize, size_t blockSize) +00095 { +00096 if (channels < getMinChannelCount() || +00097 channels > getMaxChannelCount()) return false; +00098 +00099 m_stepSize = std::min(stepSize, blockSize); +00100 +00101 return true; +00102 } +00103 +00104 void +00105 ZeroCrossing::reset() +00106 { +00107 m_previousSample = 0.0f; +00108 } +00109 +00110 ZeroCrossing::OutputList +00111 ZeroCrossing::getOutputDescriptors() const +00112 { +00113 OutputList list; +00114 +00115 OutputDescriptor zc; +00116 zc.identifier = "counts"; +00117 zc.name = "Zero Crossing Counts"; +00118 zc.description = "The number of zero crossing points per processing block"; +00119 zc.unit = "crossings"; +00120 zc.hasFixedBinCount = true; +00121 zc.binCount = 1; +00122 zc.hasKnownExtents = false; +00123 zc.isQuantized = true; +00124 zc.quantizeStep = 1.0; +00125 zc.sampleType = OutputDescriptor::OneSamplePerStep; +00126 list.push_back(zc); +00127 +00128 zc.identifier = "zerocrossings"; +00129 zc.name = "Zero Crossings"; +00130 zc.description = "The locations of zero crossing points"; +00131 zc.unit = ""; +00132 zc.hasFixedBinCount = true; +00133 zc.binCount = 0; +00134 zc.sampleType = OutputDescriptor::VariableSampleRate; +00135 zc.sampleRate = m_inputSampleRate; +00136 list.push_back(zc); +00137 +00138 return list; +00139 } +00140 +00141 ZeroCrossing::FeatureSet +00142 ZeroCrossing::process(const float *const *inputBuffers, +00143 Vamp::RealTime timestamp) +00144 { +00145 if (m_stepSize == 0) { +00146 cerr << "ERROR: ZeroCrossing::process: " +00147 << "ZeroCrossing has not been initialised" +00148 << endl; +00149 return FeatureSet(); +00150 } +00151 +00152 float prev = m_previousSample; +00153 size_t count = 0; +00154 +00155 FeatureSet returnFeatures; +00156 +00157 for (size_t i = 0; i < m_stepSize; ++i) { +00158 +00159 float sample = inputBuffers[0][i]; +00160 bool crossing = false; +00161 +00162 if (sample <= 0.0) { +00163 if (prev > 0.0) crossing = true; +00164 } else if (sample > 0.0) { +00165 if (prev <= 0.0) crossing = true; +00166 } +00167 +00168 if (crossing) { +00169 ++count; +00170 Feature feature; +00171 feature.hasTimestamp = true; +00172 feature.timestamp = timestamp + +00173 Vamp::RealTime::frame2RealTime(i, (size_t)m_inputSampleRate); +00174 returnFeatures[1].push_back(feature); +00175 } +00176 +00177 prev = sample; +00178 } +00179 +00180 m_previousSample = prev; +00181 +00182 Feature feature; +00183 feature.hasTimestamp = false; +00184 feature.values.push_back(float(count)); +00185 +00186 returnFeatures[0].push_back(feature); +00187 return returnFeatures; +00188 } +00189 +00190 ZeroCrossing::FeatureSet +00191 ZeroCrossing::getRemainingFeatures() +00192 { +00193 return FeatureSet(); +00194 } +00195 +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
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... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+Classes | |
| class | ZeroCrossing |
| Example plugin that calculates the positions and density of zero-crossing points in an audio waveform. More... | |
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+
+ -
+
+
+
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
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 Chris Cannam. +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 _ZERO_CROSSING_PLUGIN_H_ +00038 #define _ZERO_CROSSING_PLUGIN_H_ +00039 +00040 #include "vamp-sdk/Plugin.h" +00041 +00047 class ZeroCrossing : public Vamp::Plugin +00048 { +00049 public: +00050 ZeroCrossing(float inputSampleRate); +00051 virtual ~ZeroCrossing(); +00052 +00053 bool initialise(size_t channels, size_t stepSize, size_t blockSize); +00054 void reset(); +00055 +00056 InputDomain getInputDomain() const { return TimeDomain; } +00057 +00058 std::string getIdentifier() const; +00059 std::string getName() const; +00060 std::string getDescription() const; +00061 std::string getMaker() const; +00062 int getPluginVersion() const; +00063 std::string getCopyright() const; +00064 +00065 OutputList getOutputDescriptors() const; +00066 +00067 FeatureSet process(const float *const *inputBuffers, +00068 Vamp::RealTime timestamp); +00069 +00070 FeatureSet getRemainingFeatures(); +00071 +00072 protected: +00073 size_t m_stepSize; +00074 float m_previousSample; +00075 }; +00076 +00077 +00078 #endif +
-
+
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:| _VampFeature | |
| _VampFeatureList | |
| _VampFeatureUnion | |
| _VampParameterDescriptor | C language API for Vamp plugins |
| _VampPluginDescriptor | |
| AmplitudeFollower | Example plugin implementing the SuperCollider amplitude follower function |
| FixedTempoEstimator::D | |
| Vamp::Plugin::Feature | |
| FixedTempoEstimator | Example plugin that estimates the tempo of a short fixed-tempo sample |
| FixedTempoEstimator::FixedTempoEstimator::D | |
| Vamp::Plugin::OutputDescriptor | |
| Vamp::PluginBase::ParameterDescriptor | |
| PercussionOnsetDetector | Example plugin that detects percussive events |
| Vamp::Plugin | Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio or related data |
| Vamp::Plugin::Plugin::Feature | |
| Vamp::Plugin::Plugin::OutputDescriptor | |
| Vamp::PluginAdapter< P > | PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular plugin implementation |
| 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 |
| Vamp::Plugin | Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio or related data |
| Vamp::PluginAdapter< P > | PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular plugin implementation |
| 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 |
| Vamp::PluginBase | A base class for plugins with optional configurable parameters, programs, etc |
| Vamp::PluginBase::PluginBase::ParameterDescriptor | |
| 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 |
| 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 |
| 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 |
| Vamp::HostExt::PluginInputDomainAdapter | PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input into frequency-domain input for plugins that need it |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| Vamp::HostExt::PluginInputDomainAdapter | PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input into frequency-domain input for plugins that need it |
| 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 |
| 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 |
| Vamp::HostExt::PluginWrapper | PluginWrapper is a simple base class for adapter plugins |
| PowerSpectrum | Example plugin that returns a power spectrum calculated (trivially) from the frequency domain representation of each block of audio |
| Vamp::RealTime | RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conversion functions |
| Vamp::RealTime | RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conversion functions |
| SpectralCentroid | Example plugin that calculates the centre of gravity of the frequency domain representation of each block of audio |
| ZeroCrossing | Example plugin that calculates the positions and density of zero-crossing points in an audio waveform |
Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by - -
1.5.8
+
+ -
+
+
-
-
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
AmplitudeFollower Member List
This is the complete list of members for AmplitudeFollower, including all inherited members.| AmplitudeFollower(float inputSampleRate) | AmplitudeFollower | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FeatureList typedef | Vamp::Plugin | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FeatureSet typedef | Vamp::Plugin | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FrequencyDomain enum value | Vamp::Plugin | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getCopyright() const | AmplitudeFollower | [virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getCurrentProgram() const | Vamp::PluginBase | [inline, virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getDescription() const | AmplitudeFollower | [virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getIdentifier() const | AmplitudeFollower | [virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getInputDomain() const | AmplitudeFollower | [inline, virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getMaker() const | AmplitudeFollower | [virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getMaxChannelCount() const | Vamp::Plugin | [inline, virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getMinChannelCount() const | Vamp::Plugin | [inline, virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getName() const | AmplitudeFollower | [virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getOutputDescriptors() const | AmplitudeFollower | [virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getParameter(std::string paramid) const | AmplitudeFollower | [virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getParameterDescriptors() const | AmplitudeFollower | [virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getPluginVersion() const | AmplitudeFollower | [virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getPreferredBlockSize() const | Vamp::Plugin | [inline, virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getPreferredStepSize() const | Vamp::Plugin | [inline, virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getPrograms() const | Vamp::PluginBase | [inline, virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getRemainingFeatures() | AmplitudeFollower | [virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getType() const | Vamp::Plugin | [inline, virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| getVampApiVersion() const | Vamp::PluginBase | [inline, virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| initialise(size_t channels, size_t stepSize, size_t blockSize) | AmplitudeFollower | [virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| InputDomain enum name | Vamp::Plugin | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| m_clampcoef | AmplitudeFollower | [protected] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| m_inputSampleRate | Vamp::Plugin | [protected] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| m_previn | AmplitudeFollower | [protected] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| m_relaxcoef | AmplitudeFollower | [protected] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| m_stepSize | AmplitudeFollower | [protected] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OutputList typedef | Vamp::Plugin | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ParameterList typedef | Vamp::PluginBase | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Plugin(float inputSampleRate) | Vamp::Plugin | [inline, protected] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| process(const float *const *inputBuffers, Vamp::RealTime timestamp) | AmplitudeFollower | [virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProgramList typedef | Vamp::PluginBase | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| reset() | AmplitudeFollower | [virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| selectProgram(std::string) | Vamp::PluginBase | [inline, virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| setParameter(std::string paramid, float newval) | AmplitudeFollower | [virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TimeDomain enum value | Vamp::Plugin | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ~AmplitudeFollower() | AmplitudeFollower | [virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ~Plugin() | Vamp::Plugin | [inline, virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ~PluginBase() | Vamp::PluginBase | [inline, virtual] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
+ VampPluginSDK
+ 2.1
+
+
+ |
+
+
+
+
-
-
AmplitudeFollower Class Reference
Example plugin implementing the SuperCollider amplitude follower function. -More... -
-#include <AmplitudeFollower.h>
-
+ +
Example plugin implementing the SuperCollider amplitude follower function. + More...
+ +#include <AmplitudeFollower.h>
Public Types | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| enum | InputDomain { TimeDomain,
-FrequencyDomain
+
+
Detailed Description+Example plugin implementing the SuperCollider amplitude follower function. -typedef std::vector | -< OutputDescriptor > OutputList | typedef std::vector< Feature > | FeatureList | typedef std::map< int, | -FeatureList > FeatureSet | 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. | Protected Attributessize_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
- +Definition at line 47 of file AmplitudeFollower.h.
+Member Typedef Documentation
+typedef std::vector<OutputDescriptor> Vamp::Plugin::OutputList [inherited] |
+ typedef std::vector<OutputDescriptor> Vamp::Plugin::OutputList [inherited] |
- -
Definition at line 327 of file vamp-sdk/Plugin.h.
+Definition at line 327 of file vamp-sdk/Plugin.h.
typedef std::vector<Feature> Vamp::Plugin::FeatureList [inherited] |
+ typedef std::vector<Feature> Vamp::Plugin::FeatureList [inherited] |
- -
Definition at line 385 of file vamp-sdk/Plugin.h.
+Definition at line 385 of file vamp-sdk/Plugin.h.
typedef std::map<int, FeatureList> Vamp::Plugin::FeatureSet [inherited] |
+ typedef std::map<int, FeatureList> Vamp::Plugin::FeatureSet [inherited] |
- -
Definition at line 387 of file vamp-sdk/Plugin.h.
+Definition at line 387 of file vamp-sdk/Plugin.h.
typedef std::vector<ParameterDescriptor> Vamp::PluginBase::ParameterList [inherited] |
+ typedef std::vector<ParameterDescriptor> Vamp::PluginBase::ParameterList [inherited] |
- -
Definition at line 203 of file vamp-sdk/PluginBase.h.
+Definition at line 203 of file vamp-sdk/PluginBase.h.
typedef std::vector<std::string> Vamp::PluginBase::ProgramList [inherited] |
+ typedef std::vector<std::string> Vamp::PluginBase::ProgramList [inherited] |
- -
Definition at line 225 of file vamp-sdk/PluginBase.h.
+Definition at line 225 of file vamp-sdk/PluginBase.h.
-
Member Enumeration Documentation
- + +Member Enumeration Documentation
+enum Vamp::Plugin::InputDomain [inherited] |
+ enum Vamp::Plugin::InputDomain [inherited] |
-