97 lines
3.1 KiB
C++
97 lines
3.1 KiB
C++
/* This file is part of Clementine.
|
|
Copyright 2011, Arnaud Bienner <arnaud.bienner@gmail.com>
|
|
Copyright 2011, David Sansome <me@davidsansome.com>
|
|
Copyright 2012, 2014, John Maguire <john.maguire@gmail.com>
|
|
Copyright 2014, Krzysztof Sobiecki <sobkas@gmail.com>
|
|
|
|
Clementine 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.
|
|
|
|
Clementine 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 Clementine. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef CORE_URLHANDLER_H_
|
|
#define CORE_URLHANDLER_H_
|
|
|
|
#include <QIcon>
|
|
#include <QObject>
|
|
#include <QUrl>
|
|
|
|
class UrlHandler : public QObject {
|
|
Q_OBJECT
|
|
|
|
public:
|
|
explicit UrlHandler(QObject* parent = nullptr);
|
|
|
|
// The URL scheme that this handler handles.
|
|
virtual QString scheme() const = 0;
|
|
virtual QIcon icon() const;
|
|
|
|
// Returned by StartLoading() and LoadNext(), indicates what the player
|
|
// should do when it wants to load a URL.
|
|
struct LoadResult {
|
|
enum Type {
|
|
// There wasn't a track available, and the player should move on to the
|
|
// next playlist item.
|
|
NoMoreTracks,
|
|
|
|
// There might be another track available but the handler needs to do some
|
|
// work (eg. fetching a remote playlist) to find out. AsyncLoadComplete
|
|
// will be emitted later with the same original_url.
|
|
WillLoadAsynchronously,
|
|
|
|
// There was a track available. Its url is in media_url.
|
|
TrackAvailable,
|
|
|
|
// Failed to resolve URL.
|
|
Error
|
|
};
|
|
|
|
LoadResult(const QUrl& original_url, Type type,
|
|
const QUrl& media_url = QUrl(), qint64 length_nanosec_ = -1);
|
|
|
|
// The url that the playlist item has in Url().
|
|
// Might be something unplayable like lastfm://...
|
|
QUrl original_url_;
|
|
|
|
Type type_;
|
|
|
|
// The actual url to something that gstreamer can play.
|
|
QUrl media_url_;
|
|
|
|
// Track length, if we are able to get it only now
|
|
qint64 length_nanosec_;
|
|
|
|
// If non-empty, value for an Authorization header.
|
|
QByteArray auth_header_;
|
|
};
|
|
|
|
// Called by the Player when a song starts loading - gives the handler
|
|
// a chance to do something clever to get a playable track.
|
|
virtual LoadResult StartLoading(const QUrl& url) = 0;
|
|
|
|
// Called by the player when a song finishes - gives the handler a chance to
|
|
// get another track to play.
|
|
virtual LoadResult LoadNext(const QUrl& url) {
|
|
return LoadResult(url, LoadResult::NoMoreTracks);
|
|
}
|
|
|
|
// Functions to be warned when something happen to a track handled by
|
|
// UrlHandler.
|
|
virtual void TrackAboutToEnd() {}
|
|
virtual void TrackSkipped() {}
|
|
|
|
signals:
|
|
void AsyncLoadComplete(const UrlHandler::LoadResult& result);
|
|
};
|
|
|
|
#endif // CORE_URLHANDLER_H_
|