Move grabbers definitions to a separate file, vgrabbers.c, so it is easier
[asterisk/asterisk.git] / channels / vgrabbers.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright 2007, Luigi Rizzo 
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*
18  * Video grabbers used in console_video.
19  *
20  * $Revision$
21  *
22  * Each grabber is implemented through open/read/close calls,
23  * plus an additional move() function used e.g. to change origin
24  * for the X grabber (this may be extended in the future to support
25  * more controls e.g. resolution changes etc.).
26  *
27  * open() should try to open and initialize the grabber, returning NULL on error.
28  * On success it allocates a descriptor for its private data (including
29  * a buffer for the video) and returns a pointer to the descriptor.
30  * read() will return NULL on failure, or a pointer to a buffer with data
31  * on success.
32  * close() should release resources.
33  * move() is optional.
34  * For more details look at the X11 grabber below.
35  *
36  * NOTE: at the moment we expect uncompressed video frames in YUV format,
37  * because this is what current sources supply and also is a convenient
38  * format for display. It is conceivable that one might want to support
39  * an already compressed stream, in which case we should redesign the
40  * pipeline used for the local source, which at the moment is
41  *
42  *                        .->--[loc_dpy]
43  *   [src]-->--[enc_in]--+
44  *                        `->--[enc_out]
45  */
46
47 #include "asterisk.h"
48 #include <sys/ioctl.h>
49 #include "asterisk/file.h"
50 #include "asterisk/utils.h"     /* ast_calloc */
51
52 #include "console_video.h"
53
54 #if defined(HAVE_VIDEO_CONSOLE)
55
56 #ifdef HAVE_X11
57
58 /* A simple X11 grabber, supporting only truecolor formats */
59
60 #include <X11/Xlib.h>
61
62 /*! \brief internal info used by the X11 grabber */
63 struct grab_x11_desc {
64         Display         *dpy;
65         XImage          *image;
66         int             screen_width;   /* width of X screen */
67         int             screen_height;  /* height of X screen */
68         struct fbuf_t   b;              /* geometry and pointer into the XImage */
69 };
70
71 /*! \brief open the grabber.
72  * We use the special name 'X11' to indicate this grabber.
73  */
74 static void *grab_x11_open(const char *name, struct fbuf_t *geom, int fps)
75 {
76         XImage *im;
77         int screen_num;
78         struct grab_x11_desc *v;
79         struct fbuf_t *b;
80
81         if (strcasecmp(name, "X11"))
82                 return NULL;    /* not us */
83         v = ast_calloc(1, sizeof(*v));
84         if (v == NULL)
85                 return NULL;    /* no memory */
86
87         /* init the connection with the X server */
88         v->dpy = XOpenDisplay(NULL);
89         if (v->dpy == NULL) {
90                 ast_log(LOG_WARNING, "error opening display\n");
91                 goto error;
92         }
93
94         v->b = *geom;   /* copy geometry */
95         b = &v->b;      /* shorthand */
96         /* find width and height of the screen */
97         screen_num = DefaultScreen(v->dpy);
98         v->screen_width = DisplayWidth(v->dpy, screen_num);
99         v->screen_height = DisplayHeight(v->dpy, screen_num);
100
101         v->image = im = XGetImage(v->dpy,
102                 RootWindow(v->dpy, DefaultScreen(v->dpy)),
103                 b->x, b->y, b->w, b->h, AllPlanes, ZPixmap);
104         if (v->image == NULL) {
105                 ast_log(LOG_WARNING, "error creating Ximage\n");
106                 goto error;
107         }
108         switch (im->bits_per_pixel) {
109         case 32:
110                 b->pix_fmt = PIX_FMT_RGBA32;
111                 break;
112         case 16:
113                 b->pix_fmt = (im->green_mask == 0x7e0) ? PIX_FMT_RGB565 : PIX_FMT_RGB555;
114                 break;
115         }
116
117         ast_log(LOG_NOTICE, "image: data %p %d bpp fmt %d, mask 0x%lx 0x%lx 0x%lx\n",
118                 im->data,
119                 im->bits_per_pixel,
120                 b->pix_fmt,
121                 im->red_mask, im->green_mask, im->blue_mask);
122
123         /* set the pointer but not the size as this is not malloc'ed */
124         b->data = (uint8_t *)im->data;
125         return v;
126
127 error:
128         /* XXX maybe XDestroy (v->image) ? */
129         if (v->dpy)
130                 XCloseDisplay(v->dpy);
131         v->dpy = NULL;
132         ast_free(v);
133         return NULL;
134 }
135
136 static struct fbuf_t *grab_x11_read(void *desc)
137 {
138         /* read frame from X11 */
139         struct grab_x11_desc *v = desc;
140         struct fbuf_t *b = &v->b;
141
142         XGetSubImage(v->dpy,
143                 RootWindow(v->dpy, DefaultScreen(v->dpy)),
144                         b->x, b->y, b->w, b->h, AllPlanes, ZPixmap, v->image, 0, 0);
145
146         b->data = (uint8_t *)v->image->data;
147         return b;
148 }
149
150 static int boundary_checks(int x, int limit)
151 {
152         return (x <= 0) ? 0 : (x > limit ? limit : x);
153 }
154
155 /*! \brief move the origin for the grabbed area, making sure we do not
156  * overflow the screen.
157  */
158 static void grab_x11_move(void *desc, int dx, int dy)
159 {
160         struct grab_x11_desc *v = desc;
161
162         v->b.x = boundary_checks(v->b.x + dx, v->screen_width - v->b.w);
163         v->b.y = boundary_checks(v->b.y + dy, v->screen_height - v->b.h);
164 }
165
166 /*! \brief disconnect from the server and release memory */
167 static void *grab_x11_close(void *desc)
168 {
169         struct grab_x11_desc *v = desc;
170
171         XCloseDisplay(v->dpy);
172         v->dpy = NULL;
173         v->image = NULL;
174         ast_free(v);
175         return NULL;
176 }
177
178 static struct grab_desc grab_x11_desc = {
179         .name = "X11",
180         .open = grab_x11_open,
181         .read = grab_x11_read,
182         .move = grab_x11_move,
183         .close = grab_x11_close,
184 };
185 #endif  /* HAVE_X11 */
186
187 #ifdef HAVE_VIDEODEV_H
188 #include <linux/videodev.h>     /* Video4Linux stuff is only used in grab_v4l1_open() */
189
190 struct grab_v4l1_desc {
191         int fd;                 /* device handle */
192         struct fbuf_t   b;      /* buffer (allocated) with grabbed image */
193 };
194
195 /*! \brief
196  * Open the local video source and allocate a buffer
197  * for storing the image.
198  */
199 static void *grab_v4l1_open(const char *dev, struct fbuf_t *geom, int fps)
200 {
201         struct video_window vw = { 0 }; /* camera attributes */
202         struct video_picture vp;
203         int fd, i;
204         struct grab_v4l1_desc *v;
205         struct fbuf_t *b;
206
207         fd = open(dev, O_RDONLY | O_NONBLOCK);
208         if (fd < 0) {
209                 ast_log(LOG_WARNING, "error opening camera %s\n", dev);
210                 return NULL;
211         }
212
213         v = ast_calloc(1, sizeof(*v));
214         if (v == NULL) {
215                 ast_log(LOG_WARNING, "no memory for camera %s\n", dev);
216                 close(fd);
217                 return NULL;    /* no memory */
218         }
219         v->fd = fd;
220         v->b = *geom;
221         b = &v->b;      /* shorthand */
222
223         i = fcntl(fd, F_GETFL);
224         if (-1 == fcntl(fd, F_SETFL, i | O_NONBLOCK)) {
225                 /* non fatal, just emit a warning */
226                 ast_log(LOG_WARNING, "error F_SETFL for %s [%s]\n",
227                         dev, strerror(errno));
228         }
229         /* set format for the camera.
230          * In principle we could retry with a different format if the
231          * one we are asking for is not supported.
232          */
233         vw.width = b->w;
234         vw.height = b->h;
235         vw.flags = fps << 16;
236         if (ioctl(fd, VIDIOCSWIN, &vw) == -1) {
237                 ast_log(LOG_WARNING, "error setting format for %s [%s]\n",
238                         dev, strerror(errno));
239                 goto error;
240         }
241         if (ioctl(fd, VIDIOCGPICT, &vp) == -1) {
242                 ast_log(LOG_WARNING, "error reading picture info\n");
243                 goto error;
244         }
245         ast_log(LOG_WARNING,
246                 "contrast %d bright %d colour %d hue %d white %d palette %d\n",
247                 vp.contrast, vp.brightness,
248                 vp.colour, vp.hue,
249                 vp.whiteness, vp.palette);
250         /* set the video format. Here again, we don't necessary have to
251          * fail if the required format is not supported, but try to use
252          * what the camera gives us.
253          */
254         b->pix_fmt = vp.palette;
255         vp.palette = VIDEO_PALETTE_YUV420P;
256         if (ioctl(v->fd, VIDIOCSPICT, &vp) == -1) {
257                 ast_log(LOG_WARNING, "error setting palette, using %d\n",
258                         b->pix_fmt);
259         } else
260                 b->pix_fmt = vp.palette;
261         /* allocate the source buffer.
262          * XXX, the code here only handles yuv411, for other formats
263          * we need to look at pix_fmt and set size accordingly
264          */
265         b->size = (b->w * b->h * 3)/2;  /* yuv411 */
266         ast_log(LOG_WARNING, "videodev %s opened, size %dx%d %d\n",
267                 dev, b->w, b->h, b->size);
268         b->data = ast_calloc(1, b->size);
269         if (!b->data) {
270                 ast_log(LOG_WARNING, "error allocating buffer %d bytes\n",
271                         b->size);
272                 goto error;
273         }
274         ast_log(LOG_WARNING, "success opening camera\n");
275         return v;
276
277 error:
278         close(v->fd);
279         fbuf_free(b);
280         ast_free(v);
281         return NULL;
282 }
283
284 /*! \brief read until error, no data or buffer full.
285  * This might be blocking but no big deal since we are in the
286  * display thread.
287  */
288 static struct fbuf_t *grab_v4l1_read(void *desc)
289 {
290         struct grab_v4l1_desc *v = desc;
291         struct fbuf_t *b = &v->b;
292         for (;;) {
293                 int r, l = b->size - b->used;
294                 r = read(v->fd, b->data + b->used, l);
295                 // ast_log(LOG_WARNING, "read %d of %d bytes from webcam\n", r, l);
296                 if (r < 0)      /* read error */
297                         break;
298                 if (r == 0)     /* no data */
299                         break;
300                 b->used += r;
301                 if (r == l) {
302                         b->used = 0; /* prepare for next frame */
303                         return b;
304                 }
305         }
306         return NULL;
307 }
308
309 static void *grab_v4l1_close(void *desc)
310 {
311         struct grab_v4l1_desc *v = desc;
312
313         close(v->fd);
314         v->fd = -1;
315         fbuf_free(&v->b);
316         ast_free(v);
317         return NULL;
318 }
319
320 /*! \brief our descriptor. We don't have .move */
321 static struct grab_desc grab_v4l1_desc = {
322         .name = "v4l1",
323         .open = grab_v4l1_open,
324         .read = grab_v4l1_read,
325         .close = grab_v4l1_close,
326 };
327 #endif /* HAVE_VIDEODEV_H */
328
329 /*
330  * Here you can add more grabbers, e.g. V4L2, firewire,
331  * a file, a still image...
332  */
333
334 /*! \brief The list of grabbers supported, with a NULL at the end */
335 struct grab_desc *console_grabbers[] = {
336 #ifdef HAVE_X11
337         &grab_x11_desc,
338 #endif
339 #ifdef HAVE_VIDEODEV_H
340         &grab_v4l1_desc,
341 #endif
342         NULL
343 };
344
345 #endif /* HAVE_VIDEO_CONSOLE */