YARP  2.3.68+228-20170410.2+git7d0b2e0
Yet Another Robot Platform
FrameGrabberInterfaces.h File Reference

define common interfaces for frame grabber devices More...

+ Include dependency graph for FrameGrabberInterfaces.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  yarp::dev::IFrameGrabber
 Common interface to a FrameGrabber. More...
 
class  yarp::dev::IFrameGrabberRgb
 RGB Interface to a FrameGrabber device. More...
 
class  yarp::dev::IFrameGrabberImage
 Read a YARP-format image from a device. More...
 
class  yarp::dev::IFrameGrabberImageRaw
 Read a YARP-format image from a device. More...
 
class  yarp::dev::IFrameWriterImage
 Read a YARP-format image to a device. More...
 
class  yarp::dev::IFrameGrabberControls
 Control interface for frame grabber devices. More...
 
class  yarp::dev::IFrameGrabberControlsDC1394
 

Namespaces

 yarp
 The main, catch-all namespace for YARP.
 
 yarp::dev
 An interface for the device drivers.
 

Macros

#define VOCAB_BRIGHTNESS   VOCAB3('b','r','i')
 
#define VOCAB_EXPOSURE   VOCAB4('e','x','p','o')
 
#define VOCAB_SHARPNESS   VOCAB4('s','h','a','r')
 
#define VOCAB_WHITE   VOCAB4('w','h','i','t')
 
#define VOCAB_HUE   VOCAB3('h','u','e')
 
#define VOCAB_SATURATION   VOCAB4('s','a','t','u')
 
#define VOCAB_GAMMA   VOCAB4('g','a','m','m')
 
#define VOCAB_SHUTTER   VOCAB4('s','h','u','t')
 
#define VOCAB_GAIN   VOCAB4('g','a','i','n')
 
#define VOCAB_IRIS   VOCAB4('i','r','i','s')
 
#define VOCAB_SET   VOCAB3('s','e','t')
 
#define VOCAB_GET   VOCAB3('g','e','t')
 
#define VOCAB_IS   VOCAB2('i','s')
 
#define VOCAB_WIDTH   VOCAB1('w')
 
#define VOCAB_HEIGHT   VOCAB1('h')
 
#define VOCAB_DRHASFEA   VOCAB4('D','R','2','a')
 
#define VOCAB_DRSETVAL   VOCAB4('D','R','2','b')
 
#define VOCAB_DRGETVAL   VOCAB4('D','R','2','c')
 
#define VOCAB_DRHASACT   VOCAB4('D','R','2','d')
 
#define VOCAB_DRSETACT   VOCAB4('D','R','2','e')
 
#define VOCAB_DRGETACT   VOCAB4('D','R','2','f')
 
#define VOCAB_DRHASMAN   VOCAB4('D','R','2','g')
 
#define VOCAB_DRHASAUT   VOCAB4('D','R','2','h')
 
#define VOCAB_DRHASONP   VOCAB4('D','R','2','i')
 
#define VOCAB_DRSETMOD   VOCAB4('D','R','2','j')
 
#define VOCAB_DRGETMOD   VOCAB4('D','R','2','k')
 
#define VOCAB_DRSETONP   VOCAB4('D','R','2','l')
 
#define VOCAB_DRGETMSK   VOCAB4('D','R','2','m')
 
#define VOCAB_DRGETVMD   VOCAB4('D','R','2','n')
 
#define VOCAB_DRSETVMD   VOCAB4('D','R','2','o')
 
#define VOCAB_DRGETFPM   VOCAB4('D','R','2','p')
 
#define VOCAB_DRGETFPS   VOCAB4('D','R','2','q')
 
#define VOCAB_DRSETFPS   VOCAB4('D','R','2','r')
 
#define VOCAB_DRGETISO   VOCAB4('D','R','2','s')
 
#define VOCAB_DRSETISO   VOCAB4('D','R','2','t')
 
#define VOCAB_DRGETCCM   VOCAB4('D','R','2','u')
 
#define VOCAB_DRGETCOD   VOCAB4('D','R','2','v')
 
#define VOCAB_DRSETCOD   VOCAB4('D','R','2','w')
 
#define VOCAB_DRSETWHB   VOCAB4('D','R','2','x')
 
#define VOCAB_DRGETWHB   VOCAB4('D','R','2','y')
 
#define VOCAB_DRGETF7M   VOCAB4('D','R','2','z')
 
#define VOCAB_DRGETWF7   VOCAB4('D','R','2','A')
 
#define VOCAB_DRSETWF7   VOCAB4('D','R','2','B')
 
#define VOCAB_DRSETOPM   VOCAB4('D','R','2','C')
 
#define VOCAB_DRGETOPM   VOCAB4('D','R','2','D')
 
#define VOCAB_DRSETTXM   VOCAB4('D','R','2','E')
 
#define VOCAB_DRGETTXM   VOCAB4('D','R','2','F')
 
#define VOCAB_DRSETBCS   VOCAB4('D','R','2','I')
 
#define VOCAB_DRSETDEF   VOCAB4('D','R','2','J')
 
#define VOCAB_DRSETRST   VOCAB4('D','R','2','K')
 
#define VOCAB_DRSETPWR   VOCAB4('D','R','2','L')
 
#define VOCAB_DRSETCAP   VOCAB4('D','R','2','M')
 
#define VOCAB_DRSETBPP   VOCAB4('D','R','2','N')
 
#define VOCAB_DRGETBPP   VOCAB4('D','R','2','O')
 

Enumerations

enum  cameraFeature_id_t {
  YARP_FEATURE_BRIGHTNESS =0,
  YARP_FEATURE_EXPOSURE,
  YARP_FEATURE_SHARPNESS,
  YARP_FEATURE_WHITE_BALANCE,
  YARP_FEATURE_HUE,
  YARP_FEATURE_SATURATION,
  YARP_FEATURE_GAMMA,
  YARP_FEATURE_SHUTTER,
  YARP_FEATURE_GAIN,
  YARP_FEATURE_IRIS,
  YARP_FEATURE_FOCUS,
  YARP_FEATURE_TEMPERATURE,
  YARP_FEATURE_TRIGGER,
  YARP_FEATURE_TRIGGER_DELAY,
  YARP_FEATURE_WHITE_SHADING,
  YARP_FEATURE_FRAME_RATE,
  YARP_FEATURE_ZOOM,
  YARP_FEATURE_PAN,
  YARP_FEATURE_TILT,
  YARP_FEATURE_OPTICAL_FILTER,
  YARP_FEATURE_CAPTURE_SIZE,
  YARP_FEATURE_CAPTURE_QUALITY,
  YARP_FEATURE_MIRROR,
  YARP_FEATURE_NUMBER_OF
}
 

Detailed Description

define common interfaces for frame grabber devices

Definition in file FrameGrabberInterfaces.h.

Macro Definition Documentation

◆ VOCAB_BRIGHTNESS

#define VOCAB_BRIGHTNESS   VOCAB3('b','r','i')

Definition at line 35 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETACT

#define VOCAB_DRGETACT   VOCAB4('D','R','2','f')

Definition at line 95 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETBPP

#define VOCAB_DRGETBPP   VOCAB4('D','R','2','O')

Definition at line 141 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETCCM

#define VOCAB_DRGETCCM   VOCAB4('D','R','2','u')

Definition at line 116 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETCOD

#define VOCAB_DRGETCOD   VOCAB4('D','R','2','v')

Definition at line 117 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETF7M

#define VOCAB_DRGETF7M   VOCAB4('D','R','2','z')

Definition at line 123 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETFPM

#define VOCAB_DRGETFPM   VOCAB4('D','R','2','p')

Definition at line 109 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETFPS

#define VOCAB_DRGETFPS   VOCAB4('D','R','2','q')

Definition at line 110 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETISO

#define VOCAB_DRGETISO   VOCAB4('D','R','2','s')

Definition at line 113 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETMOD

#define VOCAB_DRGETMOD   VOCAB4('D','R','2','k')

Definition at line 101 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETMSK

#define VOCAB_DRGETMSK   VOCAB4('D','R','2','m')

Definition at line 105 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETOPM

#define VOCAB_DRGETOPM   VOCAB4('D','R','2','D')

Definition at line 128 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETTXM

#define VOCAB_DRGETTXM   VOCAB4('D','R','2','F')

Definition at line 130 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETVAL

#define VOCAB_DRGETVAL   VOCAB4('D','R','2','c')

Definition at line 91 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETVMD

#define VOCAB_DRGETVMD   VOCAB4('D','R','2','n')

Definition at line 106 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETWF7

#define VOCAB_DRGETWF7   VOCAB4('D','R','2','A')

Definition at line 124 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETWHB

#define VOCAB_DRGETWHB   VOCAB4('D','R','2','y')

Definition at line 121 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRHASACT

#define VOCAB_DRHASACT   VOCAB4('D','R','2','d')

Definition at line 93 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRHASAUT

#define VOCAB_DRHASAUT   VOCAB4('D','R','2','h')

Definition at line 98 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRHASFEA

#define VOCAB_DRHASFEA   VOCAB4('D','R','2','a')

Definition at line 89 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRHASMAN

#define VOCAB_DRHASMAN   VOCAB4('D','R','2','g')

Definition at line 97 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRHASONP

#define VOCAB_DRHASONP   VOCAB4('D','R','2','i')

Definition at line 99 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETACT

#define VOCAB_DRSETACT   VOCAB4('D','R','2','e')

Definition at line 94 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETBCS

#define VOCAB_DRSETBCS   VOCAB4('D','R','2','I')

Definition at line 134 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETBPP

#define VOCAB_DRSETBPP   VOCAB4('D','R','2','N')

Definition at line 140 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETCAP

#define VOCAB_DRSETCAP   VOCAB4('D','R','2','M')

Definition at line 139 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETCOD

#define VOCAB_DRSETCOD   VOCAB4('D','R','2','w')

Definition at line 118 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETDEF

#define VOCAB_DRSETDEF   VOCAB4('D','R','2','J')

Definition at line 135 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETFPS

#define VOCAB_DRSETFPS   VOCAB4('D','R','2','r')

Definition at line 111 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETISO

#define VOCAB_DRSETISO   VOCAB4('D','R','2','t')

Definition at line 114 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETMOD

#define VOCAB_DRSETMOD   VOCAB4('D','R','2','j')

Definition at line 100 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETONP

#define VOCAB_DRSETONP   VOCAB4('D','R','2','l')

Definition at line 102 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETOPM

#define VOCAB_DRSETOPM   VOCAB4('D','R','2','C')

Definition at line 127 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETPWR

#define VOCAB_DRSETPWR   VOCAB4('D','R','2','L')

Definition at line 137 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETRST

#define VOCAB_DRSETRST   VOCAB4('D','R','2','K')

Definition at line 136 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETTXM

#define VOCAB_DRSETTXM   VOCAB4('D','R','2','E')

Definition at line 129 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETVAL

#define VOCAB_DRSETVAL   VOCAB4('D','R','2','b')

Definition at line 90 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETVMD

#define VOCAB_DRSETVMD   VOCAB4('D','R','2','o')

Definition at line 107 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETWF7

#define VOCAB_DRSETWF7   VOCAB4('D','R','2','B')

Definition at line 125 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETWHB

#define VOCAB_DRSETWHB   VOCAB4('D','R','2','x')

Definition at line 120 of file FrameGrabberInterfaces.h.

◆ VOCAB_EXPOSURE

#define VOCAB_EXPOSURE   VOCAB4('e','x','p','o')

Definition at line 36 of file FrameGrabberInterfaces.h.

◆ VOCAB_GAIN

#define VOCAB_GAIN   VOCAB4('g','a','i','n')

Definition at line 43 of file FrameGrabberInterfaces.h.

◆ VOCAB_GAMMA

#define VOCAB_GAMMA   VOCAB4('g','a','m','m')

Definition at line 41 of file FrameGrabberInterfaces.h.

◆ VOCAB_GET

#define VOCAB_GET   VOCAB3('g','e','t')

Definition at line 52 of file FrameGrabberInterfaces.h.

◆ VOCAB_HEIGHT

#define VOCAB_HEIGHT   VOCAB1('h')

Definition at line 55 of file FrameGrabberInterfaces.h.

◆ VOCAB_HUE

#define VOCAB_HUE   VOCAB3('h','u','e')

Definition at line 39 of file FrameGrabberInterfaces.h.

◆ VOCAB_IRIS

#define VOCAB_IRIS   VOCAB4('i','r','i','s')

Definition at line 44 of file FrameGrabberInterfaces.h.

◆ VOCAB_IS

#define VOCAB_IS   VOCAB2('i','s')

Definition at line 53 of file FrameGrabberInterfaces.h.

◆ VOCAB_SATURATION

#define VOCAB_SATURATION   VOCAB4('s','a','t','u')

Definition at line 40 of file FrameGrabberInterfaces.h.

◆ VOCAB_SET

#define VOCAB_SET   VOCAB3('s','e','t')

Definition at line 51 of file FrameGrabberInterfaces.h.

◆ VOCAB_SHARPNESS

#define VOCAB_SHARPNESS   VOCAB4('s','h','a','r')

Definition at line 37 of file FrameGrabberInterfaces.h.

◆ VOCAB_SHUTTER

#define VOCAB_SHUTTER   VOCAB4('s','h','u','t')

Definition at line 42 of file FrameGrabberInterfaces.h.

◆ VOCAB_WHITE

#define VOCAB_WHITE   VOCAB4('w','h','i','t')

Definition at line 38 of file FrameGrabberInterfaces.h.

◆ VOCAB_WIDTH

#define VOCAB_WIDTH   VOCAB1('w')

Definition at line 54 of file FrameGrabberInterfaces.h.

Enumeration Type Documentation

◆ cameraFeature_id_t

Enumerator
YARP_FEATURE_BRIGHTNESS 
YARP_FEATURE_EXPOSURE 
YARP_FEATURE_SHARPNESS 
YARP_FEATURE_WHITE_BALANCE 
YARP_FEATURE_HUE 
YARP_FEATURE_SATURATION 
YARP_FEATURE_GAMMA 
YARP_FEATURE_SHUTTER 
YARP_FEATURE_GAIN 
YARP_FEATURE_IRIS 
YARP_FEATURE_FOCUS 
YARP_FEATURE_TEMPERATURE 
YARP_FEATURE_TRIGGER 
YARP_FEATURE_TRIGGER_DELAY 
YARP_FEATURE_WHITE_SHADING 
YARP_FEATURE_FRAME_RATE 
YARP_FEATURE_ZOOM 
YARP_FEATURE_PAN 
YARP_FEATURE_TILT 
YARP_FEATURE_OPTICAL_FILTER 
YARP_FEATURE_CAPTURE_SIZE 
YARP_FEATURE_CAPTURE_QUALITY 
YARP_FEATURE_MIRROR 
YARP_FEATURE_NUMBER_OF 

Definition at line 58 of file FrameGrabberInterfaces.h.