DeviceManager.h

/*
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Library General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * DeviceManager.h
 * Interface to the DeviceManager class
 * Copyright (C) 2005 Simon Newton
 */

#ifndef OLAD_PLUGIN_API_DEVICEMANAGER_H_
#define OLAD_PLUGIN_API_DEVICEMANAGER_H_

#include <map>
#include <set>
#include <string>
#include <vector>
#include "ola/base/Macro.h"
#include "ola/timecode/TimeCode.h"
#include "olad/Device.h"
#include "olad/Preferences.h"

namespace ola {

// pair a device with it's alias
class device_alias_pair {
 public:
  unsigned int alias;
  AbstractDevice *device;

  device_alias_pair(unsigned int alias, AbstractDevice *device)
      : alias(alias), device(device) {}
};

bool operator <(const device_alias_pair& left, const device_alias_pair &right);

class DeviceManager {
 public:
  DeviceManager(PreferencesFactory *prefs_factory,
                class PortManager *port_manager);

  ~DeviceManager();

  bool RegisterDevice(AbstractDevice *device);

  bool UnregisterDevice(const std::string &device_id);

  bool UnregisterDevice(const AbstractDevice *device);

  unsigned int DeviceCount() const;

  std::vector<device_alias_pair> Devices() const;

  AbstractDevice *GetDevice(unsigned int alias) const;

  device_alias_pair GetDevice(const std::string &unique_id) const;

  void UnregisterAllDevices();


  void SendTimeCode(const ola::timecode::TimeCode &timecode);

  static const unsigned int MISSING_DEVICE_ALIAS;

 private:
  typedef std::map<std::string, device_alias_pair> DeviceIdMap;
  typedef std::map<unsigned int, AbstractDevice*> DeviceAliasMap;

  Preferences *m_port_preferences;
  class PortManager *m_port_manager;

  DeviceIdMap m_devices;
  DeviceAliasMap m_alias_map;

  unsigned int m_next_device_alias;
  std::set<class OutputPort*> m_timecode_ports;

  void ReleaseDevice(const AbstractDevice *device);
  void RestoreDevicePortSettings(AbstractDevice *device);

  template <class PortClass>
  void SavePortPatchings(const std::vector<PortClass*> &ports) const;

  void SavePortPriority(const Port &port) const;
  void RestorePortPriority(Port *port) const;

  template <class PortClass>
  void RestorePortSettings(const std::vector<PortClass*> &ports) const;

  static const char PORT_PREFERENCES[];
  static const unsigned int FIRST_DEVICE_ALIAS = 1;
  static const char PRIORITY_VALUE_SUFFIX[];
  static const char PRIORITY_MODE_SUFFIX[];

  DISALLOW_COPY_AND_ASSIGN(DeviceManager);
};
}  // namespace ola
#endif  // OLAD_PLUGIN_API_DEVICEMANAGER_H_