vetCodec_BMP Class Reference

Inheritance diagram for vetCodec_BMP:


Public Types
enum	FileFormat
enum	FileFormat
Public Member Functions
	vetCodec_BMP (vetCodec_BMPParameters *initParams=NULL)
	Default constructor, initializa parameters and superclasses.
	vetCodec_BMP (vetFrameRGB96 &img)
	Copy constructor from vetFrameCache image, call superclass vetFrameRGB copy constructor.
	vetCodec_BMP (vetFrameRGB24 &img)
	Copy constructor from vetFrameRGB image, call superclass vetFrameRGB copy constructor.
	vetCodec_BMP (unsigned int x, unsigned int y)
	Creates a new frame from given dimensions, call superclass vetFrameRGB constructor.
	vetCodec_BMP (const char *filename, FileFormat format=vetCodec_BMP::FORMAT_BMP_ANY)
	Creates a new frame from given dimensions, call superclass vetFrameRGB constructor.
int	save ()
	Save current buffered image to current filename, first setup current filename and format then call this function.
int	save (const char *filename, FileFormat format=vetCodec_BMP::FORMAT_BMP_24)
	Save current buffered image to given filename and format.
int	load ()
	Load a BMP format image into current buffer (vetFrameRGB), first setup current filename and format then call this function.
int	load (const char *filename, FileFormat format=vetCodec_BMP::FORMAT_BMP_24)
	Load a BMP format image into current buffer (vetFrameRGB).
bool	EoF ()
	Get the state of current data source.
int	setParameters (vetCodec_BMPParameters *initParams)
	Set parameters for (de)coding.
vetCodec_BMPParameters &	getParameters ()
	Get parameters for (de)coding.
void	setFileNameProgression (bool value)
	Enable or disable filename progression, for example: basefile name is "output", index is 13 so filename is output13.bmp, if filename progression is enabled, when an operation is done onto file, idex is incremented (output14.bmp).
void	setAutoOutputEnabled (bool value=true)
	Enable or disable auto input feature,.
void	setAutoInputEnabled (bool value=true)
void	setDoBuffering (bool value=true)
void	setFileName (const char *filename)
void	setFileFormat (FileFormat format=vetCodec_BMP::FORMAT_BMP_24)
	Set current BMP format.
int	getFileNameIndex ()
	Read current file name index, used in file name progression routines.
bool	isFileNameProgressionEnabled ()
bool	isAutoInputEnabled ()
bool	isAutoOutputEnabled ()
bool	isBufferingEnabled ()
void	getFileName (char *filename)
	Read base filename, if progression is enabled it's the base fixed name.
void	getFileNameCurrent (char *filename)
	Read current filename, if progression is enabled it's the base fixed name + current index + bmp extension.
FileFormat	getFileFormat (void)
	Read current bitmap encoding/decoding format.
int	reset ()
	Reset filename related setup.
int	setHeight (unsigned int value)
	read current image's width.read current image's height.Set current canvas' height.
int	setWidth (unsigned int value)
	Set current canvas' width.
int	getAudioStreamCount ()
int	getVideoStreamCount ()
bool	hasAudio ()
bool	hasVideo ()
long	getVideoStreamLength (int stream=-1)
	Get movie's video stream frame count.
long	getAudioStreamLength (int stream=-1)
	Get movie's video stream sample count.
VETRESULT	extractTo (vetFrameYUV420 &img)
	Load bmp data into image parameter, if AutoInput is enabled try to load next filename, else just copy current data to img.
VETRESULT	extractTo (vetFrameRGB24 &img)
	Load bmp data into image parameter, if AutoInput is enabled try to load next filename, else just copy current data to img.
VETRESULT	extractTo (vetFrameT< unsigned char > &img)
	Load bmp data into image parameter, if AutoInput is enabled try to load next filename, else just copy current data to img.
VETRESULT	importFrom (vetFrameYUV420 &img)
	Load given image into memory, if AutoOutput is enabled image data will be saved as a BMP format file.
VETRESULT	importFrom (vetFrameRGB24 &img)
	Load given image into memory, if AutoOutput is enabled image data will be saved as a BMP format file.
VETRESULT	importFrom (vetFrameT< unsigned char > &img)
	Load given image into memory, if AutoOutput is enabled image data will be saved as a BMP format file.
void	operator<< (vetFrameYUV420 &img)
	Input operator, import standard VETLib frame formats, current implementation calls directly importFrom() method.
void	operator<< (vetFrameRGB24 &img)
	Input operator, import standard VETLib frame formats, current implementation calls directly importFrom() method.
void	operator<< (vetFrameT< unsigned char > &img)
	Input operator, import standard VETLib frame formats, current implementation calls directly importFrom() method.
vetInput &	operator>> (vetFrameYUV420 &img)
	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.
vetInput &	operator>> (vetFrameRGB24 &img)
	Ouput operator, export to standard VETLib frame formats, export image data, it's like a copy constructor by parameter side.
vetInput &	operator>> (vetFrameT< unsigned char > &img)
	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	isEncodingAvailable ()
	Check ability to encode data.
bool	isDecodingAvailable ()
	Check ability to decode data.
	vetCodec_BMP (vetCodec_BMPParameters *initParams=NULL)
	Default constructor, initializa parameters and superclasses.
	vetCodec_BMP (vetFrameRGB24 &img)
	Copy constructor from vetFrameYUV420 image, call superclass vetFrameRGB copy constructor.
	vetCodec_BMP (vetFrameRGB96 &img)
	Copy constructor from vetFrameRGB image, call superclass vetFrameRGB copy constructor.
	vetCodec_BMP (unsigned int x, unsigned int y)
	Creates a new frame from given dimensions, call superclass vetFrameRGB constructor.
	vetCodec_BMP (char *filename, FileFormat format=vetCodec_BMP::FORMAT_BMP_ANY)
	Creates a new frame from given dimensions, call superclass vetFrameRGB constructor.
VETRESULT	save ()
	Save current buffered image to current filename, first setup current filename and format then call this function.
VETRESULT	save (char *filename, int format=vetCodec_BMP::FORMAT_BMP_24)
	Save current buffered image to given filename and format.
VETRESULT	load ()
	Load a BMP format image into current buffer (vetFrameRGB), first setup current filename and format then call this function.
VETRESULT	load (char *filename, int format=vetCodec_BMP::FORMAT_BMP_24)
	Load a BMP format image into current buffer (vetFrameRGB).
VETRESULT	setParameters (vetCodec_BMPParameters *initParams)
	Set parameters for (de)coding.
vetCodec_BMPParameters &	getParameters ()
	Get parameters for (de)coding.
VETRESULT	setFilterParameters (vetFilterParameters *initParams)
vetFilterParameters *	getFilterParameters ()
bool	EoF ()
	Get the state of current data source.
void	setFileNameProgression (bool value)
	Enable or disable filename progression, for example: basefile name is "output", index is 13 so filename is output13.bmp, if filename progression is enabled, when an operation is done onto file, idex is incremented (output14.bmp).
void	setAutoOutputEnabled (bool value=true)
	Enable or disable auto input feature,.
void	setAutoInputEnabled (bool value=true)
void	setDoBuffering (bool value=true)
void	setFileName (const char *filename)
void	setFileFormat (FileFormat format=vetCodec_BMP::FORMAT_BMP_24)
	Set current BMP format.
int	getFileNameIndex ()
	Read current file name index, used in file name progression routines.
bool	isFileNameProgressionEnabled ()
bool	isAutoInputEnabled ()
bool	isAutoOutputEnabled ()
bool	isBufferingEnabled ()
void	getFileName (char *filename)
	Read base filename, if progression is enabled it's the base fixed name.
void	getFileNameCurrent (char *filename)
	Read current filename, if progression is enabled it's the base fixed name + current index + bmp extension.
FileFormat	getFileFormat (void)
	Read current bitmap encoding/decoding format.
VETRESULT	reset ()
	Reset filename related setup.
VETRESULT	setHeight (unsigned int value)
	read current image's width.read current image's height.Set current canvas' height.
VETRESULT	setWidth (unsigned int value)
	Set current canvas' width.
int	getAudioStreamCount ()
int	getVideoStreamCount ()
bool	hasAudio ()
bool	hasVideo ()
long	getVideoStreamLength (int stream=-1)
	Get movie's video stream frame count.
long	getAudioStreamLength (int stream=-1)
	Get movie's video stream sample count.
VETRESULT	extractTo (vetFrameYUV420 &img)
	Load bmp data into image parameter, if AutoInput is enabled try to load next filename, else just copy current data to img.
VETRESULT	extractTo (vetFrameRGB24 &img)
	Load bmp data into image parameter, if AutoInput is enabled try to load next filename, else just copy current data to img.
VETRESULT	extractTo (vetFrameT< unsigned char > &img)
	Load bmp data into image parameter, if AutoInput is enabled try to load next filename, else just copy current data to img.
VETRESULT	importFrom (vetFrameYUV420 &img)
	Load given image into memory, if AutoOutput is enabled image data will be saved as a BMP format file.
VETRESULT	importFrom (vetFrameRGB24 &img)
	Load given image into memory, if AutoOutput is enabled image data will be saved as a BMP format file.
VETRESULT	importFrom (vetFrameT< unsigned char > &img)
	Load given image into memory, if AutoOutput is enabled image data will be saved as a BMP format file.
void	operator<< (vetFrameYUV420 &img)
	Input operator, import standard VETLib frame formats, current implementation calls directly importFrom() method.
void	operator<< (vetFrameRGB24 &img)
	Input operator, import standard VETLib frame formats, current implementation calls directly importFrom() method.
void	operator<< (vetFrameT< unsigned char > &img)
	Input operator, import standard VETLib frame formats, current implementation calls directly importFrom() method.
vetInput &	operator>> (vetFrameYUV420 &img)
	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.
vetInput &	operator>> (vetFrameRGB24 &img)
	Ouput operator, export to standard VETLib frame formats, export image data, it's like a copy constructor by parameter side.
vetInput &	operator>> (vetFrameT< unsigned char > &img)
	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	isEncodingAvailable ()
	Check ability to encode data.
bool	isDecodingAvailable ()
	Check ability to decode data.
Static Public Member Functions
static VETRESULT	save (vetFrameRGB24 &source, const char *filename, FileFormat format)
	Save given image to a BMP file.
static VETRESULT	save (vetFrameYUV420 &source, const char *filename, FileFormat format)
	Save given image to a BMP file.
static VETRESULT	save (vetFrameT< unsigned char > &source, const char *filename, FileFormat format)
	Save given image to a BMP file.
static VETRESULT	save (vetFrameRGB96 &source, const char *filename, FileFormat format)
	Save given image to a BMP file.
static VETRESULT	load (vetFrameRGB24 &source, const char *filename, FileFormat format)
	Load a BMP format image into given image.
static VETRESULT	load (vetFrameYUV420 &source, const char *filename, FileFormat format)
	Load a BMP format image into given image.
static VETRESULT	load (vetFrameT< unsigned char > &source, const char *filename, FileFormat format)
	Load a BMP format image into given image.
static VETRESULT	load (vetFrameRGB96 &source, const char *filename, FileFormat format)
	Load a BMP format image into given image.
static VETRESULT	save (vetFrameYUV420 &source, char *filename, FileFormat format)
	Save given image to a BMP file.
static VETRESULT	save (vetFrameRGB24 &source, char *filename, FileFormat format)
	Save given image to a BMP file.
static VETRESULT	save (vetFrameRGB96 &source, char *filename, FileFormat format)
	Save given image to a BMP file.
static VETRESULT	save (vetFrameT< unsigned char > &source, char *filename, FileFormat format)
	Save given image to a BMP file.
static VETRESULT	load (vetFrameYUV420 &source, char *filename, FileFormat format)
	Load a BMP format image into given image.
static VETRESULT	load (vetFrameRGB24 &source, char *filename, FileFormat format)
	Load a BMP format image into given image.
static VETRESULT	load (vetFrameRGB96 &source, char *filename, FileFormat format)
	Load a BMP format image into given image.
static VETRESULT	load (vetFrameT< unsigned char > &source, char *filename, FileFormat format)
	Load a BMP format image into given image.
Protected Member Functions
void	doFileNameCurrent ()
Protected Attributes
vetCodec_BMPParameters *	myParams
char	fileNameIndexBuffer [16]
char	fileNameBuffer [80]
vetCodec_BMPParameters *	myParams

Detailed Description

Definition at line 63 of file vetCodec_BMP.h.

Constructor & Destructor Documentation

vetCodec_BMP::vetCodec_BMP ( vetFrameRGB96 & img ) [inline]

Copy constructor from vetFrameCache image, call superclass vetFrameRGB copy constructor.

Parameters:

[in] img source VETLib Cache Frame.

Definition at line 97 of file vetCodec_BMP.h.
References reset().

vetCodec_BMP::vetCodec_BMP ( vetFrameRGB24 & img ) [inline]

Copy constructor from vetFrameRGB image, call superclass vetFrameRGB copy constructor.

Parameters:

[in] img source Color VETLib Frame.

Definition at line 105 of file vetCodec_BMP.h.
References reset().

vetCodec_BMP::vetCodec_BMP ( unsigned int x,

unsigned int y

) [inline]

Creates a new frame from given dimensions, call superclass vetFrameRGB constructor.

Parameters:

[in] x width of the new frame.

[in] y height of the new frame.

Definition at line 114 of file vetCodec_BMP.h.
References reset().

vetCodec_BMP::vetCodec_BMP ( const char * filename,

FileFormat format = vetCodec_BMP::FORMAT_BMP_ANY

)

Creates a new frame from given dimensions, call superclass vetFrameRGB constructor.

Parameters:

[in] filename Input BMP filename.

[in] format BMP Encoding Format, default auto-selection.

Definition at line 30 of file vetCodec_BMP.cpp.
References DEBUGMSG, vetCodec_BMPParameters::fileFormat, vetCodec_BMPParameters::fileNameBase, load(), myParams, reset(), and setParameters().

vetCodec_BMP::vetCodec_BMP ( vetFrameRGB24 & img ) [inline]

Copy constructor from vetFrameYUV420 image, call superclass vetFrameRGB copy constructor.

Parameters:

[in] img source VETLib Cache Frame.

Definition at line 94 of file vetCodec_BMP2.h.
References vetFrameRGB96::operator<<(), and reset().

vetCodec_BMP::vetCodec_BMP ( vetFrameRGB96 & img ) [inline]

Copy constructor from vetFrameRGB image, call superclass vetFrameRGB copy constructor.

Parameters:

[in] img source Color VETLib Frame.

Definition at line 102 of file vetCodec_BMP2.h.
References reset().

vetCodec_BMP::vetCodec_BMP ( char * filename,

FileFormat format = vetCodec_BMP::FORMAT_BMP_ANY

)

Creates a new frame from given dimensions, call superclass vetFrameRGB constructor.

Parameters:

[in] filename Input BMP filename.

[in] format BMP Encoding Format, default auto-selection.

Definition at line 34 of file vetCodec_BMP2.cpp.
References DEBUGMSG, vetCodec_BMPParameters::fileFormat, vetCodec_BMPParameters::fileNameBase, load(), myParams, reset(), and setParameters().

Member Function Documentation

bool vetCodec_BMP::EoF ( ) [virtual]

Get the state of current data source.

Returns:
true is there are no more frames to load, false else.

Implements vetCodec.

bool vetCodec_BMP::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 90 of file vetCodec_BMP.cpp.
References vetFrameRGB96::data.

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

Load bmp data into image parameter, if AutoInput is enabled try to load next filename, else just copy current data to img.

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&)
AutoInput

Implements vetCodec.

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

Load bmp data into image parameter, if AutoInput is enabled try to load next filename, else just copy current data to img.

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&)
AutoInput

Implements vetCodec.
Definition at line 132 of file vetCodec_BMP.cpp.
References vetCodec_BMPParameters::autoInput, vetCodec_BMPParameters::autoOuput, DEBUGMSG, vetCodec_BMPParameters::doBuffering, doFileNameCurrent(), vetCodec_BMPParameters::fileFormat, fileNameBuffer, vetCodec_BMPParameters::fileNameIndex, vetCodec_BMPParameters::fileNameProgression, load(), myParams, vetFrameRGB96::operator>>(), and VETRET_OK.

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

Load bmp data into image parameter, if AutoInput is enabled try to load next filename, else just copy current data to img.

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&)
AutoInput

Implements vetCodec.
Definition at line 97 of file vetCodec_BMP.cpp.
References vetCodec_BMPParameters::autoInput, vetCodec_BMPParameters::autoOuput, DEBUGMSG, vetCodec_BMPParameters::doBuffering, doFileNameCurrent(), vetCodec_BMPParameters::fileFormat, fileNameBuffer, vetCodec_BMPParameters::fileNameIndex, vetCodec_BMPParameters::fileNameProgression, load(), myParams, vetFrameRGB96::operator>>(), and VETRET_OK.

long vetCodec_BMP::getAudioStreamLength ( int stream = -1 ) [inline, virtual]

Get movie's video stream sample count.

Parameters:

[in] stream select stream, default is current stream.

Returns:
number of samples in selected video stream.

Implements vetCodec.
Definition at line 411 of file vetCodec_BMP2.h.

FileFormat vetCodec_BMP::getFileFormat ( void )

Read current bitmap encoding/decoding format.

Returns:
Current I/O BMP format.

See also:
FileFormat
fileFormat

vetCodec_BMP::FileFormat vetCodec_BMP::getFileFormat ( void )

Read current bitmap encoding/decoding format.

Returns:
Current I/O BMP format.

See also:
FileFormat
fileFormat

Definition at line 675 of file vetCodec_BMP.cpp.
References vetCodec_BMPParameters::fileFormat, and myParams.

void vetCodec_BMP::getFileName ( char * filename )

Read base filename, if progression is enabled it's the base fixed name.

Parameters:

[in] @return VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

void vetCodec_BMP::getFileNameCurrent ( char * filename )

Read current filename, if progression is enabled it's the base fixed name + current index + bmp extension.

Parameters:

[out] Char Array to store current filename [Max size 64 chars]

See also:
fileNameBase

int vetCodec_BMP::getFileNameIndex ( )

Read current file name index, used in file name progression routines.

Returns:
VETRET_OK if everything is fine, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

Definition at line 612 of file vetCodec_BMP.cpp.
References vetCodec_BMPParameters::fileNameIndex, and myParams.

vetCodec_BMPParameters& vetCodec_BMP::getParameters ( ) [inline]

Get parameters for (de)coding.

Returns:
pointer to vetCodec_MOVParameters class.

Definition at line 181 of file vetCodec_BMP2.h.
References myParams.

long vetCodec_BMP::getVideoStreamLength ( int stream = -1 ) [inline, virtual]

Get movie's video stream frame count.

Parameters:

[in] stream select stream, default is current stream.

Returns:
number of frames in selected video stream.

Implements vetCodec.
Definition at line 409 of file vetCodec_BMP2.h.

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

Load given image into memory, if AutoOutput is enabled image data will be saved as a BMP format file.

Parameters:

[in] img Greyscale VETLib Frame to be processed (encoded for example)

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.

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

Load given image into memory, if AutoOutput is enabled image data will be saved as a BMP format file.

Parameters:

[in] img VETLib Cache24 Frame to be processed (encoded for example)

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 211 of file vetCodec_BMP.cpp.
References vetCodec_BMPParameters::autoOuput, DEBUGMSG, vetCodec_BMPParameters::doBuffering, doFileNameCurrent(), vetCodec_BMPParameters::fileFormat, fileNameBuffer, vetCodec_BMPParameters::fileNameIndex, vetCodec_BMPParameters::fileNameProgression, myParams, vetFrameRGB96::operator<<(), save(), and VETRET_OK.

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

Load given image into memory, if AutoOutput is enabled image data will be saved as a BMP format file.

Parameters:

[in] img VETLib Cache Frame to be processed (encoded for example)

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 177 of file vetCodec_BMP.cpp.
References vetCodec_BMPParameters::autoOuput, DEBUGMSG, vetCodec_BMPParameters::doBuffering, doFileNameCurrent(), vetCodec_BMPParameters::fileFormat, fileNameBuffer, vetCodec_BMPParameters::fileNameIndex, vetCodec_BMPParameters::fileNameProgression, myParams, vetFrameRGB96::operator<<(), save(), and VETRET_OK.

bool vetCodec_BMP::isAutoInputEnabled ( )

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

Definition at line 633 of file vetCodec_BMP.cpp.
References vetCodec_BMPParameters::autoInput, and myParams.

bool vetCodec_BMP::isAutoOutputEnabled ( )

Parameters:

[in] @return VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

Definition at line 647 of file vetCodec_BMP.cpp.
References vetCodec_BMPParameters::autoOuput, and myParams.

bool vetCodec_BMP::isBufferingEnabled ( )

Parameters:

[in] @return VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

Definition at line 662 of file vetCodec_BMP.cpp.
References vetCodec_BMPParameters::doBuffering, and myParams.

bool vetCodec_BMP::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 643 of file vetCodec_BMP2.h.

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

Check ability to encode data.

Returns:
true is class is able to encode video data, flase else.

Implements vetCodec.
Definition at line 642 of file vetCodec_BMP2.h.

bool vetCodec_BMP::isFileNameProgressionEnabled ( )

Returns:
true if filename progression is enabled.

See also:
fileNameProgression

bool vetCodec_BMP::isFileNameProgressionEnabled ( )

Returns:
true if filename progression is enabled.

See also:
fileNameProgression

Definition at line 621 of file vetCodec_BMP.cpp.
References vetCodec_BMPParameters::fileNameProgression, and myParams.

VETRESULT vetCodec_BMP::load ( vetFrameT< unsigned char > & source,

char * filename,

FileFormat format

) [static]

Load a BMP format image into given image.

Parameters:

[out] source GreyScale VETLib Frame to store data.

[in] filename Input BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 547 of file vetCodec_BMP2.cpp.
References DEBUGMSG, vetFrameT< T >::getHeight(), vetFrameT< T >::getWidth(), and VETRET_PARAM_ERR.

VETRESULT vetCodec_BMP::load ( vetFrameRGB96 & source,

char * filename,

FileFormat format

) [static]

Load a BMP format image into given image.

Parameters:

[out] source Color VETLib Frame to store data.

[in] filename Input BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 455 of file vetCodec_BMP2.cpp.
References vetFrameRGB96::data, DEBUGMSG, MicrosoftMonoBMP_RT::extract_data(), MicrosoftRCBMP_RT::extract_data(), MicrosoftBMP_RT::extract_data(), vetFrame::height, MicrosoftMonoBMP_RT::ImageHeight, MicrosoftRCBMP_RT::ImageHeight, MicrosoftBMP_RT::ImageHeight, MicrosoftMonoBMP_RT::ImageWidth, MicrosoftRCBMP_RT::ImageWidth, MicrosoftBMP_RT::ImageWidth, MicrosoftMonoBMP_RT::read(), MicrosoftRCBMP_RT::read(), MicrosoftBMP_RT::read(), vetFrameRGB96::reAllocCanvas(), and vetFrame::width.

VETRESULT vetCodec_BMP::load ( vetFrameRGB24 & source,

char * filename,

FileFormat format

) [static]

Load a BMP format image into given image.

Parameters:

[out] source VETLib Cache24 Frame to store data.

[in] filename Input BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 364 of file vetCodec_BMP2.cpp.
References vetFrameRGB24::data, DEBUGMSG, MicrosoftMonoBMP_RT::extract_data(), MicrosoftRCBMP_RT::extract_data(), MicrosoftBMP_RT::extract_data(), vetFrame::height, MicrosoftMonoBMP_RT::ImageHeight, MicrosoftRCBMP_RT::ImageHeight, MicrosoftBMP_RT::ImageHeight, MicrosoftMonoBMP_RT::ImageWidth, MicrosoftRCBMP_RT::ImageWidth, MicrosoftBMP_RT::ImageWidth, MicrosoftMonoBMP_RT::read(), MicrosoftRCBMP_RT::read(), MicrosoftBMP_RT::read(), vetFrameRGB24::reAllocCanvas(), and vetFrame::width.

VETRESULT vetCodec_BMP::load ( vetFrameYUV420 & source,

char * filename,

FileFormat format

) [static]

Load a BMP format image into given image.

Parameters:

[out] source VETLib Cache Frame to store data.

[in] filename Input BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 351 of file vetCodec_BMP2.cpp.
References DEBUGMSG.

VETRESULT vetCodec_BMP::load ( char * filename,

int format = vetCodec_BMP::FORMAT_BMP_24

) [virtual]

Load a BMP format image into current buffer (vetFrameRGB).

Parameters:

[in] filename Input BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Implements vetCodec.
Definition at line 335 of file vetCodec_BMP2.cpp.
References DEBUGMSG, and load().

VETRESULT vetCodec_BMP::load ( vetFrameRGB96 & source,

const char * filename,

FileFormat format

) [static]

Load a BMP format image into given image.

Parameters:

[out] source GreyScale VETLib Frame to store data.

[in] filename Input BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 337 of file vetCodec_BMP.cpp.
References vetFrameRGB96::data, DEBUGMSG, MicrosoftMonoBMP_RT::extract_data(), MicrosoftRCBMP_RT::extract_data(), MicrosoftBMP_RT::extract_data(), MicrosoftMonoBMP_RT::ImageHeight, MicrosoftRCBMP_RT::ImageHeight, MicrosoftBMP_RT::ImageHeight, MicrosoftMonoBMP_RT::ImageWidth, MicrosoftRCBMP_RT::ImageWidth, MicrosoftBMP_RT::ImageWidth, MicrosoftMonoBMP_RT::read(), MicrosoftRCBMP_RT::read(), MicrosoftBMP_RT::read(), vetFrameRGB96::reAllocCanvas(), and VETRET_OK.

static VETRESULT vetCodec_BMP::load ( vetFrameT< unsigned char > & source,

const char * filename,

FileFormat format

) [static]

Load a BMP format image into given image.

Parameters:

[out] source Color VETLib Frame to store data.

[in] filename Input BMP filename.

[in] format BMP Encoding Format.

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_BMP::load ( vetFrameYUV420 & source,

const char * filename,

FileFormat format

) [static]

Load a BMP format image into given image.

Parameters:

[out] source VETLib Cache24 Frame to store data.

[in] filename Input BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 432 of file vetCodec_BMP.cpp.
References DEBUGMSG, and VETRET_OK.

VETRESULT vetCodec_BMP::load ( vetFrameRGB24 & source,

const char * filename,

FileFormat format

) [static]

Load a BMP format image into given image.

Parameters:

[out] source VETLib Cache Frame to store data.

[in] filename Input BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 417 of file vetCodec_BMP.cpp.
References DEBUGMSG, load(), and VETRET_OK.

VETRESULT vetCodec_BMP::load ( const char * filename,

FileFormat format = vetCodec_BMP::FORMAT_BMP_24

)

Load a BMP format image into current buffer (vetFrameRGB).

Parameters:

[in] filename Input BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 321 of file vetCodec_BMP.cpp.
References DEBUGMSG, load(), and VETRET_OK.

VETRESULT vetCodec_BMP::load ( )

Load a BMP format image into current buffer (vetFrameRGB), first setup current filename and format then call this function.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 308 of file vetCodec_BMP.cpp.
References doFileNameCurrent(), vetCodec_BMPParameters::fileFormat, fileNameBuffer, INFO, myParams, and VETRET_OK.
Referenced by extractTo(), load(), and vetCodec_BMP().

void vetCodec_BMP::operator<< ( vetFrameT< unsigned char > & img ) [inline]

Input operator, import standard VETLib frame formats, current implementation calls directly importFrom() method.

Parameters:

[in] img Greyscale VETLib Frame to be processed (encoded for example)

See also:
importFrom(vetFrameT&)

Reimplemented from vetOutput.
Definition at line 518 of file vetCodec_BMP2.h.
References vetOutput::operator<<().

void vetCodec_BMP::operator<< ( vetFrameRGB24 & img ) [inline]

Input operator, import standard VETLib frame formats, current implementation calls directly importFrom() method.

Parameters:

[in] img VETLib Cache24 Frame to be processed (encoded for example)

See also:
importFrom(vetFrameRGB24&)

Reimplemented from vetOutput.
Definition at line 517 of file vetCodec_BMP2.h.
References vetOutput::operator<<().

void vetCodec_BMP::operator<< ( vetFrameYUV420 & img ) [inline]

Input operator, import standard VETLib frame formats, current implementation calls directly importFrom() method.

Parameters:

[in] img VETLib Cache Frame to be processed (encoded for example)

See also:
importFrom(vetFrameYUV420&)

Reimplemented from vetOutput.
Definition at line 516 of file vetCodec_BMP2.h.
References vetOutput::operator<<().

void vetCodec_BMP::operator<< ( vetFrameT< unsigned char > & img ) [inline]

Input operator, import standard VETLib frame formats, current implementation calls directly importFrom() method.

Parameters:

[in] img Greyscale VETLib Frame to be processed (encoded for example)

See also:
importFrom(vetFrameT&)

Reimplemented from vetOutput.
Definition at line 522 of file vetCodec_BMP.h.
References vetOutput::operator<<().

void vetCodec_BMP::operator<< ( vetFrameRGB24 & img ) [inline]

Input operator, import standard VETLib frame formats, current implementation calls directly importFrom() method.

Parameters:

[in] img VETLib Cache24 Frame to be processed (encoded for example)

See also:
importFrom(vetFrameRGB24&)

Reimplemented from vetOutput.
Definition at line 521 of file vetCodec_BMP.h.
References vetOutput::operator<<().

void vetCodec_BMP::operator<< ( vetFrameYUV420 & img ) [inline]

Input operator, import standard VETLib frame formats, current implementation calls directly importFrom() method.

Parameters:

[in] img VETLib Cache Frame to be processed (encoded for example)

See also:
importFrom(vetFrameYUV420&)

Reimplemented from vetOutput.
Definition at line 520 of file vetCodec_BMP.h.
References vetOutput::operator<<().

vetInput& vetCodec_BMP::operator>> ( vetFrameT< unsigned char > & img ) [inline]

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()

Reimplemented from vetInput.
Definition at line 539 of file vetCodec_BMP2.h.
References vetInput::operator>>().

vetInput& vetCodec_BMP::operator>> ( vetFrameRGB24 & img ) [inline]

Ouput operator, export to standard VETLib frame formats, export image data, it's like a copy constructor by parameter side.

Parameters:

[out] img VETLib Cache24 Frame to store data.

Returns:
Address of current instance.

Reimplemented from vetFrameRGB96.
Definition at line 538 of file vetCodec_BMP2.h.
References vetInput::operator>>().

vetInput& vetCodec_BMP::operator>> ( vetFrameYUV420 & img ) [inline]

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()

Reimplemented from vetFrameRGB96.
Definition at line 537 of file vetCodec_BMP2.h.
References vetInput::operator>>().

vetInput& vetCodec_BMP::operator>> ( vetFrameT< unsigned char > & img ) [inline]

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()

Reimplemented from vetInput.
Definition at line 543 of file vetCodec_BMP.h.
References vetInput::operator>>().

vetInput& vetCodec_BMP::operator>> ( vetFrameRGB24 & img ) [inline]

Ouput operator, export to standard VETLib frame formats, export image data, it's like a copy constructor by parameter side.

Parameters:

[out] img VETLib Cache24 Frame to store data.

Returns:
Address of current instance.

Reimplemented from vetFrameRGB96.
Definition at line 542 of file vetCodec_BMP.h.
References vetInput::operator>>().

vetInput& vetCodec_BMP::operator>> ( vetFrameYUV420 & img ) [inline]

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()

Reimplemented from vetFrameRGB96.
Definition at line 541 of file vetCodec_BMP.h.
References vetInput::operator>>().

VETRESULT vetCodec_BMP::reset ( ) [virtual]

Reset filename related setup.

Returns:
VETRET_OK if everything is fine, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Implements vetCodec.

VETRESULT vetCodec_BMP::reset ( ) [virtual]

Reset filename related setup.

Returns:
VETRET_OK if everything is fine, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Implements vetCodec.
Definition at line 61 of file vetCodec_BMP.cpp.
References vetCodec_BMPParameters::fileNameBase, fileNameBuffer, INFO, myParams, vetCodec_BMPParameters::reset(), vetObject::setDescription(), vetObject::setName(), vetObject::setVersion(), and VETRET_OK.
Referenced by vetCodec_BMP().

VETRESULT vetCodec_BMP::save ( vetFrameT< unsigned char > & source,

char * filename,

FileFormat format

) [static]

Save given image to a BMP file.

Parameters:

[in] source Greyscale VETLib Frame to store data.

[in] filename Output BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 733 of file vetCodec_BMP2.cpp.
References vetFrameT< T >::data, DEBUGMSG, vetFrameT< T >::height, VETRET_PARAM_ERR, and vetFrameT< T >::width.

VETRESULT vetCodec_BMP::save ( vetFrameRGB96 & source,

char * filename,

FileFormat format

) [static]

Save given image to a BMP file.

Parameters:

[in] source Color VETLib Frame to store data.

[in] filename Output BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 658 of file vetCodec_BMP2.cpp.
References vetFrameRGB96::data, DEBUGMSG, vetFrame::getHeight(), vetFrame::getWidth(), vetFrame::height, MicrosoftBMP_RT::put_data_grey(), MicrosoftMonoBMP_RT::put_data_grey(), MicrosoftRCBMP_RT::put_data_grey(), MicrosoftRCBMP_RT::set_palette_grey256(), MicrosoftBMP_RT::set_size(), MicrosoftMonoBMP_RT::set_size(), MicrosoftRCBMP_RT::set_size(), VETRET_PARAM_ERR, vetFrame::width, MicrosoftBMP_RT::write(), MicrosoftMonoBMP_RT::write(), and MicrosoftRCBMP_RT::write().

VETRESULT vetCodec_BMP::save ( vetFrameRGB24 & source,

char * filename,

FileFormat format

) [static]

Save given image to a BMP file.

Parameters:

[in] source VETLib Cache24 Frame to store data.

[in] filename Output BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 583 of file vetCodec_BMP2.cpp.
References vetFrameRGB24::data, DEBUGMSG, vetFrame::height, MicrosoftBMP_RT::put_data_grey(), MicrosoftMonoBMP_RT::put_data_grey(), MicrosoftRCBMP_RT::put_data_grey(), MicrosoftRCBMP_RT::set_palette_grey256(), MicrosoftBMP_RT::set_size(), MicrosoftMonoBMP_RT::set_size(), MicrosoftRCBMP_RT::set_size(), VETRET_PARAM_ERR, vetFrame::width, MicrosoftBMP_RT::write(), MicrosoftMonoBMP_RT::write(), and MicrosoftRCBMP_RT::write().

VETRESULT vetCodec_BMP::save ( vetFrameYUV420 & source,

char * filename,

FileFormat format

) [static]

Save given image to a BMP file.

Parameters:

[in] source VETLib Cache Frame to store data.

[in] filename Output BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 565 of file vetCodec_BMP2.cpp.
References vetFrameYUV420::data, DEBUGMSG, vetFrame::height, VETRET_PARAM_ERR, and vetFrame::width.

VETRESULT vetCodec_BMP::save ( char * filename,

int format = vetCodec_BMP::FORMAT_BMP_24

) [virtual]

Save current buffered image to given filename and format.

Parameters:

[in] filename Output BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Implements vetCodec.
Definition at line 310 of file vetCodec_BMP2.cpp.
References DEBUGMSG, and save().

VETRESULT vetCodec_BMP::save ( vetFrameRGB96 & source,

const char * filename,

FileFormat format

) [static]

Save given image to a BMP file.

Parameters:

[in] source VETLib Cache Frame to store data.

[in] filename Output BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 442 of file vetCodec_BMP.cpp.
References vetFrameRGB96::data, DEBUGMSG, vetFrame::height, MicrosoftBMP_RT::put_data(), MicrosoftMonoBMP_RT::put_data(), MicrosoftRCBMP_RT::put_data(), MicrosoftRCBMP_RT::set_palette_grey256(), MicrosoftBMP_RT::set_size(), MicrosoftMonoBMP_RT::set_size(), MicrosoftRCBMP_RT::set_size(), VETRET_OK, VETRET_PARAM_ERR, vetFrame::width, MicrosoftBMP_RT::write(), MicrosoftMonoBMP_RT::write(), and MicrosoftRCBMP_RT::write().

static VETRESULT vetCodec_BMP::save ( vetFrameT< unsigned char > & source,

const char * filename,

FileFormat format

) [static]

Save given image to a BMP file.

Parameters:

[in] source Color VETLib Frame to store data.

[in] filename Output BMP filename.

[in] format BMP Encoding Format.

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_BMP::save ( vetFrameYUV420 & source,

const char * filename,

FileFormat format

) [static]

Save given image to a BMP file.

Parameters:

[in] source VETLib Cache24 Frame to store data.

[in] filename Output BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 533 of file vetCodec_BMP.cpp.
References DEBUGMSG, vetFrame::getHeight(), vetFrame::getWidth(), VETRET_OK, and VETRET_PARAM_ERR.

VETRESULT vetCodec_BMP::save ( vetFrameRGB24 & source,

const char * filename,

FileFormat format

) [static]

Save given image to a BMP file.

Parameters:

[in] source VETLib Cache Frame to store data.

[in] filename Output BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 514 of file vetCodec_BMP.cpp.
References DEBUGMSG, vetFrame::getHeight(), vetFrame::getWidth(), save(), VETRET_OK, and VETRET_PARAM_ERR.

VETRESULT vetCodec_BMP::save ( const char * filename,

FileFormat format = vetCodec_BMP::FORMAT_BMP_24

)

Save current buffered image to given filename and format.

Parameters:

[in] filename Output BMP filename.

[in] format BMP Encoding Format.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 296 of file vetCodec_BMP.cpp.
References DEBUGMSG, save(), and VETRET_OK.

VETRESULT vetCodec_BMP::save ( )

Save current buffered image to current filename, first setup current filename and format then call this function.

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Definition at line 284 of file vetCodec_BMP.cpp.
References doFileNameCurrent(), vetCodec_BMPParameters::fileFormat, fileNameBuffer, INFO, myParams, and VETRET_OK.
Referenced by importFrom(), and save().

void vetCodec_BMP::setAutoInputEnabled ( bool value = true )

Parameters:

[in] @return VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

Definition at line 583 of file vetCodec_BMP.cpp.
References vetCodec_BMPParameters::autoInput, and myParams.

void vetCodec_BMP::setAutoOutputEnabled ( bool value = true )

Enable or disable auto input feature,.

Parameters:

[in] @return VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

void vetCodec_BMP::setDoBuffering ( bool value = true )

Parameters:

[in] @return VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

Definition at line 597 of file vetCodec_BMP.cpp.
References vetCodec_BMPParameters::doBuffering, and myParams.

void vetCodec_BMP::setFileFormat ( FileFormat format = vetCodec_BMP::FORMAT_BMP_24 )

Set current BMP format.

Parameters:

[in] format BMP format enumaration.

See also:
FileFormat

void vetCodec_BMP::setFileFormat ( FileFormat format = vetCodec_BMP::FORMAT_BMP_24 )

Set current BMP format.

Parameters:

[in] format BMP format enumaration.

See also:
FileFormat

Definition at line 599 of file vetCodec_BMP.cpp.
References vetCodec_BMPParameters::fileFormat, and myParams.

void vetCodec_BMP::setFileName ( const char * filename )

Parameters:

[in] @note

See also:

void vetCodec_BMP::setFileName ( const char * filename )

Parameters:

[in] @note

See also:

Definition at line 252 of file vetCodec_BMP.cpp.
References vetCodec_BMPParameters::fileNameBase, fileNameBuffer, and myParams.

void vetCodec_BMP::setFileNameProgression ( bool value )

Enable or disable filename progression, for example: basefile name is "output", index is 13 so filename is output13.bmp, if filename progression is enabled, when an operation is done onto file, idex is incremented (output14.bmp).

Parameters:

[in] value true to enable file name progression.

VETRESULT vetCodec_BMP::setHeight ( unsigned int value ) [inline]

read current image's width.read current image's height.Set current canvas' height.

Returns:
height in pixel.

Reimplemented from vetFrameRGB96.
Definition at line 394 of file vetCodec_BMP2.h.
References VETRET_NOT_IMPLEMENTED.

int vetCodec_BMP::setHeight ( unsigned int value ) [inline]

read current image's width.read current image's height.Set current canvas' height.

Returns:
height in pixel.

Reimplemented from vetFrameRGB96.
Definition at line 394 of file vetCodec_BMP.h.
References VETRET_NOT_IMPLEMENTED.

VETRESULT vetCodec_BMP::setParameters ( vetCodec_BMPParameters * initParams )

Set parameters for (de)coding.

Parameters:

[in] initParams Instance of vetCodec_BMPParameters or NULL, NULL argument make function to create a new instance with default parameters.

Returns:
VETRET_OK

Definition at line 79 of file vetCodec_BMP.cpp.
References myParams, and VETRET_OK.
Referenced by setFilterParameters(), and vetCodec_BMP().

VETRESULT vetCodec_BMP::setWidth ( unsigned int value ) [inline]

Set current canvas' width.

Returns:
width in pixel.

Reimplemented from vetFrameRGB96.
Definition at line 401 of file vetCodec_BMP2.h.
References VETRET_NOT_IMPLEMENTED.

int vetCodec_BMP::setWidth ( unsigned int value ) [inline]

Set current canvas' width.

Returns:
width in pixel.

Reimplemented from vetFrameRGB96.
Definition at line 401 of file vetCodec_BMP.h.
References VETRET_NOT_IMPLEMENTED.

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

Generated on Tue Jan 24 11:59:23 2006 for VETLib by

1.4.4

vetCodec_BMP Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation