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

XVVideo 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 <XVVideo.h>

Inheritance diagram for XVVideo:

List of all members.

Public Methods

XVVideo (const char *dev_name="/dev/video",const char *parm_string = NULL)
virtual ~XVVideo ()
int buffer_count (void) const
Functions to get at data. More...
XVImageBase<PIXTYPE>& frame (int i) const
Returns the data in frame i. More...
XVImageBase<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...
XVImageBase<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 XVImageBase<PIXTYPE>& next_frame_poll (void)
virtual int set_params (char *paramstring) = 0
XVImageBase<PIXTYPE>* remap (PIXTYPE *mm_buf[],int n_buffers)
virtual XVImageBase<PIXTYPE>* createImages (int, int, int) = 0

Protected Methods

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

Protected Attributes

const char* name
XVSize size
XVImageBase<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 XVVideo

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 38 of file XVVideo.h.

Member Function Documentation

template<classPIXTYPE>

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

Definition at line 65 of file XVVideo.h.

template<classPIXTYPE>

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

Definition at line 75 of file XVVideo.h.

template<classPIXTYPE>

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

Functions to get at data.

Definition at line 97 of file XVVideo.h.

template<classPIXTYPE>

XVImageBase< PIXTYPE >& XVVideo<PIXTYPE>::frame ( int i ) const [inline]

Returns the data in frame i.

Definition at line 100 of file XVVideo.h.
Referenced by current_frame().

template<classPIXTYPE>

XVImageBase< PIXTYPE >& XVVideo<PIXTYPE>::current_frame ( ) const [inline]

Returns the data in currently active frame.

Definition at line 103 of file XVVideo.h.

template<classPIXTYPE>

int XVVideo<PIXTYPE>::initiate_acquire ( int frame ) [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 XVVideo<PIXTYPE>::release_buffer ( int buffernum ) [inline]

Definition at line 112 of file XVVideo.h.

template<classPIXTYPE>

int & XVVideo<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 119 of file XVVideo.h.

template<classPIXTYPE>

XVImageBase< PIXTYPE >& XVVideo<PIXTYPE>::next_frame_continuous<PIXTYPE> ( ) [inline]

Definition at line 126 of file XVVideo.h.

template<classPIXTYPE>

int XVVideo<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 141 of file XVVideo.h.

template<classPIXTYPE>

const XVImageBase< PIXTYPE >& XVVideo<PIXTYPE>::next_frame_poll<PIXTYPE> ( void ) [inline]

Definition at line 157 of file XVVideo.h.

Member Data Documentation

template<classPIXTYPE>

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

Definition at line 42 of file XVVideo.h.

template<classPIXTYPE>

XVSize XVVideo<PIXTYPE>::size [protected]

Definition at line 43 of file XVVideo.h.

template<classPIXTYPE>

XVImageBase< PIXTYPE >* XVVideo<PIXTYPE>::image_buffers [protected]

Definition at line 49 of file XVVideo.h.

template<classPIXTYPE>

int XVVideo<PIXTYPE>::n_buffers [protected]

Definition at line 51 of file XVVideo.h.

template<classPIXTYPE>

int XVVideo<PIXTYPE>::current_buffer [protected]

Definition at line 52 of file XVVideo.h.

template<classPIXTYPE>

int XVVideo<PIXTYPE>::frame_count [protected]

Definition at line 56 of file XVVideo.h.

template<classPIXTYPE>

XVCapture_Mode XVVideo<PIXTYPE>::capture_mode [protected]

Definition at line 57 of file XVVideo.h.

template<classPIXTYPE>

int XVVideo<PIXTYPE>::own_buffers [protected]

Definition at line 81 of file XVVideo.h.

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

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

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