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 "libavformat/avformat.h"
41 #include "libavformat/internal.h"
43 #include "libavutil/mathematics.h"
44 #include "libavutil/opt.h"
45 #include "libavutil/parseutils.h"
46 #include "libavutil/time.h"
48 typedef struct XCBGrabContext {
51 xcb_connection_t *conn;
55 xcb_shm_seg_t segment;
72 const char *video_size;
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 { "video_size", "A string describing frame size, such as 640x480 or hd720.", OFFSET(video_size), AV_OPT_TYPE_STRING, {.str = "vga" }, 0, 0, D },
86 { "framerate", "", OFFSET(framerate), AV_OPT_TYPE_STRING, {.str = "ntsc" }, 0, 0, D },
87 { "draw_mouse", "Draw the mouse pointer.", OFFSET(draw_mouse), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, D },
88 { "follow_mouse", "Move the grabbing region when the mouse pointer reaches within specified amount of pixels to the edge of region.",
89 OFFSET(follow_mouse), AV_OPT_TYPE_INT, { .i64 = 0 }, FOLLOW_CENTER, INT_MAX, D, "follow_mouse" },
90 { "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" },
91 { "show_region", "Show the grabbing region.", OFFSET(show_region), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, D },
92 { "region_border", "Set the region border thickness.", OFFSET(region_border), AV_OPT_TYPE_INT, { .i64 = 3 }, 1, 128, D },
96 static const AVClass xcbgrab_class = {
97 .class_name = "xcbgrab indev",
98 .item_name = av_default_item_name,
100 .version = LIBAVUTIL_VERSION_INT,
101 .category = AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT,
104 static int xcbgrab_reposition(AVFormatContext *s,
105 xcb_query_pointer_reply_t *p,
106 xcb_get_geometry_reply_t *geo)
108 XCBGrabContext *c = s->priv_data;
109 int x = c->x, y = c->y;
110 int w = c->width, h = c->height, f = c->follow_mouse;
119 if (f == FOLLOW_CENTER) {
124 int right = x + w - f;
126 int bottom = y + h + f;
129 } else if (p_x < left) {
134 } else if (p_y < top) {
139 c->x = FFMIN(FFMAX(0, x), geo->width - w);
140 c->y = FFMIN(FFMAX(0, y), geo->height - h);
145 static int xcbgrab_frame(AVFormatContext *s, AVPacket *pkt)
147 XCBGrabContext *c = s->priv_data;
148 xcb_get_image_cookie_t iq;
149 xcb_get_image_reply_t *img;
150 xcb_drawable_t drawable = c->screen->root;
154 iq = xcb_get_image(c->conn, XCB_IMAGE_FORMAT_Z_PIXMAP, drawable,
155 c->x, c->y, c->width, c->height, ~0);
157 img = xcb_get_image_reply(c->conn, iq, NULL);
159 return AVERROR(EAGAIN);
161 data = xcb_get_image_data(img);
162 length = xcb_get_image_data_length(img);
164 ret = av_new_packet(pkt, length);
167 memcpy(pkt->data, data, length);
174 static void wait_frame(AVFormatContext *s, AVPacket *pkt)
176 XCBGrabContext *c = s->priv_data;
177 int64_t curtime, delay;
178 int64_t frame_time = av_rescale_q(1, c->time_base, AV_TIME_BASE_Q);
180 c->time_frame += frame_time;
183 curtime = av_gettime();
184 delay = c->time_frame - curtime;
193 #if CONFIG_LIBXCB_SHM
194 static int check_shm(xcb_connection_t *conn)
196 xcb_shm_query_version_cookie_t cookie = xcb_shm_query_version(conn);
197 xcb_shm_query_version_reply_t *reply;
199 reply = xcb_shm_query_version_reply(conn, cookie, NULL);
208 static void dealloc_shm(void *unused, uint8_t *data)
213 static int xcbgrab_frame_shm(AVFormatContext *s, AVPacket *pkt)
215 XCBGrabContext *c = s->priv_data;
216 xcb_shm_get_image_cookie_t iq;
217 xcb_shm_get_image_reply_t *img;
218 xcb_drawable_t drawable = c->screen->root;
220 int size = c->frame_size + FF_INPUT_BUFFER_PADDING_SIZE;
221 int id = shmget(IPC_PRIVATE, size, IPC_CREAT | 0777);
222 xcb_generic_error_t *e = NULL;
226 int err = AVERROR(errno);
227 av_strerror(err, errbuf, sizeof(errbuf));
228 av_log(s, AV_LOG_ERROR, "Cannot get %d bytes of shared memory: %s.\n",
233 xcb_shm_attach(c->conn, c->segment, id, 0);
235 iq = xcb_shm_get_image(c->conn, drawable,
236 c->x, c->y, c->width, c->height, ~0,
237 XCB_IMAGE_FORMAT_Z_PIXMAP, c->segment, 0);
239 xcb_shm_detach(c->conn, c->segment);
241 img = xcb_shm_get_image_reply(c->conn, iq, &e);
246 av_log(s, AV_LOG_ERROR,
247 "Cannot get the image data "
248 "event_error: response_type:%u error_code:%u "
249 "sequence:%u resource_id:%u minor_code:%u major_code:%u.\n",
250 e->response_type, e->error_code,
251 e->sequence, e->resource_id, e->minor_code, e->major_code);
253 shmctl(id, IPC_RMID, 0);
254 return AVERROR(EACCES);
259 data = shmat(id, NULL, 0);
260 shmctl(id, IPC_RMID, 0);
262 if ((intptr_t)data == -1)
263 return AVERROR(errno);
265 pkt->buf = av_buffer_create(data, size, dealloc_shm, NULL, 0);
268 return AVERROR(ENOMEM);
271 pkt->data = pkt->buf->data;
272 pkt->size = c->frame_size;
276 #endif /* CONFIG_LIBXCB_SHM */
278 #if CONFIG_LIBXCB_XFIXES
279 static int check_xfixes(xcb_connection_t *conn)
281 xcb_xfixes_query_version_cookie_t cookie;
282 xcb_xfixes_query_version_reply_t *reply;
284 cookie = xcb_xfixes_query_version(conn, XCB_XFIXES_MAJOR_VERSION,
285 XCB_XFIXES_MINOR_VERSION);
286 reply = xcb_xfixes_query_version_reply(conn, cookie, NULL);
295 #define BLEND(target, source, alpha) \
296 (target) + ((source) * (255 - (alpha)) + 255 / 2) / 255
298 static void xcbgrab_draw_mouse(AVFormatContext *s, AVPacket *pkt,
299 xcb_query_pointer_reply_t *p,
300 xcb_get_geometry_reply_t *geo)
302 XCBGrabContext *gr = s->priv_data;
304 uint8_t *image = pkt->data;
305 int stride = gr->bpp / 8;
306 xcb_xfixes_get_cursor_image_cookie_t cc;
307 xcb_xfixes_get_cursor_image_reply_t *ci;
308 int cx, cy, x, y, w, h, c_off, i_off;
310 cc = xcb_xfixes_get_cursor_image(gr->conn);
311 ci = xcb_xfixes_get_cursor_image_reply(gr->conn, cc, NULL);
315 cursor = xcb_xfixes_get_cursor_image_cursor_image(ci);
319 cx = ci->x - ci->xhot;
320 cy = ci->y - ci->yhot;
322 x = FFMAX(cx, gr->x);
323 y = FFMAX(cy, gr->y);
325 w = FFMIN(cx + ci->width, gr->x + gr->width) - x;
326 h = FFMIN(cy + ci->height, gr->y + gr->height) - y;
331 cursor += (y - cy) * ci->width;
332 image += (y - gr->y) * gr->width * stride;
334 for (y = 0; y < h; y++) {
336 image += i_off * stride;
337 for (x = 0; x < w; x++, cursor++, image += stride) {
341 g = (*cursor >> 8) & 0xff;
342 b = (*cursor >> 16) & 0xff;
343 a = (*cursor >> 24) & 0xff;
353 image[0] = BLEND(r, image[0], a);
354 image[1] = BLEND(g, image[1], a);
355 image[2] = BLEND(b, image[2], a);
359 cursor += ci->width - w - c_off;
360 image += (gr->width - w - i_off) * stride;
365 #endif /* CONFIG_LIBXCB_XFIXES */
367 static void xcbgrab_update_region(AVFormatContext *s)
369 XCBGrabContext *c = s->priv_data;
370 const uint32_t args[] = { c->x - c->region_border,
371 c->y - c->region_border };
373 xcb_configure_window(c->conn,
375 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y,
379 static int xcbgrab_read_packet(AVFormatContext *s, AVPacket *pkt)
381 XCBGrabContext *c = s->priv_data;
382 xcb_query_pointer_cookie_t pc;
383 xcb_get_geometry_cookie_t gc;
384 xcb_query_pointer_reply_t *p = NULL;
385 xcb_get_geometry_reply_t *geo = NULL;
390 if (c->follow_mouse || c->draw_mouse) {
391 pc = xcb_query_pointer(c->conn, c->screen->root);
392 gc = xcb_get_geometry(c->conn, c->screen->root);
393 p = xcb_query_pointer_reply(c->conn, pc, NULL);
394 geo = xcb_get_geometry_reply(c->conn, gc, NULL);
397 if (c->follow_mouse && p->same_screen)
398 xcbgrab_reposition(s, p, geo);
401 xcbgrab_update_region(s);
403 #if CONFIG_LIBXCB_SHM
404 if (c->has_shm && xcbgrab_frame_shm(s, pkt) < 0)
408 ret = xcbgrab_frame(s, pkt);
410 #if CONFIG_LIBXCB_XFIXES
411 if (c->draw_mouse && p->same_screen)
412 xcbgrab_draw_mouse(s, pkt, p, geo);
421 static av_cold int xcbgrab_read_close(AVFormatContext *s)
423 XCBGrabContext *ctx = s->priv_data;
425 xcb_disconnect(ctx->conn);
430 static xcb_screen_t *get_screen(const xcb_setup_t *setup, int screen_num)
432 xcb_screen_iterator_t it = xcb_setup_roots_iterator(setup);
433 xcb_screen_t *screen = NULL;
435 for (; it.rem > 0; xcb_screen_next (&it)) {
447 static int pixfmt_from_pixmap_format(AVFormatContext *s, int depth,
450 XCBGrabContext *c = s->priv_data;
451 const xcb_setup_t *setup = xcb_get_setup(c->conn);
452 const xcb_format_t *fmt = xcb_setup_pixmap_formats(setup);
453 int length = xcb_setup_pixmap_formats_length(setup);
458 if (fmt->depth == depth) {
461 if (fmt->bits_per_pixel == 32)
462 *pix_fmt = AV_PIX_FMT_0RGB;
465 if (fmt->bits_per_pixel == 32)
466 *pix_fmt = AV_PIX_FMT_0RGB32;
467 else if (fmt->bits_per_pixel == 24)
468 *pix_fmt = AV_PIX_FMT_RGB24;
471 if (fmt->bits_per_pixel == 16)
472 *pix_fmt = AV_PIX_FMT_RGB565;
475 if (fmt->bits_per_pixel == 16)
476 *pix_fmt = AV_PIX_FMT_RGB555;
479 if (fmt->bits_per_pixel == 8)
480 *pix_fmt = AV_PIX_FMT_RGB8;
486 c->bpp = fmt->bits_per_pixel;
487 c->frame_size = c->width * c->height * fmt->bits_per_pixel / 8;
493 av_log(s, AV_LOG_ERROR, "Pixmap format not mappable.\n");
495 return AVERROR_PATCHWELCOME;
498 static int create_stream(AVFormatContext *s)
500 XCBGrabContext *c = s->priv_data;
501 AVStream *st = avformat_new_stream(s, NULL);
502 xcb_get_geometry_cookie_t gc;
503 xcb_get_geometry_reply_t *geo;
507 return AVERROR(ENOMEM);
509 ret = av_parse_video_size(&c->width, &c->height, c->video_size);
513 ret = av_parse_video_rate(&st->avg_frame_rate, c->framerate);
517 avpriv_set_pts_info(st, 64, 1, 1000000);
519 gc = xcb_get_geometry(c->conn, c->screen->root);
520 geo = xcb_get_geometry_reply(c->conn, gc, NULL);
522 c->width = FFMIN(geo->width, c->width);
523 c->height = FFMIN(geo->height, c->height);
524 c->time_base = (AVRational){ st->avg_frame_rate.den,
525 st->avg_frame_rate.num };
526 c->time_frame = av_gettime();
528 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
529 st->codec->codec_id = AV_CODEC_ID_RAWVIDEO;
530 st->codec->width = c->width;
531 st->codec->height = c->height;
532 st->codec->time_base = c->time_base;
534 ret = pixfmt_from_pixmap_format(s, geo->depth, &st->codec->pix_fmt);
541 static void draw_rectangle(AVFormatContext *s)
543 XCBGrabContext *c = s->priv_data;
544 xcb_gcontext_t gc = xcb_generate_id(c->conn);
545 uint32_t mask = XCB_GC_FOREGROUND |
550 uint32_t values[] = { c->screen->black_pixel,
551 c->screen->white_pixel,
553 XCB_LINE_STYLE_DOUBLE_DASH,
554 XCB_FILL_STYLE_SOLID };
555 xcb_rectangle_t r = { 1, 1,
556 c->width + c->region_border * 2 - 3,
557 c->height + c->region_border * 2 - 3 };
559 xcb_create_gc(c->conn, gc, c->window, mask, values);
561 xcb_poly_rectangle(c->conn, c->window, gc, 1, &r);
564 static void setup_window(AVFormatContext *s)
566 XCBGrabContext *c = s->priv_data;
567 uint32_t mask = XCB_CW_OVERRIDE_REDIRECT | XCB_CW_EVENT_MASK;
568 uint32_t values[] = { 1,
569 XCB_EVENT_MASK_EXPOSURE |
570 XCB_EVENT_MASK_STRUCTURE_NOTIFY };
571 xcb_rectangle_t rect = { 0, 0, c->width, c->height };
573 c->window = xcb_generate_id(c->conn);
575 xcb_create_window(c->conn, XCB_COPY_FROM_PARENT,
578 c->x - c->region_border,
579 c->y - c->region_border,
580 c->width + c->region_border * 2,
581 c->height + c->region_border * 2,
583 XCB_WINDOW_CLASS_INPUT_OUTPUT,
584 XCB_COPY_FROM_PARENT,
587 #if CONFIG_LIBXCB_SHAPE
588 xcb_shape_rectangles(c->conn, XCB_SHAPE_SO_SUBTRACT,
589 XCB_SHAPE_SK_BOUNDING, XCB_CLIP_ORDERING_UNSORTED,
591 c->region_border, c->region_border,
595 xcb_map_window(c->conn, c->window);
600 static av_cold int xcbgrab_read_header(AVFormatContext *s)
602 XCBGrabContext *c = s->priv_data;
604 const xcb_setup_t *setup;
605 char *display_name = av_strdup(s->filename);
608 return AVERROR(ENOMEM);
610 if (!sscanf(s->filename, "%[^+]+%d,%d", display_name, &c->x, &c->y)) {
612 sscanf(s->filename, "+%d,%d", &c->x, &c->y);
615 c->conn = xcb_connect(display_name[0] ? display_name : NULL, &screen_num);
616 av_freep(&display_name);
617 if ((ret = xcb_connection_has_error(c->conn))) {
618 av_log(s, AV_LOG_ERROR, "Cannot open display %s, error %d.\n",
619 s->filename[0] ? s->filename : "default", ret);
622 setup = xcb_get_setup(c->conn);
624 c->screen = get_screen(setup, screen_num);
626 av_log(s, AV_LOG_ERROR, "The screen %d does not exist.\n",
628 xcbgrab_read_close(s);
632 #if CONFIG_LIBXCB_SHM
633 c->segment = xcb_generate_id(c->conn);
636 ret = create_stream(s);
639 xcbgrab_read_close(s);
643 #if CONFIG_LIBXCB_SHM
644 c->has_shm = check_shm(c->conn);
647 #if CONFIG_LIBXCB_XFIXES
649 if (!(c->draw_mouse = check_xfixes(c->conn))) {
650 av_log(s, AV_LOG_WARNING,
651 "XFixes not available, cannot draw the mouse.\n");
654 avpriv_report_missing_feature(s, "%d bits per pixel screen",
667 AVInputFormat ff_x11grab_xcb_demuxer = {
669 .long_name = NULL_IF_CONFIG_SMALL("X11 screen capture, using XCB"),
670 .priv_data_size = sizeof(XCBGrabContext),
671 .read_header = xcbgrab_read_header,
672 .read_packet = xcbgrab_read_packet,
673 .read_close = xcbgrab_read_close,
674 .flags = AVFMT_NOFILE,
675 .priv_class = &xcbgrab_class,