summaryrefslogtreecommitdiffstats
path: root/src/effects/effect.cpp
blob: 87b66516e44315bacd597551f0583929893fc157 (plain)
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
#include <QtDebug>

#include "effects/effect.h"
#include "effects/effectprocessor.h"
#include "effects/effectsmanager.h"
#include "effects/effectxmlelements.h"
#include "engine/effects/engineeffectchain.h"
#include "engine/effects/engineeffect.h"
#include "util/xml.h"

Effect::Effect(EffectsManager* pEffectsManager,
               EffectManifestPointer pManifest,
               EffectInstantiatorPointer pInstantiator)
        : QObject(), // no parent
          m_pEffectsManager(pEffectsManager),
          m_pManifest(pManifest),
          m_pInstantiator(pInstantiator),
          m_pEngineEffect(NULL),
          m_bAddedToEngine(false),
          m_bEnabled(false) {
    for (const auto& pManifestParameter: m_pManifest->parameters()) {
        EffectParameter* pParameter = new EffectParameter(
                this, pEffectsManager, m_parameters.size(), pManifestParameter);
        m_parameters.append(pParameter);
        if (m_parametersById.contains(pParameter->id())) {
            qWarning() << debugString() << "WARNING: Loaded EffectManifest that had parameters with duplicate IDs. Dropping one of them.";
        }
        m_parametersById[pParameter->id()] = pParameter;
    }
    //qDebug() << debugString() << "created" << this;
}

Effect::~Effect() {
    //qDebug() << debugString() << "destroyed" << this;
    m_parametersById.clear();
    for (int i = 0; i < m_parameters.size(); ++i) {
        EffectParameter* pParameter = m_parameters.at(i);
        m_parameters[i] = NULL;
        delete pParameter;
    }
}

EffectState* Effect::createState(const mixxx::EngineParameters& bufferParameters) {
    return m_pEngineEffect->createState(bufferParameters);
}

void Effect::addToEngine(EngineEffectChain* pChain, int iIndex,
                         const QSet<ChannelHandleAndGroup>& activeInputChannels) {
    VERIFY_OR_DEBUG_ASSERT(pChain) {
        return;
    }
    VERIFY_OR_DEBUG_ASSERT(m_pEngineEffect == nullptr) {
        return;
    }
    VERIFY_OR_DEBUG_ASSERT(!m_bAddedToEngine) {
        return;
    }

    m_pEngineEffect = new EngineEffect(m_pManifest,
            activeInputChannels,
            m_pEffectsManager,
            m_pInstantiator);

    EffectsRequest* request = new EffectsRequest();
    request->type = EffectsRequest::ADD_EFFECT_TO_CHAIN;
    request->pTargetChain = pChain;
    request->AddEffectToChain.pEffect = m_pEngineEffect;
    request->AddEffectToChain.iIndex = iIndex;
    m_pEffectsManager->writeRequest(request);

    m_bAddedToEngine = true;
}

void Effect::removeFromEngine(EngineEffectChain* pChain, int iIndex) {
    VERIFY_OR_DEBUG_ASSERT(pChain) {
        return;
    }
    VERIFY_OR_DEBUG_ASSERT(m_pEngineEffect != nullptr) {
        return;
    }
    VERIFY_OR_DEBUG_ASSERT(m_bAddedToEngine) {
        return;
    }

    EffectsRequest* request = new EffectsRequest();
    request->type = EffectsRequest::REMOVE_EFFECT_FROM_CHAIN;
    request->pTargetChain = pChain;
    request->RemoveEffectFromChain.pEffect = m_pEngineEffect;
    request->RemoveEffectFromChain.iIndex = iIndex;
    m_pEffectsManager->writeRequest(request);
    m_pEngineEffect = NULL;

    m_bAddedToEngine = false;
}

void Effect::updateEngineState() {
    if (!m_pEngineEffect) {
        return;
    }
    sendParameterUpdate();
    foreach (EffectParameter* pParameter, m_parameters) {
        pParameter->updateEngineState();
    }
}

EngineEffect* Effect::getEngineEffect() {
    return m_pEngineEffect;
}

EffectManifestPointer Effect::getManifest() const {
    return m_pManifest;
}

void Effect::setEnabled(bool enabled) {
    if (enabled != m_bEnabled) {
        m_bEnabled = enabled;
        updateEngineState();
        emit(enabledChanged(m_bEnabled));
    }
}

bool Effect::enabled() const {
    return m_bEnabled;
}

void Effect::sendParameterUpdate() {
    if (!m_pEngineEffect) {
        return;
    }
    EffectsRequest* pRequest = new EffectsRequest();
    pRequest->type = EffectsRequest::SET_EFFECT_PARAMETERS;
    pRequest->pTargetEffect = m_pEngineEffect;
    pRequest->SetEffectParameters.enabled = m_bEnabled;
    m_pEffectsManager->writeRequest(pRequest);
}

unsigned int Effect::numKnobParameters() const {
    unsigned int num = 0;
    foreach(const EffectParameter* parameter, m_parameters) {
        if (parameter->manifest()->controlHint() !=
                EffectManifestParameter::ControlHint::TOGGLE_STEPPING) {
            ++num;
        }
    }
    return num;
}

unsigned int Effect::numButtonParameters() const {
    unsigned int num = 0;
    foreach(const EffectParameter* parameter, m_parameters) {
        if (parameter->manifest()->controlHint() ==
                EffectManifestParameter::ControlHint::TOGGLE_STEPPING) {
            ++num;
        }
    }
    return num;
}

EffectParameter* Effect::getParameterById(const QString& id) const {
    EffectParameter* pParameter = m_parametersById.value(id, NULL);
    if (pParameter == NULL) {
        qWarning() << debugString() << "getParameterById"
                   << "WARNING: parameter for id does not exist:" << id;
    }
    return pParameter;
}

// static
bool Effect::isButtonParameter(EffectParameter* parameter) {
    return  parameter->manifest()->controlHint() ==
            EffectManifestParameter::ControlHint::TOGGLE_STEPPING;
}

// static
bool Effect::isKnobParameter(EffectParameter* parameter) {
    return !isButtonParameter(parameter);
}

EffectParameter* Effect::getFilteredParameterForSlot(ParameterFilterFnc filterFnc,
                                                     unsigned int slotNumber) {
    // It's normal to ask for a parameter that doesn't exist. Callers must check
    // for NULL.
    unsigned int num = 0;
    for (const auto& parameter: m_parameters) {
        if (parameter->manifest()->showInParameterSlot() && filterFnc(parameter)) {
            if(num == slotNumber) {
                return parameter;
            }
            ++num;
        }
    }
    return NULL;
}

EffectParameter* Effect::getKnobParameterForSlot(unsigned int slotNumber) {
    return getFilteredParameterForSlot(isKnobParameter, slotNumber);
}

EffectParameter* Effect::getButtonParameterForSlot(unsigned int slotNumber) {
    return getFilteredParameterForSlot(isButtonParameter, slotNumber);
}

// static
EffectPointer Effect::createFromXml(EffectsManager* pEffectsManager,
                              const QDomElement& element) {
    // Empty <Effect/> elements are used to preserve chain order
    // when there are empty slots at the beginning of the chain.
    if (!element.hasChildNodes()) {
        return EffectPointer();
    }
    QString effectId = XmlParse::selectNodeQString(element, EffectXml::EffectId);
    EffectPointer pEffect = pEffectsManager->instantiateEffect(effectId);
    return pEffect;
}

double Effect::getMetaknobDefault() {
    return m_pManifest->metaknobDefault();
}