x11grab: add follow_mouse AVOption.
[ffmpeg.git] / libavdevice / x11grab.c
1 /*
2  * X11 video grab interface
3  *
4  * This file is part of Libav.
5  *
6  * Libav integration:
7  * Copyright (C) 2006 Clemens Fruhwirth <clemens@endorphin.org>
8  *                    Edouard Gomez <ed.gomez@free.fr>
9  *
10  * This file contains code from grab.c:
11  * Copyright (c) 2000-2001 Fabrice Bellard
12  *
13  * This file contains code from the xvidcap project:
14  * Copyright (C) 1997-1998 Rasca, Berlin
15  *               2003-2004 Karl H. Beckers, Frankfurt
16  *
17  * Libav is free software; you can redistribute it and/or modify
18  * it under the terms of the GNU General Public License as published by
19  * the Free Software Foundation; either version 2 of the License, or
20  * (at your option) any later version.
21  *
22  * Libav is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with Libav; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30  */
31
32 /**
33  * @file
34  * X11 frame device demuxer by Clemens Fruhwirth <clemens@endorphin.org>
35  * and Edouard Gomez <ed.gomez@free.fr>.
36  */
37
38 #include "config.h"
39 #include "libavformat/avformat.h"
40 #include "libavutil/log.h"
41 #include "libavutil/opt.h"
42 #include "libavutil/parseutils.h"
43 #include <time.h>
44 #include <X11/X.h>
45 #include <X11/Xlib.h>
46 #include <X11/Xlibint.h>
47 #include <X11/Xproto.h>
48 #include <X11/Xutil.h>
49 #include <sys/shm.h>
50 #include <X11/extensions/XShm.h>
51 #include <X11/extensions/Xfixes.h>
52
53 /**
54  * X11 Device Demuxer context
55  */
56 struct x11_grab
57 {
58     const AVClass *class;    /**< Class for private options. */
59     int frame_size;          /**< Size in bytes of a grabbed frame */
60     AVRational time_base;    /**< Time base */
61     int64_t time_frame;      /**< Current time */
62
63     char *video_size;        /**< String describing video size, set by a private option. */
64     int height;              /**< Height of the grab frame */
65     int width;               /**< Width of the grab frame */
66     int x_off;               /**< Horizontal top-left corner coordinate */
67     int y_off;               /**< Vertical top-left corner coordinate */
68
69     Display *dpy;            /**< X11 display from which x11grab grabs frames */
70     XImage *image;           /**< X11 image holding the grab */
71     int use_shm;             /**< !0 when using XShm extension */
72     XShmSegmentInfo shminfo; /**< When using XShm, keeps track of XShm infos */
73     int  draw_mouse;         /**< Set by a private option. */
74     int  follow_mouse;       /**< Set by a private option. */
75     char *framerate;         /**< Set by a private option. */
76 };
77
78 /**
79  * Initialize the x11 grab device demuxer (public device demuxer API).
80  *
81  * @param s1 Context from avformat core
82  * @param ap Parameters from avformat core
83  * @return <ul>
84  *          <li>AVERROR(ENOMEM) no memory left</li>
85  *          <li>AVERROR(EIO) other failure case</li>
86  *          <li>0 success</li>
87  *         </ul>
88  */
89 static int
90 x11grab_read_header(AVFormatContext *s1, AVFormatParameters *ap)
91 {
92     struct x11_grab *x11grab = s1->priv_data;
93     Display *dpy;
94     AVStream *st = NULL;
95     enum PixelFormat input_pixfmt;
96     XImage *image;
97     int x_off = 0;
98     int y_off = 0;
99     int screen;
100     int use_shm;
101     char *param, *offset;
102     int ret = 0;
103     AVRational framerate;
104
105     param = av_strdup(s1->filename);
106     offset = strchr(param, '+');
107     if (offset) {
108         sscanf(offset, "%d,%d", &x_off, &y_off);
109         x11grab->draw_mouse = !strstr(offset, "nomouse");
110         *offset= 0;
111     }
112
113     if ((ret = av_parse_video_size(&x11grab->width, &x11grab->height, x11grab->video_size)) < 0) {
114         av_log(s1, AV_LOG_ERROR, "Couldn't parse video size.\n");
115         goto out;
116     }
117     if ((ret = av_parse_video_rate(&framerate, x11grab->framerate)) < 0) {
118         av_log(s1, AV_LOG_ERROR, "Could not parse framerate: %s.\n", x11grab->framerate);
119         goto out;
120     }
121 #if FF_API_FORMAT_PARAMETERS
122     if (ap->width > 0)
123         x11grab->width = ap->width;
124     if (ap->height > 0)
125         x11grab->height = ap->height;
126     if (ap->time_base.num)
127         framerate = (AVRational){ap->time_base.den, ap->time_base.num};
128 #endif
129     av_log(s1, AV_LOG_INFO, "device: %s -> display: %s x: %d y: %d width: %d height: %d\n",
130            s1->filename, param, x_off, y_off, x11grab->width, x11grab->height);
131
132     dpy = XOpenDisplay(param);
133     if(!dpy) {
134         av_log(s1, AV_LOG_ERROR, "Could not open X display.\n");
135         ret = AVERROR(EIO);
136         goto out;
137     }
138
139     st = av_new_stream(s1, 0);
140     if (!st) {
141         ret = AVERROR(ENOMEM);
142         goto out;
143     }
144     av_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in us */
145
146     screen = DefaultScreen(dpy);
147
148     if (x11grab->follow_mouse) {
149         int screen_w, screen_h;
150         Window w;
151
152         screen_w = DisplayWidth(dpy, screen);
153         screen_h = DisplayHeight(dpy, screen);
154         XQueryPointer(dpy, RootWindow(dpy, screen), &w, &w, &x_off, &y_off, &ret, &ret, &ret);
155         x_off -= x11grab->width / 2;
156         y_off -= x11grab->height / 2;
157         x_off = FFMIN(FFMAX(x_off, 0), screen_w - x11grab->width);
158         y_off = FFMIN(FFMAX(y_off, 0), screen_h - x11grab->height);
159         av_log(s1, AV_LOG_INFO, "followmouse is enabled, resetting grabbing region to x: %d y: %d\n", x_off, y_off);
160     }
161
162     use_shm = XShmQueryExtension(dpy);
163     av_log(s1, AV_LOG_INFO, "shared memory extension %s found\n", use_shm ? "" : "not");
164
165     if(use_shm) {
166         int scr = XDefaultScreen(dpy);
167         image = XShmCreateImage(dpy,
168                                 DefaultVisual(dpy, scr),
169                                 DefaultDepth(dpy, scr),
170                                 ZPixmap,
171                                 NULL,
172                                 &x11grab->shminfo,
173                                 x11grab->width, x11grab->height);
174         x11grab->shminfo.shmid = shmget(IPC_PRIVATE,
175                                         image->bytes_per_line * image->height,
176                                         IPC_CREAT|0777);
177         if (x11grab->shminfo.shmid == -1) {
178             av_log(s1, AV_LOG_ERROR, "Fatal: Can't get shared memory!\n");
179             ret = AVERROR(ENOMEM);
180             goto out;
181         }
182         x11grab->shminfo.shmaddr = image->data = shmat(x11grab->shminfo.shmid, 0, 0);
183         x11grab->shminfo.readOnly = False;
184
185         if (!XShmAttach(dpy, &x11grab->shminfo)) {
186             av_log(s1, AV_LOG_ERROR, "Fatal: Failed to attach shared memory!\n");
187             /* needs some better error subroutine :) */
188             ret = AVERROR(EIO);
189             goto out;
190         }
191     } else {
192         image = XGetImage(dpy, RootWindow(dpy, screen),
193                           x_off,y_off,
194                           x11grab->width, x11grab->height,
195                           AllPlanes, ZPixmap);
196     }
197
198     switch (image->bits_per_pixel) {
199     case 8:
200         av_log (s1, AV_LOG_DEBUG, "8 bit palette\n");
201         input_pixfmt = PIX_FMT_PAL8;
202         break;
203     case 16:
204         if (       image->red_mask   == 0xf800 &&
205                    image->green_mask == 0x07e0 &&
206                    image->blue_mask  == 0x001f ) {
207             av_log (s1, AV_LOG_DEBUG, "16 bit RGB565\n");
208             input_pixfmt = PIX_FMT_RGB565;
209         } else if (image->red_mask   == 0x7c00 &&
210                    image->green_mask == 0x03e0 &&
211                    image->blue_mask  == 0x001f ) {
212             av_log(s1, AV_LOG_DEBUG, "16 bit RGB555\n");
213             input_pixfmt = PIX_FMT_RGB555;
214         } else {
215             av_log(s1, AV_LOG_ERROR, "RGB ordering at image depth %i not supported ... aborting\n", image->bits_per_pixel);
216             av_log(s1, AV_LOG_ERROR, "color masks: r 0x%.6lx g 0x%.6lx b 0x%.6lx\n", image->red_mask, image->green_mask, image->blue_mask);
217             ret = AVERROR(EIO);
218             goto out;
219         }
220         break;
221     case 24:
222         if (        image->red_mask   == 0xff0000 &&
223                     image->green_mask == 0x00ff00 &&
224                     image->blue_mask  == 0x0000ff ) {
225             input_pixfmt = PIX_FMT_BGR24;
226         } else if ( image->red_mask   == 0x0000ff &&
227                     image->green_mask == 0x00ff00 &&
228                     image->blue_mask  == 0xff0000 ) {
229             input_pixfmt = PIX_FMT_RGB24;
230         } else {
231             av_log(s1, AV_LOG_ERROR,"rgb ordering at image depth %i not supported ... aborting\n", image->bits_per_pixel);
232             av_log(s1, AV_LOG_ERROR, "color masks: r 0x%.6lx g 0x%.6lx b 0x%.6lx\n", image->red_mask, image->green_mask, image->blue_mask);
233             ret = AVERROR(EIO);
234             goto out;
235         }
236         break;
237     case 32:
238         input_pixfmt = PIX_FMT_RGB32;
239         break;
240     default:
241         av_log(s1, AV_LOG_ERROR, "image depth %i not supported ... aborting\n", image->bits_per_pixel);
242         ret = AVERROR(EINVAL);
243         goto out;
244     }
245
246     x11grab->frame_size = x11grab->width * x11grab->height * image->bits_per_pixel/8;
247     x11grab->dpy = dpy;
248     x11grab->time_base  = (AVRational){framerate.den, framerate.num};
249     x11grab->time_frame = av_gettime() / av_q2d(x11grab->time_base);
250     x11grab->x_off = x_off;
251     x11grab->y_off = y_off;
252     x11grab->image = image;
253     x11grab->use_shm = use_shm;
254
255     st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
256     st->codec->codec_id = CODEC_ID_RAWVIDEO;
257     st->codec->width  = x11grab->width;
258     st->codec->height = x11grab->height;
259     st->codec->pix_fmt = input_pixfmt;
260     st->codec->time_base = x11grab->time_base;
261     st->codec->bit_rate = x11grab->frame_size * 1/av_q2d(x11grab->time_base) * 8;
262
263 out:
264     return ret;
265 }
266
267 /**
268  * Paint a mouse pointer in an X11 image.
269  *
270  * @param image image to paint the mouse pointer to
271  * @param s context used to retrieve original grabbing rectangle
272  *          coordinates
273  */
274 static void
275 paint_mouse_pointer(XImage *image, struct x11_grab *s)
276 {
277     int x_off = s->x_off;
278     int y_off = s->y_off;
279     int width = s->width;
280     int height = s->height;
281     Display *dpy = s->dpy;
282     XFixesCursorImage *xcim;
283     int x, y;
284     int line, column;
285     int to_line, to_column;
286     int pixstride = image->bits_per_pixel >> 3;
287     /* Warning: in its insanity, xlib provides unsigned image data through a
288      * char* pointer, so we have to make it uint8_t to make things not break.
289      * Anyone who performs further investigation of the xlib API likely risks
290      * permanent brain damage. */
291     uint8_t *pix = image->data;
292
293     /* Code doesn't currently support 16-bit or PAL8 */
294     if (image->bits_per_pixel != 24 && image->bits_per_pixel != 32)
295         return;
296
297     xcim = XFixesGetCursorImage(dpy);
298
299     x = xcim->x - xcim->xhot;
300     y = xcim->y - xcim->yhot;
301
302     to_line = FFMIN((y + xcim->height), (height + y_off));
303     to_column = FFMIN((x + xcim->width), (width + x_off));
304
305     for (line = FFMAX(y, y_off); line < to_line; line++) {
306         for (column = FFMAX(x, x_off); column < to_column; column++) {
307             int  xcim_addr = (line - y) * xcim->width + column - x;
308             int image_addr = ((line - y_off) * width + column - x_off) * pixstride;
309             int r = (uint8_t)(xcim->pixels[xcim_addr] >>  0);
310             int g = (uint8_t)(xcim->pixels[xcim_addr] >>  8);
311             int b = (uint8_t)(xcim->pixels[xcim_addr] >> 16);
312             int a = (uint8_t)(xcim->pixels[xcim_addr] >> 24);
313
314             if (a == 255) {
315                 pix[image_addr+0] = r;
316                 pix[image_addr+1] = g;
317                 pix[image_addr+2] = b;
318             } else if (a) {
319                 /* pixel values from XFixesGetCursorImage come premultiplied by alpha */
320                 pix[image_addr+0] = r + (pix[image_addr+0]*(255-a) + 255/2) / 255;
321                 pix[image_addr+1] = g + (pix[image_addr+1]*(255-a) + 255/2) / 255;
322                 pix[image_addr+2] = b + (pix[image_addr+2]*(255-a) + 255/2) / 255;
323             }
324         }
325     }
326
327     XFree(xcim);
328     xcim = NULL;
329 }
330
331
332 /**
333  * Read new data in the image structure.
334  *
335  * @param dpy X11 display to grab from
336  * @param d
337  * @param image Image where the grab will be put
338  * @param x Top-Left grabbing rectangle horizontal coordinate
339  * @param y Top-Left grabbing rectangle vertical coordinate
340  * @return 0 if error, !0 if successful
341  */
342 static int
343 xget_zpixmap(Display *dpy, Drawable d, XImage *image, int x, int y)
344 {
345     xGetImageReply rep;
346     xGetImageReq *req;
347     long nbytes;
348
349     if (!image) {
350         return 0;
351     }
352
353     LockDisplay(dpy);
354     GetReq(GetImage, req);
355
356     /* First set up the standard stuff in the request */
357     req->drawable = d;
358     req->x = x;
359     req->y = y;
360     req->width = image->width;
361     req->height = image->height;
362     req->planeMask = (unsigned int)AllPlanes;
363     req->format = ZPixmap;
364
365     if (!_XReply(dpy, (xReply *)&rep, 0, xFalse) || !rep.length) {
366         UnlockDisplay(dpy);
367         SyncHandle();
368         return 0;
369     }
370
371     nbytes = (long)rep.length << 2;
372     _XReadPad(dpy, image->data, nbytes);
373
374     UnlockDisplay(dpy);
375     SyncHandle();
376     return 1;
377 }
378
379 /**
380  * Grab a frame from x11 (public device demuxer API).
381  *
382  * @param s1 Context from avformat core
383  * @param pkt Packet holding the brabbed frame
384  * @return frame size in bytes
385  */
386 static int
387 x11grab_read_packet(AVFormatContext *s1, AVPacket *pkt)
388 {
389     struct x11_grab *s = s1->priv_data;
390     Display *dpy = s->dpy;
391     XImage *image = s->image;
392     int x_off = s->x_off;
393     int y_off = s->y_off;
394
395     int screen;
396     Window root;
397     int follow_mouse = s->follow_mouse;
398
399     int64_t curtime, delay;
400     struct timespec ts;
401
402     /* Calculate the time of the next frame */
403     s->time_frame += INT64_C(1000000);
404
405     /* wait based on the frame rate */
406     for(;;) {
407         curtime = av_gettime();
408         delay = s->time_frame * av_q2d(s->time_base) - curtime;
409         if (delay <= 0) {
410             if (delay < INT64_C(-1000000) * av_q2d(s->time_base)) {
411                 s->time_frame += INT64_C(1000000);
412             }
413             break;
414         }
415         ts.tv_sec = delay / 1000000;
416         ts.tv_nsec = (delay % 1000000) * 1000;
417         nanosleep(&ts, NULL);
418     }
419
420     av_init_packet(pkt);
421     pkt->data = image->data;
422     pkt->size = s->frame_size;
423     pkt->pts = curtime;
424
425     screen = DefaultScreen(dpy);
426     root = RootWindow(dpy, screen);
427     if (follow_mouse) {
428         int screen_w, screen_h;
429         int pointer_x, pointer_y, _;
430         Window w;
431
432         screen_w = DisplayWidth(dpy, screen);
433         screen_h = DisplayHeight(dpy, screen);
434         XQueryPointer(dpy, root, &w, &w, &pointer_x, &pointer_y, &_, &_, &_);
435         if (follow_mouse == -1) {
436             // follow the mouse, put it at center of grabbing region
437             x_off += pointer_x - s->width  / 2 - x_off;
438             y_off += pointer_y - s->height / 2 - y_off;
439         } else {
440             // follow the mouse, but only move the grabbing region when mouse
441             // reaches within certain pixels to the edge.
442             if (pointer_x > x_off + s->width - follow_mouse) {
443                 x_off += pointer_x - (x_off + s->width - follow_mouse);
444             } else if (pointer_x < x_off + follow_mouse)
445                 x_off -= (x_off + follow_mouse) - pointer_x;
446             if (pointer_y > y_off + s->height - follow_mouse) {
447                 y_off += pointer_y - (y_off + s->height - follow_mouse);
448             } else if (pointer_y < y_off + follow_mouse)
449                 y_off -= (y_off + follow_mouse) - pointer_y;
450         }
451         // adjust grabbing region position if it goes out of screen.
452         s->x_off = x_off = FFMIN(FFMAX(x_off, 0), screen_w - s->width);
453         s->y_off = y_off = FFMIN(FFMAX(y_off, 0), screen_h - s->height);
454     }
455
456     if(s->use_shm) {
457         if (!XShmGetImage(dpy, root, image, x_off, y_off, AllPlanes)) {
458             av_log (s1, AV_LOG_INFO, "XShmGetImage() failed\n");
459         }
460     } else {
461         if (!xget_zpixmap(dpy, root, image, x_off, y_off)) {
462             av_log (s1, AV_LOG_INFO, "XGetZPixmap() failed\n");
463         }
464     }
465
466     if (s->draw_mouse) {
467         paint_mouse_pointer(image, s);
468     }
469
470     return s->frame_size;
471 }
472
473 /**
474  * Close x11 frame grabber (public device demuxer API).
475  *
476  * @param s1 Context from avformat core
477  * @return 0 success, !0 failure
478  */
479 static int
480 x11grab_read_close(AVFormatContext *s1)
481 {
482     struct x11_grab *x11grab = s1->priv_data;
483
484     /* Detach cleanly from shared mem */
485     if (x11grab->use_shm) {
486         XShmDetach(x11grab->dpy, &x11grab->shminfo);
487         shmdt(x11grab->shminfo.shmaddr);
488         shmctl(x11grab->shminfo.shmid, IPC_RMID, NULL);
489     }
490
491     /* Destroy X11 image */
492     if (x11grab->image) {
493         XDestroyImage(x11grab->image);
494         x11grab->image = NULL;
495     }
496
497     /* Free X11 display */
498     XCloseDisplay(x11grab->dpy);
499     return 0;
500 }
501
502 #define OFFSET(x) offsetof(struct x11_grab, x)
503 #define DEC AV_OPT_FLAG_DECODING_PARAM
504 static const AVOption options[] = {
505     { "video_size", "A string describing frame size, such as 640x480 or hd720.", OFFSET(video_size), FF_OPT_TYPE_STRING, {.str = "vga"}, 0, 0, DEC },
506     { "framerate", "", OFFSET(framerate), FF_OPT_TYPE_STRING, {.str = "ntsc"}, 0, 0, DEC },
507     { "draw_mouse", "Draw the mouse pointer.", OFFSET(draw_mouse), FF_OPT_TYPE_INT, { 1 }, 0, 1, DEC },
508     { "follow_mouse", "Move the grabbing region when the mouse pointer reaches within specified amount of pixels to the edge of region.",
509       OFFSET(follow_mouse), FF_OPT_TYPE_INT, { 0 }, -1, INT_MAX, DEC, "follow_mouse" },
510     { "centered", "Keep the mouse pointer at the center of grabbing region when following.", 0, FF_OPT_TYPE_CONST, { -1 }, INT_MIN, INT_MAX, DEC, "follow_mouse" },
511     { NULL },
512 };
513
514 static const AVClass x11_class = {
515     .class_name = "X11grab indev",
516     .item_name  = av_default_item_name,
517     .option     = options,
518     .version    = LIBAVUTIL_VERSION_INT,
519 };
520
521 /** x11 grabber device demuxer declaration */
522 AVInputFormat ff_x11_grab_device_demuxer =
523 {
524     "x11grab",
525     NULL_IF_CONFIG_SMALL("X11grab"),
526     sizeof(struct x11_grab),
527     NULL,
528     x11grab_read_header,
529     x11grab_read_packet,
530     x11grab_read_close,
531     .flags = AVFMT_NOFILE,
532     .priv_class = &x11_class,
533 };