3 * Copyright (C) 2014 Luca Barbato <lu_zero@gentoo.org>
5 * This file is part of FFmpeg.
7 * FFmpeg 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.
12 * FFmpeg 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.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27 #if CONFIG_LIBXCB_XFIXES
28 #include <xcb/xfixes.h>
36 #if CONFIG_LIBXCB_SHAPE
37 #include <xcb/shape.h>
40 #include "libavutil/internal.h"
41 #include "libavutil/mathematics.h"
42 #include "libavutil/opt.h"
43 #include "libavutil/parseutils.h"
44 #include "libavutil/time.h"
46 #include "libavformat/avformat.h"
47 #include "libavformat/internal.h"
49 typedef struct XCBGrabContext {
52 xcb_connection_t *conn;
56 AVBufferPool *shm_pool;
60 int64_t frame_duration;
73 const char *framerate;
78 #define FOLLOW_CENTER -1
80 #define OFFSET(x) offsetof(XCBGrabContext, x)
81 #define D AV_OPT_FLAG_DECODING_PARAM
82 static const AVOption options[] = {
83 { "x", "Initial x coordinate.", OFFSET(x), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, D },
84 { "y", "Initial y coordinate.", OFFSET(y), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, D },
85 { "grab_x", "Initial x coordinate.", OFFSET(x), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, D },
86 { "grab_y", "Initial y coordinate.", OFFSET(y), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, D },
87 { "video_size", "A string describing frame size, such as 640x480 or hd720.", OFFSET(width), AV_OPT_TYPE_IMAGE_SIZE, {.str = NULL }, 0, 0, D },
88 { "framerate", "", OFFSET(framerate), AV_OPT_TYPE_STRING, {.str = "ntsc" }, 0, 0, D },
89 { "draw_mouse", "Draw the mouse pointer.", OFFSET(draw_mouse), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, D },
90 { "follow_mouse", "Move the grabbing region when the mouse pointer reaches within specified amount of pixels to the edge of region.",
91 OFFSET(follow_mouse), AV_OPT_TYPE_INT, { .i64 = 0 }, FOLLOW_CENTER, INT_MAX, D, "follow_mouse" },
92 { "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" },
93 { "show_region", "Show the grabbing region.", OFFSET(show_region), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, D },
94 { "region_border", "Set the region border thickness.", OFFSET(region_border), AV_OPT_TYPE_INT, { .i64 = 3 }, 1, 128, D },
98 static const AVClass xcbgrab_class = {
99 .class_name = "xcbgrab indev",
100 .item_name = av_default_item_name,
102 .version = LIBAVUTIL_VERSION_INT,
103 .category = AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT,
106 static int xcbgrab_reposition(AVFormatContext *s,
107 xcb_query_pointer_reply_t *p,
108 xcb_get_geometry_reply_t *geo)
110 XCBGrabContext *c = s->priv_data;
111 int x = c->x, y = c->y;
112 int w = c->width, h = c->height, f = c->follow_mouse;
121 if (f == FOLLOW_CENTER) {
126 int right = x + w - f;
128 int bottom = y + h - f;
131 } else if (p_x < left) {
136 } else if (p_y < top) {
141 c->x = FFMIN(FFMAX(0, x), geo->width - w);
142 c->y = FFMIN(FFMAX(0, y), geo->height - h);
147 static void xcbgrab_image_reply_free(void *opaque, uint8_t *data)
152 static int xcbgrab_frame(AVFormatContext *s, AVPacket *pkt)
154 XCBGrabContext *c = s->priv_data;
155 xcb_get_image_cookie_t iq;
156 xcb_get_image_reply_t *img;
157 xcb_drawable_t drawable = c->screen->root;
158 xcb_generic_error_t *e = NULL;
162 iq = xcb_get_image(c->conn, XCB_IMAGE_FORMAT_Z_PIXMAP, drawable,
163 c->x, c->y, c->width, c->height, ~0);
165 img = xcb_get_image_reply(c->conn, iq, &e);
168 av_log(s, AV_LOG_ERROR,
169 "Cannot get the image data "
170 "event_error: response_type:%u error_code:%u "
171 "sequence:%u resource_id:%u minor_code:%u major_code:%u.\n",
172 e->response_type, e->error_code,
173 e->sequence, e->resource_id, e->minor_code, e->major_code);
175 return AVERROR(EACCES);
179 return AVERROR(EAGAIN);
181 data = xcb_get_image_data(img);
182 length = xcb_get_image_data_length(img);
186 pkt->buf = av_buffer_create(data, length, xcbgrab_image_reply_free, img, 0);
189 return AVERROR(ENOMEM);
198 static int64_t wait_frame(AVFormatContext *s, AVPacket *pkt)
200 XCBGrabContext *c = s->priv_data;
201 int64_t curtime, delay;
203 c->time_frame += c->frame_duration;
206 curtime = av_gettime();
207 delay = c->time_frame - curtime;
216 #if CONFIG_LIBXCB_SHM
217 static int check_shm(xcb_connection_t *conn)
219 xcb_shm_query_version_cookie_t cookie = xcb_shm_query_version(conn);
220 xcb_shm_query_version_reply_t *reply;
222 reply = xcb_shm_query_version_reply(conn, cookie, NULL);
231 static void free_shm_buffer(void *opaque, uint8_t *data)
236 static AVBufferRef *allocate_shm_buffer(void *opaque, int size)
238 xcb_connection_t *conn = opaque;
239 xcb_shm_seg_t segment;
244 id = shmget(IPC_PRIVATE, size, IPC_CREAT | 0777);
248 segment = xcb_generate_id(conn);
249 xcb_shm_attach(conn, segment, id, 0);
250 data = shmat(id, NULL, 0);
251 shmctl(id, IPC_RMID, 0);
252 if ((intptr_t)data == -1 || !data)
255 ref = av_buffer_create(data, size, free_shm_buffer, (void *)(ptrdiff_t)segment, 0);
262 static int xcbgrab_frame_shm(AVFormatContext *s, AVPacket *pkt)
264 XCBGrabContext *c = s->priv_data;
265 xcb_shm_get_image_cookie_t iq;
266 xcb_shm_get_image_reply_t *img;
267 xcb_drawable_t drawable = c->screen->root;
268 xcb_generic_error_t *e = NULL;
270 xcb_shm_seg_t segment;
272 buf = av_buffer_pool_get(c->shm_pool);
274 av_log(s, AV_LOG_ERROR, "Could not get shared memory buffer.\n");
275 return AVERROR(ENOMEM);
277 segment = (xcb_shm_seg_t)av_buffer_pool_buffer_get_opaque(buf);
279 iq = xcb_shm_get_image(c->conn, drawable,
280 c->x, c->y, c->width, c->height, ~0,
281 XCB_IMAGE_FORMAT_Z_PIXMAP, segment, 0);
282 img = xcb_shm_get_image_reply(c->conn, iq, &e);
287 av_log(s, AV_LOG_ERROR,
288 "Cannot get the image data "
289 "event_error: response_type:%u error_code:%u "
290 "sequence:%u resource_id:%u minor_code:%u major_code:%u.\n",
291 e->response_type, e->error_code,
292 e->sequence, e->resource_id, e->minor_code, e->major_code);
295 av_buffer_unref(&buf);
296 return AVERROR(EACCES);
304 pkt->data = buf->data;
305 pkt->size = c->frame_size;
309 #endif /* CONFIG_LIBXCB_SHM */
311 #if CONFIG_LIBXCB_XFIXES
312 static int check_xfixes(xcb_connection_t *conn)
314 xcb_xfixes_query_version_cookie_t cookie;
315 xcb_xfixes_query_version_reply_t *reply;
317 cookie = xcb_xfixes_query_version(conn, XCB_XFIXES_MAJOR_VERSION,
318 XCB_XFIXES_MINOR_VERSION);
319 reply = xcb_xfixes_query_version_reply(conn, cookie, NULL);
328 #define BLEND(target, source, alpha) \
329 (target) + ((source) * (255 - (alpha)) + 255 / 2) / 255
331 static void xcbgrab_draw_mouse(AVFormatContext *s, AVPacket *pkt,
332 xcb_query_pointer_reply_t *p,
333 xcb_get_geometry_reply_t *geo)
335 XCBGrabContext *gr = s->priv_data;
337 uint8_t *image = pkt->data;
338 int stride = gr->bpp / 8;
339 xcb_xfixes_get_cursor_image_cookie_t cc;
340 xcb_xfixes_get_cursor_image_reply_t *ci;
341 int cx, cy, x, y, w, h, c_off, i_off;
343 cc = xcb_xfixes_get_cursor_image(gr->conn);
344 ci = xcb_xfixes_get_cursor_image_reply(gr->conn, cc, NULL);
348 cursor = xcb_xfixes_get_cursor_image_cursor_image(ci);
352 cx = ci->x - ci->xhot;
353 cy = ci->y - ci->yhot;
355 x = FFMAX(cx, gr->x);
356 y = FFMAX(cy, gr->y);
358 w = FFMIN(cx + ci->width, gr->x + gr->width) - x;
359 h = FFMIN(cy + ci->height, gr->y + gr->height) - y;
364 cursor += (y - cy) * ci->width;
365 image += (y - gr->y) * gr->width * stride;
367 for (y = 0; y < h; y++) {
369 image += i_off * stride;
370 for (x = 0; x < w; x++, cursor++, image += stride) {
374 g = (*cursor >> 8) & 0xff;
375 b = (*cursor >> 16) & 0xff;
376 a = (*cursor >> 24) & 0xff;
386 image[0] = BLEND(r, image[0], a);
387 image[1] = BLEND(g, image[1], a);
388 image[2] = BLEND(b, image[2], a);
392 cursor += ci->width - w - c_off;
393 image += (gr->width - w - i_off) * stride;
398 #endif /* CONFIG_LIBXCB_XFIXES */
400 static void xcbgrab_update_region(AVFormatContext *s)
402 XCBGrabContext *c = s->priv_data;
403 const uint32_t args[] = { c->x - c->region_border,
404 c->y - c->region_border };
406 xcb_configure_window(c->conn,
408 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y,
412 static int xcbgrab_read_packet(AVFormatContext *s, AVPacket *pkt)
414 XCBGrabContext *c = s->priv_data;
415 xcb_query_pointer_cookie_t pc;
416 xcb_get_geometry_cookie_t gc;
417 xcb_query_pointer_reply_t *p = NULL;
418 xcb_get_geometry_reply_t *geo = NULL;
422 pts = wait_frame(s, pkt);
424 if (c->follow_mouse || c->draw_mouse) {
425 pc = xcb_query_pointer(c->conn, c->screen->root);
426 gc = xcb_get_geometry(c->conn, c->screen->root);
427 p = xcb_query_pointer_reply(c->conn, pc, NULL);
428 geo = xcb_get_geometry_reply(c->conn, gc, NULL);
431 if (c->follow_mouse && p->same_screen)
432 xcbgrab_reposition(s, p, geo);
435 xcbgrab_update_region(s);
437 #if CONFIG_LIBXCB_SHM
438 if (c->has_shm && xcbgrab_frame_shm(s, pkt) < 0) {
439 av_log(s, AV_LOG_WARNING, "Continuing without shared memory.\n");
444 ret = xcbgrab_frame(s, pkt);
445 pkt->dts = pkt->pts = pts;
446 pkt->duration = c->frame_duration;
448 #if CONFIG_LIBXCB_XFIXES
449 if (ret >= 0 && c->draw_mouse && p->same_screen)
450 xcbgrab_draw_mouse(s, pkt, p, geo);
459 static av_cold int xcbgrab_read_close(AVFormatContext *s)
461 XCBGrabContext *ctx = s->priv_data;
463 #if CONFIG_LIBXCB_SHM
464 av_buffer_pool_uninit(&ctx->shm_pool);
467 xcb_disconnect(ctx->conn);
472 static xcb_screen_t *get_screen(const xcb_setup_t *setup, int screen_num)
474 xcb_screen_iterator_t it = xcb_setup_roots_iterator(setup);
475 xcb_screen_t *screen = NULL;
477 for (; it.rem > 0; xcb_screen_next (&it)) {
489 static int pixfmt_from_pixmap_format(AVFormatContext *s, int depth,
490 int *pix_fmt, int *bpp)
492 XCBGrabContext *c = s->priv_data;
493 const xcb_setup_t *setup = xcb_get_setup(c->conn);
494 const xcb_format_t *fmt = xcb_setup_pixmap_formats(setup);
495 int length = xcb_setup_pixmap_formats_length(setup);
500 if (fmt->depth == depth) {
503 if (fmt->bits_per_pixel == 32)
504 *pix_fmt = AV_PIX_FMT_0RGB;
507 if (fmt->bits_per_pixel == 32)
508 *pix_fmt = AV_PIX_FMT_0RGB32;
509 else if (fmt->bits_per_pixel == 24)
510 *pix_fmt = AV_PIX_FMT_RGB24;
513 if (fmt->bits_per_pixel == 16)
514 *pix_fmt = AV_PIX_FMT_RGB565;
517 if (fmt->bits_per_pixel == 16)
518 *pix_fmt = AV_PIX_FMT_RGB555;
521 if (fmt->bits_per_pixel == 8)
522 *pix_fmt = AV_PIX_FMT_RGB8;
528 *bpp = fmt->bits_per_pixel;
534 avpriv_report_missing_feature(s, "Mapping this pixmap format");
536 return AVERROR_PATCHWELCOME;
539 static int create_stream(AVFormatContext *s)
541 XCBGrabContext *c = s->priv_data;
542 AVStream *st = avformat_new_stream(s, NULL);
543 xcb_get_geometry_cookie_t gc;
544 xcb_get_geometry_reply_t *geo;
545 int64_t frame_size_bits;
549 return AVERROR(ENOMEM);
551 ret = av_parse_video_rate(&st->avg_frame_rate, c->framerate);
555 avpriv_set_pts_info(st, 64, 1, 1000000);
557 gc = xcb_get_geometry(c->conn, c->screen->root);
558 geo = xcb_get_geometry_reply(c->conn, gc, NULL);
560 return AVERROR_EXTERNAL;
562 if (!c->width || !c->height) {
563 c->width = geo->width;
564 c->height = geo->height;
567 if (c->x + c->width > geo->width ||
568 c->y + c->height > geo->height) {
569 av_log(s, AV_LOG_ERROR,
570 "Capture area %dx%d at position %d.%d "
571 "outside the screen size %dx%d\n",
574 geo->width, geo->height);
576 return AVERROR(EINVAL);
579 c->time_base = (AVRational){ st->avg_frame_rate.den,
580 st->avg_frame_rate.num };
581 c->frame_duration = av_rescale_q(1, c->time_base, AV_TIME_BASE_Q);
582 c->time_frame = av_gettime();
584 ret = pixfmt_from_pixmap_format(s, geo->depth, &st->codecpar->format, &c->bpp);
589 frame_size_bits = (int64_t)c->width * c->height * c->bpp;
590 if (frame_size_bits / 8 + AV_INPUT_BUFFER_PADDING_SIZE > INT_MAX) {
591 av_log(s, AV_LOG_ERROR, "Captured area is too large\n");
592 return AVERROR_PATCHWELCOME;
594 c->frame_size = frame_size_bits / 8;
596 #if CONFIG_LIBXCB_SHM
597 c->shm_pool = av_buffer_pool_init2(c->frame_size + AV_INPUT_BUFFER_PADDING_SIZE,
598 c->conn, allocate_shm_buffer, NULL);
600 return AVERROR(ENOMEM);
603 st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
604 st->codecpar->codec_id = AV_CODEC_ID_RAWVIDEO;
605 st->codecpar->width = c->width;
606 st->codecpar->height = c->height;
607 st->codecpar->bit_rate = av_rescale(frame_size_bits, st->avg_frame_rate.num, st->avg_frame_rate.den);
612 static void draw_rectangle(AVFormatContext *s)
614 XCBGrabContext *c = s->priv_data;
615 xcb_gcontext_t gc = xcb_generate_id(c->conn);
616 uint32_t mask = XCB_GC_FOREGROUND |
621 uint32_t values[] = { c->screen->black_pixel,
622 c->screen->white_pixel,
624 XCB_LINE_STYLE_DOUBLE_DASH,
625 XCB_FILL_STYLE_SOLID };
626 xcb_rectangle_t r = { 1, 1,
627 c->width + c->region_border * 2 - 3,
628 c->height + c->region_border * 2 - 3 };
630 xcb_create_gc(c->conn, gc, c->window, mask, values);
632 xcb_poly_rectangle(c->conn, c->window, gc, 1, &r);
635 static void setup_window(AVFormatContext *s)
637 XCBGrabContext *c = s->priv_data;
638 uint32_t mask = XCB_CW_OVERRIDE_REDIRECT | XCB_CW_EVENT_MASK;
639 uint32_t values[] = { 1,
640 XCB_EVENT_MASK_EXPOSURE |
641 XCB_EVENT_MASK_STRUCTURE_NOTIFY };
642 av_unused xcb_rectangle_t rect = { 0, 0, c->width, c->height };
644 c->window = xcb_generate_id(c->conn);
646 xcb_create_window(c->conn, XCB_COPY_FROM_PARENT,
649 c->x - c->region_border,
650 c->y - c->region_border,
651 c->width + c->region_border * 2,
652 c->height + c->region_border * 2,
654 XCB_WINDOW_CLASS_INPUT_OUTPUT,
655 XCB_COPY_FROM_PARENT,
658 #if CONFIG_LIBXCB_SHAPE
659 xcb_shape_rectangles(c->conn, XCB_SHAPE_SO_SUBTRACT,
660 XCB_SHAPE_SK_BOUNDING, XCB_CLIP_ORDERING_UNSORTED,
662 c->region_border, c->region_border,
666 xcb_map_window(c->conn, c->window);
671 static av_cold int xcbgrab_read_header(AVFormatContext *s)
673 XCBGrabContext *c = s->priv_data;
675 const xcb_setup_t *setup;
676 char *display_name = av_strdup(s->url);
679 return AVERROR(ENOMEM);
681 if (!sscanf(s->url, "%[^+]+%d,%d", display_name, &c->x, &c->y)) {
683 sscanf(s->url, "+%d,%d", &c->x, &c->y);
686 c->conn = xcb_connect(display_name[0] ? display_name : NULL, &screen_num);
687 av_freep(&display_name);
689 if ((ret = xcb_connection_has_error(c->conn))) {
690 av_log(s, AV_LOG_ERROR, "Cannot open display %s, error %d.\n",
691 s->url[0] ? s->url : "default", ret);
695 setup = xcb_get_setup(c->conn);
697 c->screen = get_screen(setup, screen_num);
699 av_log(s, AV_LOG_ERROR, "The screen %d does not exist.\n",
701 xcbgrab_read_close(s);
705 ret = create_stream(s);
708 xcbgrab_read_close(s);
712 #if CONFIG_LIBXCB_SHM
713 c->has_shm = check_shm(c->conn);
716 #if CONFIG_LIBXCB_XFIXES
718 if (!(c->draw_mouse = check_xfixes(c->conn))) {
719 av_log(s, AV_LOG_WARNING,
720 "XFixes not available, cannot draw the mouse.\n");
723 avpriv_report_missing_feature(s, "%d bits per pixel screen",
736 AVInputFormat ff_xcbgrab_demuxer = {
738 .long_name = NULL_IF_CONFIG_SMALL("X11 screen capture, using XCB"),
739 .priv_data_size = sizeof(XCBGrabContext),
740 .read_header = xcbgrab_read_header,
741 .read_packet = xcbgrab_read_packet,
742 .read_close = xcbgrab_read_close,
743 .flags = AVFMT_NOFILE,
744 .priv_class = &xcbgrab_class,