Port.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.
 *
 * Port.h
 * Header file for the Port classes
 * Copyright (C) 2005 Simon Newton
 */

#ifndef INCLUDE_OLAD_PORT_H_
#define INCLUDE_OLAD_PORT_H_

#include <ola/DmxBuffer.h>
#include <ola/base/Macro.h>
#include <ola/rdm/RDMCommand.h>
#include <ola/rdm/RDMControllerInterface.h>
#include <ola/timecode/TimeCode.h>
#include <olad/DmxSource.h>
#include <olad/PluginAdaptor.h>
#include <olad/PortConstants.h>
#include <olad/Universe.h>

#include <string>

namespace ola {

class AbstractDevice;

class Port {
 public:
 virtual ~Port() {}

 virtual unsigned int PortId() const = 0;

 virtual AbstractDevice *GetDevice() const = 0;

 virtual std::string Description() const = 0;

 virtual bool SetUniverse(Universe *universe) = 0;

 virtual Universe *GetUniverse() const = 0;

 virtual std::string UniqueId() const = 0;

 virtual port_priority_capability PriorityCapability() const = 0;

 virtual bool SetPriority(uint8_t priority) = 0;

 virtual uint8_t GetPriority() const = 0;

 virtual void SetPriorityMode(port_priority_mode mode) = 0;

 virtual port_priority_mode GetPriorityMode() const = 0;

 virtual bool SupportsRDM() const = 0;
};


class InputPort: public Port {
 public:
 virtual ~InputPort() {}

 virtual void DmxChanged() = 0;

 virtual const DmxSource &SourceData() const = 0;

 virtual void HandleRDMRequest(const ola::rdm::RDMRequest *request,
 ola::rdm::RDMCallback *callback) = 0;
};


class OutputPort: public Port, ola::rdm::DiscoverableRDMControllerInterface {
 public:
 virtual ~OutputPort() {}

 virtual bool WriteDMX(const DmxBuffer &buffer, uint8_t priority) = 0;

 virtual void UniverseNameChanged(const std::string &new_name) = 0;

 // Methods from DiscoverableRDMControllerInterface
 // Ownership of the request object is transferred
 virtual void SendRDMRequest(const ola::rdm::RDMRequest *request,
 ola::rdm::RDMCallback *callback) = 0;
 virtual void RunFullDiscovery(
 ola::rdm::RDMDiscoveryCallback *on_complete) = 0;
 virtual void RunIncrementalDiscovery(
 ola::rdm::RDMDiscoveryCallback *on_complete) = 0;

 // timecode support
 virtual bool SupportsTimeCode() const = 0;
 virtual bool SendTimeCode(const ola::timecode::TimeCode &timecode) = 0;
};


class BasicInputPort: public InputPort {
 public:
 BasicInputPort(AbstractDevice *parent,
 unsigned int port_id,
 const PluginAdaptor *plugin_adaptor,
 bool supports_rdm = false);

 unsigned int PortId() const { return m_port_id; }
 AbstractDevice *GetDevice() const { return m_device; }
 bool SetUniverse(Universe *universe);
 Universe *GetUniverse() const { return m_universe; }
 virtual std::string UniqueId() const;
 bool SetPriority(uint8_t priority);
 uint8_t GetPriority() const { return m_priority; }
 void SetPriorityMode(port_priority_mode mode) { m_priority_mode = mode; }
 port_priority_mode GetPriorityMode() const { return m_priority_mode; }

 void DmxChanged();
 const DmxSource &SourceData() const { return m_dmx_source; }

 // RDM methods, the child class provides HandleRDMResponse
 void HandleRDMRequest(const ola::rdm::RDMRequest *request,
 ola::rdm::RDMCallback *callback);

 void TriggerRDMDiscovery(ola::rdm::RDMDiscoveryCallback *on_complete,
 bool full = true);

 port_priority_capability PriorityCapability() const {
 return SupportsPriorities() ? CAPABILITY_FULL : CAPABILITY_STATIC;
 }

 // subclasses override these
 // Read the dmx data.
 virtual const DmxBuffer &ReadDMX() const = 0;

 // Get the inherited priority
 virtual uint8_t InheritedPriority() const {
 return ola::dmx::SOURCE_PRIORITY_MIN;
 }

 // override this to cancel the SetUniverse operation.
 virtual bool PreSetUniverse(Universe *, Universe *) { return true; }

 virtual void PostSetUniverse(Universe *, Universe *) {}

 virtual bool SupportsRDM() const { return m_supports_rdm; }

 protected:
 // indicates whether this port supports priorities, default to no
 virtual bool SupportsPriorities() const { return false; }

 private:
 const unsigned int m_port_id;
 uint8_t m_priority;
 port_priority_mode m_priority_mode;
 mutable std::string m_port_string;
 Universe *m_universe; // the universe this port belongs to
 AbstractDevice *m_device;
 DmxSource m_dmx_source;
 const PluginAdaptor *m_plugin_adaptor;
 bool m_supports_rdm;

 DISALLOW_COPY_AND_ASSIGN(BasicInputPort);
};


class BasicOutputPort: public OutputPort {
 public:
 BasicOutputPort(AbstractDevice *parent,
 unsigned int port_id,
 bool start_rdm_discovery_on_patch = false,
 bool supports_rdm = false);

 unsigned int PortId() const { return m_port_id; }
 AbstractDevice *GetDevice() const { return m_device; }
 bool SetUniverse(Universe *universe);
 Universe *GetUniverse() const { return m_universe; }
 std::string UniqueId() const;
 bool SetPriority(uint8_t priority);
 uint8_t GetPriority() const { return m_priority; }
 void SetPriorityMode(port_priority_mode mode) { m_priority_mode = mode; }
 port_priority_mode GetPriorityMode() const { return m_priority_mode; }

 virtual void UniverseNameChanged(const std::string &new_name) {
 (void) new_name;
 }

 port_priority_capability PriorityCapability() const {
 return SupportsPriorities() ? CAPABILITY_FULL : CAPABILITY_NONE;
 }

 // DiscoverableRDMControllerInterface methods
 virtual void SendRDMRequest(const ola::rdm::RDMRequest *request,
 ola::rdm::RDMCallback *callback);
 virtual void RunFullDiscovery(ola::rdm::RDMDiscoveryCallback *on_complete);

 virtual void RunIncrementalDiscovery(
 ola::rdm::RDMDiscoveryCallback *on_complete);

 // TimeCode
 virtual bool SupportsTimeCode() const { return false; }

 virtual bool SendTimeCode(const ola::timecode::TimeCode &) {
 return true;
 }

 // Subclasses can override this to cancel the SetUniverse operation.
 virtual bool PreSetUniverse(Universe *, Universe *) { return true; }
 virtual void PostSetUniverse(Universe *, Universe *) { }

 virtual bool SupportsRDM() const { return m_supports_rdm; }

 protected:
 // indicates whether this port supports priorities, default to no
 virtual bool SupportsPriorities() const { return false; }

 void UpdateUIDs(const ola::rdm::UIDSet &uids);

 private:
 const unsigned int m_port_id;
 const bool m_discover_on_patch;
 uint8_t m_priority;
 port_priority_mode m_priority_mode;
 mutable std::string m_port_string;
 Universe *m_universe; // the universe this port belongs to
 AbstractDevice *m_device;
 bool m_supports_rdm;

 DISALLOW_COPY_AND_ASSIGN(BasicOutputPort);
};


template<class PortClass>
bool IsInputPort();

template<>
bool IsInputPort<OutputPort>();
} // namespace ola
#endif // INCLUDE_OLAD_PORT_H_