Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members

Video Template Class Reference

Base class for all Video Devices of the System Video is designed to provide a generic front end to video sources. More...

#include <Video.h>

Inheritance diagram for Video:

List of all members.

Public Methods

Video (const char *dev_name="/dev/video",const char *parm_string = NULL)
virtual ~Video ()
int buffer_count (void) const
Functions to get at data. More...
XVImageRGB<PIXTYPE>& frame (int i) const
Returns the data in frame i. More...
XVImageRGB<PIXTYPE>& current_frame () const
Returns the data in currently active frame. More...
virtual int initiate_acquire (int buffernum) = 0
These are the basic functions to implement to acquire data. More...
virtual int wait_for_completion (int buffernum) = 0
int release_buffer (int buffernum)
int& request_frame_continuous (int framenum)
Continous grab where you just get the next frame down the line. More...
XVImageRGB<PIXTYPE>& next_frame_continuous ()
int request_frame_poll (int framenum)
Poll until a specific frame arives and return the index of the buffer containing it. More...
const XVImageRGB<PIXTYPE>& next_frame_poll (void)
virtual int set_params (char *paramstring) = 0
XVImageRGB<PIXTYPE>* remap (PIXTYPE *mm_buf[],int n_buffers)

Protected Methods

XVImageRGB<PIXTYPE>* init_map (XVSize s, int n_buffers)
virtual int next_buffer ()
int parse_param (char * &paramstring,XVParser &result)
XVImageRGB<PIXTYPE>* frame_addr (int i) const

Protected Attributes

const char* name
XVSize size
XVImageRGB<PIXTYPE>* image_buffers
int n_buffers
int current_buffer
int frame_count
XVCapture_Mode capture_mode
int own_buffers

Detailed Description

template<class PIXTYPE> template class Video

Base class for all Video Devices of the System Video is designed to provide a generic front end to video sources.

It also provide minimal buffer management (See VideoManager for a fully buffered video source). Most devices are expected to look at the passed type of a pixel and make their function correspond to that type. There is a means of passing character arguments to directly set device parameters.

Definition at line 49 of file Video.h.

Member Function Documentation

template<classPIXTYPE>

int Video<PIXTYPE>::next_buffer ( ) [inline, protected, virtual]

Definition at line 75 of file Video.h.

template<classPIXTYPE>

XVImageRGB< PIXTYPE >* Video<PIXTYPE>::frame_addr<PIXTYPE> ( int i ) const [inline, protected]

Definition at line 85 of file Video.h.

template<classPIXTYPE>

int Video<PIXTYPE>::buffer_count ( void ) const [inline]

Functions to get at data.

Definition at line 107 of file Video.h.

template<classPIXTYPE>

XVImageRGB< PIXTYPE >& Video<PIXTYPE>::frame ( int i ) const [inline]

Returns the data in frame i.

Definition at line 110 of file Video.h.
Referenced by current_frame().

template<classPIXTYPE>

XVImageRGB< PIXTYPE >& Video<PIXTYPE>::current_frame ( ) const [inline]

Returns the data in currently active frame.

Definition at line 113 of file Video.h.

template<classPIXTYPE>

int Video<PIXTYPE>::initiate_acquire ( int buffernum ) [pure virtual]

These are the basic functions to implement to acquire data.
The first schedules an acquisition; the second waits for its completion. Although available for "raw" use, most will probably just use either of the "next frame" functions below.
Referenced by request_frame_poll().

template<classPIXTYPE>

int Video<PIXTYPE>::release_buffer ( int buffernum ) [inline]

Definition at line 122 of file Video.h.

template<classPIXTYPE>

int & Video<PIXTYPE>::request_frame_continuous ( int framenum ) [inline]

Continous grab where you just get the next frame down the line.
If in polling mode, it schedules the first two frames and then waits for the first to complete.
Definition at line 129 of file Video.h.

template<classPIXTYPE>

XVImageRGB< PIXTYPE >& Video<PIXTYPE>::next_frame_continuous<PIXTYPE> ( ) [inline]

Definition at line 136 of file Video.h.

template<classPIXTYPE>

int Video<PIXTYPE>::request_frame_poll ( int framenum ) [inline]

Poll until a specific frame arives and return the index of the buffer containing it.

Definition at line 151 of file Video.h.

template<classPIXTYPE>

const XVImageRGB< PIXTYPE >& Video<PIXTYPE>::next_frame_poll<PIXTYPE> ( void ) [inline]

Definition at line 167 of file Video.h.

Member Data Documentation

template<classPIXTYPE>

const char * Video<PIXTYPE>::name [protected]

Definition at line 53 of file Video.h.

template<classPIXTYPE>

XVSize Video<PIXTYPE>::size [protected]

Definition at line 54 of file Video.h.

template<classPIXTYPE>

XVImageRGB< PIXTYPE >* Video<PIXTYPE>::image_buffers [protected]

Definition at line 60 of file Video.h.

template<classPIXTYPE>

int Video<PIXTYPE>::n_buffers [protected]

Definition at line 61 of file Video.h.

template<classPIXTYPE>

int Video<PIXTYPE>::current_buffer [protected]

Definition at line 62 of file Video.h.

template<classPIXTYPE>

int Video<PIXTYPE>::frame_count [protected]

Definition at line 66 of file Video.h.

template<classPIXTYPE>

XVCapture_Mode Video<PIXTYPE>::capture_mode [protected]

Definition at line 67 of file Video.h.

template<classPIXTYPE>

int Video<PIXTYPE>::own_buffers [protected]

Definition at line 91 of file Video.h.

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

/home/slang/XVision2/src/Devices/Video.h

Generated at Thu Mar 29 22:37:29 2001 for XVision by