deVideo Class Reference

Video class. More...

#include <deVideo.h>

Inheritance diagram for deVideo:

List of all members.

Public Types
enum	ePixelFormat { epf444, epf422, epf420 }
	Pixel format. More...
Public Member Functions
Constructors and Destructors
	deVideo (deVideoManager *manager, const char *filename, int width, int height, int pixelFormat, int frameRate, int frameCount, bool streaming, const decColorMatrix3 &colorConversionMatrix)
	Creates a new video object.
virtual	~deVideo ()
	Cleans up the video object.
Management
int	GetWidth () const
	Retrieves the width in pixels.
int	GetHeight () const
	Retrieves the height in pixels.
int	GetPixelFormat () const
	Retrieves the pixel format.
int	GetFrameCount () const
	Retrieves the number of frames.
unsigned char *	GetFrameData () const
	Retrieves the frame data if non-streaming or NULL if streaming.
int	GetFrameRate () const
	Retrieves the frame rate.
float	GetPlayTime () const
	Retrieves the play time in seconds.
bool	GetStreaming () const
	Determines if the video source is a streaming video.
const decColorMatrix3 &	GetColorConversionMatrix () const
	Retrieves the color conversion matrix.
System Peers
deBaseGraphicVideo *	GetGraphicPeer () const
	Retrieves the graphic system peer.
void	SetGraphicPeer (deBaseGraphicVideo *peer)
	Sets the graphic system peer.

---

Detailed Description

Video class.

Stores a video. Videos are sequences of images used to play short videos once or in a loop. Videos can be of streaming or non-streaming type. For non-streaming videos the data is loaded into a memory buffer shared. This is the best choice for small videos which do not require a lot of memory or are used in many places. For streaming videos no memory buffer is held. Streaming videos use a Video Decoder object to retrieve the image data. This is the best choice for large videos or videos which are used only a few times. The format of the video data can be RGB or YUV. The same data structures as in the image resource can be found. For the YUV format the mapping r=y, g=u and b=v is used.

Author:

Plüss Roland

Version:

1.0

Date:

2010

---

Member Enumeration Documentation

enum deVideo::ePixelFormat

Pixel format.

Enumerator:

epf444	Pixels are stored in the 4:4:4 format.
epf422	Pixels are stored in the 4:2:2 format.
epf420	Pixels are stored in the 4:2:0 format.

---

Constructor & Destructor Documentation

deVideo::deVideo	(	deVideoManager *	manager,
		const char *	filename,
		int	width,
		int	height,
		int	pixelFormat,
		int	frameRate,
		int	frameCount,
		bool	streaming,
		const decColorMatrix3 &	colorConversionMatrix
	)

Creates a new video object.

virtual deVideo::~deVideo

(

)

[virtual]

Cleans up the video object.

---

Member Function Documentation

const decColorMatrix3& deVideo::GetColorConversionMatrix

(

)

const [inline]

Retrieves the color conversion matrix.

int deVideo::GetFrameCount

(

)

const [inline]

Retrieves the number of frames.

unsigned char* deVideo::GetFrameData

(

)

const [inline]

Retrieves the frame data if non-streaming or NULL if streaming.

int deVideo::GetFrameRate

(

)

const [inline]

Retrieves the frame rate.

deBaseGraphicVideo* deVideo::GetGraphicPeer

(

)

const [inline]

Retrieves the graphic system peer.

int deVideo::GetHeight

(

)

const [inline]

Retrieves the height in pixels.

int deVideo::GetPixelFormat

(

)

const [inline]

Retrieves the pixel format.

float deVideo::GetPlayTime

(

)

const [inline]

Retrieves the play time in seconds.

bool deVideo::GetStreaming

(

)

const [inline]

Determines if the video source is a streaming video.

int deVideo::GetWidth

(

)

const [inline]

Retrieves the width in pixels.

void deVideo::SetGraphicPeer

(

deBaseGraphicVideo *

peer )

Sets the graphic system peer.

---

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

• deVideo.h