syndilights/open-lighting-architecture/ola-0.8.4/plugins/artnet/ArtNetPort.cpp

/*
 *  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.
 *
 * ArtNetPort.cpp
 * The ArtNet plugin for ola
 * Copyright (C) 2005 - 2009 Simon Newton
 */
#include <string.h>
#include <string>

#include "ola/Logging.h"
#include "olad/Universe.h"
#include "plugins/artnet/ArtNetDevice.h"
#include "plugins/artnet/ArtNetPort.h"

namespace ola {
namespace plugin {
namespace artnet {

using ola::NewClosure;

/*
 * Reprogram our port.
 */
void ArtNetPortHelper::PostSetUniverse(Universe *new_universe,
                                       unsigned int port_id) {
  ArtNetNode::artnet_port_type direction = m_is_output ?
    ArtNetNode::ARTNET_INPUT_PORT : ArtNetNode::ARTNET_OUTPUT_PORT;

  uint8_t universe_id = new_universe ? new_universe->UniverseId() % 0x10 :
    ArtNetNode::ARTNET_DISABLE_PORT;

  m_node->SetPortUniverse(direction, port_id, universe_id);
}


/*
 * Return the port description
 */
string ArtNetPortHelper::Description(const Universe *universe,
                                     unsigned int port_id) const {
  if (!universe)
    return "";

  ArtNetNode::artnet_port_type direction = m_is_output ?
    ArtNetNode::ARTNET_INPUT_PORT : ArtNetNode::ARTNET_OUTPUT_PORT;

  std::stringstream str;
  str << "ArtNet Universe " <<
    static_cast<int>(m_node->GetPortUniverse(direction, port_id));
  return str.str();
}


/*
 * Send a RDM response over ArtNet
 */
bool ArtNetInputPort::HandleRDMResponse(
    const ola::rdm::RDMResponse *response) {
  // TODO(simonn): handle fragmentation here?
  m_helper.GetNode()->SendRDMResponse(
      PortId(),
      *response);
  delete response;
  return true;
}


/*
 * Set the DMX Handlers as needed
 */
void ArtNetInputPort::PostSetUniverse(Universe *old_universe,
                                      Universe *new_universe) {
  (void) old_universe;
  m_helper.PostSetUniverse(new_universe, PortId());

  if (new_universe && !old_universe) {
    m_helper.GetNode()->SetDMXHandler(
        PortId(),
        &m_buffer,
        NewClosure<ArtNetInputPort, void>(this, &ArtNetInputPort::DmxChanged));
    m_helper.GetNode()->SetOutputPortRDMHandlers(
        PortId(),
        NewClosure<ArtNetInputPort, void>(
          this,
          &ArtNetInputPort::RespondWithTod),
        NewClosure<ArtNetInputPort, void>(
          this,
          &ArtNetInputPort::TriggerRDMDiscovery),
        ola::NewCallback<ArtNetInputPort, void, const RDMRequest*>(
          this,
          &ArtNetInputPort::PolitelyHandleRDMRequest));

  } else if (!new_universe) {
    m_helper.GetNode()->SetDMXHandler(PortId(), NULL, NULL);
    m_helper.GetNode()->SetOutputPortRDMHandlers(
        PortId(),
        NULL,
        NULL,
        NULL);
  }

  if (new_universe)
    RespondWithTod();
}


/*
 * Handle an RDM request, and send a TodData if this uid wasn't found
 */
void ArtNetInputPort::PolitelyHandleRDMRequest(
    const ola::rdm::RDMRequest *request) {

  if (!HandleRDMRequest(request)) {
    OLA_INFO << "Request for an unknown UID, sending updated TOD";
    RespondWithTod();
  }
}


/*
 * Respond With Tod
 */
void ArtNetInputPort::RespondWithTod() {
  ola::rdm::UIDSet uids;
  if (GetUniverse())
    GetUniverse()->GetUIDs(&uids);
  m_helper.GetNode()->SendTod(PortId(), uids);
}


/*
 * Write operation
 * @param data pointer to the dmx data
 * @param length the length of the data
 * @return true if the write succeeded, false otherwise
 */
bool ArtNetOutputPort::WriteDMX(const DmxBuffer &buffer,
                                uint8_t priority) {
  if (PortId() >= ARTNET_MAX_PORTS) {
    OLA_WARN << "Invalid artnet port id " << PortId();
    return false;
  }

  return m_helper.GetNode()->SendDMX(PortId(), buffer);
  (void) priority;
}


/*
 * Handle an RDMRequest
 */
bool ArtNetOutputPort::HandleRDMRequest(const ola::rdm::RDMRequest *request) {
  // Discovery requests aren't proxied
  bool ret = true;
  if (request->CommandClass() != RDMCommand::DISCOVER_COMMAND)
    ret = m_helper.GetNode()->SendRDMRequest(PortId(), request);
  return ret;
}


/*
 * Run the RDM discovery process
 */
void ArtNetOutputPort::RunRDMDiscovery() {
  m_helper.GetNode()->ForceDiscovery(PortId());
}


/*
 * Set the RDM handlers as appropriate
 */
void ArtNetOutputPort::PostSetUniverse(Universe *old_universe,
                                       Universe *new_universe) {
  (void) old_universe;
  m_helper.PostSetUniverse(new_universe, PortId());

  if (new_universe && !old_universe) {
    m_helper.GetNode()->SetInputPortRDMHandlers(
        PortId(),
        ola::NewCallback<ArtNetOutputPort, void, const UIDSet&>(
          this,
          &ArtNetOutputPort::NewUIDList),
        ola::NewCallback<ArtNetOutputPort, void, const RDMResponse*>(
          this,
          &ArtNetOutputPort::PolitelyHandleRDMResponse));
  } else if (!new_universe) {
    m_helper.GetNode()->SetInputPortRDMHandlers(PortId(), NULL, NULL);
  }

  if (new_universe)
    m_helper.GetNode()->SendTodRequest(PortId());
}


/*
 * Handle a RDMResponse from the node
 */
void ArtNetOutputPort::PolitelyHandleRDMResponse(const RDMResponse *response) {
  HandleRDMResponse(response);
}
}  // artnet
}  // plugin
}  // ola