Merge remote-tracking branch 'qatar/master'
[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
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 "libavutil/log.h"
40 #include "libavutil/opt.h"
41 #include "libavutil/parseutils.h"
42 #include <time.h>
43 #include <X11/X.h>
44 #include <X11/Xlib.h>
45 #include <X11/Xlibint.h>
46 #include <X11/Xproto.h>
47 #include <X11/Xutil.h>
48 #include <sys/shm.h>
49 #include <X11/extensions/XShm.h>
50 #include <X11/extensions/Xfixes.h>
51 #include "avdevice.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 nomouse;
74 };
75
76 /**
77  * Initialize the x11 grab device demuxer (public device demuxer API).
78  *
79  * @param s1 Context from avformat core
80  * @param ap Parameters from avformat core
81  * @return <ul>
82  *          <li>AVERROR(ENOMEM) no memory left</li>
83  *          <li>AVERROR(EIO) other failure case</li>
84  *          <li>0 success</li>
85  *         </ul>
86  */
87 static int
88 x11grab_read_header(AVFormatContext *s1, AVFormatParameters *ap)
89 {
90     struct x11_grab *x11grab = s1->priv_data;
91     Display *dpy;
92     AVStream *st = NULL;
93     enum PixelFormat input_pixfmt;
94     XImage *image;
95     int x_off = 0;
96     int y_off = 0;
97     int use_shm;
98     char *dpyname, *offset;
99     int ret = 0;
100
101     dpyname = av_strdup(s1->filename);
102     offset = strchr(dpyname, '+');
103     if (offset) {
104         sscanf(offset, "%d,%d", &x_off, &y_off);
105         x11grab->nomouse= strstr(offset, "nomouse");
106         *offset= 0;
107     }
108
109     if ((ret = av_parse_video_size(&x11grab->width, &x11grab->height, x11grab->video_size)) < 0) {
110         av_log(s1, AV_LOG_ERROR, "Couldn't parse video size.\n");
111         goto out;
112     }
113 #if FF_API_FORMAT_PARAMETERS
114     if (ap->width > 0)
115         x11grab->width = ap->width;
116     if (ap->height > 0)
117         x11grab->height = ap->height;
118 #endif
119     av_log(s1, AV_LOG_INFO, "device: %s -> display: %s x: %d y: %d width: %d height: %d\n",
120            s1->filename, dpyname, x_off, y_off, x11grab->width, x11grab->height);
121
122     dpy = XOpenDisplay(dpyname);
123     av_freep(&dpyname);
124     if(!dpy) {
125         av_log(s1, AV_LOG_ERROR, "Could not open X display.\n");
126         ret = AVERROR(EIO);
127         goto out;
128     }
129
130     if (ap->time_base.den <= 0) {
131         av_log(s1, AV_LOG_ERROR, "AVParameters don't have video size and/or rate. Use -s and -r.\n");
132         ret = AVERROR(EINVAL);
133         goto out;
134     }
135
136     st = av_new_stream(s1, 0);
137     if (!st) {
138         ret = AVERROR(ENOMEM);
139         goto out;
140     }
141     av_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in us */
142
143     use_shm = XShmQueryExtension(dpy);
144     av_log(s1, AV_LOG_INFO, "shared memory extension%s found\n", use_shm ? "" : " not");
145
146     if(use_shm) {
147         int scr = XDefaultScreen(dpy);
148         image = XShmCreateImage(dpy,
149                                 DefaultVisual(dpy, scr),
150                                 DefaultDepth(dpy, scr),
151                                 ZPixmap,
152                                 NULL,
153                                 &x11grab->shminfo,
154                                 x11grab->width, x11grab->height);
155         x11grab->shminfo.shmid = shmget(IPC_PRIVATE,
156                                         image->bytes_per_line * image->height,
157                                         IPC_CREAT|0777);
158         if (x11grab->shminfo.shmid == -1) {
159             av_log(s1, AV_LOG_ERROR, "Fatal: Can't get shared memory!\n");
160             ret = AVERROR(ENOMEM);
161             goto out;
162         }
163         x11grab->shminfo.shmaddr = image->data = shmat(x11grab->shminfo.shmid, 0, 0);
164         x11grab->shminfo.readOnly = False;
165
166         if (!XShmAttach(dpy, &x11grab->shminfo)) {
167             av_log(s1, AV_LOG_ERROR, "Fatal: Failed to attach shared memory!\n");
168             /* needs some better error subroutine :) */
169             ret = AVERROR(EIO);
170             goto out;
171         }
172     } else {
173         image = XGetImage(dpy, RootWindow(dpy, DefaultScreen(dpy)),
174                           x_off,y_off,
175                           x11grab->width, x11grab->height,
176                           AllPlanes, ZPixmap);
177     }
178
179     switch (image->bits_per_pixel) {
180     case 8:
181         av_log (s1, AV_LOG_DEBUG, "8 bit palette\n");
182         input_pixfmt = PIX_FMT_PAL8;
183         break;
184     case 16:
185         if (       image->red_mask   == 0xf800 &&
186                    image->green_mask == 0x07e0 &&
187                    image->blue_mask  == 0x001f ) {
188             av_log (s1, AV_LOG_DEBUG, "16 bit RGB565\n");
189             input_pixfmt = PIX_FMT_RGB565;
190         } else if (image->red_mask   == 0x7c00 &&
191                    image->green_mask == 0x03e0 &&
192                    image->blue_mask  == 0x001f ) {
193             av_log(s1, AV_LOG_DEBUG, "16 bit RGB555\n");
194             input_pixfmt = PIX_FMT_RGB555;
195         } else {
196             av_log(s1, AV_LOG_ERROR, "RGB ordering at image depth %i not supported ... aborting\n", image->bits_per_pixel);
197             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);
198             ret = AVERROR(EIO);
199             goto out;
200         }
201         break;
202     case 24:
203         if (        image->red_mask   == 0xff0000 &&
204                     image->green_mask == 0x00ff00 &&
205                     image->blue_mask  == 0x0000ff ) {
206             input_pixfmt = PIX_FMT_BGR24;
207         } else if ( image->red_mask   == 0x0000ff &&
208                     image->green_mask == 0x00ff00 &&
209                     image->blue_mask  == 0xff0000 ) {
210             input_pixfmt = PIX_FMT_RGB24;
211         } else {
212             av_log(s1, AV_LOG_ERROR,"rgb ordering at image depth %i not supported ... aborting\n", image->bits_per_pixel);
213             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);
214             ret = AVERROR(EIO);
215             goto out;
216         }
217         break;
218     case 32:
219 #if 0
220         GetColorInfo (image, &c_info);
221         if ( c_info.alpha_mask == 0xff000000 && image->green_mask == 0x0000ff00) {
222             /* byte order is relevant here, not endianness
223              * endianness is handled by avcodec, but atm no such thing
224              * as having ABGR, instead of ARGB in a word. Since we
225              * need this for Solaris/SPARC, but need to do the conversion
226              * for every frame we do it outside of this loop, cf. below
227              * this matches both ARGB32 and ABGR32 */
228             input_pixfmt = PIX_FMT_ARGB32;
229         }  else {
230             av_log(s1, AV_LOG_ERROR,"image depth %i not supported ... aborting\n", image->bits_per_pixel);
231             return AVERROR(EIO);
232         }
233 #endif
234         input_pixfmt = PIX_FMT_RGB32;
235         break;
236     default:
237         av_log(s1, AV_LOG_ERROR, "image depth %i not supported ... aborting\n", image->bits_per_pixel);
238         ret = AVERROR(EINVAL);
239         goto out;
240     }
241
242     x11grab->frame_size = x11grab->width * x11grab->height * image->bits_per_pixel/8;
243     x11grab->dpy = dpy;
244     x11grab->time_base  = ap->time_base;
245     x11grab->time_frame = av_gettime() / av_q2d(ap->time_base);
246     x11grab->x_off = x_off;
247     x11grab->y_off = y_off;
248     x11grab->image = image;
249     x11grab->use_shm = use_shm;
250
251     st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
252     st->codec->codec_id = CODEC_ID_RAWVIDEO;
253     st->codec->width  = x11grab->width;
254     st->codec->height = x11grab->height;
255     st->codec->pix_fmt = input_pixfmt;
256     st->codec->time_base = ap->time_base;
257     st->codec->bit_rate = x11grab->frame_size * 1/av_q2d(ap->time_base) * 8;
258
259 out:
260     av_freep(&x11grab->video_size);
261     return ret;
262 }
263
264 /**
265  * Paint a mouse pointer in an X11 image.
266  *
267  * @param image image to paint the mouse pointer to
268  * @param s context used to retrieve original grabbing rectangle
269  *          coordinates
270  */
271 static void
272 paint_mouse_pointer(XImage *image, struct x11_grab *s)
273 {
274     int x_off = s->x_off;
275     int y_off = s->y_off;
276     int width = s->width;
277     int height = s->height;
278     Display *dpy = s->dpy;
279     XFixesCursorImage *xcim;
280     int x, y;
281     int line, column;
282     int to_line, to_column;
283     int pixstride = image->bits_per_pixel >> 3;
284     /* Warning: in its insanity, xlib provides unsigned image data through a
285      * char* pointer, so we have to make it uint8_t to make things not break.
286      * Anyone who performs further investigation of the xlib API likely risks
287      * permanent brain damage. */
288     uint8_t *pix = image->data;
289
290     /* Code doesn't currently support 16-bit or PAL8 */
291     if (image->bits_per_pixel != 24 && image->bits_per_pixel != 32)
292         return;
293
294     xcim = XFixesGetCursorImage(dpy);
295
296     x = xcim->x - xcim->xhot;
297     y = xcim->y - xcim->yhot;
298
299     to_line = FFMIN((y + xcim->height), (height + y_off));
300     to_column = FFMIN((x + xcim->width), (width + x_off));
301
302     for (line = FFMAX(y, y_off); line < to_line; line++) {
303         for (column = FFMAX(x, x_off); column < to_column; column++) {
304             int  xcim_addr = (line - y) * xcim->width + column - x;
305             int image_addr = ((line - y_off) * width + column - x_off) * pixstride;
306             int r = (uint8_t)(xcim->pixels[xcim_addr] >>  0);
307             int g = (uint8_t)(xcim->pixels[xcim_addr] >>  8);
308             int b = (uint8_t)(xcim->pixels[xcim_addr] >> 16);
309             int a = (uint8_t)(xcim->pixels[xcim_addr] >> 24);
310
311             if (a == 255) {
312                 pix[image_addr+0] = r;
313                 pix[image_addr+1] = g;
314                 pix[image_addr+2] = b;
315             } else if (a) {
316                 /* pixel values from XFixesGetCursorImage come premultiplied by alpha */
317                 pix[image_addr+0] = r + (pix[image_addr+0]*(255-a) + 255/2) / 255;
318                 pix[image_addr+1] = g + (pix[image_addr+1]*(255-a) + 255/2) / 255;
319                 pix[image_addr+2] = b + (pix[image_addr+2]*(255-a) + 255/2) / 255;
320             }
321         }
322     }
323
324     XFree(xcim);
325     xcim = NULL;
326 }
327
328
329 /**
330  * Read new data in the image structure.
331  *
332  * @param dpy X11 display to grab from
333  * @param d
334  * @param image Image where the grab will be put
335  * @param x Top-Left grabbing rectangle horizontal coordinate
336  * @param y Top-Left grabbing rectangle vertical coordinate
337  * @return 0 if error, !0 if successful
338  */
339 static int
340 xget_zpixmap(Display *dpy, Drawable d, XImage *image, int x, int y)
341 {
342     xGetImageReply rep;
343     xGetImageReq *req;
344     long nbytes;
345
346     if (!image) {
347         return 0;
348     }
349
350     LockDisplay(dpy);
351     GetReq(GetImage, req);
352
353     /* First set up the standard stuff in the request */
354     req->drawable = d;
355     req->x = x;
356     req->y = y;
357     req->width = image->width;
358     req->height = image->height;
359     req->planeMask = (unsigned int)AllPlanes;
360     req->format = ZPixmap;
361
362     if (!_XReply(dpy, (xReply *)&rep, 0, xFalse) || !rep.length) {
363         UnlockDisplay(dpy);
364         SyncHandle();
365         return 0;
366     }
367
368     nbytes = (long)rep.length << 2;
369     _XReadPad(dpy, image->data, nbytes);
370
371     UnlockDisplay(dpy);
372     SyncHandle();
373     return 1;
374 }
375
376 /**
377  * Grab a frame from x11 (public device demuxer API).
378  *
379  * @param s1 Context from avformat core
380  * @param pkt Packet holding the brabbed frame
381  * @return frame size in bytes
382  */
383 static int
384 x11grab_read_packet(AVFormatContext *s1, AVPacket *pkt)
385 {
386     struct x11_grab *s = s1->priv_data;
387     Display *dpy = s->dpy;
388     XImage *image = s->image;
389     int x_off = s->x_off;
390     int y_off = s->y_off;
391
392     int64_t curtime, delay;
393     struct timespec ts;
394
395     /* Calculate the time of the next frame */
396     s->time_frame += INT64_C(1000000);
397
398     /* wait based on the frame rate */
399     for(;;) {
400         curtime = av_gettime();
401         delay = s->time_frame * av_q2d(s->time_base) - curtime;
402         if (delay <= 0) {
403             if (delay < INT64_C(-1000000) * av_q2d(s->time_base)) {
404                 s->time_frame += INT64_C(1000000);
405             }
406             break;
407         }
408         ts.tv_sec = delay / 1000000;
409         ts.tv_nsec = (delay % 1000000) * 1000;
410         nanosleep(&ts, NULL);
411     }
412
413     av_init_packet(pkt);
414     pkt->data = image->data;
415     pkt->size = s->frame_size;
416     pkt->pts = curtime;
417
418     if(s->use_shm) {
419         if (!XShmGetImage(dpy, RootWindow(dpy, DefaultScreen(dpy)), image, x_off, y_off, AllPlanes)) {
420             av_log (s1, AV_LOG_INFO, "XShmGetImage() failed\n");
421         }
422     } else {
423         if (!xget_zpixmap(dpy, RootWindow(dpy, DefaultScreen(dpy)), image, x_off, y_off)) {
424             av_log (s1, AV_LOG_INFO, "XGetZPixmap() failed\n");
425         }
426     }
427
428     if(!s->nomouse){
429         paint_mouse_pointer(image, s);
430     }
431
432     return s->frame_size;
433 }
434
435 /**
436  * Close x11 frame grabber (public device demuxer API).
437  *
438  * @param s1 Context from avformat core
439  * @return 0 success, !0 failure
440  */
441 static int
442 x11grab_read_close(AVFormatContext *s1)
443 {
444     struct x11_grab *x11grab = s1->priv_data;
445
446     /* Detach cleanly from shared mem */
447     if (x11grab->use_shm) {
448         XShmDetach(x11grab->dpy, &x11grab->shminfo);
449         shmdt(x11grab->shminfo.shmaddr);
450         shmctl(x11grab->shminfo.shmid, IPC_RMID, NULL);
451     }
452
453     /* Destroy X11 image */
454     if (x11grab->image) {
455         XDestroyImage(x11grab->image);
456         x11grab->image = NULL;
457     }
458
459     /* Free X11 display */
460     XCloseDisplay(x11grab->dpy);
461     return 0;
462 }
463
464 #define OFFSET(x) offsetof(struct x11_grab, x)
465 #define DEC AV_OPT_FLAG_DECODING_PARAM
466 static const AVOption options[] = {
467     { "video_size", "A string describing frame size, such as 640x480 or hd720.", OFFSET(video_size), FF_OPT_TYPE_STRING, {.str = "vga"}, 0, 0, DEC },
468     { NULL },
469 };
470
471 static const AVClass x11_class = {
472     .class_name = "X11grab indev",
473     .item_name  = av_default_item_name,
474     .option     = options,
475     .version    = LIBAVUTIL_VERSION_INT,
476 };
477
478 /** x11 grabber device demuxer declaration */
479 AVInputFormat ff_x11_grab_device_demuxer =
480 {
481     "x11grab",
482     NULL_IF_CONFIG_SMALL("X11grab"),
483     sizeof(struct x11_grab),
484     NULL,
485     x11grab_read_header,
486     x11grab_read_packet,
487     x11grab_read_close,
488     .flags = AVFMT_NOFILE,
489     .priv_class = &x11_class,
490 };