E131Node.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.
 *
 * E131Node.h
 * Header file for the E131Node class, this is the interface between OLA and
 * the E1.31 library.
 * Copyright (C) 2007 Simon Newton
 */

#ifndef LIBS_ACN_E131NODE_H_
#define LIBS_ACN_E131NODE_H_

#include <map>
#include <set>
#include <string>
#include <vector>
#include "ola/Callback.h"
#include "ola/Constants.h"
#include "ola/DmxBuffer.h"
#include "ola/acn/ACNPort.h"
#include "ola/acn/CID.h"
#include "ola/base/Macro.h"
#include "ola/io/SelectServerInterface.h"
#include "ola/thread/SchedulerInterface.h"
#include "ola/network/Interface.h"
#include "ola/network/Socket.h"
#include "libs/acn/DMPE131Inflator.h"
#include "libs/acn/E131DiscoveryInflator.h"
#include "libs/acn/E131Inflator.h"
#include "libs/acn/E131Sender.h"
#include "libs/acn/RootInflator.h"
#include "libs/acn/RootSender.h"
#include "libs/acn/UDPTransport.h"

namespace ola {
namespace acn {

class E131Node {
 public:
 struct Options {
 public:
 Options()
 : use_rev2(false),
 ignore_preview(true),
 enable_draft_discovery(false),
 dscp(0),
 port(ola::acn::ACN_PORT),
 source_name(ola::OLA_DEFAULT_INSTANCE_NAME) {
 }

 bool use_rev2; 
 bool ignore_preview; 
 bool enable_draft_discovery; 
 uint8_t dscp; 
 uint16_t port; 
 std::string source_name; 
 };

 struct KnownController {
 acn::CID cid;
 ola::network::IPV4Address ip_address;
 std::string source_name;
 std::set<uint16_t> universes;
 };

 E131Node(ola::thread::SchedulerInterface *ss,
 const std::string &ip_address,
 const Options &options,
 const ola::acn::CID &cid = ola::acn::CID::Generate());
 ~E131Node();

 bool Start();

 bool Stop();

 bool SetSourceName(uint16_t universe, const std::string &source);

 bool StartStream(uint16_t universe);

 bool TerminateStream(uint16_t universe,
 uint8_t priority = DEFAULT_PRIORITY);

 bool SendDMX(uint16_t universe,
 const ola::DmxBuffer &buffer,
 uint8_t priority = DEFAULT_PRIORITY,
 bool preview = false);

 bool SendDMXWithSequenceOffset(uint16_t universe,
 const ola::DmxBuffer &buffer,
 int8_t sequence_offset,
 uint8_t priority = DEFAULT_PRIORITY,
 bool preview = false);


 bool SendStreamTerminated(uint16_t universe,
 const ola::DmxBuffer &buffer = DmxBuffer(),
 uint8_t priority = DEFAULT_PRIORITY);

 bool SetHandler(uint16_t universe, ola::DmxBuffer *buffer,
 uint8_t *priority, ola::Callback0<void> *handler);

 bool RemoveHandler(uint16_t universe);

 const ola::network::Interface &GetInterface() const { return m_interface; }

 ola::network::UDPSocket* GetSocket() { return &m_socket; }

 void GetKnownControllers(std::vector<KnownController> *controllers);

 private:
 struct tx_universe {
 std::string source;
 uint8_t sequence;
 };

 typedef std::map<uint16_t, tx_universe> ActiveTxUniverses;
 typedef std::map<acn::CID, class TrackedSource*> TrackedSources;

 ola::thread::SchedulerInterface *m_ss;
 const Options m_options;
 const std::string m_preferred_ip;
 const ola::acn::CID m_cid;

 ola::network::Interface m_interface;
 ola::network::UDPSocket m_socket;
 // senders
 RootSender m_root_sender;
 E131Sender m_e131_sender;
 // inflators
 RootInflator m_root_inflator;
 E131Inflator m_e131_inflator;
 E131InflatorRev2 m_e131_rev2_inflator;
 DMPE131Inflator m_dmp_inflator;
 E131DiscoveryInflator m_discovery_inflator;

 IncomingUDPTransport m_incoming_udp_transport;
 ActiveTxUniverses m_tx_universes;
 uint8_t *m_send_buffer;

 // Discovery members
 ola::thread::timeout_id m_discovery_timeout;
 TrackedSources m_discovered_sources;

 tx_universe *SetupOutgoingSettings(uint16_t universe);

 bool PerformDiscoveryHousekeeping();
 void NewDiscoveryPage(const HeaderSet &headers,
 const E131DiscoveryInflator::DiscoveryPage &page);
 void SendDiscoveryPage(const std::vector<uint16_t> &universes, uint8_t page,
 uint8_t last_page, uint32_t sequence_number);

 static const uint16_t DEFAULT_PRIORITY = 100;
 static const uint16_t UNIVERSE_DISCOVERY_INTERVAL = 10000; // milliseconds
 static const uint16_t DISCOVERY_UNIVERSE_ID = 64214;
 static const uint16_t DISCOVERY_PAGE_SIZE = 512;

 DISALLOW_COPY_AND_ASSIGN(E131Node);
};
} // namespace acn
} // namespace ola
#endif // LIBS_ACN_E131NODE_H_