AJA NTV2 SDK  17.5.0.1492
NTV2 SDK 17.5.0.1492
Public Member Functions | List of all members
CRP188 Class Reference

#include <ntv2rp188.h>

Public Member Functions

 CRP188 ()
 
 CRP188 (const RP188_STRUCT &rp188, const TimecodeFormat tcFormat=kTCFormat30fps)
 
 CRP188 (const NTV2_RP188 &rp188, const TimecodeFormat tcFormat=kTCFormat30fps)
 
 CRP188 (const std::string &sRP188, const TimecodeFormat tcFormat=kTCFormat30fps)
 
 CRP188 (ULWord ulFrms, ULWord ulSecs, ULWord ulMins, ULWord ulHrs, const TimecodeFormat tcFormat=kTCFormat30fps)
 
 CRP188 (ULWord frames, const TimecodeFormat tcFormat=kTCFormat30fps)
 
virtual ~CRP188 ()
 
void Init ()
 
bool operator== (const CRP188 &s)
 
void SetRP188 (ULWord ulFrms, ULWord ulSecs, ULWord ulMins, ULWord ulHrs, NTV2FrameRate frameRate, const bool bDropFrame=false, const bool bSMPTE372=false)
 
void SetRP188 (const RP188_STRUCT &rp188, const TimecodeFormat tcFormat=kTCFormatUnknown)
 
void SetRP188 (const NTV2_RP188 &rp188, const TimecodeFormat tcFormat=kTCFormatUnknown)
 
void SetRP188 (const std::string &sRP188, const TimecodeFormat tcFormat=kTCFormatUnknown)
 
void SetRP188 (ULWord ulFrms, ULWord ulSecs, ULWord ulMins, ULWord ulHrs, const TimecodeFormat tcFormat=kTCFormatUnknown)
 
void SetRP188 (ULWord frames, const TimecodeFormat tcFormat=kTCFormatUnknown)
 
void SetDropFrame (bool bDropFrameFlag)
 
void SetColorFrame (bool bColorFrameFlag)
 
void SetVaricamFrameActive (bool bVaricamActive, ULWord frame)
 
void SetVaricamRate (NTV2FrameRate frameRate)
 
void SetFieldID (ULWord fieldID)
 
bool GetFieldID (void)
 
void SetBFGBits (bool bBFG0, bool bBFG1, bool bBFG2)
 
void SetSource (UByte src)
 
void SetOutputFilter (UByte src)
 
bool GetRP188Str (std::string &sRP188) const
 
const char * GetRP188CString () const
 
bool GetRP188Secs (ULWord &ulSecs) const
 
bool GetRP188Frms (ULWord &ulFrms) const
 
bool GetRP188Mins (ULWord &ulMins) const
 
bool GetRP188Hrs (ULWord &ulHrs) const
 
bool GetRP188Reg (RP188_STRUCT &outRP188) const
 
bool GetRP188Reg (NTV2_RP188 &outRP188) const
 
bool GetFrameCount (ULWord &frameCount)
 
ULWord MaxFramesPerDay (TimecodeFormat format=kTCFormatUnknown) const
 
void ConvertTimecode (ULWord &frameCount, TimecodeFormat format, ULWord hours, ULWord minutes, ULWord seconds, ULWord frames)
 
void ConvertFrameCount (ULWord frameCount, TimecodeFormat format, ULWord &hours, ULWord &minutes, ULWord &seconds, ULWord &frames)
 
ULWord AddFrames (ULWord frameCount)
 
ULWord SubtractFrames (ULWord frameCount)
 
bool GetRP188UserBitsStr (std::string &sRP188UB)
 
const char * GetRP188UserBitsCString ()
 
UByte GetSource () const
 
UByte GetOutputFilter () const
 
TimecodeFormat GetTimecodeFormat ()
 
bool IsFreshRP188 (void)
 
bool VaricamFrame0 (void)
 
bool VaricamFrame1 (void)
 
ULWord VaricamFrameRate (void)
 
NTV2FrameRate defaultFrameRateForTimecodeFormat (TimecodeFormat format=kTCFormatUnknown) const
 
bool FormatIsDropFrame (TimecodeFormat format=kTCFormatUnknown) const
 
bool FormatIs60_50fps (TimecodeFormat format=kTCFormatUnknown) const
 
bool FormatIsPAL (TimecodeFormat format=kTCFormatUnknown) const
 
ULWord FieldID (void)
 
bool DropFrame (void)
 
bool ColorFrame (void)
 
ULWord BinaryGroup (ULWord smpteNum)
 
bool SetBinaryGroup (ULWord smpteNum, ULWord bits)
 
bool SetUserBits (ULWord bits)
 
ULWord UDW (ULWord smpteUDW)
 
ULWord FramesPerSecond (TimecodeFormat format=kTCFormatUnknown) const
 
NTV2FrameRate DefaultFrameRateForTimecodeFormat (TimecodeFormat format=kTCFormatUnknown) const
 
bool InitBurnIn (NTV2FrameBufferFormat frameBufferFormat, NTV2FrameDimensions frameDimensions, LWord percentY=0)
 
void writeV210Pixel (char **pBytePtr, int x, int c, int y)
 
bool BurnTC (char *pBaseVideoAddress, int rowBytes, TimecodeBurnMode burnMode, int64_t frameCount=kDefaultFrameCount, bool bDisplay60_50fpsAs30_25=false)
 
void CopyDigit (char *pDigit, int digitWidth, int digitHeight, char *pFrameBuff, int fbRowBytes)
 
std::string GetTimeCodeString (bool bDisplay60_50fpsAs30_25=false)
 

Detailed Description

Definition at line 55 of file ntv2rp188.h.

Constructor & Destructor Documentation

◆ CRP188() [1/6]

CRP188::CRP188 ( )

Definition at line 373 of file ntv2rp188.cpp.

◆ CRP188() [2/6]

CRP188::CRP188 ( const RP188_STRUCT &  rp188,
const TimecodeFormat  tcFormat = kTCFormat30fps 
)

Definition at line 385 of file ntv2rp188.cpp.

◆ CRP188() [3/6]

CRP188::CRP188 ( const NTV2_RP188 &  rp188,
const TimecodeFormat  tcFormat = kTCFormat30fps 
)

Definition at line 391 of file ntv2rp188.cpp.

◆ CRP188() [4/6]

CRP188::CRP188 ( const std::string &  sRP188,
const TimecodeFormat  tcFormat = kTCFormat30fps 
)

◆ CRP188() [5/6]

CRP188::CRP188 ( ULWord  ulFrms,
ULWord  ulSecs,
ULWord  ulMins,
ULWord  ulHrs,
const TimecodeFormat  tcFormat = kTCFormat30fps 
)

Definition at line 379 of file ntv2rp188.cpp.

◆ CRP188() [6/6]

CRP188::CRP188 ( ULWord  frames,
const TimecodeFormat  tcFormat = kTCFormat30fps 
)

Definition at line 403 of file ntv2rp188.cpp.

◆ ~CRP188()

CRP188::~CRP188 ( )
virtual

Definition at line 410 of file ntv2rp188.cpp.

Member Function Documentation

◆ AddFrames()

ULWord CRP188::AddFrames ( ULWord  frameCount)

Definition at line 1121 of file ntv2rp188.cpp.

◆ BinaryGroup()

ULWord CRP188::BinaryGroup ( ULWord  smpteNum)

Definition at line 1269 of file ntv2rp188.cpp.

◆ BurnTC()

bool CRP188::BurnTC ( char *  pBaseVideoAddress,
int  rowBytes,
TimecodeBurnMode  burnMode,
int64_t  frameCount = kDefaultFrameCount,
bool  bDisplay60_50fpsAs30_25 = false 
)

Definition at line 1838 of file ntv2rp188.cpp.

◆ ColorFrame()

bool CRP188::ColorFrame ( void  )
inline

Definition at line 126 of file ntv2rp188.h.

◆ ConvertFrameCount()

void CRP188::ConvertFrameCount ( ULWord  frameCount,
TimecodeFormat  format,
ULWord &  hours,
ULWord &  minutes,
ULWord &  seconds,
ULWord &  frames 
)

Definition at line 1025 of file ntv2rp188.cpp.

◆ ConvertTimecode()

void CRP188::ConvertTimecode ( ULWord &  frameCount,
TimecodeFormat  format,
ULWord  hours,
ULWord  minutes,
ULWord  seconds,
ULWord  frames 
)

Definition at line 960 of file ntv2rp188.cpp.

◆ CopyDigit()

void CRP188::CopyDigit ( char *  pDigit,
int  digitWidth,
int  digitHeight,
char *  pFrameBuff,
int  fbRowBytes 
)

Definition at line 1998 of file ntv2rp188.cpp.

◆ defaultFrameRateForTimecodeFormat()

NTV2FrameRate CRP188::defaultFrameRateForTimecodeFormat ( TimecodeFormat  format = kTCFormatUnknown) const

◆ DefaultFrameRateForTimecodeFormat()

NTV2FrameRate CRP188::DefaultFrameRateForTimecodeFormat ( TimecodeFormat  format = kTCFormatUnknown) const

Definition at line 1398 of file ntv2rp188.cpp.

◆ DropFrame()

bool CRP188::DropFrame ( void  )
inline

Definition at line 124 of file ntv2rp188.h.

◆ FieldID()

ULWord CRP188::FieldID ( void  )
inline

Definition at line 122 of file ntv2rp188.h.

◆ FormatIs60_50fps()

bool CRP188::FormatIs60_50fps ( TimecodeFormat  format = kTCFormatUnknown) const

Definition at line 1208 of file ntv2rp188.cpp.

◆ FormatIsDropFrame()

bool CRP188::FormatIsDropFrame ( TimecodeFormat  format = kTCFormatUnknown) const

Definition at line 1192 of file ntv2rp188.cpp.

◆ FormatIsPAL()

bool CRP188::FormatIsPAL ( TimecodeFormat  format = kTCFormatUnknown) const

Definition at line 1227 of file ntv2rp188.cpp.

◆ FramesPerSecond()

ULWord CRP188::FramesPerSecond ( TimecodeFormat  format = kTCFormatUnknown) const

Definition at line 1369 of file ntv2rp188.cpp.

◆ GetFieldID()

bool CRP188::GetFieldID ( void  )

Definition at line 840 of file ntv2rp188.cpp.

◆ GetFrameCount()

bool CRP188::GetFrameCount ( ULWord &  frameCount)

Definition at line 952 of file ntv2rp188.cpp.

◆ GetOutputFilter()

UByte CRP188::GetOutputFilter ( ) const

Definition at line 906 of file ntv2rp188.cpp.

◆ GetRP188CString()

const char * CRP188::GetRP188CString ( ) const

Definition at line 923 of file ntv2rp188.cpp.

◆ GetRP188Frms()

bool CRP188::GetRP188Frms ( ULWord &  ulFrms) const

Definition at line 928 of file ntv2rp188.cpp.

◆ GetRP188Hrs()

bool CRP188::GetRP188Hrs ( ULWord &  ulHrs) const

Definition at line 946 of file ntv2rp188.cpp.

◆ GetRP188Mins()

bool CRP188::GetRP188Mins ( ULWord &  ulMins) const

Definition at line 940 of file ntv2rp188.cpp.

◆ GetRP188Reg() [1/2]

bool CRP188::GetRP188Reg ( NTV2_RP188 &  outRP188) const

Definition at line 1246 of file ntv2rp188.cpp.

◆ GetRP188Reg() [2/2]

bool CRP188::GetRP188Reg ( RP188_STRUCT &  outRP188) const

Definition at line 1240 of file ntv2rp188.cpp.

◆ GetRP188Secs()

bool CRP188::GetRP188Secs ( ULWord &  ulSecs) const

Definition at line 934 of file ntv2rp188.cpp.

◆ GetRP188Str()

bool CRP188::GetRP188Str ( std::string &  sRP188) const

Definition at line 917 of file ntv2rp188.cpp.

◆ GetRP188UserBitsCString()

const char * CRP188::GetRP188UserBitsCString ( )

Definition at line 1261 of file ntv2rp188.cpp.

◆ GetRP188UserBitsStr()

bool CRP188::GetRP188UserBitsStr ( std::string &  sRP188UB)

Definition at line 1252 of file ntv2rp188.cpp.

◆ GetSource()

UByte CRP188::GetSource ( ) const

Definition at line 894 of file ntv2rp188.cpp.

◆ GetTimecodeFormat()

TimecodeFormat CRP188::GetTimecodeFormat ( )
inline

Definition at line 107 of file ntv2rp188.h.

◆ GetTimeCodeString()

string CRP188::GetTimeCodeString ( bool  bDisplay60_50fpsAs30_25 = false)

Definition at line 2010 of file ntv2rp188.cpp.

◆ Init()

void CRP188::Init ( )

Definition at line 417 of file ntv2rp188.cpp.

◆ InitBurnIn()

bool CRP188::InitBurnIn ( NTV2FrameBufferFormat  frameBufferFormat,
NTV2FrameDimensions  frameDimensions,
LWord  percentY = 0 
)

Definition at line 1563 of file ntv2rp188.cpp.

◆ IsFreshRP188()

bool CRP188::IsFreshRP188 ( void  )
inline

Definition at line 110 of file ntv2rp188.h.

◆ MaxFramesPerDay()

ULWord CRP188::MaxFramesPerDay ( TimecodeFormat  format = kTCFormatUnknown) const

Definition at line 1161 of file ntv2rp188.cpp.

◆ operator==()

bool CRP188::operator== ( const CRP188 &  s)

Definition at line 427 of file ntv2rp188.cpp.

◆ SetBFGBits()

void CRP188::SetBFGBits ( bool  bBFG0,
bool  bBFG1,
bool  bBFG2 
)

Definition at line 852 of file ntv2rp188.cpp.

◆ SetBinaryGroup()

bool CRP188::SetBinaryGroup ( ULWord  smpteNum,
ULWord  bits 
)

Definition at line 1283 of file ntv2rp188.cpp.

◆ SetColorFrame()

void CRP188::SetColorFrame ( bool  bColorFrameFlag)

Definition at line 743 of file ntv2rp188.cpp.

◆ SetDropFrame()

void CRP188::SetDropFrame ( bool  bDropFrameFlag)

Definition at line 733 of file ntv2rp188.cpp.

◆ SetFieldID()

void CRP188::SetFieldID ( ULWord  fieldID)

Definition at line 820 of file ntv2rp188.cpp.

◆ SetOutputFilter()

void CRP188::SetOutputFilter ( UByte  src)

Definition at line 900 of file ntv2rp188.cpp.

◆ SetRP188() [1/6]

void CRP188::SetRP188 ( const NTV2_RP188 &  rp188,
const TimecodeFormat  tcFormat = kTCFormatUnknown 
)

Definition at line 553 of file ntv2rp188.cpp.

◆ SetRP188() [2/6]

void CRP188::SetRP188 ( const RP188_STRUCT &  rp188,
const TimecodeFormat  tcFormat = kTCFormatUnknown 
)

Definition at line 455 of file ntv2rp188.cpp.

◆ SetRP188() [3/6]

void CRP188::SetRP188 ( const std::string &  sRP188,
const TimecodeFormat  tcFormat = kTCFormatUnknown 
)

◆ SetRP188() [4/6]

void CRP188::SetRP188 ( ULWord  frames,
const TimecodeFormat  tcFormat = kTCFormatUnknown 
)

Definition at line 573 of file ntv2rp188.cpp.

◆ SetRP188() [5/6]

void CRP188::SetRP188 ( ULWord  ulFrms,
ULWord  ulSecs,
ULWord  ulMins,
ULWord  ulHrs,
const TimecodeFormat  tcFormat = kTCFormatUnknown 
)

Definition at line 627 of file ntv2rp188.cpp.

◆ SetRP188() [6/6]

void CRP188::SetRP188 ( ULWord  ulFrms,
ULWord  ulSecs,
ULWord  ulMins,
ULWord  ulHrs,
NTV2FrameRate  frameRate,
const bool  bDropFrame = false,
const bool  bSMPTE372 = false 
)

Definition at line 586 of file ntv2rp188.cpp.

◆ SetSource()

void CRP188::SetSource ( UByte  src)

Definition at line 888 of file ntv2rp188.cpp.

◆ SetUserBits()

bool CRP188::SetUserBits ( ULWord  bits)

Definition at line 1313 of file ntv2rp188.cpp.

◆ SetVaricamFrameActive()

void CRP188::SetVaricamFrameActive ( bool  bVaricamActive,
ULWord  frame 
)

Definition at line 753 of file ntv2rp188.cpp.

◆ SetVaricamRate()

void CRP188::SetVaricamRate ( NTV2FrameRate  frameRate)

Definition at line 773 of file ntv2rp188.cpp.

◆ SubtractFrames()

ULWord CRP188::SubtractFrames ( ULWord  frameCount)

Definition at line 1140 of file ntv2rp188.cpp.

◆ UDW()

ULWord CRP188::UDW ( ULWord  smpteUDW)

Definition at line 1342 of file ntv2rp188.cpp.

◆ VaricamFrame0()

bool CRP188::VaricamFrame0 ( void  )
inline

Definition at line 112 of file ntv2rp188.h.

◆ VaricamFrame1()

bool CRP188::VaricamFrame1 ( void  )
inline

Definition at line 114 of file ntv2rp188.h.

◆ VaricamFrameRate()

ULWord CRP188::VaricamFrameRate ( void  )

Definition at line 1360 of file ntv2rp188.cpp.

◆ writeV210Pixel()

void CRP188::writeV210Pixel ( char **  pBytePtr,
int  x,
int  c,
int  y 
)

Definition at line 1801 of file ntv2rp188.cpp.

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