musicsong.h

Go to the documentation of this file.

#ifndef MUSICSONG_H
#define MUSICSONG_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 "ttktime.h"
#include "musicstringutils.h"

class TTK_MODULE_EXPORT MusicSong
{
    TTK_DECLARE_MODULE(MusicSong)
public:
    enum class Sort
    {
        ByFileName,      
        BySinger,        
        ByFileSize,      
        ByAddTime,       
        ByDuration,      
        ByPlayCount      
    };

    MusicSong() noexcept;
    explicit MusicSong(const QString &path, bool track = false) noexcept;
    MusicSong(const QString &path, const QString &duration, const QString &name = {}, bool track = false) noexcept;

    QString title() const noexcept;
    QString artist() const noexcept;

    inline void setAddTimeStr(const QString &t) noexcept { m_addTimeStr = t; }
    inline QString addTimeStr() const noexcept { return m_addTimeStr; }
    inline void setSizeStr(const QString &s) noexcept { m_sizeStr = s; }
    inline QString sizeStr() const noexcept { return m_sizeStr; }

    inline void setName(const QString &n) noexcept { m_name = n; }
    inline QString name() const noexcept { return m_name; }
    inline void setPath(const QString &p) noexcept { m_path = p; }
    inline QString path() const noexcept { return m_path; }
    inline void setFormat(const QString &t) noexcept { m_format = t; }
    inline QString format() const noexcept { return m_format; }
    inline void setDuration(const QString &t) noexcept { m_duration = t; }
    inline QString duration() const noexcept { return m_duration; }
    inline qint64 size() const noexcept { return m_size; }
    inline void setPlayCount(const int c) noexcept { m_playCount = c; }
    inline int playCount() const noexcept { return m_playCount; }
    inline void setSort(const Sort s) noexcept { m_sort = s; }

    bool operator== (const MusicSong &other) const noexcept;
    bool operator< (const MusicSong &other) const noexcept;
    bool operator> (const MusicSong &other) const noexcept;

private:
    Sort m_sort;
    qint64 m_size, m_addTime;
    QString m_sizeStr, m_addTimeStr;
    int m_playCount;
    QString m_name, m_path, m_format, m_duration;

};
TTK_DECLARE_LIST(MusicSong);


struct TTK_MODULE_EXPORT MusicSongSort
{
    int m_type;
    Qt::SortOrder m_order;

    MusicSongSort()
        : m_type(-1),
          m_order(Qt::AscendingOrder)
    {

    }
};


class MusicAbstractSongsListTableWidget;

struct TTK_MODULE_EXPORT MusicSongItem
{
    int m_id;
    int m_itemIndex;
    QString m_itemName;
    MusicSongSort m_sort;
    MusicSongList m_songs;
    MusicAbstractSongsListTableWidget *m_itemWidget;

    MusicSongItem()
        : m_id(-1),
          m_itemIndex(-1),
          m_itemWidget(nullptr)
    {

    }

    inline bool operator<(const MusicSongItem &other) const noexcept
    {
        return m_itemIndex < other.m_itemIndex;
    }
};
TTK_DECLARE_LIST(MusicSongItem);


namespace TTK
{
    TTK_MODULE_EXPORT bool playlistRowValid(int index);
    TTK_MODULE_EXPORT QString trackRelatedPath(const QString &path);

    TTK_MODULE_EXPORT QString generateSongName(const QString &title, const QString &artist);
    TTK_MODULE_EXPORT QString generateSongTitle(const QString &name, const QString &key = TTK_DEFAULT_STR);
    TTK_MODULE_EXPORT QString generateSongArtist(const QString &name, const QString &key = TTK_DEFAULT_STR);
    TTK_MODULE_EXPORT MusicSongList generateSongList(const QString &path);

    TTK_MODULE_EXPORT QString generateNetworkSongTime(const QString &path);
    TTK_MODULE_EXPORT QString generateNetworkSongPath(const QString &path);

}

#endif // MUSICSONG_H