vetCodec_MOV Class Reference

Inheritance diagram for vetCodec_MOV:

Public Member Functions
	vetCodec_MOV (vetCodec_MOVParameters *initParams=NULL)
	Default constructor, initialize parameters and superclasses.
	vetCodec_MOV (char *filename, int stream=0)
	Initialize parameters and load given mpeg movie.
	~vetCodec_MOV ()
	Default destructor, close file and free buffer.
VETRESULT	newVideo (char *filename, unsigned int w, unsigned int h, float frame_rate, int quality=80)
	Load a BMP format image into current buffer (vetFrameRGB).
VETRESULT	save ()
	Save new movie to file, must be called at the end of writing, use newVideo(..) to create an empty video.
VETRESULT	load ()
	Load movie from current filename, use SetFileName() or load(char*, int).
VETRESULT	load (char *filename, int stream=0)
	Load a BMP format image into current buffer (vetFrameRGB).
VETRESULT	save (char *filename, int stream=0)
	Save current movie to file.
VETRESULT	setParameters (vetCodec_MOVParameters *initParams)
	Set parameters for (de)coding.
vetCodec_MOVParameters &	getParameters ()
	Get parameters for (de)coding.
VETRESULT	setFilterParameters (vetFilterParameters *initParams)
vetFilterParameters *	getFilterParameters ()
VETRESULT	reset ()
	Reset filename and movie related settings.
bool	EoF ()
	Get the state of current data source.
long	getAudioFrameIndex (int stream=-1)
	Test for end of file.Read current frame index (position in the video timeline).
long	getVideoFrameIndex (int stream=-1)
	Read current sample index (position in the audio timeline).
VETRESULT	setFrameIndex (long index, int stream=-1)
	Seek to point in stream (position in the video timeline).
VETRESULT	goToStart ()
	Move frame index to start (first frame).
VETRESULT	goToEnd ()
	Move frame index to end (last frame).
VETRESULT	setVideoFrameRate (float fps)
VETRESULT	setHeight (unsigned int value)
	Set current canvas' height.
VETRESULT	setWidth (unsigned int value)
	Set current canvas' width.
unsigned int	getWidth () const
	read current image's width.
unsigned int	getHeight () const
	read current image's height.
int	getVideoDepth (int stream=0)
	read current image's depth.
bool	hasVideo ()
	check if loaded movie has a video stream.
int	getVideoStreamCount ()
	get movie's video streams count.
float	getVideoFrameRate (int stream=-1)
	get movie's video frame rate.
long	getVideoStreamLength (int stream=-1)
	get movie's video frame count.
char *	getVideoCompressor (int stream=-1)
	get movie's video compressor name.
bool	hasAudio ()
	get movie's audio streams count.
int	getAudioStreamCount ()
	get movie's audio streams count.
int	getAudioChannels (int stream=-1)
	get movie's audio channel count for selected stream.
long	getAudioSampleRate (int stream=-1)
	get movie's audio sample rate for selected stream.
long	getAudioStreamLength (int stream=-1)
	get movie's audio sample count for selected stream.
char *	getAudioCompressor (int stream=-1)
	get movie's audio compressor name.
VETRESULT	setName (char *string)
	set movie's name.
VETRESULT	setInfo (char *string)
	set movie's informations.
VETRESULT	setCopyRight (char *string)
	set movie's copyright.
char *	getName ()
	get movie's name.
char *	getInfo ()
	get movie's informations.
char *	getCopyRight ()
	get movie's copyright.
VETRESULT	extractTo (vetFrameYUV420 &img)
	Load current frame data into image (parameter), increments frame index.
VETRESULT	extractTo (vetFrameRGB24 &img)
	Load current frame data into image (parameter), increments frame index.
VETRESULT	extractTo (vetFrameT< unsigned char > &img)
	Load current frame data into image (parameter), increments frame index.
VETRESULT	importFrom (vetFrameYUV420 &img)
	Encode given image to stream, increments frame index.
VETRESULT	importFrom (vetFrameRGB24 &img)
	Encode given image to stream, increments frame index.
VETRESULT	importFrom (vetFrameT< unsigned char > &img)
	Encode given image to stream, increments frame index.
bool	isEncodingAvailable ()
	Input operator, import standard VETLib frame formats, current implementation calls directly importFrom() method.Ouput operator, export to standard VETLib frame formats, current implementation calls directly extractTo() method and if framerate isn't zero waits untill clock is syncronized, if elaboration time is greater than sleeptime, no delay is applied.
bool	isDecodingAvailable ()
	Check ability to decode data.
Protected Attributes
vetCodec_MOVParameters *	myParams
	vetCodec_MOV parameters pointer.
quicktime_t *	file
	Quicktime file handle.
unsigned char **	buff
	decoded data buffer.
long	lenghtFrames
	number of frames (total).
bool	streamEOF
	when last frame is extracted this is set to true.
unsigned int	width
	quicktime movie width.
unsigned int	height
	quicktime movie height.
float	outFrameRate
	frame rate

---

Detailed Description

Definition at line 144 of file vetCodec_MOV.h.

---

Constructor & Destructor Documentation

vetCodec_MOV::vetCodec_MOV (  vetCodec_MOVParameters *  initParams = NULL  )

Default constructor, initialize parameters and superclasses. Parameters: [in]  initParams  parameters for this module or NULL for defaults. Definition at line 52 of file vetCodec_MOV.cpp. References buff, DEBUGMSG, file, reset(), and setParameters().

vetCodec_MOV::vetCodec_MOV (  char *  filename, int  stream = 0 )

Initialize parameters and load given mpeg movie. Parameters: [in]  filename  a valid MPEG1-2 movie filename [in]  stream  video stream to load (default is first: 0) Definition at line 32 of file vetCodec_MOV.cpp. References buff, DEBUGMSG, file, load(), reset(), and setParameters().

---

Member Function Documentation

bool vetCodec_MOV::EoF (   )  [virtual]

Get the state of current data source. Returns: true is there are no more frames to load, false else. Implements vetCodec. Definition at line 106 of file vetCodec_MOV.cpp. References file, vetCodec_MOVParameters::frameIndex, lenghtFrames, and myParams.

VETRESULT vetCodec_MOV::extractTo (  vetFrameT< unsigned char > &  img  )  [virtual]

Load current frame data into image (parameter), increments frame index. Parameters: [out]  img  Greyscale VETLib Frame to store data. Returns: VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else. Note: Ouput operator (>>) call directly this function. See also: operator >> (vetFrameT&) Implements vetCodec. Definition at line 230 of file vetCodec_MOV.cpp. References DEBUGMSG, file, VETRET_ILLEGAL_USE, and VETRET_NOT_IMPLEMENTED.

VETRESULT vetCodec_MOV::extractTo (  vetFrameRGB24 &  img  )  [virtual]

Load current frame data into image (parameter), increments frame index. Parameters: [out]  img  VETLib Cache24 Frame to store data. Returns: VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else. Note: Ouput operator (>>) call directly this function. See also: operator >> (vetFrameRGB24&) Implements vetCodec. Definition at line 193 of file vetCodec_MOV.cpp. References vetFrameRGB24::data, DEBUGMSG, file, vetCodec_MOVParameters::frameIndex, vetFrame::height, height, lenghtFrames, myParams, vetFrameRGB24::reAllocCanvas(), streamEOF, VETRET_ILLEGAL_USE, VETRET_OK, vetFrame::width, and width.

VETRESULT vetCodec_MOV::extractTo (  vetFrameYUV420 &  img  )  [virtual]

Load current frame data into image (parameter), increments frame index. Parameters: [out]  img  VETLib Cache Frame to store data. Returns: VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else. Note: Ouput operator (>>) call directly this function. See also: operator >> (vetFrameYUV420&) Implements vetCodec. Definition at line 170 of file vetCodec_MOV.cpp. References DEBUGMSG, file, VETRET_ILLEGAL_USE, and VETRET_NOT_IMPLEMENTED.

int vetCodec_MOV::getAudioChannels (  int  stream = -1  )

get movie's audio channel count for selected stream. Parameters: [in]  stream  select stream index. default is -1: current active stream. Returns: number of audio channels. Definition at line 788 of file vetCodec_MOV.cpp. References file, getAudioStreamCount(), hasAudio(), myParams, and vetCodec_MOVParameters::stream.

char * vetCodec_MOV::getAudioCompressor (  int  stream = -1  )

get movie's audio compressor name. Parameters: [in]  stream  select stream index. default is -1: current active stream. Returns: pointer to a NULL terminated string. Definition at line 632 of file vetCodec_MOV.cpp. References file, getAudioStreamCount(), hasVideo(), myParams, and vetCodec_MOVParameters::stream.

long vetCodec_MOV::getAudioFrameIndex (  int  stream = -1  )

Test for end of file.Read current frame index (position in the video timeline). Parameters: [in]  stream  select stream index. default is -1: current active stream. Returns: current frame index, -1 if stream has not been loaded. Definition at line 529 of file vetCodec_MOV.cpp. References file, getVideoStreamCount(), hasAudio(), myParams, and vetCodec_MOVParameters::stream.

long vetCodec_MOV::getAudioSampleRate (  int  stream = -1  )

get movie's audio sample rate for selected stream. Parameters: [in]  stream  select stream index. default is -1: current active stream. Returns: number of sample per second. Definition at line 769 of file vetCodec_MOV.cpp. References file, getAudioStreamCount(), hasAudio(), myParams, and vetCodec_MOVParameters::stream.

int vetCodec_MOV::getAudioStreamCount (   )

get movie's audio streams count. Returns: number of audio streams. Definition at line 715 of file vetCodec_MOV.cpp. References file. Referenced by getAudioChannels(), getAudioCompressor(), getAudioSampleRate(), and getAudioStreamLength().

long vetCodec_MOV::getAudioStreamLength (  int  stream = -1  )  [virtual]

get movie's audio sample count for selected stream. Parameters: [in]  stream  select stream index. default is -1: current active stream. Returns: number of sample. Implements vetCodec. Definition at line 731 of file vetCodec_MOV.cpp. References file, getAudioStreamCount(), hasAudio(), myParams, and vetCodec_MOVParameters::stream.

char * vetCodec_MOV::getCopyRight (   )

get movie's copyright. Returns: pointer to a NULL terminated string. Definition at line 892 of file vetCodec_MOV.cpp. References file.

unsigned int vetCodec_MOV::getHeight (   )  const [inline, virtual]

read current image's height. Returns: Height in pixel. Implements vetInput. Definition at line 403 of file vetCodec_MOV.h. References height.

char * vetCodec_MOV::getInfo (   )

get movie's informations. Returns: pointer to a NULL terminated string. Definition at line 879 of file vetCodec_MOV.cpp. References file.

char * vetCodec_MOV::getName (   )

get movie's name. Returns: pointer to a NULL terminated string. Definition at line 866 of file vetCodec_MOV.cpp. References file.

vetCodec_MOVParameters& vetCodec_MOV::getParameters (   )  [inline]

Get parameters for (de)coding. Returns: pointer to vetCodec_MOVParameters class. Definition at line 275 of file vetCodec_MOV.h. References myParams.

char * vetCodec_MOV::getVideoCompressor (  int  stream = -1  )

get movie's video compressor name. Parameters: [in]  stream  select stream index. default is -1: current active stream. Returns: pointer to a NULL terminated string.. Definition at line 613 of file vetCodec_MOV.cpp. References file, getVideoStreamCount(), hasVideo(), myParams, and vetCodec_MOVParameters::stream.

int vetCodec_MOV::getVideoDepth (  int  stream = 0  )

read current image's depth. Parameters: [in]  stream  select stream index. default is -1: current active stream. Returns: movie's depth. Definition at line 594 of file vetCodec_MOV.cpp. References file, getVideoStreamCount(), hasVideo(), myParams, vetCodec_MOVParameters::stream, and VETRET_ILLEGAL_USE.

long vetCodec_MOV::getVideoFrameIndex (  int  stream = -1  )

Read current sample index (position in the audio timeline). Parameters: [in]  stream  select stream index. default is -1: current active stream. Returns: current frame index, -1 if stream has not been loaded. Definition at line 548 of file vetCodec_MOV.cpp. References file, getVideoStreamCount(), hasVideo(), myParams, and vetCodec_MOVParameters::stream.

float vetCodec_MOV::getVideoFrameRate (  int  stream = -1  )

get movie's video frame rate. Parameters: [in]  stream  select stream index. default is -1: current active stream. Returns: number of frame per second. Definition at line 652 of file vetCodec_MOV.cpp. References file, getVideoStreamCount(), hasVideo(), myParams, and vetCodec_MOVParameters::stream.

int vetCodec_MOV::getVideoStreamCount (   )

get movie's video streams count. Returns: number of video streams. Definition at line 702 of file vetCodec_MOV.cpp. References file. Referenced by getAudioFrameIndex(), getVideoCompressor(), getVideoDepth(), getVideoFrameIndex(), getVideoFrameRate(), getVideoStreamLength(), and setFrameIndex().

long vetCodec_MOV::getVideoStreamLength (  int  stream = -1  )  [virtual]

get movie's video frame count. Parameters: [in]  stream  select stream index. default is -1: current active stream. Returns: number of frames in the stream. Implements vetCodec. Definition at line 750 of file vetCodec_MOV.cpp. References file, getVideoStreamCount(), hasAudio(), hasVideo(), myParams, and vetCodec_MOVParameters::stream.

unsigned int vetCodec_MOV::getWidth (   )  const [inline, virtual]

read current image's width. Returns: Width in pixel. Implements vetInput. Definition at line 396 of file vetCodec_MOV.h. References width.

VETRESULT vetCodec_MOV::goToEnd (   )

Move frame index to end (last frame). Returns: VETRET_OK if everything is fine, VETRET_ILLEGAL_USE is stream hasn't been loaded. Definition at line 510 of file vetCodec_MOV.cpp. References file, and VETRET_ILLEGAL_USE.

VETRESULT vetCodec_MOV::goToStart (   )

Move frame index to start (first frame). Returns: VETRET_OK if everything is fine, VETRET_ILLEGAL_USE is stream hasn't been loaded. Definition at line 496 of file vetCodec_MOV.cpp. References file, and VETRET_ILLEGAL_USE.

bool vetCodec_MOV::hasAudio (   )

get movie's audio streams count. Returns: number of audio streams. Definition at line 686 of file vetCodec_MOV.cpp. References file. Referenced by getAudioChannels(), getAudioFrameIndex(), getAudioSampleRate(), getAudioStreamLength(), and getVideoStreamLength().

bool vetCodec_MOV::hasVideo (   )

check if loaded movie has a video stream. Returns: true if there is at least one video stream, false else. Definition at line 670 of file vetCodec_MOV.cpp. References file. Referenced by getAudioCompressor(), getVideoCompressor(), getVideoDepth(), getVideoFrameIndex(), getVideoFrameRate(), and getVideoStreamLength().

VETRESULT vetCodec_MOV::importFrom (  vetFrameT< unsigned char > &  img  )  [virtual]

Encode given image to stream, increments frame index. Parameters: [in]  img  VETLib Cache Frame to be encoded. Returns: VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else. Note: Input operator (<<) call directly this function. See also: operator << (vetFrameT&) Implements vetCodec. Definition at line 319 of file vetCodec_MOV.cpp. References DEBUGMSG, and VETRET_NOT_IMPLEMENTED.

VETRESULT vetCodec_MOV::importFrom (  vetFrameRGB24 &  img  )  [virtual]

Encode given image to stream, increments frame index. Parameters: [in]  img  VETLib Cache Frame to be encoded. Returns: VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else. Note: Input operator (<<) call directly this function. See also: operator << (vetFrameRGB24&) Implements vetCodec. Definition at line 274 of file vetCodec_MOV.cpp. References buff, vetFrameRGB24::data, DEBUGMSG, file, vetCodec_MOVParameters::frameIndex, vetFrame::height, lenghtFrames, myParams, VETRET_ILLEGAL_USE, VETRET_INTERNAL_ERR, VETRET_OK, and vetFrame::width.

VETRESULT vetCodec_MOV::importFrom (  vetFrameYUV420 &  img  )  [virtual]

Encode given image to stream, increments frame index. Parameters: [in]  img  VETLib Cache Frame to be encoded. Returns: VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else. Note: Input operator (<<) call directly this function. See also: operator << (vetFrameYUV420&) Implements vetCodec. Definition at line 252 of file vetCodec_MOV.cpp. References DEBUGMSG, file, VETRET_ILLEGAL_USE, and VETRET_NOT_IMPLEMENTED.

bool vetCodec_MOV::isDecodingAvailable (   )  [inline, virtual]

Check ability to decode data. Returns: true is class is able to decode video data, flase else. Implements vetCodec. Definition at line 690 of file vetCodec_MOV.h.

bool vetCodec_MOV::isEncodingAvailable (   )  [inline, virtual]

Input operator, import standard VETLib frame formats, current implementation calls directly importFrom() method.Ouput operator, export to standard VETLib frame formats, current implementation calls directly extractTo() method and if framerate isn't zero waits untill clock is syncronized, if elaboration time is greater than sleeptime, no delay is applied. Parameters: [out]  img  VETLib Cache Frame to store data. Returns: Address of current instance. See also: importFrom(vetFrameYUV420&) vetsleep() setElaborationStart() getElaborationTime() Implements vetCodec. Definition at line 689 of file vetCodec_MOV.h.

VETRESULT vetCodec_MOV::load (  char *  filename, int  stream = 0 )  [virtual]

Load a BMP format image into current buffer (vetFrameRGB). Parameters: [in]  filename  a valid MPEG1-2 movie filename [in]  stream  video stream to load (default is first: 0) Returns: VETRET_ILLEGAL_USE if file is not correctly loaded, VETRET_OK else. Implements vetCodec. Definition at line 396 of file vetCodec_MOV.cpp. References DEBUGMSG, load(), myParams, vetCodec_MOVParameters::setFileName(), and vetCodec_MOVParameters::setStream().

VETRESULT vetCodec_MOV::load (   )

Load movie from current filename, use SetFileName() or load(char*, int). Returns: VETRET_ILLEGAL_USE if file is not correctly loaded, VETRET_OK else. Definition at line 335 of file vetCodec_MOV.cpp. References buff, file, vetCodec_MOVParameters::fileName, vetCodec_MOVParameters::frameIndex, height, INFO, lenghtFrames, myParams, vetCodec_MOVParameters::stream, streamEOF, VETRET_ILLEGAL_USE, VETRET_OK, and width. Referenced by load(), and vetCodec_MOV().

VETRESULT vetCodec_MOV::newVideo (  char *  filename, unsigned int  w, unsigned int  h, float  frame_rate, int  quality = 80 )

Load a BMP format image into current buffer (vetFrameRGB). Parameters: [in]  filename  a valid MPEG1-2 movie filename [in]  w  movie's width [in]  h  movie's height [in]  frame_rate  movie's fps [in]  quality  jpeg compression quality value [10, 100], default 80; Returns: VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else. See also: save() Definition at line 421 of file vetCodec_MOV.cpp. References buff, file, height, outFrameRate, reset(), streamEOF, VETRET_INTERNAL_ERR, VETRET_OK, and width.

VETRESULT vetCodec_MOV::reset (   )  [virtual]

Reset filename and movie related settings. Returns: VETRET_OK Implements vetCodec. Definition at line 68 of file vetCodec_MOV.cpp. References buff, file, height, INFO, lenghtFrames, myParams, outFrameRate, vetCodec_MOVParameters::reset(), vetObject::setDescription(), setName(), vetObject::setVersion(), streamEOF, VETRET_OK, and width. Referenced by newVideo(), save(), and vetCodec_MOV().

VETRESULT vetCodec_MOV::save (  char *  filename, int  stream = 0 )  [inline, virtual]

Save current movie to file. Parameters: [in]  filenameoutput  movie filename [in]  stream  video stream to load (default is first: 0) Returns: VETRET_ILLEGAL_USE if file is not correctly loaded, VETRET_OK else. Implements vetCodec. Definition at line 258 of file vetCodec_MOV.h. References VETRET_NOT_IMPLEMENTED.

VETRESULT vetCodec_MOV::save (   )

Save new movie to file, must be called at the end of writing, use newVideo(..) to create an empty video. Returns: VETRET_ILLEGAL_USE if file is not correctly loaded, VETRET_OK else. See also: newVideo(char*, unsigned int, unsigned int, float, int) Definition at line 471 of file vetCodec_MOV.cpp. References file, INFO, reset(), VETRET_ILLEGAL_USE, and VETRET_OK.

VETRESULT vetCodec_MOV::setCopyRight (  char *  string  )

set movie's copyright. Parameters: [in]  string  pointer to a NULL terminated string Returns: VETRET_OK if everything is fine, VETRET_ILLEGAL_USE if movie hasn't been loaded. Definition at line 851 of file vetCodec_MOV.cpp. References file, VETRET_ILLEGAL_USE, and VETRET_OK.

VETRESULT vetCodec_MOV::setFrameIndex (  long  index, int  stream = -1 )

Seek to point in stream (position in the video timeline). Parameters: [in]  index  position to set, number of frame offset [0, framesCount[ [in]  stream  select stream index. default is -1: current active stream. Returns: VETRET_OK if everything is fine, VETRET_PARAM_ERR if index or stream are not valid, VETRET_ILLEGAL_USE if stream hasn't been loaded. Definition at line 569 of file vetCodec_MOV.cpp. References file, vetCodec_MOVParameters::frameIndex, getVideoStreamCount(), myParams, vetCodec_MOVParameters::stream, VETRET_ILLEGAL_USE, and VETRET_PARAM_ERR.

VETRESULT vetCodec_MOV::setHeight (  unsigned int  value  )  [inline, virtual]

Set current canvas' height. Returns: height in pixel. Implements vetOutput. Definition at line 374 of file vetCodec_MOV.h. References height, and VETRET_OK.

VETRESULT vetCodec_MOV::setInfo (  char *  string  )

set movie's informations. Parameters: [in]  string  pointer to a NULL terminated string Returns: VETRET_OK if everything is fine, VETRET_ILLEGAL_USE if movie hasn't been loaded. Definition at line 833 of file vetCodec_MOV.cpp. References file, VETRET_ILLEGAL_USE, and VETRET_OK.

VETRESULT vetCodec_MOV::setName (  char *  string  )

set movie's name. Parameters: [in]  string  pointer to a NULL terminated string Returns: VETRET_OK if everything is fine, VETRET_ILLEGAL_USE if movie hasn't been loaded. Definition at line 815 of file vetCodec_MOV.cpp. References file, VETRET_ILLEGAL_USE, and VETRET_OK. Referenced by reset().

VETRESULT vetCodec_MOV::setParameters (  vetCodec_MOVParameters *  initParams  )

Set parameters for (de)coding. Parameters: [in]  initParams  Instance of vetCodec_MOVParameters or NULL, NULL argument make function to create a new instance with default parameters. Returns: VETRET_OK Definition at line 128 of file vetCodec_MOV.cpp. References myParams, and VETRET_OK. Referenced by setFilterParameters(), and vetCodec_MOV().

VETRESULT vetCodec_MOV::setVideoFrameRate (  float  fps  )

Parameters: [in]  fps  Returns: VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

VETRESULT vetCodec_MOV::setWidth (  unsigned int  value  )  [inline, virtual]

Set current canvas' width. Returns: width in pixel. Implements vetOutput. Definition at line 385 of file vetCodec_MOV.h. References VETRET_OK, and width.

---

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

• vetCodec_MOV.h
• vetCodec_MOV.cpp

---