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
|
#include "effects/builtin/echoeffect.h"
#include <QtDebug>
#include "util/sample.h"
#include "util/math.h"
#include "util/rampingvalue.h"
constexpr int EchoGroupState::kMaxDelaySeconds;
namespace {
void incrementRing(int* pIndex, int increment, int length) {
*pIndex = (*pIndex + increment) % length;
}
void decrementRing(int* pIndex, int decrement, int length) {
*pIndex = (*pIndex + length - decrement) % length;
}
} // anonymous namespace
// static
QString EchoEffect::getId() {
return "org.mixxx.effects.echo";
}
// static
EffectManifestPointer EchoEffect::getManifest() {
EffectManifestPointer pManifest(new EffectManifest());
pManifest->setAddDryToWet(true);
pManifest->setEffectRampsFromDry(true);
pManifest->setId(getId());
pManifest->setName(QObject::tr("Echo"));
pManifest->setShortName(QObject::tr("Echo"));
pManifest->setAuthor("The Mixxx Team");
pManifest->setVersion("1.0");
pManifest->setDescription(QObject::tr(
"Stores the input signal in a temporary buffer and outputs it after a short time"));
pManifest->setMetaknobDefault(db2ratio(-3.0));
EffectManifestParameterPointer delay = pManifest->addParameter();
delay->setId("delay_time");
delay->setName(QObject::tr("Time"));
delay->setShortName(QObject::tr("Time"));
delay->setDescription(QObject::tr(
"Delay time\n"
"1/8 - 2 beats if tempo is detected\n"
"1/8 - 2 seconds if no tempo is detected"));
delay->setControlHint(EffectManifestParameter::ControlHint::KNOB_LINEAR);
delay->setSemanticHint(EffectManifestParameter::SemanticHint::UNKNOWN);
delay->setUnitsHint(EffectManifestParameter::UnitsHint::BEATS);
delay->setMinimum(0.0);
delay->setDefault(0.5);
delay->setMaximum(2.0);
EffectManifestParameterPointer feedback = pManifest->addParameter();
feedback->setId("feedback_amount");
feedback->setName(QObject::tr("Feedback"));
feedback->setShortName(QObject::tr("Feedback"));
feedback->setDescription(QObject::tr(
"Amount the echo fades each time it loops"));
feedback->setControlHint(EffectManifestParameter::ControlHint::KNOB_LINEAR);
feedback->setSemanticHint(EffectManifestParameter::SemanticHint::UNKNOWN);
feedback->setUnitsHint(EffectManifestParameter::UnitsHint::UNKNOWN);
feedback->setMinimum(0.00);
feedback->setDefault(db2ratio(-3.0));
feedback->setMaximum(1.00);
EffectManifestParameterPointer pingpong = pManifest->addParameter();
pingpong->setId("pingpong_amount");
pingpong->setName(QObject::tr("Ping Pong"));
pingpong->setShortName(QObject::tr("Ping Pong"));
pingpong->setDescription(QObject::tr(
"How much the echoed sound bounces between the left and right sides of the stereo field"));
pingpong->setControlHint(EffectManifestParameter::ControlHint::KNOB_LINEAR);
pingpong->setSemanticHint(EffectManifestParameter::SemanticHint::UNKNOWN);
pingpong->setUnitsHint(EffectManifestParameter::UnitsHint::UNKNOWN);
pingpong->setMinimum(0.0);
pingpong->setDefault(0.0);
pingpong->setMaximum(1.0);
EffectManifestParameterPointer send = pManifest->addParameter();
send->setId("send_amount");
send->setName(QObject::tr("Send"));
send->setShortName(QObject::tr("Send"));
send->setDescription(QObject::tr(
"How much of the signal to send into the delay buffer"));
send->setControlHint(EffectManifestParameter::ControlHint::KNOB_LINEAR);
send->setSemanticHint(EffectManifestParameter::SemanticHint::UNKNOWN);
send->setUnitsHint(EffectManifestParameter::UnitsHint::UNKNOWN);
send->setDefaultLinkType(EffectManifestParameter::LinkType::LINKED);
send->setMinimum(0.0);
send->setDefault(db2ratio(-3.0));
send->setMaximum(1.0);
EffectManifestParameterPointer quantize = pManifest->addParameter();
quantize->setId("quantize");
quantize->setName(QObject::tr("Quantize"));
quantize->setShortName(QObject::tr("Quantize"));
quantize->setDescription(QObject::tr(
"Round the Time parameter to the nearest 1/4 beat."));
quantize->setControlHint(EffectManifestParameter::ControlHint::TOGGLE_STEPPING);
quantize->setSemanticHint(EffectManifestParameter::SemanticHint::UNKNOWN);
quantize->setUnitsHint(EffectManifestParameter::UnitsHint::UNKNOWN);
quantize->setDefault(1);
quantize->setMinimum(0);
quantize->setMaximum(1);
EffectManifestParameterPointer triplet = pManifest->addParameter();
triplet->setId("triplet");
triplet->setName(QObject::tr("Triplets"));
triplet->setShortName(QObject::tr("Triplets"));
triplet->setDescription(QObject::tr(
"When the Quantize parameter is enabled, divide rounded 1/4 beats of Time parameter by 3."));
triplet->setControlHint(EffectManifestParameter::ControlHint::TOGGLE_STEPPING);
triplet->setSemanticHint(EffectManifestParameter::SemanticHint::UNKNOWN);
triplet->setUnitsHint(EffectManifestParameter::UnitsHint::UNKNOWN);
triplet->setDefault(0);
triplet->setMinimum(0);
triplet->setMaximum(1);
return pManifest;
}
EchoEffect::EchoEffect(EngineEffect* pEffect)
: m_pDelayParameter(pEffect->getParameterById("delay_time")),
m_pSendParameter(pEffect->getParameterById("send_amount")),
m_pFeedbackParameter(pEffect->getParameterById("feedback_amount")),
m_pPingPongParameter(pEffect->getParameterById("pingpong_amount")),
m_pQuantizeParameter(pEffect->getParameterById("quantize")),
m_pTripletParameter(pEffect->getParameterById("triplet")) {
}
void EchoEffect::processChannel(const ChannelHandle& handle, EchoGroupState* pGroupState,
const CSAMPLE* pInput,
CSAMPLE* pOutput,
const mixxx::EngineParameters& bufferParameters,
const EffectEnableState enableState,
const GroupFeatureState& groupFeatures) {
Q_UNUSED(handle);
EchoGroupState& gs = *pGroupState;
// The minimum of the parameter is zero so the exact center of the knob is 1 beat.
double period = m_pDelayParameter->value();
const auto send_current = static_cast<CSAMPLE_GAIN>(m_pSendParameter->value());
const auto feedback_current = static_cast<CSAMPLE_GAIN>(m_pFeedbackParameter->value());
const auto pingpong_frac = static_cast<CSAMPLE_GAIN>(m_pPingPongParameter->value());
int delay_frames;
if (groupFeatures.has_beat_length_sec) {
// period is a number of beats
if (m_pQuantizeParameter->toBool()) {
period = std::max(roundToFraction(period, 4), 1/8.0);
if (m_pTripletParameter->toBool()) {
period /= 3.0;
}
} else if (period < 1/8.0) {
period = 1/8.0;
}
delay_frames = static_cast<int>(period * groupFeatures.beat_length_sec *
bufferParameters.sampleRate());
} else {
// period is a number of seconds
period = std::max(period, 1/8.0);
delay_frames = static_cast<int>(period * bufferParameters.sampleRate());
}
VERIFY_OR_DEBUG_ASSERT(delay_frames > 0) {
delay_frames = 1;
}
int delay_samples = delay_frames * bufferParameters.channelCount();
VERIFY_OR_DEBUG_ASSERT(delay_samples <= gs.delay_buf.size()) {
delay_samples = gs.delay_buf.size();
}
int prev_read_position = gs.write_position;
decrementRing(&prev_read_position, gs.prev_delay_samples, gs.delay_buf.size());
int read_position = gs.write_position;
decrementRing(&read_position, delay_samples, gs.delay_buf.size());
RampingValue<CSAMPLE_GAIN> send(send_current, gs.prev_send,
bufferParameters.framesPerBuffer());
// Feedback the delay buffer and then add the new input.
RampingValue<CSAMPLE_GAIN> feedback(feedback_current, gs.prev_feedback,
bufferParameters.framesPerBuffer());
//TODO: rewrite to remove assumption of stereo buffer
for (unsigned int i = 0;
i < bufferParameters.samplesPerBuffer();
i += bufferParameters.channelCount()) {
CSAMPLE_GAIN send_ramped = send.getNext();
CSAMPLE_GAIN feedback_ramped = feedback.getNext();
CSAMPLE bufferedSampleLeft = gs.delay_buf[read_position];
CSAMPLE bufferedSampleRight = gs.delay_buf[read_position + 1];
if (read_position != prev_read_position) {
const CSAMPLE_GAIN frac = static_cast<CSAMPLE_GAIN>(i) /
bufferParameters.samplesPerBuffer();
bufferedSampleLeft *= frac;
bufferedSampleRight *= frac;
bufferedSampleLeft += gs.delay_buf[prev_read_position] * (1 - frac);
bufferedSampleRight += gs.delay_buf[prev_read_position + 1] * (1 - frac);
incrementRing(&prev_read_position, buff
|
