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
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
|
// Tests for enginebuffer.cpp
#include <gtest/gtest.h>
#include <gmock/gmock.h>
#include <QtDebug>
#include <QTest>
#include "mixer/basetrackplayer.h"
#include "preferences/usersettings.h"
#include "control/controlobject.h"
#include "test/mockedenginebackendtest.h"
#include "test/mixxxtest.h"
#include "test/signalpathtest.h"
// Incase any of the test in this file fail. You can use the audioplot.py tool
// in the scripts folder to visually compare the results of the enginebuffer
// with the golden test data.
class EngineBufferTest : public MockedEngineBackendTest {};
class EngineBufferE2ETest : public SignalPathTest {};
TEST_F(EngineBufferTest, DisableKeylockResetsPitch) {
// To prevent one-slider users from getting stuck on a key, unsetting
// keylock resets the musical pitch.
ControlObject::set(ConfigKey(m_sGroup1, "keylockMode"),
1.0); // kLockCurrentKey;
ControlObject::set(ConfigKey(m_sGroup1, "file_bpm"), 128.0);
ControlObject::set(ConfigKey(m_sGroup1, "keylock"), 1.0);
ControlObject::set(ConfigKey(m_sGroup1, "pitch"), 0.5);
ProcessBuffer();
ControlObject::set(ConfigKey(m_sGroup1, "keylock"), 0.0);
// We require a buffer process to see that the keylock state has changed.
ProcessBuffer();
ASSERT_EQ(0.0, ControlObject::get(ConfigKey(m_sGroup1, "pitch")));
}
TEST_F(EngineBufferTest, TrackLoadResetsPitch) {
// When a new track is loaded, the pitch value should be reset.
config()->set(ConfigKey("[Controls]","SpeedAutoReset"),
ConfigValue(BaseTrackPlayer::RESET_PITCH));
ControlObject::set(ConfigKey(m_sGroup1, "file_bpm"), 128.0);
ControlObject::set(ConfigKey(m_sGroup1, "pitch_adjust"), 0.5);
ProcessBuffer();
ASSERT_NEAR(0.5, ControlObject::get(ConfigKey(m_sGroup1, "pitch_adjust")), 1e-10);
m_pMixerDeck1->loadFakeTrack(false, 0.0);
ASSERT_NEAR(0.0, ControlObject::get(ConfigKey(m_sGroup1, "pitch_adjust")), 1e-10);
}
TEST_F(EngineBufferTest, PitchRoundtrip) {
ControlObject::set(ConfigKey(m_sGroup1, "keylock"), 0.0);
ControlObject::set(ConfigKey(m_sGroup1, "keylockMode"),
0.0); // kLockOriginalKey;
ProcessBuffer();
// we are in kPakmOffsetScaleReseting mode
ControlObject::set(ConfigKey(m_sGroup1, "rate"), 0.5);
ProcessBuffer();
// pitch must not change
ASSERT_DOUBLE_EQ(0.0,
ControlObject::get(ConfigKey(m_sGroup1, "pitch_adjust")));
ControlObject::set(ConfigKey(m_sGroup1, "pitch_adjust"), 0.5);
ProcessBuffer();
// rate must not change
ASSERT_DOUBLE_EQ(0.5, ControlObject::get(ConfigKey(m_sGroup1, "rate")));
ControlObject::set(ConfigKey(m_sGroup1, "keylock"), 1.0);
ProcessBuffer();
// pitch and speed must not change
ASSERT_DOUBLE_EQ(0.5,
ControlObject::get(ConfigKey(m_sGroup1, "pitch_adjust")));
ASSERT_DOUBLE_EQ(0.5, ControlObject::get(ConfigKey(m_sGroup1, "rate")));
ControlObject::set(ConfigKey(m_sGroup1, "keylockMode"),
1.0); // kLockCurrentKey;
ProcessBuffer();
// rate must not change
ASSERT_DOUBLE_EQ(0.5, ControlObject::get(ConfigKey(m_sGroup1, "rate")));
// pitch must reflect the absolute pitch
ASSERT_NEAR(0.5, ControlObject::get(ConfigKey(m_sGroup1, "pitch")), 1e-10);
ControlObject::set(ConfigKey(m_sGroup1, "keylockMode"),
0.0); // kLockOriginalKey;
ProcessBuffer();
// rate must not change
ASSERT_NEAR(0.5, ControlObject::get(ConfigKey(m_sGroup1, "pitch")), 1e-10);
// pitch must reflect the pitch shift only
ASSERT_DOUBLE_EQ(0.5, ControlObject::get(ConfigKey(m_sGroup1, "rate")));
}
TEST_F(EngineBufferTest, SlowRubberBand) {
// At very slow speeds, RubberBand needs to reallocate buffers and since
// this
// is done in the engine thread it can be a major party-stopper.
// Make sure slow speeds still use the linear scaler.
ControlObject::set(ConfigKey(m_sGroup1, "pitch"), 2.8);
// Hack to get a slow, non-scratching direct speed
ControlObject::set(ConfigKey(m_sGroup1, "rateSearch"), 0.0072);
// With Soundtouch, it should switch the scaler as well
ControlObject::set(ConfigKey("[Master]", "keylock_engine"),
static_cast<double>(EngineBuffer::SOUNDTOUCH));
ProcessBuffer();
EXPECT_EQ(m_pMockScaleVinyl1, m_pChannel1->getEngineBuffer()->m_pScale);
// Back to full speed
ControlObject::set(ConfigKey(m_sGroup1, "rateSearch"), 1);
ProcessBuffer();
// With Rubberband, and transport stopped it should be still keylock
ControlObject::set(ConfigKey("[Master]", "keylock_engine"),
static_cast<double>(EngineBuffer::RUBBERBAND));
ControlObject::set(ConfigKey(m_sGroup1, "rateSearch"), 0.0);
ProcessBuffer();
EXPECT_EQ(m_pMockScaleKeylock1, m_pChannel1->getEngineBuffer()->m_pScale);
ControlObject::set(ConfigKey(m_sGroup1, "rateSearch"), 0.0072);
// Paying at low rate, the vinyl scaler should be used
ProcessBuffer();
EXPECT_EQ(m_pMockScaleVinyl1, m_pChannel1->getEngineBuffer()->m_pScale);
}
TEST_F(EngineBufferTest, ScalerNoTransport) {
// normaly use the Vinyl scaler
ControlObject::set(ConfigKey(m_sGroup1, "play"), 1.0);
ProcessBuffer();
EXPECT_EQ(m_pMockScaleVinyl1, m_pChannel1->getEngineBuffer()->m_pScale);
// switch to keylock scaler
ControlObject::set(ConfigKey(m_sGroup1, "keylock"), 1.0);
ProcessBuffer();
EXPECT_EQ(m_pMockScaleKeylock1, m_pChannel1->getEngineBuffer()->m_pScale);
// Stop and disable keylock: do not change scaler
ControlObject::set(ConfigKey(m_sGroup1, "play"), 0.0);
ControlObject::set(ConfigKey(m_sGroup1, "keylock"), 0.0);
ProcessBuffer();
EXPECT_EQ(m_pMockScaleKeylock1, m_pChannel1->getEngineBuffer()->m_pScale);
// play: we need to use vinyl scaler
ControlObject::set(ConfigKey(m_sGroup1, "play"), 1.0);
ProcessBuffer();
EXPECT_EQ(m_pMockScaleVinyl1, m_pChannel1->getEngineBuffer()->m_pScale);
}
TEST_F(EngineBufferTest, VinylScalerRampZero) {
// scratch in play mode
ControlObject::set(ConfigKey(m_sGroup1, "scratch2_enable"), 1.0);
ControlObject::set(ConfigKey(m_sGroup1, "scratch2"), 1.0);
ProcessBuffer();
EXPECT_EQ(m_pMockScaleVinyl1, m_pChannel1->getEngineBuffer()->m_pScale);
EXPECT_EQ(m_pMockScaleVinyl1->getProcessedTempo(), 1.0);
ControlObject::set(ConfigKey(m_sGroup1, "scratch2"), 0.0);
// we are in scratching mode so a zero rate has to be processed
ProcessBuffer();
EXPECT_EQ(m_pMockScaleVinyl1, m_pChannel1->getEngineBuffer()->m_pScale);
EXPECT_EQ(m_pMockScaleVinyl1->getProcessedTempo(), 0.0);
}
TEST_F(EngineBufferTest, ReadFadeOut) {
// Start playing
ControlObject::set(ConfigKey(m_sGroup1, "play"), 1.0);
ProcessBuffer();
EXPECT_EQ(m_pMockScaleVinyl1, m_pChannel1->getEngineBuffer()->m_pScale);
EXPECT_EQ(m_pMockScaleVinyl1->getProcessedTempo(), 1.0);
// pause
ControlObject::set(ConfigKey(m_sGroup1, "play"), 0.0);
// The scaler need to be processed with the old rate to
// prepare the crossfade buffer
ProcessBuffer();
EXPECT_EQ(m_pMockScaleVinyl1, m_pChannel1->getEngineBuffer()->m_pScale);
EXPECT_EQ(m_pMockScaleVinyl1->getProcessedTempo(), 1.0);
}
TEST_F(EngineBufferTest, ResetPitchAdjustUsesLinear) {
// If the key was adjusted, but keylock is off, and then the key is
// reset, then the engine should be using the linear scaler.
// First, we should be using the keylock scaler here.
ControlObject::set(ConfigKey(m_sGroup1, "pitch"), 1.2);
// Remember that a rate of "0" is "regular playback speed".
ControlObject::set(ConfigKey(m_sGroup1, "rate"), 0.05);
ControlObject::set(ConfigKey(m_sGroup1, "play"), 1.0);
ProcessBuffer();
EXPECT_EQ(m_pMockScaleKeylock1, m_pChannel1->getEngineBuffer()->m_pScale);
// Reset pitch adjust, and we should be back to the linear scaler.
ControlObject::set(ConfigKey(m_sGroup1, "pitch_adjust_set_default"), 1.0);
ProcessBuffer();
EXPECT_EQ(m_pMockScaleVinyl1, m_pChannel1->getEngineBuffer()->m_pScale);
}
TEST_F(EngineBufferE2ETest, SoundTouchCrashTest) {
// Soundtouch has a bug where a pitch value of zero causes an infinite loop
// and crash.
ControlObject::set(ConfigKey("[Master]", "keylock_engine"),
static_cast<double>(EngineBuffer::SOUNDTOUCH));
ControlObject::set(ConfigKey(m_sGroup1, "pitch"), 1.2);
ControlObject::set(ConfigKey(m_sGroup1, "rate"), 0.05);
ControlObject::set(ConfigKey(m_sGroup1, "play"), 1.0);
// Start by playing with soundtouch enabled.
ProcessBuffer();
// Pause the buffer. This causes the pitch to be set to 0.
ControlObject::set(ConfigKey(m_sGroup1, "play"), 0.0);
ProcessBuffer();
ControlObject::set(ConfigKey(m_sGroup1, "rateSearch"), -0.05);
// Should not crash
ProcessBuffer();
|