Tag Parser 11.5.1
C++ library for reading and writing MP4 (iTunes), ID3, Vorbis, Opus, FLAC and Matroska tags
Loading...
Searching...
No Matches
tagvalue.h
Go to the documentation of this file.
1#ifndef TAG_PARSER_TAGVALUE_H
2#define TAG_PARSER_TAGVALUE_H
3
4#include "./localehelper.h"
5#include "./positioninset.h"
6#include "./tagtype.h"
7
8#include <c++utilities/chrono/datetime.h>
9#include <c++utilities/chrono/timespan.h>
10#include <c++utilities/conversion/binaryconversion.h>
11#include <c++utilities/misc/flagenumclass.h>
12#include <c++utilities/misc/traits.h>
13
14#include <cstdint>
15#include <cstring>
16#include <iosfwd>
17#include <memory>
18#include <string>
19#include <unordered_map>
20
21namespace TagParser {
22
23class Tag;
24class Id3v2Frame;
25
29enum class TagTextEncoding : unsigned int {
30 Latin1,
31 Utf8,
35};
36
43enum class TagValueFlags : std::uint64_t {
44 None,
45 ReadOnly,
46};
47
48} // namespace TagParser
49
51
52namespace TagParser {
53
58constexpr int characterSize(TagTextEncoding encoding)
59{
60 switch (encoding) {
63 return 1;
66 return 2;
67 default:
68 return 0;
69 }
70}
71
74 std::string user;
76 double rating = 0.0;
78 std::uint64_t playCounter = 0;
82 TagType scale = TagType::Unspecified;
83
84 bool scaleTo(TagType targetScale);
85 Popularity scaled(TagType targetScale) const;
86 std::string toString() const;
87 static Popularity fromString(std::string_view str);
88 static Popularity fromString(std::string_view str, TagType scale);
89
91 bool isEmpty() const
92 {
93 return user.empty() && rating == 0.0 && !playCounter;
94 }
95
100 bool operator==(const Popularity &other) const
101 {
102 return playCounter == other.playCounter && rating == other.rating && user == other.user && scale == other.scale;
103 }
104};
105
109inline Popularity Popularity::scaled(TagType targetScale) const
110{
111 auto copy = *this;
112 copy.scaleTo(targetScale);
113 return copy;
114}
115
119enum class TagDataType : unsigned int {
120 Text,
121 Integer,
124 TimeSpan,
125 DateTime,
126 Picture,
127 Binary,
128 Undefined,
129 Popularity,
132};
133
137enum class TagValueComparisionFlags : unsigned int {
138 None,
139 CaseInsensitive = 0x1,
140 IgnoreMetaData = 0x2,
141};
142
144public:
145 // constructor, destructor
146 explicit TagValue();
147 explicit TagValue(const char *text, std::size_t textSize, TagTextEncoding textEncoding = TagTextEncoding::Latin1,
148 TagTextEncoding convertTo = TagTextEncoding::Unspecified);
149 explicit TagValue(
150 const char *text, TagTextEncoding textEncoding = TagTextEncoding::Latin1, TagTextEncoding convertTo = TagTextEncoding::Unspecified);
151 explicit TagValue(
152 const std::string &text, TagTextEncoding textEncoding = TagTextEncoding::Latin1, TagTextEncoding convertTo = TagTextEncoding::Unspecified);
153 explicit TagValue(
154 std::string_view text, TagTextEncoding textEncoding = TagTextEncoding::Latin1, TagTextEncoding convertTo = TagTextEncoding::Unspecified);
155 explicit TagValue(int value);
156 explicit TagValue(std::uint64_t value);
157 explicit TagValue(
158 const char *data, std::size_t length, TagDataType type = TagDataType::Undefined, TagTextEncoding encoding = TagTextEncoding::Latin1);
159 explicit TagValue(std::unique_ptr<char[]> &&data, std::size_t length, TagDataType type = TagDataType::Binary,
160 TagTextEncoding encoding = TagTextEncoding::Latin1);
161 explicit TagValue(PositionInSet value);
162 explicit TagValue(CppUtilities::DateTime value);
163 explicit TagValue(const CppUtilities::DateTimeExpression &value);
164 explicit TagValue(CppUtilities::TimeSpan value);
165 explicit TagValue(const Popularity &value);
166 TagValue(const TagValue &other);
167 TagValue(TagValue &&other) = default;
168 ~TagValue();
169
170 // operators
171 TagValue &operator=(const TagValue &other);
172 TagValue &operator=(TagValue &&other) = default;
173 bool operator==(const TagValue &other) const;
174 bool operator!=(const TagValue &other) const;
175 operator bool() const;
176
177 // methods
178 bool isNull() const;
179 bool isEmpty() const;
180 void clearData();
181 void clearMetadata();
182 void clearDataAndMetadata();
183 TagDataType type() const;
184 std::string toString(TagTextEncoding encoding = TagTextEncoding::Unspecified) const;
185 std::string toDisplayString() const;
186 void toString(std::string &result, TagTextEncoding encoding = TagTextEncoding::Unspecified) const;
187 std::u16string toWString(TagTextEncoding encoding = TagTextEncoding::Unspecified) const;
188 void toWString(std::u16string &result, TagTextEncoding encoding = TagTextEncoding::Unspecified) const;
189 std::int32_t toInteger() const;
190 std::uint64_t toUnsignedInteger() const;
191 int toStandardGenreIndex() const;
192 PositionInSet toPositionInSet() const;
193 CppUtilities::TimeSpan toTimeSpan() const;
194 CppUtilities::DateTime toDateTime() const;
195 CppUtilities::DateTimeExpression toDateTimeExpression() const;
196 Popularity toPopularity() const;
197 Popularity toScaledPopularity(TagType scale = TagType::Unspecified) const;
198 std::size_t dataSize() const;
199 char *dataPointer();
200 const char *dataPointer() const;
201 std::string_view data() const;
202 const std::string &description() const;
203 void setDescription(std::string_view value, TagTextEncoding encoding = TagTextEncoding::Latin1);
204 const std::string &mimeType() const;
205 void setMimeType(std::string_view mimeType);
206 const Locale &locale() const;
207 Locale &locale();
208 void setLocale(const Locale &locale);
209 TagValueFlags flags() const;
210 void setFlags(TagValueFlags flags);
211 bool isLabeledAsReadonly() const;
212 void setReadonly(bool readOnly);
213 const std::unordered_map<std::string, std::string> &nativeData() const;
214 std::unordered_map<std::string, std::string> &nativeData();
215 TagTextEncoding dataEncoding() const;
216 void convertDataEncoding(TagTextEncoding encoding);
217 void convertDataEncodingForTag(const Tag *tag);
218 TagTextEncoding descriptionEncoding() const;
219 void convertDescriptionEncoding(TagTextEncoding encoding);
220 static const TagValue &empty();
221
222 void assignText(const char *text, std::size_t textSize, TagTextEncoding textEncoding = TagTextEncoding::Latin1,
223 TagTextEncoding convertTo = TagTextEncoding::Unspecified);
224 void assignText(
225 const std::string &text, TagTextEncoding textEncoding = TagTextEncoding::Latin1, TagTextEncoding convertTo = TagTextEncoding::Unspecified);
226 void assignText(
227 std::string_view text, TagTextEncoding textEncoding = TagTextEncoding::Latin1, TagTextEncoding convertTo = TagTextEncoding::Unspecified);
228 void assignInteger(int value);
229 void assignUnsignedInteger(std::uint64_t value);
230 void assignStandardGenreIndex(int index);
231 void assignData(const char *data, std::size_t length, TagDataType type = TagDataType::Binary, TagTextEncoding encoding = TagTextEncoding::Latin1);
232 void assignData(std::unique_ptr<char[]> &&data, std::size_t length, TagDataType type = TagDataType::Binary,
233 TagTextEncoding encoding = TagTextEncoding::Latin1);
234 void assignPosition(PositionInSet value);
235 void assignTimeSpan(CppUtilities::TimeSpan value);
236 void assignDateTime(CppUtilities::DateTime value);
237 void assignDateTimeExpression(const CppUtilities::DateTimeExpression &value);
238 void assignPopularity(const Popularity &value);
239
240 static void stripBom(const char *&text, std::size_t &length, TagTextEncoding encoding);
241 static void ensureHostByteOrder(std::u16string &u16str, TagTextEncoding currentEncoding);
242 template <typename ContainerType,
243 CppUtilities::Traits::EnableIf<CppUtilities::Traits::IsIteratable<ContainerType>,
244 std::is_same<typename std::add_const<typename std::remove_pointer<typename ContainerType::value_type>::type>::type, const TagValue>>
245 * = nullptr>
246 static std::vector<std::string> toStrings(const ContainerType &values, TagTextEncoding encoding = TagTextEncoding::Utf8);
247 bool compareTo(const TagValue &other, TagValueComparisionFlags options = TagValueComparisionFlags::None) const;
248 bool compareData(const TagValue &other, bool ignoreCase = false) const;
249 static bool compareData(const std::string &data1, const std::string &data2, bool ignoreCase = false);
250 static bool compareData(const char *data1, std::size_t size1, const char *data2, std::size_t size2, bool ignoreCase = false);
251
252private:
253 std::unique_ptr<char[]> m_ptr;
254 std::size_t m_size;
255 std::string m_desc;
256 std::string m_mimeType;
257 Locale m_locale;
258 std::unordered_map<std::string, std::string> m_nativeData;
259 TagDataType m_type;
260 TagTextEncoding m_encoding;
261 TagTextEncoding m_descEncoding;
262 TagValueFlags m_flags;
263};
264
269 : m_size(0)
270 , m_type(TagDataType::Undefined)
271 , m_encoding(TagTextEncoding::Latin1)
272 , m_descEncoding(TagTextEncoding::Latin1)
273 , m_flags(TagValueFlags::None)
274{
275}
276
281{
282}
283
294inline TagValue::TagValue(const char *text, std::size_t textSize, TagTextEncoding textEncoding, TagTextEncoding convertTo)
295 : m_descEncoding(TagTextEncoding::Latin1)
296 , m_flags(TagValueFlags::None)
297{
298 assignText(text, textSize, textEncoding, convertTo);
299}
300
310inline TagValue::TagValue(const char *text, TagTextEncoding textEncoding, TagTextEncoding convertTo)
311{
312 assignText(text, std::strlen(text), textEncoding, convertTo);
313}
314
324inline TagValue::TagValue(const std::string &text, TagTextEncoding textEncoding, TagTextEncoding convertTo)
325 : m_descEncoding(TagTextEncoding::Latin1)
326 , m_flags(TagValueFlags::None)
327{
328 assignText(text, textEncoding, convertTo);
329}
330
340inline TagValue::TagValue(std::string_view text, TagTextEncoding textEncoding, TagTextEncoding convertTo)
341 : m_descEncoding(TagTextEncoding::Latin1)
342 , m_flags(TagValueFlags::None)
343{
344 assignText(text, textEncoding, convertTo);
345}
346
350inline TagValue::TagValue(int value)
351 : TagValue(reinterpret_cast<const char *>(&value), sizeof(value), TagDataType::Integer)
352{
353}
354
358inline TagParser::TagValue::TagValue(std::uint64_t value)
359 : TagValue(reinterpret_cast<const char *>(&value), sizeof(value), TagDataType::UnsignedInteger)
360{
361}
362
373inline TagValue::TagValue(const char *data, std::size_t length, TagDataType type, TagTextEncoding encoding)
374 : m_size(length)
375 , m_type(type)
376 , m_encoding(encoding)
377 , m_descEncoding(TagTextEncoding::Latin1)
378 , m_flags(TagValueFlags::None)
379{
380 if (length) {
381 if (type == TagDataType::Text) {
382 stripBom(data, m_size, encoding);
383 }
384 m_ptr = std::make_unique<char[]>(m_size);
385 std::copy(data, data + m_size, m_ptr.get());
386 }
387}
388
401inline TagValue::TagValue(std::unique_ptr<char[]> &&data, std::size_t length, TagDataType type, TagTextEncoding encoding)
402 : m_size(length)
403 , m_type(type)
404 , m_encoding(encoding)
405 , m_descEncoding(TagTextEncoding::Latin1)
406 , m_flags(TagValueFlags::None)
407{
408 if (length) {
409 m_ptr = move(data);
410 }
411}
412
417 : TagValue(reinterpret_cast<const char *>(&value), sizeof(value), TagDataType::PositionInSet)
418{
419}
420
424inline TagValue::TagValue(CppUtilities::DateTime value)
425 : TagValue(reinterpret_cast<const char *>(&value), sizeof(value), TagDataType::DateTime)
426{
427}
428
432inline TagValue::TagValue(const CppUtilities::DateTimeExpression &value)
433 : TagValue(reinterpret_cast<const char *>(&value), sizeof(value), TagDataType::DateTimeExpression)
434{
435}
436
440inline TagValue::TagValue(CppUtilities::TimeSpan value)
441 : TagValue(reinterpret_cast<const char *>(&value), sizeof(value), TagDataType::TimeSpan)
442{
443}
444
448inline TagValue::TagValue(const Popularity &value)
449 : TagValue()
450{
451 assignPopularity(value);
452}
453
458inline bool TagValue::operator==(const TagValue &other) const
459{
461}
462
467inline bool TagValue::operator!=(const TagValue &other) const
468{
470}
471
476inline TagParser::TagValue::operator bool() const
477{
478 return !isEmpty();
479}
480
490inline void TagValue::assignText(const std::string &text, TagTextEncoding textEncoding, TagTextEncoding convertTo)
491{
492 assignText(text.data(), text.size(), textEncoding, convertTo);
493}
494
504inline void TagValue::assignText(std::string_view text, TagTextEncoding textEncoding, TagTextEncoding convertTo)
505{
506 assignText(text.data(), text.size(), textEncoding, convertTo);
507}
508
513{
514 if (value.isNull()) {
516 clearData();
517 } else {
518 assignData(reinterpret_cast<const char *>(&value), sizeof(value), TagDataType::PositionInSet);
519 }
520}
521
525inline void TagValue::assignTimeSpan(CppUtilities::TimeSpan value)
526{
527 assignData(reinterpret_cast<const char *>(&value), sizeof(value), TagDataType::TimeSpan);
528}
529
533inline void TagValue::assignDateTime(CppUtilities::DateTime value)
534{
535 assignData(reinterpret_cast<const char *>(&value), sizeof(value), TagDataType::DateTime);
536}
537
541inline void TagParser::TagValue::assignDateTimeExpression(const CppUtilities::DateTimeExpression &value)
542{
543 assignData(reinterpret_cast<const char *>(&value), sizeof(value), TagDataType::DateTimeExpression);
544}
545
552{
553 assignInteger(index);
555}
556
561{
562 return m_type;
563}
564
577inline std::string TagValue::toString(TagTextEncoding encoding) const
578{
579 std::string res;
580 toString(res, encoding);
581 return res;
582}
583
590inline std::u16string TagValue::toWString(TagTextEncoding encoding) const
591{
592 std::u16string res;
593 toWString(res, encoding);
594 return res;
595}
596
604inline bool TagValue::isNull() const
605{
606 return m_ptr == nullptr;
607}
608
617inline bool TagValue::isEmpty() const
618{
619 return m_ptr == nullptr || m_size == 0;
620}
621
629{
630 m_size = 0;
631 m_ptr.reset();
632}
633
640{
641 clearData();
643}
644
649inline std::size_t TagValue::dataSize() const
650{
651 return m_size;
652}
653
661{
662 return m_ptr.get();
663}
664
665inline const char *TagValue::dataPointer() const
666{
667 return m_ptr.get();
668}
669
673inline std::string_view TagValue::data() const
674{
675 return std::string_view(m_ptr.get(), m_size);
676}
677
688inline const std::string &TagValue::description() const
689{
690 return m_desc;
691}
692
704inline void TagValue::setDescription(std::string_view value, TagTextEncoding encoding)
705{
706 m_desc = value;
707 m_descEncoding = encoding;
708}
709
717inline const std::string &TagValue::mimeType() const
718{
719 return m_mimeType;
720}
721
729inline void TagValue::setMimeType(std::string_view mimeType)
730{
731 m_mimeType = mimeType;
732}
733
743inline const Locale &TagValue::locale() const
744{
745 return m_locale;
746}
747
758{
759 return m_locale;
760}
761
771inline void TagValue::setLocale(const Locale &locale)
772{
773 m_locale = locale;
774}
775
781{
782 return m_flags;
783}
784
790{
791 m_flags = flags;
792}
793
804{
805 return m_flags & TagValueFlags::ReadOnly;
806}
807
817inline void TagValue::setReadonly(bool readOnly)
818{
819 CppUtilities::modFlagEnum(m_flags, TagValueFlags::ReadOnly, readOnly);
820}
821
826inline const std::unordered_map<std::string, std::string> &TagValue::nativeData() const
827{
828 return m_nativeData;
829}
830
835inline std::unordered_map<std::string, std::string> &TagValue::nativeData()
836{
837 return m_nativeData;
838}
839
846{
847 return m_encoding;
848}
849
856{
857 return m_descEncoding;
858}
859
865template <typename ContainerType,
866 CppUtilities::Traits::EnableIf<CppUtilities::Traits::IsIteratable<ContainerType>,
867 std::is_same<typename std::add_const<typename std::remove_pointer<typename ContainerType::value_type>::type>::type, const TagValue>> *>
868std::vector<std::string> TagValue::toStrings(const ContainerType &values, TagTextEncoding encoding)
869{
870 std::vector<std::string> res;
871 res.reserve(values.size());
872 for (const auto &value : values) {
873 res.emplace_back(CppUtilities::Traits::dereferenceMaybe(value).toString(encoding));
874 }
875 return res;
876}
877
881inline bool TagValue::compareData(const TagValue &other, bool ignoreCase) const
882{
883 return compareData(m_ptr.get(), m_size, other.m_ptr.get(), other.m_size, ignoreCase);
884}
885
889inline bool TagValue::compareData(const std::string &data1, const std::string &data2, bool ignoreCase)
890{
891 return compareData(data1.data(), data1.size(), data2.data(), data2.size(), ignoreCase);
892}
893
894} // namespace TagParser
895
897
898#endif // TAG_PARSER_TAGVALUE_H
The PositionInSet class describes the position of an element in a set which consists of a certain num...
Definition: positioninset.h:21
constexpr bool isNull() const
Returns an indication whether both the element position and total element count is 0.
Definition: positioninset.h:94
The TagValue class wraps values of different types.
Definition: tagvalue.h:143
bool compareData(const TagValue &other, bool ignoreCase=false) const
Returns whether the raw data of the current instance equals the raw data of other.
Definition: tagvalue.h:881
void setMimeType(std::string_view mimeType)
Sets the MIME type.
Definition: tagvalue.h:729
void setFlags(TagValueFlags flags)
Sets the flags.
Definition: tagvalue.h:789
const std::unordered_map< std::string, std::string > & nativeData() const
Holds tag format specific meta-data for that field which does not fit into any of the other meta-data...
Definition: tagvalue.h:826
void clearMetadata()
Wipes assigned meta data.
Definition: tagvalue.cpp:361
void assignText(const char *text, std::size_t textSize, TagTextEncoding textEncoding=TagTextEncoding::Latin1, TagTextEncoding convertTo=TagTextEncoding::Unspecified)
Assigns a copy of the given text.
Definition: tagvalue.cpp:1066
const std::string & mimeType() const
Returns the MIME type.
Definition: tagvalue.h:717
void assignInteger(int value)
Assigns the given integer value.
Definition: tagvalue.cpp:1117
bool compareTo(const TagValue &other, TagValueComparisionFlags options=TagValueComparisionFlags::None) const
Returns whether both instances are equal.
Definition: tagvalue.cpp:215
TagTextEncoding dataEncoding() const
Returns the data encoding.
Definition: tagvalue.h:845
void assignPosition(PositionInSet value)
Assigns the given PositionInSet value.
Definition: tagvalue.h:512
void assignData(const char *data, std::size_t length, TagDataType type=TagDataType::Binary, TagTextEncoding encoding=TagTextEncoding::Latin1)
TagValue(TagValue &&other)=default
bool operator==(const TagValue &other) const
Returns whether both instances are equal.
Definition: tagvalue.h:458
void setDescription(std::string_view value, TagTextEncoding encoding=TagTextEncoding::Latin1)
Sets the description.
Definition: tagvalue.h:704
TagDataType type() const
Returns the type of the assigned value.
Definition: tagvalue.h:560
void assignPopularity(const Popularity &value)
Assigns the specified popularity value.
Definition: tagvalue.cpp:1188
void assignTimeSpan(CppUtilities::TimeSpan value)
Assigns the given TimeSpan value.
Definition: tagvalue.h:525
void assignDateTimeExpression(const CppUtilities::DateTimeExpression &value)
Assigns the given DateTimeExpression value.
Definition: tagvalue.h:541
static std::vector< std::string > toStrings(const ContainerType &values, TagTextEncoding encoding=TagTextEncoding::Utf8)
Converts the specified values to string using the specified encoding.
Definition: tagvalue.h:868
void clearDataAndMetadata()
Wipes assigned data including meta data.
Definition: tagvalue.h:639
void assignData(std::unique_ptr< char[]> &&data, std::size_t length, TagDataType type=TagDataType::Binary, TagTextEncoding encoding=TagTextEncoding::Latin1)
void assignDateTime(CppUtilities::DateTime value)
Assigns the given DateTime value.
Definition: tagvalue.h:533
bool isLabeledAsReadonly() const
Returns an indication whether the value is labeled as read-only.
Definition: tagvalue.h:803
TagValueFlags flags() const
Returns the flags.
Definition: tagvalue.h:780
bool operator!=(const TagValue &other) const
Returns whether both instances are not equal.
Definition: tagvalue.h:467
~TagValue()
Destroys the TagValue.
Definition: tagvalue.h:280
std::string_view data() const
Returns the currently assigned raw data.
Definition: tagvalue.h:673
TagValue & operator=(TagValue &&other)=default
std::size_t dataSize() const
Returns the size of the assigned value in bytes.
Definition: tagvalue.h:649
std::u16string toWString(TagTextEncoding encoding=TagTextEncoding::Unspecified) const
Converts the value of the current TagValue object to its equivalent std::wstring representation.
Definition: tagvalue.h:590
TagTextEncoding descriptionEncoding() const
Returns the description encoding.
Definition: tagvalue.h:855
void assignStandardGenreIndex(int index)
Assigns the given standard genre index to be assigned.
Definition: tagvalue.h:551
std::string toString(TagTextEncoding encoding=TagTextEncoding::Unspecified) const
Converts the value of the current TagValue object to its equivalent std::string representation.
Definition: tagvalue.h:577
bool isNull() const
Returns whether no value is assigned at all.
Definition: tagvalue.h:604
void setLocale(const Locale &locale)
Sets the setLocale.
Definition: tagvalue.h:771
void setReadonly(bool readOnly)
Sets whether the TagValue is labeled as read-only.
Definition: tagvalue.h:817
static void stripBom(const char *&text, std::size_t &length, TagTextEncoding encoding)
Strips the byte order mask from the specified text.
Definition: tagvalue.cpp:1210
void clearData()
Clears the assigned data.
Definition: tagvalue.h:628
bool isEmpty() const
Returns whether no or an empty value is assigned.
Definition: tagvalue.h:617
const std::string & description() const
Returns the description.
Definition: tagvalue.h:688
const Locale & locale() const
Returns the locale.
Definition: tagvalue.h:743
TagValue()
Constructs an empty TagValue.
Definition: tagvalue.h:268
char * dataPointer()
Returns a pointer to the raw data assigned to the current instance.
Definition: tagvalue.h:660
The Tag class is used to store, read and write tag information.
Definition: tag.h:163
#define TAG_PARSER_EXPORT
Marks the symbol to be exported by the tagparser library.
Contains all classes and functions of the TagInfo library.
Definition: aaccodebook.h:10
constexpr int characterSize(TagTextEncoding encoding)
Returns the size of one character for the specified encoding in bytes.
Definition: tagvalue.h:58
TagTextEncoding
Specifies the text encoding.
Definition: tagvalue.h:29
constexpr bool operator!=(std::uint8_t lhs, FlacMetaDataBlockType type)
Definition: flacmetadata.h:23
constexpr bool operator==(std::uint8_t lhs, FlacMetaDataBlockType type)
Definition: flacmetadata.h:18
TagType
Specifies the tag type.
Definition: tagtype.h:11
TagValueComparisionFlags
The TagValueComparisionOption enum specifies options for TagValue::compareTo().
Definition: tagvalue.h:137
TagValueFlags
Specifies additional flags about the tag value.
Definition: tagvalue.h:43
TagDataType
Specifies the data type.
Definition: tagvalue.h:119
CPP_UTILITIES_MARK_FLAG_ENUM_CLASS(TagParser, TagParser::TagCreationFlags)
The Locale struct specifies a language and/or a country using one or more LocaleDetail objects.
Definition: localehelper.h:61
The Popularity class contains a value for ID3v2's "Popularimeter" field.
Definition: tagvalue.h:72
std::string user
The user who gave the rating / played the file, e.g. identified by e-mail address.
Definition: tagvalue.h:74
bool isEmpty() const
Returns whether the Popularity is empty. The scale and zero-values don't count.
Definition: tagvalue.h:91
bool operator==(const Popularity &other) const
Returns whether two instances are equal.
Definition: tagvalue.h:100
std::uint64_t playCounter
Play counter specific to the user.
Definition: tagvalue.h:78
bool scaleTo(TagType targetScale)
Scales the rating from the current scale to targetScale.
Definition: tagvalue.cpp:1307
Popularity scaled(TagType targetScale) const
Same as Popularity::scaleTo() but returns a new object.
Definition: tagvalue.h:109
TagType scale
Specifies the scale used for rating by the tag defining that scale.
Definition: tagvalue.h:82
double rating
The rating on a tag type specific scale.
Definition: tagvalue.h:76