-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
seratofeature.cpp
1123 lines (990 loc) · 38 KB
/
seratofeature.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
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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#include "library/serato/seratofeature.h"
#include <QMap>
#include <QTextCodec>
#include <QtConcurrent>
#include <QtDebug>
#include "library/dao/trackschema.h"
#include "library/library.h"
#include "library/queryutil.h"
#include "library/serato/seratoplaylistmodel.h"
#include "library/trackcollection.h"
#include "library/trackcollectionmanager.h"
#include "library/treeitem.h"
#include "moc_seratofeature.cpp"
#include "util/assert.h"
#include "util/db/dbconnectionpooled.h"
#include "util/db/dbconnectionpooler.h"
#include "widget/wlibrary.h"
#include "widget/wlibrarytextbrowser.h"
namespace {
// Serato Database Field IDs
// The "magic" value is the short 4 byte ascii code interpreted as quint32, so
// that we can use the value in a switch statement instead of going through
// a strcmp if/else ladder.
enum class FieldId : quint32 {
Version = 0x7672736e, // vrsn
Track = 0x6f74726b, // otrk
FileType = 0x74747970, // ttyp
FilePath = 0x7066696c, // pfil
SongTitle = 0x74736e67, // tsng
Artist = 0x74617274, // tart
Album = 0x74616c62, // talb
Genre = 0x7467656e, // tgen
Comment = 0x74636f6d, // tcom
Grouping = 0x74677270, // tgrp
Label = 0x746c626c, // tlbl
Year = 0x74747972, // ttyr
Length = 0x746c656e, // tlen
Bitrate = 0x74626974, // tbit
SampleRate = 0x74736d70, // tsmp
Bpm = 0x7462706d, // tbpm
DateAddedText = 0x74616464, // tadd
DateAdded = 0x75616464, // uadd
Key = 0x746b6579, // tkey
BeatgridLocked = 0x6262676c, // bbgl
FileTime = 0x75746d65, // utme
Missing = 0x626d6973, // bmis
Sorting = 0x7472736f, // osrt
ReverseOrder = 0x62726576, // brev
ColumnTitle = 0x6f766374, // ovct
ColumnName = 0x7476636e, // tvcn
ColumnWidth = 0x74766377, // tvcw
TrackPath = 0x7074726b, // ptrk
};
struct serato_track_t {
QString filetype;
QString location;
QString title;
QString artist;
QString album;
QString genre;
QString comment;
QString grouping;
QString label;
int year = -1;
int duration = 0;
QString bitrate;
QString samplerate;
double bpm = -1.0;
QString key;
bool beatgridlocked = false;
bool missing = false;
quint32 filetime = 0;
quint32 datetimeadded = 0;
};
const QString kDatabaseDirectory = QStringLiteral("_Serato_");
const QString kDatabaseFilename = QStringLiteral("database V2");
const QString kCrateDirectory = QStringLiteral("Subcrates");
const QString kCrateFilter = QStringLiteral("*.crate");
const QString kSmartCrateDirectory = QStringLiteral("Smart Crates");
const QString kSmartCrateFilter = QStringLiteral("*.scrate");
const QString kSeratoLibraryTable = QStringLiteral("serato_library");
const QString kSeratoPlaylistsTable = QStringLiteral("serato_playlists");
const QString kSeratoPlaylistTracksTable = QStringLiteral("serato_playlist_tracks");
constexpr int kHeaderSize = 2 * sizeof(quint32);
int createPlaylist(const QSqlDatabase& database, const QString& name, const QString& databasePath) {
QSqlQuery query(database);
query.prepare(
"INSERT INTO serato_playlists (name, serato_db)"
"VALUES (:name, :serato_db)");
query.bindValue(":name", name);
query.bindValue(":serato_db", databasePath);
if (!query.exec()) {
LOG_FAILED_QUERY(query) << "databasePath: " << databasePath;
return -1;
}
return query.lastInsertId().toInt();
}
int insertTrackIntoPlaylist(const QSqlDatabase& database, int playlistId, int trackId, int position) {
QSqlQuery query(database);
query.prepare(
"INSERT INTO serato_playlist_tracks (playlist_id, track_id, position) "
"VALUES (:playlist_id, :track_id, :position)");
query.bindValue(":playlist_id", playlistId);
query.bindValue(":track_id", trackId);
query.bindValue(":position", position);
if (!query.exec()) {
LOG_FAILED_QUERY(query);
return -1;
}
return query.lastInsertId().toInt();
}
inline QString utf16beToQString(const QByteArray& data, const quint32 size) {
return QTextCodec::codecForName("UTF-16BE")->toUnicode(data, size);
}
inline bool bytesToBoolean(const QByteArray& data) {
VERIFY_OR_DEBUG_ASSERT(!data.isEmpty()) {
return false;
}
return data.at(0) != 0;
}
inline quint32 bytesToUInt32(const QByteArray& data) {
VERIFY_OR_DEBUG_ASSERT(data.size() >= static_cast<int>(sizeof(quint32))) {
return 0;
}
return qFromBigEndian<quint32>(data.constData());
}
inline bool parseTrack(serato_track_t* track, QIODevice* buffer) {
QByteArray headerData = buffer->read(kHeaderSize);
while (headerData.length() == kHeaderSize) {
quint32 fieldId = bytesToUInt32(headerData.mid(0, sizeof(quint32)));
quint32 fieldSize = bytesToUInt32(headerData.mid(sizeof(quint32), kHeaderSize));
// Read field data
QByteArray data = buffer->read(fieldSize);
if (static_cast<quint32>(data.length()) != fieldSize) {
QString fieldName = QString(headerData.mid(0, sizeof(quint32)));
qWarning() << "Failed to read "
<< fieldSize
<< " bytes for "
<< fieldName
<< " field.";
return false;
}
// Parse field data
switch (static_cast<FieldId>(fieldId)) {
case FieldId::FileType:
track->filetype = utf16beToQString(data, fieldSize);
break;
case FieldId::FilePath:
track->location = utf16beToQString(data, fieldSize);
break;
case FieldId::SongTitle:
track->title = utf16beToQString(data, fieldSize);
break;
case FieldId::Artist:
track->artist = utf16beToQString(data, fieldSize);
break;
case FieldId::Album:
track->album = utf16beToQString(data, fieldSize);
break;
case FieldId::Genre:
track->genre = utf16beToQString(data, fieldSize);
break;
case FieldId::Length: {
bool ok;
int duration = utf16beToQString(data, fieldSize).toInt(&ok);
if (ok) {
track->duration = duration;
}
break;
}
case FieldId::Bitrate:
track->bitrate = utf16beToQString(data, fieldSize);
break;
case FieldId::SampleRate:
track->samplerate = utf16beToQString(data, fieldSize);
break;
case FieldId::Bpm: {
bool ok;
double bpm = utf16beToQString(data, fieldSize).toDouble(&ok);
if (ok) {
track->bpm = bpm;
}
break;
}
case FieldId::Comment:
track->comment = utf16beToQString(data, fieldSize);
break;
case FieldId::Grouping:
track->grouping = utf16beToQString(data, fieldSize);
break;
case FieldId::Label:
track->label = utf16beToQString(data, fieldSize);
break;
case FieldId::Year: {
// 4-digit year as string (YYYY)
bool ok;
int year = utf16beToQString(data, fieldSize).toInt(&ok);
if (ok) {
track->year = year;
}
break;
}
case FieldId::Key:
track->key = utf16beToQString(data, fieldSize);
break;
case FieldId::BeatgridLocked:
track->beatgridlocked = bytesToBoolean(data);
break;
case FieldId::Missing:
if (fieldSize == 1) {
track->missing = bytesToBoolean(data);
}
break;
case FieldId::FileTime:
// POSIX timestamp
if (fieldSize == sizeof(quint32)) {
track->filetime = bytesToUInt32(data);
}
break;
case FieldId::DateAdded:
// POSIX timestamp
if (fieldSize == sizeof(quint32)) {
track->datetimeadded = bytesToUInt32(data);
}
break;
case FieldId::DateAddedText:
// Ignore this field, but do not print a debug message. It's the
// same as the regular DateAdded field, but this time the timestamp
// is a string instead of an unsigned integer. Since we already
// parse the integer version, it doesn't make sense to parse this.
break;
default: {
QString fieldName = QString(headerData.mid(0, sizeof(quint32)));
qDebug() << "Ignoring unknown field "
<< fieldName
<< " ("
<< fieldSize
<< " bytes).";
}
}
headerData = buffer->read(kHeaderSize);
}
if (headerData.length() != 0) {
qWarning() << "Found "
<< headerData.length()
<< " extra bytes at end of track definition.";
return false;
}
// Ignore tracks with empty location fields. The track location is used as
// identifier by Serato (e.g. it's also used to reference them in Crates).
if (track->location.isEmpty()) {
qWarning() << "Found track with empty location field.";
return false;
}
return true;
}
inline QString parseCrateTrackPath(QIODevice* buffer) {
QString location;
QByteArray headerData = buffer->read(kHeaderSize);
while (headerData.length() == kHeaderSize) {
quint32 fieldId = bytesToUInt32(headerData.mid(0, sizeof(quint32)));
quint32 fieldSize = bytesToUInt32(headerData.mid(sizeof(quint32), kHeaderSize));
// Read field data
QByteArray data = buffer->read(fieldSize);
if (static_cast<quint32>(data.length()) != fieldSize) {
QString fieldName = QString(headerData.mid(0, sizeof(quint32)));
qWarning() << "Failed to read "
<< fieldSize
<< " bytes for "
<< fieldName
<< " field.";
return QString();
}
// Parse field data
switch (static_cast<FieldId>(fieldId)) {
case FieldId::TrackPath:
location = utf16beToQString(data, fieldSize);
break;
default: {
QString fieldName = QString(headerData.mid(0, sizeof(quint32)));
qDebug() << "Ignoring unknown field "
<< fieldName
<< " ("
<< fieldSize
<< " bytes).";
}
}
headerData = buffer->read(kHeaderSize);
}
if (headerData.length() != 0) {
qWarning() << "Found "
<< headerData.length()
<< " extra bytes at end of track definition.";
return QString();
}
return location;
}
QString parseCrate(
const QSqlDatabase& database,
const QString& databasePath,
const QString& crateFilePath,
const QMap<QString, int>& trackIdMap) {
QString crateName = QFileInfo(crateFilePath).baseName();
qDebug() << "Parsing crate"
<< crateName
<< "at" << crateFilePath;
//Open the database connection in this thread.
VERIFY_OR_DEBUG_ASSERT(database.isOpen()) {
qWarning() << "Failed to open database for Serato parser."
<< database.lastError();
return QString();
}
mixxx::FileInfo fileInfo(crateFilePath);
QFile crateFile(crateFilePath);
if (!Sandbox::askForAccess(&fileInfo) || !crateFile.open(QIODevice::ReadOnly)) {
qWarning() << "Failed to open file "
<< crateFilePath
<< " for reading:"
<< crateFile.errorString();
return QString();
}
int playlistId = createPlaylist(database, crateFilePath, databasePath);
if (playlistId < 0) {
qWarning() << "Failed to create library playlist for "
<< crateFilePath;
return QString();
}
int trackCount = 0;
QByteArray headerData = crateFile.read(kHeaderSize);
while (headerData.length() == kHeaderSize) {
quint32 fieldId = bytesToUInt32(headerData.mid(0, sizeof(quint32)));
quint32 fieldSize = bytesToUInt32(headerData.mid(sizeof(quint32), kHeaderSize));
// Read field data
QByteArray data = crateFile.read(fieldSize);
if (static_cast<quint32>(data.length()) != fieldSize) {
QString fieldName = QString(headerData.mid(0, sizeof(quint32)));
qWarning() << "Failed to read "
<< fieldSize
<< " bytes for "
<< fieldName
<< " field from "
<< crateFilePath
<< ".";
return QString();
}
// Parse field data
switch (static_cast<FieldId>(fieldId)) {
case FieldId::Version: {
QString version = utf16beToQString(data, fieldSize);
qDebug() << "Serato Database Version: "
<< version;
break;
}
case FieldId::Track: {
QBuffer buffer(&data);
buffer.open(QIODevice::ReadOnly);
QString location = parseCrateTrackPath(&buffer);
if (!location.isEmpty()) {
int trackId = trackIdMap.value(location, -1);
insertTrackIntoPlaylist(database, playlistId, trackId, trackCount);
trackCount++;
break;
}
break;
}
default: {
QString fieldName = QString(headerData.mid(0, sizeof(quint32)));
qDebug() << "Ignoring unknown field "
<< fieldName
<< " ("
<< fieldSize
<< " bytes) in database "
<< crateFilePath
<< ".";
}
}
headerData = crateFile.read(kHeaderSize);
}
if (headerData.length() != 0) {
qWarning() << "Found "
<< headerData.length()
<< " extra bytes at end of Serato database file "
<< crateFilePath
<< ".";
}
return crateName;
}
QString parseDatabase(mixxx::DbConnectionPoolPtr dbConnectionPool, TreeItem* databaseItem) {
QString databaseName = databaseItem->getLabel();
QString databaseFilePath = databaseItem->getData().toList()[0].toString();
QDir databaseDir = QFileInfo(databaseFilePath).dir();
QDir databaseRootDir = QDir(databaseDir);
databaseRootDir.cdUp();
#if defined(__WINDOWS__)
// On Windows, all paths are relative to drive root of the database (e.g.
// "C:\"). Qt doesn't seem to provide a way to find it for a specific path,
// so we just call cdUp() until it stops working.
while (databaseRootDir.cdUp()) {
// Nothing to do here
}
#else
// If the file is on an external drive, the database path are relative to
// its mountpoint, i.e. the parent directory of the _Serato_
// directory. This means we can just use the path as-is.
//
// If the file is not on an external drive, the paths are all relative to
// the file system's root directory ("/").
//
// Serato does not exist on Linux, if it did, it would probably just mirror
// the way paths are handled on OSX.
if (databaseRootDir.canonicalPath().startsWith(QDir::homePath())) {
databaseRootDir.setPath(QDir::rootPath());
}
#endif
qDebug() << "Parsing Serato database"
<< databaseName
<< "at" << databaseFilePath;
if (!QFile(databaseFilePath).exists()) {
qWarning() << "Serato database file not found: "
<< databaseFilePath;
return databaseFilePath;
}
// The pooler limits the lifetime all thread-local connections,
// that should be closed immediately before exiting this function.
const mixxx::DbConnectionPooler dbConnectionPooler(dbConnectionPool);
QSqlDatabase database = mixxx::DbConnectionPooled(dbConnectionPool);
//Open the database connection in this thread.
VERIFY_OR_DEBUG_ASSERT(database.isOpen()) {
qWarning() << "Failed to open database for Serato parser."
<< database.lastError();
return QString();
}
//Give thread a low priority
QThread* thisThread = QThread::currentThread();
thisThread->setPriority(QThread::LowPriority);
ScopedTransaction transaction(database);
QSqlQuery query(database);
query.prepare(
"INSERT INTO " +
kSeratoLibraryTable + " (" +
LIBRARYTABLE_TITLE + ", " +
LIBRARYTABLE_ARTIST + ", " +
LIBRARYTABLE_ALBUM + ", " +
LIBRARYTABLE_GENRE + ", " +
LIBRARYTABLE_COMMENT + ", " +
LIBRARYTABLE_GROUPING + ", " +
LIBRARYTABLE_YEAR + ", " +
LIBRARYTABLE_DURATION + ", " +
LIBRARYTABLE_BITRATE + ", " +
LIBRARYTABLE_SAMPLERATE + ", " +
LIBRARYTABLE_BPM + ", " +
LIBRARYTABLE_KEY + ", " +
TRACKLOCATIONSTABLE_LOCATION + ", " +
LIBRARYTABLE_BPM_LOCK + ", " +
LIBRARYTABLE_DATETIMEADDED +
", "
"label, "
"serato_db"
") VALUES ("
":title, "
":artist, "
":album, "
":genre, "
":comment, "
":grouping, "
":year, "
":duration, "
":bitrate, "
":samplerate, "
":bpm, "
":key, "
":location, "
":bpm_lock, "
":datetime_added, "
":label, "
":serato_db"
")");
mixxx::FileInfo fileInfo(databaseFilePath);
QFile databaseFile(databaseFilePath);
if (!Sandbox::askForAccess(&fileInfo) || !databaseFile.open(QIODevice::ReadOnly)) {
qWarning() << "Failed to open file "
<< databaseFilePath
<< " for reading.";
return QString();
}
int playlistId = createPlaylist(database, databaseFilePath, databaseDir.path());
if (playlistId < 0) {
qWarning() << "Failed to create library playlist for "
<< databaseFilePath;
return QString();
}
int trackCount = 0;
QMap<QString, int> trackIdMap;
QByteArray headerData = databaseFile.read(kHeaderSize);
while (headerData.length() == kHeaderSize) {
quint32 fieldId = bytesToUInt32(headerData.mid(0, sizeof(quint32)));
quint32 fieldSize = bytesToUInt32(headerData.mid(sizeof(quint32), kHeaderSize));
// Read field data
QByteArray data = databaseFile.read(fieldSize);
if (static_cast<quint32>(data.length()) != fieldSize) {
QString fieldName = QString(headerData.mid(0, sizeof(quint32)));
qWarning() << "Failed to read "
<< fieldSize
<< " bytes for "
<< fieldName
<< " field from "
<< databaseFilePath
<< ".";
return QString();
}
// Parse field data
switch (static_cast<FieldId>(fieldId)) {
case FieldId::Version: {
QString version = utf16beToQString(data, fieldSize);
qDebug() << "Serato Database Version: "
<< version;
break;
}
case FieldId::Track: {
serato_track_t track;
QBuffer buffer(&data);
buffer.open(QIODevice::ReadOnly);
if (parseTrack(&track, &buffer)) {
QString location = databaseRootDir.absoluteFilePath(track.location);
query.bindValue(":title", track.title);
query.bindValue(":artist", track.artist);
query.bindValue(":album", track.album);
query.bindValue(":genre", track.genre);
query.bindValue(":comment", track.comment);
query.bindValue(":grouping", track.grouping);
query.bindValue(":year", track.year);
query.bindValue(":duration", track.duration);
query.bindValue(":bitrate", track.bitrate);
query.bindValue(":samplerate", track.samplerate);
query.bindValue(":bpm", track.bpm);
query.bindValue(":key", track.key);
query.bindValue(":location", location);
query.bindValue(":bpm_lock", track.beatgridlocked);
query.bindValue(":datetime_added", track.datetimeadded);
query.bindValue(":label", track.label);
query.bindValue(":serato_db", databaseDir.path());
if (!query.exec()) {
LOG_FAILED_QUERY(query);
} else {
int trackId = query.lastInsertId().toInt();
insertTrackIntoPlaylist(database, playlistId, trackId, trackCount);
trackIdMap.insert(track.location, trackId);
trackCount++;
}
break;
}
break;
}
default: {
QString fieldName = QString(headerData.mid(0, sizeof(quint32)));
qDebug() << "Ignoring unknown field "
<< fieldName
<< " ("
<< fieldSize
<< " bytes) in database "
<< databaseFilePath
<< ".";
}
}
headerData = databaseFile.read(kHeaderSize);
}
if (headerData.length() != 0) {
qWarning() << "Found "
<< headerData.length()
<< " extra bytes at end of Serato database file "
<< databaseFilePath
<< ".";
}
// Parse Crates
QDir crateDir = QDir(databaseDir);
if (crateDir.cd(kCrateDirectory)) {
QStringList filters;
filters << kCrateFilter;
const auto entryList = crateDir.entryList(filters);
for (const QString& entry : entryList) {
QString crateFilePath = crateDir.filePath(entry);
QString crateName = parseCrate(
database,
databaseDir.path(),
crateFilePath,
trackIdMap);
if (!crateName.isEmpty()) {
TreeItem* crateItem = databaseItem->appendChild(crateName,
QList<QVariant>{
QVariant(crateFilePath), QVariant(true)});
crateItem->setIcon(QIcon(":/images/library/ic_library_crates.svg"));
}
}
} else {
qWarning() << "Failed to open crate directory: "
<< databaseDir.filePath(kCrateDirectory);
}
// TODO: Parse Smart Crates
transaction.commit();
return databaseFilePath;
}
// This function is executed in a separate thread other than the main thread
// The returned list owns the pointers, but we can't use a unique_ptr because
// the result is passed by a const reference inside QFuture and than copied
// to the main thread requiring a copy-able object.
QList<TreeItem*> findSeratoDatabases() {
QThread* thisThread = QThread::currentThread();
thisThread->setPriority(QThread::LowPriority);
// Build a list of directories that could contain the _Serato_ directory
QFileInfoList databaseLocations;
foreach (const QString& musicDir, QStandardPaths::standardLocations(QStandardPaths::MusicLocation)) {
databaseLocations.append(QFileInfo(musicDir));
}
#if defined(__WINDOWS__)
// Repopulate drive list
// Using drive.filePath() instead of drive.canonicalPath() as it
// freezes interface too much if there is a network share mounted
// (drive letter assigned) but unavailable
//
// drive.canonicalPath() make a system call to the underlying filesystem
// introducing delay if it is unreadable.
// drive.filePath() doesn't make any access to the filesystem and consequently
// shorten the delay
databaseLocations.append(QDir::drives());
#elif defined(__LINUX__)
// To get devices on Linux, we look for directories under /media and
// /run/media/$USER.
const QString userName = QString::fromLocal8Bit(qgetenv("USER"));
// Add folders under /media to devices.
QDir mediaDir = QDir(QStringLiteral("/media/"));
databaseLocations.append(
mediaDir.entryInfoList(QDir::AllDirs | QDir::NoDotAndDotDot));
// Add folders under /media/$USER to devices.
if (mediaDir.cd(userName)) {
databaseLocations.append(
mediaDir.entryInfoList(QDir::AllDirs | QDir::NoDotAndDotDot));
}
// Add folders under /run/media/$USER to devices.
QDir runMediaDir = QDir(QStringLiteral("/run/media/"));
if (runMediaDir.cd(userName)) {
databaseLocations.append(
runMediaDir.entryInfoList(QDir::AllDirs | QDir::NoDotAndDotDot));
}
#elif defined(__APPLE__)
QDir volumesDir = QDir(QStringLiteral("/Volumes"));
databaseLocations.append(
volumesDir.entryInfoList(QDir::AllDirs | QDir::NoDotAndDotDot));
#endif
QList<TreeItem*> foundDatabases;
for (const QFileInfo& databaseLocation : std::as_const(databaseLocations)) {
QDir databaseDir = QDir(databaseLocation.filePath());
if (!databaseDir.cd(kDatabaseDirectory)) {
continue;
}
if (!databaseDir.exists(kDatabaseFilename)) {
continue;
}
QString displayPath = databaseLocation.filePath();
if (displayPath.endsWith("/")) {
displayPath.chop(1);
}
TreeItem* foundDatabase = new TreeItem(std::move(displayPath),
QVariant(QList<QVariant>{
QVariant(databaseDir.filePath(kDatabaseFilename)),
QVariant(false)}));
foundDatabases << foundDatabase;
}
return foundDatabases;
}
bool createLibraryTable(QSqlDatabase& database, const QString& tableName) {
qDebug() << "Creating Serato library table: " << tableName;
QSqlQuery query(database);
query.prepare(
"CREATE TABLE IF NOT EXISTS " + tableName +
" ("
" id INTEGER PRIMARY KEY AUTOINCREMENT,"
" title TEXT,"
" artist TEXT,"
" album TEXT,"
" genre TEXT,"
" comment TEXT,"
" grouping TEXT,"
" year INTEGER,"
" duration INTEGER,"
" bitrate TEXT,"
" samplerate TEXT,"
" bpm FLOAT,"
" key TEXT,"
" location TEXT,"
" bpm_lock INTEGER,"
" datetime_added DEFAULT CURRENT_TIMESTAMP,"
" label TEXT,"
" composer TEXT,"
" filename TEXT,"
" filetype TEXT,"
" remixer TEXT,"
" size INTEGER,"
" tracknumber TEXT,"
" serato_db TEXT"
");");
if (!query.exec()) {
LOG_FAILED_QUERY(query);
return false;
}
return true;
}
bool createPlaylistsTable(QSqlDatabase& database, const QString& tableName) {
qDebug() << "Creating Serato playlists table: " << tableName;
QSqlQuery query(database);
query.prepare(
"CREATE TABLE IF NOT EXISTS " + tableName +
" ("
" id INTEGER PRIMARY KEY,"
" name TEXT,"
" serato_db TEXT"
");");
if (!query.exec()) {
LOG_FAILED_QUERY(query);
return false;
}
return true;
}
bool createPlaylistTracksTable(QSqlDatabase& database, const QString& tableName) {
qDebug() << "Creating Serato playlist tracks table: " << tableName;
QSqlQuery query(database);
query.prepare(
"CREATE TABLE IF NOT EXISTS " + tableName +
" ("
" id INTEGER PRIMARY KEY AUTOINCREMENT,"
" playlist_id INTEGER REFERENCES serato_playlists(id),"
" track_id INTEGER REFERENCES serato_library(id),"
" position INTEGER"
");");
if (!query.exec()) {
LOG_FAILED_QUERY(query);
return false;
}
return true;
}
bool dropTable(QSqlDatabase& database, const QString& tableName) {
qDebug() << "Dropping Serato table: " << tableName;
QSqlQuery query(database);
query.prepare("DROP TABLE IF EXISTS " + tableName);
if (!query.exec()) {
LOG_FAILED_QUERY(query);
return false;
}
return true;
}
} // anonymous namespace
SeratoFeature::SeratoFeature(
Library* pLibrary,
UserSettingsPointer pConfig)
: BaseExternalLibraryFeature(pLibrary, pConfig, QStringLiteral("serato")),
m_pSidebarModel(make_parented<TreeItemModel>(this)) {
QString idColumn = LIBRARYTABLE_ID;
QStringList columns = {
LIBRARYTABLE_ID,
LIBRARYTABLE_TITLE,
LIBRARYTABLE_ARTIST,
LIBRARYTABLE_ALBUM,
LIBRARYTABLE_GENRE,
LIBRARYTABLE_COMMENT,
LIBRARYTABLE_GROUPING,
LIBRARYTABLE_YEAR,
LIBRARYTABLE_DURATION,
LIBRARYTABLE_BITRATE,
LIBRARYTABLE_SAMPLERATE,
LIBRARYTABLE_BPM,
LIBRARYTABLE_KEY,
LIBRARYTABLE_TRACKNUMBER,
TRACKLOCATIONSTABLE_LOCATION,
LIBRARYTABLE_BPM_LOCK};
QStringList searchColumns = {
LIBRARYTABLE_ARTIST,
LIBRARYTABLE_TITLE,
LIBRARYTABLE_ALBUM,
LIBRARYTABLE_GENRE,
TRACKLOCATIONSTABLE_LOCATION,
LIBRARYTABLE_COMMENT,
LIBRARYTABLE_GROUPING};
m_trackSource = QSharedPointer<BaseTrackCache>::create(
m_pTrackCollection,
kSeratoLibraryTable,
std::move(idColumn),
std::move(columns),
std::move(searchColumns),
false);
m_pSeratoPlaylistModel = new SeratoPlaylistModel(
this, pLibrary->trackCollectionManager(), m_trackSource);
m_title = tr("Serato");
QSqlDatabase database = m_pTrackCollection->database();
ScopedTransaction transaction(database);
// Drop any leftover temporary Serato database tables if they exist
dropTable(database, kSeratoPlaylistTracksTable);
dropTable(database, kSeratoPlaylistsTable);
dropTable(database, kSeratoLibraryTable);
// Create new temporary Serato database tables
createLibraryTable(database, kSeratoLibraryTable);
createPlaylistsTable(database, kSeratoPlaylistsTable);
createPlaylistTracksTable(database, kSeratoPlaylistTracksTable);
transaction.commit();
connect(&m_databasesFutureWatcher,
&QFutureWatcher<QList<TreeItem*>>::finished,
this,
&SeratoFeature::onSeratoDatabasesFound);
connect(&m_tracksFutureWatcher,
&QFutureWatcher<QString>::finished,
this,
&SeratoFeature::onTracksFound);
// initialize the model
m_pSidebarModel->setRootItem(TreeItem::newRoot(this));
}
SeratoFeature::~SeratoFeature() {
m_databasesFuture.waitForFinished();
m_tracksFuture.waitForFinished();
// Drop temporary Serato database tables on shutdown
QSqlDatabase database = m_pTrackCollection->database();
ScopedTransaction transaction(database);
dropTable(database, kSeratoPlaylistTracksTable);
dropTable(database, kSeratoPlaylistsTable);
dropTable(database, kSeratoLibraryTable);
transaction.commit();
delete m_pSeratoPlaylistModel;
}
void SeratoFeature::bindLibraryWidget(WLibrary* libraryWidget,
KeyboardEventFilter* keyboard) {
Q_UNUSED(keyboard);
WLibraryTextBrowser* edit = new WLibraryTextBrowser(libraryWidget);
edit->setHtml(formatRootViewHtml());
edit->setOpenLinks(false);
connect(edit, &WLibraryTextBrowser::anchorClicked, this, &SeratoFeature::htmlLinkClicked);
libraryWidget->registerView("SERATOHOME", edit);
}
void SeratoFeature::htmlLinkClicked(const QUrl& link) {
if (QString(link.path()) == "refresh") {
activate();
} else {
qDebug() << "Unknown link clicked" << link;
}
}
std::unique_ptr<BaseSqlTableModel>
SeratoFeature::createPlaylistModelForPlaylist(const QString& playlist) {
auto pModel = std::make_unique<SeratoPlaylistModel>(
this, m_pLibrary->trackCollectionManager(), m_trackSource);
pModel->setPlaylist(playlist);
return pModel;
}
QVariant SeratoFeature::title() {
return m_title;
}
bool SeratoFeature::isSupported() {
return true;
}
TreeItemModel* SeratoFeature::sidebarModel() const {
return m_pSidebarModel;
}
QString SeratoFeature::formatRootViewHtml() const {
QString title = tr("Serato");
QString summary = tr("Reads the following from the Serato Music directory and removable devices:");
QStringList items;
items << tr("Tracks")
<< tr("Crates");
QString html;
QString refreshLink = tr("Check for Serato databases (refresh)");
html.append(QString("<h2>%1</h2>").arg(title));
html.append(QString("<p>%1</p>").arg(summary));
html.append(QString("<ul>"));
for (const auto& item : std::as_const(items)) {
html.append(QString("<li>%1</li>").arg(item));
}
html.append(QString("</ul>"));
//Colorize links in lighter blue, instead of QT default dark blue.
//Links are still different from regular text, but readable on dark/light backgrounds.
//https://github.com/mixxxdj/mixxx/issues/9103
html.append(QString("<a style=\"color:#0496FF;\" href=\"refresh\">%1</a>")
.arg(refreshLink));
return html;
}
void SeratoFeature::refreshLibraryModels() {
}
void SeratoFeature::activate() {
qDebug() << "SeratoFeature::activate()";
// Let a worker thread do the parsing
m_databasesFuture = QtConcurrent::run(findSeratoDatabases);
m_databasesFutureWatcher.setFuture(m_databasesFuture);
m_title = tr("(loading) Serato");