File: /usr/src/linux/include/linux/videodev.h
1 #ifndef __LINUX_VIDEODEV_H
2 #define __LINUX_VIDEODEV_H
3
4 #include <linux/types.h>
5 #include <linux/version.h>
6
7 #ifdef __KERNEL__
8
9 #include <linux/poll.h>
10 #include <linux/devfs_fs_kernel.h>
11
12 struct video_device
13 {
14 struct module *owner;
15 char name[32];
16 int type;
17 int hardware;
18
19 int (*open)(struct video_device *, int mode);
20 void (*close)(struct video_device *);
21 long (*read)(struct video_device *, char *, unsigned long, int noblock);
22 /* Do we need a write method ? */
23 long (*write)(struct video_device *, const char *, unsigned long, int noblock);
24 #if LINUX_VERSION_CODE >= 0x020100
25 unsigned int (*poll)(struct video_device *, struct file *, poll_table *);
26 #endif
27 int (*ioctl)(struct video_device *, unsigned int , void *);
28 int (*mmap)(struct video_device *, const char *, unsigned long);
29 int (*initialize)(struct video_device *);
30 void *priv; /* Used to be 'private' but that upsets C++ */
31 int busy;
32 int minor;
33 devfs_handle_t devfs_handle;
34 };
35
36 #define VIDEO_MAJOR 81
37 extern int video_register_device(struct video_device *, int type, int nr);
38
39 #define VFL_TYPE_GRABBER 0
40 #define VFL_TYPE_VBI 1
41 #define VFL_TYPE_RADIO 2
42 #define VFL_TYPE_VTX 3
43
44 extern void video_unregister_device(struct video_device *);
45 #endif
46
47
48 #define VID_TYPE_CAPTURE 1 /* Can capture */
49 #define VID_TYPE_TUNER 2 /* Can tune */
50 #define VID_TYPE_TELETEXT 4 /* Does teletext */
51 #define VID_TYPE_OVERLAY 8 /* Overlay onto frame buffer */
52 #define VID_TYPE_CHROMAKEY 16 /* Overlay by chromakey */
53 #define VID_TYPE_CLIPPING 32 /* Can clip */
54 #define VID_TYPE_FRAMERAM 64 /* Uses the frame buffer memory */
55 #define VID_TYPE_SCALES 128 /* Scalable */
56 #define VID_TYPE_MONOCHROME 256 /* Monochrome only */
57 #define VID_TYPE_SUBCAPTURE 512 /* Can capture subareas of the image */
58 #define VID_TYPE_MPEG_DECODER 1024 /* Can decode MPEG streams */
59 #define VID_TYPE_MPEG_ENCODER 2048 /* Can encode MPEG streams */
60 #define VID_TYPE_MJPEG_DECODER 4096 /* Can decode MJPEG streams */
61 #define VID_TYPE_MJPEG_ENCODER 8192 /* Can encode MJPEG streams */
62
63 struct video_capability
64 {
65 char name[32];
66 int type;
67 int channels; /* Num channels */
68 int audios; /* Num audio devices */
69 int maxwidth; /* Supported width */
70 int maxheight; /* And height */
71 int minwidth; /* Supported width */
72 int minheight; /* And height */
73 };
74
75
76 struct video_channel
77 {
78 int channel;
79 char name[32];
80 int tuners;
81 __u32 flags;
82 #define VIDEO_VC_TUNER 1 /* Channel has a tuner */
83 #define VIDEO_VC_AUDIO 2 /* Channel has audio */
84 __u16 type;
85 #define VIDEO_TYPE_TV 1
86 #define VIDEO_TYPE_CAMERA 2
87 __u16 norm; /* Norm set by channel */
88 };
89
90 struct video_tuner
91 {
92 int tuner;
93 char name[32];
94 ulong rangelow, rangehigh; /* Tuner range */
95 __u32 flags;
96 #define VIDEO_TUNER_PAL 1
97 #define VIDEO_TUNER_NTSC 2
98 #define VIDEO_TUNER_SECAM 4
99 #define VIDEO_TUNER_LOW 8 /* Uses KHz not MHz */
100 #define VIDEO_TUNER_NORM 16 /* Tuner can set norm */
101 #define VIDEO_TUNER_STEREO_ON 128 /* Tuner is seeing stereo */
102 #define VIDEO_TUNER_RDS_ON 256 /* Tuner is seeing an RDS datastream */
103 #define VIDEO_TUNER_MBS_ON 512 /* Tuner is seeing an MBS datastream */
104 __u16 mode; /* PAL/NTSC/SECAM/OTHER */
105 #define VIDEO_MODE_PAL 0
106 #define VIDEO_MODE_NTSC 1
107 #define VIDEO_MODE_SECAM 2
108 #define VIDEO_MODE_AUTO 3
109 __u16 signal; /* Signal strength 16bit scale */
110 };
111
112 struct video_picture
113 {
114 __u16 brightness;
115 __u16 hue;
116 __u16 colour;
117 __u16 contrast;
118 __u16 whiteness; /* Black and white only */
119 __u16 depth; /* Capture depth */
120 __u16 palette; /* Palette in use */
121 #define VIDEO_PALETTE_GREY 1 /* Linear greyscale */
122 #define VIDEO_PALETTE_HI240 2 /* High 240 cube (BT848) */
123 #define VIDEO_PALETTE_RGB565 3 /* 565 16 bit RGB */
124 #define VIDEO_PALETTE_RGB24 4 /* 24bit RGB */
125 #define VIDEO_PALETTE_RGB32 5 /* 32bit RGB */
126 #define VIDEO_PALETTE_RGB555 6 /* 555 15bit RGB */
127 #define VIDEO_PALETTE_YUV422 7 /* YUV422 capture */
128 #define VIDEO_PALETTE_YUYV 8
129 #define VIDEO_PALETTE_UYVY 9 /* The great thing about standards is ... */
130 #define VIDEO_PALETTE_YUV420 10
131 #define VIDEO_PALETTE_YUV411 11 /* YUV411 capture */
132 #define VIDEO_PALETTE_RAW 12 /* RAW capture (BT848) */
133 #define VIDEO_PALETTE_YUV422P 13 /* YUV 4:2:2 Planar */
134 #define VIDEO_PALETTE_YUV411P 14 /* YUV 4:1:1 Planar */
135 #define VIDEO_PALETTE_YUV420P 15 /* YUV 4:2:0 Planar */
136 #define VIDEO_PALETTE_YUV410P 16 /* YUV 4:1:0 Planar */
137 #define VIDEO_PALETTE_PLANAR 13 /* start of planar entries */
138 #define VIDEO_PALETTE_COMPONENT 7 /* start of component entries */
139 };
140
141 struct video_audio
142 {
143 int audio; /* Audio channel */
144 __u16 volume; /* If settable */
145 __u16 bass, treble;
146 __u32 flags;
147 #define VIDEO_AUDIO_MUTE 1
148 #define VIDEO_AUDIO_MUTABLE 2
149 #define VIDEO_AUDIO_VOLUME 4
150 #define VIDEO_AUDIO_BASS 8
151 #define VIDEO_AUDIO_TREBLE 16
152 char name[16];
153 #define VIDEO_SOUND_MONO 1
154 #define VIDEO_SOUND_STEREO 2
155 #define VIDEO_SOUND_LANG1 4
156 #define VIDEO_SOUND_LANG2 8
157 __u16 mode;
158 __u16 balance; /* Stereo balance */
159 __u16 step; /* Step actual volume uses */
160 };
161
162 struct video_clip
163 {
164 __s32 x,y;
165 __s32 width, height;
166 struct video_clip *next; /* For user use/driver use only */
167 };
168
169 struct video_window
170 {
171 __u32 x,y; /* Position of window */
172 __u32 width,height; /* Its size */
173 __u32 chromakey;
174 __u32 flags;
175 struct video_clip *clips; /* Set only */
176 int clipcount;
177 #define VIDEO_WINDOW_INTERLACE 1
178 #define VIDEO_WINDOW_CHROMAKEY 16 /* Overlay by chromakey */
179 #define VIDEO_CLIP_BITMAP -1
180 /* bitmap is 1024x625, a '1' bit represents a clipped pixel */
181 #define VIDEO_CLIPMAP_SIZE (128 * 625)
182 };
183
184 struct video_capture
185 {
186 __u32 x,y; /* Offsets into image */
187 __u32 width, height; /* Area to capture */
188 __u16 decimation; /* Decimation divder */
189 __u16 flags; /* Flags for capture */
190 #define VIDEO_CAPTURE_ODD 0 /* Temporal */
191 #define VIDEO_CAPTURE_EVEN 1
192 };
193
194 struct video_buffer
195 {
196 void *base;
197 int height,width;
198 int depth;
199 int bytesperline;
200 };
201
202 struct video_mmap
203 {
204 unsigned int frame; /* Frame (0 - n) for double buffer */
205 int height,width;
206 unsigned int format; /* should be VIDEO_PALETTE_* */
207 };
208
209 struct video_key
210 {
211 __u8 key[8];
212 __u32 flags;
213 };
214
215
216 #define VIDEO_MAX_FRAME 32
217
218 struct video_mbuf
219 {
220 int size; /* Total memory to map */
221 int frames; /* Frames */
222 int offsets[VIDEO_MAX_FRAME];
223 };
224
225
226 #define VIDEO_NO_UNIT (-1)
227
228
229 struct video_unit
230 {
231 int video; /* Video minor */
232 int vbi; /* VBI minor */
233 int radio; /* Radio minor */
234 int audio; /* Audio minor */
235 int teletext; /* Teletext minor */
236 };
237
238 struct vbi_format {
239 __u32 sampling_rate; /* in Hz */
240 __u32 samples_per_line;
241 __u32 sample_format; /* VIDEO_PALETTE_RAW only (1 byte) */
242 __s32 start[2]; /* starting line for each frame */
243 __u32 count[2]; /* count of lines for each frame */
244 __u32 flags;
245 #define VBI_UNSYNC 1 /* can distingues between top/bottom field */
246 #define VBI_INTERLACED 2 /* lines are interlaced */
247 };
248
249 /* video_info is biased towards hardware mpeg encode/decode */
250 /* but it could apply generically to any hardware compressor/decompressor */
251 struct video_info
252 {
253 __u32 frame_count; /* frames output since decode/encode began */
254 __u32 h_size; /* current unscaled horizontal size */
255 __u32 v_size; /* current unscaled veritcal size */
256 __u32 smpte_timecode; /* current SMPTE timecode (for current GOP) */
257 __u32 picture_type; /* current picture type */
258 __u32 temporal_reference; /* current temporal reference */
259 __u8 user_data[256]; /* user data last found in compressed stream */
260 /* user_data[0] contains user data flags, user_data[1] has count */
261 };
262
263 /* generic structure for setting playback modes */
264 struct video_play_mode
265 {
266 int mode;
267 int p1;
268 int p2;
269 };
270
271 /* for loading microcode / fpga programming */
272 struct video_code
273 {
274 char loadwhat[16]; /* name or tag of file being passed */
275 int datasize;
276 __u8 *data;
277 };
278
279 #define VIDIOCGCAP _IOR('v',1,struct video_capability) /* Get capabilities */
280 #define VIDIOCGCHAN _IOWR('v',2,struct video_channel) /* Get channel info (sources) */
281 #define VIDIOCSCHAN _IOW('v',3,struct video_channel) /* Set channel */
282 #define VIDIOCGTUNER _IOWR('v',4,struct video_tuner) /* Get tuner abilities */
283 #define VIDIOCSTUNER _IOW('v',5,struct video_tuner) /* Tune the tuner for the current channel */
284 #define VIDIOCGPICT _IOR('v',6,struct video_picture) /* Get picture properties */
285 #define VIDIOCSPICT _IOW('v',7,struct video_picture) /* Set picture properties */
286 #define VIDIOCCAPTURE _IOW('v',8,int) /* Start, end capture */
287 #define VIDIOCGWIN _IOR('v',9, struct video_window) /* Get the video overlay window */
288 #define VIDIOCSWIN _IOW('v',10, struct video_window) /* Set the video overlay window - passes clip list for hardware smarts , chromakey etc */
289 #define VIDIOCGFBUF _IOR('v',11, struct video_buffer) /* Get frame buffer */
290 #define VIDIOCSFBUF _IOW('v',12, struct video_buffer) /* Set frame buffer - root only */
291 #define VIDIOCKEY _IOR('v',13, struct video_key) /* Video key event - to dev 255 is to all - cuts capture on all DMA windows with this key (0xFFFFFFFF == all) */
292 #define VIDIOCGFREQ _IOR('v',14, unsigned long) /* Set tuner */
293 #define VIDIOCSFREQ _IOW('v',15, unsigned long) /* Set tuner */
294 #define VIDIOCGAUDIO _IOR('v',16, struct video_audio) /* Get audio info */
295 #define VIDIOCSAUDIO _IOW('v',17, struct video_audio) /* Audio source, mute etc */
296 #define VIDIOCSYNC _IOW('v',18, int) /* Sync with mmap grabbing */
297 #define VIDIOCMCAPTURE _IOW('v',19, struct video_mmap) /* Grab frames */
298 #define VIDIOCGMBUF _IOR('v',20, struct video_mbuf) /* Memory map buffer info */
299 #define VIDIOCGUNIT _IOR('v',21, struct video_unit) /* Get attached units */
300 #define VIDIOCGCAPTURE _IOR('v',22, struct video_capture) /* Get subcapture */
301 #define VIDIOCSCAPTURE _IOW('v',23, struct video_capture) /* Set subcapture */
302 #define VIDIOCSPLAYMODE _IOW('v',24, struct video_play_mode) /* Set output video mode/feature */
303 #define VIDIOCSWRITEMODE _IOW('v',25, int) /* Set write mode */
304 #define VIDIOCGPLAYINFO _IOR('v',26, struct video_info) /* Get current playback info from hardware */
305 #define VIDIOCSMICROCODE _IOW('v',27, struct video_code) /* Load microcode into hardware */
306 #define VIDIOCGVBIFMT _IOR('v',28, struct vbi_format) /* Get VBI information */
307 #define VIDIOCSVBIFMT _IOW('v',29, struct vbi_format) /* Set VBI information */
308
309
310 #define BASE_VIDIOCPRIVATE 192 /* 192-255 are private */
311
312 /* VIDIOCSWRITEMODE */
313 #define VID_WRITE_MPEG_AUD 0
314 #define VID_WRITE_MPEG_VID 1
315 #define VID_WRITE_OSD 2
316 #define VID_WRITE_TTX 3
317 #define VID_WRITE_CC 4
318 #define VID_WRITE_MJPEG 5
319
320 /* VIDIOCSPLAYMODE */
321 #define VID_PLAY_VID_OUT_MODE 0
322 /* p1: = VIDEO_MODE_PAL, VIDEO_MODE_NTSC, etc ... */
323 #define VID_PLAY_GENLOCK 1
324 /* p1: 0 = OFF, 1 = ON */
325 /* p2: GENLOCK FINE DELAY value */
326 #define VID_PLAY_NORMAL 2
327 #define VID_PLAY_PAUSE 3
328 #define VID_PLAY_SINGLE_FRAME 4
329 #define VID_PLAY_FAST_FORWARD 5
330 #define VID_PLAY_SLOW_MOTION 6
331 #define VID_PLAY_IMMEDIATE_NORMAL 7
332 #define VID_PLAY_SWITCH_CHANNELS 8
333 #define VID_PLAY_FREEZE_FRAME 9
334 #define VID_PLAY_STILL_MODE 10
335 #define VID_PLAY_MASTER_MODE 11
336 /* p1: see below */
337 #define VID_PLAY_MASTER_NONE 1
338 #define VID_PLAY_MASTER_VIDEO 2
339 #define VID_PLAY_MASTER_AUDIO 3
340 #define VID_PLAY_ACTIVE_SCANLINES 12
341 /* p1 = first active; p2 = last active */
342 #define VID_PLAY_RESET 13
343 #define VID_PLAY_END_MARK 14
344
345
346
347 #define VID_HARDWARE_BT848 1
348 #define VID_HARDWARE_QCAM_BW 2
349 #define VID_HARDWARE_PMS 3
350 #define VID_HARDWARE_QCAM_C 4
351 #define VID_HARDWARE_PSEUDO 5
352 #define VID_HARDWARE_SAA5249 6
353 #define VID_HARDWARE_AZTECH 7
354 #define VID_HARDWARE_SF16MI 8
355 #define VID_HARDWARE_RTRACK 9
356 #define VID_HARDWARE_ZOLTRIX 10
357 #define VID_HARDWARE_SAA7146 11
358 #define VID_HARDWARE_VIDEUM 12 /* Reserved for Winnov videum */
359 #define VID_HARDWARE_RTRACK2 13
360 #define VID_HARDWARE_PERMEDIA2 14 /* Reserved for Permedia2 */
361 #define VID_HARDWARE_RIVA128 15 /* Reserved for RIVA 128 */
362 #define VID_HARDWARE_PLANB 16 /* PowerMac motherboard video-in */
363 #define VID_HARDWARE_BROADWAY 17 /* Broadway project */
364 #define VID_HARDWARE_GEMTEK 18
365 #define VID_HARDWARE_TYPHOON 19
366 #define VID_HARDWARE_VINO 20 /* SGI Indy Vino */
367 #define VID_HARDWARE_CADET 21 /* Cadet radio */
368 #define VID_HARDWARE_TRUST 22 /* Trust FM Radio */
369 #define VID_HARDWARE_TERRATEC 23 /* TerraTec ActiveRadio */
370 #define VID_HARDWARE_CPIA 24
371 #define VID_HARDWARE_ZR36120 25 /* Zoran ZR36120/ZR36125 */
372 #define VID_HARDWARE_ZR36067 26 /* Zoran ZR36067/36060 */
373 #define VID_HARDWARE_OV511 27
374 #define VID_HARDWARE_ZR356700 28 /* Zoran 36700 series */
375 #define VID_HARDWARE_W9966 29
376 #define VID_HARDWARE_SE401 30 /* SE401 USB webcams */
377 #define VID_HARDWARE_PWC 31 /* Philips webcams */
378 #define VID_HARDWARE_MEYE 32 /* Sony Vaio MotionEye cameras */
379 #define VID_HARDWARE_CPIA2 33
380
381 /*
382 * Initialiser list
383 */
384
385 struct video_init
386 {
387 char *name;
388 int (*init)(struct video_init *);
389 };
390
391 #endif
392