YARP
Yet Another Robot Platform
FrameGrabberInterfaces.h File Reference

define common interfaces to discover remote camera capabilities 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.

Detailed Description

define common interfaces to discover remote camera capabilities

define common interfaces for frame grabber devices

Definition in file FrameGrabberInterfaces.h.

Classes

struct  CameraDescriptor
 
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_FRAMEGRABBER_IMAGE   VOCAB3('f','g','i')
 
#define VOCAB_FRAMEGRABBER_IMAGERAW   VOCAB4('f','g','i','r')
 
#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_CROP   VOCAB4('c','r','o','p')
 
#define VOCAB_FRAMEGRABBER_CONTROL   VOCAB3('f','g','c')
 
#define VOCAB_FRAMEGRABBER_CONTROL_DC1394   VOCAB4('f','g','f','w')
 
#define VOCAB_CAMERA_DESCRIPTION   VOCAB4('c','a','m','d')
 
#define VOCAB_HAS   VOCAB3('h','a','s')
 
#define VOCAB_FEATURE   VOCAB4('f','e','a','t')
 
#define VOCAB_FEATURE2   VOCAB4('f','e','a','2')
 
#define VOCAB_ONOFF   VOCAB4('o','n','o','f')
 
#define VOCAB_AUTO   VOCAB4('a','u','t','o')
 
#define VOCAB_MANUAL   VOCAB3('m','a','n')
 
#define VOCAB_ONEPUSH   VOCAB4('o','n','e','p')
 
#define VOCAB_ACTIVE   VOCAB4('a','c','t','v')
 
#define VOCAB_MODE   VOCAB4('m','o','d','e')
 
#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  BusType {
  BUS_UNKNOWN = 0,
  BUS_FIREWIRE,
  BUS_USB
}
 
enum  FeatureMode {
  MODE_UNKNOWN = 0,
  MODE_MANUAL,
  MODE_AUTO
}
 
enum  cropType_id_t {
  YARP_CROP_RECT = 0,
  YARP_CROP_LIST
}
 
enum  cameraFeature_id_t {
  YARP_FEATURE_INVALID =-1,
  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
}
 

Macro Definition Documentation

◆ VOCAB_ACTIVE

#define VOCAB_ACTIVE   VOCAB4('a','c','t','v')

Definition at line 78 of file FrameGrabberInterfaces.h.

◆ VOCAB_AUTO

#define VOCAB_AUTO   VOCAB4('a','u','t','o')

Definition at line 75 of file FrameGrabberInterfaces.h.

◆ VOCAB_BRIGHTNESS

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

Definition at line 47 of file FrameGrabberInterfaces.h.

◆ VOCAB_CAMERA_DESCRIPTION

#define VOCAB_CAMERA_DESCRIPTION   VOCAB4('c','a','m','d')

Definition at line 70 of file FrameGrabberInterfaces.h.

◆ VOCAB_CROP

#define VOCAB_CROP   VOCAB4('c','r','o','p')

Definition at line 65 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETACT

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

Definition at line 127 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETBPP

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

Definition at line 173 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETCCM

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

Definition at line 148 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETCOD

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

Definition at line 149 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETF7M

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

Definition at line 155 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETFPM

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

Definition at line 141 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETFPS

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

Definition at line 142 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETISO

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

Definition at line 145 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETMOD

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

Definition at line 133 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETMSK

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

Definition at line 137 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETOPM

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

Definition at line 160 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETTXM

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

Definition at line 162 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETVAL

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

Definition at line 123 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETVMD

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

Definition at line 138 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETWF7

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

Definition at line 156 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRGETWHB

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

Definition at line 153 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRHASACT

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

Definition at line 125 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRHASAUT

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

Definition at line 130 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRHASFEA

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

Definition at line 121 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRHASMAN

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

Definition at line 129 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRHASONP

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

Definition at line 131 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETACT

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

Definition at line 126 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETBCS

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

Definition at line 166 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETBPP

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

Definition at line 172 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETCAP

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

Definition at line 171 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETCOD

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

Definition at line 150 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETDEF

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

Definition at line 167 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETFPS

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

Definition at line 143 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETISO

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

Definition at line 146 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETMOD

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

Definition at line 132 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETONP

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

Definition at line 134 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETOPM

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

Definition at line 159 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETPWR

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

Definition at line 169 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETRST

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

Definition at line 168 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETTXM

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

Definition at line 161 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETVAL

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

Definition at line 122 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETVMD

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

Definition at line 139 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETWF7

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

Definition at line 157 of file FrameGrabberInterfaces.h.

◆ VOCAB_DRSETWHB

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

Definition at line 152 of file FrameGrabberInterfaces.h.

◆ VOCAB_EXPOSURE

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

Definition at line 48 of file FrameGrabberInterfaces.h.

◆ VOCAB_FEATURE

#define VOCAB_FEATURE   VOCAB4('f','e','a','t')

Definition at line 72 of file FrameGrabberInterfaces.h.

◆ VOCAB_FEATURE2

#define VOCAB_FEATURE2   VOCAB4('f','e','a','2')

Definition at line 73 of file FrameGrabberInterfaces.h.

◆ VOCAB_FRAMEGRABBER_CONTROL

#define VOCAB_FRAMEGRABBER_CONTROL   VOCAB3('f','g','c')

Definition at line 68 of file FrameGrabberInterfaces.h.

◆ VOCAB_FRAMEGRABBER_CONTROL_DC1394

#define VOCAB_FRAMEGRABBER_CONTROL_DC1394   VOCAB4('f','g','f','w')

Definition at line 69 of file FrameGrabberInterfaces.h.

◆ VOCAB_FRAMEGRABBER_IMAGE

#define VOCAB_FRAMEGRABBER_IMAGE   VOCAB3('f','g','i')

Definition at line 40 of file FrameGrabberInterfaces.h.

◆ VOCAB_FRAMEGRABBER_IMAGERAW

#define VOCAB_FRAMEGRABBER_IMAGERAW   VOCAB4('f','g','i','r')

Definition at line 41 of file FrameGrabberInterfaces.h.

◆ VOCAB_GAIN

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

Definition at line 55 of file FrameGrabberInterfaces.h.

◆ VOCAB_GAMMA

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

Definition at line 53 of file FrameGrabberInterfaces.h.

◆ VOCAB_GET

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

Definition at line 60 of file FrameGrabberInterfaces.h.

◆ VOCAB_HAS

#define VOCAB_HAS   VOCAB3('h','a','s')

Definition at line 71 of file FrameGrabberInterfaces.h.

◆ VOCAB_HEIGHT

#define VOCAB_HEIGHT   VOCAB1('h')

Definition at line 63 of file FrameGrabberInterfaces.h.

◆ VOCAB_HUE

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

Definition at line 51 of file FrameGrabberInterfaces.h.

◆ VOCAB_IRIS

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

Definition at line 56 of file FrameGrabberInterfaces.h.

◆ VOCAB_IS

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

Definition at line 61 of file FrameGrabberInterfaces.h.

◆ VOCAB_MANUAL

#define VOCAB_MANUAL   VOCAB3('m','a','n')

Definition at line 76 of file FrameGrabberInterfaces.h.

◆ VOCAB_MODE

#define VOCAB_MODE   VOCAB4('m','o','d','e')

Definition at line 79 of file FrameGrabberInterfaces.h.

◆ VOCAB_ONEPUSH

#define VOCAB_ONEPUSH   VOCAB4('o','n','e','p')

Definition at line 77 of file FrameGrabberInterfaces.h.

◆ VOCAB_ONOFF

#define VOCAB_ONOFF   VOCAB4('o','n','o','f')

Definition at line 74 of file FrameGrabberInterfaces.h.

◆ VOCAB_SATURATION

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

Definition at line 52 of file FrameGrabberInterfaces.h.

◆ VOCAB_SET

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

Definition at line 59 of file FrameGrabberInterfaces.h.

◆ VOCAB_SHARPNESS

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

Definition at line 49 of file FrameGrabberInterfaces.h.

◆ VOCAB_SHUTTER

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

Definition at line 54 of file FrameGrabberInterfaces.h.

◆ VOCAB_WHITE

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

Definition at line 50 of file FrameGrabberInterfaces.h.

◆ VOCAB_WIDTH

#define VOCAB_WIDTH   VOCAB1('w')

Definition at line 62 of file FrameGrabberInterfaces.h.

Enumeration Type Documentation

◆ BusType

enum BusType
Enumerator
BUS_UNKNOWN 
BUS_FIREWIRE 
BUS_USB 

Definition at line 20 of file FrameGrabberInterfaces.h.

◆ cameraFeature_id_t

Enumerator
YARP_FEATURE_INVALID 
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 89 of file FrameGrabberInterfaces.h.

◆ cropType_id_t

Enumerator
YARP_CROP_RECT 
YARP_CROP_LIST 

Definition at line 82 of file FrameGrabberInterfaces.h.

◆ FeatureMode

Enumerator
MODE_UNKNOWN 
MODE_MANUAL 
MODE_AUTO 

Definition at line 26 of file FrameGrabberInterfaces.h.