CVD::V4L1::RawV4L1 Class Reference

#include <v4l1buffer.h>

Inheritance diagram for CVD::V4L1::RawV4L1:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void captureFrame (unsigned int buffer)
void commitSettings ()
bool frame_pending ()
 Is there a frame waiting in the buffer? This function does not block.
double frame_rate ()
 Get the camera frame rate.
bool get_auto_exp (void)
double get_brightness (void)
double get_contrast (void)
unsigned char * get_frame ()
int get_handle () const
 return underlying file handle for select operations etc
double get_hue (void)
double get_saturation (void)
const ImageRefget_size () const
double get_whiteness (void)
void put_frame (unsigned char *)
 RawV4L1 (const std::string &dev, unsigned int mode, const ImageRef &)
void retrieveSettings ()
void set_auto_exp (bool on)
void set_brightness (double brightness)
void set_contrast (double contrast)
void set_hue (double hue)
void set_palette (unsigned int palette)
void set_saturation (double saturation)
void set_size (const ImageRef &size)
void set_whiteness (double whiteness)
virtual ~RawV4L1 ()

Private Attributes

int autoexp
std::string deviceName
size_t mmaped_len
void * mmaped_memory
unsigned int myBpp
double myBrightness
double myContrast
int myDevice
std::vector< unsigned char * > myFrameBuf
std::vector< bool > myFrameBufState
double myHue
unsigned int myNextRetrieveBuf
unsigned int myPalette
double mySaturation
ImageRef mySize
double myWhiteness

Detailed Description

Internal (non type-safe) class used by V4L1Buffer classes to access video devices with v4l1 drivers. Use V4L1Buffer to get the 8-bit greyscale or 24-bit color.

Definition at line 97 of file v4l1buffer.h.


Constructor & Destructor Documentation

CVD::V4L1::RawV4L1::RawV4L1 ( const std::string &  dev,
unsigned int  mode,
const ImageRef  
)

constructor

Parameters:
dev file name of the device to open
mode color palette to use (see linux/video.h for possible modes)
virtual CVD::V4L1::RawV4L1::~RawV4L1 (  )  [virtual]

Member Function Documentation

void CVD::V4L1::RawV4L1::captureFrame ( unsigned int  buffer  ) 

marks a frame as ready for capturing

void CVD::V4L1::RawV4L1::commitSettings (  ) 

Commit the settings to the camera device.

bool CVD::V4L1::RawV4L1::frame_pending (  ) 

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

Reimplemented in CVD::V4L1Buffer< T >.

double CVD::V4L1::RawV4L1::frame_rate (  ) 

Get the camera frame rate.

Reimplemented in CVD::V4L1Buffer< T >.

bool CVD::V4L1::RawV4L1::get_auto_exp ( void   ) 

gets autoexposure

double CVD::V4L1::RawV4L1::get_brightness ( void   )  [inline]

returns current brightness setting.

Definition at line 115 of file v4l1buffer.h.

double CVD::V4L1::RawV4L1::get_contrast ( void   )  [inline]

returns current contrast setting.

Definition at line 127 of file v4l1buffer.h.

unsigned char* CVD::V4L1::RawV4L1::get_frame (  ) 

returns the data of the next captured frame

Reimplemented in CVD::V4L1Buffer< T >.

int CVD::V4L1::RawV4L1::get_handle (  )  const [inline]

return underlying file handle for select operations etc

Definition at line 151 of file v4l1buffer.h.

double CVD::V4L1::RawV4L1::get_hue ( void   )  [inline]

returns current hue setting.

Definition at line 123 of file v4l1buffer.h.

double CVD::V4L1::RawV4L1::get_saturation ( void   )  [inline]

returns current saturation setting.

Definition at line 131 of file v4l1buffer.h.

const ImageRef& CVD::V4L1::RawV4L1::get_size (  )  const

Get the width in pixels of the captured frames.

double CVD::V4L1::RawV4L1::get_whiteness ( void   )  [inline]

returns current whiteness setting.

Definition at line 119 of file v4l1buffer.h.

void CVD::V4L1::RawV4L1::put_frame ( unsigned char *   ) 

returns the frame data to be used for further capturing

void CVD::V4L1::RawV4L1::retrieveSettings (  ) 

Get current settings from the camera device.

void CVD::V4L1::RawV4L1::set_auto_exp ( bool  on  ) 

sets autoexposure

void CVD::V4L1::RawV4L1::set_brightness ( double  brightness  ) 

Set the brightness in [0,1] of the captured frames.

void CVD::V4L1::RawV4L1::set_contrast ( double  contrast  ) 

Set the contrast in [0,1] of the captured frames.

void CVD::V4L1::RawV4L1::set_hue ( double  hue  ) 

Set the hue in [0,1] of the captured frames.

void CVD::V4L1::RawV4L1::set_palette ( unsigned int  palette  ) 

Set the color palette to use

void CVD::V4L1::RawV4L1::set_saturation ( double  saturation  ) 

Set the saturation in [0,1] of the captured frames.

void CVD::V4L1::RawV4L1::set_size ( const ImageRef size  ) 

Set the size of the captured frames.

void CVD::V4L1::RawV4L1::set_whiteness ( double  whiteness  ) 

Set the whiteness in [0,1] of the captured frames.


Member Data Documentation

Definition at line 160 of file v4l1buffer.h.

std::string CVD::V4L1::RawV4L1::deviceName [private]

Definition at line 151 of file v4l1buffer.h.

Definition at line 163 of file v4l1buffer.h.

Definition at line 162 of file v4l1buffer.h.

unsigned int CVD::V4L1::RawV4L1::myBpp [private]

Definition at line 159 of file v4l1buffer.h.

Definition at line 158 of file v4l1buffer.h.

Definition at line 158 of file v4l1buffer.h.

Definition at line 155 of file v4l1buffer.h.

std::vector<unsigned char*> CVD::V4L1::RawV4L1::myFrameBuf [private]

Definition at line 165 of file v4l1buffer.h.

std::vector<bool> CVD::V4L1::RawV4L1::myFrameBufState [private]

Definition at line 166 of file v4l1buffer.h.

double CVD::V4L1::RawV4L1::myHue [private]

Definition at line 158 of file v4l1buffer.h.

unsigned int CVD::V4L1::RawV4L1::myNextRetrieveBuf [private]

Definition at line 167 of file v4l1buffer.h.

unsigned int CVD::V4L1::RawV4L1::myPalette [private]

Definition at line 157 of file v4l1buffer.h.

Definition at line 158 of file v4l1buffer.h.

Definition at line 156 of file v4l1buffer.h.

Definition at line 158 of file v4l1buffer.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:14:00 2013