CVD::DVBuffer2< T > Class Template Reference
[Video buffers]

#include <dvbuffer.h>

Inheritance diagram for CVD::DVBuffer2< T >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DVBuffer2 (int cam_no, int num_dma_buffers, int bright=-1, int exposure=-1, double fps=DC::cam_type< T >::fps)
virtual bool frame_pending ()
 Is there a frame waiting in the buffer? This function does not block.
double frame_rate ()
 Get the camera frame rate.
virtual VideoFrame< T > * get_frame ()
 Returns the next frame from the buffer. This function blocks until a frame is ready.
virtual void put_frame (VideoFrame< T > *f)
virtual void seek_to (double)
virtual ImageRef size ()
 The size of the VideoFrames returned by this buffer.
virtual ~DVBuffer2 ()

Detailed Description

template<class T>
class CVD::DVBuffer2< T >

A video buffer from a Firewire (IEEE 1394) camera. The requested image format depends on the templated pixel type. Frames of size 640 by 480 pixels are requested, at 30fps (except for CVD::Rgb<CVD::byte>, which is 15fps).

Parameters:
T The pixel type of the frames. Currently only <CVD::Rgb<CVD::byte> > CVD::yuv411> and CVD::byte> are supported.

Definition at line 244 of file dvbuffer.h.


Constructor & Destructor Documentation

template<class T >
CVD::DVBuffer2< T >::DVBuffer2 ( int  cam_no,
int  num_dma_buffers,
int  bright = -1,
int  exposure = -1,
double  fps = DC::cam_type<T>::fps 
) [inline]

Construct a video buffer

Parameters:
cam_no The camera number (the first camera is 0)
num_dma_buffers The number of DMA buffers to use (at least 3 is recommended)
bright The brightness correction (default = -1 = automatic)
exposure The exposure correction (default = -1 = automatic)
fps The number of frames per second (default = 30fps)

Definition at line 253 of file dvbuffer.h.

template<class T >
virtual CVD::DVBuffer2< T >::~DVBuffer2 (  )  [inline, virtual]

Definition at line 260 of file dvbuffer.h.


Member Function Documentation

template<class T >
virtual bool CVD::DVBuffer2< T >::frame_pending (  )  [inline, virtual]

Is there a frame waiting in the buffer? This function does not block.

Reimplemented from CVD::DC::RawDCVideo.

Definition at line 284 of file dvbuffer.h.

template<class T >
double CVD::DVBuffer2< T >::frame_rate (  )  [inline]

Get the camera frame rate.

Reimplemented from CVD::DC::RawDCVideo.

Definition at line 264 of file dvbuffer.h.

template<class T >
virtual VideoFrame<T>* CVD::DVBuffer2< T >::get_frame (  )  [inline, virtual]

Returns the next frame from the buffer. This function blocks until a frame is ready.

Reimplemented from CVD::DC::RawDCVideo.

Definition at line 274 of file dvbuffer.h.

template<class T >
virtual void CVD::DVBuffer2< T >::put_frame ( VideoFrame< T > *  f  )  [inline, virtual]

Tell the buffer that you are finished with this frame. Typically the VideoBuffer then destroys the frame.

Parameters:
f The frame that you are finished with.

Implements CVD::VideoBuffer< T >.

Definition at line 279 of file dvbuffer.h.

template<class T >
virtual void CVD::DVBuffer2< T >::seek_to ( double   )  [inline, virtual]

Go to a particular point in the video buffer (only implemented in buffers of recorded video)

Parameters:
t The frame time in seconds

Reimplemented from CVD::RawVideoBuffer.

Definition at line 289 of file dvbuffer.h.

template<class T >
virtual ImageRef CVD::DVBuffer2< T >::size (  )  [inline, virtual]

The size of the VideoFrames returned by this buffer.

Reimplemented from CVD::DC::RawDCVideo.

Definition at line 269 of file dvbuffer.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


libcvd
Author(s): Edward Rosten, Paul Smith, Tom Drummond, Gerhard Reitmayr, Ethan Eade, Timothy Gan, Chris Kemp, Georg Klein
autogenerated on Fri Jan 11 09:13:51 2013