summaryrefslogtreecommitdiffstats
path: root/src/test/seratobeatgridtest.cpp
blob: d8b1b9d3fc1c0bc32ede481ec16350294f8e069e (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
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
#include <gtest/gtest.h>
#include <taglib/textidentificationframe.h>
#include <taglib/tstring.h>

#include <QDir>
#include <QtDebug>

#include "track/beats.h"
#include "track/serato/beatgrid.h"
#include "track/serato/beatsimporter.h"
#include "util/memory.h"

namespace {

// Maximum allowed frame position inaccuracy after reimport
constexpr double kEpsilon = 0.1;

} // namespace

namespace mixxx {

class SeratoBeatGridTest : public testing::Test {
  protected:
    bool parseBeatGridData(const QByteArray& inputValue,
            bool valid,
            mixxx::taglib::FileType fileType,
            QByteArray* output = nullptr) {
        mixxx::SeratoBeatGrid seratoBeatGrid;
        bool parseOk = mixxx::SeratoBeatGrid::parse(
                &seratoBeatGrid, inputValue, fileType);
        EXPECT_EQ(valid, parseOk);
        if (!parseOk) {
            return false;
        }
        QByteArray outputValue = seratoBeatGrid.dump(fileType);
        EXPECT_EQ(inputValue, outputValue);
        if (inputValue != outputValue) {
            if (output) {
                output->clear();
                output->append(outputValue);
            }
            return false;
        }
        return true;
    }

    void parseBeatGridDataInDirectory(
            QDir dir, mixxx::taglib::FileType fileType) {
        EXPECT_TRUE(dir.exists());
        dir.setFilter(QDir::Files);
        dir.setNameFilters(QStringList() << "*.octet-stream");

        QFileInfoList fileList = dir.entryInfoList();
        EXPECT_FALSE(fileList.isEmpty());
        for (const QFileInfo& fileInfo : fileList) {
            qDebug() << "--- File:" << fileInfo.fileName();
            QFile file(dir.filePath(fileInfo.fileName()));
            bool openOk = file.open(QIODevice::ReadOnly);
            EXPECT_TRUE(openOk);
            if (!openOk) {
                continue;
            }
            QByteArray data = file.readAll();
            QByteArray actualData;
            if (!parseBeatGridData(data, true, fileType, &actualData)) {
                QFile outfile(file.fileName() + QStringLiteral(".actual"));
                openOk = outfile.open(QIODevice::WriteOnly);
                EXPECT_TRUE(openOk);
                if (!openOk) {
                    continue;
                }
                EXPECT_EQ(actualData.size(), outfile.write(actualData));
            }
        }
    }

    void parseEmptyBeatGridData(mixxx::taglib::FileType fileType) {
        QByteArray inputValue;
        mixxx::SeratoBeatGrid seratoBeatGrid;
        mixxx::SeratoBeatGrid::parse(&seratoBeatGrid, inputValue, fileType);
        QByteArray outputValue = seratoBeatGrid.dump(fileType);
        EXPECT_EQ(inputValue, outputValue);
    }
};

TEST_F(SeratoBeatGridTest, ParseBeatGridDataMP3) {
    parseBeatGridDataInDirectory(QDir("src/test/serato/data/mp3/beatgrid"),
            mixxx::taglib::FileType::MP3);
}

TEST_F(SeratoBeatGridTest, ParseEmptyDataMP3) {
    parseEmptyBeatGridData(mixxx::taglib::FileType::MP3);
}

TEST_F(SeratoBeatGridTest, ParseBeatGridDataMP4) {
    parseBeatGridDataInDirectory(QDir("src/test/serato/data/mp4/beatgrid"),
            mixxx::taglib::FileType::MP4);
}

TEST_F(SeratoBeatGridTest, ParseEmptyDataMP4) {
    parseEmptyBeatGridData(mixxx::taglib::FileType::MP4);
}

TEST_F(SeratoBeatGridTest, ParseBeatGridDataFLAC) {
    parseBeatGridDataInDirectory(QDir("src/test/serato/data/flac/beatgrid"),
            mixxx::taglib::FileType::FLAC);
}

TEST_F(SeratoBeatGridTest, ParseEmptyDataFLAC) {
    parseEmptyBeatGridData(mixxx::taglib::FileType::FLAC);
}

TEST_F(SeratoBeatGridTest, SerializeBeatgrid) {
    // Create a const beatgrid at 120 BPM
    constexpr mixxx::Bpm bpm(120.0);
    const auto sampleRate = mixxx::audio::SampleRate(44100);
    EXPECT_EQ(sampleRate.isValid(), true);
    const auto pBeats = mixxx::Beats::fromConstTempo(
            sampleRate, mixxx::audio::kStartFramePos, bpm);
    const auto signalInfo = mixxx::audio::SignalInfo(mixxx::audio::ChannelCount(2), sampleRate);
    const auto duration = mixxx::Duration::fromSeconds<int>(300);

    // Serialize that beatgrid into Serato BeatGrid data and check if it's correct
    mixxx::SeratoBeatGrid seratoBeatGrid;
    seratoBeatGrid.setBeats(pBeats, signalInfo, duration, 0);
    EXPECT_EQ(seratoBeatGrid.nonTerminalMarkers().size(), 0);
    EXPECT_NE(seratoBeatGrid.terminalMarker(), nullptr);
    EXPECT_FLOAT_EQ(seratoBeatGrid.terminalMarker()->bpm(), static_cast<float>(bpm.value()));
}

TEST_F(SeratoBeatGridTest, SerializeBeatMap) {
    // Create a non-const beatmap
    constexpr double timingOffsetMillis = -10;
    constexpr mixxx::Bpm bpm(120);
    const auto sampleRate = mixxx::audio::SampleRate(44100);
    const auto signalInfo = mixxx::audio::SignalInfo(mixxx::audio::ChannelCount(2), sampleRate);
    const auto duration = mixxx::Duration::fromSeconds<int>(300);
    const mixxx::audio::FrameDiff_t framesPerMinute = signalInfo.getSampleRate() * 60;
    const mixxx::audio::FrameDiff_t framesPerBeat = framesPerMinute / bpm.value();
    const mixxx::audio::FrameDiff_t initialFrameOffset = framesPerBeat / 2;

    QVector<mixxx::audio::FramePos> beatPositionsFrames;
    mixxx::audio::FramePos beatPositionFrames = mixxx::audio::FramePos(initialFrameOffset);

    constexpr int kNumBeats120BPM = 4;
    qInfo() << "Step 1: Add" << kNumBeats120BPM << "beats at 100 bpm to the beatgrid";
    for (int i = 0; i < kNumBeats120BPM; i++) {
        beatPositionsFrames.append(beatPositionFrames);
        beatPositionFrames += framesPerBeat;
    }
    ASSERT_EQ(beatPositionsFrames.size(), kNumBeats120BPM);

    // Check the const beatmap
    {
        const auto pBeats = mixxx::Beats::fromBeatPositions(sampleRate, beatPositionsFrames);
        // Check that the first section's BPM is 100
        EXPECT_EQ(pBeats->getBpmAroundPosition(
                          mixxx::audio::FramePos(initialFrameOffset +
                                  framesPerBeat * kNumBeats120BPM / 2),
                          1),
                bpm);

        mixxx::SeratoBeatGrid seratoBeatGrid;
        seratoBeatGrid.setBeats(pBeats, signalInfo, duration, timingOffsetMillis);
        EXPECT_EQ(seratoBeatGrid.nonTerminalMarkers().size(), 0);
        EXPECT_NE(seratoBeatGrid.terminalMarker(), nullptr);
        EXPECT_FLOAT_EQ(seratoBeatGrid.terminalMarker()->bpm(), static_cast<float>(bpm.value()));

        // Check if the beats can be re-imported losslessly
        mixxx::SeratoBeatsImporter beatsImporter(
                seratoBeatGrid.nonTerminalMarkers(),
                seratoBeatGrid.terminalMarker());
        const auto pImportedBeats =
                beatsImporter.importBeatsAndApplyTimingOffset(
                        timingOffsetMillis, signalInfo);
        auto pBeatsIterator =
                pImportedBeats->findBeats(beatPositionsFrames.first() - 1000,
                        beatPositionsFrames.last() + 1000);
        for (int i = 0; i < beatPositionsFrames.size(); i++) {
            const auto importedPosition = pBeatsIterator->next();
            EXPECT_NEAR(beatPositionsFrames[i].value(),
                    importedPosition.value(),
                    kEpsilon);
        }
        ASSERT_FALSE(pBeatsIterator->hasNext());
    }

    constexpr int kNumBeats60BPM = 4;
    qInfo() << "Step 2: Add" << kNumBeats60BPM << "beats at 50 bpm to the beatgrid";
    for (int i = 0; i < kNumBeats60BPM; i++) {
        beatPositionsFrames.append(beatPositionFrames);
        beatPositionFrames += framesPerBeat * 2;
    }
    ASSERT_EQ(beatPositionsFrames.size(), kNumBeats120BPM + kNumBeats60BPM);

    {
        const auto pBeats = mixxx::Beats::fromBeatPositions(sampleRate, beatPositionsFrames);
        // Check that the first section'd BPM is 100
        EXPECT_EQ(pBeats->getBpmAroundPosition(
                          mixxx::audio::FramePos(initialFrameOffset +
                                  framesPerBeat * kNumBeats120BPM / 2),
                          1),
                bpm);
        // Check that the second section'd BPM is 50
        EXPECT_EQ(pBeats->getBpmAroundPosition(
                          mixxx::audio::FramePos(initialFrameOffset +
                                  framesPerBeat * kNumBeats120BPM +
                                  framesPerBeat * kNumBeats60BPM / 2),
                          1),
                bpm / 2);

        mixxx::SeratoBeatGrid seratoBeatGrid;
        seratoBeatGrid.setBeats(pBeats, signalInfo,