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"
 
class AJA_EXPORT AJATimeCode
{
public:
    AJATimeCode();
    AJATimeCode(uint32_t frame);
    AJATimeCode(const std::string &str, const AJATimeBase& timeBase, bool bDropFrame, bool bStdTc=false);
    AJATimeCode(const std::string &str, const AJATimeBase& timeBase);
    AJATimeCode(const AJATimeCode& other);
 
    virtual ~AJATimeCode();
    
    void                QueryString(std::string &str, const AJATimeBase& timeBase, bool bDropFrame);
    void                QueryString(char *pString, const AJATimeBase& timeBase, bool bDropFrame);     
 
    void                QuerySMPTEString(char *pString, const AJATimeBase& timeBase, bool bDropFrame);
    
    static int          QuerySMPTEStringSize(void);
    
    uint32_t            QueryFrame(void) const;
    
    
    bool                QueryStdTimecodeForHfr() { return m_stdTimecodeForHfr; }
    
    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);
    
    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 *pDbb, uint32_t *pLow, uint32_t *pHigh, const AJATimeBase& timeBase, bool bDrop);
    
    void                QueryRP188(uint32_t & outDBB, uint32_t & outLo, uint32_t & outHi, const AJATimeBase & timeBase, const bool bDrop);
    
    void                SetStdTimecodeForHfr(bool bStdTc) {m_stdTimecodeForHfr = 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;
    
    uint32_t            m_frame;
    bool                m_stdTimecodeForHfr;
protected:
private:
};
 
#endif  // AJA_TIMECODE_H