strawberry-audio-player-windows-mac-linux/src/tidal/tidalsearch.h

/*
 * Strawberry Music Player
 * This code was part of Clementine (GlobalSearch)
 * Copyright 2010, David Sansome <me@davidsansome.com>
 * Copyright 2018, Jonas Kvinge <jonas@jkvinge.net>
 *
 * 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/>.
 *
 */

#ifndef TIDALSEARCH_H
#define TIDALSEARCH_H

#include "config.h"

#include <QObject>
#include <QFuture>
#include <QIcon>
#include <QMetaType>
#include <QPixmapCache>

#include "core/song.h"
#include "covermanager/albumcoverloaderoptions.h"
#include "settings/tidalsettingspage.h"

class Application;
class MimeData;
class AlbumCoverLoader;
class InternetService;
class TidalService;

class TidalSearch : public QObject {
  Q_OBJECT

 public:
  TidalSearch(Application *app, QObject *parent = nullptr);
  ~TidalSearch();

  struct Result {
    Song metadata_;
    QString pixmap_cache_key_;
  };
  typedef QList<Result> ResultList;
  
  static const int kDelayedSearchTimeoutMs;
  static const int kMaxResultsPerEmission;

  Application *application() const { return app_; }
  TidalService *service() const { return service_; }

  int SearchAsync(const QString &query, TidalSettingsPage::SearchBy searchby);
  int LoadArtAsync(const TidalSearch::Result &result);

  void CancelSearch(int id);
  void CancelArt(int id);

  // Loads tracks for results that were previously emitted by ResultsAvailable.
  // The implementation creates a SongMimeData with one Song for each Result.
  MimeData *LoadTracks(const ResultList &results);

 signals:
  void SearchAsyncSig(int id, const QString &query, TidalSettingsPage::SearchBy searchby);
  void ResultsAvailable(int id, const TidalSearch::ResultList &results);
  void AddResults(int id, const TidalSearch::ResultList &results);
  void SearchError(const int id, const QString error);
  void SearchFinished(int id);

  void ArtLoaded(int id, const QPixmap &pixmap);
  void ArtLoaded(int id, const QImage &image);
  
 protected:

  struct PendingState {
    PendingState() : orig_id_(-1) {}
    PendingState(int orig_id, QStringList tokens)
        : orig_id_(orig_id), tokens_(tokens) {}
    int orig_id_;
    QStringList tokens_;

    bool operator<(const PendingState &b) const {
      return orig_id_ < b.orig_id_;
    }

    bool operator==(const PendingState &b) const {
      return orig_id_ == b.orig_id_;
    }
  };

  void timerEvent(QTimerEvent *e);

  // These functions treat queries in the same way as LibraryQuery.
  // They're useful for figuring out whether you got a result because it matched in the song title or the artist/album name.
  static QStringList TokenizeQuery(const QString &query);
  static bool Matches(const QStringList &tokens, const QString &string);

 private slots:
  void DoSearchAsync(int id, const QString &query, TidalSettingsPage::SearchBy searchby);
  void SearchDone(int id, const SongList &songs);
  void HandleError(const int id, const QString error);
  void ResultsAvailableSlot(int id, TidalSearch::ResultList results);

  void ArtLoadedSlot(int id, const QImage &image);
  void AlbumArtLoaded(quint64 id, const QImage &image);

 private:
  void SearchAsync(int id, const QString &query, TidalSettingsPage::SearchBy searchby);
  void HandleLoadedArt(int id, const QImage &image);
  bool FindCachedPixmap(const TidalSearch::Result &result, QPixmap *pixmap) const;
  QString PixmapCacheKey(const TidalSearch::Result &result) const;
  void MaybeSearchFinished(int id);
  void ShowConfig() {}
  static QImage ScaleAndPad(const QImage &image);

 private:
  struct DelayedSearch {
    int id_;
    QString query_;
    TidalSettingsPage::SearchBy searchby_;
  };

  static const int kArtHeight;

  Application *app_;
  TidalService *service_;
  QString name_;
  QString id_;
  QIcon icon_;
  QImage icon_as_image_;
  int searches_next_id_;
  int art_searches_next_id_;

  QMap<int, DelayedSearch> delayed_searches_;
  QMap<int, QString> pending_art_searches_;
  QPixmapCache pixmap_cache_;
  AlbumCoverLoaderOptions cover_loader_options_;
  QMap<quint64, int> cover_loader_tasks_;

  QMap<int, PendingState> pending_searches_;

};

Q_DECLARE_METATYPE(TidalSearch::Result)
Q_DECLARE_METATYPE(TidalSearch::ResultList)

#endif  // TIDALSEARCH_H