cannam@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@0: 
cannam@0: /*
cannam@0:     Vamp
cannam@0: 
cannam@0:     An API for audio analysis and feature extraction plugins.
cannam@0: 
cannam@0:     Centre for Digital Music, Queen Mary, University of London.
cannam@0:     Copyright 2006 Chris Cannam.
cannam@0:   
cannam@0:     Permission is hereby granted, free of charge, to any person
cannam@0:     obtaining a copy of this software and associated documentation
cannam@0:     files (the "Software"), to deal in the Software without
cannam@0:     restriction, including without limitation the rights to use, copy,
cannam@0:     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@0:     of the Software, and to permit persons to whom the Software is
cannam@0:     furnished to do so, subject to the following conditions:
cannam@0: 
cannam@0:     The above copyright notice and this permission notice shall be
cannam@0:     included in all copies or substantial portions of the Software.
cannam@0: 
cannam@0:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@0:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@0:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@6:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@0:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@0:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@0:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@0: 
cannam@0:     Except as contained in this notice, the names of the Centre for
cannam@0:     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@0:     shall not be used in advertising or otherwise to promote the sale,
cannam@0:     use or other dealings in this Software without prior written
cannam@0:     authorization.
cannam@0: */
cannam@0: 
cannam@0: #ifndef _ZERO_CROSSING_PLUGIN_H_
cannam@0: #define _ZERO_CROSSING_PLUGIN_H_
cannam@0: 
cannam@64: #include "vamp-sdk/Plugin.h"
cannam@0: 
cannam@54: /**
cannam@54:  * Example plugin that calculates the positions and density of
cannam@54:  * zero-crossing points in an audio waveform.
cannam@54: */
cannam@54: 
cannam@0: class ZeroCrossing : public Vamp::Plugin
cannam@0: {
cannam@0: public:
cannam@0:     ZeroCrossing(float inputSampleRate);
cannam@0:     virtual ~ZeroCrossing();
cannam@0: 
cannam@0:     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
cannam@0:     void reset();
cannam@0: 
cannam@0:     InputDomain getInputDomain() const { return TimeDomain; }
cannam@0: 
cannam@49:     std::string getIdentifier() const;
cannam@0:     std::string getName() const;
cannam@0:     std::string getDescription() const;
cannam@0:     std::string getMaker() const;
cannam@0:     int getPluginVersion() const;
cannam@0:     std::string getCopyright() const;
cannam@0: 
cannam@0:     OutputList getOutputDescriptors() const;
cannam@0: 
cannam@47:     FeatureSet process(const float *const *inputBuffers,
cannam@47:                        Vamp::RealTime timestamp);
cannam@0: 
cannam@0:     FeatureSet getRemainingFeatures();
cannam@0: 
cannam@0: protected:
cannam@0:     size_t m_stepSize;
cannam@0:     float m_previousSample;
cannam@0: };
cannam@0: 
cannam@0: 
cannam@0: #endif