track_list.h

Go to the documentation of this file.

/*
 * Copyright © 2021-2022 UBports Foundation.
 *
 * Contact: Alberto Mardegan <mardy@users.sourceforge.net>
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3,
 * as published by the Free Software Foundation.
 *
 * 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LOMIRI_MEDIAHUB_TRACK_LIST_H
#define LOMIRI_MEDIAHUB_TRACK_LIST_H
 
#include "global.h"
#include "track.h"
 
#include <QObject>
#include <QScopedPointer>
#include <QVector>
 
namespace lomiri {
namespace MediaHub {
 
class PlayerPrivate;
 
class TrackListPrivate;
class MH_EXPORT TrackList: public QObject
{
    Q_OBJECT
    Q_DISABLE_COPY(TrackList)
 
public:
    TrackList(QObject *parent = nullptr);
    ~TrackList();

    Q_PROPERTY(bool canEditTracks READ canEditTracks
               NOTIFY canEditTracksChanged)
    Q_PROPERTY(int currentTrack READ currentTrack WRITE goTo
               NOTIFY currentTrackChanged)
 
    const QVector<Track> &tracks() const;
 
    bool canEditTracks() const;
    int currentTrack() const;
 
    /*
     * Unused:
     * - query_meta_data_for_track()
     * - query_uri_for_track() (can use `tracks()[index].url()`)
     * - has_next()
     * - has_previous()
     * - next()
     * - previous()
     * - on_track_list_replaced() // Never emitted by the service
     *
     * FIXME: remove this comment?
     * We don't want to allow other processes to modify our own playlist, and
     * QtMultimedia does not provide a way to track another process's playlist.
     * Therefore it looks like we can get away without all them.
     */

    void addTrackWithUriAt(const QUrl &uri, int position, bool makeCurrent);

    void addTracksWithUriAt(const QVector<QUrl> &uris, int position);

    void moveTrack(int index, int to);

    void removeTrack(int index);

    void goTo(int index);

    void reset();
 
Q_SIGNALS:
    void canEditTracksChanged();
    void currentTrackChanged(); // D-Bus: TrackChanged
 
    void tracksAdded(int start, int end);
    void trackRemoved(int index);
    void trackMoved(int index, int to);
    void trackListReset();
 
private:
    friend class PlayerPrivate;
    Q_DECLARE_PRIVATE(TrackList)
    QScopedPointer<TrackListPrivate> d_ptr;
};
 
} // namespace MediaHub
} // namespace lomiri
 
#endif // LOMIRI_MEDIAHUB_TRACK_LIST_H