95d94f5babb2fca13952bf092ed962255009e242
[vamp-aubio-plugins.git] / plugins / Onset.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 _ONSET_PLUGIN_H_
18 #define _ONSET_PLUGIN_H_
19
20 #include <vamp-sdk/Plugin.h>
21 #include <aubio/aubio.h>
22
23 #include "Types.h"
24
25 class Onset : public Vamp::Plugin
26 {
27 public:
28     Onset(float inputSampleRate);
29     virtual ~Onset();
30
31     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
32     void reset();
33
34     InputDomain getInputDomain() const { return TimeDomain; }
35
36     std::string getIdentifier() const;
37     std::string getName() const;
38     std::string getDescription() const;
39     std::string getMaker() const;
40     int getPluginVersion() const;
41     std::string getCopyright() const;
42
43     ParameterList getParameterDescriptors() const;
44     float getParameter(std::string) const;
45     void setParameter(std::string, float);
46
47     size_t getPreferredStepSize() const;
48     size_t getPreferredBlockSize() const;
49
50     OutputList getOutputDescriptors() const;
51
52     FeatureSet process(const float *const *inputBuffers,
53                        Vamp::RealTime timestamp);
54
55     FeatureSet getRemainingFeatures();
56
57 protected:
58     fvec_t *m_ibuf;
59     cvec_t *m_fftgrain;
60     fvec_t *m_onset;
61     aubio_pvoc_t *m_pv;
62     aubio_peakpicker_t *m_peakpick;
63     aubio_onset_t *m_onsetdet;
64     OnsetType m_onsettype;
65     float m_threshold;
66     float m_silence;
67     size_t m_stepSize;
68     size_t m_blockSize;
69     Vamp::RealTime m_delay;
70     Vamp::RealTime m_lastOnset;
71 };
72
73
74 #endif