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