Main Page | Class Hierarchy | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages | Examples

vetOutput Class Reference

Abstract class for all data outputs, implementations should encode VETLib data stream to a device (visualization or storage for example), inherited classes must implement data encoding throw importFrom() methods, base input operators (<<) make a direct call to these functions, inherited classes may obviously override current operators behaviour. More...

#include <vetOutput.h>

Inheritance diagram for vetOutput:

vetCodec vetDoctor vetFilter vetNetClient vetNetServer vetOutputVoid vetVision vetWindow32 vetWindowGTK vetWindowQT

Public Types

enum  
 Ignore this, it's a class-type definition, mostly used by VETLib WorkShop, sintax is a bit more complex than usual because of a VC6 BUG, it's the same as: const int vetClassType = VETCLASS_TYPE_OUTPUT;.

Public Member Functions

 vetOutput ()
 Default constructor is protected because this is an abstract class and instance cannot be created directly.
virtual ~vetOutput ()
virtual VETRESULT setHeight (unsigned int value)=0
 Set current canvas' height.
virtual VETRESULT setWidth (unsigned int value)=0
 Set current canvas' width.
virtual VETRESULT importFrom (vetFrameYUV420 &img)=0
 Inherited class must implement this function, processing frames to specific output (device or stream).
virtual VETRESULT importFrom (vetFrameRGB24 &img)=0
 Inherited class must implement this function, processing frames to specific output (device or stream).
virtual VETRESULT importFrom (vetFrameT< unsigned char > &img)=0
 Inherited class must implement this function, processing frames to specific output (device or stream).
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.

Detailed Description

Abstract class for all data outputs, implementations should encode VETLib data stream to a device (visualization or storage for example), inherited classes must implement data encoding throw importFrom() methods, base input operators (<<) make a direct call to these functions, inherited classes may obviously override current operators behaviour.

Version:
1.0.2
Date:
24/12/2005
Author:
Alessandro Polo
VETLib Framework 1.0.2 Copyright (C) Alessandro Polo 2006 http://www.ewgate.net/vetlib

Definition at line 34 of file vetOutput.h.


Member Function Documentation

virtual VETRESULT vetOutput::importFrom vetFrameT< unsigned char > &  img  )  [pure virtual]
 

Inherited class must implement this function, processing frames to specific output (device or stream).

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

Implemented in vetCodec_BMP, vetCodec_BMP, vetCodec_IMG, vetCodec_MOV, vetCodec_MPEG, vetCodec_XVID, vetDigitalFilter, vetFilterColor, vetFilterGeometric, vetFilterNoiseChannel, vetMultiplexer, vetDoctor, vetOutputVoid, vetWindow32, vetWindowGTK, vetWindowQT, vetCodec, vetFilter, vetMotionIlluminationInvariant, and vetMotionLame.

virtual VETRESULT vetOutput::importFrom vetFrameRGB24 img  )  [pure virtual]
 

Inherited class must implement this function, processing frames to specific output (device or stream).

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

Implemented in vetCodec_BMP, vetCodec_BMP, vetCodec_IMG, vetCodec_MOV, vetCodec_MPEG, vetCodec_XVID, vetDigitalFilter, vetFilterColor, vetFilterGeometric, vetFilterNoiseChannel, vetMultiplexer, vetDoctor, vetOutputVoid, vetWindow32, vetWindowGTK, vetWindowQT, vetCodec, vetFilter, vetVision, vetMotionIlluminationInvariant, and vetMotionLame.

virtual VETRESULT vetOutput::importFrom vetFrameYUV420 img  )  [pure virtual]
 

Inherited class must implement this function, processing frames to specific output (device or stream).

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

Implemented in vetCodec_BMP, vetCodec_BMP, vetCodec_IMG, vetCodec_MOV, vetCodec_MPEG, vetCodec_XVID, vetDigitalFilter, vetFilterColor, vetFilterGeometric, vetFilterNoiseChannel, vetMultiplexer, vetDoctor, vetOutputVoid, vetWindow32, vetWindowGTK, vetWindowQT, vetCodec, vetFilter, vetVision, vetMotionIlluminationInvariant, and vetMotionLame.

Referenced by operator<<().

void vetOutput::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 in vetCodec_BMP, vetCodec_BMP, and vetDoctor.

Definition at line 138 of file vetOutput.h.

References importFrom().

void vetOutput::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 in vetCodec_BMP, vetCodec_BMP, and vetDoctor.

Definition at line 127 of file vetOutput.h.

References importFrom().

void vetOutput::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 in vetCodec_BMP, vetCodec_BMP, and vetDoctor.

Definition at line 116 of file vetOutput.h.

References importFrom().

Referenced by vetCodec_BMP::operator<<().

virtual VETRESULT vetOutput::setHeight unsigned int  value  )  [pure virtual]
 

Set current canvas' height.

Returns:
height in pixel.

Implemented in vetCodec_BMP, vetCodec_BMP, vetCodec_IMG, vetCodec_MOV, vetCodec_MPEG, vetCodec_XVID, vetNetClient, vetDoctor, vetOutputVoid, vetWindow32, vetWindowGTK, vetWindowQT, and vetFilter.

virtual VETRESULT vetOutput::setWidth unsigned int  value  )  [pure virtual]
 

Set current canvas' width.

Returns:
width in pixel.

Implemented in vetCodec_BMP, vetCodec_BMP, vetCodec_IMG, vetCodec_MOV, vetCodec_MPEG, vetCodec_XVID, vetNetClient, vetDoctor, vetOutputVoid, vetWindow32, vetWindowGTK, vetWindowQT, and vetFilter.


The documentation for this class was generated from the following file:
Generated on Tue Jan 24 11:59:42 2006 for VETLib by  doxygen 1.4.4