-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
Copy pathmetadatasourcetaglib.cpp
694 lines (625 loc) · 25.5 KB
/
metadatasourcetaglib.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
#include "sources/metadatasourcetaglib.h"
#include <taglib/opusfile.h>
#include <taglib/vorbisfile.h>
#include <QFile>
#include <QFileInfo>
#include <QThread>
#include <memory>
#include "track/taglib/trackmetadata.h"
#include "util/logger.h"
#include "util/safelywritablefile.h"
namespace mixxx {
namespace {
Logger kLogger("MetadataSourceTagLib");
// Workaround for missing functionality in TagLib 1.11.x that
// doesn't support to read text chunks from AIFF files.
// See also:
// http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/AIFF/AIFF.html
// http://paulbourke.net/dataformats/audio/
//
//
class AiffFile : public TagLib::RIFF::AIFF::File {
public:
explicit AiffFile(TagLib::FileName fileName)
: TagLib::RIFF::AIFF::File(fileName) {
}
bool importTrackMetadataFromTextChunks(TrackMetadata* pTrackMetadata) /*non-const*/ {
if (pTrackMetadata == nullptr) {
return false; // nothing to do
}
bool imported = false;
for (unsigned int i = 0; i < chunkCount(); ++i) {
const TagLib::ByteVector chunkId(TagLib::RIFF::AIFF::File::chunkName(i));
if (chunkId == "NAME") {
pTrackMetadata->refTrackInfo().setTitle(decodeChunkText(
TagLib::RIFF::AIFF::File::chunkData(i)));
imported = true;
} else if (chunkId == "AUTH") {
pTrackMetadata->refTrackInfo().setArtist(decodeChunkText(
TagLib::RIFF::AIFF::File::chunkData(i)));
imported = true;
} else if (chunkId == "ANNO") {
pTrackMetadata->refTrackInfo().setComment(decodeChunkText(
TagLib::RIFF::AIFF::File::chunkData(i)));
imported = true;
}
}
return imported;
}
private:
// From the specs: 13. TEXT CHUNKS - NAME, AUTHOR, COPYRIGHT, ANNOTATION
// "text: contains pure ASCII characters"
static QString decodeChunkText(const TagLib::ByteVector& chunkData) {
return QString::fromLatin1(chunkData.data(), chunkData.size());
}
};
} // anonymous namespace
std::pair<MetadataSourceTagLib::ImportResult, QDateTime>
MetadataSourceTagLib::afterImport(ImportResult importResult) const {
const auto sourceSynchronizedAt =
MetadataSource::getFileSynchronizedAt(QFile(m_fileName));
DEBUG_ASSERT(sourceSynchronizedAt.isValid() ||
importResult != ImportResult::Succeeded);
return std::make_pair(importResult, sourceSynchronizedAt);
}
std::pair<MetadataSourceTagLib::ExportResult, QDateTime>
MetadataSourceTagLib::afterExport(ExportResult exportResult) const {
const auto sourceSynchronizedAt =
MetadataSource::getFileSynchronizedAt(QFile(m_fileName));
DEBUG_ASSERT(sourceSynchronizedAt.isValid() ||
exportResult != ExportResult::Succeeded);
return std::make_pair(exportResult, sourceSynchronizedAt);
}
std::pair<MetadataSource::ImportResult, QDateTime>
MetadataSourceTagLib::importTrackMetadataAndCoverImage(
TrackMetadata* pTrackMetadata,
QImage* pCoverImage,
bool resetMissingTagMetadata) const {
VERIFY_OR_DEBUG_ASSERT(pTrackMetadata || pCoverImage) {
kLogger.warning()
<< "Nothing to import"
<< "from file" << m_fileName
<< "with type" << m_fileType;
return afterImport(ImportResult::Unavailable);
}
if (kLogger.traceEnabled()) {
kLogger.trace() << "Importing"
<< ((pTrackMetadata && pCoverImage) ? "track metadata and cover art" : (pTrackMetadata ? "track metadata" : "cover art"))
<< "from file" << m_fileName
<< "with type" << m_fileType;
}
// Rationale: If a file contains different types of tags only
// a single type of tag will be read. Tag types are read in a
// fixed order. Both track metadata and cover art will be read
// from the same tag types. Only the first available tag type
// is read and data in subsequent tags is ignored.
switch (m_fileType) {
case taglib::FileType::MP3: {
TagLib::MPEG::File file(TAGLIB_FILENAME_FROM_QSTRING(m_fileName));
if (!taglib::readAudioPropertiesFromFile(pTrackMetadata, file)) {
break;
}
// ID3v2 tag takes precedence over APE tag
if (taglib::hasID3v2Tag(file)) {
const TagLib::ID3v2::Tag* pTag = file.ID3v2Tag();
DEBUG_ASSERT(pTag);
taglib::id3v2::importTrackMetadataFromTag(
pTrackMetadata, *pTag, resetMissingTagMetadata);
taglib::id3v2::importCoverImageFromTag(pCoverImage, *pTag);
return afterImport(ImportResult::Succeeded);
} else if (taglib::hasAPETag(file)) {
const TagLib::APE::Tag* pTag = file.APETag();
DEBUG_ASSERT(pTag);
taglib::ape::importTrackMetadataFromTag(pTrackMetadata, *pTag, resetMissingTagMetadata);
taglib::ape::importCoverImageFromTag(pCoverImage, *pTag);
return afterImport(ImportResult::Succeeded);
} else if (taglib::hasID3v1Tag(file)) {
// Note (TagLib 1.1.11): TagLib::MPEG::File::tag() returns a
// valid pointer even if neither an ID3v2 nor an ID3v1 tag is
// present!
// See also: https://github.com/mixxxdj/mixxx/issues/9891
const TagLib::Tag* pTag = file.tag();
if (pTag) {
taglib::importTrackMetadataFromTag(pTrackMetadata, *pTag);
return afterImport(ImportResult::Succeeded);
}
}
break;
}
case taglib::FileType::MP4: {
TagLib::MP4::File file(TAGLIB_FILENAME_FROM_QSTRING(m_fileName));
if (!taglib::readAudioPropertiesFromFile(pTrackMetadata, file)) {
break;
}
if (taglib::hasMP4Tag(file)) {
const TagLib::MP4::Tag* pTag = file.tag();
DEBUG_ASSERT(pTag);
taglib::mp4::importTrackMetadataFromTag(pTrackMetadata, *pTag, resetMissingTagMetadata);
taglib::mp4::importCoverImageFromTag(pCoverImage, *pTag);
return afterImport(ImportResult::Succeeded);
}
break;
}
case taglib::FileType::FLAC: {
TagLib::FLAC::File file(TAGLIB_FILENAME_FROM_QSTRING(m_fileName));
if (!taglib::readAudioPropertiesFromFile(pTrackMetadata, file)) {
break;
}
bool importSucceeded = false;
bool coverImageImported = false;
// VorbisComment tag takes precedence over ID3v2 tag
if (taglib::hasXiphComment(file)) {
TagLib::Ogg::XiphComment* pTag = file.xiphComment();
DEBUG_ASSERT(pTag);
taglib::xiph::importTrackMetadataFromTag(pTrackMetadata,
*pTag,
taglib::FileType::FLAC,
resetMissingTagMetadata);
coverImageImported = taglib::xiph::importCoverImageFromTag(pCoverImage, *pTag);
importSucceeded = true;
} else if (taglib::hasID3v2Tag(file)) {
const TagLib::ID3v2::Tag* pTag = file.ID3v2Tag();
DEBUG_ASSERT(pTag);
taglib::id3v2::importTrackMetadataFromTag(
pTrackMetadata, *pTag, resetMissingTagMetadata);
coverImageImported = taglib::id3v2::importCoverImageFromTag(pCoverImage, *pTag);
importSucceeded = true;
}
// Only import cover images from picture list as a fallback if file tags
// are available but no cover image has been found yet! Otherwise until
// file tags have been successfully imported once, Mixxx would retry to
// import the missing file tags over and over again when loading the
// cover image.
if (pCoverImage && // cover image is requested
importSucceeded &&
!coverImageImported) { // no cover image found in file tags
// Read cover art directly from the file as a fallback
*pCoverImage = taglib::xiph::importCoverImageFromPictureList(file.pictureList());
}
if (importSucceeded) {
return afterImport(ImportResult::Succeeded);
}
break;
}
case taglib::FileType::OGG: {
TagLib::Ogg::Vorbis::File file(TAGLIB_FILENAME_FROM_QSTRING(m_fileName));
if (!taglib::readAudioPropertiesFromFile(pTrackMetadata, file)) {
break;
}
TagLib::Ogg::XiphComment* pTag = file.tag();
if (pTag) {
taglib::xiph::importTrackMetadataFromTag(pTrackMetadata,
*pTag,
taglib::FileType::OGG,
resetMissingTagMetadata);
taglib::xiph::importCoverImageFromTag(pCoverImage, *pTag);
return afterImport(ImportResult::Succeeded);
}
break;
}
case taglib::FileType::OPUS: {
TagLib::Ogg::Opus::File file(TAGLIB_FILENAME_FROM_QSTRING(m_fileName));
if (!taglib::readAudioPropertiesFromFile(pTrackMetadata, file)) {
break;
}
TagLib::Ogg::XiphComment* pTag = file.tag();
if (pTag) {
taglib::xiph::importTrackMetadataFromTag(pTrackMetadata,
*pTag,
taglib::FileType::OPUS,
resetMissingTagMetadata);
taglib::xiph::importCoverImageFromTag(pCoverImage, *pTag);
return afterImport(ImportResult::Succeeded);
}
break;
}
case taglib::FileType::WV: {
TagLib::WavPack::File file(TAGLIB_FILENAME_FROM_QSTRING(m_fileName));
if (!taglib::readAudioPropertiesFromFile(pTrackMetadata, file)) {
break;
}
if (taglib::hasAPETag(file)) {
const TagLib::APE::Tag* pTag = file.APETag();
DEBUG_ASSERT(pTag);
taglib::ape::importTrackMetadataFromTag(pTrackMetadata, *pTag, resetMissingTagMetadata);
taglib::ape::importCoverImageFromTag(pCoverImage, *pTag);
return afterImport(ImportResult::Succeeded);
}
break;
}
case taglib::FileType::WAV: {
TagLib::RIFF::WAV::File file(TAGLIB_FILENAME_FROM_QSTRING(m_fileName));
if (!taglib::readAudioPropertiesFromFile(pTrackMetadata, file)) {
break;
}
if (taglib::hasID3v2Tag(file)) {
const TagLib::ID3v2::Tag* pTag = file.ID3v2Tag();
DEBUG_ASSERT(pTag);
taglib::id3v2::importTrackMetadataFromTag(
pTrackMetadata, *pTag, resetMissingTagMetadata);
taglib::id3v2::importCoverImageFromTag(pCoverImage, *pTag);
return afterImport(ImportResult::Succeeded);
} else if (file.hasInfoTag()) {
const TagLib::RIFF::Info::Tag* pTag = file.InfoTag();
DEBUG_ASSERT(pTag);
taglib::riff::importTrackMetadataFromTag(pTrackMetadata, *pTag);
return afterImport(ImportResult::Succeeded);
}
break;
}
case taglib::FileType::AIFF: {
AiffFile file(TAGLIB_FILENAME_FROM_QSTRING(m_fileName));
if (!taglib::readAudioPropertiesFromFile(pTrackMetadata, file)) {
break;
}
if (taglib::hasID3v2Tag(file)) {
const TagLib::ID3v2::Tag* pTag = file.tag();
DEBUG_ASSERT(pTag);
taglib::id3v2::importTrackMetadataFromTag(
pTrackMetadata, *pTag, resetMissingTagMetadata);
taglib::id3v2::importCoverImageFromTag(pCoverImage, *pTag);
return afterImport(ImportResult::Succeeded);
} else if (file.importTrackMetadataFromTextChunks(pTrackMetadata)) {
return afterImport(ImportResult::Succeeded);
}
break;
}
default:
kLogger.warning()
<< "Cannot import track metadata"
<< "from file" << m_fileName
<< "with unknown or unsupported type" << m_fileType;
return afterImport(ImportResult::Failed);
}
kLogger.info()
<< "No track metadata or cover art found"
<< "in file" << m_fileName
<< "with type" << m_fileType;
return afterImport(ImportResult::Unavailable);
}
namespace {
// Encapsulates subtle differences between TagLib::File::save()
// and variants of this function in derived subclasses.
class TagSaver {
public:
virtual ~TagSaver() = default;
virtual bool hasModifiedTags() const = 0;
virtual bool saveModifiedTags() = 0;
};
class MpegTagSaver : public TagSaver {
public:
MpegTagSaver(const QString& fileName, const TrackMetadata& trackMetadata)
: m_file(TAGLIB_FILENAME_FROM_QSTRING(fileName)),
m_modifiedTagsBitmask(exportTrackMetadata(&m_file, trackMetadata)) {
}
~MpegTagSaver() override = default;
bool hasModifiedTags() const override {
return m_modifiedTagsBitmask != TagLib::MPEG::File::NoTags;
}
bool saveModifiedTags() override {
DEBUG_ASSERT(hasModifiedTags());
#if (TAGLIB_MAJOR_VERSION == 1) && (TAGLIB_MINOR_VERSION < 12)
// NOTE(uklotzde, 2016-08-28): Only save the tags that have
// actually been modified! Otherwise TagLib 1.11 adds unwanted
// ID3v1 tags, even if the file does not already contain those
// legacy tags.
return m_file.save(m_modifiedTagsBitmask);
#else
// Keep ID3v1 tag synchronized if it already exists in the file
const auto duplicateTags =
m_file.hasID3v1Tag()
? TagLib::File::DuplicateTags::Duplicate
: TagLib::File::DuplicateTags::DoNotDuplicate;
return m_file.save(
m_modifiedTagsBitmask,
TagLib::File::StripTags::StripNone,
TagLib::ID3v2::Version::v4,
duplicateTags);
#endif
}
private:
static int exportTrackMetadata(TagLib::MPEG::File* pFile, const TrackMetadata& trackMetadata) {
int modifiedTagsBitmask = TagLib::MPEG::File::NoTags;
if (pFile->isOpen()) {
TagLib::ID3v2::Tag* pID3v2Tag = nullptr;
if (taglib::hasAPETag(*pFile)) {
if (taglib::ape::exportTrackMetadataIntoTag(pFile->APETag(), trackMetadata)) {
modifiedTagsBitmask |= TagLib::MPEG::File::APE;
}
// Only write ID3v2 tag if it already exists.
if (pFile->hasID3v2Tag()) {
pID3v2Tag = pFile->ID3v2Tag(false);
DEBUG_ASSERT(pID3v2Tag);
}
} else {
// Get or create ID3v2 tag
pID3v2Tag = pFile->ID3v2Tag(true);
DEBUG_ASSERT(pID3v2Tag);
}
if (taglib::id3v2::exportTrackMetadataIntoTag(pID3v2Tag, trackMetadata)) {
modifiedTagsBitmask |= TagLib::MPEG::File::ID3v2;
}
}
return modifiedTagsBitmask;
}
TagLib::MPEG::File m_file;
int m_modifiedTagsBitmask;
};
class Mp4TagSaver : public TagSaver {
public:
Mp4TagSaver(const QString& fileName, const TrackMetadata& trackMetadata)
: m_file(TAGLIB_FILENAME_FROM_QSTRING(fileName)),
m_modifiedTags(exportTrackMetadata(&m_file, trackMetadata)) {
}
~Mp4TagSaver() override = default;
bool hasModifiedTags() const override {
return m_modifiedTags;
}
bool saveModifiedTags() override {
return m_file.save();
}
private:
static bool exportTrackMetadata(TagLib::MP4::File* pFile, const TrackMetadata& trackMetadata) {
return pFile->isOpen() && taglib::mp4::exportTrackMetadataIntoTag(pFile->tag(), trackMetadata);
}
TagLib::MP4::File m_file;
bool m_modifiedTags;
};
class FlacTagSaver : public TagSaver {
public:
FlacTagSaver(const QString& fileName, const TrackMetadata& trackMetadata)
: m_file(TAGLIB_FILENAME_FROM_QSTRING(fileName)),
m_modifiedTags(exportTrackMetadata(&m_file, trackMetadata)) {
}
~FlacTagSaver() override = default;
bool hasModifiedTags() const override {
return m_modifiedTags;
}
bool saveModifiedTags() override {
return m_file.save();
}
private:
static bool exportTrackMetadata(TagLib::FLAC::File* pFile, const TrackMetadata& trackMetadata) {
bool modifiedTags = false;
if (pFile->isOpen()) {
TagLib::Ogg::XiphComment* pXiphComment = nullptr;
if (taglib::hasID3v2Tag(*pFile)) {
modifiedTags |= taglib::id3v2::exportTrackMetadataIntoTag(pFile->ID3v2Tag(), trackMetadata);
// Only write VorbisComment tag if it already exists
if (taglib::hasXiphComment(*pFile)) {
pXiphComment = pFile->xiphComment(false);
DEBUG_ASSERT(pXiphComment);
}
} else {
// Get or create VorbisComment tag
pXiphComment = pFile->xiphComment(true);
DEBUG_ASSERT(pXiphComment);
}
modifiedTags |= taglib::xiph::exportTrackMetadataIntoTag(
pXiphComment, trackMetadata, taglib::FileType::FLAC);
}
return modifiedTags;
}
TagLib::FLAC::File m_file;
bool m_modifiedTags;
};
class OggTagSaver : public TagSaver {
public:
OggTagSaver(const QString& fileName, const TrackMetadata& trackMetadata)
: m_file(TAGLIB_FILENAME_FROM_QSTRING(fileName)),
m_modifiedTags(exportTrackMetadata(&m_file, trackMetadata)) {
}
~OggTagSaver() override = default;
bool hasModifiedTags() const override {
return m_modifiedTags;
}
bool saveModifiedTags() override {
return m_file.save();
}
private:
static bool exportTrackMetadata(TagLib::Ogg::Vorbis::File* pFile,
const TrackMetadata& trackMetadata) {
#if (TAGLIB_MAJOR_VERSION == 1) && (TAGLIB_MINOR_VERSION == 11) && \
(TAGLIB_PATCH_VERSION == 1)
// TagLib 1.11.1 suffers from a serious bug that corrupts OGG files
// when writing tags: https://github.com/taglib/taglib/issues/864
// Launchpad issue: https://github.com/mixxxdj/mixxx/issues/9680
Q_UNUSED(pFile);
Q_UNUSED(trackMetadata);
kLogger.warning() << "Skipping export of metadata into Ogg file due to "
"serious bug in TagLib 1.11.1 "
"(https://github.com/taglib/taglib/issues/864)";
return false;
#else
return pFile->isOpen() &&
taglib::xiph::exportTrackMetadataIntoTag(
pFile->tag(), trackMetadata, taglib::FileType::OGG);
#endif
}
TagLib::Ogg::Vorbis::File m_file;
bool m_modifiedTags;
};
class OpusTagSaver : public TagSaver {
public:
OpusTagSaver(const QString& fileName, const TrackMetadata& trackMetadata)
: m_file(TAGLIB_FILENAME_FROM_QSTRING(fileName)),
m_modifiedTags(exportTrackMetadata(&m_file, trackMetadata)) {
}
~OpusTagSaver() override = default;
bool hasModifiedTags() const override {
return m_modifiedTags;
}
bool saveModifiedTags() override {
return m_file.save();
}
private:
static bool exportTrackMetadata(TagLib::Ogg::Opus::File* pFile,
const TrackMetadata& trackMetadata) {
return pFile->isOpen() &&
taglib::xiph::exportTrackMetadataIntoTag(
pFile->tag(), trackMetadata, taglib::FileType::OPUS);
}
TagLib::Ogg::Opus::File m_file;
bool m_modifiedTags;
};
class WavPackTagSaver : public TagSaver {
public:
WavPackTagSaver(const QString& fileName, const TrackMetadata& trackMetadata)
: m_file(TAGLIB_FILENAME_FROM_QSTRING(fileName)),
m_modifiedTags(exportTrackMetadata(&m_file, trackMetadata)) {
}
~WavPackTagSaver() override = default;
bool hasModifiedTags() const override {
return m_modifiedTags;
}
bool saveModifiedTags() override {
return m_file.save();
}
private:
static bool exportTrackMetadata(TagLib::WavPack::File* pFile, const TrackMetadata& trackMetadata) {
return pFile->isOpen() && taglib::ape::exportTrackMetadataIntoTag(pFile->APETag(true), trackMetadata);
}
TagLib::WavPack::File m_file;
bool m_modifiedTags;
};
bool exportTrackMetadataIntoRIFFTag(TagLib::RIFF::Info::Tag* pTag, const TrackMetadata& trackMetadata) {
if (!pTag) {
return false;
}
taglib::exportTrackMetadataIntoTag(pTag, trackMetadata, taglib::WriteTagFlag::OmitNone);
return true;
}
class WavTagSaver : public TagSaver {
public:
WavTagSaver(const QString& fileName, const TrackMetadata& trackMetadata)
: m_file(TAGLIB_FILENAME_FROM_QSTRING(fileName)),
m_modifiedTags(exportTrackMetadata(&m_file, trackMetadata)) {
}
~WavTagSaver() override = default;
bool hasModifiedTags() const override {
return m_modifiedTags;
}
bool saveModifiedTags() override {
return m_file.save();
}
private:
static bool exportTrackMetadata(TagLib::RIFF::WAV::File* pFile, const TrackMetadata& trackMetadata) {
bool modifiedTags = false;
if (pFile->isOpen()) {
TagLib::RIFF::Info::Tag* pInfoTag = nullptr;
// Write into all available tags
if (pFile->hasID3v2Tag()) {
modifiedTags |= taglib::id3v2::exportTrackMetadataIntoTag(
pFile->ID3v2Tag(), trackMetadata);
// Only write Info tag if it already exists
if (pFile->hasInfoTag()) {
pInfoTag = pFile->InfoTag();
DEBUG_ASSERT(pInfoTag);
}
} else {
// Get or create Info tag
pInfoTag = pFile->InfoTag();
DEBUG_ASSERT(pInfoTag);
}
modifiedTags |= exportTrackMetadataIntoRIFFTag(pInfoTag, trackMetadata);
}
return modifiedTags;
}
TagLib::RIFF::WAV::File m_file;
bool m_modifiedTags;
};
class AiffTagSaver : public TagSaver {
public:
AiffTagSaver(const QString& fileName, const TrackMetadata& trackMetadata)
: m_file(TAGLIB_FILENAME_FROM_QSTRING(fileName)),
m_modifiedTags(exportTrackMetadata(&m_file, trackMetadata)) {
}
~AiffTagSaver() override = default;
bool hasModifiedTags() const override {
return m_modifiedTags;
}
bool saveModifiedTags() override {
return m_file.save();
}
private:
static bool exportTrackMetadata(TagLib::RIFF::AIFF::File* pFile, const TrackMetadata& trackMetadata) {
return pFile->isOpen() && taglib::id3v2::exportTrackMetadataIntoTag(pFile->tag(), trackMetadata);
}
TagLib::RIFF::AIFF::File m_file;
bool m_modifiedTags;
};
} // anonymous namespace
std::pair<MetadataSource::ExportResult, QDateTime>
MetadataSourceTagLib::exportTrackMetadata(
const TrackMetadata& trackMetadata) const {
// Modifying an external file is a potentially dangerous operation.
// If this operation unexpectedly crashes or corrupts data we need
// to identify the file that is affected.
kLogger.info() << "Exporting track metadata into file:" << m_fileName;
SafelyWritableFile safelyWritableFile(m_fileName,
SafelyWritableFile::SafetyMode::Edit);
if (!safelyWritableFile.isReady()) {
kLogger.warning()
<< "Unable to export track metadata into file"
<< m_fileName
<< "- Please check file permissions and storage space";
return afterExport(ExportResult::Failed);
}
std::unique_ptr<TagSaver> pTagSaver;
switch (m_fileType) {
case taglib::FileType::MP3: {
pTagSaver = std::make_unique<MpegTagSaver>(safelyWritableFile.fileName(), trackMetadata);
break;
}
case taglib::FileType::MP4: {
pTagSaver = std::make_unique<Mp4TagSaver>(safelyWritableFile.fileName(), trackMetadata);
break;
}
case taglib::FileType::FLAC: {
pTagSaver = std::make_unique<FlacTagSaver>(safelyWritableFile.fileName(), trackMetadata);
break;
}
case taglib::FileType::OGG: {
pTagSaver = std::make_unique<OggTagSaver>(safelyWritableFile.fileName(), trackMetadata);
break;
}
case taglib::FileType::OPUS: {
pTagSaver = std::make_unique<OpusTagSaver>(safelyWritableFile.fileName(), trackMetadata);
break;
}
case taglib::FileType::WV: {
pTagSaver = std::make_unique<WavPackTagSaver>(safelyWritableFile.fileName(), trackMetadata);
break;
}
case taglib::FileType::WAV: {
pTagSaver = std::make_unique<WavTagSaver>(safelyWritableFile.fileName(), trackMetadata);
break;
}
case taglib::FileType::AIFF: {
pTagSaver = std::make_unique<AiffTagSaver>(safelyWritableFile.fileName(), trackMetadata);
break;
}
default:
kLogger.debug()
<< "Cannot export track metadata"
<< "into file" << m_fileName
<< "with unknown or unsupported type"
<< m_fileType;
return afterExport(ExportResult::Unsupported);
}
if (pTagSaver->hasModifiedTags()) {
if (pTagSaver->saveModifiedTags()) {
// Close all file handles after modified tags have been saved into the temporary file!
pTagSaver.reset();
// Now we can safely replace the original file with the temporary file
if (safelyWritableFile.commit()) {
return afterExport(ExportResult::Succeeded);
}
}
kLogger.warning() << "Failed to save tags of file" << m_fileName;
} else {
kLogger.warning() << "Failed to modify tags of file" << m_fileName;
}
return afterExport(ExportResult::Failed);
}
} // namespace mixxx