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>
38 #include <vlc_dialog.h>
42 #define ADAPTOR_TEXT N_("XVideo adaptor number")
43 #define ADAPTOR_LONGTEXT N_( \
44 "XVideo hardware adaptor to use. By default, VLC will " \
45 "use the first functional adaptor.")
47 #define SHM_TEXT N_("Use shared memory")
48 #define SHM_LONGTEXT N_( \
49 "Use shared memory to communicate between VLC and the X server.")
51 static int Open (vlc_object_t *);
52 static void Close (vlc_object_t *);
58 set_shortname (N_("XVideo"))
59 set_description (N_("XVideo output (XCB)"))
60 set_category (CAT_VIDEO)
61 set_subcategory (SUBCAT_VIDEO_VOUT)
62 set_capability ("vout display", 155)
63 set_callbacks (Open, Close)
65 add_integer ("xvideo-adaptor", -1, NULL,
66 ADAPTOR_TEXT, ADAPTOR_LONGTEXT, true)
67 add_bool ("x11-shm", true, NULL, SHM_TEXT, SHM_LONGTEXT, true)
68 add_deprecated_alias ("xvideo-shm")
69 add_shortcut ("xcb-xv", "xv", "xvideo", "xid")
72 #define MAX_PICTURES (128)
74 struct vout_display_sys_t
76 xcb_connection_t *conn;
77 vout_window_t *embed;/* VLC window */
79 xcb_cursor_t cursor; /* blank cursor */
80 xcb_window_t window; /* drawable X window */
81 xcb_gcontext_t gc; /* context to put images */
82 xcb_xv_port_t port; /* XVideo port */
83 uint32_t id; /* XVideo format */
84 uint16_t width; /* display width */
85 uint16_t height; /* display height */
86 uint32_t data_size; /* picture byte size (for non-SHM) */
87 bool swap_uv; /* U/V pointer must be swapped in a picture */
88 bool shm; /* whether to use MIT-SHM */
89 bool visible; /* whether it makes sense to draw at all */
91 xcb_xv_query_image_attributes_reply_t *att;
92 picture_pool_t *pool; /* picture pool */
93 picture_resource_t resource[MAX_PICTURES];
96 static picture_pool_t *Pool (vout_display_t *, unsigned);
97 static void Display (vout_display_t *, picture_t *);
98 static int Control (vout_display_t *, int, va_list);
99 static void Manage (vout_display_t *);
102 * Check that the X server supports the XVideo extension.
104 static bool CheckXVideo (vout_display_t *vd, xcb_connection_t *conn)
106 xcb_xv_query_extension_reply_t *r;
107 xcb_xv_query_extension_cookie_t ck = xcb_xv_query_extension (conn);
110 /* We need XVideo 2.2 for PutImage */
111 r = xcb_xv_query_extension_reply (conn, ck, NULL);
113 msg_Dbg (vd, "XVideo extension not available");
116 msg_Dbg (vd, "XVideo extension v%"PRIu8".%"PRIu8" unknown",
120 msg_Dbg (vd, "XVideo extension v%"PRIu8".%"PRIu8" too old",
124 msg_Dbg (vd, "using XVideo extension v%"PRIu8".%"PRIu8,
132 static vlc_fourcc_t ParseFormat (vout_display_t *vd,
133 const xcb_xv_image_format_info_t *restrict f)
135 if (f->byte_order != ORDER && f->bpp != 8)
136 return 0; /* Argh! */
140 case XCB_XV_IMAGE_FORMAT_INFO_TYPE_RGB:
141 switch (f->num_planes)
148 return VLC_CODEC_RGB32;
150 return 0; /* ARGB -> VLC cannot do that currently */
154 return VLC_CODEC_RGB24;
158 return VLC_CODEC_RGB16;
160 return VLC_CODEC_RGB15;
164 return VLC_CODEC_RGB8;
169 msg_Err (vd, "unknown XVideo RGB format %"PRIx32" (%.4s)",
171 msg_Dbg (vd, " %"PRIu8" planes, %"PRIu8" bits/pixel, "
172 "depth %"PRIu8, f->num_planes, f->bpp, f->depth);
175 case XCB_XV_IMAGE_FORMAT_INFO_TYPE_YUV:
176 if (f->u_sample_bits != f->v_sample_bits
177 || f->vhorz_u_period != f->vhorz_v_period
178 || f->vvert_u_period != f->vvert_v_period
179 || f->y_sample_bits != 8 || f->u_sample_bits != 8
180 || f->vhorz_y_period != 1 || f->vvert_y_period != 1)
182 switch (f->num_planes)
188 if (f->vhorz_u_period == 1 && f->vvert_u_period == 1)
189 return VLC_CODEC_I444;
192 if (f->vhorz_u_period == 2 && f->vvert_u_period == 1)
194 if (!strcmp ((const char *)f->vcomp_order, "YUYV"))
195 return VLC_CODEC_YUYV;
196 if (!strcmp ((const char *)f->vcomp_order, "UYVY"))
197 return VLC_CODEC_UYVY;
206 if (f->vhorz_u_period == 2 && f->vvert_u_period == 2)
208 if (!strcmp ((const char *)f->vcomp_order, "YVU"))
209 return VLC_CODEC_YV12;
210 if (!strcmp ((const char *)f->vcomp_order, "YUV"))
211 return VLC_CODEC_I420;
217 msg_Err (vd, "unknown XVideo YUV format %"PRIx32" (%.4s)", f->id,
219 msg_Dbg (vd, " %"PRIu8" planes, %"PRIu32" bits/pixel, "
220 "%"PRIu32"/%"PRIu32"/%"PRIu32" bits/sample", f->num_planes,
221 f->bpp, f->y_sample_bits, f->u_sample_bits, f->v_sample_bits);
222 msg_Dbg (vd, " period: %"PRIu32"/%"PRIu32"/%"PRIu32"x"
223 "%"PRIu32"/%"PRIu32"/%"PRIu32,
224 f->vhorz_y_period, f->vhorz_u_period, f->vhorz_v_period,
225 f->vvert_y_period, f->vvert_u_period, f->vvert_v_period);
226 msg_Warn (vd, " order: %.32s", f->vcomp_order);
233 static const xcb_xv_image_format_info_t *
234 FindFormat (vout_display_t *vd,
235 vlc_fourcc_t chroma, const video_format_t *fmt,
237 const xcb_xv_list_image_formats_reply_t *list,
238 xcb_xv_query_image_attributes_reply_t **restrict pa)
240 xcb_connection_t *conn = vd->sys->conn;
241 const xcb_xv_image_format_info_t *f, *end;
244 f = xcb_xv_list_image_formats_format (list);
246 f = (xcb_xv_image_format_info_t *) (list + 1);
248 end = f + xcb_xv_list_image_formats_format_length (list);
251 if (chroma != ParseFormat (vd, f))
254 /* VLC pads scanline to 16 pixels internally */
255 unsigned width = (fmt->i_width + 15) & ~15;
256 unsigned height = (fmt->i_height + 15) & ~15;
257 xcb_xv_query_image_attributes_reply_t *i;
258 i = xcb_xv_query_image_attributes_reply (conn,
259 xcb_xv_query_image_attributes (conn, port, f->id,
260 width, height), NULL);
264 if (i->width != width || i->height != height)
266 msg_Warn (vd, "incompatible size %ux%u -> %"PRIu32"x%"PRIu32,
267 fmt->i_width, fmt->i_height,
268 i->width, i->height);
269 var_Create (vd->p_libvlc, "xvideo-resolution-error", VLC_VAR_BOOL);
270 if (!var_GetBool (vd->p_libvlc, "xvideo-resolution-error"))
272 dialog_FatalWait (vd, _("Video acceleration not available"),
273 _("Your video output acceleration driver does not support "
274 "the required resolution: %ux%u pixels. The maximum "
275 "supported resolution is %"PRIu32"x%"PRIu32".\n"
276 "Video output acceleration will be disabled. However, "
277 "rendering videos with overly large resolution "
278 "may cause severe performance degration."),
279 width, height, i->width, i->height);
280 var_SetBool (vd->p_libvlc, "xvideo-resolution-error", true);
293 * Probe the X server.
295 static int Open (vlc_object_t *obj)
297 vout_display_t *vd = (vout_display_t *)obj;
298 vout_display_sys_t *p_sys = malloc (sizeof (*p_sys));
300 if (!var_CreateGetBool (obj, "overlay"))
308 xcb_connection_t *conn;
309 const xcb_screen_t *screen;
311 p_sys->embed = GetWindow (vd, &conn, &screen, &depth);
312 if (p_sys->embed == NULL)
321 p_sys->swap_uv = false;
323 if (!CheckXVideo (vd, conn))
325 msg_Warn (vd, "Please enable XVideo 2.2 for faster video display");
329 p_sys->window = xcb_generate_id (conn);
330 xcb_pixmap_t pixmap = xcb_generate_id (conn);
332 /* Cache adaptors infos */
333 xcb_xv_query_adaptors_reply_t *adaptors =
334 xcb_xv_query_adaptors_reply (conn,
335 xcb_xv_query_adaptors (conn, p_sys->embed->handle.xid), NULL);
336 if (adaptors == NULL)
339 int forced_adaptor = var_CreateGetInteger (obj, "xvideo-adaptor");
342 video_format_t fmt = vd->fmt;
343 bool found_adaptor = false;
345 xcb_xv_adaptor_info_iterator_t it;
346 for (it = xcb_xv_query_adaptors_info_iterator (adaptors);
347 it.rem > 0 && !found_adaptor;
348 xcb_xv_adaptor_info_next (&it))
350 const xcb_xv_adaptor_info_t *a = it.data;
353 if (forced_adaptor != -1 && forced_adaptor != 0)
359 if (!(a->type & XCB_XV_TYPE_IMAGE_MASK))
362 xcb_xv_list_image_formats_reply_t *r =
363 xcb_xv_list_image_formats_reply (conn,
364 xcb_xv_list_image_formats (conn, a->base_id), NULL);
368 /* Look for an image format */
369 const xcb_xv_image_format_info_t *xfmt = NULL;
370 const vlc_fourcc_t *chromas, chromas_default[] = {
379 if (vlc_fourcc_IsYUV (fmt.i_chroma))
380 chromas = vlc_fourcc_GetYUVFallback (fmt.i_chroma);
382 chromas = chromas_default;
385 for (size_t i = 0; chromas[i]; i++)
390 if ((chroma == VLC_CODEC_I420 || chroma == VLC_CODEC_YV12)
392 && !memcmp ("OMAP", xcb_xv_adaptor_info_name (a), 4))
394 msg_Dbg (vd, "skipping slow I420 format");
395 continue; /* OMAP framebuffer sucks at YUV 4:2:0 */
398 xfmt = FindFormat (vd, chroma, &fmt, a->base_id, r, &p_sys->att);
401 p_sys->id = xfmt->id;
402 p_sys->swap_uv = vlc_fourcc_AreUVPlanesSwapped (fmt.i_chroma,
405 fmt.i_chroma = chroma;
406 if (xfmt->type == XCB_XV_IMAGE_FORMAT_INFO_TYPE_RGB)
408 fmt.i_rmask = xfmt->red_mask;
409 fmt.i_gmask = xfmt->green_mask;
410 fmt.i_bmask = xfmt->blue_mask;
416 if (xfmt == NULL) /* No acceptable image formats */
420 for (unsigned i = 0; i < a->num_ports; i++)
422 xcb_xv_port_t port = a->base_id + i;
423 xcb_xv_grab_port_reply_t *gr =
424 xcb_xv_grab_port_reply (conn,
425 xcb_xv_grab_port (conn, port, XCB_CURRENT_TIME), NULL);
426 uint8_t result = gr ? gr->result : 0xff;
434 msg_Dbg (vd, "cannot grab port %"PRIu32, port);
436 continue; /* No usable port */
439 /* Found port - initialize selected format */
440 name = strndup (xcb_xv_adaptor_info_name (a), a->name_size);
443 msg_Dbg (vd, "using adaptor %s", name);
446 msg_Dbg (vd, "using port %"PRIu32, p_sys->port);
447 msg_Dbg (vd, "using image format 0x%"PRIx32, p_sys->id);
449 /* Look for an X11 visual, create a window */
450 xcb_xv_format_t *f = xcb_xv_adaptor_info_formats (a);
451 for (uint_fast16_t i = a->num_formats; i > 0; i--, f++)
453 if (f->depth != screen->root_depth)
454 continue; /* this would fail anyway */
459 XCB_CW_BORDER_PIXMAP |
460 XCB_CW_BORDER_PIXEL |
463 const uint32_t list[] = {
464 /* XCB_CW_BACK_PIXMAP */
466 /* XCB_CW_BACK_PIXEL */
468 /* XCB_CW_BORDER_PIXMAP */
470 /* XCB_CW_BORDER_PIXEL */
472 /* XCB_CW_EVENT_MASK */
473 XCB_EVENT_MASK_VISIBILITY_CHANGE,
474 /* XCB_CW_COLORMAP */
475 screen->default_colormap,
480 xcb_create_pixmap (conn, f->depth, pixmap, screen->root, 1, 1);
481 c = xcb_create_window_checked (conn, f->depth, p_sys->window,
482 p_sys->embed->handle.xid, 0, 0, 1, 1, 0,
483 XCB_WINDOW_CLASS_INPUT_OUTPUT, f->visual, mask, list);
485 if (!CheckError (vd, conn, "cannot create X11 window", c))
487 msg_Dbg (vd, "using X11 visual ID 0x%"PRIx32
488 " (depth: %"PRIu8")", f->visual, f->depth);
489 msg_Dbg (vd, "using X11 window 0x%08"PRIx32, p_sys->window);
493 xcb_xv_ungrab_port (conn, p_sys->port, XCB_CURRENT_TIME);
494 msg_Dbg (vd, "no usable X11 visual");
495 continue; /* No workable XVideo format (visual/depth) */
498 found_adaptor = true;
504 msg_Err (vd, "no available XVideo adaptor");
509 xcb_map_window (conn, p_sys->window);
511 vout_display_place_t place;
513 vout_display_PlacePicture (&place, &vd->source, vd->cfg, false);
514 p_sys->width = place.width;
515 p_sys->height = place.height;
518 const uint32_t values[] = {
519 place.x, place.y, place.width, place.height };
520 xcb_configure_window (conn, p_sys->window,
521 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
522 XCB_CONFIG_WINDOW_WIDTH |
523 XCB_CONFIG_WINDOW_HEIGHT,
526 p_sys->visible = false;
528 /* Create graphic context */
529 p_sys->gc = xcb_generate_id (conn);
530 xcb_create_gc (conn, p_sys->gc, p_sys->window, 0, NULL);
531 msg_Dbg (vd, "using X11 graphic context 0x%08"PRIx32, p_sys->gc);
534 p_sys->cursor = CreateBlankCursor (conn, screen);
536 CheckSHM (obj, conn, &p_sys->shm);
539 vout_display_info_t info = vd->info;
540 info.has_pictures_invalid = false;
541 info.has_event_thread = true;
543 /* Setup vout_display_t once everything is fine */
549 vd->display = Display;
550 vd->control = Control;
554 bool is_fullscreen = vd->cfg->is_fullscreen;
555 if (is_fullscreen && vout_window_SetFullScreen (p_sys->embed, true))
556 is_fullscreen = false;
557 vout_display_SendEventFullscreen (vd, is_fullscreen);
558 unsigned width, height;
559 if (!GetWindowSize (p_sys->embed, conn, &width, &height))
560 vout_display_SendEventDisplaySize (vd, width, height, is_fullscreen);
571 * Disconnect from the X server.
573 static void Close (vlc_object_t *obj)
575 vout_display_t *vd = (vout_display_t *)obj;
576 vout_display_sys_t *p_sys = vd->sys;
580 for (unsigned i = 0; i < MAX_PICTURES; i++)
582 picture_resource_t *res = &p_sys->resource[i];
584 if (!res->p->p_pixels)
586 PictureResourceFree (res, NULL);
588 picture_pool_Delete (p_sys->pool);
591 /* show the default cursor */
592 xcb_change_window_attributes (p_sys->conn, p_sys->embed->handle.xid, XCB_CW_CURSOR,
593 &(uint32_t) { XCB_CURSOR_NONE });
594 xcb_flush (p_sys->conn);
597 xcb_disconnect (p_sys->conn);
598 vout_display_DeleteWindow (vd, p_sys->embed);
603 * Return a direct buffer
605 static picture_pool_t *Pool (vout_display_t *vd, unsigned requested_count)
607 vout_display_sys_t *p_sys = vd->sys;
611 memset (p_sys->resource, 0, sizeof(p_sys->resource));
613 const uint32_t *pitches =
614 xcb_xv_query_image_attributes_pitches (p_sys->att);
615 const uint32_t *offsets =
616 xcb_xv_query_image_attributes_offsets (p_sys->att);
617 p_sys->data_size = p_sys->att->data_size;
620 picture_t *pic_array[MAX_PICTURES];
621 for (count = 0; count < requested_count; count++)
623 if (count >= MAX_PICTURES)
625 picture_resource_t *res = &p_sys->resource[count];
627 for (int i = 0; i < __MIN (p_sys->att->num_planes, PICTURE_PLANE_MAX); i++)
630 ((i + 1 < p_sys->att->num_planes ? offsets[i+1] :
631 p_sys->data_size) - offsets[i]) / pitches[i];
632 res->p[i].i_pitch = pitches[i];
634 if (PictureResourceAlloc (vd, res, p_sys->att->data_size,
635 p_sys->conn, p_sys->shm))
638 /* Allocate further planes as specified by XVideo */
639 /* We assume that offsets[0] is zero */
640 for (int i = 1; i < __MIN (p_sys->att->num_planes, PICTURE_PLANE_MAX); i++)
641 res->p[i].p_pixels = res->p[0].p_pixels + offsets[i];
643 { /* YVU: swap U and V planes */
644 uint8_t *buf = res->p[2].p_pixels;
645 res->p[2].p_pixels = res->p[1].p_pixels;
646 res->p[1].p_pixels = buf;
649 pic_array[count] = picture_NewFromResource (&vd->fmt, res);
650 if (!pic_array[count])
652 PictureResourceFree (res, p_sys->conn);
653 memset (res, 0, sizeof(*res));
661 p_sys->pool = picture_pool_New (count, pic_array);
662 /* TODO release picture resources if NULL */
663 xcb_flush (p_sys->conn);
670 * Sends an image to the X server.
672 static void Display (vout_display_t *vd, picture_t *pic)
674 vout_display_sys_t *p_sys = vd->sys;
675 xcb_shm_seg_t segment = pic->p_sys->segment;
676 xcb_void_cookie_t ck;
681 ck = xcb_xv_shm_put_image_checked (p_sys->conn, p_sys->port,
682 p_sys->window, p_sys->gc, segment, p_sys->id, 0,
683 /* Src: */ vd->source.i_x_offset,
684 vd->source.i_y_offset,
685 vd->source.i_visible_width,
686 vd->source.i_visible_height,
687 /* Dst: */ 0, 0, p_sys->width, p_sys->height,
688 /* Memory: */ pic->p->i_pitch / pic->p->i_pixel_pitch,
689 pic->p->i_lines, false);
691 ck = xcb_xv_put_image_checked (p_sys->conn, p_sys->port, p_sys->window,
692 p_sys->gc, p_sys->id,
693 vd->source.i_x_offset,
694 vd->source.i_y_offset,
695 vd->source.i_visible_width,
696 vd->source.i_visible_height,
697 0, 0, p_sys->width, p_sys->height,
698 pic->p->i_pitch / pic->p->i_pixel_pitch,
700 p_sys->data_size, pic->p->p_pixels);
702 /* Wait for reply. See x11.c for rationale. */
703 xcb_generic_error_t *e = xcb_request_check (p_sys->conn, ck);
706 msg_Dbg (vd, "%s: X11 error %d", "cannot put image", e->error_code);
710 picture_Release (pic);
713 static int Control (vout_display_t *vd, int query, va_list ap)
715 vout_display_sys_t *p_sys = vd->sys;
719 case VOUT_DISPLAY_CHANGE_FULLSCREEN:
721 const vout_display_cfg_t *c = va_arg (ap, const vout_display_cfg_t *);
722 return vout_window_SetFullScreen (p_sys->embed, c->is_fullscreen);
725 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
726 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
727 case VOUT_DISPLAY_CHANGE_ZOOM:
728 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
729 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
731 const vout_display_cfg_t *cfg;
732 const video_format_t *source;
733 bool is_forced = false;
735 if (query == VOUT_DISPLAY_CHANGE_SOURCE_ASPECT
736 || query == VOUT_DISPLAY_CHANGE_SOURCE_CROP)
738 source = (const video_format_t *)va_arg (ap, const video_format_t *);
743 source = &vd->source;
744 cfg = (const vout_display_cfg_t*)va_arg (ap, const vout_display_cfg_t *);
745 if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE)
746 is_forced = (bool)va_arg (ap, int);
750 if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE
752 && (cfg->display.width != vd->cfg->display.width
753 ||cfg->display.height != vd->cfg->display.height)
754 && vout_window_SetSize (p_sys->embed,
756 cfg->display.height))
759 vout_display_place_t place;
760 vout_display_PlacePicture (&place, source, cfg, false);
761 p_sys->width = place.width;
762 p_sys->height = place.height;
764 /* Move the picture within the window */
765 const uint32_t values[] = { place.x, place.y,
766 place.width, place.height, };
767 xcb_configure_window (p_sys->conn, p_sys->window,
768 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y
769 | XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
771 xcb_flush (p_sys->conn);
774 case VOUT_DISPLAY_CHANGE_WINDOW_STATE:
776 unsigned state = va_arg (ap, unsigned);
777 return vout_window_SetState (p_sys->embed, state);
780 /* Hide the mouse. It will be send when
781 * vout_display_t::info.b_hide_mouse is false */
782 case VOUT_DISPLAY_HIDE_MOUSE:
783 xcb_change_window_attributes (p_sys->conn, p_sys->embed->handle.xid,
784 XCB_CW_CURSOR, &(uint32_t){ p_sys->cursor });
786 case VOUT_DISPLAY_RESET_PICTURES:
789 msg_Err (vd, "Unknown request in XCB vout display");
794 static void Manage (vout_display_t *vd)
796 vout_display_sys_t *p_sys = vd->sys;
798 ManageEvent (vd, p_sys->conn, &p_sys->visible);