CGUIVideoData Class Reference

Contains information about a video loaded by CGUIVideoDecoder. More...

#include <GUIVideoData.h>

Public Member Functions
	CGUIVideoData ()
	~CGUIVideoData ()
void	DeleteData ()
eC_UByte	GetBytePerPixel () const
eC_UInt	GetCurrentFrame () const
eC_UByte *	GetData () const
eC_UInt	GetDataLength () const
eC_Bool	GetDeleteDataOnDestruction () const
void	GetFrameData (eC_UInt &Offset, eC_UInt &Size) const
eC_UInt	GetFrameSize () const
eC_UInt	GetHeight () const
eC_UInt	GetMicroSecondsPerFrame () const
eC_UInt	GetNumberOfFrames () const
eC_UInt	GetWidth () const
CGUIVideoData &	operator= (const CGUIVideoData &kSource)
void	SetBytesPerPixel (const eC_UByte &ubBPP)
void	SetCurrentFrame (const eC_UInt &uiFrame)
void	SetData (eC_UByte *pubData)
void	SetDataLength (const eC_UInt &uiLength)
void	SetDeleteDataOnDestruction (const eC_Bool bDeleteDataOnDestruction)
void	SetFrameOffset (const eC_UInt &uiIndex, const eC_UInt &uiOffset, const eC_UInt &uiSize)
void	SetHeight (const eC_UInt &uiHeight)
void	SetMicroSecondsPerFrame (const eC_UInt &uiMicroSecondsPerFrame)
void	SetNumberOfFrames (const eC_UInt &uiNumberOfFrames)
void	SetWidth (const eC_UInt &uiWidth)

Detailed Description

Contains information about a video loaded by CGUIVideoDecoder.

Typical use case for this class is that a graphics wrapper creates an object of this class, sets some attributes to make sure the image uses the correct format etc., then passes it to the image loader which hands it over to the individual image decoders that fill the data section with the decoded image data.

Constructor & Destructor Documentation

CGUIVideoData()

CGUIVideoData::CGUIVideoData

(

)

CGUIImageData constructor

~CGUIVideoData()

CGUIVideoData::~CGUIVideoData

(

)

CGUIImageData destructor

Member Function Documentation

DeleteData()

void CGUIVideoData::DeleteData

(

)

Deletes the image data array.

GetBytePerPixel()

eC_UByte CGUIVideoData::GetBytePerPixel

(

)

const

Returns

The bit depth of the image.

GetCurrentFrame()

eC_UInt CGUIVideoData::GetCurrentFrame

(

)

const

Return the index of the current frame

Returns

index of current frame

GetData()

eC_UByte * CGUIVideoData::GetData

(

)

const

Returns

Pointer to the decoded image data.

GetDataLength()

eC_UInt CGUIVideoData::GetDataLength

(

)

const

Returns the length of data

Returns

length of data

GetDeleteDataOnDestruction()

eC_Bool CGUIVideoData::GetDeleteDataOnDestruction

(

)

const

Returns

True if this image data deletes its contents upon destruction.

GetFrameData()

void CGUIVideoData::GetFrameData	(	eC_UInt &	Offset,
		eC_UInt &	Size
	)		const

Returns offset and size of current frame

Parameters

Offset
Size

GetFrameSize()

eC_UInt CGUIVideoData::GetFrameSize

(

)

const

Returns the size (in bytes) of one frame. Width, height and bits per pixel must have been set correctly before.

Returns

Frame size in bytes.

GetHeight()

eC_UInt CGUIVideoData::GetHeight

(

)

const

Returns

The height of the image.

GetMicroSecondsPerFrame()

eC_UInt CGUIVideoData::GetMicroSecondsPerFrame

(

)

const

Return the number of microseconds per frame

Returns

number of microseconds

GetNumberOfFrames()

eC_UInt CGUIVideoData::GetNumberOfFrames

(

)

const

Return number of frames

Returns

number of frames

GetWidth()

eC_UInt CGUIVideoData::GetWidth

(

)

const

Returns

The width of the image.

operator=()

CGUIVideoData & CGUIVideoData::operator=

(

const CGUIVideoData &

kSource

)

Operator= method. This does a flat copy of the given source CGUIImageData object, which means that both GUIImageData objects will then reference the SAME DATA in memory.

Parameters

kSource

Source object to be copied.

Returns

This instance.

SetBytesPerPixel()

void CGUIVideoData::SetBytesPerPixel

(

const eC_UByte &

ubBPP

)

Sets the bits per pixel of the image. Should only be called by an image decoder.

Parameters

ubBPP

Height of the image.

SetCurrentFrame()

void CGUIVideoData::SetCurrentFrame

(

const eC_UInt &

uiFrame

)

Sets the index of the current frame

Parameters

uiFrame

SetData()

void CGUIVideoData::SetData

(

eC_UByte *

pubData

)

Sets the data pointer of the image. Should only be called by an image decoder.

Parameters

*pubData

Pointer to memory to be used for storing a decoded image.

SetDataLength()

void CGUIVideoData::SetDataLength

(

const eC_UInt &

uiLength

)

Sets length of data

Parameters

uiLength

SetDeleteDataOnDestruction()

void CGUIVideoData::SetDeleteDataOnDestruction

(

const eC_Bool

bDeleteDataOnDestruction

)

Sets the destructor's behaviour.

Parameters

bDeleteDataOnDestruction

Pass true to have the destructor delete the decoded image data.

SetFrameOffset()

void CGUIVideoData::SetFrameOffset	(	const eC_UInt &	uiIndex,
		const eC_UInt &	uiOffset,
		const eC_UInt &	uiSize
	)

Sets the frame-offset

Parameters

uiIndex	index of frame
uiOffset	offset from beginning
uiSize	size in bytes

SetHeight()

void CGUIVideoData::SetHeight

(

const eC_UInt &

uiHeight

)

Sets the height of the image. Should only be called by an image decoder.

Parameters

uiHeight

Height of the image.

SetMicroSecondsPerFrame()

void CGUIVideoData::SetMicroSecondsPerFrame

(

const eC_UInt &

uiMicroSecondsPerFrame

)

Sets the number of microseconds per frame

Parameters

uiMicroSecondsPerFrame

SetNumberOfFrames()

void CGUIVideoData::SetNumberOfFrames

(

const eC_UInt &

uiNumberOfFrames

)

Sets the number of frames

Parameters

uiNumberOfFrames

SetWidth()

void CGUIVideoData::SetWidth

(

const eC_UInt &

uiWidth

)

Sets the width of the image. Should only be called by an image decoder.

Parameters

uiWidth

Width of the image.

---

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

• GUIVideoData.h