plugins/Pitch.h

   1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
   2
   3 /*
   4     Vamp feature extraction plugins using Paul Brossier's Aubio library.
   5
   6     Centre for Digital Music, Queen Mary, University of London.
   7     This file copyright 2006 Chris Cannam.
   8
   9     This program is free software; you can redistribute it and/or
  10     modify it under the terms of the GNU General Public License as
  11     published by the Free Software Foundation; either version 2 of the
  12     License, or (at your option) any later version.  See the file
  13     COPYING included with this distribution for more information.
  14
  15 */
  16
  17 #ifndef _PITCH_PLUGIN_H_
  18 #define _PITCH_PLUGIN_H_
  19
  20 #include <vamp-sdk/Plugin.h>
  21 #include <aubio/aubio.h>
  22
  23 class Pitch : public Vamp::Plugin
  24 {
  25 public:
  26     Pitch(float inputSampleRate);
  27     virtual ~Pitch();
  28
  29     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
  30     void reset();
  31
  32     InputDomain getInputDomain() const { return TimeDomain; }
  33
  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     size_t getPreferredStepSize() const;
  45     size_t getPreferredBlockSize() const;
  46
  47     OutputList getOutputDescriptors() const;
  48
  49     FeatureSet process(const float *const *inputBuffers,
  50                        Vamp::RealTime timestamp);
  51
  52     FeatureSet getRemainingFeatures();
  53
  54 protected:
  55     fvec_t *m_ibuf;
  56     aubio_pitchdetection_t *m_pitchdet;
  57     aubio_pitchdetection_type m_pitchtype;
  58     aubio_pitchdetection_mode m_pitchmode;
  59     size_t m_stepSize;
  60     size_t m_blockSize;
  61     size_t m_channelCount;
  62 };
  63
  64
  65 #endif