Fawkes API  Fawkes Development Version
dummy.h
1 
2 /***************************************************************************
3  * dummy.h - controller that controls nothing, sounds like a stupid
4  * idea but this avoids NULL checks in software using
5  * a camera controller
6  *
7  * Created: Wed Jun 15 12:45:57 2005
8  * Copyright 2005-2009 Tim Niemueller [www.niemueller.de]
9  *
10  ****************************************************************************/
11 
12 /* This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version. A runtime exception applies to
16  * this software (see LICENSE.GPL_WRE file mentioned below for details).
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU Library General Public License for more details.
22  *
23  * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
24  */
25 
26 #ifndef __FIREVISION_CAMS_DUMMY_CONTROL_H_
27 #define __FIREVISION_CAMS_DUMMY_CONTROL_H_
28 
29 #include <fvcams/control/color.h>
30 #include <fvcams/control/image.h>
31 #include <fvcams/control/pantilt.h>
32 #include <fvcams/control/zoom.h>
33 #include <fvcams/control/effect.h>
34 #include <fvcams/control/focus.h>
35 
36 namespace firevision {
37 #if 0 /* just to make Emacs auto-indent happy */
38 }
39 #endif
40 
41 /** Plain dummy control.
42  * Does nothing, supports nothing. Use to avoid unecessary NULL checks
43  */
45 : public CameraControlColor,
46  public CameraControlImage,
47  public CameraControlPanTilt,
48  public CameraControlZoom,
49  public CameraControlEffect,
50  public CameraControlFocus
51 {
52  public:
53  // from CameraControlColor
54  virtual bool auto_gain();
55  virtual void set_auto_gain(bool enabled);
56  virtual bool auto_white_balance();
57  virtual void set_auto_white_balance(bool enabled);
58  virtual unsigned int exposure_auto();
59  virtual void set_exposure_auto(unsigned int enabled);
60 
61  virtual int red_balance();
62  virtual void set_red_balance(int red_balance);
63  virtual int blue_balance();
64  virtual void set_blue_balance(int blue_balance);
65 
66  virtual int u_balance();
67  virtual void set_u_balance(int u_balance);
68  virtual int v_balance();
69  virtual void set_v_balance(int v_balance);
70 
71  virtual unsigned int brightness();
72  virtual void set_brightness(unsigned int brightness);
73  virtual unsigned int contrast();
74  virtual void set_contrast(unsigned int contrast);
75  virtual unsigned int saturation();
76  virtual void set_saturation(unsigned int saturation);
77  virtual int hue();
78  virtual void set_hue(int hue);
79  virtual unsigned int exposure();
80  virtual void set_exposure(unsigned int exposure);
81  virtual unsigned int gain();
82  virtual void set_gain(unsigned int gain);
83 
84  // From CameraControlImage
85  virtual const char * format();
86  virtual void set_format(const char *format);
87  virtual unsigned int width();
88  virtual unsigned int height();
89  virtual void size(unsigned int &width, unsigned int &height);
90  virtual void set_size(unsigned int width, unsigned int height);
91  virtual bool horiz_mirror();
92  virtual bool vert_mirror();
93  virtual void mirror(bool &horiz, bool &vert);
94  virtual void set_horiz_mirror(bool enabled);
95  virtual void set_vert_mirror(bool enabled);
96  virtual void set_mirror(bool horiz, bool vert);
97 
98  virtual unsigned int fps();
99  virtual void set_fps(unsigned int fps);
100 
101  virtual unsigned int lens_x_corr();
102  virtual unsigned int lens_y_corr();
103  virtual void lens_corr(unsigned int &x_corr, unsigned int &y_corr);
104  virtual void set_lens_x_corr(unsigned int x_corr);
105  virtual void set_lens_y_corr(unsigned int y_corr);
106  virtual void set_lens_corr(unsigned int x_corr, unsigned int y_corr);
107 
108  // From CameraControlPanTilt
109  virtual void process_pantilt();
110 
111  virtual bool supports_pan();
112  virtual bool supports_tilt();
113  virtual void set_pan(int pan);
114  virtual void set_tilt(int tilt);
115  virtual void set_pan_tilt(int pan, int tilt);
116  virtual void set_pan_tilt_rad(float pan, float tilt);
117  virtual int pan();
118  virtual int tilt();
119  virtual void start_get_pan_tilt();
120  virtual void pan_tilt(int &pan, int &tilt);
121  virtual void pan_tilt_rad(float &pan, float &tilt);
122  virtual int min_pan();
123  virtual int max_pan();
124  virtual int min_tilt();
125  virtual int max_tilt();
126  virtual void reset_pan_tilt();
127  virtual void set_pan_tilt_limit(int pan_left, int pan_right,
128  int tilt_up, int tilt_down);
129  virtual void reset_pan_tilt_limit();
130 
131  // From CameraControlZoom
132  virtual void reset_zoom();
133  virtual void set_zoom(unsigned int zoom);
134  virtual unsigned int zoom();
135  virtual unsigned int zoom_max();
136  virtual unsigned int zoom_min();
137  virtual void set_zoom_speed_tele(unsigned int speed);
138  virtual void set_zoom_speed_wide(unsigned int speed);
139  virtual void set_zoom_digital_enabled(bool enabled);
140 
141  // from CameraControlEffect
142  virtual bool supports_effect(unsigned int effect);
143  virtual void set_effect(unsigned int effect);
144  virtual unsigned int effect();
145  virtual void reset_effect();
146 
147  // from CameraControlFocus
148  virtual bool auto_focus();
149  virtual void set_auto_focus(bool enabled);
150  virtual unsigned int focus();
151  virtual void set_focus(unsigned int focus);
152  virtual unsigned int focus_min();
153  virtual unsigned int focus_max();
154 
155 };
156 
157 } // end namespace firevision
158 
159 #endif
virtual void reset_effect()
Reset effect.
Definition: dummy.cpp:392
virtual bool supports_tilt()
Check whether this controller supports tilting.
Definition: dummy.cpp:265
virtual void set_format(const char *format)
Set the image format the camera should use.
Definition: dummy.cpp:166
virtual unsigned int contrast()
Get current contrast.
Definition: dummy.cpp:115
virtual unsigned int width()
Get the current width of the image.
Definition: dummy.cpp:170
virtual unsigned int exposure_auto()
Return whether auto exposure is enabled.
Definition: dummy.cpp:58
virtual unsigned int effect()
Current effect.
Definition: dummy.cpp:387
virtual void set_zoom_speed_wide(unsigned int speed)
Set speed in wide range.
Definition: dummy.cpp:370
virtual void set_lens_y_corr(unsigned int y_corr)
Set lens y correction.
Definition: dummy.cpp:247
Camera zoom control interface.
Definition: zoom.h:35
virtual void set_tilt(int tilt)
Set tilt value.
Definition: dummy.cpp:274
virtual void set_red_balance(int red_balance)
Set red balance.
Definition: dummy.cpp:73
virtual void lens_corr(unsigned int &x_corr, unsigned int &y_corr)
Get current lens correction.
Definition: dummy.cpp:238
Camera focus control interface.
Definition: focus.h:35
virtual void set_auto_gain(bool enabled)
Enable/disable auto gain.
Definition: dummy.cpp:45
virtual int v_balance()
Get current v balance.
Definition: dummy.cpp:96
virtual void set_exposure_auto(unsigned int enabled)
Enable/disable auto exposure.
Definition: dummy.cpp:63
virtual void set_saturation(unsigned int saturation)
Set new saturation.
Definition: dummy.cpp:129
virtual void set_mirror(bool horiz, bool vert)
Set whether the camera should mirror images.
Definition: dummy.cpp:213
virtual void set_size(unsigned int width, unsigned int height)
Set the image size the camera should use.
Definition: dummy.cpp:185
virtual void set_blue_balance(int blue_balance)
Set blue balance.
Definition: dummy.cpp:82
virtual int red_balance()
Get current red balance.
Definition: dummy.cpp:68
virtual int min_tilt()
Get minimum tilt value.
Definition: dummy.cpp:320
virtual bool auto_gain()
Return whether auto gain is enabled.
Definition: dummy.cpp:40
Camera color control interface.
Definition: color.h:35
Plain dummy control.
Definition: dummy.h:44
virtual bool supports_effect(unsigned int effect)
Check if camera control supports desired effect.
Definition: dummy.cpp:378
virtual void reset_pan_tilt()
Bring camera into home position.
Definition: dummy.cpp:330
Camera image control interface.
Definition: image.h:35
virtual unsigned int zoom_max()
Maximum zoom value.
Definition: dummy.cpp:356
virtual void set_fps(unsigned int fps)
Set the number of frames per second the camera tries to deliver.
Definition: dummy.cpp:223
virtual int tilt()
Get tilt value.
Definition: dummy.cpp:291
virtual int blue_balance()
Get current blue balance.
Definition: dummy.cpp:77
virtual void set_hue(int hue)
Set new hue.
Definition: dummy.cpp:138
virtual void set_zoom(unsigned int zoom)
Set new camera-specific zoom value.
Definition: dummy.cpp:347
virtual int min_pan()
Get minimum pan value.
Definition: dummy.cpp:310
virtual void set_pan(int pan)
Set pan value.
Definition: dummy.cpp:270
virtual void start_get_pan_tilt()
Start asynchronous fetch operation for pan and tilt values.
Definition: dummy.cpp:296
virtual unsigned int focus_min()
Get minimum focus value.
Definition: dummy.cpp:414
virtual const char * format()
Get the image format the camera currently uses.
Definition: dummy.cpp:161
virtual bool vert_mirror()
Return whether the camera image is vertically mirrored.
Definition: dummy.cpp:195
virtual void set_effect(unsigned int effect)
Enable effect.
Definition: dummy.cpp:383
virtual unsigned int lens_y_corr()
Get current lens y correction.
Definition: dummy.cpp:233
virtual unsigned int focus()
Get current focus value.
Definition: dummy.cpp:405
virtual int pan()
Get pan value.
Definition: dummy.cpp:286
virtual void reset_zoom()
Reset zoom.
Definition: dummy.cpp:343
virtual void pan_tilt(int &pan, int &tilt)
Get pan and tilt at the same time.
Definition: dummy.cpp:300
virtual unsigned int focus_max()
Get maximum focus value.
Definition: dummy.cpp:419
virtual void set_pan_tilt(int pan, int tilt)
Set pan and tilt in one go.
Definition: dummy.cpp:278
virtual bool auto_white_balance()
Return whether auto white balance is enabled.
Definition: dummy.cpp:49
virtual void set_horiz_mirror(bool enabled)
Set whether the camera should mirror images horizontally.
Definition: dummy.cpp:205
virtual void set_pan_tilt_rad(float pan, float tilt)
Set pan and tilt as float value.
Definition: dummy.cpp:282
Camera effect control interface.
Definition: effect.h:35
virtual unsigned int gain()
Get current gain.
Definition: dummy.cpp:151
virtual void process_pantilt()
Process pan/tilt information.
Definition: dummy.cpp:255
virtual int hue()
Get current hue.
Definition: dummy.cpp:133
virtual unsigned int zoom_min()
Minimum zoom value.
Definition: dummy.cpp:361
virtual void set_lens_corr(unsigned int x_corr, unsigned int y_corr)
Set lens correction.
Definition: dummy.cpp:251
virtual void set_brightness(unsigned int brightness)
Set new brightness.
Definition: dummy.cpp:111
virtual unsigned int saturation()
Get current saturation.
Definition: dummy.cpp:124
virtual void set_auto_focus(bool enabled)
Enable or disable auto focus.
Definition: dummy.cpp:401
virtual bool auto_focus()
Check if auto focus is enabled.
Definition: dummy.cpp:396
virtual int u_balance()
Get current u balance.
Definition: dummy.cpp:87
virtual void set_vert_mirror(bool enabled)
Set whether the camera should mirror images vertically.
Definition: dummy.cpp:209
virtual int max_pan()
Get maximum pan value.
Definition: dummy.cpp:315
virtual unsigned int height()
Get the current height of the image.
Definition: dummy.cpp:175
virtual void set_exposure(unsigned int exposure)
Set new exposure.
Definition: dummy.cpp:147
virtual void set_gain(unsigned int gain)
Set new gain.
Definition: dummy.cpp:156
virtual bool supports_pan()
Check whether this controller supports panning.
Definition: dummy.cpp:260
virtual void reset_pan_tilt_limit()
Reset pan/tilt limits.
Definition: dummy.cpp:339
virtual void set_pan_tilt_limit(int pan_left, int pan_right, int tilt_up, int tilt_down)
Set pan/tilt limits.
Definition: dummy.cpp:334
Camera pan/tilt control interface.
Definition: pantilt.h:35
virtual void set_u_balance(int u_balance)
Set u balance.
Definition: dummy.cpp:92
virtual void set_auto_white_balance(bool enabled)
Enable/disable auto white balance.
Definition: dummy.cpp:54
virtual void set_zoom_digital_enabled(bool enabled)
Set if digital zoom may be used.
Definition: dummy.cpp:374
virtual int max_tilt()
Get maximum tilt value.
Definition: dummy.cpp:325
virtual void set_zoom_speed_tele(unsigned int speed)
Set speed in tele range.
Definition: dummy.cpp:366
virtual void set_v_balance(int v_balance)
Set v balance.
Definition: dummy.cpp:101
virtual unsigned int exposure()
Get current exposure.
Definition: dummy.cpp:142
virtual void pan_tilt_rad(float &pan, float &tilt)
Get pan and tilt at the same time in radiant.
Definition: dummy.cpp:305
virtual void set_focus(unsigned int focus)
Set new focus value.
Definition: dummy.cpp:410
virtual bool horiz_mirror()
Return whether the camera image is horizontally mirrored.
Definition: dummy.cpp:190
virtual void size(unsigned int &width, unsigned int &height)
Get the current image size.
Definition: dummy.cpp:180
virtual unsigned int zoom()
Get current zoom value.
Definition: dummy.cpp:351
virtual void mirror(bool &horiz, bool &vert)
Get information about current camera image mirroring.
Definition: dummy.cpp:200
virtual unsigned int fps()
Get the number of frames per second the camera tries to deliver.
Definition: dummy.cpp:218
virtual void set_lens_x_corr(unsigned int x_corr)
Set lens x correction.
Definition: dummy.cpp:243
virtual unsigned int lens_x_corr()
Get current lens x correction.
Definition: dummy.cpp:228
virtual void set_contrast(unsigned int contrast)
Set new contrast.
Definition: dummy.cpp:120
virtual unsigned int brightness()
Get current brightness.
Definition: dummy.cpp:106