3 * @brief X C Bindings video output module for VLC media player
5 /*****************************************************************************
6 * Copyright © 2009 Rémi Denis-Courmont
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 ****************************************************************************/
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
36 #include <vlc_vout_display.h>
37 #include <vlc_picture_pool.h>
41 #define DISPLAY_TEXT N_("X11 display")
42 #define DISPLAY_LONGTEXT N_( \
43 "X11 hardware display to use. By default, VLC will " \
44 "use the value of the DISPLAY environment variable.")
46 #define ADAPTOR_TEXT N_("XVideo adaptor number")
47 #define ADAPTOR_LONGTEXT N_( \
48 "XVideo hardware adaptor to use. By default, VLC will " \
49 "use the first functional adaptor.")
51 #define SHM_TEXT N_("Use shared memory")
52 #define SHM_LONGTEXT N_( \
53 "Use shared memory to communicate between VLC and the X server.")
55 static int Open (vlc_object_t *);
56 static void Close (vlc_object_t *);
62 set_shortname (N_("XVideo"))
63 set_description (N_("XVideo output (XCB)"))
64 set_category (CAT_VIDEO)
65 set_subcategory (SUBCAT_VIDEO_VOUT)
66 set_capability ("vout display", 155)
67 set_callbacks (Open, Close)
69 add_string ("x11-display", NULL, NULL,
70 DISPLAY_TEXT, DISPLAY_LONGTEXT, true)
71 add_deprecated_alias ("xvideo-display")
72 add_integer ("xvideo-adaptor", -1, NULL,
73 ADAPTOR_TEXT, ADAPTOR_LONGTEXT, true)
74 add_bool ("x11-shm", true, NULL, SHM_TEXT, SHM_LONGTEXT, true)
75 add_deprecated_alias ("xvideo-shm")
76 add_shortcut ("xcb-xv")
78 add_shortcut ("xvideo")
81 #define MAX_PICTURES (VOUT_MAX_PICTURES)
83 struct vout_display_sys_t
85 xcb_connection_t *conn;
86 vout_window_t *embed;/* VLC window */
88 xcb_window_t window; /* drawable X window */
89 xcb_gcontext_t gc; /* context to put images */
90 xcb_xv_port_t port; /* XVideo port */
91 uint32_t id; /* XVideo format */
92 uint16_t width; /* display width */
93 uint16_t height; /* display height */
94 uint32_t data_size; /* picture byte size (for non-SHM) */
95 bool shm; /* whether to use MIT-SHM */
96 bool visible; /* whether it makes sense to draw at all */
98 xcb_xv_query_image_attributes_reply_t *att;
99 picture_pool_t *pool; /* picture pool */
100 picture_resource_t resource[MAX_PICTURES];
103 static picture_t *Get (vout_display_t *);
104 static void Display (vout_display_t *, picture_t *);
105 static int Control (vout_display_t *, int, va_list);
106 static void Manage (vout_display_t *);
109 * Check that the X server supports the XVideo extension.
111 static bool CheckXVideo (vout_display_t *vd, xcb_connection_t *conn)
113 xcb_xv_query_extension_reply_t *r;
114 xcb_xv_query_extension_cookie_t ck = xcb_xv_query_extension (conn);
117 r = xcb_xv_query_extension_reply (conn, ck, NULL);
119 { /* We need XVideo 2.2 for PutImage */
120 if ((r->major > 2) || (r->major == 2 && r->minor >= 2))
122 msg_Dbg (vd, "using XVideo extension v%"PRIu8".%"PRIu8,
127 msg_Dbg (vd, "XVideo extension too old (v%"PRIu8".%"PRIu8,
132 msg_Dbg (vd, "XVideo extension not available");
136 static vlc_fourcc_t ParseFormat (vout_display_t *vd,
137 const xcb_xv_image_format_info_t *restrict f)
139 if (f->byte_order != ORDER && f->bpp != 8)
140 return 0; /* Argh! */
144 case XCB_XV_IMAGE_FORMAT_INFO_TYPE_RGB:
145 switch (f->num_planes)
152 return VLC_CODEC_RGB32;
156 return VLC_CODEC_RGB24;
160 return VLC_CODEC_RGB16;
162 return VLC_CODEC_RGB15;
166 return VLC_CODEC_RGB8;
171 msg_Err (vd, "unknown XVideo RGB format %"PRIx32" (%.4s)",
173 msg_Dbg (vd, " %"PRIu8" planes, %"PRIu8" bits/pixel, "
174 "depth %"PRIu8, f->num_planes, f->bpp, f->depth);
177 case XCB_XV_IMAGE_FORMAT_INFO_TYPE_YUV:
178 if (f->u_sample_bits != f->v_sample_bits
179 || f->vhorz_u_period != f->vhorz_v_period
180 || f->vvert_u_period != f->vvert_v_period
181 || f->y_sample_bits != 8 || f->u_sample_bits != 8
182 || f->vhorz_y_period != 1 || f->vvert_y_period != 1)
184 switch (f->num_planes)
190 if (f->vhorz_u_period == 1 && f->vvert_u_period == 1)
191 return VLC_CODEC_I444;
194 if (f->vhorz_u_period == 2 && f->vvert_u_period == 1)
196 if (!strcmp ((const char *)f->vcomp_order, "YUYV"))
197 return VLC_CODEC_YUYV;
198 if (!strcmp ((const char *)f->vcomp_order, "UYVY"))
199 return VLC_CODEC_UYVY;
208 if (f->vhorz_u_period == 2 && f->vvert_u_period == 2)
210 if (!strcmp ((const char *)f->vcomp_order, "YVU"))
211 return VLC_CODEC_YV12;
212 if (!strcmp ((const char *)f->vcomp_order, "YUV"))
213 return VLC_CODEC_I420;
219 msg_Err (vd, "unknown XVideo YUV format %"PRIx32" (%.4s)", f->id,
221 msg_Dbg (vd, " %"PRIu8" planes, %"PRIu32" bits/pixel, "
222 "%"PRIu32"/%"PRIu32"/%"PRIu32" bits/sample", f->num_planes,
223 f->bpp, f->y_sample_bits, f->u_sample_bits, f->v_sample_bits);
224 msg_Dbg (vd, " period: %"PRIu32"/%"PRIu32"/%"PRIu32"x"
225 "%"PRIu32"/%"PRIu32"/%"PRIu32,
226 f->vhorz_y_period, f->vhorz_u_period, f->vhorz_v_period,
227 f->vvert_y_period, f->vvert_u_period, f->vvert_v_period);
228 msg_Warn (vd, " order: %.32s", f->vcomp_order);
235 static const xcb_xv_image_format_info_t *
236 FindFormat (vout_display_t *vd,
237 vlc_fourcc_t chroma, const video_format_t *fmt,
239 const xcb_xv_list_image_formats_reply_t *list,
240 xcb_xv_query_image_attributes_reply_t **restrict pa)
242 xcb_connection_t *conn = vd->sys->conn;
243 const xcb_xv_image_format_info_t *f, *end;
246 f = xcb_xv_list_image_formats_format (list);
248 f = (xcb_xv_image_format_info_t *) (list + 1);
250 end = f + xcb_xv_list_image_formats_format_length (list);
253 if (chroma != ParseFormat (vd, f))
256 /* VLC pads scanline to 16 pixels internally */
257 unsigned width = (fmt->i_width + 15) & ~15;
258 unsigned height = (fmt->i_height + 15) & ~15;
259 xcb_xv_query_image_attributes_reply_t *i;
260 i = xcb_xv_query_image_attributes_reply (conn,
261 xcb_xv_query_image_attributes (conn, port, f->id,
262 width, height), NULL);
266 if (i->width != width || i->height != height)
268 msg_Warn (vd, "incompatible size %ux%u -> %"PRIu32"x%"PRIu32,
269 fmt->i_width, fmt->i_height,
270 i->width, i->height);
282 * Probe the X server.
284 static int Open (vlc_object_t *obj)
286 vout_display_t *vd = (vout_display_t *)obj;
287 vout_display_sys_t *p_sys = malloc (sizeof (*p_sys));
294 xcb_connection_t *conn = Connect (obj);
302 if (!CheckXVideo (vd, conn))
304 msg_Warn (vd, "Please enable XVideo 2.2 for faster video display");
305 xcb_disconnect (conn);
310 const xcb_screen_t *screen;
311 p_sys->embed = GetWindow (vd, conn, &screen, &p_sys->shm);
312 if (p_sys->embed == NULL)
314 xcb_disconnect (conn);
323 /* Cache adaptors infos */
324 xcb_xv_query_adaptors_reply_t *adaptors =
325 xcb_xv_query_adaptors_reply (conn,
326 xcb_xv_query_adaptors (conn, p_sys->embed->handle.xid), NULL);
327 if (adaptors == NULL)
330 int forced_adaptor = var_CreateGetInteger (obj, "xvideo-adaptor");
333 video_format_t fmt = vd->fmt;
334 bool found_adaptor = false;
336 xcb_xv_adaptor_info_iterator_t it;
337 for (it = xcb_xv_query_adaptors_info_iterator (adaptors);
338 it.rem > 0 && !found_adaptor;
339 xcb_xv_adaptor_info_next (&it))
341 const xcb_xv_adaptor_info_t *a = it.data;
344 if (forced_adaptor != -1 && forced_adaptor != 0)
350 if (!(a->type & XCB_XV_TYPE_IMAGE_MASK))
353 xcb_xv_list_image_formats_reply_t *r =
354 xcb_xv_list_image_formats_reply (conn,
355 xcb_xv_list_image_formats (conn, a->base_id), NULL);
359 /* Look for an image format */
360 const xcb_xv_image_format_info_t *xfmt = NULL;
361 const vlc_fourcc_t *chromas, chromas_default[] = {
370 if (vlc_fourcc_IsYUV (fmt.i_chroma))
371 chromas = vlc_fourcc_GetYUVFallback (fmt.i_chroma);
373 chromas = chromas_default;
376 for (size_t i = 0; chromas[i] && (xfmt == NULL); i++)
381 if ((chroma == VLC_CODEC_I420 || chroma == VLC_CODEC_YV12)
383 && !memcmp ("OMAP", xcb_xv_adaptor_info_name (a), 4))
385 msg_Dbg (vd, "skipping slow I420 format");
386 continue; /* OMAP framebuffer sucks at YUV 4:2:0 */
389 xfmt = FindFormat (vd, chroma, &fmt, a->base_id, r, &p_sys->att);
392 if (xfmt == NULL) /* No acceptable image formats */
396 for (unsigned i = 0; i < a->num_ports; i++)
398 xcb_xv_port_t port = a->base_id + i;
399 xcb_xv_grab_port_reply_t *gr =
400 xcb_xv_grab_port_reply (conn,
401 xcb_xv_grab_port (conn, port, XCB_CURRENT_TIME), NULL);
402 uint8_t result = gr ? gr->result : 0xff;
408 found_adaptor = true;
411 msg_Dbg (vd, "cannot grab port %"PRIu32, port);
416 /* Found port - initialize selected format */
417 name = strndup (xcb_xv_adaptor_info_name (a), a->name_size);
420 msg_Dbg (vd, "using adaptor %s", name);
423 msg_Dbg (vd, "using port %"PRIu32, p_sys->port);
425 p_sys->id = xfmt->id;
426 msg_Dbg (vd, "using image format 0x%"PRIx32, p_sys->id);
427 fmt.i_chroma = chroma;
428 if (xfmt->type == XCB_XV_IMAGE_FORMAT_INFO_TYPE_RGB)
430 fmt.i_rmask = xfmt->red_mask;
431 fmt.i_gmask = xfmt->green_mask;
432 fmt.i_bmask = xfmt->blue_mask;
441 msg_Err (vd, "no available XVideo adaptor");
447 const uint32_t mask =
448 /* XCB_CW_EVENT_MASK */
449 XCB_EVENT_MASK_BUTTON_PRESS | XCB_EVENT_MASK_BUTTON_RELEASE |
450 XCB_EVENT_MASK_VISIBILITY_CHANGE;
452 xcb_window_t window = xcb_generate_id (conn);
454 c = xcb_create_window_checked (conn, screen->root_depth, window,
455 p_sys->embed->handle.xid, 0, 0, 1, 1, 0,
456 XCB_WINDOW_CLASS_INPUT_OUTPUT,
458 XCB_CW_EVENT_MASK, &mask);
459 if (CheckError (vd, conn, "cannot create X11 window", c))
461 p_sys->window = window;
462 msg_Dbg (vd, "using X11 window 0x%08"PRIx32, window);
463 xcb_map_window (conn, window);
465 vout_display_place_t place;
467 vout_display_PlacePicture (&place, &vd->source, vd->cfg, false);
468 p_sys->width = place.width;
469 p_sys->height = place.height;
472 const uint32_t values[] = { place.x, place.y, place.width, place.height };
473 xcb_configure_window (conn, window,
474 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
475 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
478 p_sys->visible = false;
480 /* Create graphic context */
481 p_sys->gc = xcb_generate_id (conn);
482 xcb_create_gc (conn, p_sys->gc, p_sys->window, 0, NULL);
483 msg_Dbg (vd, "using X11 graphic context 0x%08"PRIx32, p_sys->gc);
489 vout_display_info_t info = vd->info;
490 info.has_pictures_invalid = false;
492 /* Setup vout_display_t once everything is fine */
498 vd->display = Display;
499 vd->control = Control;
503 vout_display_SendEventFullscreen (vd, false);
504 unsigned width, height;
505 if (!GetWindowSize (p_sys->embed, conn, &width, &height))
506 vout_display_SendEventDisplaySize (vd, width, height, false);
517 * Disconnect from the X server.
519 static void Close (vlc_object_t *obj)
521 vout_display_t *vd = (vout_display_t *)obj;
522 vout_display_sys_t *p_sys = vd->sys;
526 for (unsigned i = 0; i < MAX_PICTURES; i++)
528 picture_resource_t *res = &p_sys->resource[i];
530 if (!res->p->p_pixels)
532 PictureResourceFree (res, NULL);
534 picture_pool_Delete (p_sys->pool);
538 vout_display_DeleteWindow (vd, p_sys->embed);
539 xcb_disconnect (p_sys->conn);
544 * Return a direct buffer
546 static picture_t *Get (vout_display_t *vd)
548 vout_display_sys_t *p_sys = vd->sys;
552 picture_t *pic = picture_New (vd->fmt.i_chroma, p_sys->att->width,
553 p_sys->att->height, 0);
557 memset (p_sys->resource, 0, sizeof(p_sys->resource));
559 const uint32_t *offsets =
560 xcb_xv_query_image_attributes_offsets (p_sys->att);
561 p_sys->data_size = p_sys->att->data_size;
564 picture_t *pic_array[MAX_PICTURES];
565 for (count = 0; count < MAX_PICTURES; count++)
567 picture_resource_t *res = &p_sys->resource[count];
569 for (int i = 0; i < pic->i_planes; i++)
571 res->p[i].i_lines = pic->p[i].i_lines; /* FIXME seems wrong*/
572 res->p[i].i_pitch = pic->p[i].i_pitch;
574 if (PictureResourceAlloc (vd, res, p_sys->att->data_size,
575 p_sys->conn, p_sys->shm))
578 /* Allocate further planes as specified by XVideo */
579 /* We assume that offsets[0] is zero */
580 for (int i = 1; i < pic->i_planes; i++)
581 res->p[i].p_pixels = res->p[0].p_pixels + offsets[i];
582 if (vd->fmt.i_chroma == VLC_CODEC_YV12)
583 { /* YVU: swap U and V planes */
584 uint8_t *buf = res->p[2].p_pixels;
585 res->p[2].p_pixels = res->p[1].p_pixels;
586 res->p[1].p_pixels = buf;
589 pic_array[count] = picture_NewFromResource (&vd->fmt, res);
590 if (!pic_array[count])
592 PictureResourceFree (res, p_sys->conn);
593 memset (res, 0, sizeof(*res));
597 picture_Release (pic);
602 p_sys->pool = picture_pool_New (count, pic_array);
605 /* TODO release picture resources */
608 /* FIXME should also do it in case of error ? */
609 xcb_flush (p_sys->conn);
612 return picture_pool_Get (p_sys->pool);
616 * Sends an image to the X server.
618 static void Display (vout_display_t *vd, picture_t *pic)
620 vout_display_sys_t *p_sys = vd->sys;
621 xcb_shm_seg_t segment = pic->p_sys->segment;
622 xcb_void_cookie_t ck;
627 ck = xcb_xv_shm_put_image_checked (p_sys->conn, p_sys->port,
628 p_sys->window, p_sys->gc, segment, p_sys->id, 0,
629 /* Src: */ vd->source.i_x_offset,
630 vd->source.i_y_offset,
631 vd->source.i_visible_width,
632 vd->source.i_visible_height,
633 /* Dst: */ 0, 0, p_sys->width, p_sys->height,
634 /* Memory: */ pic->p->i_pitch / pic->p->i_pixel_pitch,
635 pic->p->i_lines, false);
637 ck = xcb_xv_put_image_checked (p_sys->conn, p_sys->port, p_sys->window,
638 p_sys->gc, p_sys->id,
639 vd->source.i_x_offset,
640 vd->source.i_y_offset,
641 vd->source.i_visible_width,
642 vd->source.i_visible_height,
643 0, 0, p_sys->width, p_sys->height,
644 pic->p->i_pitch / pic->p->i_pixel_pitch,
646 p_sys->data_size, pic->p->p_pixels);
648 /* Wait for reply. See x11.c for rationale. */
649 xcb_generic_error_t *e = xcb_request_check (p_sys->conn, ck);
652 msg_Dbg (vd, "%s: X11 error %d", "cannot put image", e->error_code);
656 picture_Release (pic);
659 static int Control (vout_display_t *vd, int query, va_list ap)
661 vout_display_sys_t *p_sys = vd->sys;
665 case VOUT_DISPLAY_CHANGE_FULLSCREEN:
667 const vout_display_cfg_t *c = va_arg (ap, const vout_display_cfg_t *);
668 return vout_window_SetFullScreen (p_sys->embed, c->is_fullscreen);
671 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
672 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
673 case VOUT_DISPLAY_CHANGE_ZOOM:
674 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
675 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
677 const vout_display_cfg_t *cfg;
678 const video_format_t *source;
681 if (query == VOUT_DISPLAY_CHANGE_SOURCE_ASPECT
682 || query == VOUT_DISPLAY_CHANGE_SOURCE_CROP)
684 source = (const video_format_t *)va_arg (ap, const video_format_t *);
689 source = &vd->source;
690 cfg = (const vout_display_cfg_t*)va_arg (ap, const vout_display_cfg_t *);
691 if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE)
692 is_forced = (bool)va_arg (ap, int);
696 if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE
698 && (cfg->display.width != vd->cfg->display.width
699 ||cfg->display.height != vd->cfg->display.height)
700 && vout_window_SetSize (p_sys->embed,
702 cfg->display.height))
705 vout_display_place_t place;
706 vout_display_PlacePicture (&place, source, cfg, false);
707 p_sys->width = place.width;
708 p_sys->height = place.height;
710 /* Move the picture within the window */
711 const uint32_t values[] = { place.x, place.y,
712 place.width, place.height, };
713 xcb_configure_window (p_sys->conn, p_sys->window,
714 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y
715 | XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
717 xcb_flush (p_sys->conn);
720 case VOUT_DISPLAY_CHANGE_ON_TOP:
722 int on_top = (int)va_arg (ap, int);
723 return vout_window_SetOnTop (p_sys->embed, on_top);
728 /* Hide the mouse. It will be send when
729 * vout_display_t::info.b_hide_mouse is false */
730 VOUT_DISPLAY_HIDE_MOUSE,
732 case VOUT_DISPLAY_RESET_PICTURES:
735 msg_Err (vd, "Unknown request in XCB vout display");
740 static void Manage (vout_display_t *vd)
742 vout_display_sys_t *p_sys = vd->sys;
744 ManageEvent (vd, p_sys->conn, &p_sys->visible);