OpenLCP/sacn/universe.cpp

/*
  universe.cpp

  Copyright (c) 2020 Kevin Matz (kevin.matz@gmail.com)

  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
*/

#include "universe.h"
#include "../build/has_rtti.h"

namespace SACN {

/**
 * @brief UniverseSource::UniverseSource
 */
UniverseSource::UniverseSource()
  : cid_(UUID::uuid())
  , description_(std::string())
  , universe_(0)
  , priority_(100)
  , sync_address_(0)
  , options_(0)
{}


/**
 * @brief UniverseSource::UniverseSource
 * @param pdu
 *
 * Construct a Universe Source from an sACN frame PDU
 */
UniverseSource::UniverseSource(std::shared_ptr<DATA::Pdu> pdu)
{
#if defined(RTTI_ENABLED)
  auto root_header  = dynamic_cast<RLP::rlp_header*>(pdu->parent()->header());
  auto frame_header = dynamic_cast<DATA::frame_header*>(pdu->header());
#else
  auto root_header  = static_cast<RLP::rlp_header*>(pdu->parent()->header());
  auto frame_header = static_cast<DATA::frame_header*>(pdu->header());
#endif

  cid_ = root_header->cid;
  description_ = std::string((char*)frame_header->source_name);
  universe_ = frame_header->universe;
  priority_ = frame_header->priority;
  sync_address_ = frame_header->sync_address;
  options_  = frame_header->options;
};


/**
 * @brief operator ==
 * @param a
 * @param b
 * @return
 */
bool operator== (const UniverseSource& a, const UniverseSource& b)
{
    return (std::hash<UniverseSource>{}(a) == std::hash<UniverseSource>{}(b));
}


/**
 * @brief Universe::Universe
 */
Universe::Universe()
    : DMX::Universe()
    , synchronized_(false)
{
};


/**
 * @brief Universe::~Universe
 */
Universe::~Universe()
{
}


/**
  Set universe data from a DMP PDU from a UniverseSource.
*/
void Universe::set(std::shared_ptr<DMP::Pdu> dmp,
                   std::shared_ptr<UniverseSource> source) {
  // 7.3 Address Type and Data Type
  // Sources shall set the DMP Layer's Address Type and Data Type to 0xa1.
  // Receivers shall discard the packet if the received value is not 0xa1.
  if (!dmp->header())
    return;
#if defined(RTTI_ENABLED)
  auto type = dynamic_cast<ACN::DMP::address_type*>(dmp->header());
#else
  auto type = static_cast<ACN::DMP::address_type*>(dmp->header());
#endif
  if (!type->z_reserved) return; // needs to be true, but why?
  if (type->relative) return;
  if (type->type != ACN::DMP::ARRAY) return;
  if (type->x_reserved != 0) return;
  if (type->width != ACN::DMP::TWO) return;

  // only act on the first property pair in the data
  if (!dmp->data())
    return;

#if defined(RTTI_ENABLED)
  auto set_data = dynamic_cast<ACN::DMP::dmp_set_data*>(dmp->data());
#else
  auto set_data = static_cast<ACN::DMP::dmp_set_data*>(dmp->data());
#endif
  const auto& [range, data] = set_data->properties.front();

  // 7.4 First Property Address
  // Sources shall set the DMP Layer's First Property Address to 0x0000.
  // Receivers shall discard the packet if the received value is not 0x0000.
  if (range.address != 0)
    return;

  // 7.5 Address Increment
  // Sources shall set the DMP Layer's Address Increment to 0x0001.
  // Receivers shall discard the packet if the received value is not 0x0001.
  if (range.incriment != 1)
    return;

  // 7.6 Property Value Count
  // The DMP Layer's Property Value Count is used to encode the number of
  // DMX512-A [DMX] Slots (including the START Code slot).
  if (range.count < 1 || range.count > 513)
    return;

  setSource(source);

  // 7.7 Property Values (DMX512-A Data)
  // The DMP Layer's Property values field is used to encode the
  // DMX512-A [DMX] START Code and data.
  DMX::Universe::setData(data);
}


/**
 * @brief Universe::setSource
 * @param source
 */
void Universe::setSource(std::shared_ptr<UniverseSource> source)
{
    source_ = source;
}


MergeProxyUniverse::MergeProxyUniverse()
      : SACN::Universe()
{
}

MergeProxyUniverse::~MergeProxyUniverse()
{
  for (auto& [_, universe] : sources_)
    delete universe;
}

/**
 * @brief MergeProxyUniverse::sources
 * @return
 */
const std::vector<UniverseSource> MergeProxyUniverse::sources() const
{
  std::vector<UniverseSource> keys;
  for (const auto& [key, _] : sources_)
    keys.push_back(key);
  return keys;
}


/**
 * @brief MergeProxyUniverse::sourceUniverse
 * @return
 */
Universe* MergeProxyUniverse::sourceUniverse(const UniverseSource &src)
{
  if (!hasSourceUniverse(src))
    newSource_(src);
  return sources_.at(src);
}


/**
 * @brief MergeProxyUniverse::hasSourceUniverse
 * @return
 */
bool MergeProxyUniverse::hasSourceUniverse(const UniverseSource& src) const
{
  if (sources_.count(src))
    return true;
  return false;
}


/**
 * @brief MergeProxyUniverse::hassources
 * @return
 */
bool MergeProxyUniverse::hasSources() const
{
  if (sources_.size())
    return true;
  return false;
}


/**
 * @brief MergeProxyUniverse::deleteSourceUniverse
 * @return
 */
void MergeProxyUniverse::deleteSourceUniverse(const UniverseSource& src)
{
  if (sources_.count(src)) {
    delete sources_.at(src);
    sources_.erase(src);
  }
}


/**
 * @brief MergeProxyUniverse::addSourceUniverse
 */
void MergeProxyUniverse::addSourceUniverse(Universe* universe)
{
  sources_.at(*universe->source()) = universe;
}


/**
 * @brief MergeProxyUniverse::dataChangedNotifier
 * @param universe
 */
void MergeProxyUniverse::dataChangedNotifier(DMX::Universe* dmx)
{
#if defined(RTTI_ENABLED)
  auto sacn = static_cast<SACN::Universe*>(dmx);
#else
  auto sacn = static_cast<SACN::Universe*>(dmx);
#endif
  auto universe = dominant_();
  if (!universe)
    return;
  if (sacn->source() == universe->source())
    for (const auto &cb : callbacks_)
      cb(this);
}


/**
 * @brief MergeProxyUniverse::isSyncronized
 * @return
 */
bool MergeProxyUniverse::isSyncronized() const
{
  auto universe = dominant_();
  if (!universe) return false;
  return universe->isSyncronized();
}


/**
 * @brief MergeProxyUniverse::source
 * @return
 */
std::shared_ptr<UniverseSource> MergeProxyUniverse::source() const
{
  auto universe = dominant_();
  if (!universe) return nullptr;
  return universe->source();
}


/**
 * @brief MergeProxyUniverse::set
 * @param pdu
 * @param source
 */
void MergeProxyUniverse::set(std::shared_ptr<DMP::Pdu> pdu,
                             std::shared_ptr<UniverseSource> src)
{
  if (!sources_.count(*src))
    newSource_(*src);

  sources_.at(*src)->set(pdu, src);
}


/**
 * @brief MergeProxyUniverse::data
 * @return
 */
const DMX::DimmerData * MergeProxyUniverse::data() const
{
  auto universe = dominant_();
  if (!universe) return nullptr;
  return universe->data();
}


/**
 * @brief MergeProxyUniverse::slot
 * @param s
 * @return
 */
uint8_t MergeProxyUniverse::slot(const uint16_t s) const
{
  auto universe = dominant_();
  if (!universe) return 0;
  return universe->slot(s);
}


/**
 * @brief MergeProxyUniverse::rxRate
 * @return
 */
double MergeProxyUniverse::rxRate()
{
  auto universe = dominant_();
  if (!universe) return 0.0;
  return universe->rxRate();
}


/**
 * @brief MergeProxyUniverse::dominant_
 * @return
 */
Universe* MergeProxyUniverse::dominant_() const
{
  Universe* ret = nullptr;
  for (auto& [_, uni] : sources_) {
      if (uni->rxRate() < 1)  // stale universes cannot be dominant
        continue;
      if (!ret || uni->source()->priority() > ret->source()->priority())
        ret = uni;
    }
  return ret;
}


/**
 * @brief MergeProxyUniverse::newSource_
 * @param src
 */
void MergeProxyUniverse::newSource_(const UniverseSource &src)
{
  sources_.emplace(src, new Universe());
  sources_.at(src)->onData(std::bind(&SACN::MergeProxyUniverse::dataChangedNotifier,
                                this, std::placeholders::_1));
}

};  // SACN