Tag Parser
7.1.0
C++ library for reading and writing MP4 (iTunes), ID3, Vorbis, Opus, FLAC and Matroska tags
|
The TagValue class wraps values of different types. More...
#include <tagvalue.h>
Public Member Functions | |
TagValue () | |
Constructs an empty TagValue. More... | |
TagValue (const char *text, std::size_t textSize, TagTextEncoding textEncoding=TagTextEncoding::Latin1, TagTextEncoding convertTo=TagTextEncoding::Unspecified) | |
Constructs a new TagValue holding a copy of the given text. More... | |
TagValue (const char *text, TagTextEncoding textEncoding=TagTextEncoding::Latin1, TagTextEncoding convertTo=TagTextEncoding::Unspecified) | |
Constructs a new TagValue holding a copy of the given text. More... | |
TagValue (const std::string &text, TagTextEncoding textEncoding=TagTextEncoding::Latin1, TagTextEncoding convertTo=TagTextEncoding::Unspecified) | |
Constructs a new TagValue holding a copy of the given text. More... | |
TagValue (int value) | |
Constructs a new TagValue holding the given integer value. More... | |
TagValue (const char *data, std::size_t length, TagDataType type=TagDataType::Undefined, TagTextEncoding encoding=TagTextEncoding::Latin1) | |
Constructs a new TagValue with a copy of the given data. More... | |
TagValue (std::unique_ptr< char[]> &&data, std::size_t length, TagDataType type=TagDataType::Binary, TagTextEncoding encoding=TagTextEncoding::Latin1) | |
Constructs a new TagValue holding with the given data. More... | |
TagValue (const PositionInSet &value) | |
Constructs a new TagValue holding a copy of the given PositionInSet value. More... | |
TagValue (const TagValue &other) | |
Constructs a new TagValue holding a copy of the given TagValue instance. More... | |
TagValue (TagValue &&other)=default | |
~TagValue () | |
Destroys the TagValue. More... | |
TagValue & | operator= (const TagValue &other) |
Assigns the value of another TagValue to the current instance. More... | |
TagValue & | operator= (TagValue &&other)=default |
bool | operator== (const TagValue &other) const |
Returns whether both instances are equal. More... | |
bool | operator!= (const TagValue &other) const |
Returns whether both instances are not equal. More... | |
bool | isEmpty () const |
Returns an indication whether an value is assigned. More... | |
void | clearData () |
Clears the assigned data. More... | |
void | clearMetadata () |
Wipes assigned meta data. More... | |
void | clearDataAndMetadata () |
Wipes assigned data including meta data. More... | |
TagDataType | type () const |
Returns the type of the assigned value. More... | |
std::string | toString (TagTextEncoding encoding=TagTextEncoding::Unspecified) const |
Converts the value of the current TagValue object to its equivalent std::string representation. More... | |
void | toString (std::string &result, TagTextEncoding encoding=TagTextEncoding::Unspecified) const |
Converts the value of the current TagValue object to its equivalent std::string representation. More... | |
std::u16string | toWString (TagTextEncoding encoding=TagTextEncoding::Unspecified) const |
Converts the value of the current TagValue object to its equivalent std::wstring representation. More... | |
void | toWString (std::u16string &result, TagTextEncoding encoding=TagTextEncoding::Unspecified) const |
Converts the value of the current TagValue object to its equivalent std::u16string representation. More... | |
int32 | toInteger () const |
Converts the value of the current TagValue object to its equivalent integer representation. More... | |
int | toStandardGenreIndex () const |
Converts the value of the current TagValue object to its equivalent standard genre index. More... | |
PositionInSet | toPositionInSet () const |
Converts the value of the current TagValue object to its equivalent PositionInSet representation. More... | |
ChronoUtilities::TimeSpan | toTimeSpan () const |
Converts the value of the current TagValue object to its equivalent TimeSpan representation. More... | |
ChronoUtilities::DateTime | toDateTime () const |
Converts the value of the current TagValue object to its equivalent DateTime representation. More... | |
std::size_t | dataSize () const |
Returns the size of the assigned value in bytes. More... | |
char * | dataPointer () |
Returns a pointer to the raw data assigned to the current instance. More... | |
const char * | dataPointer () const |
const std::string & | description () const |
Returns the description. More... | |
void | setDescription (const std::string &value, TagTextEncoding encoding=TagTextEncoding::Latin1) |
Sets the description. More... | |
const std::string & | mimeType () const |
Returns the MIME type. More... | |
void | setMimeType (const std::string &mimeType) |
Sets the MIME type. More... | |
const std::string & | language () const |
Returns the language. More... | |
void | setLanguage (const std::string &language) |
Sets the language. More... | |
bool | isLabeledAsReadonly () const |
Returns an indication whether the value is labeled as read-only. More... | |
void | setReadonly (bool readOnly) |
Sets whether the TagValue is labeled as read-only. More... | |
TagTextEncoding | dataEncoding () const |
Returns the data encoding. More... | |
void | convertDataEncoding (TagTextEncoding encoding) |
Converts the currently assigned text value to the specified encoding. More... | |
void | convertDataEncodingForTag (const Tag *tag) |
Ensures the encoding of the currently assigned text value is supported by the specified tag. More... | |
TagTextEncoding | descriptionEncoding () const |
Returns the description encoding. More... | |
void | assignText (const char *text, std::size_t textSize, TagTextEncoding textEncoding=TagTextEncoding::Latin1, TagTextEncoding convertTo=TagTextEncoding::Unspecified) |
Assigns a copy of the given text. More... | |
void | assignText (const std::string &text, TagTextEncoding textEncoding=TagTextEncoding::Latin1, TagTextEncoding convertTo=TagTextEncoding::Unspecified) |
Assigns a copy of the given text. More... | |
void | assignInteger (int value) |
Assigns the given integer value. More... | |
void | assignStandardGenreIndex (int index) |
Assigns the given standard genre index to be assigned. More... | |
void | assignData (const char *data, std::size_t length, TagDataType type=TagDataType::Binary, TagTextEncoding encoding=TagTextEncoding::Latin1) |
void | assignData (std::unique_ptr< char[]> &&data, std::size_t length, TagDataType type=TagDataType::Binary, TagTextEncoding encoding=TagTextEncoding::Latin1) |
void | assignPosition (PositionInSet value) |
Assigns the given PositionInSet value. More... | |
void | assignTimeSpan (ChronoUtilities::TimeSpan value) |
Assigns the given TimeSpan value. More... | |
void | assignDateTime (ChronoUtilities::DateTime value) |
Assigns the given DateTime value. More... | |
Static Public Member Functions | |
static const TagValue & | empty () |
Returns an empty TagValue. More... | |
static void | stripBom (const char *&text, std::size_t &length, TagTextEncoding encoding) |
Strips the byte order mask from the specified text. More... | |
static void | ensureHostByteOrder (std::u16string &u16str, TagTextEncoding currentEncoding) |
Ensures the byte-order of the specified UTF-16 string matches the byte-order of the machine. More... | |
The TagValue class wraps values of different types.
It is meant to be assigned to a tag field.
For a list of supported types see TagParser::TagDataType.
Definition at line 64 of file tagvalue.h.
|
inline |
Constructs an empty TagValue.
Definition at line 151 of file tagvalue.h.
|
inline |
Constructs a new TagValue holding a copy of the given text.
text | Specifies the text to be assigned. |
textSize | Specifies the size of text. (The actual number of bytes, not the number of characters.) |
textEncoding | Specifies the encoding of the given text. |
convertTo | Specifies the encoding to convert text to; set to TagTextEncoding::Unspecified to use textEncoding without any character set conversions. |
Throws | a ConversionException if the conversion the specified character set fails. |
Definition at line 177 of file tagvalue.h.
|
inline |
Constructs a new TagValue holding a copy of the given text.
text | Specifies the text to be assigned. This string must be null-terminated. |
textEncoding | Specifies the encoding of the given text. |
convertTo | Specifies the encoding to convert text to; set to TagTextEncoding::Unspecified to use textEncoding without any character set conversions. |
Throws | a ConversionException if the conversion the specified character set fails. |
Definition at line 193 of file tagvalue.h.
|
inline |
Constructs a new TagValue holding a copy of the given text.
text | Specifies the text to be assigned. |
textEncoding | Specifies the encoding of the given text. |
convertTo | Specifies the encoding to convert text to; set to TagTextEncoding::Unspecified to use textEncoding without any character set conversions. |
Throws | a ConversionException if the conversion the specified character set fails. |
Definition at line 207 of file tagvalue.h.
|
inline |
Constructs a new TagValue holding the given integer value.
Definition at line 217 of file tagvalue.h.
|
inline |
Constructs a new TagValue with a copy of the given data.
data | Specifies a pointer to the data. |
length | Specifies the length of the data. |
type | Specifies the type of the data as TagDataType. |
encoding | Specifies the encoding of the data as TagTextEncoding. The encoding will only be considered if a text is assigned. |
Definition at line 232 of file tagvalue.h.
|
inline |
Constructs a new TagValue holding with the given data.
The data is not copied. It is moved.
data | Specifies a pointer to the data. |
length | Specifies the length of the data. |
type | Specifies the type of the data as TagDataType. |
encoding | Specifies the encoding of the data as TagTextEncoding. The encoding will only be considered if a text is assigned. |
Definition at line 260 of file tagvalue.h.
|
inline |
Constructs a new TagValue holding a copy of the given PositionInSet value.
value | Specifies the PositionInSet. |
Definition at line 277 of file tagvalue.h.
TagParser::TagValue::TagValue | ( | const TagValue & | other | ) |
Constructs a new TagValue holding a copy of the given TagValue instance.
other | Specifies another TagValue instance. |
Definition at line 59 of file tagvalue.cpp.
|
default |
|
inline |
Destroys the TagValue.
Definition at line 163 of file tagvalue.h.
void TagParser::TagValue::assignData | ( | const char * | data, |
std::size_t | length, | ||
TagDataType | type = TagDataType::Binary , |
||
TagTextEncoding | encoding = TagTextEncoding::Latin1 |
||
) |
void TagParser::TagValue::assignData | ( | std::unique_ptr< char[]> && | data, |
std::size_t | length, | ||
TagDataType | type = TagDataType::Binary , |
||
TagTextEncoding | encoding = TagTextEncoding::Latin1 |
||
) |
|
inline |
Assigns the given DateTime value.
Definition at line 329 of file tagvalue.h.
void TagParser::TagValue::assignInteger | ( | int | value | ) |
Assigns the given integer value.
value | Specifies the integer to be assigned. |
Definition at line 630 of file tagvalue.cpp.
|
inline |
Assigns the given PositionInSet value.
Definition at line 308 of file tagvalue.h.
|
inline |
Assigns the given standard genre index to be assigned.
index | Specifies the index to be assigned. |
Definition at line 339 of file tagvalue.h.
void TagParser::TagValue::assignText | ( | const char * | text, |
std::size_t | textSize, | ||
TagTextEncoding | textEncoding = TagTextEncoding::Latin1 , |
||
TagTextEncoding | convertTo = TagTextEncoding::Unspecified |
||
) |
Assigns a copy of the given text.
text | Specifies the text to be assigned. |
textSize | Specifies the size of text. (The actual number of bytes, not the number of characters.) |
textEncoding | Specifies the encoding of the given text. |
convertTo | Specifies the encoding to convert text to; set to TagTextEncoding::Unspecified to use textEncoding without any character set conversions. |
Throws | a ConversionException if the conversion the specified character set fails. |
Definition at line 579 of file tagvalue.cpp.
|
inline |
Assigns a copy of the given text.
text | Specifies the text to be assigned. |
textEncoding | Specifies the encoding of the given text. |
convertTo | Specifies the encoding to convert text to; set to TagTextEncoding::Unspecified to use textEncoding without any character set conversions. |
Throws | a ConversionException if the conversion the specified character set fails. |
Definition at line 300 of file tagvalue.h.
|
inline |
Assigns the given TimeSpan value.
Definition at line 321 of file tagvalue.h.
|
inline |
Clears the assigned data.
Definition at line 395 of file tagvalue.h.
|
inline |
Wipes assigned data including meta data.
Definition at line 406 of file tagvalue.h.
void TagParser::TagValue::clearMetadata | ( | ) |
Wipes assigned meta data.
Definition at line 161 of file tagvalue.cpp.
void TagParser::TagValue::convertDataEncoding | ( | TagTextEncoding | encoding | ) |
Converts the currently assigned text value to the specified encoding.
Throws | ConversionUtilities::ConversionException() if the conversion fails. |
Definition at line 369 of file tagvalue.cpp.
void TagParser::TagValue::convertDataEncodingForTag | ( | const Tag * | tag | ) |
Ensures the encoding of the currently assigned text value is supported by the specified tag.
Definition at line 411 of file tagvalue.cpp.
|
inline |
Returns the data encoding.
Definition at line 535 of file tagvalue.h.
|
inline |
Returns a pointer to the raw data assigned to the current instance.
Definition at line 427 of file tagvalue.h.
|
inline |
Definition at line 432 of file tagvalue.h.
|
inline |
Returns the size of the assigned value in bytes.
Definition at line 416 of file tagvalue.h.
|
inline |
Returns the description.
Definition at line 443 of file tagvalue.h.
|
inline |
Returns the description encoding.
Definition at line 545 of file tagvalue.h.
|
static |
Returns an empty TagValue.
Definition at line 737 of file tagvalue.cpp.
|
static |
Ensures the byte-order of the specified UTF-16 string matches the byte-order of the machine.
Definition at line 717 of file tagvalue.cpp.
|
inline |
Returns an indication whether an value is assigned.
Definition at line 384 of file tagvalue.h.
|
inline |
Returns an indication whether the value is labeled as read-only.
Definition at line 512 of file tagvalue.h.
|
inline |
Returns the language.
Definition at line 488 of file tagvalue.h.
|
inline |
Returns the MIME type.
Definition at line 467 of file tagvalue.h.
|
inline |
Returns whether both instances are not equal.
Definition at line 286 of file tagvalue.h.
Assigns the value of another TagValue to the current instance.
Definition at line 78 of file tagvalue.cpp.
bool TagParser::TagValue::operator== | ( | const TagValue & | other | ) | const |
Returns whether both instances are equal.
If the data types are not equal, two instances are still considered equal if the string representation is identical. The encoding and meta data must be equal as well if relevant for the data type.
Definition at line 108 of file tagvalue.cpp.
|
inline |
Sets the description.
value | Specifies the description. |
encoding | Specifies the encoding used to provide the description. |
Definition at line 456 of file tagvalue.h.
|
inline |
Sets the language.
value | Specifies the language. |
Definition at line 499 of file tagvalue.h.
|
inline |
Sets the MIME type.
value | Specifies the mime type. |
Definition at line 478 of file tagvalue.h.
|
inline |
Sets whether the TagValue is labeled as read-only.
Definition at line 525 of file tagvalue.h.
|
static |
Strips the byte order mask from the specified text.
Definition at line 688 of file tagvalue.cpp.
DateTime TagParser::TagValue::toDateTime | ( | ) | const |
Converts the value of the current TagValue object to its equivalent DateTime representation.
Throws | ConversionException on failure. |
Definition at line 319 of file tagvalue.cpp.
int32 TagParser::TagValue::toInteger | ( | ) | const |
Converts the value of the current TagValue object to its equivalent integer representation.
Throws | ConversionException on failure. |
Definition at line 177 of file tagvalue.cpp.
PositionInSet TagParser::TagValue::toPositionInSet | ( | ) | const |
Converts the value of the current TagValue object to its equivalent PositionInSet representation.
Throws | ConversionException on failure. |
Definition at line 253 of file tagvalue.cpp.
int TagParser::TagValue::toStandardGenreIndex | ( | ) | const |
Converts the value of the current TagValue object to its equivalent standard genre index.
Throws | ConversionException on failure. |
Definition at line 212 of file tagvalue.cpp.
|
inline |
Converts the value of the current TagValue object to its equivalent std::string representation.
encoding | Specifies the encoding to to be used; set to TagTextEncoding::Unspecified to use the present encoding without any character set conversion. |
Throws | ConversionException on failure. |
Definition at line 360 of file tagvalue.h.
void TagParser::TagValue::toString | ( | std::string & | result, |
TagTextEncoding | encoding = TagTextEncoding::Unspecified |
||
) | const |
Converts the value of the current TagValue object to its equivalent std::string representation.
result | Specifies the string to store the result. |
encoding | Specifies the encoding to to be used; set to TagTextEncoding::Unspecified to use the present encoding without any character set conversion. |
Throws | ConversionException on failure. |
Definition at line 427 of file tagvalue.cpp.
TimeSpan TagParser::TagValue::toTimeSpan | ( | ) | const |
Converts the value of the current TagValue object to its equivalent TimeSpan representation.
Throws | ConversionException on failure. |
Definition at line 291 of file tagvalue.cpp.
|
inline |
Converts the value of the current TagValue object to its equivalent std::wstring representation.
Throws | ConversionException on failure. |
Definition at line 373 of file tagvalue.h.
void TagParser::TagValue::toWString | ( | std::u16string & | result, |
TagTextEncoding | encoding = TagTextEncoding::Unspecified |
||
) | const |
Converts the value of the current TagValue object to its equivalent std::u16string representation.
Throws | ConversionException on failure. |
Definition at line 503 of file tagvalue.cpp.
|
inline |
Returns the type of the assigned value.
Definition at line 348 of file tagvalue.h.