Clementine-audio-player-Mac-Linux-Windows/src/devices/devicemanager.h

/* This file is part of Clementine.
   Copyright 2010, 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 DEVICEMANAGER_H
#define DEVICEMANAGER_H

#include <QAbstractItemModel>
#include <QIcon>
#include <QThreadPool>
#include <memory>

#include "core/simpletreemodel.h"
#include "devicedatabasebackend.h"
#include "deviceinfo.h"
#include "library/librarymodel.h"

class Application;
class ConnectedDevice;
class DeviceLister;
class DeviceStateFilterModel;

class DeviceManager : public SimpleTreeModel<DeviceInfo> {
  Q_OBJECT

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

  enum Role {
    Role_State = LibraryModel::LastRole,
    Role_UniqueId,
    Role_FriendlyName,
    Role_Capacity,
    Role_FreeSpace,
    Role_IconName,
    Role_UpdatingPercentage,
    Role_MountPath,
    Role_TranscodeMode,
    Role_TranscodeFormat,
    Role_SongCount,
    LastRole,
  };

  enum State {
    State_Remembered,
    State_NotMounted,
    State_NotConnected,
    State_Connected,
  };

  static const int kDeviceIconSize;
  static const int kDeviceIconOverlaySize;

  DeviceStateFilterModel* connected_devices_model() const {
    return connected_devices_model_;
  }

  // Get info about devices
  int GetDatabaseId(const QModelIndex& idx) const;
  DeviceLister* GetLister(QModelIndex idx) const;
  std::shared_ptr<ConnectedDevice> GetConnectedDevice(QModelIndex idx) const;
  std::shared_ptr<ConnectedDevice> GetConnectedDevice(DeviceInfo* info) const;

  DeviceInfo* FindDeviceById(const QString& id) const;
  DeviceInfo* FindDeviceByUrl(const QList<QUrl>& url) const;
  DeviceInfo* FindEquivalentDevice(DeviceInfo* info) const;

  // Actions on devices
  std::shared_ptr<ConnectedDevice> Connect(DeviceInfo* info);
  std::shared_ptr<ConnectedDevice> Connect(QModelIndex idx);
  void Disconnect(QModelIndex idx);
  void Forget(QModelIndex idx);
  void UnmountAsync(QModelIndex idx);
  bool IsConnected(QModelIndex idx) {
    return GetConnectedDevice(idx) != nullptr;
  }

  void SetDeviceOptions(QModelIndex idx, const QString& friendly_name,
                        const QString& icon_name,
                        MusicStorage::TranscodeMode mode,
                        Song::FileType format);

  // QAbstractItemModel
  QVariant data(const QModelIndex& idx, int role = Qt::DisplayRole) const;

 public slots:
  void Unmount(QModelIndex idx);

 signals:
  void DeviceConnected(QModelIndex idx);
  void DeviceDisconnected(QModelIndex idx);
  void DeviceCreatedFromDb(DeviceInfo* info);

 private slots:
  void PhysicalDeviceAdded(const QString& id);
  void PhysicalDeviceRemoved(const QString& id);
  void PhysicalDeviceChanged(const QString& id);
  void DeviceTaskStarted(int id);
  void TasksChanged();
  void DeviceSongCountUpdated(int count);
  void LoadAllDevices();
  void DeviceConnectFinished(const QString& id, bool success);
  void AddDeviceFromDb(DeviceInfo* info);

 protected:
  void LazyPopulate(DeviceInfo* item) { LazyPopulate(item, true); }
  void LazyPopulate(DeviceInfo* item, bool signal);

 private:
  void AddLister(DeviceLister* lister);
  template <typename T>
  void AddDeviceClass();

  DeviceDatabaseBackend::Device InfoToDatabaseDevice(
      const DeviceInfo& info) const;

 private:
  Application* app_;
  DeviceDatabaseBackend* backend_;

  DeviceStateFilterModel* connected_devices_model_;

  QIcon not_connected_overlay_;

  QList<DeviceLister*> listers_;
  QList<DeviceInfo*> devices_;

  QMultiMap<QString, QMetaObject> device_classes_;

  // Map of task ID to device index
  QMap<int, QPersistentModelIndex> active_tasks_;

  QThreadPool thread_pool_;
};

template <typename T>
void DeviceManager::AddDeviceClass() {
  QStringList schemes = T::url_schemes();
  QMetaObject obj = T::staticMetaObject;

  for (const QString& scheme : schemes) {
    device_classes_.insert(scheme, obj);
  }
}

#endif  // DEVICEMANAGER_H