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