VBILine Class Reference

Class that holds a single line of VBI data. More...

#include <vbi.h>

Inheritance diagram for VBILine:

List of all members.

Public Member Functions
	VBILine (int LineNumber, VBIWrappingType Wrapping, VBISampleCoding Coding)
	Construct a VBILine with no data.
	VBILine (int Field, int LineNumber, VBIWrappingType Wrapping, VBISampleCoding Coding)
	Construct a VBILine with no data, for an interlaced frame.
	VBILine (int LineNumber, VBIWrappingType Wrapping, VBISampleCoding Coding, UInt16 SampleCount, DataChunkPtr &LineData)
	Construct a VBILine with data.
	VBILine (int Field, int LineNumber, VBIWrappingType Wrapping, VBISampleCoding Coding, UInt16 SampleCount, DataChunkPtr &LineData)
	Construct a VBILine with data, for an interlaced frame.
void	SetData (UInt16 SampleCount, DataChunkPtr &LineData)
	Set (or replace) the current line data.
size_t	GetDataSize (void)
	Get the size of the data buffer, excluding the line number, wrapping type, sample coding and sample count bytes.
size_t	GetFullDataSize (void)
	Get the size of the data buffer, including the line number, wrapping type, sample coding and sample count bytes.
void	WriteData (UInt8 *Buffer)
	Write the line of data into a buffer, including the line number, wrapping type, sample coding and sample count bytes.
Protected Attributes
DataChunk	Data
	The VBI actual data bytes for this line, packed as per SMPTE-436M.
int	LineNumber
	The line number of this line in the frame, plus 0x4000 if the line is in field 2 of an interlaced picture.
VBIWrappingType	WrappingType
	The VBI Wrapping type for this line.
VBISampleCoding	SampleCoding
	SampleCoding for this line.
UInt16	SampleCount
	Number of samples in this line.

---

Detailed Description

Class that holds a single line of VBI data.

---

Constructor & Destructor Documentation

VBILine	(	int	LineNumber,
		VBIWrappingType	Wrapping,
		VBISampleCoding	Coding
	)			[inline]

Construct a VBILine with no data.

VBILine	(	int	Field,
		int	LineNumber,
		VBIWrappingType	Wrapping,
		VBISampleCoding	Coding
	)			[inline]

Construct a VBILine with no data, for an interlaced frame.

VBILine	(	int	LineNumber,
		VBIWrappingType	Wrapping,
		VBISampleCoding	Coding,
		UInt16	SampleCount,
		DataChunkPtr &	LineData
	)			[inline]

Construct a VBILine with data.

DRAGONS: The LineData chunk will be cleared by this operation

VBILine	(	int	Field,
		int	LineNumber,
		VBIWrappingType	Wrapping,
		VBISampleCoding	Coding,
		UInt16	SampleCount,
		DataChunkPtr &	LineData
	)			[inline]

Construct a VBILine with data, for an interlaced frame.

DRAGONS: The LineData chunk will be cleared by this operation

---

Member Function Documentation

void SetData	(	UInt16	SampleCount,
		DataChunkPtr &	LineData
	)			[inline]

Set (or replace) the current line data.

DRAGONS: The LineData chunk will be cleared by this operation

size_t GetDataSize

(

void

)

[inline]

Get the size of the data buffer, excluding the line number, wrapping type, sample coding and sample count bytes.

size_t GetFullDataSize

(

void

)

[inline]

Get the size of the data buffer, including the line number, wrapping type, sample coding and sample count bytes.

void WriteData

(

UInt8 *

Buffer

)

Write the line of data into a buffer, including the line number, wrapping type, sample coding and sample count bytes.

Note:

It is the caller's responsibility to ensure that the buffer has enough space - the number of bytes written will be GetFullDataSize()

---

Member Data Documentation

DataChunk Data [protected]

The VBI actual data bytes for this line, packed as per SMPTE-436M.

int LineNumber [protected]

The line number of this line in the frame, plus 0x4000 if the line is in field 2 of an interlaced picture.

VBIWrappingType WrappingType [protected]

The VBI Wrapping type for this line.

VBISampleCoding SampleCoding [protected]

SampleCoding for this line.

UInt16 SampleCount [protected]

Number of samples in this line.

---

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

• vbi.h
• vbi.cpp

---