tip/code-docs/ZeroCrossing_8h_source.html

 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */

 /*
     Vamp

     An API for audio analysis and feature extraction plugins.

     Centre for Digital Music, Queen Mary, University of London.
     Copyright 2006 Chris Cannam.

     Permission is hereby granted, free of charge, to any person
     obtaining a copy of this software and associated documentation
     files (the "Software"), to deal in the Software without
     restriction, including without limitation the rights to use, copy,
     modify, merge, publish, distribute, sublicense, and/or sell copies
     of the Software, and to permit persons to whom the Software is
     furnished to do so, subject to the following conditions:

     The above copyright notice and this permission notice shall be
     included in all copies or substantial portions of the Software.

     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

     Except as contained in this notice, the names of the Centre for
     Digital Music; Queen Mary, University of London; and Chris Cannam
     shall not be used in advertising or otherwise to promote the sale,
     use or other dealings in this Software without prior written
     authorization.
 */

 #ifndef _ZERO_CROSSING_PLUGIN_H_
 #define _ZERO_CROSSING_PLUGIN_H_

 #include "vamp-sdk/Plugin.h"

 class ZeroCrossing : public Vamp::Plugin
 {
 public:
     ZeroCrossing(float inputSampleRate);
     virtual ~ZeroCrossing();

     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
     void reset();

     InputDomain getInputDomain() const { return TimeDomain; }

     std::string getIdentifier() const;
     std::string getName() const;
     std::string getDescription() const;
     std::string getMaker() const;
     int getPluginVersion() const;
     std::string getCopyright() const;

     OutputList getOutputDescriptors() const;

     FeatureSet process(const float *const *inputBuffers,
                        Vamp::RealTime timestamp);

     FeatureSet getRemainingFeatures();

 protected:
     size_t m_stepSize;
     float m_previousSample;
 };


 #endif
Vamp::Plugin::OutputList
std::vector< OutputDescriptor > OutputList
Definition: vamp-sdk/Plugin.h:335

Chris@6: ZeroCrossing::process
FeatureSet process(const float *const *inputBuffers, Vamp::RealTime timestamp)
Process a single block of input data.
Definition: ZeroCrossing.cpp:143

Chris@6: Vamp::Plugin
Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...
Definition: vamp-sdk/Plugin.h:124

Chris@6: Vamp::Plugin::InputDomain
InputDomain
Definition: vamp-sdk/Plugin.h:152

Chris@6: ZeroCrossing::getOutputDescriptors
OutputList getOutputDescriptors() const
Get the outputs of this plugin.
Definition: ZeroCrossing.cpp:112

Chris@6: ZeroCrossing::initialise
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).
Definition: ZeroCrossing.cpp:95

Chris@6: ZeroCrossing
Example plugin that calculates the positions and density of zero-crossing points in an audio waveform...
Definition: ZeroCrossing.h:47

Chris@6: Vamp::Plugin::FeatureSet
std::map< int, FeatureList > FeatureSet
Definition: vamp-sdk/Plugin.h:395

Chris@6: ZeroCrossing::m_stepSize
size_t m_stepSize
Definition: ZeroCrossing.h:73

Chris@6: ZeroCrossing::getRemainingFeatures
FeatureSet getRemainingFeatures()
After all blocks have been processed, calculate and return any remaining features derived from the co...
Definition: ZeroCrossing.cpp:192

Chris@6: ZeroCrossing::reset
void reset()
Reset the plugin after use, to prepare it for another clean run.
Definition: ZeroCrossing.cpp:106

Chris@6: ZeroCrossing::getIdentifier
std::string getIdentifier() const
Get the computer-usable name of the plugin.
Definition: ZeroCrossing.cpp:59

Chris@6: ZeroCrossing::~ZeroCrossing
virtual ~ZeroCrossing()
Definition: ZeroCrossing.cpp:54

Chris@6: ZeroCrossing::ZeroCrossing
ZeroCrossing(float inputSampleRate)
Definition: ZeroCrossing.cpp:47

Chris@6: ZeroCrossing::getInputDomain
InputDomain getInputDomain() const
Get the plugin&#39;s required input domain.
Definition: ZeroCrossing.h:56

Chris@6: Vamp::Plugin::TimeDomain
Definition: vamp-sdk/Plugin.h:152

Chris@6: Vamp::RealTime
RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...
Definition: vamp-sdk/RealTime.h:66

Chris@6: ZeroCrossing::getPluginVersion
int getPluginVersion() const
Get the version number of the plugin.
Definition: ZeroCrossing.cpp:83

Chris@6: ZeroCrossing::getMaker
std::string getMaker() const
Get the name of the author or vendor of the plugin in human-readable form.
Definition: ZeroCrossing.cpp:77

Chris@6: ZeroCrossing::getCopyright
std::string getCopyright() const
Get the copyright statement or licensing summary for the plugin.
Definition: ZeroCrossing.cpp:89

Chris@6: ZeroCrossing::getName
std::string getName() const
Get a human-readable name or title of the plugin.
Definition: ZeroCrossing.cpp:65

Chris@6: ZeroCrossing::getDescription
std::string getDescription() const
Get a human-readable description for the plugin, typically a line of text that may optionally be disp...
Definition: ZeroCrossing.cpp:71

Chris@6: ZeroCrossing::m_previousSample
float m_previousSample
Definition: ZeroCrossing.h:74

Chris@6: Plugin.h

Chris@6: