ancillarydata_timecode_vitc.h

Go to the documentation of this file.

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

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


// comment this out to use older "NTV2" VITC Encode algorithm
// leave defined to use "D-VITC" parameters as defined in SMPTE-266M
#define USE_SMPTE_266M


// VITC ("Analog") Packet IDs
const uint8_t   AJAAncillaryData_VITC_DID = AJAAncData_AnalogSID;
const uint8_t   AJAAncillaryData_VITC_SID = AJAAncData_AnalogDID;

const uint32_t  AJAAncillaryData_VITC_PayloadSize = 720;    // note: assumes we're only using this for SD (720 pixels/line)


enum AJAAncillaryData_Timecode_VITC_Type
{
    AJAAncillaryData_Timecode_VITC_Type_Unknown     = 0,
    AJAAncillaryData_Timecode_VITC_Type_Timecode    = 1,    // CRC == 0x00
    AJAAncillaryData_Timecode_VITC_Type_FilmData    = 2,    // RP-201 Film Data (CRC == 0xFF)
    AJAAncillaryData_Timecode_VITC_Type_ProdData    = 3     // RP-201 Production Data (CRC == 0x0F)
};



class AJAExport AJAAncillaryData_Timecode_VITC : public AJAAncillaryData_Timecode
{
public:
                                            AJAAncillaryData_Timecode_VITC ();
                                            AJAAncillaryData_Timecode_VITC (const AJAAncillaryData_Timecode_VITC & clone);
                                            AJAAncillaryData_Timecode_VITC (const AJAAncillaryData_Timecode_VITC * pClone);
                                            AJAAncillaryData_Timecode_VITC (const AJAAncillaryData * pData);

    virtual                                 ~AJAAncillaryData_Timecode_VITC ()      {}

    virtual void                            Clear (void);       

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

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

    virtual AJAStatus                       ParsePayloadData (void);

    virtual AJAStatus                       GeneratePayloadData (void);

    virtual inline AJAAncillaryData_Timecode_VITC_Type  GetVITCDataType (void) const    {return m_vitcType;}    

    virtual AJAStatus                   SetVITCDataType (const AJAAncillaryData_Timecode_VITC_Type inType);

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


    static AJAAncDataType               RecognizeThisAncillaryData (const AJAAncillaryData * pInAncData);

    static std::string                  VITCTypeToString (const AJAAncillaryData_Timecode_VITC_Type inType);


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

    // Encode methods ported/stolen from ntv2vitc.cpp
    bool        DecodeLine (const uint8_t * pInLine);
    AJAStatus   EncodeLine (uint8_t * pOutLine) const;

#ifdef USE_SMPTE_266M
#else
    void DoVITCBitPair(uint8_t *pLine, uint32_t& pixelIndex, bool bPrevBit, bool bBit0, bool bBit1, bool bDropBit);
#endif

    // 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!
    AJAAncillaryData_Timecode_VITC_Type m_vitcType;     

};  //  AJAAncillaryData_Timecode_VITC

#endif  // AJA_ANCILLARYDATA_TIMECODE_VITC_H