1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
/*
Sonic Visualiser
An audio file viewer and annotation editor.
Centre for Digital Music, Queen Mary, University of London.
This file copyright 2006-2007 Chris Cannam and QMUL.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version. See the file
COPYING included with this distribution for more information.
*/
#ifndef SV_TRANSFORM_H
#define SV_TRANSFORM_H
#include "base/XmlExportable.h"
#include "base/Window.h"
#include "base/RealTime.h"
#include <vamp-hostsdk/PluginBase.h>
#include <QString>
#include <QMap>
#include <map>
#include <vector>
namespace sv {
typedef QString TransformId;
class Transform : public XmlExportable
{
public:
/**
* Construct a new Transform with default data and no identifier.
* The Transform object will be meaningless until some data and an
* identifier have been set on it.
*
* To construct a Transform for use with a particular transform
* identifier, use TransformFactory::getDefaultTransformFor.
*/
Transform();
/**
* Construct a Transform by parsing the given XML data string.
* This is the inverse of toXmlString. If this fails,
* getErrorString() will return a non-empty string.
*/
Transform(QString xml);
virtual ~Transform();
/**
* Compare two Transforms. They only compare equal if every data
* element matches.
*/
bool operator==(const Transform &) const;
/**
* Order two Transforms, so that they can be used as keys in
* containers.
*/
bool operator<(const Transform &) const;
void setIdentifier(TransformId id);
TransformId getIdentifier() const;
enum Type { FeatureExtraction, RealTimeEffect, UnknownType };
Type getType() const;
QString getPluginIdentifier() const;
QString getOutput() const;
void setPluginIdentifier(QString pluginIdentifier);
void setOutput(QString output);
// Turn a plugin ID and output name into a transform ID. Note
// that our pluginIdentifier is the same thing as the Vamp SDK's
// PluginLoader::PluginKey.
static TransformId getIdentifierForPluginOutput(QString pluginIdentifier,
QString output = "");
typedef std::map<QString, float> ParameterMap;
const ParameterMap &getParameters() const;
void setParameters(const ParameterMap &pm);
void setParameter(QString name, float value);
typedef std::map<QString, QString> ConfigurationMap;
const ConfigurationMap &getConfiguration() const;
void setConfiguration(const ConfigurationMap &cm);
void setConfigurationValue(QString name, QString value);
enum SummaryType {
// This is the same as Vamp::PluginSummarisingAdapter::SummaryType
// except with NoSummary instead of UnknownSummaryType
Minimum = 0,
Maximum = 1,
Mean = 2,
Median = 3,
Mode = 4,
Sum = 5,
Variance = 6,
StandardDeviation = 7,
Count = 8,
NoSummary = 999
};
SummaryType getSummaryType() const;
void setSummaryType(SummaryType type);
QString getPluginVersion() const;
void setPluginVersion(QString version);
QString getProgram() const;
void setProgram(QString program);
int getStepSize() const;
void setStepSize(int s);
int getBlockSize() const;
void setBlockSize(int s);
WindowType getWindowType() const;
void setWindowType(WindowType type);
RealTime getStartTime() const;
void setStartTime(RealTime t);
RealTime getDuration() const; // 0 -> all
void setDuration(RealTime d);
sv_samplerate_t getSampleRate() const; // 0 -> as input
void setSampleRate(sv_samplerate_t rate);
void toXml(QTextStream &stream, QString indent = "",
QString extraAttributes = "") const override;
typedef QMap<QString, QString> Attributes;
/**
* Set the main transform data from the given attributes -
* historically, attributes read from an XML document. This does
* not set the parameters or configuration, which are exported to
* separate XML elements rather than attributes of the transform
* element.
*
* Note that this only sets those attributes which are actually
* present in the argument. Any attributes not defined in the
* attribute will remain unchanged in the Transform. If your aim
* is to create a transform exactly matching the given attributes,
* ensure you start from an empty transform rather than one that
* has already been configured.
*/
void setFromAttributes(const Attributes &);
QString getErrorString() const { return m_errorString; }
static SummaryType stringToSummaryType(QString);
static QString summaryTypeToString(SummaryType);
protected:
TransformId m_id; // pluginid:output, that is type:soname:label:output
static QString createIdentifier
(QString type, QString soName, QString label, QString output);
static void parseIdentifier
(QString identifier,
QString &type, QString &soName, QString &label, QString &output);
template <typename A, typename B>
bool mapLessThan(const std::map<A, B> &a, const std::map<A, B> &b) const {
// Return true if a is "less than" b. Ordering doesn't have
// to be meaningful, just consistent.
typename std::map<A, B>::const_iterator i;
typename std::map<A, B>::const_iterator j;
for (i = a.begin(), j = b.begin(); i != a.end(); ++i) {
if (j == b.end()) return false; // a is longer than b
if (i->first != j->first) return i->first < j->first;
if (i->second != j->second) return i->second < j->second;
}
if (j != b.end()) return true; // a is shorter than b
return false; // equal
}
ParameterMap m_parameters;
ConfigurationMap m_configuration;
SummaryType m_summaryType;
QString m_pluginVersion;
QString m_program;
int m_stepSize;
int m_blockSize;
WindowType m_windowType;
RealTime m_startTime;
RealTime m_duration;
sv_samplerate_t m_sampleRate;
QString m_errorString;
};
typedef std::vector<Transform> Transforms;
} // end namespace sv
#endif
|
