libs/vamp-plugins/KeyDetect.h

   1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
   2
   3 /*
   4     QM Vamp Plugin Set
   5
   6     Centre for Digital Music, Queen Mary, University of London.
   7
   8     This program is free software; you can redistribute it and/or
   9     modify it under the terms of the GNU General Public License as
  10     published by the Free Software Foundation; either version 2 of the
  11     License, or (at your option) any later version.  See the file
  12     COPYING included with this distribution for more information.
  13 */
  14
  15 #ifndef _GETMODE_PLUGIN_H_
  16 #define _GETMODE_PLUGIN_H_
  17
  18 #include <vamp-sdk/Plugin.h>
  19
  20 #include <dsp/keydetection/GetKeyMode.h>
  21
  22 class KeyDetector : public Vamp::Plugin
  23 {
  24 public:
  25     KeyDetector(float inputSampleRate);
  26     virtual ~KeyDetector();
  27
  28     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
  29     void reset();
  30
  31     InputDomain getInputDomain() const { return TimeDomain; }
  32
  33     std::string getIdentifier() const;
  34     std::string getName() const;
  35     std::string getDescription() const;
  36     std::string getMaker() const;
  37     int getPluginVersion() const;
  38     std::string getCopyright() const;
  39
  40     ParameterList getParameterDescriptors() const;
  41     float getParameter(std::string) const;
  42     void setParameter(std::string, float);
  43
  44     OutputList getOutputDescriptors() const;
  45
  46     FeatureSet process(const float *const *inputBuffers,
  47                        Vamp::RealTime timestamp);
  48
  49     FeatureSet getRemainingFeatures();
  50
  51     size_t getPreferredStepSize() const;
  52     size_t getPreferredBlockSize() const;
  53
  54 protected:
  55     mutable size_t m_stepSize;
  56     mutable size_t m_blockSize;
  57     float m_tuningFrequency;
  58     int m_length;
  59
  60     std::string getKeyName(int index, bool minor, bool includeMajMin) const;
  61
  62     GetKeyMode* m_getKeyMode;
  63     double* m_inputFrame;
  64     int m_prevKey;
  65     bool m_first;
  66 };
  67
  68
  69 #endif