VidReader Class Reference

#include <VidReader.hh>

Inheritance diagram for VidReader:

Collaboration diagram for VidReader:

List of all members.

Public Member Functions
	VidReader (char const *name, VideoArray< coeff > *arrays[], int rawy, int rawx, int colors, int from, int to, int skip=0)
virtual	~VidReader (void)
Static Public Member Functions
static int	framesInFile (const char *fname, int rows, int cols, int colors, int skip)
Protected Member Functions
virtual int	readfmt (void)
Protected Attributes
int	m_ysize
int	m_xsize
int	m_skip

---

Detailed Description

A VID file reader.

Definition at line 21 of file VidReader.hh.

---

Constructor & Destructor Documentation

VidReader::VidReader	(	char const *	name,
		VideoArray< coeff > *	arrays[],
		int	rawy,
		int	rawx,
		int	colors,
		int	from,
		int	to,
		int	skip = 0
	)

Constructor. Only calls the mother class' constructor to initialize the {ImageArray} reference.

Parameters:

name	the file name
arrays	the array of video arrays for the values
rawy	the number of rows
rawx	the number of cols
colors	the number of colors
from	the first frame
to	one greater than the last frame, if equal to `from' then the whole video will be read, if 0, then the video will be read from `from' to the end
skip	the size of the header to skip

virtual VidReader::~VidReader

(

void

)

[inline, virtual]

Destructor - does nothing.

Definition at line 43 of file VidReader.hh.

---

Member Function Documentation

static int VidReader::framesInFile	(	const char *	fname,
		int	rows,
		int	cols,
		int	colors,
		int	skip
	)		[static]

Return the number of frames in a file.

Parameters:

fname	the file name.
rows	the number of rows
cols	the number of columns
colors	the number of colors
skip	the number bytes to skip

Returns:

the number of frames

virtual int VidReader::readfmt

(

void

)

[protected, virtual]

Read the VID file format. This does the actual work of reading and parsing the video file. It gets called by the {read ()} method.

Returns:

0 if successful, -1 on read error, -2 on file format error.

Implements VideoReader.

---

Member Data Documentation

int VidReader::m_skip [protected]

If applicable, a header to skip before reading the contents

Definition at line 66 of file VidReader.hh.

int VidReader::m_xsize [protected]

The assumed number of columns

Definition at line 64 of file VidReader.hh.

int VidReader::m_ysize [protected]

The assumed number of rows

Definition at line 62 of file VidReader.hh.

---

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

• VidReader.hh