2021-05-27 10:59:22 -04:00
|
|
|
/*
|
|
|
|
data.h
|
|
|
|
|
|
|
|
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.
|
|
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
|
2021-08-15 23:36:29 -04:00
|
|
|
#include "acn/pdu.h"
|
2021-05-27 10:59:22 -04:00
|
|
|
#include "sacn.h"
|
|
|
|
|
2021-08-28 09:01:33 -04:00
|
|
|
/**
|
|
|
|
* \cite sACN 1.4 Classes of Data Appropriate for Transmission
|
|
|
|
*
|
|
|
|
* This standard, E1.31, is intended to define a method to carry DMX512-A
|
|
|
|
* \cite DMX style data and metadata over IP Networks. It is designed to carry
|
|
|
|
* repetitive control data from one or more sources to one or more receivers.
|
|
|
|
* This protocol is intended to be used to control dimmers, other lighting
|
|
|
|
* devices, and related non- hazardous effects equipment.
|
|
|
|
*/
|
|
|
|
namespace sACN::DATA {
|
2021-05-27 10:59:22 -04:00
|
|
|
|
2021-07-30 09:11:32 -04:00
|
|
|
/**
|
|
|
|
* @brief Table 6-1: E1.31 Data Packet Framing Layer
|
|
|
|
*/
|
2021-08-15 23:36:29 -04:00
|
|
|
struct data_header : ACN::PDU::pdu_header {
|
2021-08-25 17:20:33 -04:00
|
|
|
std::string source_name; //!< source description
|
|
|
|
uint8_t priority; //!< priority, between 0 and 200
|
|
|
|
uint16_t sync_address; //!< syncronization address
|
|
|
|
uint8_t sequence_number; //!< sequence
|
|
|
|
uint8_t options; //!< options
|
|
|
|
uint16_t universe; //!< universe number
|
2021-08-15 23:36:29 -04:00
|
|
|
|
2021-08-20 11:41:20 -04:00
|
|
|
size_t streamSize() const override { return 71; }
|
2021-08-15 23:36:29 -04:00
|
|
|
void iStream(ACN::PDU::Stream) override;
|
|
|
|
void oStream(ACN::PDU::Stream) const override;
|
2021-05-27 10:59:22 -04:00
|
|
|
};
|
|
|
|
|
2021-07-30 09:11:32 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief 6.2.6 E1.31 Data Packet: Options
|
|
|
|
*/
|
2021-05-27 10:59:22 -04:00
|
|
|
enum options_t : uint8_t {
|
2021-08-15 23:36:29 -04:00
|
|
|
PREVIEW_DATA = 0b10000000, //!< Bit 7 = Preview_Data
|
|
|
|
STREAM_TERMINATED = 0b01000000, //!< Bit 6 = Stream_Terminated
|
|
|
|
FORCE_SYNCHRONIZATION = 0b00100000, //!< Bit 5 = Force_Synchronization
|
2021-05-27 10:59:22 -04:00
|
|
|
};
|
|
|
|
|
2021-07-30 09:11:32 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief The DATA::Pdu class
|
|
|
|
*/
|
2021-05-27 10:59:22 -04:00
|
|
|
class Pdu
|
2021-08-15 23:36:29 -04:00
|
|
|
: public ACN::PDU::Pdu
|
2021-05-27 10:59:22 -04:00
|
|
|
{
|
|
|
|
public:
|
2021-07-29 19:26:49 -04:00
|
|
|
Pdu();
|
2021-08-15 23:36:29 -04:00
|
|
|
void iStream(ACN::PDU::Stream) override;
|
2021-05-27 10:59:22 -04:00
|
|
|
};
|
|
|
|
|
2021-08-24 18:10:20 -04:00
|
|
|
} // SACN::DATA
|