2018-02-27 18:06:05 +01:00
|
|
|
/*
|
|
|
|
* Strawberry Music Player
|
2021-03-20 21:14:47 +01:00
|
|
|
* Copyright 2018-2021, Jonas Kvinge <jonas@jkvinge.net>
|
2018-02-27 18:06:05 +01:00
|
|
|
*
|
|
|
|
* Strawberry 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.
|
|
|
|
*
|
|
|
|
* Strawberry 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 Strawberry. If not, see <http://www.gnu.org/licenses/>.
|
2018-08-09 18:39:44 +02:00
|
|
|
*
|
2018-02-27 18:06:05 +01:00
|
|
|
*/
|
|
|
|
|
2018-08-29 21:42:24 +02:00
|
|
|
#ifndef LYRICSPROVIDER_H
|
|
|
|
#define LYRICSPROVIDER_H
|
2018-02-27 18:06:05 +01:00
|
|
|
|
|
|
|
#include "config.h"
|
|
|
|
|
2020-02-09 02:29:35 +01:00
|
|
|
#include <QtGlobal>
|
2018-05-01 00:41:33 +02:00
|
|
|
#include <QObject>
|
2018-08-29 21:42:24 +02:00
|
|
|
#include <QList>
|
2020-06-15 21:55:05 +02:00
|
|
|
#include <QVariant>
|
2018-05-01 00:41:33 +02:00
|
|
|
#include <QString>
|
2022-10-15 14:33:35 +02:00
|
|
|
#include <QRegularExpression>
|
2018-05-01 00:41:33 +02:00
|
|
|
|
2023-07-21 05:55:24 +02:00
|
|
|
#include "core/shared_ptr.h"
|
2022-10-17 21:34:18 +02:00
|
|
|
#include "core/networkaccessmanager.h"
|
2023-03-06 21:42:59 +01:00
|
|
|
#include "lyricssearchrequest.h"
|
|
|
|
#include "lyricssearchresult.h"
|
2018-02-27 18:06:05 +01:00
|
|
|
|
2018-08-29 21:42:24 +02:00
|
|
|
class LyricsProvider : public QObject {
|
2018-02-27 18:06:05 +01:00
|
|
|
Q_OBJECT
|
|
|
|
|
2019-06-23 16:45:00 +02:00
|
|
|
public:
|
2023-07-21 05:55:24 +02:00
|
|
|
explicit LyricsProvider(const QString &name, const bool enabled, const bool authentication_required, SharedPtr<NetworkAccessManager> network, QObject *parent);
|
2018-02-27 18:06:05 +01:00
|
|
|
|
2018-08-29 21:42:24 +02:00
|
|
|
QString name() const { return name_; }
|
2020-05-08 18:35:36 +02:00
|
|
|
bool is_enabled() const { return enabled_; }
|
|
|
|
int order() const { return order_; }
|
|
|
|
|
|
|
|
void set_enabled(const bool enabled) { enabled_ = enabled; }
|
|
|
|
void set_order(const int order) { order_ = order; }
|
2018-02-27 18:06:05 +01:00
|
|
|
|
2023-03-06 21:42:59 +01:00
|
|
|
virtual bool StartSearch(const int id, const LyricsSearchRequest &request) = 0;
|
2021-10-30 02:21:29 +02:00
|
|
|
virtual void CancelSearch(const int id) { Q_UNUSED(id); }
|
2020-06-15 21:55:05 +02:00
|
|
|
virtual bool AuthenticationRequired() const { return authentication_required_; }
|
2020-05-08 18:35:36 +02:00
|
|
|
virtual void Authenticate() {}
|
2020-06-15 21:55:05 +02:00
|
|
|
virtual bool IsAuthenticated() const { return !authentication_required_; }
|
2020-05-08 18:35:36 +02:00
|
|
|
virtual void Deauthenticate() {}
|
2018-02-27 18:06:05 +01:00
|
|
|
|
2020-06-15 21:55:05 +02:00
|
|
|
virtual void Error(const QString &error, const QVariant &debug = QVariant()) = 0;
|
|
|
|
|
2019-06-23 16:45:00 +02:00
|
|
|
signals:
|
2023-04-09 20:23:42 +02:00
|
|
|
void AuthenticationComplete(const bool success, const QStringList &errors = QStringList());
|
2020-05-08 18:35:36 +02:00
|
|
|
void AuthenticationSuccess();
|
2023-04-09 20:23:42 +02:00
|
|
|
void AuthenticationFailure(const QStringList &errors);
|
|
|
|
void SearchFinished(const int id, const LyricsSearchResults &results = LyricsSearchResults());
|
2018-02-27 18:06:05 +01:00
|
|
|
|
2021-08-12 23:00:10 +02:00
|
|
|
protected:
|
2023-07-21 05:55:24 +02:00
|
|
|
SharedPtr<NetworkAccessManager> network_;
|
2022-10-17 21:34:18 +02:00
|
|
|
const QString name_;
|
2020-05-08 18:35:36 +02:00
|
|
|
bool enabled_;
|
|
|
|
int order_;
|
2022-10-17 21:34:18 +02:00
|
|
|
const bool authentication_required_;
|
2018-02-27 18:06:05 +01:00
|
|
|
};
|
|
|
|
|
2021-01-26 16:48:04 +01:00
|
|
|
#endif // LYRICSPROVIDER_H
|