-
Notifications
You must be signed in to change notification settings - Fork 17
/
mediafileinfo.cpp
1930 lines (1809 loc) · 71.8 KB
/
mediafileinfo.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 "./mediafileinfo.h"
#include "./abstracttrack.h"
#include "./backuphelper.h"
#include "./diagnostics.h"
#include "./exceptions.h"
#include "./locale.h"
#include "./progressfeedback.h"
#include "./signature.h"
#include "./tag.h"
#include "./id3/id3v1tag.h"
#include "./id3/id3v2tag.h"
#include "./wav/waveaudiostream.h"
#include "./mpegaudio/mpegaudioframestream.h"
#include "./adts/adtsstream.h"
#include "./ivf/ivfstream.h"
#include "./mp4/mp4atom.h"
#include "./mp4/mp4container.h"
#include "./mp4/mp4ids.h"
#include "./mp4/mp4tag.h"
#include "./mp4/mp4track.h"
#include "./matroska/ebmlelement.h"
#include "./matroska/matroskacontainer.h"
#include "./matroska/matroskatag.h"
#include "./matroska/matroskatrack.h"
#include "./ogg/oggcontainer.h"
#include "./flac/flacmetadata.h"
#include "./flac/flacstream.h"
#include <c++utilities/chrono/timespan.h>
#include <c++utilities/conversion/stringconversion.h>
#include <c++utilities/io/path.h>
#include <algorithm>
#include <cstdint>
#include <cstdio>
#include <filesystem>
#include <functional>
#include <iomanip>
#include <ios>
#include <memory>
#include <system_error>
using namespace std;
using namespace std::placeholders;
using namespace CppUtilities;
/*!
* \namespace IoUtilities
* \brief Contains utility classes helping to read and write streams.
*/
namespace TagParser {
/// \brief The MediaFileInfoPrivate struct contains private fields of the MediaFileInfo class.
struct MediaFileInfoPrivate {};
/*!
* \class TagParser::MediaFileInfo
* \brief The MediaFileInfo class allows to read and write tag information providing
* a container/tag format independent interface.
*
* It also provides some technical information such as contained streams.
*
* For examples see "cli/mainfeatures.cpp" of the tageditor repository.
*/
/*!
* \brief Constructs a new MediaFileInfo for the specified file.
*
* \param path Specifies the absolute or relative path of the file.
*/
MediaFileInfo::MediaFileInfo(std::string &&path)
: BasicFileInfo(std::move(path))
, m_containerParsingStatus(ParsingStatus::NotParsedYet)
, m_containerFormat(ContainerFormat::Unknown)
, m_containerOffset(0)
, m_paddingSize(0)
, m_effectiveSize(0)
, m_fileStructureFlags(MediaFileStructureFlags::None)
, m_tracksParsingStatus(ParsingStatus::NotParsedYet)
, m_tagsParsingStatus(ParsingStatus::NotParsedYet)
, m_chaptersParsingStatus(ParsingStatus::NotParsedYet)
, m_attachmentsParsingStatus(ParsingStatus::NotParsedYet)
, m_minPadding(0)
, m_maxPadding(0)
, m_preferredPadding(0)
, m_tagPosition(ElementPosition::BeforeData)
, m_indexPosition(ElementPosition::BeforeData)
, m_fileHandlingFlags(MediaFileHandlingFlags::ForceRewrite | MediaFileHandlingFlags::ForceTagPosition | MediaFileHandlingFlags::ForceIndexPosition
| MediaFileHandlingFlags::NormalizeKnownTagFieldIds | MediaFileHandlingFlags::PreserveRawTimingValues)
, m_maxFullParseSize(0x3200000)
{
}
/*!
* \brief Constructs a new MediaFileInfo.
*/
MediaFileInfo::MediaFileInfo()
: MediaFileInfo(std::string())
{
}
/*!
* \brief Constructs a new MediaFileInfo.
*/
MediaFileInfo::MediaFileInfo(std::string_view path)
: MediaFileInfo(std::string(path))
{
}
/*!
* \brief Destroys the MediaFileInfo.
*/
MediaFileInfo::~MediaFileInfo()
{
}
/*!
* \brief Parses the container format of the current file.
*
* This method parses the container of the current file format if it has not been
* parsed yet.
*
* After calling this method the methods containerFormat(), containerFormatName(),
* containerFormatAbbreviation(), containerFormatSubversion(), containerMimeType(),
* container(), mp4Container() and matroskaContainer() will return the parsed
* information.
* \throws Throws std::ios_base::failure when an IO error occurs.
* \sa isContainerParsed(), parseTracks(), parseTag(), parseChapters(), parseEverything()
*/
void MediaFileInfo::parseContainerFormat(Diagnostics &diag, AbortableProgressFeedback &progress)
{
CPP_UTILITIES_UNUSED(progress)
// skip if container format already parsed
if (containerParsingStatus() != ParsingStatus::NotParsedYet) {
return;
}
static const string context("parsing file header");
open(); // ensure the file is open
m_containerFormat = ContainerFormat::Unknown;
// file size
m_paddingSize = 0;
m_containerOffset = 0;
std::size_t bytesSkippedBeforeContainer = 0;
std::streamoff id3v2Size = 0;
// read signatrue
char buff[16];
const char *const buffEnd = buff + sizeof(buff), *buffOffset;
startParsingSignature:
if (progress.isAborted()) {
diag.emplace_back(DiagLevel::Information, "Parsing the container format has been aborted.", context);
return;
}
if (size() - containerOffset() >= 16) {
stream().seekg(m_containerOffset, ios_base::beg);
stream().read(buff, sizeof(buff));
// skip zero/junk bytes
// notes:
// - Only skipping 4 or more consecutive zero bytes at this point because some signatures start with up to 4 zero bytes.
// - It seems that most players/tools¹ skip junk bytes, at least when reading MP3 files. Hence the tagparser library is following
// the same approach. (¹e.g. ffmpeg: "[mp3 @ 0x559e1f4cbd80] Skipping 1670 bytes of junk at 1165.")
std::size_t bytesSkipped = 0;
for (buffOffset = buff; buffOffset != buffEnd && !(*buffOffset); ++buffOffset, ++bytesSkipped)
;
if (bytesSkipped >= 4) {
skipJunkBytes:
m_containerOffset += static_cast<std::streamoff>(bytesSkipped);
m_paddingSize += bytesSkipped;
// give up after 0x800 bytes
if ((bytesSkippedBeforeContainer += bytesSkipped) >= 0x800u) {
m_containerParsingStatus = ParsingStatus::NotSupported;
m_containerFormat = ContainerFormat::Unknown;
m_containerOffset = id3v2Size;
return;
}
// try again
goto startParsingSignature;
}
// parse signature
switch ((m_containerFormat = parseSignature(buff, sizeof(buff)))) {
case ContainerFormat::Id3v2Tag:
// save position of ID3v2 tag
m_actualId3v2TagOffsets.push_back(m_containerOffset);
if (m_actualId3v2TagOffsets.size() == 2) {
diag.emplace_back(DiagLevel::Warning, "There is more than just one ID3v2 header at the beginning of the file.", context);
}
// read ID3v2 header
stream().seekg(m_containerOffset + 5, ios_base::beg);
stream().read(buff, 5);
// set the container offset to skip ID3v2 header
m_containerOffset += toNormalInt(BE::toInt<std::uint32_t>(buff + 1)) + 10;
if ((*buff) & 0x10) {
// footer present
m_containerOffset += 10;
}
id3v2Size = m_containerOffset;
// continue reading signature
goto startParsingSignature;
case ContainerFormat::Mp4:
case ContainerFormat::QuickTime: {
// MP4/QuickTime is handled using Mp4Container instance
m_container = make_unique<Mp4Container>(*this, m_containerOffset);
try {
static_cast<Mp4Container *>(m_container.get())->validateElementStructure(diag, progress, &m_paddingSize);
} catch (const OperationAbortedException &) {
diag.emplace_back(DiagLevel::Information, "Validating the MP4 element structure has been aborted.", context);
} catch (const Failure &) {
m_containerParsingStatus = ParsingStatus::CriticalFailure;
}
break;
}
case ContainerFormat::Ebml: {
// EBML/Matroska is handled using MatroskaContainer instance
auto container = make_unique<MatroskaContainer>(*this, m_containerOffset);
try {
container->parseHeader(diag, progress);
if (container->documentType() == "matroska") {
m_containerFormat = ContainerFormat::Matroska;
} else if (container->documentType() == "webm") {
m_containerFormat = ContainerFormat::Webm;
}
if (isForcingFullParse()) {
// validating the element structure of Matroska files takes too long when
// parsing big files so do this only when explicitly desired
container->validateElementStructure(diag, progress, &m_paddingSize);
container->validateIndex(diag, progress);
}
} catch (const OperationAbortedException &) {
diag.emplace_back(DiagLevel::Information, "Validating the Matroska element structure has been aborted.", context);
} catch (const Failure &) {
m_containerParsingStatus = ParsingStatus::CriticalFailure;
}
m_container = std::move(container);
break;
}
case ContainerFormat::Ogg:
// Ogg is handled by OggContainer instance
m_container = make_unique<OggContainer>(*this, m_containerOffset);
static_cast<OggContainer *>(m_container.get())->setChecksumValidationEnabled(isForcingFullParse());
break;
case ContainerFormat::Unknown:
case ContainerFormat::ApeTag:
// skip APE tag if the specified size makes sense at all
if (m_containerFormat == ContainerFormat::ApeTag) {
if (const auto apeEnd = m_containerOffset + 32 + LE::toUInt32(buff + 12); apeEnd <= static_cast<std::streamoff>(size())) {
// take record of APE tag
diag.emplace_back(DiagLevel::Critical,
argsToString("Found an APE tag at the beginning of the file at offset ", m_containerOffset,
". This tag format is not supported and the tag will therefore be ignored. It will NOT be preserved when saving as "
"placing an APE tag at the beginning of a file is strongly unrecommended."),
context);
// continue reading signature
m_containerOffset = apeEnd;
goto startParsingSignature;
}
m_containerFormat = ContainerFormat::Unknown;
}
// check for magic numbers at odd offsets
// -> check for tar (magic number at offset 0x101)
if (size() > 0x107) {
stream().seekg(0x101);
stream().read(buff, 6);
if (buff[0] == 0x75 && buff[1] == 0x73 && buff[2] == 0x74 && buff[3] == 0x61 && buff[4] == 0x72 && buff[5] == 0x00) {
m_containerFormat = ContainerFormat::Tar;
break;
}
}
// skip previously determined zero-bytes or try our luck on the next byte
if (!bytesSkipped) {
++bytesSkipped;
}
goto skipJunkBytes;
default:;
}
}
if (bytesSkippedBeforeContainer) {
diag.emplace_back(DiagLevel::Warning, argsToString(bytesSkippedBeforeContainer, " bytes of junk skipped"), context);
}
// set parsing status
if (m_containerParsingStatus == ParsingStatus::NotParsedYet) {
if (m_containerFormat == ContainerFormat::Unknown) {
m_containerParsingStatus = ParsingStatus::NotSupported;
} else {
m_containerParsingStatus = ParsingStatus::Ok;
}
}
}
/*!
* \brief Parses the tracks of the current file.
*
* This method parses the tracks of the current file if not been parsed yet.
* After calling this method the methods trackCount(), tracks(), and
* hasTracksOfType() will return the parsed information.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \remarks parseContainerFormat() must be called before.
* \sa areTracksParsed(), parseContainerFormat(), parseTags(), parseChapters(), parseEverything()
*/
void MediaFileInfo::parseTracks(Diagnostics &diag, AbortableProgressFeedback &progress)
{
// skip if tracks already parsed
if (tracksParsingStatus() != ParsingStatus::NotParsedYet) {
return;
}
static const string context("parsing tracks");
try {
// parse tracks via container object
if (m_container) {
m_container->parseTracks(diag, progress);
m_tracksParsingStatus = ParsingStatus::Ok;
return;
}
// parse tracks via track object for "single-track"-formats
switch (m_containerFormat) {
case ContainerFormat::Adts:
m_singleTrack = make_unique<AdtsStream>(stream(), m_containerOffset);
break;
case ContainerFormat::Flac:
m_singleTrack = make_unique<FlacStream>(*this, m_containerOffset);
break;
case ContainerFormat::Ivf:
m_singleTrack = make_unique<IvfStream>(stream(), m_containerOffset);
break;
case ContainerFormat::MpegAudioFrames:
m_singleTrack = make_unique<MpegAudioFrameStream>(stream(), m_containerOffset);
break;
case ContainerFormat::RiffWave:
m_singleTrack = make_unique<WaveAudioStream>(stream(), m_containerOffset);
break;
default:
throw NotImplementedException();
}
if (m_containerFormat != ContainerFormat::Flac) {
// ensure the effective size has been determined
// note: This is not required for FLAC and should also be avoided as parseTags() will invoke
// parseTracks() when dealing with FLAC files.
parseTags(diag, progress);
m_singleTrack->setSize(m_effectiveSize);
}
m_singleTrack->parseHeader(diag, progress);
// take padding for some "single-track" formats into account
switch (m_containerFormat) {
case ContainerFormat::Flac:
m_paddingSize += static_cast<FlacStream *>(m_singleTrack.get())->paddingSize();
break;
default:;
}
m_tracksParsingStatus = ParsingStatus::Ok;
} catch (const NotImplementedException &) {
diag.emplace_back(DiagLevel::Information, "Parsing tracks is not implemented for the container format of the file.", context);
m_tracksParsingStatus = ParsingStatus::NotSupported;
} catch (const OperationAbortedException &) {
diag.emplace_back(DiagLevel::Information, "Parsing tracks has been aborted.", context);
} catch (const Failure &) {
diag.emplace_back(DiagLevel::Critical, "Unable to parse tracks.", context);
m_tracksParsingStatus = ParsingStatus::CriticalFailure;
}
}
/*!
* \brief Parses the tag(s) of the current file.
*
* This method parses the tag(s) of the current file if not been parsed yet.
* After calling this method the methods id3v1Tag(), id3v2Tags(),
* mp4Tag() and allTags() will return the parsed information.
*
* Previously assigned but not applied tag information will be discarted.
* \throws Throws std::ios_base::failure when an IO error occurs.
* \remarks parseContainerFormat() must be called before.
* \sa isTagParsed(), parseContainerFormat(), parseTracks(), parseChapters(), parseEverything()
*/
void MediaFileInfo::parseTags(Diagnostics &diag, AbortableProgressFeedback &progress)
{
// skip if tags already parsed
if (tagsParsingStatus() != ParsingStatus::NotParsedYet) {
return;
}
static const string context("parsing tag");
// check for ID3v1 tag
auto effectiveSize = static_cast<std::streamoff>(size());
if (effectiveSize >= 128) {
m_id3v1Tag = make_unique<Id3v1Tag>();
try {
stream().seekg(effectiveSize - 128, std::ios_base::beg);
m_id3v1Tag->parse(stream(), diag);
m_fileStructureFlags += MediaFileStructureFlags::ActualExistingId3v1Tag;
effectiveSize -= 128;
} catch (const NoDataFoundException &) {
m_id3v1Tag.reset();
} catch (const OperationAbortedException &) {
diag.emplace_back(DiagLevel::Information, "Parsing ID3v1 tag has been aborted.", context);
return;
} catch (const Failure &) {
m_tagsParsingStatus = ParsingStatus::CriticalFailure;
diag.emplace_back(DiagLevel::Critical, "Unable to parse ID3v1 tag.", context);
}
}
// check for APE tag at the end of the file (APE tags a the beginning are already covered when parsing the container format)
if (constexpr auto apeHeaderSize = 32; effectiveSize >= apeHeaderSize) {
const auto footerOffset = effectiveSize - apeHeaderSize;
char buffer[apeHeaderSize];
stream().seekg(footerOffset, std::ios_base::beg);
stream().read(buffer, sizeof(buffer));
if (BE::toInt<std::uint64_t>(buffer) == 0x4150455441474558ul /* APETAGEX */) {
// take record of APE tag
const auto tagSize = static_cast<std::streamoff>(LE::toInt<std::uint32_t>(buffer + 12));
const auto flags = LE::toInt<std::uint32_t>(buffer + 20);
// subtract tag size (footer size and contents) from effective size
if (tagSize <= effectiveSize) {
effectiveSize -= tagSize;
}
// subtract header size (not included in tag size) from effective size if flags indicate presence of header
if ((flags & 0x80000000u) && (apeHeaderSize <= effectiveSize)) {
effectiveSize -= apeHeaderSize;
}
diag.emplace_back(DiagLevel::Warning,
argsToString("Found an APE tag at the end of the file at offset ", (footerOffset - tagSize),
". This tag format is not supported and the tag will therefore be ignored. It will be preserved when saving as-is."),
context);
}
}
// check for ID3v2 tags: the offsets of the ID3v2 tags have already been parsed when parsing the container format
m_id3v2Tags.clear();
for (const auto offset : m_actualId3v2TagOffsets) {
auto id3v2Tag = make_unique<Id3v2Tag>();
stream().seekg(offset, ios_base::beg);
try {
id3v2Tag->parse(stream(), size() - static_cast<std::uint64_t>(offset), diag);
m_paddingSize += id3v2Tag->paddingSize();
} catch (const NoDataFoundException &) {
continue;
} catch (const OperationAbortedException &) {
diag.emplace_back(DiagLevel::Information, "Parsing ID3v2 tags has been aborted.", context);
return;
} catch (const Failure &) {
m_tagsParsingStatus = ParsingStatus::CriticalFailure;
diag.emplace_back(DiagLevel::Critical, "Unable to parse ID3v2 tag.", context);
}
m_id3v2Tags.emplace_back(id3v2Tag.release());
}
// compute effective size
m_effectiveSize = static_cast<std::uint64_t>(effectiveSize - m_containerOffset);
// check for tags in tracks (FLAC only) or via container object
try {
if (m_containerFormat == ContainerFormat::Flac) {
parseTracks(diag, progress);
if (m_tagsParsingStatus == ParsingStatus::NotParsedYet) {
m_tagsParsingStatus = m_tracksParsingStatus;
}
return;
} else if (m_container) {
m_container->parseTags(diag, progress);
} else if (m_containerFormat != ContainerFormat::MpegAudioFrames) {
throw NotImplementedException();
}
// set status, but do not override error/unsupported status form ID3 tags here
if (m_tagsParsingStatus == ParsingStatus::NotParsedYet) {
m_tagsParsingStatus = ParsingStatus::Ok;
}
} catch (const NotImplementedException &) {
// set status to not supported, but do not override parsing status from ID3 tags here
if (m_tagsParsingStatus == ParsingStatus::NotParsedYet) {
m_tagsParsingStatus = ParsingStatus::NotSupported;
}
diag.emplace_back(DiagLevel::Information, "Parsing tags is not implemented for the container format of the file.", context);
} catch (const OperationAbortedException &) {
diag.emplace_back(DiagLevel::Information, "Parsing tags from container/streams has been aborted.", context);
return;
} catch (const Failure &) {
m_tagsParsingStatus = ParsingStatus::CriticalFailure;
diag.emplace_back(DiagLevel::Critical, "Unable to parse tag.", context);
}
}
/*!
* \brief Parses the chapters of the current file.
*
* This method parses the chapters of the current file if not been parsed yet.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \remarks parseContainerFormat() must be called before.
* \sa areChaptersParsed(), parseContainerFormat(), parseTracks(), parseTags(), parseEverything()
*/
void MediaFileInfo::parseChapters(Diagnostics &diag, AbortableProgressFeedback &progress)
{
// skip if chapters already parsed
if (chaptersParsingStatus() != ParsingStatus::NotParsedYet) {
return;
}
static const string context("parsing chapters");
try {
// parse chapters via container object
if (!m_container) {
throw NotImplementedException();
}
m_container->parseChapters(diag, progress);
m_chaptersParsingStatus = ParsingStatus::Ok;
} catch (const NotImplementedException &) {
m_chaptersParsingStatus = ParsingStatus::NotSupported;
diag.emplace_back(DiagLevel::Information, "Parsing chapters is not implemented for the container format of the file.", context);
} catch (const Failure &) {
m_chaptersParsingStatus = ParsingStatus::CriticalFailure;
diag.emplace_back(DiagLevel::Critical, "Unable to parse chapters.", context);
}
}
/*!
* \brief Parses the attachments of the current file.
*
* This method parses the attachments of the current file if not been parsed yet.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \remarks parseContainerFormat() must be called before.
* \sa areChaptersParsed(), parseContainerFormat(), parseTracks(), parseTags(), parseEverything()
*/
void MediaFileInfo::parseAttachments(Diagnostics &diag, AbortableProgressFeedback &progress)
{
// skip if attachments already parsed
if (attachmentsParsingStatus() != ParsingStatus::NotParsedYet) {
return;
}
static const string context("parsing attachments");
try {
// parse attachments via container object
if (!m_container) {
throw NotImplementedException();
}
m_container->parseAttachments(diag, progress);
m_attachmentsParsingStatus = ParsingStatus::Ok;
} catch (const NotImplementedException &) {
m_attachmentsParsingStatus = ParsingStatus::NotSupported;
diag.emplace_back(DiagLevel::Information, "Parsing attachments is not implemented for the container format of the file.", context);
} catch (const Failure &) {
m_attachmentsParsingStatus = ParsingStatus::CriticalFailure;
diag.emplace_back(DiagLevel::Critical, "Unable to parse attachments.", context);
}
}
/*!
* \brief Parses the container format, the tracks and the tag information of the current file.
*
* See the individual methods to for more details and exceptions which might be thrown.
* \sa parseContainerFormat(), parseTracks(), parseTags()
*/
void MediaFileInfo::parseEverything(Diagnostics &diag, AbortableProgressFeedback &progress)
{
parseContainerFormat(diag, progress);
if (progress.isAborted()) {
return;
}
parseTracks(diag, progress);
if (progress.isAborted()) {
return;
}
parseTags(diag, progress);
if (progress.isAborted()) {
return;
}
parseChapters(diag, progress);
if (progress.isAborted()) {
return;
}
parseAttachments(diag, progress);
}
/*!
* \brief Ensures appropriate tags are created according the given \a settings.
* \return Returns whether appropriate tags could be created for the file.
* \remarks
* - Tags must have been parsed before invoking this method (otherwise it will just return false).
* - The ID3 related arguments are only practiced when the file format is MP3 or when the file format is unknown and \a treatUnknownFilesAsMp3Files is true.
* - Tags might be removed as well. For example the existing ID3v1 tag of an MP3 file will be removed if \a id3v1Usage is set to TagUsage::Never.
* - The method might do nothing if present tag(s) already match the given specifications.
* - This is only a convenience method. The task could be done by manually using the methods createId3v1Tag(), createId3v2Tag(), removeId3v1Tag() ... as well.
* - Some tag information might be discarded. For example when an ID3v2 tag needs to be removed (TagSettings::id3v2usage is set to TagUsage::Never) and an ID3v1 tag will be created instead not all fields can be transferred.
*/
bool MediaFileInfo::createAppropriateTags(const TagCreationSettings &settings)
{
// check if tags have been parsed yet (tags must have been parsed yet to create appropriate tags)
if (tagsParsingStatus() == ParsingStatus::NotParsedYet) {
return false;
}
// check if tags need to be created/adjusted/removed
const auto requiredTargets(settings.requiredTargets);
const auto flags(settings.flags);
const auto targetsRequired = !requiredTargets.empty() && (requiredTargets.size() != 1 || !requiredTargets.front().isEmpty());
auto targetsSupported = false;
if (areTagsSupported() && m_container) {
// container object takes care of tag management
if (targetsRequired) {
// check whether container supports targets
if (m_container->tagCount()) {
// all tags in the container should support targets if the first one supports targets
targetsSupported = m_container->tag(0)->supportsTarget();
} else {
// try to create a new tag and check whether targets are supported
auto *const tag = m_container->createTag();
if (tag && (targetsSupported = tag->supportsTarget())) {
tag->setTarget(requiredTargets.front());
}
}
if (targetsSupported) {
for (const auto &target : requiredTargets) {
m_container->createTag(target);
}
}
} else {
// no targets are required -> just ensure that at least one tag is present
m_container->createTag();
}
return true;
}
// no container object present
switch (m_containerFormat) {
case ContainerFormat::Flac:
static_cast<FlacStream *>(m_singleTrack.get())->createVorbisComment();
break;
default:
// create ID3 tag(s)
if (!hasAnyTag() && !(flags & TagCreationFlags::TreatUnknownFilesAsMp3Files)) {
switch (containerFormat()) {
case ContainerFormat::Adts:
case ContainerFormat::Aiff:
case ContainerFormat::MpegAudioFrames:
case ContainerFormat::WavPack:
break;
default:
return false;
}
}
// create ID3 tags according to id3v2usage and id3v2usage
// always create ID3v1 tag -> ensure there is one
if (settings.id3v1usage == TagUsage::Always && !id3v1Tag()) {
auto *const id3v1Tag = createId3v1Tag();
if (flags & TagCreationFlags::Id3InitOnCreate) {
for (const auto &id3v2Tag : id3v2Tags()) {
// overwrite existing values to ensure default ID3v1 genre "Blues" is updated as well
id3v1Tag->insertValues(*id3v2Tag, true);
// ID3v1 does not support all text encodings which might be used in ID3v2
id3v1Tag->ensureTextValuesAreProperlyEncoded();
}
}
}
if (settings.id3v2usage == TagUsage::Always && !hasId3v2Tag()) {
// always create ID3v2 tag -> ensure there is one and set version
auto *const id3v2Tag = createId3v2Tag();
id3v2Tag->setVersion(settings.id3v2MajorVersion, 0);
if ((flags & TagCreationFlags::Id3InitOnCreate) && id3v1Tag()) {
id3v2Tag->insertValues(*id3v1Tag(), true);
}
}
}
if (flags & TagCreationFlags::MergeMultipleSuccessiveId3v2Tags) {
mergeId3v2Tags();
}
// remove ID3 tags according to settings
if (settings.id3v1usage == TagUsage::Never && hasId3v1Tag()) {
// transfer tags to ID3v2 tag before removing
if ((flags & TagCreationFlags::Id3TransferValuesOnRemoval) && hasId3v2Tag()) {
id3v2Tags().front()->insertValues(*id3v1Tag(), false);
}
removeId3v1Tag();
}
if (settings.id3v2usage == TagUsage::Never) {
if ((flags & TagCreationFlags::Id3TransferValuesOnRemoval) && hasId3v1Tag()) {
// transfer tags to ID3v1 tag before removing
for (const auto &tag : id3v2Tags()) {
id3v1Tag()->insertValues(*tag, false);
}
}
removeAllId3v2Tags();
} else if (!(flags & TagCreationFlags::KeepExistingId3v2Version)) {
// set version of ID3v2 tag according user preferences
for (const auto &tag : id3v2Tags()) {
tag->setVersion(settings.id3v2MajorVersion, 0);
}
}
return true;
}
/*!
* \brief Applies assigned/changed tag information to the current file.
*
* This method applies previously assigned tag information to the current file.
*
* Depending on the changes to be applied the file will be rewritten.
*
* When the file needs to be rewritten it will be renamed. A new file with the old name
* will be created to replace the old file.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws TagParser::Failure or a derived exception when a making error occurs.
*
* \remarks Tags and tracks need to be parsed without errors before this method can be called.
* All previous parsing results are cleared (using clearParsingResults()). Hence
* the file must be reparsed. All related objects (tags, tracks, ...) might get invalidated.
* This includes notifications of these objects as well.
*
* \sa clearParsingResults()
*/
void MediaFileInfo::applyChanges(Diagnostics &diag, AbortableProgressFeedback &progress)
{
static const string context("making file");
diag.emplace_back(DiagLevel::Information, "Changes are about to be applied.", context);
bool previousParsingSuccessful = true;
switch (tagsParsingStatus()) {
case ParsingStatus::Ok:
case ParsingStatus::NotSupported:
break;
default:
previousParsingSuccessful = false;
diag.emplace_back(DiagLevel::Critical, "Tags have to be parsed without critical errors before changes can be applied.", context);
}
switch (tracksParsingStatus()) {
case ParsingStatus::Ok:
case ParsingStatus::NotSupported:
break;
default:
previousParsingSuccessful = false;
diag.emplace_back(DiagLevel::Critical, "Tracks have to be parsed without critical errors before changes can be applied.", context);
}
if (!previousParsingSuccessful) {
throw InvalidDataException();
}
if (m_container) { // container object takes care
// ID3 tags can not be applied in this case -> add warnings if ID3 tags have been assigned
if (hasId3v1Tag()) {
diag.emplace_back(DiagLevel::Warning, "Assigned ID3v1 tag can't be attached and will be ignored.", context);
}
if (hasId3v2Tag()) {
diag.emplace_back(DiagLevel::Warning, "Assigned ID3v2 tag can't be attached and will be ignored.", context);
}
m_tracksParsingStatus = ParsingStatus::NotParsedYet;
m_tagsParsingStatus = ParsingStatus::NotParsedYet;
try {
m_container->makeFile(diag, progress);
} catch (...) {
// since the file might be messed up, invalidate the parsing results
clearParsingResults();
throw;
}
} else { // implementation if no container object is present
// assume the file is a MP3 file
try {
makeMp3File(diag, progress);
} catch (...) {
// since the file might be messed up, invalidate the parsing results
clearParsingResults();
throw;
}
}
clearParsingResults();
}
/*!
* \brief Returns the abbreviation of the container format as C-style string.
*
* This abbreviation might be used as file extension.
*
* parseContainerFormat() needs to be called before. Otherwise
* always an empty string will be returned.
*
* \sa containerFormat()
* \sa containerFormatName()
* \sa parseContainerFormat()
*/
string_view MediaFileInfo::containerFormatAbbreviation() const
{
MediaType mediaType = MediaType::Unknown;
unsigned int version = 0;
switch (m_containerFormat) {
case ContainerFormat::Ogg: {
// check for video track or whether only Opus or Speex tracks are present
const auto &tracks = static_cast<OggContainer *>(m_container.get())->tracks();
if (tracks.empty()) {
break;
}
bool onlyOpus = true, onlySpeex = true;
for (const auto &track : static_cast<OggContainer *>(m_container.get())->tracks()) {
if (track->mediaType() == MediaType::Video) {
mediaType = MediaType::Video;
}
if (track->format().general != GeneralMediaFormat::Opus) {
onlyOpus = false;
}
if (track->format().general != GeneralMediaFormat::Speex) {
onlySpeex = false;
}
}
if (onlyOpus) {
version = static_cast<unsigned int>(GeneralMediaFormat::Opus);
} else if (onlySpeex) {
version = static_cast<unsigned int>(GeneralMediaFormat::Speex);
}
break;
}
case ContainerFormat::Matroska:
case ContainerFormat::Mp4:
mediaType = hasTracksOfType(MediaType::Video) ? MediaType::Video : MediaType::Audio;
break;
case ContainerFormat::MpegAudioFrames:
if (m_singleTrack) {
version = m_singleTrack->format().sub;
}
break;
default:;
}
return TagParser::containerFormatAbbreviation(m_containerFormat, mediaType, version);
}
/*!
* \brief Returns the MIME-type of the container format as C-style string.
*
* parseContainerFormat() needs to be called before. Otherwise
* always an empty string will be returned.
*
* \sa containerFormat()
* \sa containerFormatName()
* \sa parseContainerFormat()
*/
string_view MediaFileInfo::mimeType() const
{
MediaType mediaType;
switch (m_containerFormat) {
case ContainerFormat::Mp4:
case ContainerFormat::Ogg:
case ContainerFormat::Matroska:
mediaType = hasTracksOfType(MediaType::Video) ? MediaType::Video : MediaType::Audio;
break;
default:
mediaType = MediaType::Unknown;
}
return TagParser::containerMimeType(m_containerFormat, mediaType);
}
/*!
* \brief Returns the tracks for the current file.
*
* parseTracks() needs to be called before. Otherwise this
* method always returns an empty vector.
*
* \remarks The MediaFileInfo keeps the ownership over the returned
* pointers. The returned Tracks will be destroyed when the
* MediaFileInfo is invalidated.
*
* \sa parseTracks()
*/
vector<AbstractTrack *> MediaFileInfo::tracks() const
{
vector<AbstractTrack *> res;
size_t trackCount = 0;
size_t containerTrackCount = 0;
if (m_singleTrack) {
trackCount = 1;
}
if (m_container) {
trackCount += (containerTrackCount = m_container->trackCount());
}
res.reserve(trackCount);
if (m_singleTrack) {
res.push_back(m_singleTrack.get());
}
for (size_t i = 0; i != containerTrackCount; ++i) {
res.push_back(m_container->track(i));
}
return res;
}
/*!
* \brief Returns an indication whether the current file has tracks of the specified \a type.
*
* parseTracks() needs to be called before. Otherwise this
* method always returns false.
*
* \sa parseTracks()
*/
bool MediaFileInfo::hasTracksOfType(MediaType type) const
{
if (tracksParsingStatus() == ParsingStatus::NotParsedYet) {
return false;
}
if (m_singleTrack && m_singleTrack->mediaType() == type) {
return true;
} else if (m_container) {
for (size_t i = 0, count = m_container->trackCount(); i != count; ++i) {
if (m_container->track(i)->mediaType() == type) {
return true;
}
}
}
return false;
}
/*!
* \brief Returns the overall duration of the file if known; otherwise
* returns a TimeSpan with zero ticks.
*
* parseTracks() needs to be called before. Otherwise this
* method always returns false.
*
* \sa parseTracks()
*/
CppUtilities::TimeSpan MediaFileInfo::duration() const
{
if (m_container) {
return m_container->duration();
} else if (m_singleTrack) {
return m_singleTrack->duration();
}
return TimeSpan();
}
/*!
* \brief Returns the overall average bitrate in kbit/s of the file if known; otherwise
* returns 0.0.
*
* parseTracks() needs to be called before. Otherwise this
* method always returns false.
*
* \sa parseTracks()
*/
double MediaFileInfo::overallAverageBitrate() const
{
const auto duration = this->duration();
if (duration.isNull()) {
return 0.0;
}
return 0.0078125 * static_cast<double>(size()) / duration.totalSeconds();
}
/*!
* \brief Determines the available languages for specified media type (by default MediaType::Audio).
*
* If \a type is MediaType::Unknown, all media types are considered.
*
* parseTracks() needs to be called before. Otherwise this
* method always returns an empty set.
*
* \sa parseTracks()
*/
unordered_set<string> MediaFileInfo::availableLanguages(MediaType type) const
{
unordered_set<string> res;
if (m_container) {
for (size_t i = 0, count = m_container->trackCount(); i != count; ++i) {
const AbstractTrack *const track = m_container->track(i);
if (type != MediaType::Unknown && track->mediaType() != type) {
continue;
}
if (const auto &language = track->locale().someAbbreviatedName(); !language.empty()) {
res.emplace(language);
}
}
} else if (m_singleTrack && (type == MediaType::Unknown || m_singleTrack->mediaType() == type)) {
if (const auto &language = m_singleTrack->locale().someAbbreviatedName(); !language.empty()) {
res.emplace(language);
}