musicplaylist.h

Go to the documentation of this file.

#ifndef MUSICPLAYLIST_H
#define MUSICPLAYLIST_H

/***************************************************************************
 * This file is part of the TTK Music Player project
 * Copyright (C) 2015 - 2026 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 "musicglobaldefine.h"

struct TTK_MODULE_EXPORT MusicPlayItem
{
    int m_playlistRow;
    QString m_path;

    MusicPlayItem() noexcept
        : m_playlistRow(-1)
    {

    }

    MusicPlayItem(int index, const QString &path) noexcept
        : m_playlistRow(index),
          m_path(path)
    {

    }

    inline bool isValid() const noexcept
    {
        return m_playlistRow != -1 && !m_path.isEmpty();
    }

    inline bool operator== (const MusicPlayItem &other) const noexcept
    {
        return m_playlistRow == other.m_playlistRow && m_path == other.m_path;
    }
};
TTK_DECLARE_LIST(MusicPlayItem);

static constexpr int PLAY_NEXT_LEVEL = -123;
static constexpr int PLAY_PREVIOUS_LEVEL = -321;

class TTK_MODULE_EXPORT MusicPlaylist : public QObject
{
    Q_OBJECT
public:
    explicit MusicPlaylist(QObject *parent = nullptr);

    void setShuffleMode(bool shuffle) noexcept;

    TTK::PlayMode playbackMode() const noexcept;
    void setPlaybackMode(TTK::PlayMode mode) noexcept;

    int currentIndex() const noexcept;
    MusicPlayItem currentItem() const noexcept;

    const MusicPlayItemList& mediaList() const noexcept;
    const MusicPlayItemList& queueList() const noexcept;

    int count() const noexcept;
    bool isEmpty() const noexcept;
    void clear();

    void update(const TTK::IndexPropertyList &rows);

    int find(const MusicPlayItem &item) const;
    int find(int playlistRow, const QString &content, int from = 0);

    void add(int playlistRow, const QString &content);
    void add(int playlistRow, const QStringList &items);

    void append(int playlistRow, const QString &content);
    void append(int playlistRow, const QStringList &items);
    void appendQueue(int playlistRow, const QString &content);

    bool remove(int index);
    int remove(int playlistRow, const QString &content);
    void removeQueue() noexcept;

Q_SIGNALS:
    void currentIndexChanged(int index);
    void playbackModeChanged(TTK::PlayMode mode);

public Q_SLOTS:
    void setCurrentIndex(int index);
    void setCurrentIndex(int playlistRow, const QString &path);

private:
    int m_currentIndex;
    MusicPlayItemList m_mediaList;
    MusicPlayItemList m_queueList;
    TTK::PlayMode m_playbackMode;

    class Shuffle
    {
    public:
        Shuffle() noexcept;

        void setEnabled(bool enable) noexcept;
        bool isEnabled() const noexcept;
        void initialize(const MusicPlayItemList &items) noexcept;
        void setCurrentIndex(const MusicPlayItem &item) noexcept;
        MusicPlayItem setCurrentIndex(int index) noexcept;

    private:
        int m_index;
        bool m_enable;
        MusicPlayItemList m_data;

    } m_shuffle;

};

#endif // MUSICPLAYLIST_H