xcbgrab: Move NULL check before pointer dereference
[ffmpeg.git] / libavdevice / xcbgrab.c
1 /*
2  * XCB input grabber
3  * Copyright (C) 2014 Luca Barbato <lu_zero@gentoo.org>
4  *
5  * This file is part of Libav.
6  *
7  * Libav is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * Libav is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include "config.h"
23
24 #include <stdlib.h>
25 #include <xcb/xcb.h>
26
27 #if CONFIG_LIBXCB_XFIXES
28 #include <xcb/xfixes.h>
29 #endif
30
31 #if CONFIG_LIBXCB_SHM
32 #include <sys/shm.h>
33 #include <xcb/shm.h>
34 #endif
35
36 #include "libavformat/avformat.h"
37 #include "libavformat/internal.h"
38
39 #include "libavutil/mathematics.h"
40 #include "libavutil/opt.h"
41 #include "libavutil/parseutils.h"
42 #include "libavutil/time.h"
43
44 typedef struct XCBGrabContext {
45     const AVClass *class;
46
47     xcb_connection_t *conn;
48     xcb_screen_t *screen;
49     xcb_window_t window;
50     xcb_shm_seg_t segment;
51
52     int64_t time_frame;
53     AVRational time_base;
54
55     int x, y;
56     int width, height;
57     int frame_size;
58     int bpp;
59
60     int draw_mouse;
61     int follow_mouse;
62     int show_region;
63     int region_border;
64     int centered;
65
66     const char *video_size;
67     const char *framerate;
68
69     int has_shm;
70 } XCBGrabContext;
71
72 #define FOLLOW_CENTER -1
73
74 #define OFFSET(x) offsetof(XCBGrabContext, x)
75 #define D AV_OPT_FLAG_DECODING_PARAM
76 static const AVOption options[] = {
77     { "x", "Initial x coordinate.", OFFSET(x), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, D },
78     { "y", "Initial y coordinate.", OFFSET(y), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, D },
79     { "video_size", "A string describing frame size, such as 640x480 or hd720.", OFFSET(video_size), AV_OPT_TYPE_STRING, {.str = "vga" }, 0, 0, D },
80     { "framerate", "", OFFSET(framerate), AV_OPT_TYPE_STRING, {.str = "ntsc" }, 0, 0, D },
81     { "draw_mouse", "Draw the mouse pointer.", OFFSET(draw_mouse), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, D },
82     { "follow_mouse", "Move the grabbing region when the mouse pointer reaches within specified amount of pixels to the edge of region.",
83       OFFSET(follow_mouse), AV_OPT_TYPE_INT, { .i64 = 0 },  FOLLOW_CENTER, INT_MAX, D, "follow_mouse" },
84     { "centered", "Keep the mouse pointer at the center of grabbing region when following.", 0, AV_OPT_TYPE_CONST, { .i64 = -1 }, INT_MIN, INT_MAX, D, "follow_mouse" },
85     { "show_region", "Show the grabbing region.", OFFSET(show_region), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, D },
86     { "region_border", "Set the region border thickness.", OFFSET(region_border), AV_OPT_TYPE_INT, { .i64 = 3 }, 1, 128, D },
87     { NULL },
88 };
89
90 static const AVClass xcbgrab_class = {
91     .class_name = "xcbgrab indev",
92     .item_name  = av_default_item_name,
93     .option     = options,
94     .version    = LIBAVUTIL_VERSION_INT,
95 };
96
97 static int xcbgrab_reposition(AVFormatContext *s,
98                               xcb_query_pointer_reply_t *p,
99                               xcb_get_geometry_reply_t *geo)
100 {
101     XCBGrabContext *c = s->priv_data;
102     int x = c->x, y = c->y;
103     int w = c->width, h = c->height, f = c->follow_mouse;
104     int p_x, p_y;
105
106     if (!p || !geo)
107         return AVERROR(EIO);
108
109     p_x = p->win_x;
110     p_y = p->win_y;
111
112     if (f == FOLLOW_CENTER) {
113         x = p_x - w / 2;
114         y = p_y - h / 2;
115     } else {
116         int left   = x + f;
117         int right  = x + w - f;
118         int top    = y + f;
119         int bottom = y + h + f;
120         if (p_x > right) {
121             x += p_x - right;
122         } else if (p_x < left) {
123             x -= left - p_x;
124         }
125         if (p_y > bottom) {
126             y += p_y - bottom;
127         } else if (p_y < top) {
128             y -= top - p_y;
129         }
130     }
131
132     c->x = FFMIN(FFMAX(0, x), geo->width  - w);
133     c->y = FFMIN(FFMAX(0, y), geo->height - h);
134
135     return 0;
136 }
137
138 static int xcbgrab_frame(AVFormatContext *s, AVPacket *pkt)
139 {
140     XCBGrabContext *c = s->priv_data;
141     xcb_get_image_cookie_t iq;
142     xcb_get_image_reply_t *img;
143     xcb_drawable_t drawable = c->screen->root;
144     uint8_t *data;
145     int length, ret;
146
147     iq  = xcb_get_image(c->conn, XCB_IMAGE_FORMAT_Z_PIXMAP, drawable,
148                         c->x, c->y, c->width, c->height, ~0);
149
150     img = xcb_get_image_reply(c->conn, iq, NULL);
151     if (!img)
152         return AVERROR(EAGAIN);
153
154     data   = xcb_get_image_data(img);
155     length = xcb_get_image_data_length(img);
156
157     ret = av_new_packet(pkt, length);
158
159     if (!ret)
160         memcpy(pkt->data, data, length);
161
162     free(img);
163
164     return ret;
165 }
166
167 static void wait_frame(AVFormatContext *s, AVPacket *pkt)
168 {
169     XCBGrabContext *c = s->priv_data;
170     int64_t curtime, delay;
171     int64_t frame_time = av_rescale_q(1, c->time_base, AV_TIME_BASE_Q);
172
173     c->time_frame += frame_time;
174
175     for (;;) {
176         curtime = av_gettime();
177         delay   = c->time_frame - curtime;
178         if (delay <= 0)
179             break;
180         av_usleep(delay);
181     }
182
183     pkt->pts = curtime;
184 }
185
186 #if CONFIG_LIBXCB_SHM
187 static int check_shm(xcb_connection_t *conn)
188 {
189     xcb_shm_query_version_cookie_t cookie = xcb_shm_query_version(conn);
190     xcb_shm_query_version_reply_t *reply;
191
192     reply = xcb_shm_query_version_reply(conn, cookie, NULL);
193     if (reply) {
194         free(reply);
195         return 1;
196     }
197
198     return 0;
199 }
200
201 static void dealloc_shm(void *unused, uint8_t *data)
202 {
203     shmdt(data);
204 }
205
206 static int xcbgrab_frame_shm(AVFormatContext *s, AVPacket *pkt)
207 {
208     XCBGrabContext *c = s->priv_data;
209     xcb_shm_get_image_cookie_t iq;
210     xcb_shm_get_image_reply_t *img;
211     xcb_drawable_t drawable = c->screen->root;
212     uint8_t *data;
213     int size = c->frame_size + FF_INPUT_BUFFER_PADDING_SIZE;
214     int id   = shmget(IPC_PRIVATE, size, IPC_CREAT | 0777);
215     xcb_generic_error_t *e = NULL;
216
217     if (id == -1) {
218         char errbuf[1024];
219         int err = AVERROR(errno);
220         av_strerror(err, errbuf, sizeof(errbuf));
221         av_log(s, AV_LOG_ERROR, "Cannot get %d bytes of shared memory: %s.\n",
222                size, errbuf);
223         return err;
224     }
225
226     xcb_shm_attach(c->conn, c->segment, id, 0);
227
228     iq = xcb_shm_get_image(c->conn, drawable,
229                            c->x, c->y, c->width, c->height, ~0,
230                            XCB_IMAGE_FORMAT_Z_PIXMAP, c->segment, 0);
231
232     xcb_shm_detach(c->conn, c->segment);
233
234     img = xcb_shm_get_image_reply(c->conn, iq, &e);
235
236     xcb_flush(c->conn);
237
238     if (e) {
239         av_log(s, AV_LOG_ERROR,
240                "Cannot get the image data "
241                "event_error: response_type:%u error_code:%u "
242                "sequence:%u resource_id:%u minor_code:%u major_code:%u.\n",
243                e->response_type, e->error_code,
244                e->sequence, e->resource_id, e->minor_code, e->major_code);
245
246         shmctl(id, IPC_RMID, 0);
247         return AVERROR(EACCES);
248     }
249
250     free(img);
251
252     data = shmat(id, NULL, 0);
253     shmctl(id, IPC_RMID, 0);
254
255     if ((intptr_t)data == -1)
256         return AVERROR(errno);
257
258     pkt->buf = av_buffer_create(data, size, dealloc_shm, NULL, 0);
259     if (!pkt->buf) {
260         shmdt(data);
261         return AVERROR(ENOMEM);
262     }
263
264     pkt->data = pkt->buf->data;
265     pkt->size = c->frame_size;
266
267     return 0;
268 }
269 #endif /* CONFIG_LIBXCB_SHM */
270
271 #if CONFIG_LIBXCB_XFIXES
272 static int check_xfixes(xcb_connection_t *conn)
273 {
274     xcb_xfixes_query_version_cookie_t cookie;
275     xcb_xfixes_query_version_reply_t *reply;
276
277     cookie = xcb_xfixes_query_version(conn, XCB_XFIXES_MAJOR_VERSION,
278                                       XCB_XFIXES_MINOR_VERSION);
279     reply  = xcb_xfixes_query_version_reply(conn, cookie, NULL);
280
281     if (reply) {
282         free(reply);
283         return 1;
284     }
285     return 0;
286 }
287
288 #define BLEND(target, source, alpha) \
289     (target) + ((source) * (255 - (alpha)) + 255 / 2) / 255
290
291 static void xcbgrab_draw_mouse(AVFormatContext *s, AVPacket *pkt,
292                                xcb_query_pointer_reply_t *p,
293                                xcb_get_geometry_reply_t *geo)
294 {
295     XCBGrabContext *gr = s->priv_data;
296     uint32_t *cursor;
297     uint8_t *image = pkt->data;
298     int stride     = gr->bpp / 8;
299     xcb_xfixes_get_cursor_image_cookie_t cc;
300     xcb_xfixes_get_cursor_image_reply_t *ci;
301     int cx, cy, x, y, w, h, c_off, i_off;
302
303     cc = xcb_xfixes_get_cursor_image(gr->conn);
304     ci = xcb_xfixes_get_cursor_image_reply(gr->conn, cc, NULL);
305     if (!ci)
306         return;
307
308     cursor = xcb_xfixes_get_cursor_image_cursor_image(ci);
309     if (!cursor)
310         return;
311
312     cx = ci->x - ci->xhot;
313     cy = ci->y - ci->yhot;
314
315     x = FFMAX(cx, gr->x);
316     y = FFMAX(cy, gr->y);
317
318     w = FFMIN(cx + ci->width,  gr->x + gr->width)  - x;
319     h = FFMIN(cy + ci->height, gr->y + gr->height) - y;
320
321     c_off = x - cx;
322     i_off = x - gr->x;
323
324     cursor += (y - cy) * ci->width;
325     image  += (y - gr->y) * gr->width * stride;
326
327     for (y = 0; y < h; y++) {
328         cursor += c_off;
329         image  += i_off * stride;
330         for (x = 0; x < w; x++, cursor++, image += stride) {
331             int r, g, b, a;
332
333             r =  *cursor        & 0xff;
334             g = (*cursor >>  8) & 0xff;
335             b = (*cursor >> 16) & 0xff;
336             a = (*cursor >> 24) & 0xff;
337
338             if (!a)
339                 continue;
340
341             if (a == 255) {
342                 image[0] = r;
343                 image[1] = g;
344                 image[2] = b;
345             } else {
346                 image[0] = BLEND(r, image[0], a);
347                 image[1] = BLEND(g, image[1], a);
348                 image[2] = BLEND(b, image[2], a);
349             }
350
351         }
352         cursor +=  ci->width - w - c_off;
353         image  += (gr->width - w - i_off) * stride;
354     }
355
356     free(ci);
357 }
358 #endif /* CONFIG_LIBXCB_XFIXES */
359
360 static void xcbgrab_update_region(AVFormatContext *s)
361 {
362     XCBGrabContext *c     = s->priv_data;
363     const uint32_t args[] = { c->x - c->region_border,
364                               c->y - c->region_border };
365
366     xcb_configure_window(c->conn,
367                          c->window,
368                          XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y,
369                          args);
370 }
371
372 static int xcbgrab_read_packet(AVFormatContext *s, AVPacket *pkt)
373 {
374     XCBGrabContext *c = s->priv_data;
375     xcb_query_pointer_cookie_t pc;
376     xcb_get_geometry_cookie_t gc;
377     xcb_query_pointer_reply_t *p  = NULL;
378     xcb_get_geometry_reply_t *geo = NULL;
379     int ret = 0;
380
381     wait_frame(s, pkt);
382
383     if (c->follow_mouse || c->draw_mouse) {
384         pc  = xcb_query_pointer(c->conn, c->screen->root);
385         gc  = xcb_get_geometry(c->conn, c->screen->root);
386         p   = xcb_query_pointer_reply(c->conn, pc, NULL);
387         geo = xcb_get_geometry_reply(c->conn, gc, NULL);
388     }
389
390     if (c->follow_mouse && p->same_screen)
391         xcbgrab_reposition(s, p, geo);
392
393     if (c->show_region)
394         xcbgrab_update_region(s);
395
396 #if CONFIG_LIBXCB_SHM
397     if (c->has_shm && xcbgrab_frame_shm(s, pkt) < 0)
398         c->has_shm = 0;
399 #endif
400     if (!c->has_shm)
401         ret = xcbgrab_frame(s, pkt);
402
403 #if CONFIG_LIBXCB_XFIXES
404     if (c->draw_mouse && p->same_screen)
405         xcbgrab_draw_mouse(s, pkt, p, geo);
406 #endif
407
408     free(p);
409     free(geo);
410
411     return ret;
412 }
413
414 static av_cold int xcbgrab_read_close(AVFormatContext *s)
415 {
416     XCBGrabContext *ctx = s->priv_data;
417
418     xcb_disconnect(ctx->conn);
419
420     return 0;
421 }
422
423 static xcb_screen_t *get_screen(const xcb_setup_t *setup, int screen_num)
424 {
425     xcb_screen_iterator_t it = xcb_setup_roots_iterator(setup);
426     xcb_screen_t *screen     = NULL;
427
428     for (; it.rem > 0; xcb_screen_next (&it)) {
429         if (!screen_num) {
430             screen = it.data;
431             break;
432         }
433
434         screen_num--;
435     }
436
437     return screen;
438 }
439
440 static int pixfmt_from_pixmap_format(AVFormatContext *s, int depth,
441                                      int *pix_fmt)
442 {
443     XCBGrabContext *c        = s->priv_data;
444     const xcb_setup_t *setup = xcb_get_setup(c->conn);
445     const xcb_format_t *fmt  = xcb_setup_pixmap_formats(setup);
446     int length               = xcb_setup_pixmap_formats_length(setup);
447
448     *pix_fmt = 0;
449
450     while (length--) {
451         if (fmt->depth == depth) {
452             switch (depth) {
453             case 32:
454                 if (fmt->bits_per_pixel == 32)
455                     *pix_fmt = AV_PIX_FMT_ARGB;
456                 break;
457             case 24:
458                 if (fmt->bits_per_pixel == 32)
459                     *pix_fmt = AV_PIX_FMT_RGB32;
460                 else if (fmt->bits_per_pixel == 24)
461                     *pix_fmt = AV_PIX_FMT_RGB24;
462                 break;
463             case 16:
464                 if (fmt->bits_per_pixel == 16)
465                     *pix_fmt = AV_PIX_FMT_RGB565;
466                 break;
467             case 15:
468                 if (fmt->bits_per_pixel == 16)
469                     *pix_fmt = AV_PIX_FMT_RGB555;
470                 break;
471             case 8:
472                 if (fmt->bits_per_pixel == 8)
473                     *pix_fmt = AV_PIX_FMT_RGB8;
474                 break;
475             }
476         }
477
478         if (*pix_fmt) {
479             c->bpp        = fmt->bits_per_pixel;
480             c->frame_size = c->width * c->height * fmt->bits_per_pixel / 8;
481             return 0;
482         }
483
484         fmt++;
485     }
486     av_log(s, AV_LOG_ERROR, "Pixmap format not mappable.\n");
487
488     return AVERROR_PATCHWELCOME;
489 }
490
491 static int create_stream(AVFormatContext *s)
492 {
493     XCBGrabContext *c = s->priv_data;
494     AVStream *st      = avformat_new_stream(s, NULL);
495     const char *opts  = strchr(s->filename, '+');
496     xcb_get_geometry_cookie_t gc;
497     xcb_get_geometry_reply_t *geo;
498     int ret;
499
500     if (!st)
501         return AVERROR(ENOMEM);
502
503     ret = av_parse_video_size(&c->width, &c->height, c->video_size);
504     if (ret < 0)
505         return ret;
506
507     ret = av_parse_video_rate(&st->avg_frame_rate, c->framerate);
508     if (ret < 0)
509         return ret;
510
511     if (opts)
512         sscanf(opts, "%d,%d", &c->x, &c->y);
513
514     avpriv_set_pts_info(st, 64, 1, 1000000);
515
516     gc  = xcb_get_geometry(c->conn, c->screen->root);
517     geo = xcb_get_geometry_reply(c->conn, gc, NULL);
518
519     c->width      = FFMIN(geo->width, c->width);
520     c->height     = FFMIN(geo->height, c->height);
521     c->time_base  = (AVRational){ st->avg_frame_rate.den,
522                                   st->avg_frame_rate.num };
523     c->time_frame = av_gettime();
524
525     st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
526     st->codec->codec_id   = AV_CODEC_ID_RAWVIDEO;
527     st->codec->width      = c->width;
528     st->codec->height     = c->height;
529     st->codec->time_base  = c->time_base;
530
531     ret = pixfmt_from_pixmap_format(s, geo->depth, &st->codec->pix_fmt);
532
533     free(geo);
534
535     return ret;
536 }
537
538 static void draw_rectangle(AVFormatContext *s)
539 {
540     XCBGrabContext *c = s->priv_data;
541     xcb_gcontext_t gc = xcb_generate_id(c->conn);
542     uint32_t mask     = XCB_GC_FOREGROUND |
543                         XCB_GC_BACKGROUND |
544                         XCB_GC_LINE_WIDTH |
545                         XCB_GC_LINE_STYLE |
546                         XCB_GC_FILL_STYLE;
547     uint32_t values[] = { c->screen->black_pixel,
548                           c->screen->white_pixel,
549                           c->region_border,
550                           XCB_LINE_STYLE_DOUBLE_DASH,
551                           XCB_FILL_STYLE_SOLID };
552     xcb_rectangle_t r = { 1, 1,
553                           c->width  + c->region_border * 2 - 3,
554                           c->height + c->region_border * 2 - 3 };
555
556     xcb_create_gc(c->conn, gc, c->window, mask, values);
557
558     xcb_poly_rectangle(c->conn, c->window, gc, 1, &r);
559 }
560
561 static void setup_window(AVFormatContext *s)
562 {
563     XCBGrabContext *c = s->priv_data;
564     uint32_t mask     = XCB_CW_OVERRIDE_REDIRECT | XCB_CW_EVENT_MASK;
565     uint32_t values[] = { 1,
566                           XCB_EVENT_MASK_EXPOSURE |
567                           XCB_EVENT_MASK_STRUCTURE_NOTIFY };
568     xcb_rectangle_t rect = { c->x, c->y, c->width, c->height };
569
570     c->window = xcb_generate_id(c->conn);
571
572     xcb_create_window(c->conn, XCB_COPY_FROM_PARENT,
573                       c->window,
574                       c->screen->root,
575                       c->x - c->region_border,
576                       c->y - c->region_border,
577                       c->width + c->region_border * 2,
578                       c->height + c->region_border * 2,
579                       0,
580                       XCB_WINDOW_CLASS_INPUT_OUTPUT,
581                       XCB_COPY_FROM_PARENT,
582                       mask, values);
583
584     xcb_shape_rectangles(c->conn, XCB_SHAPE_SO_SUBTRACT,
585                          XCB_SHAPE_SK_BOUNDING, XCB_CLIP_ORDERING_UNSORTED,
586                          c->window,
587                          c->region_border, c->region_border,
588                          1, &rect);
589
590     xcb_map_window(c->conn, c->window);
591
592     draw_rectangle(s);
593 }
594
595 static av_cold int xcbgrab_read_header(AVFormatContext *s)
596 {
597     XCBGrabContext *c = s->priv_data;
598     int screen_num, ret;
599     const xcb_setup_t *setup;
600
601     c->conn = xcb_connect(s->filename[0] ? s->filename : NULL, &screen_num);
602     if ((ret = xcb_connection_has_error(c->conn))) {
603         av_log(s, AV_LOG_ERROR, "Cannot open display %s, error %d.\n",
604                s->filename[0] ? s->filename : "default", ret);
605         return AVERROR(EIO);
606     }
607     setup = xcb_get_setup(c->conn);
608
609     c->screen = get_screen(setup, screen_num);
610     if (!c->screen) {
611         av_log(s, AV_LOG_ERROR, "The screen %d does not exist.\n",
612                screen_num);
613         xcbgrab_read_close(s);
614         return AVERROR(EIO);
615     }
616
617     c->segment = xcb_generate_id(c->conn);
618
619     ret = create_stream(s);
620
621     if (ret < 0) {
622         xcbgrab_read_close(s);
623         return ret;
624     }
625
626 #if CONFIG_LIBXCB_SHM
627     c->has_shm = check_shm(c->conn);
628 #endif
629
630 #if CONFIG_LIBXCB_XFIXES
631     if (c->draw_mouse) {
632         if (!(c->draw_mouse = check_xfixes(c->conn))) {
633             av_log(s, AV_LOG_WARNING,
634                    "XFixes not available, cannot draw the mouse.\n");
635         }
636         if (c->bpp < 24) {
637             avpriv_report_missing_feature(s, "%d bits per pixel screen",
638                                           c->bpp);
639             c->draw_mouse = 0;
640         }
641     }
642 #endif
643
644     if (c->show_region)
645         setup_window(s);
646
647     return 0;
648 }
649
650 AVInputFormat ff_x11grab_xcb_demuxer = {
651     .name           = "x11grab",
652     .long_name      = NULL_IF_CONFIG_SMALL("X11 screen capture, using XCB"),
653     .priv_data_size = sizeof(XCBGrabContext),
654     .read_header    = xcbgrab_read_header,
655     .read_packet    = xcbgrab_read_packet,
656     .read_close     = xcbgrab_read_close,
657     .flags          = AVFMT_NOFILE,
658     .priv_class     = &xcbgrab_class,
659 };