ntv2captiondecoder708.h File Reference

Declares the CNTV2CaptionDecoder708 class. More...

#include "ntv2caption708service.h"
#include "ntv2caption608dataqueue.h"
#include "ajaanc/includes/ancillarydata_cea708.h"

Include dependency graph for ntv2captiondecoder708.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	CaptionChannelPacketInfo
	I am a container for a "Caption Channel Packet" – i.e., a wrapper for a clump of CEA-708 caption data. By CEA-708 rules, Caption Channel Packets are independent ("asynchronous") of video frame boundaries, which means a single Caption Channel Packet could span more than one frame, and/or multiple Caption Channel Packets can be sent in a single frame. Since we tend to parse things on a frame-by-frame basis (how quaint...), this means that at the beginning of each frame we could have an incomplete Caption Channel Packet (i.e. one that was started last frame but not yet completed), and at the end of each frame we could have zero, one or more completed Caption Channel Packets, and zero or one incomplete Packets (Caption Channel Packets that have been started but not completed). More...
class	CNTV2CaptionDecoder708
	I am a CEA-708 captioning decoder used primarily to obtain CEA-608 captions carried in CEA-708 anc data packets. More...

Typedefs
typedef AJARefPtr< CNTV2CaptionDecoder708 >	CNTV2CaptionDecoder708Ptr
typedef struct CaptionChannelPacketInfo	CaptionChannelPacketInfo
	I am a container for a "Caption Channel Packet" – i.e., a wrapper for a clump of CEA-708 caption data. By CEA-708 rules, Caption Channel Packets are independent ("asynchronous") of video frame boundaries, which means a single Caption Channel Packet could span more than one frame, and/or multiple Caption Channel Packets can be sent in a single frame. Since we tend to parse things on a frame-by-frame basis (how quaint...), this means that at the beginning of each frame we could have an incomplete Caption Channel Packet (i.e. one that was started last frame but not yet completed), and at the end of each frame we could have zero, one or more completed Caption Channel Packets, and zero or one incomplete Packets (Caption Channel Packets that have been started but not completed). More...
typedef struct CaptionChannelPacketInfo *	CaptionChannelPacketInfoPtr

Enumerations
enum	{ kCaptionChannelPacketClear, kCaptionChannelPacketStarted, kCaptionChannelPacketComplete }

Variables
const int	kMaxNumCaptionChannelPacketInfo = 25
	The max number of CaptionChannelPackets we can deal with in a single frame (a Caption Channel Packet can be as small as one "triplet", so whatever the max triplet count is...) More...

Detailed Description

Declares the CNTV2CaptionDecoder708 class.

Copyright

(C) 2006-2022 AJA Video Systems, Inc. All rights reserved.

Definition in file ntv2captiondecoder708.h.

Typedef Documentation

CaptionChannelPacketInfo

typedef struct CaptionChannelPacketInfo CaptionChannelPacketInfo

I am a container for a "Caption Channel Packet" – i.e., a wrapper for a clump of CEA-708 caption data. By CEA-708 rules, Caption Channel Packets are independent ("asynchronous") of video frame boundaries, which means a single Caption Channel Packet could span more than one frame, and/or multiple Caption Channel Packets can be sent in a single frame. Since we tend to parse things on a frame-by-frame basis (how quaint...), this means that at the beginning of each frame we could have an incomplete Caption Channel Packet (i.e. one that was started last frame but not yet completed), and at the end of each frame we could have zero, one or more completed Caption Channel Packets, and zero or one incomplete Packets (Caption Channel Packets that have been started but not completed).

CaptionChannelPacketInfoPtr

typedef struct CaptionChannelPacketInfo * CaptionChannelPacketInfoPtr

CNTV2CaptionDecoder708Ptr

typedef AJARefPtr<CNTV2CaptionDecoder708> CNTV2CaptionDecoder708Ptr

Definition at line 29 of file ntv2captiondecoder708.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kCaptionChannelPacketClear	"Empty" Caption Channel Packet
kCaptionChannelPacketStarted	We've started pouring data into a Caption Channel Packet but haven't yet finished.
kCaptionChannelPacketComplete	The Caption Channel Packet is "complete": it has all the data it's going to get.

Definition at line 36 of file ntv2captiondecoder708.h.

Variable Documentation

kMaxNumCaptionChannelPacketInfo

const int kMaxNumCaptionChannelPacketInfo = 25

The max number of CaptionChannelPackets we can deal with in a single frame (a Caption Channel Packet can be as small as one "triplet", so whatever the max triplet count is...)

Definition at line 33 of file ntv2captiondecoder708.h.