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