timecode.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef AJA_TIMECODE_H
#define AJA_TIMECODE_H
#include "ajabase/common/timebase.h"
 
typedef enum
{
    AJA_TIMECODE_LEGACY     = 0,    
    AJA_TIMECODE_STANDARD   = 1     
} AJATimecodeNotation;
 
 
class AJA_EXPORT AJATimeCode
{
public:
    AJATimeCode();
    AJATimeCode(uint32_t frame, bool bStdTcForHfr=true);
    AJATimeCode(const std::string &str, const AJATimeBase& timeBase, bool bDropFrame, bool bStdTcForHfr=true);
    AJATimeCode(const std::string &str, const AJATimeBase& timeBase);
    AJATimeCode(const AJATimeCode& other);
 
    virtual ~AJATimeCode();
 
    static uint32_t CalcFrame(uint32_t h, uint32_t m, uint32_t s, uint32_t f, const AJATimeBase& timeBase, bool bDropFrame, bool bStdTcForHfr, uint32_t addFrame);
 
    static uint32_t CalcHmsf(uint32_t &h, uint32_t &m, uint32_t &s, uint32_t &f, uint32_t frame, const AJATimeBase& timeBase, bool bDropFrame, bool bStdTcForHfr);
 
 
    void                QueryString(std::string &str, const AJATimeBase& timeBase, bool bDropFrame, bool bStdTcForHfr, AJATimecodeNotation notation = AJA_TIMECODE_LEGACY);
 
    void                QueryString(std::string &str, const AJATimeBase& timeBase, bool bDropFrame, AJATimecodeNotation notation = AJA_TIMECODE_LEGACY);
 
    void                QuerySMPTEString(char *pString, const AJATimeBase& timeBase, bool bDropFrame);
 
    static int          QuerySMPTEStringSize(void);
 
    uint32_t            QueryFrame(void) const;
 
 
    bool                QueryStdTimecodeForHfr() { return m_stdTcForHfr; }
 
    void                QueryHmsf(uint32_t &h, uint32_t &m, uint32_t &s, uint32_t &f, const AJATimeBase& timeBase, bool bDropFrame) const;
 
    void                Set(uint32_t frame);
 
    void                Set(const std::string &str, const AJATimeBase& timeBase);
 
    void                SetWithCleanup(const std::string &str, const AJATimeBase& timeBase, bool bDrop);
 
    void                Set(const std::string &str, const AJATimeBase& timeBase, bool bDropFrame);
 
    void                SetHmsf(uint32_t h, uint32_t m, uint32_t s, uint32_t f, const AJATimeBase& timeBase, bool bDropFrame, bool bStdTcForHfr, uint32_t addFrame);
    void                SetHmsf(uint32_t h, uint32_t m, uint32_t s, uint32_t f, const AJATimeBase& timeBase, bool bDropFrame);
 
    void                SetSMPTEString(const char *pBufr, const AJATimeBase& timeBase);
 
    void                SetRP188 (const uint32_t inDBB, const uint32_t inLo, const uint32_t inHi, const AJATimeBase & inTimeBase);
 
    void                QueryRP188(uint32_t & outDBB, uint32_t & outLo, uint32_t & outHi, const AJATimeBase & timeBase, const bool bDrop);
 
    void                SetStdTimecodeForHfr(bool bStdTc) {m_stdTcForHfr = bStdTc;}
 
 
    static bool         QueryIsDropFrame(const std::string &str);
 
 
    static int          QueryStringSize(void);  
 
    static bool         QueryIsRP188DropFrame (const uint32_t inDBB, const uint32_t inLo, const uint32_t inHi);
 
    AJATimeCode&        operator=(const AJATimeCode  &val);
    AJATimeCode&        operator+=(const AJATimeCode &val);
    AJATimeCode&        operator-=(const AJATimeCode &val);
    AJATimeCode&        operator+=(const int32_t val);
    AJATimeCode&        operator-=(const int32_t val);
    const AJATimeCode   operator+(const AJATimeCode &val) const;
    const AJATimeCode   operator+(const int32_t val) const;
    const AJATimeCode   operator-(const AJATimeCode &val) const;
    const AJATimeCode   operator-(const int32_t val) const;
    bool                operator==(const AJATimeCode &val) const;
    bool                operator<(const AJATimeCode &val) const;
    bool                operator<(const int32_t val) const;
    bool                operator>(const AJATimeCode &val) const;
    bool                operator>(const int32_t val) const;
    bool                operator!=(const AJATimeCode &val) const;
 
    #if !defined(NTV2_DEPRECATE_17_5)
        void QueryString(char *pStr, const AJATimeBase& tb, bool df, AJATimecodeNotation notation = AJA_TIMECODE_LEGACY);   
        void QueryRP188(uint32_t *pDbb, uint32_t *pLo, uint32_t *pHi, const AJATimeBase& tb, bool drop);    
    #endif  //  NTV2_DEPRECATE_17_5
private:
    uint32_t            m_frame;
    bool                m_stdTcForHfr;
};  //  AJATimeCode
 
#endif  // AJA_TIMECODE_H