E131Port.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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * E131Port.h
 * The E1.31 port for OLA
 * Copyright (C) 2007-2009 Simon Newton
 */

#ifndef PLUGINS_E131_E131PORT_H_
#define PLUGINS_E131_E131PORT_H_

#include <string>
#include "olad/Port.h"
#include "plugins/e131/E131Device.h"
#include "plugins/e131/e131/E131Node.h"

namespace ola {
namespace plugin {
namespace e131 {

using ola::DmxBuffer;


class E131PortHelper {
  public:
    bool PreSetUniverse(Universe *old_universe, Universe *new_universe);
    string Description(Universe *universe) const;
  private:
    static const unsigned int MAX_E131_UNIVERSE = 63999;
};


class E131InputPort: public BasicInputPort {
  public:
    E131InputPort(E131Device *parent, int id, E131Node *node,
                  class PluginAdaptor *plugin_adaptor)
        : BasicInputPort(parent, id, plugin_adaptor),
          m_node(node) {}

    bool PreSetUniverse(Universe *old_universe, Universe *new_universe) {
      return m_helper.PreSetUniverse(old_universe, new_universe);
    }
    void PostSetUniverse(Universe *old_universe, Universe *new_universe);
    string Description() const { return m_helper.Description(GetUniverse()); }
    const DmxBuffer &ReadDMX() const { return m_buffer; }
    bool SupportsPriorities() const { return true; }
    uint8_t InheritedPriority() const { return m_priority; }

  private:
    DmxBuffer m_buffer;
    E131Node *m_node;
    E131PortHelper m_helper;
    uint8_t m_priority;
};


class E131OutputPort: public BasicOutputPort {
  public:
    E131OutputPort(E131Device *parent, int id, E131Node *node,
                   bool prepend_hostname)
        : BasicOutputPort(parent, id),
          m_prepend_hostname(prepend_hostname),
          m_preview_on(false),
          m_node(node) {}

    bool PreSetUniverse(Universe *old_universe, Universe *new_universe) {
      return m_helper.PreSetUniverse(old_universe, new_universe);
    }
    void PostSetUniverse(Universe *old_universe, Universe *new_universe);
    string Description() const { return m_helper.Description(GetUniverse()); }

    bool WriteDMX(const DmxBuffer &buffer, uint8_t priority);
    void UniverseNameChanged(const string &new_name);

    void SetPreviewMode(bool preview_mode) { m_preview_on = preview_mode; }
    bool PreviewMode() const { return m_preview_on; }
    bool SupportsPriorities() const { return true; }

  private:
    bool m_prepend_hostname;
    bool m_preview_on;
    DmxBuffer m_buffer;
    E131Node *m_node;
    E131PortHelper m_helper;
};
}  // namespace e131
}  // namespace plugin
}  // namespace ola
#endif  // PLUGINS_E131_E131PORT_H_