musicobject.h

Go to the documentation of this file.

#ifndef MUSICOBJECT_H
#define MUSICOBJECT_H

/***************************************************************************
 * This file is part of the TTK Music Player project
 * Copyright (C) 2015 - 2025 Greedysky Studio

 * This program 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.

 * This program 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 this program; If not, see <http://www.gnu.org/licenses/>.
 ***************************************************************************/

#include <QDir>

#include "ttkqtglobal.h"
#include "ttkqtobject.h"

#define TKF_FILE_SUFFIX          "tkf"
#define TKX_FILE_SUFFIX          "tkx"
#define TKM_FILE_SUFFIX          "tkm"
#define TKB_FILE_SUFFIX          "tkb"
//
#define SKN_FILE_SUFFIX          "skn"
#define JPG_FILE_SUFFIX          "jpg"
#define PNG_FILE_SUFFIX          "png"
#define XML_FILE_SUFFIX          "xml"
//
#define LRC_FILE_SUFFIX          "lrc"
#define KRC_FILE_SUFFIX          "krc"
#define QRC_FILE_SUFFIX          "qrc"
#define TRC_FILE_SUFFIX          "trc"
#define YRC_FILE_SUFFIX          "yrc"
#define KSC_FILE_SUFFIX          "ksc"
// playlist ext
#define TPL_FILE_SUFFIX          "tkpl"
#define M3U_FILE_SUFFIX          "m3u"
#define M3U8_FILE_SUFFIX         "m3u8"
#define PLS_FILE_SUFFIX          "pls"
#define WPL_FILE_SUFFIX          "wpl"
#define XSPF_FILE_SUFFIX         "xspf"
#define JSPF_FILE_SUFFIX         "jspf"
#define ASX_FILE_SUFFIX          "asx"
#define CSV_FILE_SUFFIX          "csv"
#define TXT_FILE_SUFFIX          "txt"
#define FPL_FILE_SUFFIX          "fpl"
#define DBPL_FILE_SUFFIX         "dbpl"
// file ext
#define MP3_FILE_SUFFIX          "mp3"
#define APE_FILE_SUFFIX          "ape"
#define FLAC_FILE_SUFFIX         "flac"
#define MP4_FILE_SUFFIX          "mp4"
#define FLV_FILE_SUFFIX          "flv"


#define TKF_FILE                 TTK_STR_CAT(TTK_DOT, TKF_FILE_SUFFIX)
#define TKX_FILE                 TTK_STR_CAT(TTK_DOT, TKX_FILE_SUFFIX)
#define TKM_FILE                 TTK_STR_CAT(TTK_DOT, TKM_FILE_SUFFIX)
#define TKB_FILE                 TTK_STR_CAT(TTK_DOT, TKB_FILE_SUFFIX)
//
#define SKN_FILE                 TTK_STR_CAT(TTK_DOT, SKN_FILE_SUFFIX)
#define JPG_FILE                 TTK_STR_CAT(TTK_DOT, JPG_FILE_SUFFIX)
#define PNG_FILE                 TTK_STR_CAT(TTK_DOT, PNG_FILE_SUFFIX)
#define MP3_FILE                 TTK_STR_CAT(TTK_DOT, MP3_FILE_SUFFIX)
#define TPL_FILE                 TTK_STR_CAT(TTK_DOT, TPL_FILE_SUFFIX)
#define XML_FILE                 TTK_STR_CAT(TTK_DOT, XML_FILE_SUFFIX)
//
#define LRC_FILE                 TTK_STR_CAT(TTK_DOT, LRC_FILE_SUFFIX)
#define KRC_FILE                 TTK_STR_CAT(TTK_DOT, KRC_FILE_SUFFIX)
#define QRC_FILE                 TTK_STR_CAT(TTK_DOT, QRC_FILE_SUFFIX)
#define TRC_FILE                 TTK_STR_CAT(TTK_DOT, TRC_FILE_SUFFIX)
#define YRC_FILE                 TTK_STR_CAT(TTK_DOT, YRC_FILE_SUFFIX)
#define KSC_FILE                 TTK_STR_CAT(TTK_DOT, KSC_FILE_SUFFIX)
// file ext
#define MP3_FILE                 TTK_STR_CAT(TTK_DOT, MP3_FILE_SUFFIX)
#define APE_FILE                 TTK_STR_CAT(TTK_DOT, APE_FILE_SUFFIX)
#define FLAC_FILE                TTK_STR_CAT(TTK_DOT, FLAC_FILE_SUFFIX)
#define MP4_FILE                 TTK_STR_CAT(TTK_DOT, MP4_FILE_SUFFIX)
#define FLV_FILE                 TTK_STR_CAT(TTK_DOT, FLV_FILE_SUFFIX)


#define APPDATA_DIR              TTK_STR_CAT("AppData", TTK_SEPARATOR)
#define APPCACHE_DIR             TTK_STR_CAT("AppCache", TTK_SEPARATOR)
#define APPBACKUP_DIR            TTK_STR_CAT("AppBackup", TTK_SEPARATOR)
#define DOWNLOAD_DIR             TTK_STR_CAT("Downloads", TTK_SEPARATOR)
//
#define LRC_DIR                  TTK_STR_CAT("Lyric", TTK_SEPARATOR)
#define MUSIC_DIR                TTK_STR_CAT("Music", TTK_SEPARATOR)
#define ARCHIVE_DIR              TTK_STR_CAT("Archive", TTK_SEPARATOR)
//
#define LANGUAGE_DIR             TTK_STR_CAT("GLanguage", TTK_SEPARATOR)
#define PLUGINS_DIR              TTK_STR_CAT("GPlugins", TTK_SEPARATOR)
#define THEME_DIR                TTK_STR_CAT("GTheme", TTK_SEPARATOR)
//
#define ART_DIR                  TTK_STR_CAT("Art", TTK_SEPARATOR)
#define BACKGROUND_DIR           TTK_STR_CAT("Background", TTK_SEPARATOR)
#define CACHE_DIR                TTK_STR_CAT("Cache", TTK_SEPARATOR)
#define RESOURCE_DIR             TTK_STR_CAT("resource", TTK_SEPARATOR)
//
#define CONFIG_DIR               TTK_STR_CAT("config", TTK_SEPARATOR)
#define USER_THEME_DIR           TTK_STR_CAT("theme", TTK_SEPARATOR)


#define MAKE_TRANSFORM_NAME      TTK_STR_CAT("avconv", TKX_FILE)
#define MAKE_PLAYER_NAME         TTK_STR_CAT("avplayer", TKX_FILE)
#define MAKE_GAIN_NAME           TTK_STR_CAT("avgain", TKX_FILE)


#define MAKE_CONFIG_DIR          TTK_STR_CAT(PLUGINS_DIR, CONFIG_DIR)
#define MAKE_TRANSFORM_PATH      TTK_STR_CAT(PLUGINS_DIR, MAKE_TRANSFORM_NAME)
#define MAKE_PLAYER_PATH         TTK_STR_CAT(PLUGINS_DIR, MAKE_PLAYER_NAME)
#define MAKE_GAIN_PATH           TTK_STR_CAT(PLUGINS_DIR, MAKE_GAIN_NAME)


#define COFIG_PATH               TTK_STR_CAT("config", XML_FILE)
#define PLAYLIST_PATH            TTK_STR_CAT("playlist", TPL_FILE)
#define NORMAL_DOWN_PATH         TTK_STR_CAT("download", TKF_FILE)
#define CLOUD_DOWN_PATH          TTK_STR_CAT("cdownload", TKF_FILE)
#define CLOUD_UP_PATH            TTK_STR_CAT("cupload", TKF_FILE)
#define SEARCH_PATH              TTK_STR_CAT("search", TKF_FILE)


#define MAIN_DIR_FULL            TTK::applicationPath() + TTK_PARENT_DIR
//
#define DOWNLOAD_DIR_FULL        MAIN_DIR_FULL + DOWNLOAD_DIR
#define APPDATA_DIR_FULL         TTK::configPath() + APPDATA_DIR
#define APPCACHE_DIR_FULL        TTK::configPath() + APPCACHE_DIR
#define APPBACKUP_DIR_FULL       TTK::configPath() + APPBACKUP_DIR
//
#define LRC_DIR_FULL             DOWNLOAD_DIR_FULL + LRC_DIR
#define MUSIC_DIR_FULL           DOWNLOAD_DIR_FULL + MUSIC_DIR
#define ARCHIVE_DIR_DIR_FULL     DOWNLOAD_DIR_FULL + ARCHIVE_DIR
//
#define ART_DIR_FULL             APPCACHE_DIR_FULL + ART_DIR
#define BACKGROUND_DIR_FULL      APPCACHE_DIR_FULL + BACKGROUND_DIR
#define CACHE_DIR_FULL           APPCACHE_DIR_FULL + CACHE_DIR
#define RESOURCE_DIR_FULL        APPCACHE_DIR_FULL + RESOURCE_DIR
//
#define COFIG_PATH_FULL          APPDATA_DIR_FULL + COFIG_PATH
#define PLAYLIST_PATH_FULL       APPDATA_DIR_FULL + PLAYLIST_PATH
#define NORMAL_DOWN_PATH_FULL    APPDATA_DIR_FULL + NORMAL_DOWN_PATH
#define CLOUD_DOWN_PATH_FULL     APPDATA_DIR_FULL + CLOUD_DOWN_PATH
#define CLOUD_UP_PATH_FULL       APPDATA_DIR_FULL + CLOUD_UP_PATH
#define SEARCH_PATH_FULL         APPDATA_DIR_FULL + SEARCH_PATH
#define USER_THEME_DIR_FULL      APPDATA_DIR_FULL + USER_THEME_DIR


#define THEME_DIR_FULL           TTK::applicationPath() + THEME_DIR
#define PLUGINS_DIR_FULL         TTK::applicationPath() + PLUGINS_DIR
#define LANGUAGE_DIR_FULL        TTK::applicationPath() + LANGUAGE_DIR


#define MAKE_CONFIG_DIR_FULL     TTK::applicationPath() + MAKE_CONFIG_DIR
#define MAKE_TRANSFORM_PATH_FULL TTK::applicationPath() + MAKE_TRANSFORM_PATH
#define MAKE_PLAYER_PATH_FULL    TTK::applicationPath() + MAKE_PLAYER_PATH
#define MAKE_GAIN_PATH_FULL      TTK::applicationPath() + MAKE_GAIN_PATH


#define WINDOW_WIDTH_MIN         1000
#define WINDOW_HEIGHT_MIN        665
#define LEFT_SIDE_WIDTH_MIN      320
#define CONCISE_WIDTH_MIN        LEFT_SIDE_WIDTH_MIN + 2


namespace TTK
{
    enum class PlayState
    {
        Stopped,           
        Playing,           
        Paused             
    };

    enum class PlayMode
    {
        Order,             
        Random,            
        ListLoop,          
        OneLoop,           
        Once               
    };

    enum class FontStyleMode
    {
        Bold =       0x0001,   
        Italic =     0x0002,   
        Underline =  0x0004,   
        Overline =   0x0008,   
        StrikeOut =  0x0010,   
        FixedPitch = 0x0020,   
        Kerningt =   0x0040    
    };

    enum class QueryQuality
    {
        None,            
        Standard,        
        High,            
        Super,           
        Lossless         
    };


    struct IndexProperty
    {
        int m_first;
        int m_second;

        IndexProperty() = default;
        IndexProperty(int first, int second) noexcept
            : m_first(first),
              m_second(second)
        {

        }
    };
    TTK_DECLARE_LIST(IndexProperty);


    struct MusicSongProperty
    {
        int m_bitrate;
        QString m_format;
        QString m_url;
        QString m_size;

        MusicSongProperty() noexcept
            : m_bitrate(-1)
        {

        }

        inline bool isEmpty() const noexcept
        {
            return m_url.isEmpty();
        }

        inline bool operator< (const MusicSongProperty &other) const noexcept
        {
            return m_bitrate < other.m_bitrate;
        }

        inline bool operator== (const MusicSongProperty &other) const noexcept
        {
            return m_bitrate == other.m_bitrate || m_url == other.m_url;
        }
    };
    TTK_DECLARE_LIST(MusicSongProperty);


    struct MusicArtistProperty
    {
        QString m_id;
        QString m_name;

        MusicArtistProperty() = default;
        MusicArtistProperty(const QString &id, const QString &name) noexcept
            : m_id(id),
              m_name(name)
        {

        }

        inline bool isEmpty() const noexcept
        {
            return m_id.isEmpty() || m_name.isEmpty();
        }
    };
    TTK_DECLARE_LIST(MusicArtistProperty);


    struct MusicSongInformation
    {
        QString m_songId;
        QString m_songName;
        QString m_artistId;
        QString m_artistName;
        QString m_albumId;
        QString m_albumName;
        QString m_coverUrl;
        QString m_lrcUrl;
        QString m_duration;
        QString m_year;
        QString m_trackNumber;
        QString m_formatProps;
        MusicSongPropertyList m_songProps;
    };
    TTK_DECLARE_LIST(MusicSongInformation);


    inline static QString configPath()
    {
        const bool portable = QFile::exists(MAIN_DIR_FULL + "ttk_portable");
#ifdef Q_OS_WIN
        return (portable ? MAIN_DIR_FULL : QString::fromLocal8Bit(getenv("APPDATA")) + TTK_SEPARATOR) + "ttkmp/";
#else
        return (portable ? MAIN_DIR_FULL : QDir::homePath() + TTK_SEPARATOR) + ".config/ttkmp/";
#endif
    }
}

#endif // MUSICOBJECT_H