cannam@233
|
1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
|
cannam@233
|
2
|
cannam@233
|
3 /*
|
cannam@233
|
4 Vamp
|
cannam@233
|
5
|
cannam@233
|
6 An API for audio analysis and feature extraction plugins.
|
cannam@233
|
7
|
cannam@233
|
8 Centre for Digital Music, Queen Mary, University of London.
|
cannam@233
|
9 Copyright 2006-2007 Chris Cannam and QMUL.
|
cannam@233
|
10
|
cannam@233
|
11 Permission is hereby granted, free of charge, to any person
|
cannam@233
|
12 obtaining a copy of this software and associated documentation
|
cannam@233
|
13 files (the "Software"), to deal in the Software without
|
cannam@233
|
14 restriction, including without limitation the rights to use, copy,
|
cannam@233
|
15 modify, merge, publish, distribute, sublicense, and/or sell copies
|
cannam@233
|
16 of the Software, and to permit persons to whom the Software is
|
cannam@233
|
17 furnished to do so, subject to the following conditions:
|
cannam@233
|
18
|
cannam@233
|
19 The above copyright notice and this permission notice shall be
|
cannam@233
|
20 included in all copies or substantial portions of the Software.
|
cannam@233
|
21
|
cannam@233
|
22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
cannam@233
|
23 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
cannam@233
|
24 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
cannam@233
|
25 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
|
cannam@233
|
26 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
|
cannam@233
|
27 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
cannam@233
|
28 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
cannam@233
|
29
|
cannam@233
|
30 Except as contained in this notice, the names of the Centre for
|
cannam@233
|
31 Digital Music; Queen Mary, University of London; and Chris Cannam
|
cannam@233
|
32 shall not be used in advertising or otherwise to promote the sale,
|
cannam@233
|
33 use or other dealings in this Software without prior written
|
cannam@233
|
34 authorization.
|
cannam@233
|
35 */
|
cannam@233
|
36
|
cannam@233
|
37 #ifndef _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_
|
cannam@233
|
38 #define _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_
|
cannam@233
|
39
|
cannam@243
|
40 #include "hostguard.h"
|
cannam@233
|
41 #include "PluginWrapper.h"
|
cannam@233
|
42
|
cannam@233
|
43 namespace Vamp {
|
cannam@233
|
44
|
cannam@233
|
45 namespace HostExt {
|
cannam@233
|
46
|
cannam@233
|
47 /**
|
cannam@233
|
48 * \class PluginInputDomainAdapter PluginInputDomainAdapter.h <vamp-hostsdk/PluginInputDomainAdapter.h>
|
cannam@233
|
49 *
|
cannam@233
|
50 * PluginInputDomainAdapter is a Vamp plugin adapter that converts
|
cannam@233
|
51 * time-domain input into frequency-domain input for plugins that need
|
cannam@233
|
52 * it. This permits a host to use time- and frequency-domain plugins
|
cannam@233
|
53 * interchangeably without needing to handle the conversion itself.
|
cannam@233
|
54 *
|
cannam@233
|
55 * This adapter uses a basic Hanning windowed FFT that supports
|
cannam@233
|
56 * power-of-two block sizes only. If a frequency domain plugin
|
cannam@233
|
57 * requests a non-power-of-two blocksize, the adapter will adjust it
|
cannam@233
|
58 * to a nearby power of two instead. Thus, getPreferredBlockSize()
|
cannam@233
|
59 * will always return a power of two if the wrapped plugin is a
|
cannam@233
|
60 * frequency domain one. If the plugin doesn't accept the adjusted
|
cannam@233
|
61 * power of two block size, initialise() will fail.
|
cannam@233
|
62 *
|
cannam@233
|
63 * The adapter provides no way for the host to discover whether the
|
cannam@233
|
64 * underlying plugin is actually a time or frequency domain plugin
|
cannam@233
|
65 * (except that if the preferred block size is not a power of two, it
|
cannam@233
|
66 * must be a time domain plugin).
|
cannam@233
|
67 *
|
cannam@233
|
68 * The FFT implementation is simple and self-contained, but unlikely
|
cannam@233
|
69 * to be the fastest available: a host can usually do better if it
|
cannam@233
|
70 * cares enough.
|
cannam@233
|
71 *
|
cannam@233
|
72 * In every respect other than its input domain handling, the
|
cannam@233
|
73 * PluginInputDomainAdapter behaves identically to the plugin that it
|
cannam@233
|
74 * wraps. The wrapped plugin will be deleted when the wrapper is
|
cannam@233
|
75 * deleted.
|
cannam@233
|
76 *
|
cannam@233
|
77 * \note This class was introduced in version 1.1 of the Vamp plugin SDK.
|
cannam@233
|
78 */
|
cannam@233
|
79
|
cannam@233
|
80 class PluginInputDomainAdapter : public PluginWrapper
|
cannam@233
|
81 {
|
cannam@233
|
82 public:
|
cannam@233
|
83 PluginInputDomainAdapter(Plugin *plugin); // I take ownership of plugin
|
cannam@233
|
84 virtual ~PluginInputDomainAdapter();
|
cannam@233
|
85
|
cannam@233
|
86 bool initialise(size_t channels, size_t stepSize, size_t blockSize);
|
cannam@233
|
87
|
cannam@233
|
88 InputDomain getInputDomain() const;
|
cannam@233
|
89
|
cannam@233
|
90 size_t getPreferredStepSize() const;
|
cannam@233
|
91 size_t getPreferredBlockSize() const;
|
cannam@233
|
92
|
cannam@233
|
93 FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
|
cannam@233
|
94
|
cannam@233
|
95 /**
|
cannam@233
|
96 * Return the amount by which the timestamps supplied to process()
|
cannam@233
|
97 * are being incremented when they are passed to the plugin's own
|
cannam@233
|
98 * process() implementation.
|
cannam@233
|
99 *
|
cannam@233
|
100 * The Vamp API mandates that the timestamp passed to the plugin
|
cannam@233
|
101 * for time-domain input should be the time of the first sample in
|
cannam@233
|
102 * the block, but the timestamp passed for frequency-domain input
|
cannam@233
|
103 * should be the timestamp of the centre of the block.
|
cannam@233
|
104 *
|
cannam@233
|
105 * The PluginInputDomainAdapter adjusts its timestamps properly so
|
cannam@233
|
106 * that the plugin receives correct times, but in some
|
cannam@233
|
107 * circumstances (such as for establishing the correct timing of
|
cannam@233
|
108 * implicitly-timed features, i.e. features without their own
|
cannam@233
|
109 * timestamps) the host may need to be aware that this adjustment
|
cannam@233
|
110 * is taking place.
|
cannam@233
|
111 *
|
cannam@233
|
112 * If the plugin requires time-domain input, this function will
|
cannam@233
|
113 * return zero. The result of calling this function before
|
cannam@233
|
114 * initialise() has been called is undefined.
|
cannam@233
|
115 */
|
cannam@233
|
116 RealTime getTimestampAdjustment() const;
|
cannam@233
|
117
|
cannam@233
|
118 protected:
|
cannam@233
|
119 class Impl;
|
cannam@233
|
120 Impl *m_impl;
|
cannam@233
|
121 };
|
cannam@233
|
122
|
cannam@233
|
123 }
|
cannam@233
|
124
|
cannam@233
|
125 }
|
cannam@233
|
126
|
cannam@233
|
127 #endif
|