ancillarydata_timecode.h

Go to the documentation of this file.

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

#include "ajabase/common/timecode.h"
#include "ajabase/common/timebase.h"
#include "ancillarydatafactory.h"
#include "ancillarydata.h"


enum AJAAncillaryData_Timecode_Format
{
    AJAAncillaryData_Timecode_Format_Unknown,   // not set (usually defaults to 30 fps)

    AJAAncillaryData_Timecode_Format_60fps, // 60/59.94 fps format ("NTSC")
    AJAAncillaryData_Timecode_Format_50fps, // 50 fps format ("PAL")
    AJAAncillaryData_Timecode_Format_48fps, // 48/47.95 fps format
    AJAAncillaryData_Timecode_Format_30fps, // 30/29.97 fps format ("NTSC")
    AJAAncillaryData_Timecode_Format_25fps, // 25 fps format ("PAL")
    AJAAncillaryData_Timecode_Format_24fps  // 24/23.98 fps format
};


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

    virtual inline                          ~AJAAncillaryData_Timecode ()   {}

    virtual void                            Clear (void);       

    AJAAncillaryData_Timecode &             operator = (const AJAAncillaryData_Timecode & inRHS);

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

    virtual AJAStatus                       ParsePayloadData (void);


    virtual AJAStatus                       GeneratePayloadData (void)                  {return AJA_STATUS_SUCCESS;}


    virtual AJAStatus                       SetTimeHexValue (const uint8_t inDigitNum, const uint8_t inHexValue, const uint8_t inMask = 0x0f);

    virtual AJAStatus                       GetTimeHexValue (uint8_t inDigitNum, uint8_t & outHexValue, uint8_t inMask = 0x0f) const;

    virtual AJAStatus   SetTimeDigits ( const uint8_t inHourTens,   const uint8_t inHourOnes,
                                        const uint8_t inMinTens,    const uint8_t inMinOnes,
                                        const uint8_t inSecsTens,   const uint8_t inSecsOnes,
                                        const uint8_t inFrameTens,  const uint8_t inFrameOnes);

    virtual AJAStatus   GetTimeDigits ( uint8_t & outHourTens,  uint8_t & outHourOnes,
                                        uint8_t & outMinTens,   uint8_t & outMinOnes,
                                        uint8_t & outSecsTens,  uint8_t & outSecsOnes,
                                        uint8_t & outFrameTens, uint8_t & outFrameOnes) const;

    virtual AJAStatus   SetTime (const AJAAncillaryData_Timecode_Format inFormat, const uint32_t inHours,
                                const uint32_t inMinutes, const uint32_t inSeconds, const uint32_t inFrames);

    virtual AJAStatus   GetTime (const AJAAncillaryData_Timecode_Format inFormat, uint32_t & outHours,
                                uint32_t & outMinutes, uint32_t & outSeconds, uint32_t & outFrames) const;

    virtual AJAStatus SetTimecode (const AJATimeCode & inTimecode, const AJATimeBase & inTimeBase, const bool inIsDropFrame);

    virtual AJAStatus GetTimecode (AJATimeCode & outTimecode, const AJATimeBase & inTimeBase) const;

    virtual AJAStatus SetRP188Words (const uint32_t inLoWord, const uint32_t inHiWord, const AJATimeBase & inTimeBase);

    virtual AJAStatus GetRP188Words (uint32_t & outLoWord, uint32_t & outHiWord, const AJATimeBase & inTimeBase) const;


    virtual AJAStatus SetBinaryGroupHexValue (uint8_t digitNum, uint8_t  hexValue, uint8_t mask = 0x0f);
    virtual AJAStatus GetBinaryGroupHexValue (uint8_t digitNum, uint8_t& hexValue, uint8_t mask = 0x0f) const;

    virtual AJAStatus SetBinaryGroups (uint8_t  bg8, uint8_t  bg7, uint8_t  bg6, uint8_t  bg5, uint8_t  bg4, uint8_t  bg3, uint8_t  bg2, uint8_t  bg1);
    virtual AJAStatus GetBinaryGroups (uint8_t& bg8, uint8_t& bg7, uint8_t& bg6, uint8_t& bg5, uint8_t& bg4, uint8_t& bg3, uint8_t& bg2, uint8_t& bg1) const;


    virtual AJAStatus SetFieldIdFlag (bool  bFlag, AJAAncillaryData_Timecode_Format tcFmt = AJAAncillaryData_Timecode_Format_Unknown);
    virtual AJAStatus GetFieldIdFlag (bool& bFlag, AJAAncillaryData_Timecode_Format tcFmt = AJAAncillaryData_Timecode_Format_Unknown) const;


    virtual AJAStatus SetDropFrameFlag (bool  bFlag, AJAAncillaryData_Timecode_Format tcFmt = AJAAncillaryData_Timecode_Format_Unknown);
    virtual AJAStatus GetDropFrameFlag (bool& bFlag, AJAAncillaryData_Timecode_Format tcFmt = AJAAncillaryData_Timecode_Format_Unknown) const;


    virtual AJAStatus SetColorFrameFlag (bool  bFlag, AJAAncillaryData_Timecode_Format tcFmt = AJAAncillaryData_Timecode_Format_Unknown);
    virtual AJAStatus GetColorFrameFlag (bool& bFlag, AJAAncillaryData_Timecode_Format tcFmt = AJAAncillaryData_Timecode_Format_Unknown) const;


    virtual AJAStatus SetBinaryGroupFlag (const uint8_t inBGFlag, const AJAAncillaryData_Timecode_Format inFormat = AJAAncillaryData_Timecode_Format_Unknown);

    virtual AJAStatus GetBinaryGroupFlag (uint8_t & outBGFlag, const AJAAncillaryData_Timecode_Format inFormat = AJAAncillaryData_Timecode_Format_Unknown) const;

    static AJAAncDataType               RecognizeThisAncillaryData (const AJAAncillaryData * pInAncData);

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

    virtual std::string                 TimecodeString (void) const;

    static AJAAncillaryData_Timecode_Format GetTimecodeFormatFromTimeBase (const AJATimeBase & inTimeBase);

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

    // Which timecode digits go in which elements of timeDigits[]
    // Note that this is the same order as received/transmitted, i.e. ls digits FIRST!
    enum
    {
        kTcFrameUnits   = 0,
        kTcFrameTens    = 1,
        kTcSecondUnits  = 2,
        kTcSecondTens   = 3,
        kTcMinuteUnits  = 4,
        kTcMinuteTens   = 5,
        kTcHourUnits    = 6,
        kTcHourTens     = 7,
        kNumTimeDigits  = 8
    };

    //  Which binary groups go in which elements of binaryGroup[]?
    //  Note that this is the same order as received/transmitted, i.e. ls digits FIRST!
    enum
    {
        kBg1    = 0,
        kBg2    = 1,
        kBg3    = 2,
        kBg4    = 3,
        kBg5    = 4,
        kBg6    = 5,
        kBg7    = 6,
        kBg8    = 7,
        kNumBinaryGroups = 8
    };

    // 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!

    // The timecode data is stored as "raw" hex nibbles of data, split up between "time" values and "binary group" values.
    // This means that sundry "flags" which take advantage of unused time bits (e.g. bits 2 and 3 of the hour tens digit)
    // are kept with the hex digit data, and only parsed in or out by the appropriate Set()/Get() methods.
    uint8_t     m_timeDigits[kNumTimeDigits];       // the 8 hex values of the time data, in order of received/transmitted (i.e. ls digits first)
    uint8_t     m_binaryGroup[kNumBinaryGroups];    // the 8 hex values of the "Binary Groups", in order from BG1 - BG8

};  //  AJAAncillaryData_Timecode


inline std::ostream & operator << (std::ostream & inOutStream, const AJAAncillaryData_Timecode & inAncData)     {return inAncData.Print (inOutStream);}

#endif  // AJA_ANCILLARYDATA_TIMECODE_H