forked from mixxxdj/mixxx
-
Notifications
You must be signed in to change notification settings - Fork 2
/
effectslot.cpp
393 lines (336 loc) · 13.7 KB
/
effectslot.cpp
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
#include "effects/effectslot.h"
#include <QDebug>
#include "control/controlencoder.h"
#include "control/controlproxy.h"
#include "control/controlpushbutton.h"
#include "effects/effectxmlelements.h"
#include "moc_effectslot.cpp"
#include "util/math.h"
#include "util/xml.h"
// The maximum number of effect parameters we're going to support.
const unsigned int kDefaultMaxParameters = 16;
EffectSlot::EffectSlot(const QString& group,
const unsigned int iChainNumber,
const unsigned int iEffectnumber)
: m_iChainNumber(iChainNumber),
m_iEffectNumber(iEffectnumber),
m_group(group) {
m_pControlLoaded = new ControlObject(ConfigKey(m_group, "loaded"));
m_pControlLoaded->setReadOnly();
m_pControlNumParameters = new ControlObject(ConfigKey(m_group, "num_parameters"));
m_pControlNumParameters->setReadOnly();
m_pControlNumParameterSlots = new ControlObject(ConfigKey(m_group, "num_parameterslots"));
m_pControlNumParameterSlots->setReadOnly();
m_pControlNumButtonParameters = new ControlObject(ConfigKey(m_group, "num_button_parameters"));
m_pControlNumButtonParameters->setReadOnly();
m_pControlNumButtonParameterSlots = new ControlObject(ConfigKey(m_group, "num_button_parameterslots"));
m_pControlNumButtonParameterSlots->setReadOnly();
// Default to disabled to prevent accidental activation of effects
// at the beginning of a set.
m_pControlEnabled = new ControlPushButton(ConfigKey(m_group, "enabled"));
m_pControlEnabled->setButtonMode(ControlPushButton::POWERWINDOW);
connect(m_pControlEnabled, &ControlPushButton::valueChanged, this, &EffectSlot::slotEnabled);
m_pControlNextEffect = new ControlPushButton(ConfigKey(m_group, "next_effect"));
connect(m_pControlNextEffect,
&ControlPushButton::valueChanged,
this,
&EffectSlot::slotNextEffect);
m_pControlPrevEffect = new ControlPushButton(ConfigKey(m_group, "prev_effect"));
connect(m_pControlPrevEffect,
&ControlPushButton::valueChanged,
this,
&EffectSlot::slotPrevEffect);
// Ignoring no-ops is important since this is for +/- tickers.
m_pControlEffectSelector = new ControlEncoder(ConfigKey(m_group, "effect_selector"), false);
connect(m_pControlEffectSelector,
&ControlEncoder::valueChanged,
this,
&EffectSlot::slotEffectSelector);
m_pControlClear = new ControlPushButton(ConfigKey(m_group, "clear"));
connect(m_pControlClear, &ControlPushButton::valueChanged, this, &EffectSlot::slotClear);
for (unsigned int i = 0; i < kDefaultMaxParameters; ++i) {
addEffectParameterSlot();
addEffectButtonParameterSlot();
}
m_pControlMetaParameter = new ControlPotmeter(ConfigKey(m_group, "meta"), 0.0, 1.0);
connect(m_pControlMetaParameter, &ControlPotmeter::valueChanged, this, [this](double value) {
slotEffectMetaParameter(value, false);
});
m_pControlMetaParameter->set(0.0);
m_pControlMetaParameter->setDefaultValue(0.0);
m_pSoftTakeover = new SoftTakeover();
clear();
}
EffectSlot::~EffectSlot() {
//qDebug() << debugString() << "destroyed";
clear();
delete m_pControlLoaded;
delete m_pControlNumParameters;
delete m_pControlNumParameterSlots;
delete m_pControlNumButtonParameters;
delete m_pControlNumButtonParameterSlots;
delete m_pControlNextEffect;
delete m_pControlPrevEffect;
delete m_pControlEffectSelector;
delete m_pControlClear;
delete m_pControlEnabled;
delete m_pControlMetaParameter;
delete m_pSoftTakeover;
}
EffectParameterSlotPointer EffectSlot::addEffectParameterSlot() {
EffectParameterSlotPointer pParameter = EffectParameterSlotPointer(
new EffectParameterSlot(m_group, m_parameters.size()));
m_parameters.append(pParameter);
m_pControlNumParameterSlots->forceSet(
m_pControlNumParameterSlots->get() + 1);
return pParameter;
}
EffectButtonParameterSlotPointer EffectSlot::addEffectButtonParameterSlot() {
EffectButtonParameterSlotPointer pParameter = EffectButtonParameterSlotPointer(
new EffectButtonParameterSlot(m_group, m_buttonParameters.size()));
m_buttonParameters.append(pParameter);
m_pControlNumButtonParameterSlots->forceSet(
m_pControlNumButtonParameterSlots->get() + 1);
return pParameter;
}
EffectPointer EffectSlot::getEffect() const {
return m_pEffect;
}
unsigned int EffectSlot::numParameterSlots() const {
return m_parameters.size();
}
unsigned int EffectSlot::numButtonParameterSlots() const {
return m_buttonParameters.size();
}
void EffectSlot::slotEnabled(double v) {
//qDebug() << debugString() << "slotEnabled" << v;
if (m_pEffect) {
m_pEffect->setEnabled(v > 0);
}
}
void EffectSlot::slotEffectEnabledChanged(bool enabled) {
m_pControlEnabled->set(enabled);
}
EffectParameterSlotPointer EffectSlot::getEffectParameterSlot(unsigned int slotNumber) {
//qDebug() << debugString() << "getEffectParameterSlot" << slotNumber;
if (slotNumber >= static_cast<unsigned int>(m_parameters.size())) {
qWarning() << "WARNING: slotNumber out of range";
return EffectParameterSlotPointer();
}
return m_parameters[slotNumber];
}
EffectButtonParameterSlotPointer EffectSlot::getEffectButtonParameterSlot(unsigned int slotNumber) {
//qDebug() << debugString() << "getEffectParameterSlot" << slotNumber;
if (slotNumber >= static_cast<unsigned int>(m_buttonParameters.size())) {
qWarning() << "WARNING: slotNumber out of range";
return EffectButtonParameterSlotPointer();
}
return m_buttonParameters[slotNumber];
}
void EffectSlot::loadEffect(EffectPointer pEffect, bool adoptMetaknobPosition) {
//qDebug() << debugString() << "loadEffect"
// << (pEffect ? pEffect->getManifest().name() : "(null)");
if (pEffect) {
m_pEffect = pEffect;
m_pControlLoaded->forceSet(1.0);
m_pControlNumParameters->forceSet(pEffect->numKnobParameters());
m_pControlNumButtonParameters->forceSet(pEffect->numButtonParameters());
// The enabled status persists in the EffectSlot when loading a new
// EffectPointer to the EffectSlot. Effects and EngineEffects default to
// disabled, so if this EffectSlot was enabled, enable the Effect and EngineEffect.
pEffect->setEnabled(m_pControlEnabled->toBool());
connect(pEffect.data(),
&Effect::enabledChanged,
this,
&EffectSlot::slotEffectEnabledChanged);
while (static_cast<unsigned int>(m_parameters.size())
< pEffect->numKnobParameters()) {
addEffectParameterSlot();
}
while (static_cast<unsigned int>(m_buttonParameters.size())
< pEffect->numButtonParameters()) {
addEffectButtonParameterSlot();
}
for (const auto& pParameter : qAsConst(m_parameters)) {
pParameter->loadEffect(pEffect);
}
for (const auto& pParameter : qAsConst(m_buttonParameters)) {
pParameter->loadEffect(pEffect);
}
if (adoptMetaknobPosition) {
slotEffectMetaParameter(m_pControlMetaParameter->get(), true);
} else {
m_pControlMetaParameter->set(pEffect->getMetaknobDefault());
slotEffectMetaParameter(pEffect->getMetaknobDefault(), true);
}
emit effectLoaded(pEffect, m_iEffectNumber);
} else {
clear();
// Broadcasts a null effect pointer
emit effectLoaded(EffectPointer(), m_iEffectNumber);
}
emit updated();
}
void EffectSlot::clear() {
if (m_pEffect) {
m_pEffect->disconnect(this);
}
m_pControlLoaded->forceSet(0.0);
m_pControlNumParameters->forceSet(0.0);
m_pControlNumButtonParameters->forceSet(0.0);
for (const auto& pParameter : qAsConst(m_parameters)) {
pParameter->clear();
}
for (const auto& pParameter : qAsConst(m_buttonParameters)) {
pParameter->clear();
}
m_pEffect.clear();
emit updated();
}
void EffectSlot::slotPrevEffect(double v) {
if (v > 0) {
slotEffectSelector(-1);
}
}
void EffectSlot::slotNextEffect(double v) {
if (v > 0) {
slotEffectSelector(1);
}
}
void EffectSlot::slotEffectSelector(double v) {
if (v > 0) {
emit nextEffect(m_iChainNumber, m_iEffectNumber, m_pEffect);
} else if (v < 0) {
emit prevEffect(m_iChainNumber, m_iEffectNumber, m_pEffect);
}
}
void EffectSlot::slotClear(double v) {
if (v > 0) {
emit clearEffect(m_iEffectNumber);
}
}
void EffectSlot::syncSofttakeover() {
for (const auto& pParameterSlot : qAsConst(m_parameters)) {
pParameterSlot->syncSofttakeover();
}
}
double EffectSlot::getMetaParameter() const {
return m_pControlMetaParameter->get();
}
// This function is for the superknob to update individual effects' meta knobs
// slotEffectMetaParameter does not need to update m_pControlMetaParameter's value
void EffectSlot::setMetaParameter(double v, bool force) {
if (!m_pSoftTakeover->ignore(m_pControlMetaParameter, v)
|| !m_pControlEnabled->toBool()
|| force) {
m_pControlMetaParameter->set(v);
slotEffectMetaParameter(v, force);
}
}
void EffectSlot::slotEffectMetaParameter(double v, bool force) {
// Clamp to [0.0, 1.0]
if (v < 0.0 || v > 1.0) {
qWarning() << debugString() << "value out of limits";
v = math_clamp(v, 0.0, 1.0);
m_pControlMetaParameter->set(v);
}
if (!m_pControlEnabled->toBool()) {
force = true;
}
for (const auto& pParameterSlot : qAsConst(m_parameters)) {
pParameterSlot->onEffectMetaParameterChanged(v, force);
}
}
QDomElement EffectSlot::toXml(QDomDocument* doc) const {
QDomElement effectElement = doc->createElement(EffectXml::Effect);
if (!m_pEffect) {
return effectElement;
}
QDomElement metaKnobElement = doc->createElement(EffectXml::EffectMetaParameter);
XmlParse::addElement(*doc, effectElement,
EffectXml::EffectMetaParameter,
QString::number(m_pControlMetaParameter->get()));
EffectManifestPointer pManifest = m_pEffect->getManifest();
XmlParse::addElement(*doc, effectElement,
EffectXml::EffectId, pManifest->id());
XmlParse::addElement(*doc, effectElement,
EffectXml::EffectVersion, pManifest->version());
QDomElement parametersElement = doc->createElement(EffectXml::ParametersRoot);
for (const auto& pParameter : m_parameters) {
QDomElement parameterElement = pParameter->toXml(doc);
if (!parameterElement.hasChildNodes()) {
continue;
}
EffectManifestParameterPointer manifest = pParameter->getManifest();
if (!manifest) {
continue;
}
XmlParse::addElement(*doc, parameterElement,
EffectXml::ParameterId,
manifest->id());
parametersElement.appendChild(parameterElement);
}
for (const auto& pParameter : m_buttonParameters) {
QDomElement parameterElement = pParameter->toXml(doc);
if (!parameterElement.hasChildNodes()) {
continue;
}
EffectManifestParameterPointer manifest = pParameter->getManifest();
if (!manifest) {
continue;
}
XmlParse::addElement(*doc, parameterElement,
EffectXml::ParameterId,
pParameter->getManifest()->id());
parametersElement.appendChild(parameterElement);
}
effectElement.appendChild(parametersElement);
return effectElement;
}
void EffectSlot::loadEffectSlotFromXml(const QDomElement& effectElement) {
if (!m_pEffect) {
return;
}
if (!effectElement.hasChildNodes()) {
return;
}
QDomElement effectIdElement = XmlParse::selectElement(effectElement,
EffectXml::EffectId);
if (m_pEffect->getManifest()->id() != effectIdElement.text()) {
qWarning() << "EffectSlot::loadEffectSlotFromXml"
<< "effect ID in XML does not match presently loaded effect, ignoring.";
return;
}
m_pControlMetaParameter->set(XmlParse::selectNodeDouble(
effectElement, EffectXml::EffectMetaParameter));
QDomElement parametersElement = XmlParse::selectElement(
effectElement, EffectXml::ParametersRoot);
if (!parametersElement.hasChildNodes()) {
return;
}
QMap<QString, EffectParameterSlotBasePointer> parametersById;
for (const auto& pParameter : qAsConst(m_parameters)) {
EffectManifestParameterPointer manifest = pParameter->getManifest();
if (manifest) {
parametersById.insert(manifest->id(), pParameter);
}
}
for (const auto& pParameter : qAsConst(m_buttonParameters)) {
EffectManifestParameterPointer manifest = pParameter->getManifest();
if (manifest) {
parametersById.insert(manifest->id(), pParameter);
}
}
QDomNodeList parametersNodeList = parametersElement.childNodes();
for (int i = 0; i < parametersNodeList.size(); ++i) {
QDomNode parameterNode = parametersNodeList.at(i);
if (parameterNode.isElement()) {
const QString id = XmlParse::selectNodeQString(parameterNode,
EffectXml::ParameterId);
EffectParameterSlotBasePointer pParameterSlot = parametersById.value(id);
if (pParameterSlot != nullptr) {
pParameterSlot->loadParameterSlotFromXml(parameterNode.toElement());
}
}
}
}