3c430ef1ed66/code-docs/ZeroCrossing_8h_source.html

00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@1: 00002
Chris@1: 00003 /*
Chris@1: 00004     Vamp
Chris@1: 00005
Chris@1: 00006     An API for audio analysis and feature extraction plugins.
Chris@1: 00007
Chris@1: 00008     Centre for Digital Music, Queen Mary, University of London.
Chris@1: 00009     Copyright 2006 Chris Cannam.
Chris@1: 00010
Chris@1: 00011     Permission is hereby granted, free of charge, to any person
Chris@1: 00012     obtaining a copy of this software and associated documentation
Chris@1: 00013     files (the "Software"), to deal in the Software without
Chris@1: 00014     restriction, including without limitation the rights to use, copy,
Chris@1: 00015     modify, merge, publish, distribute, sublicense, and/or sell copies
Chris@1: 00016     of the Software, and to permit persons to whom the Software is
Chris@1: 00017     furnished to do so, subject to the following conditions:
Chris@1: 00018
Chris@1: 00019     The above copyright notice and this permission notice shall be
Chris@1: 00020     included in all copies or substantial portions of the Software.
Chris@1: 00021
Chris@1: 00022     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Chris@1: 00023     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Chris@1: 00024     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Chris@1: 00025     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
Chris@1: 00026     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
Chris@1: 00027     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
Chris@1: 00028     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Chris@1: 00029
Chris@1: 00030     Except as contained in this notice, the names of the Centre for
Chris@1: 00031     Digital Music; Queen Mary, University of London; and Chris Cannam
Chris@1: 00032     shall not be used in advertising or otherwise to promote the sale,
Chris@1: 00033     use or other dealings in this Software without prior written
Chris@1: 00034     authorization.
Chris@1: 00035 */
Chris@1: 00036
Chris@1: 00037 #ifndef _ZERO_CROSSING_PLUGIN_H_
Chris@1: 00038 #define _ZERO_CROSSING_PLUGIN_H_
Chris@1: 00039
Chris@1: 00040 #include "vamp-sdk/Plugin.h"
Chris@1: 00041
Chris@1: 00047 class ZeroCrossing : public Vamp::Plugin
Chris@1: 00048 {
Chris@1: 00049 public:
Chris@1: 00050     ZeroCrossing(float inputSampleRate);
Chris@1: 00051     virtual ~ZeroCrossing();
Chris@1: 00052
Chris@1: 00053     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
Chris@1: 00054     void reset();
Chris@1: 00055
Chris@1: 00056     InputDomain getInputDomain() const { return TimeDomain; }
Chris@1: 00057
Chris@1: 00058     std::string getIdentifier() const;
Chris@1: 00059     std::string getName() const;
Chris@1: 00060     std::string getDescription() const;
Chris@1: 00061     std::string getMaker() const;
Chris@1: 00062     int getPluginVersion() const;
Chris@1: 00063     std::string getCopyright() const;
Chris@1: 00064
Chris@1: 00065     OutputList getOutputDescriptors() const;
Chris@1: 00066
Chris@1: 00067     FeatureSet process(const float *const *inputBuffers,
Chris@1: 00068                        Vamp::RealTime timestamp);
Chris@1: 00069
Chris@1: 00070     FeatureSet getRemainingFeatures();
Chris@1: 00071
Chris@1: 00072 protected:
Chris@1: 00073     size_t m_stepSize;
Chris@1: 00074     float m_previousSample;
Chris@1: 00075 };
Chris@1: 00076
Chris@1: 00077
Chris@1: 00078 #endif
Chris@1: