Real cursor support in x11grab.
[ffmpeg.git] / libavdevice / x11grab.c
1 /*
2  * X11 video grab interface
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg 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  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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 libavdevice/x11grab.c
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 <time.h>
41 #include <X11/X.h>
42 #include <X11/Xlib.h>
43 #include <X11/Xlibint.h>
44 #include <X11/Xproto.h>
45 #include <X11/Xutil.h>
46 #include <sys/shm.h>
47 #include <X11/extensions/XShm.h>
48 #include <X11/extensions/Xfixes.h>
49
50 /**
51  * X11 Device Demuxer context
52  */
53 struct x11_grab
54 {
55     int frame_size;          /**< Size in bytes of a grabbed frame */
56     AVRational time_base;    /**< Time base */
57     int64_t time_frame;      /**< Current time */
58
59     int height;              /**< Height of the grab frame */
60     int width;               /**< Width of the grab frame */
61     int x_off;               /**< Horizontal top-left corner coordinate */
62     int y_off;               /**< Vertical top-left corner coordinate */
63
64     Display *dpy;            /**< X11 display from which x11grab grabs frames */
65     XImage *image;           /**< X11 image holding the grab */
66     int use_shm;             /**< !0 when using XShm extension */
67     XShmSegmentInfo shminfo; /**< When using XShm, keeps track of XShm infos */
68     int mouse_warning_shown;
69 };
70
71 /**
72  * Initializes the x11 grab device demuxer (public device demuxer API).
73  *
74  * @param s1 Context from avformat core
75  * @param ap Parameters from avformat core
76  * @return <ul>
77  *          <li>AVERROR(ENOMEM) no memory left</li>
78  *          <li>AVERROR(EIO) other failure case</li>
79  *          <li>0 success</li>
80  *         </ul>
81  */
82 static int
83 x11grab_read_header(AVFormatContext *s1, AVFormatParameters *ap)
84 {
85     struct x11_grab *x11grab = s1->priv_data;
86     Display *dpy;
87     AVStream *st = NULL;
88     int input_pixfmt;
89     XImage *image;
90     int x_off = 0;
91     int y_off = 0;
92     int use_shm;
93     char *param, *offset;
94
95     param = av_strdup(s1->filename);
96     offset = strchr(param, '+');
97     if (offset) {
98         sscanf(offset, "%d,%d", &x_off, &y_off);
99         *offset= 0;
100     }
101
102     av_log(s1, AV_LOG_INFO, "device: %s -> display: %s x: %d y: %d width: %d height: %d\n", s1->filename, param, x_off, y_off, ap->width, ap->height);
103
104     dpy = XOpenDisplay(param);
105     if(!dpy) {
106         av_log(s1, AV_LOG_ERROR, "Could not open X display.\n");
107         return AVERROR(EIO);
108     }
109
110     if (!ap || ap->width <= 0 || ap->height <= 0 || ap->time_base.den <= 0) {
111         av_log(s1, AV_LOG_ERROR, "AVParameters don't have video size and/or rate. Use -s and -r.\n");
112         return AVERROR(EIO);
113     }
114
115     st = av_new_stream(s1, 0);
116     if (!st) {
117         return AVERROR(ENOMEM);
118     }
119     av_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in us */
120
121     use_shm = XShmQueryExtension(dpy);
122     av_log(s1, AV_LOG_INFO, "shared memory extension %s found\n", use_shm ? "" : "not");
123
124     if(use_shm) {
125         int scr = XDefaultScreen(dpy);
126         image = XShmCreateImage(dpy,
127                                 DefaultVisual(dpy, scr),
128                                 DefaultDepth(dpy, scr),
129                                 ZPixmap,
130                                 NULL,
131                                 &x11grab->shminfo,
132                                 ap->width, ap->height);
133         x11grab->shminfo.shmid = shmget(IPC_PRIVATE,
134                                         image->bytes_per_line * image->height,
135                                         IPC_CREAT|0777);
136         if (x11grab->shminfo.shmid == -1) {
137             av_log(s1, AV_LOG_ERROR, "Fatal: Can't get shared memory!\n");
138             return AVERROR(ENOMEM);
139         }
140         x11grab->shminfo.shmaddr = image->data = shmat(x11grab->shminfo.shmid, 0, 0);
141         x11grab->shminfo.readOnly = False;
142
143         if (!XShmAttach(dpy, &x11grab->shminfo)) {
144             av_log(s1, AV_LOG_ERROR, "Fatal: Failed to attach shared memory!\n");
145             /* needs some better error subroutine :) */
146             return AVERROR(EIO);
147         }
148     } else {
149         image = XGetImage(dpy, RootWindow(dpy, DefaultScreen(dpy)),
150                           x_off,y_off,
151                           ap->width,ap->height,
152                           AllPlanes, ZPixmap);
153     }
154
155     switch (image->bits_per_pixel) {
156     case 8:
157         av_log (s1, AV_LOG_DEBUG, "8 bit palette\n");
158         input_pixfmt = PIX_FMT_PAL8;
159         break;
160     case 16:
161         if (       image->red_mask   == 0xf800 &&
162                    image->green_mask == 0x07e0 &&
163                    image->blue_mask  == 0x001f ) {
164             av_log (s1, AV_LOG_DEBUG, "16 bit RGB565\n");
165             input_pixfmt = PIX_FMT_RGB565;
166         } else if (image->red_mask   == 0x7c00 &&
167                    image->green_mask == 0x03e0 &&
168                    image->blue_mask  == 0x001f ) {
169             av_log(s1, AV_LOG_DEBUG, "16 bit RGB555\n");
170             input_pixfmt = PIX_FMT_RGB555;
171         } else {
172             av_log(s1, AV_LOG_ERROR, "RGB ordering at image depth %i not supported ... aborting\n", image->bits_per_pixel);
173             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);
174             return AVERROR(EIO);
175         }
176         break;
177     case 24:
178         if (        image->red_mask   == 0xff0000 &&
179                     image->green_mask == 0x00ff00 &&
180                     image->blue_mask  == 0x0000ff ) {
181             input_pixfmt = PIX_FMT_BGR24;
182         } else if ( image->red_mask   == 0x0000ff &&
183                     image->green_mask == 0x00ff00 &&
184                     image->blue_mask  == 0xff0000 ) {
185             input_pixfmt = PIX_FMT_RGB24;
186         } else {
187             av_log(s1, AV_LOG_ERROR,"rgb ordering at image depth %i not supported ... aborting\n", image->bits_per_pixel);
188             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);
189             return AVERROR(EIO);
190         }
191         break;
192     case 32:
193 #if 0
194         GetColorInfo (image, &c_info);
195         if ( c_info.alpha_mask == 0xff000000 && image->green_mask == 0x0000ff00) {
196             /* byte order is relevant here, not endianness
197              * endianness is handled by avcodec, but atm no such thing
198              * as having ABGR, instead of ARGB in a word. Since we
199              * need this for Solaris/SPARC, but need to do the conversion
200              * for every frame we do it outside of this loop, cf. below
201              * this matches both ARGB32 and ABGR32 */
202             input_pixfmt = PIX_FMT_ARGB32;
203         }  else {
204             av_log(s1, AV_LOG_ERROR,"image depth %i not supported ... aborting\n", image->bits_per_pixel);
205             return AVERROR(EIO);
206         }
207 #endif
208         input_pixfmt = PIX_FMT_RGB32;
209         break;
210     default:
211         av_log(s1, AV_LOG_ERROR, "image depth %i not supported ... aborting\n", image->bits_per_pixel);
212         return -1;
213     }
214
215     x11grab->frame_size = ap->width * ap->height * image->bits_per_pixel/8;
216     x11grab->dpy = dpy;
217     x11grab->width = ap->width;
218     x11grab->height = ap->height;
219     x11grab->time_base  = ap->time_base;
220     x11grab->time_frame = av_gettime() / av_q2d(ap->time_base);
221     x11grab->x_off = x_off;
222     x11grab->y_off = y_off;
223     x11grab->image = image;
224     x11grab->use_shm = use_shm;
225     x11grab->mouse_warning_shown = 0;
226
227     st->codec->codec_type = CODEC_TYPE_VIDEO;
228     st->codec->codec_id = CODEC_ID_RAWVIDEO;
229     st->codec->width = ap->width;
230     st->codec->height = ap->height;
231     st->codec->pix_fmt = input_pixfmt;
232     st->codec->time_base = ap->time_base;
233     st->codec->bit_rate = x11grab->frame_size * 1/av_q2d(ap->time_base) * 8;
234
235     return 0;
236 }
237
238 /**
239  * Mouse painting helper function that applies an 'and' and 'or' mask pair to
240  * '*dst' pixel. It actually draws a mouse pointer pixel to grabbed frame.
241  *
242  * @param dst Destination pixel
243  * @param and Part of the mask that must be applied using a bitwise 'and'
244  *            operator
245  * @param or  Part of the mask that must be applied using a bitwise 'or'
246  *            operator
247  * @param bits_per_pixel Bits per pixel used in the grabbed image
248  */
249 static void inline
250 apply_masks(uint8_t *dst, int and, int or, int bits_per_pixel)
251 {
252     switch (bits_per_pixel) {
253     case 32:
254         *(uint32_t*)dst = (*(uint32_t*)dst & and) | or;
255         break;
256     case 16:
257         *(uint16_t*)dst = (*(uint16_t*)dst & and) | or;
258         break;
259     case 8:
260         *dst = !!or;
261         break;
262     }
263 }
264
265 /**
266  * Paints a mouse pointer in an X11 image.
267  *
268  * @param image image to paint the mouse pointer to
269  * @param s context used to retrieve original grabbing rectangle
270  *          coordinates
271  * @param x Mouse pointer coordinate
272  * @param y Mouse pointer coordinate
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 image_addr, xcim_addr;
287
288     xcim = XFixesGetCursorImage(dpy);;
289
290     x = xcim->x - xcim->xhot;
291     y = xcim->y - xcim->yhot;
292
293     to_line = FFMIN((y + xcim->height), (height + y_off));
294     to_column = FFMIN((x + xcim->width), (width + x_off));
295
296     for (line = FFMAX(y, y_off); line < to_line; line++) {
297         for (column = FFMAX(x, x_off); column < to_column; column++) {
298             xcim_addr = (line - y) * xcim->width + column - x;
299
300             if ((unsigned char)(xcim->pixels[xcim_addr] >> 24) != 0) { // skip fully transparent pixel
301                 image_addr = ((line - y_off) * width + column - x_off) * 4;
302
303                 image->data[image_addr] = (unsigned char)(xcim->pixels[xcim_addr] >> 0);
304                 image->data[image_addr+1] = (unsigned char)(xcim->pixels[xcim_addr] >> 8);
305                 image->data[image_addr+2] = (unsigned char)(xcim->pixels[xcim_addr] >> 16);
306             }
307         }
308     }
309
310     XFree(xcim);
311     xcim = NULL;
312 }
313
314
315 /**
316  * Reads new data in the image structure.
317  *
318  * @param dpy X11 display to grab from
319  * @param d
320  * @param image Image where the grab will be put
321  * @param x Top-Left grabbing rectangle horizontal coordinate
322  * @param y Top-Left grabbing rectangle vertical coordinate
323  * @return 0 if error, !0 if successful
324  */
325 static int
326 xget_zpixmap(Display *dpy, Drawable d, XImage *image, int x, int y)
327 {
328     xGetImageReply rep;
329     xGetImageReq *req;
330     long nbytes;
331
332     if (!image) {
333         return 0;
334     }
335
336     LockDisplay(dpy);
337     GetReq(GetImage, req);
338
339     /* First set up the standard stuff in the request */
340     req->drawable = d;
341     req->x = x;
342     req->y = y;
343     req->width = image->width;
344     req->height = image->height;
345     req->planeMask = (unsigned int)AllPlanes;
346     req->format = ZPixmap;
347
348     if (!_XReply(dpy, (xReply *)&rep, 0, xFalse) || !rep.length) {
349         UnlockDisplay(dpy);
350         SyncHandle();
351         return 0;
352     }
353
354     nbytes = (long)rep.length << 2;
355     _XReadPad(dpy, image->data, nbytes);
356
357     UnlockDisplay(dpy);
358     SyncHandle();
359     return 1;
360 }
361
362 /**
363  * Grabs a frame from x11 (public device demuxer API).
364  *
365  * @param s1 Context from avformat core
366  * @param pkt Packet holding the brabbed frame
367  * @return frame size in bytes
368  */
369 static int
370 x11grab_read_packet(AVFormatContext *s1, AVPacket *pkt)
371 {
372     struct x11_grab *s = s1->priv_data;
373     Display *dpy = s->dpy;
374     XImage *image = s->image;
375     int x_off = s->x_off;
376     int y_off = s->y_off;
377
378     int64_t curtime, delay;
379     struct timespec ts;
380
381     /* Calculate the time of the next frame */
382     s->time_frame += INT64_C(1000000);
383
384     /* wait based on the frame rate */
385     for(;;) {
386         curtime = av_gettime();
387         delay = s->time_frame * av_q2d(s->time_base) - curtime;
388         if (delay <= 0) {
389             if (delay < INT64_C(-1000000) * av_q2d(s->time_base)) {
390                 s->time_frame += INT64_C(1000000);
391             }
392             break;
393         }
394         ts.tv_sec = delay / 1000000;
395         ts.tv_nsec = (delay % 1000000) * 1000;
396         nanosleep(&ts, NULL);
397     }
398
399     if (av_new_packet(pkt, s->frame_size) < 0) {
400         return AVERROR(EIO);
401     }
402
403     pkt->pts = curtime;
404
405     if(s->use_shm) {
406         if (!XShmGetImage(dpy, RootWindow(dpy, DefaultScreen(dpy)), image, x_off, y_off, AllPlanes)) {
407             av_log (s1, AV_LOG_INFO, "XShmGetImage() failed\n");
408         }
409     } else {
410         if (!xget_zpixmap(dpy, RootWindow(dpy, DefaultScreen(dpy)), image, x_off, y_off)) {
411             av_log (s1, AV_LOG_INFO, "XGetZPixmap() failed\n");
412         }
413     }
414
415     {
416         paint_mouse_pointer(image, s);
417     }
418
419
420     /* XXX: avoid memcpy */
421     memcpy(pkt->data, image->data, s->frame_size);
422     return s->frame_size;
423 }
424
425 /**
426  * Closes x11 frame grabber (public device demuxer API).
427  *
428  * @param s1 Context from avformat core
429  * @return 0 success, !0 failure
430  */
431 static int
432 x11grab_read_close(AVFormatContext *s1)
433 {
434     struct x11_grab *x11grab = s1->priv_data;
435
436     /* Detach cleanly from shared mem */
437     if (x11grab->use_shm) {
438         XShmDetach(x11grab->dpy, &x11grab->shminfo);
439         shmdt(x11grab->shminfo.shmaddr);
440         shmctl(x11grab->shminfo.shmid, IPC_RMID, NULL);
441     }
442
443     /* Destroy X11 image */
444     if (x11grab->image) {
445         XDestroyImage(x11grab->image);
446         x11grab->image = NULL;
447     }
448
449     /* Free X11 display */
450     XCloseDisplay(x11grab->dpy);
451     return 0;
452 }
453
454 /** x11 grabber device demuxer declaration */
455 AVInputFormat x11_grab_device_demuxer =
456 {
457     "x11grab",
458     NULL_IF_CONFIG_SMALL("X11grab"),
459     sizeof(struct x11_grab),
460     NULL,
461     x11grab_read_header,
462     x11grab_read_packet,
463     x11grab_read_close,
464     .flags = AVFMT_NOFILE,
465 };