1#ifndef TAG_PARSER_TAG_H
2#define TAG_PARSER_TAG_H
7#include <c++utilities/io/binaryreader.h>
43 Invalid = std::numeric_limits<unsigned int>::max(),
164 CPP_UTILITIES_UNUSED(field)
182 virtual std::string_view typeName()
const;
183 std::string toString()
const;
187 virtual std::vector<const TagValue *> values(
KnownField field)
const;
189 virtual bool setValues(
KnownField field,
const std::vector<TagValue> &values);
192 const std::string &
version()
const;
193 std::uint64_t size()
const;
194 virtual bool supportsTarget()
const;
199 std::string_view targetLevelName()
const;
201 std::string targetString()
const;
205 virtual bool supportsDescription(
KnownField field)
const;
206 virtual bool supportsMimeType(
KnownField field)
const;
207 virtual bool supportsMultipleValues(
KnownField field)
const;
208 virtual std::size_t insertValues(
const Tag &from,
bool overwrite);
226 return "unspecified";
Implementation of TagParser::Tag for ID3v1 tags.
Implementation of TagParser::Tag for ID3v2 tags.
Implementation of TagParser::Tag for the Matroska container.
Implementation of TagParser::Tag for the MP4 container.
The TagTarget class specifies the target of a tag.
std::string toString(const std::function< TagTargetLevel(std::uint64_t)> &tagTargetMapping) const
Returns the string representation of the current instance.
The TagValue class wraps values of different types.
The Tag class is used to store, read and write tag information.
std::uint64_t size() const
Returns the size the tag within the file it is parsed from in bytes.
std::string_view targetLevelName() const
Returns the name of the current target level.
void setTarget(const TagTarget &target)
Sets the target of tag.
bool isTargetingLevel(TagTargetLevel tagTargetLevel) const
Returns whether the tag is targeting the specified tagTargetLevel.
virtual std::size_t fieldCount() const =0
Returns the number of present fields.
const std::string & version() const
Returns the version of the tag as std::string.
virtual bool supportsDescription(KnownField field) const
Returns an indications whether the specified field supports descriptions.
std::string targetString() const
Returns the string representation for the assigned tag target.
virtual TagTextEncoding proposedTextEncoding() const
Returns the proposed text encoding.
virtual TagType type() const
Returns the type of the tag as TagParser::TagType.
virtual std::string_view typeName() const
Returns the type name of the tag as C-style string.
virtual bool hasField(KnownField field) const =0
Returns an indication whether the specified field is present.
virtual void removeAllFields()=0
Removes all fields from the tag.
virtual TagTargetLevel targetLevel() const
Returns the name of the current tag target level.
const TagTarget & target() const
virtual bool setValue(KnownField field, const TagValue &value)=0
Assigns the given value to the specified field.
virtual TagDataType proposedDataType(KnownField field) const
Returns the proposed data type for the specified field as TagDataType.
virtual bool canEncodingBeUsed(TagTextEncoding encoding) const
Returns an indication whether the specified encoding can be used to provide string values for the tag...
virtual bool supportsMultipleValues(KnownField field) const
Returns an indications whether the specified field supports multiple values.
virtual void ensureTextValuesAreProperlyEncoded()=0
Ensures the encoding of all assigned text values is supported by the tag by converting the character ...
virtual bool supportsMimeType(KnownField field) const
Returns an indications whether the specified field supports mime types.
virtual bool supportsField(KnownField field) const =0
Returns an indication whether the specified field is supported by the tag.
virtual const TagValue & value(KnownField field) const =0
Returns the value of the specified field.
virtual bool supportsTarget() const
Returns an indication whether a target is supported by the tag.
#define TAG_PARSER_EXPORT
Marks the symbol to be exported by the tagparser library.
Contains all classes and functions of the TagInfo library.
KnownField
Specifies the field.
TAG_PARSER_EXPORT std::string_view tagTargetLevelName(TagTargetLevel tagTargetLevel)
Returns a string representation for the specified tagTargetLevel.
constexpr unsigned int knownFieldArraySize
The number of valid entries in the TagParser::KnownField enum.
TagTargetLevel
The TagTargetLevel enum specifies tag target levels.
constexpr KnownField nextKnownField(KnownField field)
Returns the next known field skipping any deprecated fields.
TagTextEncoding
Specifies the text encoding.
constexpr KnownField lastKnownField
The last valid entry in the TagParser::KnownField enum.
TagType
Specifies the tag type.
constexpr KnownField firstKnownField
The first valid entry in the TagParser::KnownField enum.
constexpr bool isKnownFieldDeprecated(KnownField field)
Returns whether the specified field is deprecated and should not be used anymore.
TagDataType
Specifies the data type.