Tag Parser
9.1.3
C++ library for reading and writing MP4 (iTunes), ID3, Vorbis, Opus, FLAC and Matroska tags
|
Contains all classes and functions of the TagInfo library. More...
Namespaces | |
BackupHelper | |
Helps to create and restore backup files when rewriting files to apply changed tag information. | |
EbmlIds | |
Encapsulates all EBML ID values. | |
ExtensionFormats | |
Encapsulates extension formats. | |
FourccIds | |
Encapsulates all supported MP4 media format IDs (aka "FOURCCs"). | |
Id3v2FrameIds | |
Encapsulates the most common ID3v2 frame IDs and related functions. | |
Id3v2TextEncodingBytes | |
MatroskaIds | |
Encapsulates the most common Matroska element IDs. | |
MatroskaTagIds | |
Encapsulates Matroska tag IDs. | |
MatroskaTrackType | |
Encapsulates the most common Matroska track IDs. | |
Mp4AtomIds | |
Encapsulates the most common MP4 atom IDs. | |
Mp4FormatExtensionIds | |
Encapsulates all supported MP4 media format description extensions. | |
Mp4MediaTypeIds | |
Encapsulates all supported MP4 media type IDs. | |
Mp4TagAtomIds | |
Encapsulates IDs of MP4 atoms holding tag information. | |
Mp4TagExtendedMeanIds | |
Encapsulates "mean values" used in iTunes style MP4 tags. | |
Mp4TagExtendedNameIds | |
Encapsulates "name values" used in iTunes style MP4 tags. | |
Mpeg2VideoCodes | |
Encapsulates MPEG-2 video codes. | |
Mpeg4AudioObjectIds | |
Encapsulates all supported MPEG-4 audio object type IDs. | |
Mpeg4ChannelConfigs | |
Encapsulates all supported MPEG-4 channel configurations. | |
Mpeg4DescriptorIds | |
Encapsulates all known MPEG-4 descriptor IDs. | |
Mpeg4ElementaryStreamObjectIds | |
Encapsulates all supported MPEG-4 elementary stream object IDs. | |
Mpeg4ElementaryStreamTypeIds | |
Returns the name of the stream type denoted by the specified MPEG-4 stream type ID. | |
Mpeg4VideoCodes | |
Encapsulates MPEG-4 video (14496-2) codes. | |
RawDataType | |
Encapsulates the most common data type IDs of MP4 tag fields. | |
SubFormats | |
Encapsulates sub formats. | |
VorbisCommentIds | |
Encapsulates Vorbis comment IDs. | |
VorbisPackageTypes | |
Encapsulates known Vorbis package type IDs. | |
Classes | |
class | AbortableProgressFeedback |
The AbortableProgressFeedback class provides feedback about an ongoing operation via callbacks. It also allows to abort the operation. More... | |
class | AbstractAttachment |
The AbstractAttachment class parses and stores attachment information. More... | |
class | AbstractChapter |
The AbstractChapter class parses chapter information. More... | |
class | AbstractContainer |
The AbstractContainer class provides an interface and common functionality to parse and make a certain container format. More... | |
class | AbstractTrack |
The AbstractTrack class parses and stores technical information about video, audio and other kinds of media tracks. More... | |
class | AdtsFrame |
The AdtsFrame class is used to parse "Audio Data Transport Stream" frames. More... | |
class | AdtsStream |
Implementation of TagParser::AbstractTrack for ADTS streams. More... | |
struct | AspectRatio |
The AspectRatio struct defines an aspect ratio. More... | |
class | Av1Configuration |
The Av1Configuration struct provides a parser for AV1 configuration found in ISOBMFF files. More... | |
class | AvcConfiguration |
The AvcConfiguration struct provides a parser for AVC configuration. More... | |
struct | AvcFrame |
The AvcFrame struct holds an AVC frame. More... | |
class | BasicFileInfo |
The BasicFileInfo class provides basic file information such as file name, extension, directory and size for a specified file. More... | |
class | BasicProgressFeedback |
The BasicProgressFeedback class provides the base for ProgressFeedback and AbortableProgressFeedback. More... | |
class | BitmapInfoHeader |
The BitmapInfoHeader class parses the BITMAPINFOHEADER structure defined by MS. More... | |
struct | CaseInsensitiveCharComparer |
The CaseInsensitiveCharComparer struct defines a method for case-insensivive character comparsion (less). More... | |
struct | CaseInsensitiveStringComparer |
The CaseInsensitiveStringComparer struct defines a method for case-insensivive string comparsion (less). More... | |
class | DiagMessage |
The DiagMessage class holds an information, warning or error gathered during parsing or making. More... | |
class | Diagnostics |
The Diagnostics class is a container for DiagMessage. More... | |
class | EbmlElement |
The EbmlElement class helps to parse EBML files such as Matroska files. More... | |
class | Failure |
The class inherits from std::exception and serves as base class for exceptions thrown by the elements of the Media namespace. More... | |
class | FieldMapBasedTag |
The FieldMapBasedTag provides a generic implementation of Tag which stores the tag fields using std::multimap. More... | |
class | FieldMapBasedTagTraits |
Defines traits for the specified ImplementationType. More... | |
class | FieldMapBasedTagTraits< Id3v2Tag > |
Defines traits for the TagField implementation of the Id3v2Tag class. More... | |
class | FieldMapBasedTagTraits< MatroskaTag > |
Defines traits for the TagField implementation of the MatroskaTag class. More... | |
class | FieldMapBasedTagTraits< Mp4Tag > |
Defines traits for the TagField implementation of the Mp4Tag class. More... | |
class | FieldMapBasedTagTraits< VorbisComment > |
Defines traits for the TagField implementation of the VorbisComment class. More... | |
class | FileDataBlock |
The FileDataBlock class is a reference to a certain data block of a file stream. More... | |
class | FileElementTraits |
Defines traits for the specified ImplementationType. More... | |
class | FileElementTraits< EbmlElement > |
Defines traits for the GenericFileElement implementation EbmlElement. More... | |
class | FileElementTraits< Mp4Atom > |
Defines traits for the GenericFileElement implementation Mp4Atom. More... | |
class | FileElementTraits< Mpeg4Descriptor > |
Defines traits for the GenericFileElement implementation Mpeg4Descriptor. More... | |
class | FlacMetaDataBlockHeader |
The FlacMetaDataBlockHeader class is a FLAC "METADATA_BLOCK_HEADER" parser and maker. More... | |
class | FlacMetaDataBlockPicture |
The FlacMetaDataBlockPicture class is a FLAC "METADATA_BLOCK_PICTURE" parser and maker. More... | |
class | FlacMetaDataBlockStreamInfo |
The FlacMetaDataBlockStreamInfo class is a FLAC "METADATA_BLOCK_STREAMINFO" parser. More... | |
class | FlacStream |
Implementation of TagParser::AbstractTrack for raw FLAC streams. More... | |
class | FlacToOggMappingHeader |
The FlacToOggMappingHeader class is a FLAC-to-Ogg mapping header parser. More... | |
class | FrameComparer |
Defines the order which is used to store ID3v2 frames. More... | |
class | GenericContainer |
The GenericContainer class helps parsing header, track, tag and chapter information of a file. More... | |
class | GenericFileElement |
The GenericFileElement class helps to parse binary files which consist of an arboreal element strucutre. More... | |
struct | HrdParameters |
The HrdParameters struct holds "Hypothetical Reference Decoder" parameters. More... | |
class | Id3Genres |
The Id3Genres class converts pre-defined ID3 genres to strings and vise versa. More... | |
class | Id3v1Tag |
Implementation of TagParser::Tag for ID3v1 tags. More... | |
class | Id3v2Frame |
The Id3v2Frame class is used by Id3v2Tag to store the fields. More... | |
class | Id3v2FrameMaker |
The Id3v2FrameMaker class helps making ID3v2 frames. It allows to calculate the required size. More... | |
class | Id3v2Tag |
Implementation of TagParser::Tag for ID3v2 tags. More... | |
class | Id3v2TagMaker |
The Id3v2TagMaker class helps writing ID3v2 tags. More... | |
class | InvalidDataException |
The exception that is thrown when the data to be parsed or to be made seems invalid and therefore can not be parsed. More... | |
class | IvfFrame |
The IvfFrame class is used to parse IVF frames. More... | |
class | IvfStream |
Implementation of TagParser::AbstractTrack for ADTS streams. More... | |
class | LocaleAwareString |
The LocaleAwareString class is a standard string with locale information (languages, countries). More... | |
class | Margin |
The Margin class defines the four margins of a rectangle. More... | |
class | MatroskaAttachment |
Implementation of TagParser::AbstractAttachment for the Matroska container. More... | |
class | MatroskaAttachmentMaker |
The MatroskaAttachmentMaker class helps writing Matroska "AttachedFile"-elements which contain an attachment. More... | |
class | MatroskaChapter |
The MatroskaChapter class provides an implementation of AbstractAttachment for Matroska files. More... | |
class | MatroskaContainer |
Implementation of GenericContainer<MediaFileInfo, MatroskaTag, MatroskaTrack, EbmlElement>. More... | |
class | MatroskaCuePositionUpdater |
The MatroskaCuePositionUpdater class helps to rewrite the "Cues"-element with shifted positions. More... | |
class | MatroskaEditionEntry |
The MatroskaEditionEntry class provides a parser for edition entries in Matroska files. More... | |
class | MatroskaOffsetStates |
The MatroskaOffsetStates holds an offset within a Matroska file. More... | |
class | MatroskaReferenceOffsetPair |
The MatroskaReferenceOffsetPair holds an offset within a Matroska file plus the reference offset. More... | |
class | MatroskaSeekInfo |
The MatroskaSeekInfo class helps parsing and making "SeekHead"-elements. More... | |
class | MatroskaTag |
Implementation of TagParser::Tag for the Matroska container. More... | |
class | MatroskaTagField |
The MatroskaTagField class is used by MatroskaTag to store the fields. More... | |
class | MatroskaTagFieldMaker |
The MatroskaTagFieldMaker class helps making tag fields. It allows to calculate the required size. More... | |
class | MatroskaTagMaker |
The MatroskaTagMaker class helps writing Matroska "Tag"-elements storing tag information. More... | |
class | MatroskaTrack |
Implementation of TagParser::AbstractTrack for the Matroska container. More... | |
class | MatroskaTrackHeaderMaker |
The MatroskaTrackHeaderMaker class helps writing Matroska "TrackEntry"-elements storing track header information. More... | |
class | MediaFileInfo |
The MediaFileInfo class allows to read and write tag information providing a container/tag format independent interface. More... | |
class | MediaFormat |
The MediaFormat class specifies the format of media data. More... | |
class | Mp4Atom |
The Mp4Atom class helps to parse MP4 files. More... | |
class | Mp4Container |
Implementation of GenericContainer<MediaFileInfo, Mp4Tag, Mp4Track, Mp4Atom>. More... | |
class | Mp4ExtendedFieldId |
The Mp4ExtendedFieldId specifies parameter for an extended field denoted via Mp4TagAtomIds::Extended. More... | |
class | Mp4Tag |
Implementation of TagParser::Tag for the MP4 container. More... | |
class | Mp4TagField |
The Mp4TagField class is used by Mp4Tag to store the fields. More... | |
class | Mp4TagFieldMaker |
The Mp4TagFieldMaker class helps making tag fields. It allows to calculate the required size. More... | |
class | Mp4TagMaker |
The Mp4TagMaker class helps writing MP4 tags. More... | |
class | Mp4Track |
Implementation of TagParser::AbstractTrack for the MP4 container. More... | |
class | Mpeg4AudioSpecificConfig |
The Mpeg4AudioSpecificConfig class holds MPEG-4 audio specific config parsed using Mp4Track::parseAudioSpecificConfig(). More... | |
class | Mpeg4Descriptor |
The Mpeg4Descriptor class helps to parse MPEG-4 descriptors. More... | |
class | Mpeg4ElementaryStreamInfo |
The Mpeg4ElementaryStreamInfo class holds MPEG-4 elementary stream info parsed using Mp4Track::parseMpeg4ElementaryStreamInfo(). More... | |
class | Mpeg4VideoSpecificConfig |
The Mpeg4VideoSpecificConfig class holds MPEG-4 video specific config parsed using Mp4Track::parseVideoSpecificConfig(). More... | |
class | MpegAudioFrame |
The MpegAudioFrame class is used to parse MPEG audio frames. More... | |
class | MpegAudioFrameStream |
Implementation of TagParser::AbstractTrack MPEG audio streams. More... | |
class | NoDataFoundException |
The exception that is thrown when the data to be parsed holds no parsable information (e.g. relevant section in the file does not exist or has size of zero). More... | |
class | NoDataProvidedException |
class | NotImplementedException |
This exception is thrown when the an operation is invoked that has not been implemented yet. More... | |
class | OggContainer |
Implementation of TagParser::AbstractContainer for OGG files. More... | |
class | OggIterator |
The OggIterator class helps iterating through all segments of an OGG bitstream. More... | |
class | OggPage |
The OggPage class is used to parse OGG pages. More... | |
struct | OggParameter |
The OggParameter struct holds the OGG parameter for a VorbisComment. More... | |
class | OggStream |
Implementation of TagParser::AbstractTrack for OGG streams. More... | |
class | OggVorbisComment |
Specialization of TagParser::VorbisComment for Vorbis comments inside an OGG stream. More... | |
class | OperationAbortedException |
The exception that is thrown when an operation has been stopped and thus not successfully completed because it has been aborted. More... | |
class | OpusIdentificationHeader |
The OpusIdentificationHeader class is an Opus identification header parser. More... | |
class | PositionInSet |
The PositionInSet class describes the position of an element in a set which consists of a certain number of elements. More... | |
struct | PpsInfo |
The PpsInfo struct holds the picture parameter set. More... | |
class | ProgressFeedback |
The ProgressFeedback class provides feedback about an ongoing operation via callbacks. More... | |
struct | SegmentData |
The private SegmentData struct is used in MatroskaContainer::internalMakeFile() to store segment specific data. More... | |
class | Size |
The Size class defines the size of a two-dimensional object using integer point precision. More... | |
struct | SliceInfo |
The SliceInfo struct holds the slice information of an AVC frame. More... | |
struct | SpsInfo |
The SpsInfo struct holds the sequence parameter set. More... | |
class | StreamDataBlock |
The StreamDataBlock class is a reference to a certain data block of a stream. More... | |
class | Tag |
The Tag class is used to store, read and write tag information. More... | |
struct | TagCreationSettings |
The TagSettings struct contains settings which can be passed to MediaFileInfo::createAppropriateTags(). More... | |
class | TagField |
The TagField class is used by FieldMapBasedTag to store the fields. More... | |
class | TagFieldTraits |
Defines traits for the specified ImplementationType. More... | |
class | TagFieldTraits< Id3v2Frame > |
Defines traits for the TagField implementation of the Id3v2Frame class. More... | |
class | TagFieldTraits< MatroskaTagField > |
Defines traits for the TagField implementation of the MatroskaTagField class. More... | |
class | TagFieldTraits< Mp4TagField > |
Defines traits for the TagField implementation of the Mp4TagField class. More... | |
class | TagFieldTraits< VorbisCommentField > |
Defines traits for the TagField implementation of the VorbisCommentField class. More... | |
class | TagTarget |
The TagTarget class specifies the target of a tag. More... | |
class | TagValue |
The TagValue class wraps values of different types. It is meant to be assigned to a tag field. More... | |
struct | TimingInfo |
The TimingInfo struct holds timing information (part of SPS info). More... | |
struct | TrackHeaderInfo |
The TrackHeaderInfo struct holds information about the present track header (tkhd atom) and information for making a new track header based on it. More... | |
class | TruncatedDataException |
The exception that is thrown when the data to be parsed is truncated and therefore can not be parsed at all. More... | |
class | VersionNotSupportedException |
The exception that is thrown when an operation fails because the detected or specified version is not supported by the implementation. More... | |
class | VorbisComment |
Implementation of TagParser::Tag for Vorbis comments. More... | |
class | VorbisCommentField |
The VorbisCommentField class is used by VorbisComment to store the fields. More... | |
class | VorbisIdentificationHeader |
The VorbisIdentificationHeader class is a Vorbis identification header parser. More... | |
class | WaveAudioStream |
Implementation of TagParser::AbstractTrack for the RIFF WAVE container format. More... | |
class | WaveFormatHeader |
The WaveFormatHeader class parses the WAVEFORMATEX structure defined by MS. More... | |
Typedefs | |
using | ugolomb = std::uint32_t |
Type used to store unsigned integer values using golomb coding. More... | |
using | sgolomb = std::int32_t |
Type used to store signed integer values using golomb coding. More... | |
Functions | |
const TAG_PARSER_EXPORT char * | diagLevelName (DiagLevel diagLevel) |
Returns the string representation of the specified diagLevel. More... | |
constexpr DiagLevel & | operator|= (DiagLevel &lhs, const DiagLevel &rhs) |
Sets lhs to rhs if rhs is more critical than lhs and returns lhs. More... | |
constexpr bool | operator== (std::uint8_t lhs, FlacMetaDataBlockType type) |
constexpr bool | operator!= (std::uint8_t lhs, FlacMetaDataBlockType type) |
bool | isLanguageDefined (const std::string &languageSpecification) |
Returns whether languageSpecification is not empty or undefined. More... | |
const TAG_PARSER_EXPORT std::string & | languageNameFromIso (const std::string &isoCode) |
Returns the language name for the specified ISO-639-2 code (bibliographic, 639-2/B). More... | |
const TAG_PARSER_EXPORT std::string & | languageNameFromIsoWithFallback (const std::string &isoCode) |
Returns the language name for the specified ISO-639-2 code (bibliographic, 639-2/B). More... | |
constexpr bool | operator> (MatroskaElementLevel lhs, MatroskaElementLevel rhs) |
constexpr bool | operator> (std::uint8_t lhs, MatroskaElementLevel rhs) |
constexpr bool | operator< (MatroskaElementLevel lhs, MatroskaElementLevel rhs) |
constexpr bool | operator>= (MatroskaElementLevel lhs, MatroskaElementLevel rhs) |
constexpr bool | operator<= (MatroskaElementLevel lhs, MatroskaElementLevel rhs) |
const TAG_PARSER_EXPORT char * | matroskaIdName (std::uint32_t matroskaId) |
Returns a string for the specified matroskaId if known; otherwise returns an empty string. More... | |
TAG_PARSER_EXPORT MatroskaElementLevel | matroskaIdLevel (std::uint32_t matroskaId) |
Returns the level at which elements with the specified matroskaId are supposed to occur in a Matroska file. More... | |
constexpr TAG_PARSER_EXPORT TagTargetLevel | matroskaTagTargetLevel (std::uint64_t targetLevelValue) |
Returns the general TagTargetLevel for the Matroska specific targetLevelValue. More... | |
constexpr TAG_PARSER_EXPORT std::uint64_t | matroskaTagTargetLevelValue (TagTargetLevel targetLevel) |
Returns the Matroska specific target level value for the specified general targetLevel. More... | |
const TAG_PARSER_EXPORT char * | mediaTypeName (MediaType mediaType) |
Returns the string representation for the specified mediaType. More... | |
const TAG_PARSER_EXPORT char * | mpegChannelModeString (MpegChannelMode channelMode) |
Returns the string representation for the specified channelMode. More... | |
constexpr XingHeaderFlags | operator| (XingHeaderFlags lhs, XingHeaderFlags rhs) |
constexpr XingHeaderFlags | operator& (XingHeaderFlags lhs, XingHeaderFlags rhs) |
TAG_PARSER_EXPORT ContainerFormat | parseSignature (const char *buffer, int bufferSize) |
Parses the signature read from the specified buffer. More... | |
const TAG_PARSER_EXPORT char * | containerFormatName (ContainerFormat containerFormat) |
Returns the name of the specified container format as C-style string. More... | |
const TAG_PARSER_EXPORT char * | containerFormatAbbreviation (ContainerFormat containerFormat, MediaType mediaType, unsigned int version) |
Returns the abbreviation of the container format as C-style string considering the specified media type and version. More... | |
const TAG_PARSER_EXPORT char * | containerFormatSubversion (ContainerFormat containerFormat) |
Returns the subversion of the container format as C-style string. More... | |
const TAG_PARSER_EXPORT char * | containerMimeType (ContainerFormat containerFormat, MediaType mediaType) |
Returns the MIME-type of the container format as C-style string. More... | |
TAG_PARSER_EXPORT TagTargetLevel | containerTargetLevel (ContainerFormat containerFormat, std::uint64_t targetLevelValue) |
Returns the general TagTargetLevel for the specified container format and raw targetLevelValue. More... | |
TAG_PARSER_EXPORT std::uint64_t | containerTargetLevelValue (ContainerFormat containerFormat, TagTargetLevel targetLevel) |
Returns the raw target level value for the specified containerFormat and general targetLevel. More... | |
constexpr KnownField | nextKnownField (KnownField field) |
Returns the next known field. More... | |
const TAG_PARSER_EXPORT char * | tagTargetLevelName (TagTargetLevel tagTargetLevel) |
Returns a string representation for the specified tagTargetLevel. More... | |
constexpr int | characterSize (TagTextEncoding encoding) |
Returns the size of one character for the specified encoding in bytes. More... | |
constexpr bool | operator& (VorbisCommentFlags lhs, VorbisCommentFlags rhs) |
constexpr VorbisCommentFlags | operator| (VorbisCommentFlags lhs, VorbisCommentFlags rhs) |
constexpr auto | maxId3v2FrameDataSize (numeric_limits< std::uint32_t >::max() - 15) |
The maximum (supported) size of an ID3v2Frame. More... | |
template<class stringtype > | |
int | parseGenreIndex (const stringtype &denotation) |
Helper function to parse the genre index. More... | |
string | stringFromSubstring (tuple< const char *, size_t, const char * > substr) |
Returns an std::string instance for the substring parsed using parseSubstring(). More... | |
u16string | wideStringFromSubstring (tuple< const char *, size_t, const char * > substr, TagTextEncoding encoding) |
Returns an std::u16string instance for the substring parsed using parseSubstring(). More... | |
bool | sameOffset (std::uint64_t offset, const EbmlElement *element) |
Returns an indication whether offset equals the start offset of element. More... | |
bool | excludesOffset (const vector< EbmlElement * > &elements, std::uint64_t offset) |
Returns whether none of the specified elements have the specified offset. More... | |
const char * | tagDataTypeString (TagDataType dataType) |
Returns the string representation of the specified dataType. More... | |
pair< const char *, float > | encodingParameter (TagTextEncoding tagTextEncoding) |
Returns the encoding parameter (name of the character set and bytes per character) for the specified tagTextEncoding. More... | |
Variables | |
constexpr auto | worstDiagLevel = DiagLevel::Fatal |
The worst diag level. More... | |
std::uint32_t | mpeg4SamplingFrequencyTable [13] = { 96000, 88200, 64000, 48000, 44100, 32000, 24000, 22050, 16000, 12000, 11025, 8000, 7350 } |
constexpr KnownField | firstKnownField = KnownField::Title |
The first valid entry in the TagParser::KnownField enum. More... | |
constexpr KnownField | lastKnownField = KnownField::AlbumArtist |
The last valid entry in the TagParser::KnownField enum. More... | |
constexpr unsigned int | knownFieldArraySize = static_cast<unsigned int>(lastKnownField) + 1 |
The number of valid entries in the TagParser::KnownField enum. More... | |
const DateTime | startDate = DateTime::fromDate(1904, 1, 1) |
Dates within MP4 tracks are expressed as the number of seconds since this date. More... | |
Contains all classes and functions of the TagInfo library.
using TagParser::sgolomb = typedef std::int32_t |
using TagParser::ugolomb = typedef std::uint32_t |
|
strong |
|
strong |
Specifies the container format.
Raw streams like ADTS or raw FLAC count as container format in this context.
Definition at line 17 of file signature.h.
|
strong |
|
strong |
Specifies the level of the diagnostic message.
Definition at line 16 of file diagnostics.h.
|
strong |
Enumerator | |
---|---|
BeforeData | the element is positioned before the actual data |
AfterData | the element is positioned after the actual data |
Keep | the element is placed where it was before |
Definition at line 13 of file settings.h.
|
strong |
The FlacMetaDataBlockType enum specifies the type of FlacMetaDataBlockHeader.
Enumerator | |
---|---|
StreamInfo | |
Padding | |
Application | |
SeekTable | |
VorbisComment | |
CuseSheet | |
Picture |
Definition at line 16 of file flacmetadata.h.
|
strong |
The GeneralMediaFormat enum specifies the general format of media data (PCM, MPEG-4, PNG, ...).
Definition at line 29 of file mediaformat.h.
|
strong |
Specifies the field.
These "known" fields are used to specify a field without using the field identifier used by the underlaying tag type.
Not all fields are supported by all tag types (see Tag::supportsField()).
Mapping proposed by HAK: https://wiki.hydrogenaud.io/index.php?title=Tag_Mapping
Enumerator | |
---|---|
Invalid | invalid field name, do not map this value when subclassing Tag |
Title | title |
Album | album/collection |
Artist | artist/band |
Genre | genre |
Year | year |
Comment | comment |
Bpm | beats per minute |
Bps | beats per second |
Lyricist | lyricist |
TrackPosition | track/part number and total track/part count |
DiskPosition | disk number and total disk count |
PartNumber | track/part number |
TotalParts | total track/part count |
Encoder | encoder |
RecordDate | record date |
Performers | performers |
Length | length |
Language | language |
EncoderSettings | encoder settings |
Lyrics | lyrics |
SynchronizedLyrics | synchronized lyrics |
Grouping | grouping |
RecordLabel | record label |
Cover | cover |
Composer | composer |
Rating | rating |
Description | description |
Vendor | vendor |
AlbumArtist | album artist |
|
strong |
Enumerator | |
---|---|
TopLevel | |
Level1 | |
Level2 | |
Level3 | |
Level4 | |
Level5 | |
Level6 | |
Global | |
Unknown |
Definition at line 406 of file matroskaid.h.
|
strong |
The MediaType enum specifies the type of media data (audio, video, text, ...).
Enumerator | |
---|---|
Unknown | the type is unknown |
Audio | audio/sound |
Video | video |
Text | text/subtitle |
Buttons | buttons |
Control | control |
Hint | hint |
Meta | (timed) metadata |
Definition at line 13 of file mediaformat.h.
|
strong |
|
strong |
|
strong |
Specifies the channel mode.
Enumerator | |
---|---|
Stereo | stereo |
JointStereo | joint stereo |
DualChannel | dual channel |
SingleChannel | single channel/mono |
Unspecifed | used to indicate that the channel mode is unknown |
Definition at line 18 of file mpegaudioframe.h.
|
strong |
The ParsingStatus enum specifies whether a certain part of the file (tracks, tags, ...) has been parsed yet and if what the parsing result is.
Definition at line 38 of file mediafileinfo.h.
enum TagParser::Sig16 : std::uint16_t |
Holds 16-bit signatures.
Definition at line 84 of file signature.cpp.
enum TagParser::Sig24 : std::uint32_t |
Holds 24-bit signatures.
Enumerator | |
---|---|
Bzip2 | |
Bzip2 | bzip2 compressed file |
Flv | |
Gzip | |
Gzip | gzip compressed file |
Id3v2 | |
Utf8Text | |
Utf8Text | UTF-8 text |
Definition at line 73 of file signature.cpp.
enum TagParser::Sig32 : std::uint32_t |
Holds 32-bit signatures.
Definition at line 44 of file signature.cpp.
enum TagParser::Sig48 : std::uint64_t |
Holds 48-bit signatures.
Enumerator | |
---|---|
Gif87a | |
Gif87a | Graphics Interchange Format (1987) |
Gif89a | |
Gif89a | Graphics Interchange Format (1989) |
SevenZ | |
SevenZ | 7z archive |
Xz | |
Xz | xz compressed file |
Definition at line 34 of file signature.cpp.
enum TagParser::Sig56 : std::uint64_t |
enum TagParser::Sig64 : std::uint64_t |
Holds 64-bit signatures.
Enumerator | |
---|---|
Ar | |
Ar | "GNU ar" archive |
Asf1 | |
Asf2 | |
Png | |
Png | PNG |
Png | Portable Network Graphics |
RiffAvi | |
RiffAvi | Audio Video Interleave (subset of RIFF) |
YUV4Mpeg2 | |
YUV4Mpeg2 | YUV4MPEG2 |
Definition at line 15 of file signature.cpp.
|
strong |
The Flags enum contains options to control the tag creation via MediaFileInfo::createAppropriateTags().
Enumerator | |
---|---|
None | no flags present |
TreatUnknownFilesAsMp3Files | treat unknown file formats as MP3 (might make those files unusable) |
Id3InitOnCreate | initialize newly created ID3 tags with the values of the already present ID3 tags |
Id3TransferValuesOnRemoval | transfer values of removed ID3 tags to remaining ID3 tags (no values will be overwritten) |
MergeMultipleSuccessiveId3v2Tags | merge multiple successive ID3v2 tags (see MediaFileInfo::mergeId3v2Tags()) |
KeepExistingId3v2Version | keep version of existing ID3v2 tags so TagSettings::id3v2version is only used when creating a new ID3v2 tag |
Definition at line 31 of file settings.h.
|
strong |
Specifies the data type.
Enumerator | |
---|---|
Text | text/string |
Integer | integer |
PositionInSet | position in set, see TagParser::PositionInSet |
StandardGenreIndex | pre-defined genre name denoted by numerical code |
TimeSpan | time span, see ChronoUtils::TimeSpan |
DateTime | date time, see ChronoUtils::DateTime |
Picture | picture file |
Binary | unspecified binary data |
Undefined | undefined/invalid data type |
Definition at line 54 of file tagvalue.h.
|
strong |
The TagTargetLevel enum specifies tag target levels.
Enumerator | |
---|---|
Unspecified | |
Shot | |
Subtrack | |
Track | |
Part | |
Album | |
Edition | |
Collection |
Definition at line 16 of file tagtarget.h.
|
strong |
Specifies the text encoding.
Enumerator | |
---|---|
Latin1 | ISO/IEC 8859-1 aka "Latin 1" |
Utf8 | UTF-8 |
Utf16LittleEndian | UTF-16 (little endian) |
Utf16BigEndian | UTF-16 (big endian) |
Unspecified | unspecified encoding |
Definition at line 25 of file tagvalue.h.
|
strong |
Specifies the tag type.
Enumerator | |
---|---|
Unspecified | The tag type is unspecified. |
Id3v1Tag | The tag is a TagParser::Id3v1Tag. |
Id3v2Tag | The tag is a TagParser::Id3v2Tag. |
Mp4Tag | The tag is a TagParser::Mp4Tag. |
MatroskaTag | The tag is a TagParser::MatroskaTag. |
VorbisComment | The tag is a TagParser::VorbisComment. |
OggVorbisComment | The tag is a TagParser::OggVorbisComment. |
|
strong |
The TagUsage enum specifies the usage of a certain tag type.
Definition at line 22 of file settings.h.
|
strong |
The TagValueComparisionOption enum specifies options for TagValue::compareTo().
Definition at line 69 of file tagvalue.h.
|
strong |
Specifies the track type.
Enumerator | |
---|---|
Unspecified | The track type is not specified. |
MatroskaTrack | The track is a TagParser::MatroskaTrack. |
MpegAudioFrameStream | The track is a TagParser::MpegAudioFrameStream. |
Mp4Track | The track is a TagParser::Mp4Track. |
WaveAudioStream | The track is a TagParser::WaveAudioStream. |
OggStream | The track is a TagParser::OggStream. |
AdtsStream | The track is a TagParser::AdtsStream. |
FlacStream | The track is a TagParser::FlacStream. |
IvfStream | The track is a TagParser::IvfStream. |
Definition at line 27 of file abstracttrack.h.
|
strong |
The VorbisCommentFlags enum specifies flags which controls parsing and making of Vorbis comments.
Definition at line 16 of file vorbiscommentfield.h.
|
strong |
Definition at line 28 of file mpegaudioframe.h.
|
constexpr |
Returns the size of one character for the specified encoding in bytes.
Definition at line 37 of file tagvalue.h.
const char * TagParser::containerFormatAbbreviation | ( | ContainerFormat | containerFormat, |
MediaType | mediaType, | ||
unsigned int | version | ||
) |
Returns the abbreviation of the container format as C-style string considering the specified media type and version.
Definition at line 251 of file signature.cpp.
const char * TagParser::containerFormatName | ( | ContainerFormat | containerFormat | ) |
Returns the name of the specified container format as C-style string.
Returns "unknown" if no name is available.
Definition at line 373 of file signature.cpp.
const char * TagParser::containerFormatSubversion | ( | ContainerFormat | containerFormat | ) |
Returns the subversion of the container format as C-style string.
Returns an empty string if there is no subversion available.
Definition at line 478 of file signature.cpp.
const char * TagParser::containerMimeType | ( | ContainerFormat | containerFormat, |
MediaType | mediaType | ||
) |
Returns the MIME-type of the container format as C-style string.
Returns an empty string if there is no MIME-type available.
Definition at line 499 of file signature.cpp.
TagTargetLevel TagParser::containerTargetLevel | ( | ContainerFormat | containerFormat, |
std::uint64_t | targetLevelValue | ||
) |
Returns the general TagTargetLevel for the specified container format and raw targetLevelValue.
Definition at line 572 of file signature.cpp.
std::uint64_t TagParser::containerTargetLevelValue | ( | ContainerFormat | containerFormat, |
TagTargetLevel | targetLevel | ||
) |
Returns the raw target level value for the specified containerFormat and general targetLevel.
Definition at line 586 of file signature.cpp.
const char * TagParser::diagLevelName | ( | DiagLevel | diagLevel | ) |
Returns the string representation of the specified diagLevel.
Definition at line 22 of file diagnostics.cpp.
pair<const char *, float> TagParser::encodingParameter | ( | TagTextEncoding | tagTextEncoding | ) |
Returns the encoding parameter (name of the character set and bytes per character) for the specified tagTextEncoding.
Definition at line 52 of file tagvalue.cpp.
|
inline |
Returns whether none of the specified elements have the specified offset.
Definition at line 309 of file matroskacontainer.cpp.
|
inline |
Returns whether languageSpecification is not empty or undefined.
Definition at line 16 of file language.h.
const std::string & TagParser::languageNameFromIso | ( | const std::string & | isoCode | ) |
Returns the language name for the specified ISO-639-2 code (bibliographic, 639-2/B).
Definition at line 19 of file language.cpp.
const std::string & TagParser::languageNameFromIsoWithFallback | ( | const std::string & | isoCode | ) |
Returns the language name for the specified ISO-639-2 code (bibliographic, 639-2/B).
Definition at line 34 of file language.cpp.
MatroskaElementLevel TagParser::matroskaIdLevel | ( | std::uint32_t | matroskaId | ) |
Returns the level at which elements with the specified matroskaId are supposed to occur in a Matroska file.
Definition at line 523 of file matroskaid.cpp.
const char * TagParser::matroskaIdName | ( | std::uint32_t | matroskaId | ) |
Returns a string for the specified matroskaId if known; otherwise returns an empty string.
Definition at line 22 of file matroskaid.cpp.
|
constexpr |
Returns the general TagTargetLevel for the Matroska specific targetLevelValue.
Definition at line 486 of file matroskatagid.h.
|
constexpr |
Returns the Matroska specific target level value for the specified general targetLevel.
Definition at line 494 of file matroskatagid.h.
|
constexpr |
The maximum (supported) size of an ID3v2Frame.
const char * TagParser::mediaTypeName | ( | MediaType | mediaType | ) |
Returns the string representation for the specified mediaType.
Definition at line 997 of file mediaformat.cpp.
const char * TagParser::mpegChannelModeString | ( | MpegChannelMode | channelMode | ) |
Returns the string representation for the specified channelMode.
Definition at line 15 of file mpegaudioframe.cpp.
|
constexpr |
Returns the next known field.
Returns KnownField::Invalid if there is not next field.
|
constexpr |
Definition at line 23 of file flacmetadata.h.
|
constexpr |
Definition at line 23 of file vorbiscommentfield.h.
|
constexpr |
Definition at line 150 of file mpegaudioframe.h.
|
constexpr |
Definition at line 432 of file matroskaid.h.
|
constexpr |
Definition at line 444 of file matroskaid.h.
|
constexpr |
Definition at line 18 of file flacmetadata.h.
|
constexpr |
Definition at line 418 of file matroskaid.h.
|
constexpr |
Definition at line 425 of file matroskaid.h.
|
constexpr |
Definition at line 439 of file matroskaid.h.
|
constexpr |
Definition at line 28 of file vorbiscommentfield.h.
|
constexpr |
Definition at line 145 of file mpegaudioframe.h.
Sets lhs to rhs if rhs is more critical than lhs and returns lhs.
Definition at line 33 of file diagnostics.h.
int TagParser::parseGenreIndex | ( | const stringtype & | denotation | ) |
Helper function to parse the genre index.
Definition at line 66 of file id3v2frame.cpp.
ContainerFormat TagParser::parseSignature | ( | const char * | buffer, |
int | bufferSize | ||
) |
Parses the signature read from the specified buffer.
buffer | Specifies the buffer to read the signature from. |
bufferSize | Specifies the size of buffer. |
Definition at line 104 of file signature.cpp.
bool TagParser::sameOffset | ( | std::uint64_t | offset, |
const EbmlElement * | element | ||
) |
Returns an indication whether offset equals the start offset of element.
Definition at line 300 of file matroskacontainer.cpp.
string TagParser::stringFromSubstring | ( | tuple< const char *, size_t, const char * > | substr | ) |
Returns an std::string instance for the substring parsed using parseSubstring().
Definition at line 107 of file id3v2frame.cpp.
const char* TagParser::tagDataTypeString | ( | TagDataType | dataType | ) |
Returns the string representation of the specified dataType.
Definition at line 25 of file tagvalue.cpp.
const char * TagParser::tagTargetLevelName | ( | TagTargetLevel | tagTargetLevel | ) |
Returns a string representation for the specified tagTargetLevel.
Definition at line 17 of file tagtarget.cpp.
u16string TagParser::wideStringFromSubstring | ( | tuple< const char *, size_t, const char * > | substr, |
TagTextEncoding | encoding | ||
) |
Returns an std::u16string instance for the substring parsed using parseSubstring().
Definition at line 115 of file id3v2frame.cpp.
|
constexpr |
The first valid entry in the TagParser::KnownField enum.
|
constexpr |
The number of valid entries in the TagParser::KnownField enum.
|
constexpr |
The last valid entry in the TagParser::KnownField enum.
std::uint32_t TagParser::mpeg4SamplingFrequencyTable = { 96000, 88200, 64000, 48000, 44100, 32000, 24000, 22050, 16000, 12000, 11025, 8000, 7350 } |
Definition at line 422 of file mp4ids.cpp.
const DateTime TagParser::startDate = DateTime::fromDate(1904, 1, 1) |
Dates within MP4 tracks are expressed as the number of seconds since this date.
Definition at line 70 of file mp4track.cpp.
|
constexpr |
The worst diag level.
Definition at line 26 of file diagnostics.h.