MythTV master
musicmetadata.h
Go to the documentation of this file.
1#ifndef MUSICMETADATA_H_
2#define MUSICMETADATA_H_
3
4// C/C++
5#include <array>
6#include <cstdint>
7#include <utility>
8
9// qt
10#include <QCoreApplication>
11#include <QDateTime>
12#include <QImage>
13#include <QMap>
14#include <QMetaType>
15#include <QStringList>
16#include <QTimeZone>
17
18// MythTV
19#include "libmythbase/mthread.h"
22
23class AllMusic;
24class AlbumArtImages;
25class LyricsData;
26class MetaIO;
27
28enum ImageType : std::uint8_t
29{
37};
38
40{
41 public:
43 m_filename(""), m_hostname(""), m_description("") {}
44 explicit AlbumArtImage(const AlbumArtImage * const image) :
45 m_id(image->m_id), m_filename(image->m_filename),
46 m_hostname(image->m_hostname), m_imageType(image->m_imageType),
47 m_description(image->m_description), m_embedded(image->m_embedded) {}
48 int m_id {0};
49 QString m_filename;
50 QString m_hostname;
51 ImageType m_imageType {IT_UNKNOWN};
53 bool m_embedded {false};
54};
55
56using AlbumArtList = QList<AlbumArtImage*>;
57
58enum RepoType : std::uint8_t
59{
61 RT_CD = 1,
62 RT_Radio = 2
63};
64
65static constexpr uint8_t METADATA_BITS_FOR_REPO { 8 };
66static constexpr uint8_t METADATA_REPO_SHIFT { 24 };
67static constexpr uint32_t METADATA_REPO_MASK { 0xff000000 };
68static constexpr uint32_t METADATA_ID_MASK { 0x00ffffff };
69
70static constexpr uint32_t ID_TO_ID(uint32_t x) { return x & METADATA_ID_MASK; };
71static constexpr uint32_t ID_TO_REPO(uint32_t x) { return x >> METADATA_REPO_SHIFT; };
72
73static constexpr const char* METADATA_INVALID_FILENAME { "**NOT FOUND**" };
74
75static constexpr const char* STREAMUPDATEURL { "https://services.mythtv.org/music/data/?data=streams" };
76static constexpr size_t STREAMURLCOUNT { 5 };
77
78using UrlList = std::array<QString,STREAMURLCOUNT>;
79
81{
83
84 public:
85
86 using IdType = uint32_t;
87
88 explicit MusicMetadata(QString lfilename = "", QString lartist = "", QString lcompilation_artist = "",
89 QString lalbum = "", QString ltitle = "", QString lgenre = "",
90 int lyear = 0, int ltracknum = 0, std::chrono::milliseconds llength = 0ms, int lid = 0,
91 int lrating = 0, int lplaycount = 0, QDateTime llastplay = QDateTime(),
92 QDateTime ldateadded = QDateTime(), bool lcompilation = false, QString lformat = "")
93 : m_artist(std::move(lartist)),
94 m_compilationArtist(std::move(lcompilation_artist)),
95 m_album(std::move(lalbum)),
96 m_title(std::move(ltitle)),
97 m_genre(std::move(lgenre)),
98 m_format(std::move(lformat)),
99 m_year(lyear),
100 m_trackNum(ltracknum),
101 m_length(llength),
102 m_rating(lrating),
103 m_lastPlay(std::move(llastplay)),
104 m_dateAdded(std::move(ldateadded)),
105 m_playCount(lplaycount),
106 m_compilation(lcompilation),
107 m_id(lid),
108 m_filename(std::move(lfilename))
109 {
110 checkEmptyFields();
111 }
112
113 MusicMetadata(int lid, QString lbroadcaster, QString lchannel, QString ldescription, const UrlList &lurls, QString llogourl,
114 QString lgenre, QString lmetaformat, QString lcountry, QString llanguage, QString lformat);
115
117
119 {
120 *this = other;
121 }
122
123 MusicMetadata& operator=(const MusicMetadata &rhs);
124
125 QString Artist() const { return m_artist; }
126 QString ArtistSort() const { return m_artistSort; }
127 void setArtist(const QString &lartist,
128 const QString &lartist_sort = nullptr)
129 {
130 m_artist = lartist;
131 m_artistId = -1;
132 m_artistSort = lartist_sort;
133 m_formattedArtist.clear(); m_formattedTitle.clear();
134 ensureSortFields();
135 }
136
137 QString CompilationArtist() const { return m_compilationArtist; }
138 QString CompilationArtistSort() const { return m_compilationArtistSort; }
139 void setCompilationArtist(const QString &lcompilation_artist,
140 const QString &lcompilation_artist_sort = nullptr)
141 {
142 m_compilationArtist = lcompilation_artist;
143 m_compartistId = -1;
144 m_compilationArtistSort = lcompilation_artist_sort;
145 m_formattedArtist.clear(); m_formattedTitle.clear();
146 ensureSortFields();
147 }
148
149 QString Album() const { return m_album; }
150 QString AlbumSort() const { return m_albumSort; }
151 void setAlbum(const QString &lalbum,
152 const QString &lalbum_sort = nullptr)
153 {
154 m_album = lalbum;
155 m_albumId = -1;
156 m_albumSort = lalbum_sort;
157 m_formattedArtist.clear(); m_formattedTitle.clear();
158 ensureSortFields();
159 }
160
161 QString Title() const { return m_title; }
162 QString TitleSort() const { return m_titleSort; }
163 void setTitle(const QString &ltitle,
164 const QString &ltitle_sort = nullptr)
165 {
166 m_title = ltitle;
167 m_titleSort = ltitle_sort;
168 ensureSortFields();
169 }
170
171 QString FormatArtist();
172 QString FormatTitle();
173
174 QString Genre() const { return m_genre; }
175 void setGenre(const QString &lgenre) {
176 m_genre = lgenre;
177 m_genreId = -1;
178 }
179
180 void setDirectoryId(int ldirectoryid) { m_directoryId = ldirectoryid; }
181 int getDirectoryId();
182
183 void setArtistId(int lartistid) { m_artistId = lartistid; }
184 int getArtistId();
185
186 void setCompilationArtistId(int lartistid) { m_compartistId = lartistid; }
187 int getCompilationArtistId();
188
189 void setAlbumId(int lalbumid) { m_albumId = lalbumid; }
190 int getAlbumId();
191
192 void setGenreId(int lgenreid) { m_genreId = lgenreid; }
193 int getGenreId();
194
195 int Year() const { return m_year; }
196 void setYear(int lyear) { m_year = lyear; }
197
198 int Track() const { return m_trackNum; }
199 void setTrack(int ltrack) { m_trackNum = ltrack; }
200
201 int GetTrackCount() const { return m_trackCount; }
202 void setTrackCount(int ltrackcount) { m_trackCount = ltrackcount; }
203
204 std::chrono::milliseconds Length() const { return m_length; }
205 template <typename T, std::enable_if_t<std::chrono::__is_duration<T>::value, bool> = true>
206 void setLength(T llength) { m_length = llength; }
207
208 int DiscNumber() const {return m_discNum;}
209 void setDiscNumber(int discnum) { m_discNum = discnum; }
210
211 int DiscCount() const {return m_discCount;}
212 void setDiscCount(int disccount) { m_discCount = disccount; }
213
214 int Playcount() const { return m_playCount; }
215 void setPlaycount(int lplaycount) { m_playCount = lplaycount; }
216
217 IdType ID() const { return m_id; }
218 void setID(IdType lid) { m_id = lid; }
219 void setRepo(RepoType repo) { m_id = (m_id & METADATA_ID_MASK) | (repo << METADATA_REPO_SHIFT); }
220
221 bool isCDTrack(void) const { return ID_TO_REPO(m_id) == RT_CD; }
222 bool isDBTrack(void) const { return ID_TO_REPO(m_id) == RT_Database; }
223 bool isRadio(void) const { return ID_TO_REPO(m_id) == RT_Radio; }
224
225 QString Filename(bool find = true);
226 void setFilename(const QString &lfilename);
227 QString getLocalFilename(void);
228
229 QString Hostname(void) { return m_hostname; }
230 void setHostname(const QString &host) { m_hostname = host; }
231
232 uint64_t FileSize() const { return m_fileSize; }
233 void setFileSize(uint64_t lfilesize) { m_fileSize = lfilesize; }
234
235 QString Format() const { return m_format; }
236 void setFormat(const QString &lformat) { m_format = lformat; }
237
238 int Rating() const { return m_rating; }
239 void decRating();
240 void incRating();
241 void setRating(int lrating) { m_rating = lrating; }
242
243 QDateTime LastPlay() const { return m_lastPlay; }
244 void setLastPlay();
245 void setLastPlay(const QDateTime& lastPlay);
246
247 int PlayCount() const { return m_playCount; }
248 void incPlayCount();
249
250 // track is part of a compilation album
251 bool Compilation() const { return m_compilation; }
252 void setCompilation(bool state)
253 {
254 m_compilation = state;
255 m_formattedArtist.clear();
256 m_formattedTitle.clear();
257 }
258 bool determineIfCompilation(bool cd = false);
259
260 // for radio streams
261 void setBroadcaster(const QString &broadcaster) { m_broadcaster = broadcaster; }
262 QString Broadcaster(void) { return m_broadcaster; }
263
264 void setChannel(const QString &channel) { m_channel = channel; }
265 QString Channel(void) { return m_channel; }
266
267 void setDescription(const QString &description) { m_description = description; }
268 QString Description(void) { return m_description; }
269
270 void setUrl(const QString &url, size_t index = 0);
271 QString Url(size_t index = 0);
272
273 void setLogoUrl(const QString &logourl) { m_logoUrl = logourl; }
274 QString LogoUrl(void) { return m_logoUrl; }
275
276 void setMetadataFormat(const QString &metaformat) { m_metaFormat = metaformat; }
277 QString MetadataFormat(void) { return m_metaFormat; }
278
279 void setCountry(const QString &country) { m_country = country; }
280 QString Country(void) { return m_country; }
281
282 void setLanguage(const QString &language) { m_language = language; }
283 QString Language(void) { return m_language; }
284
285 void setEmbeddedAlbumArt(AlbumArtList &albumart);
286
287 void reloadMetadata(void);
288 void dumpToDatabase(void);
289 void setField(const QString &field, const QString &data);
290 void getField(const QString& field, QString *data);
291 void toMap(InfoMap &metadataMap, const QString &prefix = "");
292
293 void persist(void);
294
295 bool hasChanged(void) const { return m_changed; }
296
297 bool compare(MusicMetadata *mdata) const;
298
299 // static functions
300 static MusicMetadata *createFromFilename(const QString &filename);
301 static MusicMetadata *createFromID(int trackid);
302 static void setArtistAndTrackFormats();
303 static QStringList fillFieldList(const QString& field);
304 static bool updateStreamList(void);
305
306 // this looks for any image available - preferring a front cover if available
307 QString getAlbumArtFile(void);
308 // this looks only for the given image type
309 QString getAlbumArtFile(ImageType type);
310
311 AlbumArtImages *getAlbumArtImages(void);
312 void reloadAlbumArtImages(void);
313
314 LyricsData *getLyricsData(void);
315
316 MetaIO *getTagger(void);
317
318 private:
319 void setCompilationFormatting(bool cd = false);
320 QString formatReplaceSymbols(const QString &format);
321 void checkEmptyFields(void);
322 void ensureSortFields(void);
323 void saveHostname(void);
324
325 QString m_artist;
329 QString m_album;
330 QString m_albumSort;
331 QString m_title;
332 QString m_titleSort;
335 QString m_genre;
336 QString m_format;
337 int m_year {0};
338 int m_trackNum {0};
339 int m_trackCount {0};
340 int m_discNum {0};
341 int m_discCount {0};
342 std::chrono::milliseconds m_length {0ms};
343 int m_rating {0};
344 int m_directoryId {-1};
345 int m_artistId {-1};
346 int m_compartistId {-1};
347 int m_albumId {-1};
348 int m_genreId {-1};
349 QDateTime m_lastPlay;
350 QDateTime m_tempLastPlay;
351 QDateTime m_dateAdded;
352 int m_playCount {0};
353 int m_tempPlayCount {0};
354 bool m_compilation {false};
355
356 AlbumArtImages *m_albumArt {nullptr};
357
358 LyricsData *m_lyricsData {nullptr};
359
360 IdType m_id {0};
361 QString m_filename; // file name as stored in the DB
362 QString m_hostname; // host where file is located as stored in the DB
363 QString m_actualFilename; // actual URL of the file if found
364 uint64_t m_fileSize {0};
365 bool m_changed {false};
366
367 // radio stream stuff
369 QString m_channel;
372 QString m_logoUrl;
374 QString m_country;
375 QString m_language;
376
377 // Various formatting strings
381 static QString s_formatNormalCdTrack;
382
387};
388
391
394
398
399//---------------------------------------------------------------------------
400
402{
403
404 public:
405
406 explicit MetadataLoadingThread(AllMusic *parent_ptr)
407 : MThread("MetadataLoading"), m_parent(parent_ptr) {}
408 void run() override; // MThread
409
410 private:
411
412 AllMusic *m_parent {nullptr};
413};
414
415//---------------------------------------------------------------------------
416
418{
420
421 public:
422
423 AllMusic(void);
424 ~AllMusic();
425
426 MusicMetadata* getMetadata(int an_id);
427 bool updateMetadata(int an_id, MusicMetadata *the_track);
428 int count() const { return m_numPcs; }
429 int countLoaded() const { return m_numLoaded; }
430 void save();
431 bool startLoading(void);
432 void resync(); // After a CD rip, for example
433
434 // cd stuff
435 void clearCDData(void);
436 void addCDTrack(const MusicMetadata &the_track);
437 bool checkCDTrack(MusicMetadata *the_track);
438 MusicMetadata* getCDMetadata(int m_the_track);
439 QString getCDTitle(void) const { return m_cdTitle; }
440 void setCDTitle(const QString &a_title) { m_cdTitle = a_title; }
441 int getCDTrackCount(void) const { return m_cdData.count(); }
442
443 bool doneLoading() const { return m_doneLoading; }
444 bool cleanOutThreads();
445
446 MetadataPtrList *getAllMetadata(void) { return &m_allMusic; }
447 MetadataPtrList *getAllCDMetadata(void) { return &m_cdData; }
448
449 bool isValidID(int an_id);
450
451 private:
453
454 int m_numPcs {0};
455 int m_numLoaded {0};
456
457 using MusicMap = QMap<int, MusicMetadata*>;
459
460 // cd stuff
461 MetadataPtrList m_cdData; // More than one cd player?
462 QString m_cdTitle;
463
464 MetadataLoadingThread *m_metadataLoader {nullptr};
465 bool m_doneLoading {false};
466
467 int m_playCountMin {0};
468 int m_playCountMax {0};
469 qint64 m_lastPlayMin {0};
470 qint64 m_lastPlayMax {0};
471};
472
473using StreamList = QList<MusicMetadata*>;
474
476{
477 public:
478
479 AllStream(void);
480 ~AllStream();
481
482 void loadStreams(void);
483
484 bool isValidID(MusicMetadata::IdType an_id);
485
486 MusicMetadata* getMetadata(MusicMetadata::IdType an_id);
487
488 StreamList *getStreams(void) { return &m_streamList; }
489
490 void addStream(MusicMetadata *mdata);
491 void removeStream(MusicMetadata *mdata);
492 void updateStream(MusicMetadata *mdata);
493
494 private:
496};
497
498//----------------------------------------------------------------------------
499
501{
502 public:
503 explicit AlbumArtScannerThread(QStringList strList) :
504 MThread("AlbumArtScanner"), m_strList(std::move(strList)) {}
505
506 void run() override; // MThread
507
508 QStringList getResult(void) { return m_strList; }
509
510 private:
511 QStringList m_strList;
512};
513
515{
517
518 public:
519 explicit AlbumArtImages(MusicMetadata *metadata, bool loadFromDB = true);
520 explicit AlbumArtImages(MusicMetadata *metadata, const AlbumArtImages &other);
522
523 void scanForImages(void);
524 void addImage(const AlbumArtImage * newImage);
525 uint getImageCount() { return m_imageList.size(); }
526 AlbumArtImage *getImage(ImageType type);
527 AlbumArtImage *getImageByID(int imageID);
528 QStringList getImageFilenames(void) const;
529 AlbumArtList *getImageList(void) { return &m_imageList; }
530 AlbumArtImage *getImageAt(uint index);
531
532 void dumpToDatabase(void);
533
534 static ImageType guessImageType(const QString &filename);
535 static QString getTypeName(ImageType type);
536 static QString getTypeFilename(ImageType type);
537 static ImageType getImageTypeFromName(const QString &name);
538
539 private:
540 void findImages(void);
541
542 MusicMetadata *m_parent {nullptr};
544};
545
547
548#endif
QString m_filename
Definition: musicmetadata.h:49
AlbumArtImage(const AlbumArtImage *const image)
Definition: musicmetadata.h:44
QString m_description
Definition: musicmetadata.h:52
AlbumArtImage(void)
Definition: musicmetadata.h:42
QString m_hostname
Definition: musicmetadata.h:50
uint getImageCount()
AlbumArtList * getImageList(void)
Q_DECLARE_TR_FUNCTIONS(AlbumArtImages)
AlbumArtList m_imageList
QStringList getResult(void)
AlbumArtScannerThread(QStringList strList)
void run() override
Runs the Qt event loop unless we have a QRunnable, in which case we run the runnable run instead.
QMap< int, MusicMetadata * > MusicMap
MusicMap m_musicMap
int countLoaded() const
int getCDTrackCount(void) const
MetadataPtrList * getAllCDMetadata(void)
MetadataPtrList * getAllMetadata(void)
QString m_cdTitle
Q_DECLARE_TR_FUNCTIONS(AllMusic)
int count() const
QString getCDTitle(void) const
MetadataPtrList m_allMusic
void setCDTitle(const QString &a_title)
MetadataPtrList m_cdData
bool doneLoading() const
StreamList m_streamList
StreamList * getStreams(void)
This is a wrapper around QThread that does several additional things.
Definition: mthread.h:49
Definition: metaio.h:18
MetadataLoadingThread(AllMusic *parent_ptr)
bool isCDTrack(void) const
void setDirectoryId(int ldirectoryid)
QString m_formattedTitle
void setArtistId(int lartistid)
int Year() const
void setRepo(RepoType repo)
bool isRadio(void) const
QString m_albumSort
QString m_format
void setMetadataFormat(const QString &metaformat)
QString m_description
void setID(IdType lid)
void setYear(int lyear)
QString m_compilationArtistSort
void setChannel(const QString &channel)
QString Language(void)
static QString s_formatCompilationCdArtist
void setHostname(const QString &host)
static QString s_formatNormalCdArtist
QString m_artistSort
void setCompilationArtist(const QString &lcompilation_artist, const QString &lcompilation_artist_sort=nullptr)
void setGenre(const QString &lgenre)
bool isDBTrack(void) const
QString Country(void)
void setFormat(const QString &lformat)
QDateTime LastPlay() const
static QString s_formatNormalCdTrack
QString Hostname(void)
QString CompilationArtist() const
void setCompilation(bool state)
QString AlbumSort() const
void setLogoUrl(const QString &logourl)
QString m_titleSort
std::chrono::milliseconds Length() const
void setCountry(const QString &country)
static QString s_formatNormalFileArtist
void setCompilationArtistId(int lartistid)
QString m_logoUrl
void setTrackCount(int ltrackcount)
void setLength(T llength)
QString Broadcaster(void)
QString m_country
QString Title() const
void setTitle(const QString &ltitle, const QString &ltitle_sort=nullptr)
QString m_artist
void setAlbumId(int lalbumid)
QString MetadataFormat(void)
void setLanguage(const QString &language)
int Playcount() const
QString m_language
QString m_broadcaster
QString m_hostname
QString Channel(void)
QString m_filename
int Track() const
IdType ID() const
QString Artist() const
QString m_actualFilename
void setRating(int lrating)
void setPlaycount(int lplaycount)
QString LogoUrl(void)
int DiscNumber() const
static QString s_formatNormalFileTrack
QString TitleSort() const
void setDiscNumber(int discnum)
int Rating() const
void setGenreId(int lgenreid)
void setAlbum(const QString &lalbum, const QString &lalbum_sort=nullptr)
void setDiscCount(int disccount)
QDateTime m_dateAdded
QString Format() const
QString m_compilationArtist
QString ArtistSort() const
bool Compilation() const
QDateTime m_lastPlay
uint64_t FileSize() const
int PlayCount() const
MusicMetadata(QString lfilename="", QString lartist="", QString lcompilation_artist="", QString lalbum="", QString ltitle="", QString lgenre="", int lyear=0, int ltracknum=0, std::chrono::milliseconds llength=0ms, int lid=0, int lrating=0, int lplaycount=0, QDateTime llastplay=QDateTime(), QDateTime ldateadded=QDateTime(), bool lcompilation=false, QString lformat="")
Definition: musicmetadata.h:88
uint32_t IdType
Definition: musicmetadata.h:86
void setTrack(int ltrack)
QString Genre() const
void setBroadcaster(const QString &broadcaster)
QString Album() const
QDateTime m_tempLastPlay
QString CompilationArtistSort() const
static QString s_formatCompilationFileTrack
QString Description(void)
void setArtist(const QString &lartist, const QString &lartist_sort=nullptr)
QString m_channel
bool hasChanged(void) const
Q_DECLARE_TR_FUNCTIONS(MusicMetadata)
int GetTrackCount() const
QString m_metaFormat
void setFileSize(uint64_t lfilesize)
MusicMetadata(const MusicMetadata &other)
static QString s_formatCompilationFileArtist
int DiscCount() const
static QString s_formatCompilationCdTrack
QString m_formattedArtist
void setDescription(const QString &description)
static pid_list_t::iterator find(const PIDInfoMap &map, pid_list_t &list, pid_list_t::iterator begin, pid_list_t::iterator end, bool find_open)
unsigned int uint
Definition: freesurround.h:24
QList< MusicMetadata * > MetadataPtrList
QList< MusicMetadata * > StreamList
ImageType
Definition: musicmetadata.h:29
@ IT_INLAY
Definition: musicmetadata.h:34
@ IT_BACKCOVER
Definition: musicmetadata.h:32
@ IT_LAST
Definition: musicmetadata.h:36
@ IT_UNKNOWN
Definition: musicmetadata.h:30
@ IT_FRONTCOVER
Definition: musicmetadata.h:31
@ IT_ARTIST
Definition: musicmetadata.h:35
@ IT_CD
Definition: musicmetadata.h:33
static constexpr const char * STREAMUPDATEURL
Definition: musicmetadata.h:75
static constexpr uint8_t METADATA_REPO_SHIFT
Definition: musicmetadata.h:66
RepoType
Definition: musicmetadata.h:59
@ RT_Radio
Definition: musicmetadata.h:62
@ RT_CD
Definition: musicmetadata.h:61
@ RT_Database
Definition: musicmetadata.h:60
static constexpr uint8_t METADATA_BITS_FOR_REPO
Definition: musicmetadata.h:65
bool operator==(MusicMetadata &a, MusicMetadata &b)
bool operator!=(MusicMetadata &a, MusicMetadata &b)
static constexpr const char * METADATA_INVALID_FILENAME
Definition: musicmetadata.h:73
QList< AlbumArtImage * > AlbumArtList
Definition: musicmetadata.h:56
static constexpr uint32_t METADATA_ID_MASK
Definition: musicmetadata.h:68
static constexpr size_t STREAMURLCOUNT
Definition: musicmetadata.h:76
std::array< QString, STREAMURLCOUNT > UrlList
Definition: musicmetadata.h:78
Q_DECLARE_METATYPE(ImageType)
static constexpr uint32_t METADATA_REPO_MASK
Definition: musicmetadata.h:67
static constexpr uint32_t ID_TO_ID(uint32_t x)
Definition: musicmetadata.h:70
static constexpr uint32_t ID_TO_REPO(uint32_t x)
Definition: musicmetadata.h:71
#define META_PUBLIC
Definition: mythmetaexp.h:9
QHash< QString, QString > InfoMap
Definition: mythtypes.h:15
void run(const QString &name, Class *object, void(Class::*fn)())
Definition: mconcurrent.h:137
STL namespace.