|| ||           || Doxygen's  

---

HxImageSeq Class Reference

Class definition for a sequence of HxImageRep's. More...

#include <HxImageSeq.h>

List of all members.

Public Methods
	HxImageSeq ()
	Constructor. More...
	HxImageSeq (HxString filename, int bufSize=0)
	Construct sequence from given file. More...
	HxImageSeq (const HxImageSeq &rhs)
	Copy constructor. More...
virtual	~HxImageSeq ()
	Destructor. More...
HxImageSeq &	operator= (const HxImageSeq &rhs)
	Assignment operator. More...
int	ident () const
	The identity of the sequence. More...
int	isNull () const
	Indicates wether this is a valid sequence. More...
int	frameWidth () const
	The frame width. More...
int	frameHeight () const
	The frame height. More...
int	frameDepth () const
	The frame depth. More...
int	nrFrames () const
	The number of frames. More...
HxImageRep	getFrame (int nr) const
	Get the specified frame as HxImageRep. More...
void	getRgb2d (int nr, int *pixels, HxString displayMode) const
	Display the specified frame in the given buffer in ARGB format using the given displayMode. More...
void	getRgbPixels2d (int nr, int *pixels, HxString displayMode, int resWidth=-1, int resHeight=-1, HxGeoIntType gi=NEAREST) const
	Display the specified frame in the given buffer in ARGB format using the given displayMode at the given resolution. More...
HxImageSeqIter	begin ()
	An iterator pointing to the first frame. More...
HxImageSeqIter	end ()
	An iterator pointing beyond the last frame. More...
int	writeFile (std::vector< int > frameList, HxString filename, int format)
	Write the frame from the list to the given file in the given format. More...
STD_OSTREAM &	put (STD_OSTREAM &os) const
	Put some information on the given stream. More...
Static Public Methods
void	setUseMDC (int flag)
	Indicate whether the MDC library should be used to decode mpeg files (when it is available :-). More...
Static Public Attributes
const int	MPEG_F = 1
const int	MIR_F = 2
const int	AVI_F = 3
Friends
class	HxImageSeqIter

---

Detailed Description

Class definition for a sequence of HxImageRep's.

Supported types:

• Mpeg video: Both Mpeg 1 and 2 are supported.
• MIR video: A simple uncompressed format. A sequence of images (HxImageRep) are stacked in a MIR file. MIR stands for Motion (Hx)ImageRep.
• AVI video: Standard video for windows format.

We use the file extension to recognize the video format:

• .mir -> MIR format
• .avi -> AVI format
• default -> Mpeg format

---

Constructor & Destructor Documentation

HxImageSeq::HxImageSeq (    )

Constructor. : _pointee(0) { }

HxImageSeq::HxImageSeq (  HxString    filename, int    bufSize = 0 )

Construct sequence from given file. bufSize: the size of the internal buffer. The buffer stores frames converted to HxImageRep's for later references. In the current implementation only contiguous frames are kept. The default is no buffering. : _pointee(0) { #ifndef __GNUC__ int pos = filename.rfind("."); if (pos >=0 ) { HxString ext = filename.substr(pos); for (HxString::iterator i = ext.begin(); i!= ext.end(); i++) *i = toupper(*i); if (ext.compare(".MIR")==0) _pointee = new HxImageSeqMir(filename, bufSize); else { HxImageSeqData* seq; if (_useMDC) seq = new HxImageSeqMDC(filename, bufSize); else seq = new HxImageSeqDXMedia(filename, bufSize); if(seq->valid()) _pointee = seq; else delete seq; } } else { HxEnvironment::instance()->errorStream() << "No extension found in " << filename << STD_ENDL; HxEnvironment::instance()->flush(); } #else HxImageSeqMDC* seq = new HxImageSeqMDC(filename, bufSize); if(seq->valid()) _pointee = seq; else delete seq; #endif }

HxImageSeq::HxImageSeq (  const HxImageSeq &    rhs )

Copy constructor. : _pointee(rhs.pointee()) { }

HxImageSeq::~HxImageSeq (    )  [virtual]

Destructor. { }

---

Member Function Documentation

void HxImageSeq::setUseMDC (  int    flag )  [static]

Indicate whether the MDC library should be used to decode mpeg files (when it is available :-). Default is false. { _useMDC = flag; }

HxImageSeq & HxImageSeq::operator= (  const HxImageSeq &    rhs )

Assignment operator. { _pointee = rhs._pointee; return *this; }

int HxImageSeq::ident (    )  const

The identity of the sequence. { return pointee() ? pointee()->ident() : 0; }

int HxImageSeq::isNull (    )  const

Indicates wether this is a valid sequence. { return !int(_pointee); }

int HxImageSeq::frameWidth (    )  const

The frame width. { return pointee() ? pointee()->frameWidth() : 0; }

int HxImageSeq::frameHeight (    )  const

The frame height. { return pointee() ? pointee()->frameHeight() : 0; }

int HxImageSeq::frameDepth (    )  const

The frame depth. { return pointee() ? pointee()->frameDepth() : 0; }

int HxImageSeq::nrFrames (    )  const

The number of frames. { return pointee() ? pointee()->nrFrames() : 0; }

HxImageRep HxImageSeq::getFrame (  int    nr )  const

Get the specified frame as HxImageRep. { return pointee() ? pointee()->getFrame(nr) : HxImageRep(); }

void HxImageSeq::getRgb2d (  int    nr, int *    pixels, HxString    displayMode )  const

Display the specified frame in the given buffer in ARGB format using the given displayMode. The pixels buffer has to be allocated by the class user and should have sufficient size. { if (!pointee()) return; pointee()->getRgb2d(nr, pixels, displayMode); }

void HxImageSeq::getRgbPixels2d (  int    nr, int *    pixels, HxString    displayMode, int    resWidth = -1, int    resHeight = -1, HxGeoIntType    gi = NEAREST )  const

Display the specified frame in the given buffer in ARGB format using the given displayMode at the given resolution. The pixels buffer has to be allocated by the class user and should have sufficient size. { if (!pointee()) return; pointee()->getRgbPixels2d(nr, pixels, displayMode, resWidth, resHeight, gi); }

HxImageSeqIter HxImageSeq::begin (    )

An iterator pointing to the first frame. { return HxImageSeqIter(this, 0); }

HxImageSeqIter HxImageSeq::end (    )

An iterator pointing beyond the last frame. { return HxImageSeqIter(this, pointee()->nrFrames()); }

int HxImageSeq::writeFile (  std::vector< int >    frameList, HxString    filename, int    format )

Write the frame from the list to the given file in the given format. Currently, only MIR format is implemented. { #ifndef __GNUC__ if (format==MIR_F) { Header_Type* header = new Header_Type; strcpy(header->id,"MIR"); header->width = frameWidth(); header->height = frameHeight(); header->depth = frameDepth(); header->no_of_frames = frameList.size(); FILE *fp = fopen(filename.c_str(),"w+b"); if (!fp) { HxEnvironment::instance()->errorStream() << "Cannot open file for writing:" << filename << STD_ENDL; HxEnvironment::instance()->flush(); return -1; } int* buf = new int[header->width * header->height]; int block_size = header->width * header->height * sizeof(int); fwrite(header,sizeof(Header_Type),1,fp); for (int i=0; i<frameList.size(); i++) { HxImageRep im = pointee()->frame2HxImageRep(frameList[i]); im.getRgbPixels2d(buf,"Direct"); fwrite(buf, block_size, 1, fp); } fclose(fp); delete buf; return 0; } else { HxEnvironment::instance()->errorStream() << "Writefile for this format not implemented yet" << STD_ENDL; HxEnvironment::instance()->flush(); return -1; } #else HxEnvironment::instance()->errorStream() << "No non DX codec" << STD_ENDL; HxEnvironment::instance()->flush(); return -1; // __GNUC__ #endif }

STD_OSTREAM & HxImageSeq::put (  STD_OSTREAM &    os )  const

Put some information on the given stream. { os << "Number of Frames: " << nrFrames() << ", frame sizes : " << frameWidth() << " x " << frameHeight() << STD_ENDL; return os; }

---

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

• HxImageSeq.h
• HxImageSeq.c

---