3 * Copyright (C) 2014 Luca Barbato <lu_zero@gentoo.org>
5 * This file is part of Libav.
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.
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.
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
26 #include <xcb/shape.h>
28 #if CONFIG_LIBXCB_XFIXES
29 #include <xcb/xfixes.h>
37 #include "libavutil/internal.h"
38 #include "libavutil/mathematics.h"
39 #include "libavutil/opt.h"
40 #include "libavutil/parseutils.h"
41 #include "libavutil/time.h"
43 #include "libavformat/avformat.h"
44 #include "libavformat/internal.h"
46 typedef struct XCBGrabContext {
49 xcb_connection_t *conn;
53 xcb_shm_seg_t segment;
69 const char *video_size;
70 const char *framerate;
75 #define FOLLOW_CENTER -1
77 #define OFFSET(x) offsetof(XCBGrabContext, x)
78 #define D AV_OPT_FLAG_DECODING_PARAM
79 static const AVOption options[] = {
80 { "x", "Initial x coordinate.", OFFSET(x), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, D },
81 { "y", "Initial y coordinate.", OFFSET(y), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, D },
82 { "grab_x", "Initial x coordinate.", OFFSET(x), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, D },
83 { "grab_y", "Initial y coordinate.", OFFSET(y), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, D },
84 { "video_size", "A string describing frame size, such as 640x480 or hd720.", OFFSET(video_size), AV_OPT_TYPE_STRING, {.str = "vga" }, 0, 0, D },
85 { "framerate", "", OFFSET(framerate), AV_OPT_TYPE_STRING, {.str = "ntsc" }, 0, 0, D },
86 { "draw_mouse", "Draw the mouse pointer.", OFFSET(draw_mouse), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, D },
87 { "follow_mouse", "Move the grabbing region when the mouse pointer reaches within specified amount of pixels to the edge of region.",
88 OFFSET(follow_mouse), AV_OPT_TYPE_INT, { .i64 = 0 }, FOLLOW_CENTER, INT_MAX, D, "follow_mouse" },
89 { "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" },
90 { "show_region", "Show the grabbing region.", OFFSET(show_region), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, D },
91 { "region_border", "Set the region border thickness.", OFFSET(region_border), AV_OPT_TYPE_INT, { .i64 = 3 }, 1, 128, D },
95 static const AVClass xcbgrab_class = {
96 .class_name = "xcbgrab indev",
97 .item_name = av_default_item_name,
99 .version = LIBAVUTIL_VERSION_INT,
102 static int xcbgrab_reposition(AVFormatContext *s,
103 xcb_query_pointer_reply_t *p,
104 xcb_get_geometry_reply_t *geo)
106 XCBGrabContext *c = s->priv_data;
107 int x = c->x, y = c->y;
108 int w = c->width, h = c->height, f = c->follow_mouse;
117 if (f == FOLLOW_CENTER) {
122 int right = x + w - f;
124 int bottom = y + h + f;
127 } else if (p_x < left) {
132 } else if (p_y < top) {
137 c->x = FFMIN(FFMAX(0, x), geo->width - w);
138 c->y = FFMIN(FFMAX(0, y), geo->height - h);
143 static int xcbgrab_frame(AVFormatContext *s, AVPacket *pkt)
145 XCBGrabContext *c = s->priv_data;
146 xcb_get_image_cookie_t iq;
147 xcb_get_image_reply_t *img;
148 xcb_drawable_t drawable = c->screen->root;
149 xcb_generic_error_t *e = NULL;
153 iq = xcb_get_image(c->conn, XCB_IMAGE_FORMAT_Z_PIXMAP, drawable,
154 c->x, c->y, c->width, c->height, ~0);
156 img = xcb_get_image_reply(c->conn, iq, &e);
159 av_log(s, AV_LOG_ERROR,
160 "Cannot get the image data "
161 "event_error: response_type:%u error_code:%u "
162 "sequence:%u resource_id:%u minor_code:%u major_code:%u.\n",
163 e->response_type, e->error_code,
164 e->sequence, e->resource_id, e->minor_code, e->major_code);
165 return AVERROR(EACCES);
169 return AVERROR(EAGAIN);
171 data = xcb_get_image_data(img);
172 length = xcb_get_image_data_length(img);
174 ret = av_new_packet(pkt, length);
177 memcpy(pkt->data, data, length);
184 static void wait_frame(AVFormatContext *s, AVPacket *pkt)
186 XCBGrabContext *c = s->priv_data;
187 int64_t curtime, delay;
188 int64_t frame_time = av_rescale_q(1, c->time_base, AV_TIME_BASE_Q);
190 c->time_frame += frame_time;
193 curtime = av_gettime();
194 delay = c->time_frame - curtime;
203 #if CONFIG_LIBXCB_SHM
204 static int check_shm(xcb_connection_t *conn)
206 xcb_shm_query_version_cookie_t cookie = xcb_shm_query_version(conn);
207 xcb_shm_query_version_reply_t *reply;
209 reply = xcb_shm_query_version_reply(conn, cookie, NULL);
218 static void dealloc_shm(void *unused, uint8_t *data)
223 static int xcbgrab_frame_shm(AVFormatContext *s, AVPacket *pkt)
225 XCBGrabContext *c = s->priv_data;
226 xcb_shm_get_image_cookie_t iq;
227 xcb_shm_get_image_reply_t *img;
228 xcb_drawable_t drawable = c->screen->root;
230 int size = c->frame_size + AV_INPUT_BUFFER_PADDING_SIZE;
231 int id = shmget(IPC_PRIVATE, size, IPC_CREAT | 0777);
232 xcb_generic_error_t *e = NULL;
236 int err = AVERROR(errno);
237 av_strerror(err, errbuf, sizeof(errbuf));
238 av_log(s, AV_LOG_ERROR, "Cannot get %d bytes of shared memory: %s.\n",
243 xcb_shm_attach(c->conn, c->segment, id, 0);
245 iq = xcb_shm_get_image(c->conn, drawable,
246 c->x, c->y, c->width, c->height, ~0,
247 XCB_IMAGE_FORMAT_Z_PIXMAP, c->segment, 0);
249 xcb_shm_detach(c->conn, c->segment);
251 img = xcb_shm_get_image_reply(c->conn, iq, &e);
256 av_log(s, AV_LOG_ERROR,
257 "Cannot get the image data "
258 "event_error: response_type:%u error_code:%u "
259 "sequence:%u resource_id:%u minor_code:%u major_code:%u.\n",
260 e->response_type, e->error_code,
261 e->sequence, e->resource_id, e->minor_code, e->major_code);
263 shmctl(id, IPC_RMID, 0);
264 return AVERROR(EACCES);
269 data = shmat(id, NULL, 0);
270 shmctl(id, IPC_RMID, 0);
272 if ((intptr_t)data == -1)
273 return AVERROR(errno);
275 pkt->buf = av_buffer_create(data, size, dealloc_shm, NULL, 0);
278 return AVERROR(ENOMEM);
281 pkt->data = pkt->buf->data;
282 pkt->size = c->frame_size;
286 #endif /* CONFIG_LIBXCB_SHM */
288 #if CONFIG_LIBXCB_XFIXES
289 static int check_xfixes(xcb_connection_t *conn)
291 xcb_xfixes_query_version_cookie_t cookie;
292 xcb_xfixes_query_version_reply_t *reply;
294 cookie = xcb_xfixes_query_version(conn, XCB_XFIXES_MAJOR_VERSION,
295 XCB_XFIXES_MINOR_VERSION);
296 reply = xcb_xfixes_query_version_reply(conn, cookie, NULL);
305 #define BLEND(target, source, alpha) \
306 (target) + ((source) * (255 - (alpha)) + 255 / 2) / 255
308 static void xcbgrab_draw_mouse(AVFormatContext *s, AVPacket *pkt,
309 xcb_query_pointer_reply_t *p,
310 xcb_get_geometry_reply_t *geo)
312 XCBGrabContext *gr = s->priv_data;
314 uint8_t *image = pkt->data;
315 int stride = gr->bpp / 8;
316 xcb_xfixes_get_cursor_image_cookie_t cc;
317 xcb_xfixes_get_cursor_image_reply_t *ci;
318 int cx, cy, x, y, w, h, c_off, i_off;
320 cc = xcb_xfixes_get_cursor_image(gr->conn);
321 ci = xcb_xfixes_get_cursor_image_reply(gr->conn, cc, NULL);
325 cursor = xcb_xfixes_get_cursor_image_cursor_image(ci);
329 cx = ci->x - ci->xhot;
330 cy = ci->y - ci->yhot;
332 x = FFMAX(cx, gr->x);
333 y = FFMAX(cy, gr->y);
335 w = FFMIN(cx + ci->width, gr->x + gr->width) - x;
336 h = FFMIN(cy + ci->height, gr->y + gr->height) - y;
341 cursor += (y - cy) * ci->width;
342 image += (y - gr->y) * gr->width * stride;
344 for (y = 0; y < h; y++) {
346 image += i_off * stride;
347 for (x = 0; x < w; x++, cursor++, image += stride) {
351 g = (*cursor >> 8) & 0xff;
352 b = (*cursor >> 16) & 0xff;
353 a = (*cursor >> 24) & 0xff;
363 image[0] = BLEND(r, image[0], a);
364 image[1] = BLEND(g, image[1], a);
365 image[2] = BLEND(b, image[2], a);
369 cursor += ci->width - w - c_off;
370 image += (gr->width - w - i_off) * stride;
375 #endif /* CONFIG_LIBXCB_XFIXES */
377 static void xcbgrab_update_region(AVFormatContext *s)
379 XCBGrabContext *c = s->priv_data;
380 const uint32_t args[] = { c->x - c->region_border,
381 c->y - c->region_border };
383 xcb_configure_window(c->conn,
385 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y,
389 static int xcbgrab_read_packet(AVFormatContext *s, AVPacket *pkt)
391 XCBGrabContext *c = s->priv_data;
392 xcb_query_pointer_cookie_t pc;
393 xcb_get_geometry_cookie_t gc;
394 xcb_query_pointer_reply_t *p = NULL;
395 xcb_get_geometry_reply_t *geo = NULL;
400 if (c->follow_mouse || c->draw_mouse) {
401 pc = xcb_query_pointer(c->conn, c->screen->root);
402 gc = xcb_get_geometry(c->conn, c->screen->root);
403 p = xcb_query_pointer_reply(c->conn, pc, NULL);
404 geo = xcb_get_geometry_reply(c->conn, gc, NULL);
407 if (c->follow_mouse && p->same_screen)
408 xcbgrab_reposition(s, p, geo);
411 xcbgrab_update_region(s);
413 #if CONFIG_LIBXCB_SHM
414 if (c->has_shm && xcbgrab_frame_shm(s, pkt) < 0)
418 ret = xcbgrab_frame(s, pkt);
420 #if CONFIG_LIBXCB_XFIXES
421 if (ret >= 0 && c->draw_mouse && p->same_screen)
422 xcbgrab_draw_mouse(s, pkt, p, geo);
431 static av_cold int xcbgrab_read_close(AVFormatContext *s)
433 XCBGrabContext *ctx = s->priv_data;
435 xcb_disconnect(ctx->conn);
440 static xcb_screen_t *get_screen(const xcb_setup_t *setup, int screen_num)
442 xcb_screen_iterator_t it = xcb_setup_roots_iterator(setup);
443 xcb_screen_t *screen = NULL;
445 for (; it.rem > 0; xcb_screen_next (&it)) {
457 static int pixfmt_from_pixmap_format(AVFormatContext *s, int depth,
460 XCBGrabContext *c = s->priv_data;
461 const xcb_setup_t *setup = xcb_get_setup(c->conn);
462 const xcb_format_t *fmt = xcb_setup_pixmap_formats(setup);
463 int length = xcb_setup_pixmap_formats_length(setup);
468 if (fmt->depth == depth) {
471 if (fmt->bits_per_pixel == 32)
472 *pix_fmt = AV_PIX_FMT_ARGB;
475 if (fmt->bits_per_pixel == 32)
476 *pix_fmt = AV_PIX_FMT_RGB32;
477 else if (fmt->bits_per_pixel == 24)
478 *pix_fmt = AV_PIX_FMT_RGB24;
481 if (fmt->bits_per_pixel == 16)
482 *pix_fmt = AV_PIX_FMT_RGB565;
485 if (fmt->bits_per_pixel == 16)
486 *pix_fmt = AV_PIX_FMT_RGB555;
489 if (fmt->bits_per_pixel == 8)
490 *pix_fmt = AV_PIX_FMT_RGB8;
496 c->bpp = fmt->bits_per_pixel;
497 c->frame_size = c->width * c->height * fmt->bits_per_pixel / 8;
503 avpriv_report_missing_feature(s, "Mapping this pixmap format");
505 return AVERROR_PATCHWELCOME;
508 static int create_stream(AVFormatContext *s)
510 XCBGrabContext *c = s->priv_data;
511 AVStream *st = avformat_new_stream(s, NULL);
512 xcb_get_geometry_cookie_t gc;
513 xcb_get_geometry_reply_t *geo;
517 return AVERROR(ENOMEM);
519 ret = av_parse_video_size(&c->width, &c->height, c->video_size);
523 ret = av_parse_video_rate(&st->avg_frame_rate, c->framerate);
527 avpriv_set_pts_info(st, 64, 1, 1000000);
529 gc = xcb_get_geometry(c->conn, c->screen->root);
530 geo = xcb_get_geometry_reply(c->conn, gc, NULL);
532 if (c->x + c->width > geo->width ||
533 c->y + c->height > geo->height) {
534 av_log(s, AV_LOG_ERROR,
535 "Capture area %dx%d at position %d.%d "
536 "outside the screen size %dx%d\n",
539 geo->width, geo->height);
540 return AVERROR(EINVAL);
543 c->time_base = (AVRational){ st->avg_frame_rate.den,
544 st->avg_frame_rate.num };
545 c->time_frame = av_gettime();
547 st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
548 st->codecpar->codec_id = AV_CODEC_ID_RAWVIDEO;
549 st->codecpar->width = c->width;
550 st->codecpar->height = c->height;
552 ret = pixfmt_from_pixmap_format(s, geo->depth, &st->codecpar->format);
559 static void draw_rectangle(AVFormatContext *s)
561 XCBGrabContext *c = s->priv_data;
562 xcb_gcontext_t gc = xcb_generate_id(c->conn);
563 uint32_t mask = XCB_GC_FOREGROUND |
568 uint32_t values[] = { c->screen->black_pixel,
569 c->screen->white_pixel,
571 XCB_LINE_STYLE_DOUBLE_DASH,
572 XCB_FILL_STYLE_SOLID };
573 xcb_rectangle_t r = { 1, 1,
574 c->width + c->region_border * 2 - 3,
575 c->height + c->region_border * 2 - 3 };
577 xcb_create_gc(c->conn, gc, c->window, mask, values);
579 xcb_poly_rectangle(c->conn, c->window, gc, 1, &r);
582 static void setup_window(AVFormatContext *s)
584 XCBGrabContext *c = s->priv_data;
585 uint32_t mask = XCB_CW_OVERRIDE_REDIRECT | XCB_CW_EVENT_MASK;
586 uint32_t values[] = { 1,
587 XCB_EVENT_MASK_EXPOSURE |
588 XCB_EVENT_MASK_STRUCTURE_NOTIFY };
589 xcb_rectangle_t rect = { 0, 0, c->width, c->height };
591 c->window = xcb_generate_id(c->conn);
593 xcb_create_window(c->conn, XCB_COPY_FROM_PARENT,
596 c->x - c->region_border,
597 c->y - c->region_border,
598 c->width + c->region_border * 2,
599 c->height + c->region_border * 2,
601 XCB_WINDOW_CLASS_INPUT_OUTPUT,
602 XCB_COPY_FROM_PARENT,
605 xcb_shape_rectangles(c->conn, XCB_SHAPE_SO_SUBTRACT,
606 XCB_SHAPE_SK_BOUNDING, XCB_CLIP_ORDERING_UNSORTED,
608 c->region_border, c->region_border,
611 xcb_map_window(c->conn, c->window);
616 static av_cold int xcbgrab_read_header(AVFormatContext *s)
618 XCBGrabContext *c = s->priv_data;
620 const xcb_setup_t *setup;
621 char *host = s->filename[0] ? s->filename : NULL;
622 const char *opts = strchr(s->filename, '+');
625 sscanf(opts, "%d,%d", &c->x, &c->y);
626 host = av_strdup(s->filename);
628 return AVERROR(ENOMEM);
629 host[opts - s->filename] = '\0';
632 c->conn = xcb_connect(host, &screen_num);
634 if ((ret = xcb_connection_has_error(c->conn))) {
635 av_log(s, AV_LOG_ERROR, "Cannot open display %s, error %d.\n",
636 s->filename[0] ? host : "default", ret);
645 setup = xcb_get_setup(c->conn);
647 c->screen = get_screen(setup, screen_num);
649 av_log(s, AV_LOG_ERROR, "The screen %d does not exist.\n",
651 xcbgrab_read_close(s);
655 ret = create_stream(s);
658 xcbgrab_read_close(s);
662 #if CONFIG_LIBXCB_SHM
663 if ((c->has_shm = check_shm(c->conn)))
664 c->segment = xcb_generate_id(c->conn);
667 #if CONFIG_LIBXCB_XFIXES
669 if (!(c->draw_mouse = check_xfixes(c->conn))) {
670 av_log(s, AV_LOG_WARNING,
671 "XFixes not available, cannot draw the mouse.\n");
674 avpriv_report_missing_feature(s, "%d bits per pixel screen",
687 AVInputFormat ff_xcbgrab_demuxer = {
689 .long_name = NULL_IF_CONFIG_SMALL("X11 screen capture, using XCB"),
690 .priv_data_size = sizeof(XCBGrabContext),
691 .read_header = xcbgrab_read_header,
692 .read_packet = xcbgrab_read_packet,
693 .read_close = xcbgrab_read_close,
694 .flags = AVFMT_NOFILE,
695 .priv_class = &xcbgrab_class,