annotate plugins/BeatDetect.h @ 10:6ab46726a653

* Make plugin initialise fail if the right block size isn't provided.
author Chris Cannam <c.cannam@qmul.ac.uk>
date Tue, 16 May 2006 12:20:57 +0000
parents d00c1bad7332
children 99dadc93042e
rev   line source
c@0 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
c@0 2
c@0 3 /*
c@0 4 QM Vamp Plugin Set
c@0 5
c@0 6 Centre for Digital Music, Queen Mary, University of London.
c@0 7 All rights reserved.
c@0 8 */
c@0 9
c@0 10 #ifndef _BEAT_DETECT_PLUGIN_H_
c@0 11 #define _BEAT_DETECT_PLUGIN_H_
c@0 12
c@3 13 #include <vamp-sdk/Plugin.h>
c@0 14
c@0 15 class BeatDetectorData;
c@0 16
c@0 17 class BeatDetector : public Vamp::Plugin
c@0 18 {
c@0 19 public:
c@0 20 BeatDetector(float inputSampleRate);
c@0 21 virtual ~BeatDetector();
c@0 22
c@0 23 bool initialise(size_t channels, size_t stepSize, size_t blockSize);
c@0 24 void reset();
c@0 25
c@6 26 InputDomain getInputDomain() const { return FrequencyDomain; }
c@0 27
c@0 28 std::string getName() const;
c@0 29 std::string getDescription() const;
c@0 30 std::string getMaker() const;
c@0 31 int getPluginVersion() const;
c@0 32 std::string getCopyright() const;
c@0 33
c@0 34 ParameterList getParameterDescriptors() const;
c@0 35 float getParameter(std::string) const;
c@0 36 void setParameter(std::string, float);
c@0 37
c@0 38 size_t getPreferredStepSize() const;
c@0 39 size_t getPreferredBlockSize() const;
c@0 40
c@0 41 OutputList getOutputDescriptors() const;
c@0 42
c@0 43 FeatureSet process(float **inputBuffers, Vamp::RealTime timestamp);
c@0 44
c@0 45 FeatureSet getRemainingFeatures();
c@0 46
c@0 47 protected:
c@0 48 BeatDetectorData *m_d;
c@0 49 int m_dfType;
c@0 50 static float m_stepSecs;
c@0 51 };
c@0 52
c@0 53
c@0 54 #endif