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

#include <localvideobuffer.h>

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

List of all members.

Public Member Functions

virtual bool frame_pending ()=0
virtual LocalVideoFrame< T > * get_frame ()=0
 Returns the next frame from the buffer. This function blocks until a frame is ready.
 LocalVideoBuffer (typename VideoBufferType::Type t)
virtual void put_frame (VideoFrame< T > *f)=0
virtual void seek_to (double)
virtual ImageRef size ()=0
 The size of the VideoFrames returned by this buffer.
virtual ~LocalVideoBuffer ()

Detailed Description

template<class T>
class CVD::LocalVideoBuffer< T >

Base class for a VideoBuffer which manages its own memory for each VideoFrame that it provides. (In contrast to most buffers, where the memory is managed by the video hardware.)

Parameters:
T The pixel type of the video frames

Definition at line 36 of file localvideobuffer.h.


Constructor & Destructor Documentation

template<class T>
CVD::LocalVideoBuffer< T >::LocalVideoBuffer ( typename VideoBufferType::Type  t  )  [inline]

Definition at line 39 of file localvideobuffer.h.

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

Definition at line 43 of file localvideobuffer.h.


Member Function Documentation

template<class T>
virtual bool CVD::LocalVideoBuffer< T >::frame_pending (  )  [pure virtual]

Is there a frame waiting in the buffer? This function does not block. See is_live and is_flushable.

Implements CVD::RawVideoBuffer.

Implemented in CVD::ColourspaceBuffer< T, From >, CVD::DiskBuffer2< T >, CVD::ServerPushJpegBuffer< C >, and CVD::VideoFileBuffer< T >.

template<class T>
virtual LocalVideoFrame<T>* CVD::LocalVideoBuffer< T >::get_frame (  )  [pure virtual]

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

Implements CVD::VideoBuffer< T >.

Implemented in CVD::ColourspaceBuffer< T, From >, CVD::DiskBuffer2< T >, CVD::ServerPushJpegBuffer< C >, CVD::TimedDiskBuffer< T >, and CVD::VideoFileBuffer< T >.

template<class T>
virtual void CVD::LocalVideoBuffer< T >::put_frame ( VideoFrame< T > *  f  )  [pure 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 >.

Implemented in CVD::ColourspaceBuffer< T, From >, CVD::DiskBuffer2< T >, CVD::ServerPushJpegBuffer< C >, and CVD::VideoFileBuffer< T >.

template<class T>
virtual void CVD::LocalVideoBuffer< 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.

Reimplemented in CVD::ColourspaceBuffer< T, From >, CVD::DiskBuffer2< T >, CVD::ServerPushJpegBuffer< C >, and CVD::VideoFileBuffer< T >.

Definition at line 49 of file localvideobuffer.h.

template<class T>
virtual ImageRef CVD::LocalVideoBuffer< T >::size (  )  [pure virtual]

The size of the VideoFrames returned by this buffer.

Implements CVD::RawVideoBuffer.

Implemented in CVD::ColourspaceBuffer< T, From >, CVD::DiskBuffer2< T >, CVD::ServerPushJpegBuffer< C >, and CVD::VideoFileBuffer< T >.


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