InputDDP.h

Go to the documentation of this file.

#pragma once
/*
* InputDDP.h
*
* Project: InputDDP - Asynchronous DDP library for Arduino ESP8266 and ESP32
* Copyright (c) 2019, 2025 Daniel Kulp, Shelby Merrick
*
*  This program is provided free for you to use in any way that you wish,
*  subject to the laws and regulations where you are using it.  Due diligence
*  is strongly suggested before using this code.  Please give credit where due.
*
*  The Author makes no warranty of any kind, express or implied, with regard
*  to this program or the documentation contained in this document.  The
*  Author shall not be liable in any event for incidental or consequential
*  damages in connection with, or arising out of, the furnishing, performance
*  or use of these programs.
*
*/
 
#include "ESPixelStick.h"
#include "InputCommon.hpp"
 
#ifdef ESP32
#include <WiFi.h>
#include <AsyncUDP.h>
#elif defined (ESP8266)
#include <ESPAsyncUDP.h>
#include <ESP8266WiFi.h>
#include <ESP8266WiFiMulti.h>
#else
#error Platform not supported
#endif
 
class c_InputDDP : public c_InputCommon
{
private:
 
#define DDP_PORT 4048
 
#define DDP_Header_t_LEN (sizeof(struct ddp_hdr_struct))
#define DDP_MAX_DATALEN (480*3)   // fits nicely in an ethernet packet
 
#define DDP_FLAGS1_VERMASK  0xc0   // version mask
#define DDP_FLAGS1_VER1     0x40   // version=1
#define DDP_FLAGS1_PUSH     0x01
#define DDP_FLAGS1_QUERY    0x02
#define DDP_FLAGS1_REPLY    0x04
#define DDP_FLAGS1_STORAGE  0x08
#define DDP_FLAGS1_TIME     0x10
#define DDP_FLAGS1_DATAMASK (DDP_FLAGS1_QUERY | DDP_FLAGS1_REPLY | DDP_FLAGS1_STORAGE | DDP_FLAGS1_TIME)
#define DDP_FLAGS1_DATA     0x00
 
#define DDP_ID_DEFAULT_ID    1
#define DDP_ID_CONTROL     246
#define DDP_ID_CONFIG      250
#define DDP_ID_STATUS      251
#define DDP_ID_DMXTRANSIT  254
#define DDP_ID_ALL         255
 
#define IsData(f)          (DDP_FLAGS1_DATA    == ((f) & DDP_FLAGS1_DATAMASK))
#define IsPush(f)          (DDP_FLAGS1_PUSH    == ((f) & DDP_FLAGS1_PUSH))
#define IsQuery(f)         (DDP_FLAGS1_QUERY   == ((f) & DDP_FLAGS1_QUERY))
#define IsReply(f)         (DDP_FLAGS1_REPLY   == ((f) & DDP_FLAGS1_REPLY))
#define IsStorage(f)       (DDP_FLAGS1_STORAGE == ((f) & DDP_FLAGS1_STORAGE))
#define IsTime(f)          (DDP_FLAGS1_TIME    == ((f) & DDP_FLAGS1_TIME))
 
    struct __attribute__ ((packed)) DDP_Header_t
    {
        byte  flags1;
        byte  flags2;
        byte  type;
        byte  id;
        uint32_t channelOffset;
        uint16_t dataLen;
    };
 
    struct __attribute__ ((packed)) DDP_packet_t
    {
        DDP_Header_t header;  // header may or may not be time code
        byte         data[DDP_MAX_DATALEN];
    };
 
    struct __attribute__ ((packed)) DDP_TimeCode_packet_t
    {
        DDP_Header_t header;  // header may or may not be time code
        uint32_t     TimeCode;
        byte         data[DDP_MAX_DATALEN - sizeof(TimeCode)];
    };
 
    struct __attribute__ ((packed)) DDP_stats_t
    {
        uint32_t packetsReceived;
        uint64_t bytesReceived;
        uint32_t errors;
    };
    String   lastError;
 
    AsyncUDP        * udp = nullptr;         // UDP
    uint8_t         lastReceivedSequenceNumber = 0;
    bool            suspend = false;
    DDP_stats_t     stats;    // Statistics tracker
 
    void NetworkStateChanged (bool NetwokState);
 
    // Packet parser callback
    void ProcessReceivedUdpPacket (AsyncUDPPacket _packet);
    void ProcessReceivedData  (DDP_packet_t & Packet);
    void ProcessReceivedQuery ();
 
    enum PacketBufferStatus_t
    {
        BufferIsAvailable,
        BufferIsFilled,
        BufferIsBeingProcessed,
    };
 
    struct PacketBuffer_t
    {
        PacketBufferStatus_t PacketBufferStatus = PacketBufferStatus_t::BufferIsAvailable;
        DDP_packet_t Packet;
        IPAddress ResponseAddress;
        uint16_t  ResponsePort;
    } ;
 
    PacketBuffer_t PacketBuffer;
 
public:
 
    c_InputDDP (c_InputMgr::e_InputChannelIds NewInputChannelId,
                c_InputMgr::e_InputType       NewChannelType,
                uint32_t                        BufferSize);
 
    virtual ~c_InputDDP ();
 
    // Generic UDP listener, no physical or IP configuration
    void Begin ();
    bool SetConfig (JsonObject& jsonConfig);   
    void GetConfig (JsonObject& jsonConfig);   
    void GetStatus (JsonObject& jsonStatus);
    void Process ();                                        
    void GetDriverName (String& sDriverName) { sDriverName = "DDP"; } 
    void SetBufferInfo (uint32_t BufferSize);
    bool isShutDownRebootNeeded () { return HasBeenInitialized; }
 
};