C++ library for reading and writing MP4/M4A/AAC (iTunes), ID3, Vorbis, Opus, FLAC and Matroska tags
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Martchus d812e0d3ae Detect VobSub within MP4 2 weeks ago
aac Fix misc warnings 7 months ago
adts Use constexpr where possible 8 months ago
av1 Prepare parsing AV1 config 7 months ago
avc Prepare logging errors when parsing AVC config 7 months ago
avi Fix documentation which was still using the old namespace 9 months ago
doc Improve refs in "Adding new fields" doc 2 months ago
flac Implement small TODOs for v8 8 months ago
id3 Deprecate unused methods in Id3v2Frame 1 month ago
ivf Detect AV1 in IVF stream 7 months ago
matroska Prepare logging errors when parsing AVC config 7 months ago
mp4 Detect VobSub within MP4 2 weeks ago
mpegaudio Fix warnings in MpegAudioFrame 7 months ago
ogg Add tagType and tagName to OggVorbisComment 2 months ago
opus Use constexpr where possible 8 months ago
scripts Add testfile for AV1 in MP4 4 months ago
testfiles Test more methods of MediaFileInfo 1 year ago
tests Fix TagValue::toStandardGenreIndex() for empty genre index 1 month ago
vorbis Support album artist and fix/improve grouping 2 months ago
wav Detect float PCM in WAVE container 2 months ago
.gitignore Apply clang-format later 1 year ago
CMakeLists.txt Add MediaFileInfo::overallAverageBitrate() 2 weeks ago
LICENSE Initial commit 3 years ago
README.md Document usage, especially error handling 1 year ago
abstractattachment.cpp Fix compile error due to incomplete MediaFileInfo 5 months ago
abstractattachment.h Fix compile error due to incomplete MediaFileInfo 5 months ago
abstractchapter.cpp Fix documentation which was still using the old namespace 9 months ago
abstractchapter.h Apply clang-format 1 year ago
abstractcontainer.cpp Fix documentation which was still using the old namespace 9 months ago
abstractcontainer.h Refactor MediaFileInfo::createAppropriateTags() 1 year ago
abstracttrack.cpp Fix documentation which was still using the old namespace 9 months ago
abstracttrack.h Detect AV1 in IVF stream 7 months ago
aspectratio.cpp Fix documentation which was still using the old namespace 9 months ago
aspectratio.h Add AspectRatio::toString() 7 months ago
backuphelper.cpp Fix typo occured -> occurred 8 months ago
backuphelper.h Don't use global variable for backup directory 8 months ago
basicfileinfo.cpp Fix documentation which was still using the old namespace 9 months ago
basicfileinfo.h Apply clang-format 1 year ago
caseinsensitivecomparer.h Apply clang-format 1 year ago
diagnostics.cpp Refactor formatting list of values 8 months ago
diagnostics.h Remove DiagPtr 8 months ago
exceptions.cpp Use noexcept directly 1 month ago
exceptions.h Use noexcept directly 1 month ago
fieldbasedtag.h Adjust values()/setValues() to handle multiple values per text frame 8 months ago
genericcontainer.h Replace typedef with using 8 months ago
genericfileelement.h Replace typedef with using 8 months ago
generictagfield.h Replace typedef with using 8 months ago
global.h Apply clang-format later 1 year ago
localeawarestring.cpp Apply clang-format 1 year ago
localeawarestring.h Apply clang-format 1 year ago
margin.h Apply clang-format 1 year ago
mediafileinfo.cpp Add MediaFileInfo::overallAverageBitrate() 2 weeks ago
mediafileinfo.h Add MediaFileInfo::overallAverageBitrate() 2 weeks ago
mediaformat.cpp Detect AV1 in MKV 7 months ago
mediaformat.h Fix misc warnings 7 months ago
positioninset.h Fix documentation which was still using the old namespace 9 months ago
progressfeedback.cpp Document progress feedback 9 months ago
progressfeedback.h Document progress feedback 9 months ago
settings.h Apply clang-format 1 year ago
signature.cpp Detect MIDI files 6 months ago
signature.h Detect MIDI files 6 months ago
size.cpp Apply clang-format 1 year ago
size.h Apply clang-format 1 year ago
tag.cpp Add Tag::supportsMultipleValues() 8 months ago
tag.h Don't treat synchronized lyrics as regular text field 1 month ago
tagtarget.cpp Fix documentation which was still using the old namespace 9 months ago
tagtarget.h Replace typedef with using 8 months ago
tagvalue.cpp Fix TagValue::toStandardGenreIndex() for empty genre index 1 month ago
tagvalue.h Implement small TODOs for v8 8 months ago

README.md

Tag Parser

C++ library for reading and writing MP4 (iTunes), ID3, Vorbis, Opus, FLAC and Matroska tags.

Supported formats

The tag library can read and write the following tag formats:

  • iTunes-style MP4/M4A tags (MP4-DASH is supported)
  • ID3v1 and ID3v2 tags
    • conversion between ID3v1 and different versions of ID3v2 is possible
  • Vorbis, Opus and FLAC comments in Ogg streams
    • cover art via “METADATA_BLOCK_PICTURE” is supported
  • Vorbis comments and “METADATA_BLOCK_PICTURE” in raw FLAC streams
  • Matroska/WebM tags and attachments

File layout options

Tag position

The library allows you to choose whether tags should be placed at the beginning or at the end of an MP4/Matroska file.

Padding

Padding allows adding additional tag information without rewriting the entire file or appending the tag. Usage of padding can be configured:

  • minimum/maximum padding: The file is rewritten if the padding would fall below/exceed the specifed limits.
  • preferred padding: If the file needs to be rewritten the preferred padding is used.

Default value for minimum and maximum padding is zero. Hence the library will almost always have to rewrite the entire file to apply changes. To prevent this, set at least the maximum padding to a higher value.

It is also possible to force rewriting the entire file always.

Taking advantage of padding is currently not supported when dealing with Ogg streams (it is supported when dealing with raw FLAC streams).

Additional features

The library can also display technical information such as the ID, format, language, bitrate, duration, size, timestamps, sampling frequency, FPS and other information of the tracks.

It also allows to inspect and validate the element structure of MP4 and Matroska files.

Text encoding, Unicode support

The library is aware of different text encodings and can convert between different encodings using iconv.

Windows specific

A workaround to support filenames containing non-ASCII characters (despite the lack of an UTF-8 supporting std::fstream under Windows) can be enabled by adding -DUSE_NATIVE_FILE_BUFFER=ON to the CMake arguments when building c++utilities. It is not sufficient to specify this option only when building tagparser.

Usage

This example shows how to read and write tag fields in a format-independent way:

#include <tagparser/mediafileinfo.h>
#include <tagparser/diagnostics.h>

using namespace TagParser;

// create a MediaFileInfo for high-level access to overall functionality of the library
MediaFileInfo fileInfo;
// create container for errors, warnings, etc.
Diagnostics diag;

// open file (might throw ios_base::failure)
fileInfo.setPath("/path/to/some/file");
fileInfo.open();
// parse tags
// (might throw exception derived from Failure for fatal parsing error or ios_base::failure for IO errors)
fileInfo.parseTags(diag);

// get first tag as an object derived from the Tag class
auto tag = fileInfo.tags().at(0);
// extract title and convert it to UTF-8 std::string
// (toString() might throw ConversionException)
auto title = tag->value(KnownField::Title).toString(TagTextEncoding::Utf8);

// change album using an encoding suitable for the tag format
tag->setValue(KnownField::Album, TagValue("some UTF-8 string", TagTextEncoding::Utf8, tag->proposedTextEncoding()));

// create progress
AbortableProgressFeedback progress([callback for status update], [callback for percentage-only updates]);

// apply changes to the file on disk
// (might throw exception derived from Failure for fatal processing error or ios_base::failure for IO errors)
fileInfo.applyChanges(diag, progress);

Summary

  • So the most important class is MediaFileInfo providing access to everything else.
  • IO errors are propagated via standard std::ios_base::failure.
  • Fatal processing errors are propagated by throwing a class derived from Failure.
  • All operations which might generate warnings, non-fatal errors, … take a Diagnostics object to store those messages.
  • All operations which can be aborted or provide progress feedback take a AbortableProgressFeedback object for callbacks and aborting.
  • Field values are stored using TagValue objects. Those objects erase the actual type similar to QVariant from the Qt framework.

Further documentation

For more examples check out the command line interface of Tag Editor. API documentation can be generated using Doxygen with make tagparser_apidoc.

Bugs, stability

It is recommend to create backups before editing because I can not test whether the library works with all kinds of files (when forcing rewrite a backup is always created).

Build instructions

The tagparser library depends on c++utilities and is built in the same way. It also depends on zlib. For checking integrity of testfiles, the OpenSSL crypto library is required.

TODOs

  • Support more formats (EXIF, PDF metadata, Theora, …)
  • Support adding cue-sheet to FLAC files

More TODOs are tracked in the issue section at GitHub.