comparison plugins/KeyDetect.h @ 21:d695fc2baa91

* Turning key-mode plugin into a generic key detection plugin, and attempting to debug it
author Chris Cannam <c.cannam@qmul.ac.uk>
date Mon, 22 Jan 2007 17:32:40 +0000
parents
children 6d014fb538db
comparison
equal deleted inserted replaced
20:1f1881046b0c 21:d695fc2baa91
1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
2
3 /*
4 Vamp
5
6 An API for audio analysis and feature extraction plugins.
7
8 Centre for Digital Music, Queen Mary, University of London.
9 Copyright 2006-2007 QMUL.
10
11 Permission is hereby granted, free of charge, to any person
12 obtaining a copy of this software and associated documentation
13 files (the "Software"), to deal in the Software without
14 restriction, including without limitation the rights to use, copy,
15 modify, merge, publish, distribute, sublicense, and/or sell copies
16 of the Software, and to permit persons to whom the Software is
17 furnished to do so, subject to the following conditions:
18
19 The above copyright notice and this permission notice shall be
20 included in all copies or substantial portions of the Software.
21
22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
25 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
26 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
27 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29
30 Except as contained in this notice, the names of the Centre for
31 Digital Music; Queen Mary, University of London; and Chris Cannam
32 shall not be used in advertising or otherwise to promote the sale,
33 use or other dealings in this Software without prior written
34 authorization.
35 */
36
37 #ifndef _GETMODE_PLUGIN_H_
38 #define _GETMODE_PLUGIN_H_
39
40 #include <vamp-sdk/Plugin.h>
41
42 #include <dsp/keydetection/GetKeyMode.h>
43
44 class KeyDetector : public Vamp::Plugin
45 {
46 public:
47 KeyDetector(float inputSampleRate);
48 virtual ~KeyDetector();
49
50 bool initialise(size_t channels, size_t stepSize, size_t blockSize);
51 void reset();
52
53 InputDomain getInputDomain() const { return TimeDomain; }
54
55 std::string getName() const;
56 std::string getDescription() const;
57 std::string getMaker() const;
58 int getPluginVersion() const;
59 std::string getCopyright() const;
60
61 ParameterList getParameterDescriptors() const;
62 float getParameter(std::string) const;
63 void setParameter(std::string, float);
64
65 OutputList getOutputDescriptors() const;
66
67 FeatureSet process(const float *const *inputBuffers,
68 Vamp::RealTime timestamp);
69
70 FeatureSet getRemainingFeatures();
71
72 size_t getPreferredStepSize() const;
73 size_t getPreferredBlockSize() const;
74
75 protected:
76 mutable size_t m_stepSize;
77 mutable size_t m_blockSize;
78 float m_tuningFrequency;
79 int m_length;
80
81 const char *getKeyName(int index);
82
83 GetKeyMode* m_getKeyMode;
84 double* m_inputFrame;
85 int m_prevKey;
86 };
87
88
89 #endif