Funkwhale
/
strawberry-audio-player-windows-mac-linux
mirror of https://github.com/strawberrymusicplayer/strawberry
1
0
Fork 0
Code Issues Releases Wiki Activity
strawberry-audio-player-win.../src/core/song.h

437 lines
12 KiB
C++
Raw Blame History

/*
* Strawberry Music Player
* This file was part of Clementine.
* Copyright 2010, David Sansome <me@davidsansome.com>
* Copyright 2018-2021, Jonas Kvinge <jonas@jkvinge.net>
*
* Strawberry is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Strawberry is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Strawberry. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef SONG_H
#define SONG_H
#include "config.h"
#include <QtGlobal>
#include <QSharedData>
#include <QSharedDataPointer>
#include <QMetaType>
#include <QList>
#include <QSet>
#include <QMap>
#include <QVariant>
#include <QString>
#include <QStringList>
#include <QRegularExpression>
#include <QUrl>
#include <QFileInfo>
#include <QIcon>
class SqlQuery;
namespace Engine {
struct SimpleMetaBundle;
} // namespace Engine
namespace spb {
namespace tagreader {
class SongMetadata;
} // namespace tagreader
} // namespace spb
#ifdef HAVE_LIBGPOD
struct _Itdb_Track;
#endif
#ifdef HAVE_LIBMTP
struct LIBMTP_track_struct;
#endif
class SqlRow;
class Song {
public:
enum class Source {
Unknown = 0,
LocalFile = 1,
Collection = 2,
CDDA = 3,
Device = 4,
Stream = 5,
Tidal = 6,
Subsonic = 7,
Qobuz = 8,
SomaFM = 9,
RadioParadise = 10
};
// Don't change these values - they're stored in the database, and defined in the tag reader protobuf.
// If a new lossless file is added, also add it to IsFileLossless().
enum class FileType {
Unknown = 0,
WAV = 1,
FLAC = 2,
WavPack = 3,
OggFlac = 4,
OggVorbis = 5,
OggOpus = 6,
OggSpeex = 7,
MPEG = 8,
MP4 = 9,
ASF = 10,
AIFF = 11,
MPC = 12,
TrueAudio = 13,
DSF = 14,
DSDIFF = 15,
PCM = 16,
APE = 17,
MOD = 18,
S3M = 19,
XM = 20,
IT = 21,
SPC = 22,
VGM = 23,
CDDA = 90,
Stream = 91
};
Song(Source source = Source::Unknown);
Song(const Song &other);
~Song();
static const QStringList kColumns;
static const QString kColumnSpec;
static const QString kBindSpec;
static const QString kUpdateSpec;
static const QStringList kFtsColumns;
static const QString kFtsColumnSpec;
static const QString kFtsBindSpec;
static const QString kFtsUpdateSpec;
static const QString kManuallyUnsetCover;
static const QString kEmbeddedCover;
static const QRegularExpression kAlbumRemoveDisc;
static const QRegularExpression kAlbumRemoveMisc;
static const QRegularExpression kTitleRemoveMisc;
static const QStringList kArticles;
static const QStringList kAcceptedExtensions;
static QString JoinSpec(const QString &table);
static Source SourceFromURL(const QUrl &url);
static QString TextForSource(const Source source);
static QString DescriptionForSource(const Source source);
static Source SourceFromText(const QString &source);
static QIcon IconForSource(const Source source);
static QString TextForFiletype(const FileType filetype);
static QString ExtensionForFiletype(const FileType filetype);
static QIcon IconForFiletype(const FileType filetype);
QString TextForSource() const { return TextForSource(source()); }
QString DescriptionForSource() const { return DescriptionForSource(source()); }
QIcon IconForSource() const { return IconForSource(source()); }
QString TextForFiletype() const { return TextForFiletype(filetype()); }
QIcon IconForFiletype() const { return IconForFiletype(filetype()); }
bool IsFileLossless() const;
static FileType FiletypeByMimetype(const QString &mimetype);
static FileType FiletypeByDescription(const QString &text);
static FileType FiletypeByExtension(const QString &ext);
static QString ImageCacheDir(const Source source);
// Sort songs alphabetically using their pretty title
static int CompareSongsName(const Song &song1, const Song &song2);
static void SortSongsListAlphabetically(QList<Song> *songs);
// Constructors
void Init(const QString &title, const QString &artist, const QString &album, qint64 length_nanosec);
void Init(const QString &title, const QString &artist, const QString &album, qint64 beginning, qint64 end);
void InitFromProtobuf(const spb::tagreader::SongMetadata &pb);
void InitFromQuery(const SqlRow &query, const bool reliable_metadata);
void InitFromFilePartial(const QString &filename, const QFileInfo &fileinfo);
void InitArtManual();
void InitArtAutomatic();
bool MergeFromSimpleMetaBundle(const Engine::SimpleMetaBundle &bundle);
#ifdef HAVE_LIBGPOD
void InitFromItdb(_Itdb_Track *track, const QString &prefix);
void ToItdb(_Itdb_Track *track) const;
#endif
#ifdef HAVE_LIBMTP
void InitFromMTP(const LIBMTP_track_struct *track, const QString &host);
void ToMTP(LIBMTP_track_struct *track) const;
#endif
// Copies important statistics from the other song to this one, overwriting any data that already exists.
// Useful when you want updated tags from disk but you want to keep user stats.
void MergeUserSetData(const Song &other, const bool merge_playcount, const bool merge_rating);
// Save
void BindToQuery(SqlQuery *query) const;
void BindToFtsQuery(SqlQuery *query) const;
void ToXesam(QVariantMap *map) const;
void ToProtobuf(spb::tagreader::SongMetadata *pb) const;
// Simple accessors
bool is_valid() const;
bool is_unavailable() const;
int id() const;
const QString &title() const;
const QString &title_sortable() const;
const QString &album() const;
const QString &album_sortable() const;
const QString &artist() const;
const QString &artist_sortable() const;
const QString &albumartist() const;
const QString &albumartist_sortable() const;
int track() const;
int disc() const;
int year() const;
int originalyear() const;
const QString &genre() const;
bool compilation() const;
const QString &composer() const;
const QString &performer() const;
const QString &grouping() const;
const QString &comment() const;
const QString &lyrics() const;
QString artist_id() const;
QString album_id() const;
QString song_id() const;
qint64 beginning_nanosec() const;
qint64 end_nanosec() const;
qint64 length_nanosec() const;
int bitrate() const;
int samplerate() const;
int bitdepth() const;
Source source() const;
int directory_id() const;
const QUrl &url() const;
const QString &basefilename() const;
FileType filetype() const;
qint64 filesize() const;
qint64 mtime() const;
qint64 ctime() const;
QString fingerprint() const;
uint playcount() const;
uint skipcount() const;
qint64 lastplayed() const;
qint64 lastseen() const;
bool compilation_detected() const;
bool compilation_off() const;
bool compilation_on() const;
const QUrl &art_automatic() const;
const QUrl &art_manual() const;
const QString &cue_path() const;
bool has_cue() const;
float rating() const;
const QString &effective_album() const;
int effective_originalyear() const;
const QString &effective_albumartist() const;
const QString &effective_albumartist_sortable() const;
bool is_collection_song() const;
bool is_stream() const;
bool is_radio() const;
bool is_cdda() const;
bool is_metadata_good() const;
bool art_automatic_is_valid() const;
bool art_manual_is_valid() const;
bool has_valid_art() const;
bool is_compilation() const;
bool stream_url_can_expire() const;
bool is_module_music() const;
// Playlist views are special because you don't want to fill in album artists automatically for compilations, but you do for normal albums:
const QString &playlist_albumartist() const;
const QString &playlist_albumartist_sortable() const;
// Returns true if this Song had it's cover manually unset by user.
bool has_manually_unset_cover() const;
// This method represents an explicit request to unset this song's cover.
void set_manually_unset_cover();
// Returns true if this song (it's media file) has an embedded cover.
bool has_embedded_cover() const;
// Sets a flag saying that this song (it's media file) has an embedded cover.
void set_embedded_cover();
void clear_art_automatic();
void clear_art_manual();
static bool save_embedded_cover_supported(const FileType filetype);
bool save_embedded_cover_supported() const { return url().isLocalFile() && save_embedded_cover_supported(filetype()) && !has_cue(); };
bool additional_tags_supported() const;
bool albumartist_supported() const;
bool composer_supported() const;
bool performer_supported() const;
bool grouping_supported() const;
bool genre_supported() const;
bool compilation_supported() const;
bool rating_supported() const;
bool comment_supported() const;
bool lyrics_supported() const;
const QUrl &stream_url() const;
const QUrl &effective_stream_url() const;
bool init_from_file() const;
// Pretty accessors
QString PrettyTitle() const;
QString PrettyTitleWithArtist() const;
QString PrettyLength() const;
QString PrettyYear() const;
QString PrettyOriginalYear() const;
QString TitleWithCompilationArtist() const;
QString SampleRateBitDepthToText() const;
QString PrettyRating() const;
// Setters
bool IsEditable() const;
void set_id(const int id);
void set_valid(const bool v);
void set_title(const QString &v);
void set_album(const QString &v);
void set_artist(const QString &v);
void set_albumartist(const QString &v);
void set_track(const int v);
void set_disc(const int v);
void set_year(const int v);
void set_originalyear(int v);
void set_genre(const QString &v);
void set_compilation(bool v);
void set_composer(const QString &v);
void set_performer(const QString &v);
void set_grouping(const QString &v);
void set_comment(const QString &v);
void set_lyrics(const QString &v);
void set_artist_id(const QString &v);
void set_album_id(const QString &v);
void set_song_id(const QString &v);
void set_beginning_nanosec(qint64 v);
void set_end_nanosec(qint64 v);
void set_length_nanosec(qint64 v);
void set_bitrate(const int v);
void set_samplerate(const int v);
void set_bitdepth(const int v);
void set_source(const Source v);
void set_directory_id(const int v);
void set_url(const QUrl &v);
void set_basefilename(const QString &v);
void set_filetype(const FileType v);
void set_filesize(const qint64 v);
void set_mtime(const qint64 v);
void set_ctime(const qint64 v);
void set_unavailable(const bool v);
void set_fingerprint(const QString &v);
void set_playcount(const uint v);
void set_skipcount(const uint v);
void set_lastplayed(const qint64 v);
void set_lastseen(const qint64 v);
void set_compilation_detected(const bool v);
void set_compilation_on(const bool v);
void set_compilation_off(const bool v);
void set_art_automatic(const QUrl &v);
void set_art_manual(const QUrl &v);
void set_cue_path(const QString &v);
void set_rating(const float v);
void set_stream_url(const QUrl &v);
// Comparison functions
bool IsMetadataEqual(const Song &other) const;
bool IsStatisticsEqual(const Song &other) const;
bool IsRatingEqual(const Song &other) const;
bool IsFingerprintEqual(const Song &other) const;
bool IsArtEqual(const Song &other) const;
bool IsAllMetadataEqual(const Song &other) const;
bool IsOnSameAlbum(const Song &other) const;
bool IsSimilar(const Song &other) const;
bool operator==(const Song &other) const;
bool operator!=(const Song &other) const;
// Two songs that are on the same album will have the same AlbumKey.
// It is more efficient to use IsOnSameAlbum, but this function can be used when you need to hash the key to do fast lookups.
QString AlbumKey() const;
Song &operator=(const Song &other);
private:
struct Private;
static QString sortable(const QString &v);
QSharedDataPointer<Private> d;
};
using SongList = QList<Song>;
using SongMap = QMap<QString, Song>;
Q_DECLARE_METATYPE(Song)
Q_DECLARE_METATYPE(SongList)
Q_DECLARE_METATYPE(SongMap)
Q_DECLARE_METATYPE(Song::Source)
Q_DECLARE_METATYPE(Song::FileType)
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
size_t qHash(const Song &song);
#else
uint qHash(const Song &song);
#endif
// Hash function using field checked in IsSimilar function
size_t HashSimilar(const Song &song);
#endif // SONG_H
Reference in New Issue View Git Blame Copy Permalink