cannam@56
|
1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
|
cannam@56
|
2
|
cannam@56
|
3 /*
|
cannam@56
|
4 Vamp
|
cannam@56
|
5
|
cannam@56
|
6 An API for audio analysis and feature extraction plugins.
|
cannam@56
|
7
|
cannam@56
|
8 Centre for Digital Music, Queen Mary, University of London.
|
cannam@56
|
9 Copyright 2006 Chris Cannam.
|
cannam@56
|
10
|
cannam@56
|
11 Permission is hereby granted, free of charge, to any person
|
cannam@56
|
12 obtaining a copy of this software and associated documentation
|
cannam@56
|
13 files (the "Software"), to deal in the Software without
|
cannam@56
|
14 restriction, including without limitation the rights to use, copy,
|
cannam@56
|
15 modify, merge, publish, distribute, sublicense, and/or sell copies
|
cannam@56
|
16 of the Software, and to permit persons to whom the Software is
|
cannam@56
|
17 furnished to do so, subject to the following conditions:
|
cannam@56
|
18
|
cannam@56
|
19 The above copyright notice and this permission notice shall be
|
cannam@56
|
20 included in all copies or substantial portions of the Software.
|
cannam@56
|
21
|
cannam@56
|
22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
cannam@56
|
23 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
cannam@56
|
24 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
cannam@56
|
25 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
|
cannam@56
|
26 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
|
cannam@56
|
27 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
cannam@56
|
28 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
cannam@56
|
29
|
cannam@56
|
30 Except as contained in this notice, the names of the Centre for
|
cannam@56
|
31 Digital Music; Queen Mary, University of London; and Chris Cannam
|
cannam@56
|
32 shall not be used in advertising or otherwise to promote the sale,
|
cannam@56
|
33 use or other dealings in this Software without prior written
|
cannam@56
|
34 authorization.
|
cannam@56
|
35 */
|
cannam@56
|
36
|
cannam@56
|
37 #ifndef _PLUGIN_INPUT_DOMAIN_ADAPTER_H_
|
cannam@56
|
38
|
cannam@56
|
39 #include <vamp-sdk/Plugin.h>
|
cannam@56
|
40
|
cannam@56
|
41 namespace Vamp {
|
cannam@56
|
42
|
cannam@56
|
43 /**
|
cannam@56
|
44 * An adapter that converts time-domain input into frequency-domain
|
cannam@56
|
45 * input for plugins that need it. In every other respect this
|
cannam@56
|
46 * adapter behaves like the plugin it wraps. The wrapped plugin may
|
cannam@56
|
47 * be a time-domain plugin, in which case this wrapper does nothing.
|
cannam@56
|
48 *
|
cannam@56
|
49 * Uses a Hanning windowed FFT. The FFT implementation is not the
|
cannam@56
|
50 * fastest, so a host can do much better if it cares enough, but it is
|
cannam@56
|
51 * simple and self-contained.
|
cannam@56
|
52 *
|
cannam@56
|
53 * Note that this adapter does not support non-power-of-two block
|
cannam@56
|
54 * sizes.
|
cannam@56
|
55 */
|
cannam@56
|
56
|
cannam@56
|
57 //!!! It would also be nice to have a channel wrapper, which deals
|
cannam@56
|
58 //with mixing down channels if the plugin needs a different number
|
cannam@56
|
59 //from the input source. It would have some sort of mixdown/channel
|
cannam@56
|
60 //input policy selection. Probably this class and that one should
|
cannam@56
|
61 //both inherit a PluginAdapter class which contains a plugin and
|
cannam@56
|
62 //delegates all calls through to it; the subclass can then override
|
cannam@56
|
63 //only the ones it needs to handle.
|
cannam@56
|
64
|
cannam@56
|
65 class PluginInputDomainAdapter : public Plugin
|
cannam@56
|
66 {
|
cannam@56
|
67 public:
|
cannam@56
|
68 PluginInputDomainAdapter(Plugin *plugin); // I take ownership of plugin
|
cannam@56
|
69 virtual ~PluginInputDomainAdapter();
|
cannam@56
|
70
|
cannam@56
|
71 bool initialise(size_t channels, size_t stepSize, size_t blockSize);
|
cannam@56
|
72 void reset();
|
cannam@56
|
73
|
cannam@56
|
74 InputDomain getInputDomain() const { return Plugin::TimeDomain; }
|
cannam@56
|
75
|
cannam@56
|
76 unsigned int getVampApiVersion() const;
|
cannam@56
|
77 std::string getIdentifier() const;
|
cannam@56
|
78 std::string getName() const;
|
cannam@56
|
79 std::string getDescription() const;
|
cannam@56
|
80 std::string getMaker() const;
|
cannam@56
|
81 int getPluginVersion() const;
|
cannam@56
|
82 std::string getCopyright() const;
|
cannam@56
|
83
|
cannam@56
|
84 ParameterList getParameterDescriptors() const;
|
cannam@56
|
85 float getParameter(std::string) const;
|
cannam@56
|
86 void setParameter(std::string, float);
|
cannam@56
|
87
|
cannam@56
|
88 ProgramList getPrograms() const;
|
cannam@56
|
89 std::string getCurrentProgram() const;
|
cannam@56
|
90 void selectProgram(std::string);
|
cannam@56
|
91
|
cannam@56
|
92 size_t getPreferredStepSize() const;
|
cannam@56
|
93 size_t getPreferredBlockSize() const;
|
cannam@56
|
94
|
cannam@56
|
95 size_t getMinChannelCount() const;
|
cannam@56
|
96 size_t getMaxChannelCount() const;
|
cannam@56
|
97
|
cannam@56
|
98 OutputList getOutputDescriptors() const;
|
cannam@56
|
99
|
cannam@56
|
100 FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
|
cannam@56
|
101
|
cannam@56
|
102 FeatureSet getRemainingFeatures();
|
cannam@56
|
103
|
cannam@56
|
104 protected:
|
cannam@56
|
105 Plugin *m_plugin;
|
cannam@56
|
106 size_t m_channels;
|
cannam@56
|
107 size_t m_blockSize;
|
cannam@56
|
108 float **m_freqbuf;
|
cannam@56
|
109 double *m_ri;
|
cannam@56
|
110 double *m_ro;
|
cannam@56
|
111 double *m_io;
|
cannam@56
|
112
|
cannam@56
|
113 void fft(unsigned int n, bool inverse,
|
cannam@56
|
114 double *ri, double *ii, double *ro, double *io);
|
cannam@56
|
115 };
|
cannam@56
|
116
|
cannam@56
|
117 }
|
cannam@56
|
118
|
cannam@56
|
119 #endif
|