1#ifndef PWC_IOCTL_H
2#define PWC_IOCTL_H
3
4/* (C) 2001-2003 Nemosoft Unv.    webcam@smcc.demon.nl
5
6   This program is free software; you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation; either version 2 of the License, or
9   (at your option) any later version.
10
11   This program is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with this program; if not, write to the Free Software
18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19*/
20
21/*         This is pwc-ioctl.h belonging to PWC 8.10                        */
22
23/*
24   Changes
25   2001/08/03  Alvarado   Added ioctl constants to access methods for
26                          changing white balance and red/blue gains
27   2002/12/15  G. H. Fernandez-Toribio   VIDIOCGREALSIZE
28 */
29
30/* These are private ioctl() commands, specific for the Philips webcams.
31   They contain functions not found in other webcams, and settings not
32   specified in the Video4Linux API.
33
34   The #define names are built up like follows:
35   VIDIOC		VIDeo IOCtl prefix
36         PWC		Philps WebCam
37            G           optional: Get
38            S           optional: Set
39             ... 	the function
40 */
41
42
43
44
45/* The frame rate is encoded in the video_window.flags parameter using
46   the upper 16 bits, since some flags are defined nowadays. The following
47   defines provide a mask and shift to filter out this value.
48
49   In 'Snapshot' mode the camera freezes its automatic exposure and colour
50   balance controls.
51 */
52#define PWC_FPS_SHIFT		16
53#define PWC_FPS_MASK		0x00FF0000
54#define PWC_FPS_FRMASK		0x003F0000
55#define PWC_FPS_SNAPSHOT	0x00400000
56
57
58
59struct pwc_probe
60{
61	char name[32];
62	int type;
63};
64
65
66/* pwc_whitebalance.mode values */
67#define PWC_WB_INDOOR		0
68#define PWC_WB_OUTDOOR		1
69#define PWC_WB_FL		2
70#define PWC_WB_MANUAL		3
71#define PWC_WB_AUTO		4
72
73/* Used with VIDIOCPWC[SG]AWB (Auto White Balance).
74   Set mode to one of the PWC_WB_* values above.
75   *red and *blue are the respective gains of these colour components inside
76   the camera; range 0..65535
77   When 'mode' == PWC_WB_MANUAL, 'manual_red' and 'manual_blue' are set or read;
78   otherwise undefined.
79   'read_red' and 'read_blue' are read-only.
80*/
81
82struct pwc_whitebalance
83{
84	int mode;
85	int manual_red, manual_blue;	/* R/W */
86	int read_red, read_blue;	/* R/O */
87};
88
89/*
90   'control_speed' and 'control_delay' are used in automatic whitebalance mode,
91   and tell the camera how fast it should react to changes in lighting, and
92   with how much delay. Valid values are 0..65535.
93*/
94struct pwc_wb_speed
95{
96	int control_speed;
97	int control_delay;
98
99};
100
101/* Used with VIDIOCPWC[SG]LED */
102struct pwc_leds
103{
104	int led_on;			/* Led on-time; range = 0..25000 */
105	int led_off;			/* Led off-time; range = 0..25000  */
106};
107
108/* Image size (used with GREALSIZE) */
109struct pwc_imagesize
110{
111	int width;
112	int height;
113};
114
115 /* Restore user settings */
116#define VIDIOCPWCRUSER		_IO('v', 192)
117 /* Save user settings */
118#define VIDIOCPWCSUSER		_IO('v', 193)
119 /* Restore factory settings */
120#define VIDIOCPWCFACTORY	_IO('v', 194)
121
122 /* You can manipulate the compression factor. A compression preference of 0
123    means use uncompressed modes when available; 1 is low compression, 2 is
124    medium and 3 is high compression preferred. Of course, the higher the
125    compression, the lower the bandwidth used but more chance of artefacts
126    in the image. The driver automatically chooses a higher compression when
127    the preferred mode is not available.
128  */
129 /* Set preferred compression quality (0 = uncompressed, 3 = highest compression) */
130#define VIDIOCPWCSCQUAL		_IOW('v', 195, int)
131 /* Get preferred compression quality */
132#define VIDIOCPWCGCQUAL		_IOR('v', 195, int)
133
134
135 /* This is a probe function; since so many devices are supported, it
136    becomes difficult to include all the names in programs that want to
137    check for the enhanced Philips stuff. So in stead, try this PROBE;
138    it returns a structure with the original name, and the corresponding
139    Philips type.
140    To use, fill the structure with zeroes, call PROBE and if that succeeds,
141    compare the name with that returned from VIDIOCGCAP; they should be the
142    same. If so, you can be assured it is a Philips (OEM) cam and the type
143    is valid.
144 */
145#define VIDIOCPWCPROBE		_IOR('v', 199, struct pwc_probe)
146
147 /* Set AGC (Automatic Gain Control); int < 0 = auto, 0..65535 = fixed */
148#define VIDIOCPWCSAGC		_IOW('v', 200, int)
149 /* Get AGC; int < 0 = auto; >= 0 = fixed, range 0..65535 */
150#define VIDIOCPWCGAGC		_IOR('v', 200, int)
151 /* Set shutter speed; int < 0 = auto; >= 0 = fixed, range 0..65535 */
152#define VIDIOCPWCSSHUTTER	_IOW('v', 201, int)
153
154 /* Color compensation (Auto White Balance) */
155#define VIDIOCPWCSAWB           _IOW('v', 202, struct pwc_whitebalance)
156#define VIDIOCPWCGAWB           _IOR('v', 202, struct pwc_whitebalance)
157
158 /* Auto WB speed */
159#define VIDIOCPWCSAWBSPEED	_IOW('v', 203, struct pwc_wb_speed)
160#define VIDIOCPWCGAWBSPEED	_IOR('v', 203, struct pwc_wb_speed)
161
162 /* LEDs on/off/blink; int range 0..65535 */
163#define VIDIOCPWCSLED           _IOW('v', 205, struct pwc_leds)
164#define VIDIOCPWCGLED           _IOR('v', 205, struct pwc_leds)
165
166  /* Contour (sharpness); int < 0 = auto, 0..65536 = fixed */
167#define VIDIOCPWCSCONTOUR	_IOW('v', 206, int)
168#define VIDIOCPWCGCONTOUR	_IOR('v', 206, int)
169
170  /* Backlight compensation; 0 = off, otherwise on */
171#define VIDIOCPWCSBACKLIGHT	_IOW('v', 207, int)
172#define VIDIOCPWCGBACKLIGHT	_IOR('v', 207, int)
173
174  /* Flickerless mode; = 0 off, otherwise on */
175#define VIDIOCPWCSFLICKER	_IOW('v', 208, int)
176#define VIDIOCPWCGFLICKER	_IOR('v', 208, int)
177
178  /* Dynamic noise reduction; 0 off, 3 = high noise reduction */
179#define VIDIOCPWCSDYNNOISE	_IOW('v', 209, int)
180#define VIDIOCPWCGDYNNOISE	_IOR('v', 209, int)
181
182 /* Real image size as used by the camera; tells you whether or not there's a gray border around the image */
183#define VIDIOCPWCGREALSIZE	_IOR('v', 210, struct pwc_imagesize)
184
185#endif
186