Clementine-audio-player-Mac-Linux-Windows/src/moodbar/moodbarloader.h

/* This file is part of Clementine.
   Copyright 2012, David Sansome <me@davidsansome.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 MOODBARLOADER_H
#define MOODBARLOADER_H

#include <QMap>
#include <QObject>
#include <QPair>

class QNetworkDiskCache;
class QUrl;

class MoodbarPipeline;

class MoodbarLoader : public QObject {
  Q_OBJECT
    
public:
  MoodbarLoader(QObject* parent = 0);
  ~MoodbarLoader();
  
  enum Result {
    // The URL isn't a local file or the moodbar plugin was not available -
    // moodbar data can never be loaded.
    CannotLoad,
      
    // Moodbar data was loaded and returned.
    Loaded,
      
    // Moodbar data will be loaded in the background, a MoodbarPipeline* was
    // was returned that you can connect to the Finished() signal on.
    WillLoadAsync
  };
  
  Result Load(const QUrl& url, QByteArray* data, MoodbarPipeline** async_pipeline);

private slots:
  void RequestFinished(MoodbarPipeline* request, const QUrl& filename);

private:
  static QStringList MoodFilenames(const QString& song_filename);
  bool StartQueuedRequest(const QUrl& url);
  
private:
  QNetworkDiskCache* cache_;

  const int kMaxActiveRequests;
  
  QMap<QUrl, MoodbarPipeline*> active_requests_;
  QList<QUrl> queued_requests_;

  bool save_alongside_originals_;
};

#endif // MOODBARLOADER_H