ancillarydata_timecode_atc.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef AJA_ANCILLARYDATA_TIMECODE_ATC_H
#define AJA_ANCILLARYDATA_TIMECODE_ATC_H

#include "ancillarydatafactory.h"
#include "ancillarydata.h"
#include "ancillarydata_timecode.h"


// SMPTE 12M Ancillary Packet (formerly "RP-188")
const uint8_t   AJAAncillaryData_SMPTE12M_DID           = 0x60;
const uint8_t   AJAAncillaryData_SMPTE12M_SID           = 0x60;
const uint32_t  AJAAncillaryData_SMPTE12M_PayloadSize   = 16;   // constant 16 bytes


// see SMPTE 12M-2 Table 2
enum AJAAncillaryData_Timecode_ATC_DBB1PayloadType
{
    AJAAncillaryData_Timecode_ATC_DBB1PayloadType_LTC               = 0x00,
    AJAAncillaryData_Timecode_ATC_DBB1PayloadType_VITC1             = 0x01,
    AJAAncillaryData_Timecode_ATC_DBB1PayloadType_VITC2             = 0x02,

    AJAAncillaryData_Timecode_ATC_DBB1PayloadType_ReaderFilmData    = 0x06,
    AJAAncillaryData_Timecode_ATC_DBB1PayloadType_ReaderProdData    = 0x07,

    AJAAncillaryData_Timecode_ATC_DBB1PayloadType_LocalVideoData    = 0x7D,
    AJAAncillaryData_Timecode_ATC_DBB1PayloadType_LocalFilmData     = 0x7E,
    AJAAncillaryData_Timecode_ATC_DBB1PayloadType_LocalProdData     = 0x7F,

    AJAAncillaryData_Timecode_ATC_DBB1PayloadType_Unknown           = 0xFF
};


class AJAExport AJAAncillaryData_Timecode_ATC : public AJAAncillaryData_Timecode
{
public:
    AJAAncillaryData_Timecode_ATC ();   

    AJAAncillaryData_Timecode_ATC (const AJAAncillaryData_Timecode_ATC & inClone);

    AJAAncillaryData_Timecode_ATC (const AJAAncillaryData_Timecode_ATC * pInClone);

    AJAAncillaryData_Timecode_ATC (const AJAAncillaryData * pInData);

    virtual                                     ~AJAAncillaryData_Timecode_ATC ();  

    virtual void                                Clear (void);                       

    virtual AJAAncillaryData_Timecode_ATC &         operator = (const AJAAncillaryData_Timecode_ATC & inRHS);

    virtual inline AJAAncillaryData_Timecode_ATC *  Clone (void) const  {return new AJAAncillaryData_Timecode_ATC (this);}  


    virtual AJAStatus SetDBB1(uint8_t  dbb1);
    virtual AJAStatus GetDBB1(uint8_t& dbb1) const;

    virtual AJAStatus SetDBB2(uint8_t  dbb2);
    virtual AJAStatus GetDBB2(uint8_t& dbb2) const;

    virtual AJAStatus SetDBB(uint8_t  dbb1, uint8_t  dbb2);
    virtual AJAStatus GetDBB(uint8_t& dbb1, uint8_t& dbb2) const;


    virtual AJAStatus               SetDBB1PayloadType (const AJAAncillaryData_Timecode_ATC_DBB1PayloadType inType);

    virtual AJAStatus               GetDBB1PayloadType (AJAAncillaryData_Timecode_ATC_DBB1PayloadType & outType) const;

    virtual AJAStatus               ParsePayloadData (void);

    virtual AJAStatus               GeneratePayloadData (void);

    virtual std::ostream &          Print (std::ostream & inOutStream, const bool inDetailed = false) const;

    static AJAAncDataType           RecognizeThisAncillaryData (const AJAAncillaryData * pInAncData);

protected:
    void        Init (void);    // NOT virtual - called by constructors

    // Note: if you make a change to the local member data, be sure to ALSO make the appropriate
    //       changes in the Init() and operator= methods!
    uint8_t     m_dbb1;         // "Distributed Binary Bits" - only transported by ATC
    uint8_t     m_dbb2;         //

};  //  AJAAncillaryData_Timecode_ATC

#endif  // AJA_ANCILLARYDATA_TIMECODE_ATC_H