Utility class for timecodes. More...

#include <timecode.h>

Public Member Functions
	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 ()

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)

uint32_t	QueryFrame (void) const

bool	QueryStdTimecodeForHfr ()

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)

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

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)

Static Public Member Functions
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)

static int	QuerySMPTEStringSize (void)

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)

Detailed Description

Utility class for timecodes.

This is a storage and conversion class for timecodes.

Definition at line 28 of file timecode.h.

Constructor & Destructor Documentation

◆ AJATimeCode() [1/5]

AJATimeCode::AJATimeCode ( )

Definition at line 44 of file timecode.cpp.

◆ AJATimeCode() [2/5]

AJATimeCode::AJATimeCode	(	uint32_t	frame,
		bool	bStdTcForHfr = `true`
	)

Definition at line 50 of file timecode.cpp.

◆ AJATimeCode() [3/5]

AJATimeCode::AJATimeCode	(	const std::string &	str,
		const AJATimeBase &	timeBase,
		bool	bDropFrame,
		bool	bStdTcForHfr = `true`
	)

Definition at line 56 of file timecode.cpp.

◆ AJATimeCode() [4/5]

AJATimeCode::AJATimeCode	(	const std::string &	str,
		const AJATimeBase &	timeBase
	)

Definition at line 62 of file timecode.cpp.

◆ AJATimeCode() [5/5]

AJATimeCode::AJATimeCode ( const AJATimeCode & other )

Definition at line 68 of file timecode.cpp.

◆ ~AJATimeCode()

AJATimeCode::~AJATimeCode ( )

virtual

Definition at line 77 of file timecode.cpp.

Member Function Documentation

◆ CalcFrame()

uint32_t AJATimeCode::CalcFrame	(	uint32_t	h,
		uint32_t	m,
		uint32_t	s,
		uint32_t	f,
		const AJATimeBase &	timeBase,
		bool	bDropFrame,
		bool	bStdTcForHfr,
		uint32_t	addFrame
	)

static

Calculate frame count given hmsf presentation.

Parameters

[in]	h	specifies the hours value.
[in]	m	specifies the minutes value.
[in]	s	specifies the seconds value.
[in]	f	specifies the frames value.
[in]	timeBase	frame rate from which to calculate string.
[in]	bDropFrame	true if using drop frame calculation.
[in]	bStdTcForHfr	true to use standard (LFR) frame values (1/2 frame values for framerates above 30 fps, 1/4 for rates above 60)
[in]	addFrame	number of frames to add when bStdTcForHfr=true (e.g given 60 fps, h=m=s=0 f=29 addFrame=1 -> return=59).

Returns: Return calculated frame count based on input values

Definition at line 107 of file timecode.cpp.

◆ CalcHmsf()

uint32_t AJATimeCode::CalcHmsf	(	uint32_t &	h,
		uint32_t &	m,
		uint32_t &	s,
		uint32_t &	f,
		uint32_t	frame,
		const AJATimeBase &	timeBase,
		bool	bDropFrame,
		bool	bStdTcForHfr = `true`
	)

static

Calculate hmsf values given frame count. Return add-frame remainder when using std timecode presentation

Parameters

[out]	h	specifies the hours value.
[out]	m	specifies the minutes value.
[out]	s	specifies the seconds value.
[out]	f	specifies the frames value.
[in]	frame	frame count.
[in]	timeBase	frame rate from which to calculate hmsf values.
[in]	bDropFrame	true to use drop frame calculation.
[in]	bStdTcForHfr	true to use standard (LFR) frame values (1/2 frame values for framerates above 30 fps, 1/4 for rates above 60 fps)

Returns: Return remaining uncounted frame with bStdTcForHfr=true (e.g given 60 fps, frame=59 => h=m=s=0 f=29 return=1)

Definition at line 170 of file timecode.cpp.

◆ operator!=()

bool AJATimeCode::operator!= ( const AJATimeCode & val ) const

Definition at line 701 of file timecode.cpp.

◆ operator+() [1/2]

const AJATimeCode AJATimeCode::operator+ ( const AJATimeCode & val ) const

Definition at line 747 of file timecode.cpp.

◆ operator+() [2/2]

const AJATimeCode AJATimeCode::operator+ ( const int32_t val ) const

Definition at line 752 of file timecode.cpp.

◆ operator+=() [1/2]

AJATimeCode & AJATimeCode::operator+= ( const AJATimeCode & val )

Definition at line 709 of file timecode.cpp.

◆ operator+=() [2/2]

AJATimeCode & AJATimeCode::operator+= ( const int32_t val )

Definition at line 715 of file timecode.cpp.

◆ operator-() [1/2]

const AJATimeCode AJATimeCode::operator- ( const AJATimeCode & val ) const

Definition at line 760 of file timecode.cpp.

◆ operator-() [2/2]

const AJATimeCode AJATimeCode::operator- ( const int32_t val ) const

Definition at line 765 of file timecode.cpp.

◆ operator-=() [1/2]

AJATimeCode & AJATimeCode::operator-= ( const AJATimeCode & val )

Definition at line 724 of file timecode.cpp.

◆ operator-=() [2/2]

AJATimeCode & AJATimeCode::operator-= ( const int32_t val )

Definition at line 734 of file timecode.cpp.

◆ operator<() [1/2]

bool AJATimeCode::operator< ( const AJATimeCode & val ) const

Definition at line 669 of file timecode.cpp.

◆ operator<() [2/2]

bool AJATimeCode::operator< ( const int32_t val ) const

Definition at line 675 of file timecode.cpp.

◆ operator=()

AJATimeCode & AJATimeCode::operator= ( const AJATimeCode & val )

Definition at line 643 of file timecode.cpp.

◆ operator==()

bool AJATimeCode::operator== ( const AJATimeCode & val ) const

Definition at line 656 of file timecode.cpp.

◆ operator>() [1/2]

bool AJATimeCode::operator> ( const AJATimeCode & val ) const

Definition at line 685 of file timecode.cpp.

◆ operator>() [2/2]

bool AJATimeCode::operator> ( const int32_t val ) const

Definition at line 691 of file timecode.cpp.

◆ QueryFrame()

uint32_t AJATimeCode::QueryFrame ( void ) const

Query frame number.

Returns: frame number.

Definition at line 92 of file timecode.cpp.

◆ QueryHmsf()

void AJATimeCode::QueryHmsf	(	uint32_t &	h,
		uint32_t &	m,
		uint32_t &	s,
		uint32_t &	f,
		const AJATimeBase &	timeBase,
		bool	bDropFrame
	)		const

Query hmsf values showing timecode for current frame count given the passed parameters.

Parameters

[out]	h	specifies the hours value.
[out]	m	specifies the minutes value.
[out]	s	specifies the seconds value.
[out]	f	specifies the frames value.
[in]	timeBase	frame rate from which to calculate string.
[in]	bDropFrame	drop frame value for string.

Definition at line 292 of file timecode.cpp.

◆ QueryIsDropFrame()

bool AJATimeCode::QueryIsDropFrame ( const std::string & str )

static

Query string showing timecode for current frame count given the passed parameters.

Parameters

[in] str string with timecode

Definition at line 81 of file timecode.cpp.

◆ QueryIsRP188DropFrame()

bool AJATimeCode::QueryIsRP188DropFrame	(	const uint32_t	inDBB,
		const uint32_t	inLo,
		const uint32_t	inHi
	)

static

Query if rp188 data is drop frame or not

Parameters

[in]	inDBB	Specifies the DBB bits of the RP188 struct.
[in]	inLo	Specifies the lo-order 32-bit word of the RP188 struct.
[in]	inHi	Specifies the hi-order 32-bit word of the RP188 struct.

Definition at line 563 of file timecode.cpp.

◆ QueryRP188() [1/2]

void AJATimeCode::QueryRP188	(	uint32_t &	outDBB,
		uint32_t &	outLo,
		uint32_t &	outHi,
		const AJATimeBase &	timeBase,
		const bool	bDrop
	)

Get RP188 register values using the given timebase, and drop frame.

Parameters

[out]	outDBB	Receives the DBB component.
[out]	outLo	Receives the low byte component.
[out]	outHi	Receives the high byte component.
[in]	timeBase	Specifies the AJATimeBase to use.
[in]	bDrop	Specify true if forcing drop-frame; otherwise false.

Bug:: Unimplemented.

Todo:: Needs to be implemented.

Definition at line 625 of file timecode.cpp.

◆ QueryRP188() [2/2]

void AJATimeCode::QueryRP188	(	uint32_t *	pDbb,
		uint32_t *	pLo,
		uint32_t *	pHi,
		const AJATimeBase &	tb,
		bool	drop
	)

Deprecated:: Use QueryRP188(uint32_t&, uint32_t&, uint32_t&, const AJATimeBase&, const bool) instead

Definition at line 615 of file timecode.cpp.

◆ QuerySMPTEString()

void AJATimeCode::QuerySMPTEString	(	char *	pString,
		const AJATimeBase &	timeBase,
		bool	bDropFrame
	)

Query SMPTE string showing timecode for current frame count given the passed parameters.

Parameters

[out]	pString	buffer in which to place string.
[in]	timeBase	frame rate from which to calculate string.
[in]	bDropFrame	drop frame value for string.

Definition at line 401 of file timecode.cpp.

◆ QuerySMPTEStringSize()

int AJATimeCode::QuerySMPTEStringSize ( void )

static

Query SMPTE string byte count.

Returns: number of bytes in SMPTE timecode string.

Definition at line 396 of file timecode.cpp.

◆ QueryStdTimecodeForHfr()

bool AJATimeCode::QueryStdTimecodeForHfr ( )

inline

Query HFR divide-by-two flag.

Returns: bStdTc Return true when using standard TC notation for HFR (e.g 01:00:00#59 -> 01:00:00:29), set to true by default

Definition at line 122 of file timecode.h.

◆ QueryString() [1/3]

void AJATimeCode::QueryString	(	char *	pStr,
		const AJATimeBase &	tb,
		bool	df,
		AJATimecodeNotation	notation = `AJA_TIMECODE_LEGACY`
	)

Deprecated:: Use QueryString(std::string&, const AJATimeBase&, bool, AJATimecodeNotation) instead

Definition at line 387 of file timecode.cpp.

◆ QueryString() [2/3]

void AJATimeCode::QueryString	(	std::string &	str,
		const AJATimeBase &	timeBase,
		bool	bDropFrame,
		AJATimecodeNotation	notation = `AJA_TIMECODE_LEGACY`
	)

Query string showing timecode for current frame count given the passed parameters.

Parameters

[out]	str	string in which to place timecode.
[in]	timeBase	frame rate from which to calculate string.
[in]	bDropFrame	drop frame value for string.
[in]	notation	specifies AJATimecodeNotation for timecode delimiters

See also: Timecode Display

Definition at line 381 of file timecode.cpp.

◆ QueryString() [3/3]

void AJATimeCode::QueryString	(	std::string &	str,
		const AJATimeBase &	timeBase,
		bool	bDropFrame,
		bool	bStdTcForHfr,
		AJATimecodeNotation	notation = `AJA_TIMECODE_LEGACY`
	)

Query string showing timecode for current frame count given the passed parameters.

Parameters

[out]	str	string in which to place timecode.
[in]	timeBase	frame rate from which to calculate string.
[in]	bDropFrame	drop frame value for string.
[in]	bStdTcForHfr	true to use standard (LFR) frame values (1/2 frame values for framerates above 30 fps, 1/4 for rates above 60)
[in]	notation	specifies AJATimecodeNotation for timecode delimiters

See also: Timecode Display

Definition at line 299 of file timecode.cpp.

◆ QueryStringSize()

int AJATimeCode::QueryStringSize ( void )

static

Deprecated:: Not needed when using std::string.

Definition at line 87 of file timecode.cpp.

◆ Set() [1/3]

void AJATimeCode::Set	(	const std::string &	str,
		const AJATimeBase &	timeBase
	)

Set current frame number.

Parameters

[in]	str	xx:xx:xx:xx style string representing new frame number.
[in]	timeBase	frame rate associated with pString.

Definition at line 489 of file timecode.cpp.

◆ Set() [2/3]

void AJATimeCode::Set	(	const std::string &	str,
		const AJATimeBase &	timeBase,
		bool	bDropFrame
	)

Set current frame number.

Parameters

[in]	str	xx:xx:xx:xx style string representing new frame number.
[in]	timeBase	frame rate associated with pString.
[in]	bDropFrame	true if forcing dropframe, false otherwise.

Definition at line 439 of file timecode.cpp.

◆ Set() [3/3]

void AJATimeCode::Set ( uint32_t frame )

Set current frame number.

Parameters

[in] frame new frame number.

Definition at line 420 of file timecode.cpp.

◆ SetHmsf() [1/2]

void AJATimeCode::SetHmsf	(	uint32_t	h,
		uint32_t	m,
		uint32_t	s,
		uint32_t	f,
		const AJATimeBase &	timeBase,
		bool	bDropFrame
	)

Definition at line 431 of file timecode.cpp.

◆ SetHmsf() [2/2]

void AJATimeCode::SetHmsf	(	uint32_t	h,
		uint32_t	m,
		uint32_t	s,
		uint32_t	f,
		const AJATimeBase &	timeBase,
		bool	bDropFrame,
		bool	bStdTcForHfr,
		uint32_t	addFrame
	)

Set current frame number.

Parameters

[in]	h	specifies the hours value.
[in]	m	specifies the minutes value.
[in]	s	specifies the seconds value.
[in]	f	specifies the frames value.
[in]	timeBase	frame rate associated with hmsf.
[in]	bDropFrame	true if forcing dropframe, false otherwise.
[in]	bStdTcForHfr	true to use standard (LFR) frame values (1/2 frame values for framerates above 30 fps, 1/4 for rates above 60)
[in]	addFrame	number of frames to add when using std TC presentation (e.g given 60 fps, 00:00:00.29 addFrame=0 => set:frame=58 .. 00:00:00:29 addFrame=1 => set:frame=59).

Definition at line 425 of file timecode.cpp.

◆ SetRP188()

void AJATimeCode::SetRP188	(	const uint32_t	inDBB,
		const uint32_t	inLo,
		const uint32_t	inHi,
		const AJATimeBase &	inTimeBase
	)

Set timecode via RP188 bytes.

Parameters

[in]	inDBB	Specifies the DBB bits of the RP188 struct.
[in]	inLo	Specifies the lo-order 32-bit word of the RP188 struct.
[in]	inHi	Specifies the hi-order 32-bit word of the RP188 struct.
[in]	inTimeBase	Specifies the time base to use.

Definition at line 570 of file timecode.cpp.

◆ SetSMPTEString()

void AJATimeCode::SetSMPTEString	(	const char *	pBufr,
		const AJATimeBase &	timeBase
	)

Set timecode via a SMPTE string.

Parameters

[in]	pBufr	pointer to string.
[in]	timeBase	time base associated with string.

Definition at line 549 of file timecode.cpp.

◆ SetStdTimecodeForHfr()

void AJATimeCode::SetStdTimecodeForHfr ( bool bStdTc )

inline

Set HFR divide-by-two flag.

Parameters

[in] bStdTc Set true when using standard TC notation for HFR (e.g 01:00:00#59 -> 01:00:00:29), set to true by default

Definition at line 220 of file timecode.h.

◆ SetWithCleanup()

void AJATimeCode::SetWithCleanup	(	const std::string &	str,
		const AJATimeBase &	timeBase,
		bool	bDrop
	)

Set current frame number. A variant which may have junk in the string.

Parameters

[in]	str	xx:xx:xx:xx style string representing new frame number.
[in]	timeBase	frame rate associated with pString.
[in]	bDrop	true if drop frame

Definition at line 495 of file timecode.cpp.

The documentation for this class was generated from the following files:

/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajabase/common/timecode.h
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajabase/common/timecode.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AJATimeCode() [1/5]

◆ AJATimeCode() [2/5]

◆ AJATimeCode() [3/5]

◆ AJATimeCode() [4/5]

◆ AJATimeCode() [5/5]

◆ ~AJATimeCode()

Member Function Documentation

◆ CalcFrame()

◆ CalcHmsf()

◆ operator!=()

◆ operator+() [1/2]

◆ operator+() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator<() [1/2]

◆ operator<() [2/2]

◆ operator=()

◆ operator==()

◆ operator>() [1/2]

◆ operator>() [2/2]

◆ QueryFrame()

◆ QueryHmsf()

◆ QueryIsDropFrame()

◆ QueryIsRP188DropFrame()

◆ QueryRP188() [1/2]

◆ QueryRP188() [2/2]

◆ QuerySMPTEString()

◆ QuerySMPTEStringSize()

◆ QueryStdTimecodeForHfr()

◆ QueryString() [1/3]

◆ QueryString() [2/3]

◆ QueryString() [3/3]

◆ QueryStringSize()

◆ Set() [1/3]

◆ Set() [2/3]

◆ Set() [3/3]

◆ SetHmsf() [1/2]

◆ SetHmsf() [2/2]

◆ SetRP188()

◆ SetSMPTEString()

◆ SetStdTimecodeForHfr()

◆ SetWithCleanup()