annotate BeatRootVampPlugin.h @ 37:1f175ae200a6 tip

Update RDF
author Chris Cannam
date Wed, 25 Jun 2014 13:48:49 +0100
parents b9c2f444cdaa
children
rev   line source
Chris@0 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
Chris@0 2
Chris@0 3 /*
Chris@0 4 Vamp feature extraction plugin for the BeatRoot beat tracker.
Chris@0 5
Chris@0 6 Centre for Digital Music, Queen Mary, University of London.
Chris@0 7 This file copyright 2011 Simon Dixon, Chris Cannam and QMUL.
Chris@0 8
Chris@0 9 This program is free software; you can redistribute it and/or
Chris@0 10 modify it under the terms of the GNU General Public License as
Chris@0 11 published by the Free Software Foundation; either version 2 of the
Chris@0 12 License, or (at your option) any later version. See the file
Chris@0 13 COPYING included with this distribution for more information.
Chris@0 14 */
Chris@0 15
Chris@0 16 #ifndef _BEATROOT_VAMP_PLUGIN_H_
Chris@0 17 #define _BEATROOT_VAMP_PLUGIN_H_
Chris@0 18
Chris@23 19 #include "Agent.h"
Chris@23 20
Chris@0 21 #include <vamp-sdk/Plugin.h>
Chris@0 22
Chris@0 23 using std::string;
Chris@0 24
Chris@1 25 class BeatRootProcessor;
Chris@1 26
Chris@0 27 class BeatRootVampPlugin : public Vamp::Plugin
Chris@0 28 {
Chris@0 29 public:
Chris@0 30 BeatRootVampPlugin(float inputSampleRate);
Chris@0 31 virtual ~BeatRootVampPlugin();
Chris@0 32
Chris@0 33 string getIdentifier() const;
Chris@0 34 string getName() const;
Chris@0 35 string getDescription() const;
Chris@0 36 string getMaker() const;
Chris@0 37 int getPluginVersion() const;
Chris@0 38 string getCopyright() const;
Chris@0 39
Chris@0 40 InputDomain getInputDomain() const;
Chris@0 41 size_t getPreferredBlockSize() const;
Chris@0 42 size_t getPreferredStepSize() const;
Chris@0 43 size_t getMinChannelCount() const;
Chris@0 44 size_t getMaxChannelCount() const;
Chris@0 45
Chris@0 46 ParameterList getParameterDescriptors() const;
Chris@0 47 float getParameter(string identifier) const;
Chris@0 48 void setParameter(string identifier, float value);
Chris@0 49
Chris@0 50 ProgramList getPrograms() const;
Chris@0 51 string getCurrentProgram() const;
Chris@0 52 void selectProgram(string name);
Chris@0 53
Chris@0 54 OutputList getOutputDescriptors() const;
Chris@0 55
Chris@0 56 bool initialise(size_t channels, size_t stepSize, size_t blockSize);
Chris@0 57 void reset();
Chris@0 58
Chris@0 59 FeatureSet process(const float *const *inputBuffers,
Chris@0 60 Vamp::RealTime timestamp);
Chris@0 61
Chris@0 62 FeatureSet getRemainingFeatures();
Chris@0 63
Chris@0 64 protected:
Chris@0 65 BeatRootProcessor *m_processor;
Chris@23 66 AgentParameters m_parameters;
Chris@31 67 Vamp::RealTime m_origin;
Chris@31 68 bool m_firstFrame;
Chris@0 69 };
Chris@0 70
Chris@0 71
Chris@0 72
Chris@0 73 #endif