x11grab: fix a memory leak exposed by valgrind
[libav.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
35 * @author Clemens Fruhwirth <clemens@endorphin.org>
36 * @author Edouard Gomez <ed.gomez@free.fr>
37 */
38
39 #include "config.h"
40 #include "libavformat/avformat.h"
41 #include "libavformat/internal.h"
42 #include "libavutil/log.h"
43 #include "libavutil/opt.h"
44 #include "libavutil/parseutils.h"
45 #include <time.h>
46 #include <X11/X.h>
47 #include <X11/Xlib.h>
48 #include <X11/Xlibint.h>
49 #include <X11/Xproto.h>
50 #include <X11/Xutil.h>
51 #include <sys/shm.h>
52 #include <X11/extensions/shape.h>
53 #include <X11/extensions/XShm.h>
54 #include <X11/extensions/Xfixes.h>
55
56 /**
57 * X11 Device Demuxer context
58 */
59 struct x11_grab
60 {
61 const AVClass *class; /**< Class for private options. */
62 int frame_size; /**< Size in bytes of a grabbed frame */
63 AVRational time_base; /**< Time base */
64 int64_t time_frame; /**< Current time */
65
66 char *video_size; /**< String describing video size, set by a private option. */
67 int height; /**< Height of the grab frame */
68 int width; /**< Width of the grab frame */
69 int x_off; /**< Horizontal top-left corner coordinate */
70 int y_off; /**< Vertical top-left corner coordinate */
71
72 Display *dpy; /**< X11 display from which x11grab grabs frames */
73 XImage *image; /**< X11 image holding the grab */
74 int use_shm; /**< !0 when using XShm extension */
75 XShmSegmentInfo shminfo; /**< When using XShm, keeps track of XShm infos */
76 int draw_mouse; /**< Set by a private option. */
77 int follow_mouse; /**< Set by a private option. */
78 int show_region; /**< set by a private option. */
79 char *framerate; /**< Set by a private option. */
80
81 Window region_win; /**< This is used by show_region option. */
82 };
83
84 #define REGION_WIN_BORDER 3
85 /**
86 * Draw grabbing region window
87 *
88 * @param s x11_grab context
89 */
90 static void
91 x11grab_draw_region_win(struct x11_grab *s)
92 {
93 Display *dpy = s->dpy;
94 int screen;
95 Window win = s->region_win;
96 GC gc;
97
98 screen = DefaultScreen(dpy);
99 gc = XCreateGC(dpy, win, 0, 0);
100 XSetForeground(dpy, gc, WhitePixel(dpy, screen));
101 XSetBackground(dpy, gc, BlackPixel(dpy, screen));
102 XSetLineAttributes(dpy, gc, REGION_WIN_BORDER, LineDoubleDash, 0, 0);
103 XDrawRectangle(dpy, win, gc,
104 1, 1,
105 (s->width + REGION_WIN_BORDER * 2) - 1 * 2 - 1,
106 (s->height + REGION_WIN_BORDER * 2) - 1 * 2 - 1);
107 XFreeGC(dpy, gc);
108 }
109
110 /**
111 * Initialize grabbing region window
112 *
113 * @param s x11_grab context
114 */
115 static void
116 x11grab_region_win_init(struct x11_grab *s)
117 {
118 Display *dpy = s->dpy;
119 int screen;
120 XSetWindowAttributes attribs;
121 XRectangle rect;
122
123 screen = DefaultScreen(dpy);
124 attribs.override_redirect = True;
125 s->region_win = XCreateWindow(dpy, RootWindow(dpy, screen),
126 s->x_off - REGION_WIN_BORDER,
127 s->y_off - REGION_WIN_BORDER,
128 s->width + REGION_WIN_BORDER * 2,
129 s->height + REGION_WIN_BORDER * 2,
130 0, CopyFromParent,
131 InputOutput, CopyFromParent,
132 CWOverrideRedirect, &attribs);
133 rect.x = 0;
134 rect.y = 0;
135 rect.width = s->width;
136 rect.height = s->height;
137 XShapeCombineRectangles(dpy, s->region_win,
138 ShapeBounding, REGION_WIN_BORDER, REGION_WIN_BORDER,
139 &rect, 1, ShapeSubtract, 0);
140 XMapWindow(dpy, s->region_win);
141 XSelectInput(dpy, s->region_win, ExposureMask | StructureNotifyMask);
142 x11grab_draw_region_win(s);
143 }
144
145 /**
146 * Initialize the x11 grab device demuxer (public device demuxer API).
147 *
148 * @param s1 Context from avformat core
149 * @return <ul>
150 * <li>AVERROR(ENOMEM) no memory left</li>
151 * <li>AVERROR(EIO) other failure case</li>
152 * <li>0 success</li>
153 * </ul>
154 */
155 static int
156 x11grab_read_header(AVFormatContext *s1)
157 {
158 struct x11_grab *x11grab = s1->priv_data;
159 Display *dpy;
160 AVStream *st = NULL;
161 enum PixelFormat input_pixfmt;
162 XImage *image;
163 int x_off = 0;
164 int y_off = 0;
165 int screen;
166 int use_shm;
167 char *param, *offset;
168 int ret = 0;
169 AVRational framerate;
170
171 param = av_strdup(s1->filename);
172 if (!param)
173 goto out;
174
175 offset = strchr(param, '+');
176 if (offset) {
177 sscanf(offset, "%d,%d", &x_off, &y_off);
178 x11grab->draw_mouse = !strstr(offset, "nomouse");
179 *offset= 0;
180 }
181
182 if ((ret = av_parse_video_size(&x11grab->width, &x11grab->height, x11grab->video_size)) < 0) {
183 av_log(s1, AV_LOG_ERROR, "Couldn't parse video size.\n");
184 goto out;
185 }
186 if ((ret = av_parse_video_rate(&framerate, x11grab->framerate)) < 0) {
187 av_log(s1, AV_LOG_ERROR, "Could not parse framerate: %s.\n", x11grab->framerate);
188 goto out;
189 }
190 av_log(s1, AV_LOG_INFO, "device: %s -> display: %s x: %d y: %d width: %d height: %d\n",
191 s1->filename, param, x_off, y_off, x11grab->width, x11grab->height);
192
193 dpy = XOpenDisplay(param);
194 if(!dpy) {
195 av_log(s1, AV_LOG_ERROR, "Could not open X display.\n");
196 ret = AVERROR(EIO);
197 goto out;
198 }
199
200 st = avformat_new_stream(s1, NULL);
201 if (!st) {
202 ret = AVERROR(ENOMEM);
203 goto out;
204 }
205 avpriv_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in us */
206
207 screen = DefaultScreen(dpy);
208
209 if (x11grab->follow_mouse) {
210 int screen_w, screen_h;
211 Window w;
212
213 screen_w = DisplayWidth(dpy, screen);
214 screen_h = DisplayHeight(dpy, screen);
215 XQueryPointer(dpy, RootWindow(dpy, screen), &w, &w, &x_off, &y_off, &ret, &ret, &ret);
216 x_off -= x11grab->width / 2;
217 y_off -= x11grab->height / 2;
218 x_off = FFMIN(FFMAX(x_off, 0), screen_w - x11grab->width);
219 y_off = FFMIN(FFMAX(y_off, 0), screen_h - x11grab->height);
220 av_log(s1, AV_LOG_INFO, "followmouse is enabled, resetting grabbing region to x: %d y: %d\n", x_off, y_off);
221 }
222
223 use_shm = XShmQueryExtension(dpy);
224 av_log(s1, AV_LOG_INFO, "shared memory extension %s found\n", use_shm ? "" : "not");
225
226 if(use_shm) {
227 int scr = XDefaultScreen(dpy);
228 image = XShmCreateImage(dpy,
229 DefaultVisual(dpy, scr),
230 DefaultDepth(dpy, scr),
231 ZPixmap,
232 NULL,
233 &x11grab->shminfo,
234 x11grab->width, x11grab->height);
235 x11grab->shminfo.shmid = shmget(IPC_PRIVATE,
236 image->bytes_per_line * image->height,
237 IPC_CREAT|0777);
238 if (x11grab->shminfo.shmid == -1) {
239 av_log(s1, AV_LOG_ERROR, "Fatal: Can't get shared memory!\n");
240 ret = AVERROR(ENOMEM);
241 goto out;
242 }
243 x11grab->shminfo.shmaddr = image->data = shmat(x11grab->shminfo.shmid, 0, 0);
244 x11grab->shminfo.readOnly = False;
245
246 if (!XShmAttach(dpy, &x11grab->shminfo)) {
247 av_log(s1, AV_LOG_ERROR, "Fatal: Failed to attach shared memory!\n");
248 /* needs some better error subroutine :) */
249 ret = AVERROR(EIO);
250 goto out;
251 }
252 } else {
253 image = XGetImage(dpy, RootWindow(dpy, screen),
254 x_off,y_off,
255 x11grab->width, x11grab->height,
256 AllPlanes, ZPixmap);
257 }
258
259 switch (image->bits_per_pixel) {
260 case 8:
261 av_log (s1, AV_LOG_DEBUG, "8 bit palette\n");
262 input_pixfmt = PIX_FMT_PAL8;
263 break;
264 case 16:
265 if ( image->red_mask == 0xf800 &&
266 image->green_mask == 0x07e0 &&
267 image->blue_mask == 0x001f ) {
268 av_log (s1, AV_LOG_DEBUG, "16 bit RGB565\n");
269 input_pixfmt = PIX_FMT_RGB565;
270 } else if (image->red_mask == 0x7c00 &&
271 image->green_mask == 0x03e0 &&
272 image->blue_mask == 0x001f ) {
273 av_log(s1, AV_LOG_DEBUG, "16 bit RGB555\n");
274 input_pixfmt = PIX_FMT_RGB555;
275 } else {
276 av_log(s1, AV_LOG_ERROR, "RGB ordering at image depth %i not supported ... aborting\n", image->bits_per_pixel);
277 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);
278 ret = AVERROR(EIO);
279 goto out;
280 }
281 break;
282 case 24:
283 if ( image->red_mask == 0xff0000 &&
284 image->green_mask == 0x00ff00 &&
285 image->blue_mask == 0x0000ff ) {
286 input_pixfmt = PIX_FMT_BGR24;
287 } else if ( image->red_mask == 0x0000ff &&
288 image->green_mask == 0x00ff00 &&
289 image->blue_mask == 0xff0000 ) {
290 input_pixfmt = PIX_FMT_RGB24;
291 } else {
292 av_log(s1, AV_LOG_ERROR,"rgb ordering at image depth %i not supported ... aborting\n", image->bits_per_pixel);
293 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);
294 ret = AVERROR(EIO);
295 goto out;
296 }
297 break;
298 case 32:
299 input_pixfmt = PIX_FMT_RGB32;
300 break;
301 default:
302 av_log(s1, AV_LOG_ERROR, "image depth %i not supported ... aborting\n", image->bits_per_pixel);
303 ret = AVERROR(EINVAL);
304 goto out;
305 }
306
307 x11grab->frame_size = x11grab->width * x11grab->height * image->bits_per_pixel/8;
308 x11grab->dpy = dpy;
309 x11grab->time_base = (AVRational){framerate.den, framerate.num};
310 x11grab->time_frame = av_gettime() / av_q2d(x11grab->time_base);
311 x11grab->x_off = x_off;
312 x11grab->y_off = y_off;
313 x11grab->image = image;
314 x11grab->use_shm = use_shm;
315
316 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
317 st->codec->codec_id = CODEC_ID_RAWVIDEO;
318 st->codec->width = x11grab->width;
319 st->codec->height = x11grab->height;
320 st->codec->pix_fmt = input_pixfmt;
321 st->codec->time_base = x11grab->time_base;
322 st->codec->bit_rate = x11grab->frame_size * 1/av_q2d(x11grab->time_base) * 8;
323
324 out:
325 av_free(param);
326 return ret;
327 }
328
329 /**
330 * Paint a mouse pointer in an X11 image.
331 *
332 * @param image image to paint the mouse pointer to
333 * @param s context used to retrieve original grabbing rectangle
334 * coordinates
335 */
336 static void
337 paint_mouse_pointer(XImage *image, struct x11_grab *s)
338 {
339 int x_off = s->x_off;
340 int y_off = s->y_off;
341 int width = s->width;
342 int height = s->height;
343 Display *dpy = s->dpy;
344 XFixesCursorImage *xcim;
345 int x, y;
346 int line, column;
347 int to_line, to_column;
348 int pixstride = image->bits_per_pixel >> 3;
349 /* Warning: in its insanity, xlib provides unsigned image data through a
350 * char* pointer, so we have to make it uint8_t to make things not break.
351 * Anyone who performs further investigation of the xlib API likely risks
352 * permanent brain damage. */
353 uint8_t *pix = image->data;
354
355 /* Code doesn't currently support 16-bit or PAL8 */
356 if (image->bits_per_pixel != 24 && image->bits_per_pixel != 32)
357 return;
358
359 xcim = XFixesGetCursorImage(dpy);
360
361 x = xcim->x - xcim->xhot;
362 y = xcim->y - xcim->yhot;
363
364 to_line = FFMIN((y + xcim->height), (height + y_off));
365 to_column = FFMIN((x + xcim->width), (width + x_off));
366
367 for (line = FFMAX(y, y_off); line < to_line; line++) {
368 for (column = FFMAX(x, x_off); column < to_column; column++) {
369 int xcim_addr = (line - y) * xcim->width + column - x;
370 int image_addr = ((line - y_off) * width + column - x_off) * pixstride;
371 int r = (uint8_t)(xcim->pixels[xcim_addr] >> 0);
372 int g = (uint8_t)(xcim->pixels[xcim_addr] >> 8);
373 int b = (uint8_t)(xcim->pixels[xcim_addr] >> 16);
374 int a = (uint8_t)(xcim->pixels[xcim_addr] >> 24);
375
376 if (a == 255) {
377 pix[image_addr+0] = r;
378 pix[image_addr+1] = g;
379 pix[image_addr+2] = b;
380 } else if (a) {
381 /* pixel values from XFixesGetCursorImage come premultiplied by alpha */
382 pix[image_addr+0] = r + (pix[image_addr+0]*(255-a) + 255/2) / 255;
383 pix[image_addr+1] = g + (pix[image_addr+1]*(255-a) + 255/2) / 255;
384 pix[image_addr+2] = b + (pix[image_addr+2]*(255-a) + 255/2) / 255;
385 }
386 }
387 }
388
389 XFree(xcim);
390 xcim = NULL;
391 }
392
393
394 /**
395 * Read new data in the image structure.
396 *
397 * @param dpy X11 display to grab from
398 * @param d
399 * @param image Image where the grab will be put
400 * @param x Top-Left grabbing rectangle horizontal coordinate
401 * @param y Top-Left grabbing rectangle vertical coordinate
402 * @return 0 if error, !0 if successful
403 */
404 static int
405 xget_zpixmap(Display *dpy, Drawable d, XImage *image, int x, int y)
406 {
407 xGetImageReply rep;
408 xGetImageReq *req;
409 long nbytes;
410
411 if (!image) {
412 return 0;
413 }
414
415 LockDisplay(dpy);
416 GetReq(GetImage, req);
417
418 /* First set up the standard stuff in the request */
419 req->drawable = d;
420 req->x = x;
421 req->y = y;
422 req->width = image->width;
423 req->height = image->height;
424 req->planeMask = (unsigned int)AllPlanes;
425 req->format = ZPixmap;
426
427 if (!_XReply(dpy, (xReply *)&rep, 0, xFalse) || !rep.length) {
428 UnlockDisplay(dpy);
429 SyncHandle();
430 return 0;
431 }
432
433 nbytes = (long)rep.length << 2;
434 _XReadPad(dpy, image->data, nbytes);
435
436 UnlockDisplay(dpy);
437 SyncHandle();
438 return 1;
439 }
440
441 /**
442 * Grab a frame from x11 (public device demuxer API).
443 *
444 * @param s1 Context from avformat core
445 * @param pkt Packet holding the brabbed frame
446 * @return frame size in bytes
447 */
448 static int
449 x11grab_read_packet(AVFormatContext *s1, AVPacket *pkt)
450 {
451 struct x11_grab *s = s1->priv_data;
452 Display *dpy = s->dpy;
453 XImage *image = s->image;
454 int x_off = s->x_off;
455 int y_off = s->y_off;
456
457 int screen;
458 Window root;
459 int follow_mouse = s->follow_mouse;
460
461 int64_t curtime, delay;
462 struct timespec ts;
463
464 /* Calculate the time of the next frame */
465 s->time_frame += INT64_C(1000000);
466
467 /* wait based on the frame rate */
468 for(;;) {
469 curtime = av_gettime();
470 delay = s->time_frame * av_q2d(s->time_base) - curtime;
471 if (delay <= 0) {
472 if (delay < INT64_C(-1000000) * av_q2d(s->time_base)) {
473 s->time_frame += INT64_C(1000000);
474 }
475 break;
476 }
477 ts.tv_sec = delay / 1000000;
478 ts.tv_nsec = (delay % 1000000) * 1000;
479 nanosleep(&ts, NULL);
480 }
481
482 av_init_packet(pkt);
483 pkt->data = image->data;
484 pkt->size = s->frame_size;
485 pkt->pts = curtime;
486
487 screen = DefaultScreen(dpy);
488 root = RootWindow(dpy, screen);
489 if (follow_mouse) {
490 int screen_w, screen_h;
491 int pointer_x, pointer_y, _;
492 Window w;
493
494 screen_w = DisplayWidth(dpy, screen);
495 screen_h = DisplayHeight(dpy, screen);
496 XQueryPointer(dpy, root, &w, &w, &pointer_x, &pointer_y, &_, &_, &_);
497 if (follow_mouse == -1) {
498 // follow the mouse, put it at center of grabbing region
499 x_off += pointer_x - s->width / 2 - x_off;
500 y_off += pointer_y - s->height / 2 - y_off;
501 } else {
502 // follow the mouse, but only move the grabbing region when mouse
503 // reaches within certain pixels to the edge.
504 if (pointer_x > x_off + s->width - follow_mouse) {
505 x_off += pointer_x - (x_off + s->width - follow_mouse);
506 } else if (pointer_x < x_off + follow_mouse)
507 x_off -= (x_off + follow_mouse) - pointer_x;
508 if (pointer_y > y_off + s->height - follow_mouse) {
509 y_off += pointer_y - (y_off + s->height - follow_mouse);
510 } else if (pointer_y < y_off + follow_mouse)
511 y_off -= (y_off + follow_mouse) - pointer_y;
512 }
513 // adjust grabbing region position if it goes out of screen.
514 s->x_off = x_off = FFMIN(FFMAX(x_off, 0), screen_w - s->width);
515 s->y_off = y_off = FFMIN(FFMAX(y_off, 0), screen_h - s->height);
516
517 if (s->show_region && s->region_win)
518 XMoveWindow(dpy, s->region_win,
519 s->x_off - REGION_WIN_BORDER,
520 s->y_off - REGION_WIN_BORDER);
521 }
522
523 if (s->show_region) {
524 if (s->region_win) {
525 XEvent evt;
526 // clean up the events, and do the initinal draw or redraw.
527 for (evt.type = NoEventMask; XCheckMaskEvent(dpy, ExposureMask | StructureNotifyMask, &evt); );
528 if (evt.type)
529 x11grab_draw_region_win(s);
530 } else {
531 x11grab_region_win_init(s);
532 }
533 }
534
535 if(s->use_shm) {
536 if (!XShmGetImage(dpy, root, image, x_off, y_off, AllPlanes)) {
537 av_log (s1, AV_LOG_INFO, "XShmGetImage() failed\n");
538 }
539 } else {
540 if (!xget_zpixmap(dpy, root, image, x_off, y_off)) {
541 av_log (s1, AV_LOG_INFO, "XGetZPixmap() failed\n");
542 }
543 }
544
545 if (s->draw_mouse) {
546 paint_mouse_pointer(image, s);
547 }
548
549 return s->frame_size;
550 }
551
552 /**
553 * Close x11 frame grabber (public device demuxer API).
554 *
555 * @param s1 Context from avformat core
556 * @return 0 success, !0 failure
557 */
558 static int
559 x11grab_read_close(AVFormatContext *s1)
560 {
561 struct x11_grab *x11grab = s1->priv_data;
562
563 /* Detach cleanly from shared mem */
564 if (x11grab->use_shm) {
565 XShmDetach(x11grab->dpy, &x11grab->shminfo);
566 shmdt(x11grab->shminfo.shmaddr);
567 shmctl(x11grab->shminfo.shmid, IPC_RMID, NULL);
568 }
569
570 /* Destroy X11 image */
571 if (x11grab->image) {
572 XDestroyImage(x11grab->image);
573 x11grab->image = NULL;
574 }
575
576 if (x11grab->region_win) {
577 XDestroyWindow(x11grab->dpy, x11grab->region_win);
578 }
579
580 /* Free X11 display */
581 XCloseDisplay(x11grab->dpy);
582 return 0;
583 }
584
585 #define OFFSET(x) offsetof(struct x11_grab, x)
586 #define DEC AV_OPT_FLAG_DECODING_PARAM
587 static const AVOption options[] = {
588 { "video_size", "A string describing frame size, such as 640x480 or hd720.", OFFSET(video_size), AV_OPT_TYPE_STRING, {.str = "vga"}, 0, 0, DEC },
589 { "framerate", "", OFFSET(framerate), AV_OPT_TYPE_STRING, {.str = "ntsc"}, 0, 0, DEC },
590 { "draw_mouse", "Draw the mouse pointer.", OFFSET(draw_mouse), AV_OPT_TYPE_INT, { 1 }, 0, 1, DEC },
591 { "follow_mouse", "Move the grabbing region when the mouse pointer reaches within specified amount of pixels to the edge of region.",
592 OFFSET(follow_mouse), AV_OPT_TYPE_INT, { 0 }, -1, INT_MAX, DEC, "follow_mouse" },
593 { "centered", "Keep the mouse pointer at the center of grabbing region when following.", 0, AV_OPT_TYPE_CONST, { -1 }, INT_MIN, INT_MAX, DEC, "follow_mouse" },
594 { "show_region", "Show the grabbing region.", OFFSET(show_region), AV_OPT_TYPE_INT, { 0 }, 0, 1, DEC },
595 { NULL },
596 };
597
598 static const AVClass x11_class = {
599 .class_name = "X11grab indev",
600 .item_name = av_default_item_name,
601 .option = options,
602 .version = LIBAVUTIL_VERSION_INT,
603 };
604
605 /** x11 grabber device demuxer declaration */
606 AVInputFormat ff_x11_grab_device_demuxer = {
607 .name = "x11grab",
608 .long_name = NULL_IF_CONFIG_SMALL("X11grab"),
609 .priv_data_size = sizeof(struct x11_grab),
610 .read_header = x11grab_read_header,
611 .read_packet = x11grab_read_packet,
612 .read_close = x11grab_read_close,
613 .flags = AVFMT_NOFILE,
614 .priv_class = &x11_class,
615 };