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")
71 add_shortcut ("xvideo")
74 #define MAX_PICTURES (VOUT_MAX_PICTURES)
76 struct vout_display_sys_t
78 xcb_connection_t *conn;
79 vout_window_t *embed;/* VLC window */
81 xcb_cursor_t cursor; /* blank cursor */
82 xcb_window_t window; /* drawable X window */
83 xcb_gcontext_t gc; /* context to put images */
84 xcb_xv_port_t port; /* XVideo port */
85 uint32_t id; /* XVideo format */
86 uint16_t width; /* display width */
87 uint16_t height; /* display height */
88 uint32_t data_size; /* picture byte size (for non-SHM) */
89 bool shm; /* whether to use MIT-SHM */
90 bool visible; /* whether it makes sense to draw at all */
92 xcb_xv_query_image_attributes_reply_t *att;
93 picture_pool_t *pool; /* picture pool */
94 picture_resource_t resource[MAX_PICTURES];
97 static picture_t *Get (vout_display_t *);
98 static void Display (vout_display_t *, picture_t *);
99 static int Control (vout_display_t *, int, va_list);
100 static void Manage (vout_display_t *);
103 * Check that the X server supports the XVideo extension.
105 static bool CheckXVideo (vout_display_t *vd, xcb_connection_t *conn)
107 xcb_xv_query_extension_reply_t *r;
108 xcb_xv_query_extension_cookie_t ck = xcb_xv_query_extension (conn);
111 r = xcb_xv_query_extension_reply (conn, ck, NULL);
113 { /* We need XVideo 2.2 for PutImage */
114 if ((r->major > 2) || (r->major == 2 && r->minor >= 2))
116 msg_Dbg (vd, "using XVideo extension v%"PRIu8".%"PRIu8,
121 msg_Dbg (vd, "XVideo extension too old (v%"PRIu8".%"PRIu8,
126 msg_Dbg (vd, "XVideo extension not available");
130 static vlc_fourcc_t ParseFormat (vout_display_t *vd,
131 const xcb_xv_image_format_info_t *restrict f)
133 if (f->byte_order != ORDER && f->bpp != 8)
134 return 0; /* Argh! */
138 case XCB_XV_IMAGE_FORMAT_INFO_TYPE_RGB:
139 switch (f->num_planes)
146 return VLC_CODEC_RGB32;
150 return VLC_CODEC_RGB24;
154 return VLC_CODEC_RGB16;
156 return VLC_CODEC_RGB15;
160 return VLC_CODEC_RGB8;
165 msg_Err (vd, "unknown XVideo RGB format %"PRIx32" (%.4s)",
167 msg_Dbg (vd, " %"PRIu8" planes, %"PRIu8" bits/pixel, "
168 "depth %"PRIu8, f->num_planes, f->bpp, f->depth);
171 case XCB_XV_IMAGE_FORMAT_INFO_TYPE_YUV:
172 if (f->u_sample_bits != f->v_sample_bits
173 || f->vhorz_u_period != f->vhorz_v_period
174 || f->vvert_u_period != f->vvert_v_period
175 || f->y_sample_bits != 8 || f->u_sample_bits != 8
176 || f->vhorz_y_period != 1 || f->vvert_y_period != 1)
178 switch (f->num_planes)
184 if (f->vhorz_u_period == 1 && f->vvert_u_period == 1)
185 return VLC_CODEC_I444;
188 if (f->vhorz_u_period == 2 && f->vvert_u_period == 1)
190 if (!strcmp ((const char *)f->vcomp_order, "YUYV"))
191 return VLC_CODEC_YUYV;
192 if (!strcmp ((const char *)f->vcomp_order, "UYVY"))
193 return VLC_CODEC_UYVY;
202 if (f->vhorz_u_period == 2 && f->vvert_u_period == 2)
204 if (!strcmp ((const char *)f->vcomp_order, "YVU"))
205 return VLC_CODEC_YV12;
206 if (!strcmp ((const char *)f->vcomp_order, "YUV"))
207 return VLC_CODEC_I420;
213 msg_Err (vd, "unknown XVideo YUV format %"PRIx32" (%.4s)", f->id,
215 msg_Dbg (vd, " %"PRIu8" planes, %"PRIu32" bits/pixel, "
216 "%"PRIu32"/%"PRIu32"/%"PRIu32" bits/sample", f->num_planes,
217 f->bpp, f->y_sample_bits, f->u_sample_bits, f->v_sample_bits);
218 msg_Dbg (vd, " period: %"PRIu32"/%"PRIu32"/%"PRIu32"x"
219 "%"PRIu32"/%"PRIu32"/%"PRIu32,
220 f->vhorz_y_period, f->vhorz_u_period, f->vhorz_v_period,
221 f->vvert_y_period, f->vvert_u_period, f->vvert_v_period);
222 msg_Warn (vd, " order: %.32s", f->vcomp_order);
229 static const xcb_xv_image_format_info_t *
230 FindFormat (vout_display_t *vd,
231 vlc_fourcc_t chroma, const video_format_t *fmt,
233 const xcb_xv_list_image_formats_reply_t *list,
234 xcb_xv_query_image_attributes_reply_t **restrict pa)
236 xcb_connection_t *conn = vd->sys->conn;
237 const xcb_xv_image_format_info_t *f, *end;
240 f = xcb_xv_list_image_formats_format (list);
242 f = (xcb_xv_image_format_info_t *) (list + 1);
244 end = f + xcb_xv_list_image_formats_format_length (list);
247 if (chroma != ParseFormat (vd, f))
250 /* VLC pads scanline to 16 pixels internally */
251 unsigned width = (fmt->i_width + 15) & ~15;
252 unsigned height = (fmt->i_height + 15) & ~15;
253 xcb_xv_query_image_attributes_reply_t *i;
254 i = xcb_xv_query_image_attributes_reply (conn,
255 xcb_xv_query_image_attributes (conn, port, f->id,
256 width, height), NULL);
260 if (i->width != width || i->height != height)
262 msg_Warn (vd, "incompatible size %ux%u -> %"PRIu32"x%"PRIu32,
263 fmt->i_width, fmt->i_height,
264 i->width, i->height);
265 var_Create (vd->p_libvlc, "xvideo-resolution-error", VLC_VAR_BOOL);
266 if (!var_GetBool (vd->p_libvlc, "xvideo-resolution-error"))
268 dialog_FatalWait (vd, _("Video acceleration not available"),
269 _("Your video output acceleration driver does not support "
270 "the required resolution: %ux%u pixels. The maximum "
271 "supported resolution is %"PRIu32"x%"PRIu32".\n"
272 "Video output acceleration will be disabled. However, "
273 "rendering videos with overly large resolution "
274 "may cause severe performance degration."),
275 width, height, i->width, i->height);
276 var_SetBool (vd->p_libvlc, "xvideo-resolution-error", true);
289 * Probe the X server.
291 static int Open (vlc_object_t *obj)
293 vout_display_t *vd = (vout_display_t *)obj;
294 vout_display_sys_t *p_sys = malloc (sizeof (*p_sys));
301 xcb_connection_t *conn;
302 const xcb_screen_t *screen;
304 p_sys->embed = GetWindow (vd, &conn, &screen, &depth, &p_sys->shm);
305 if (p_sys->embed == NULL)
315 if (!CheckXVideo (vd, conn))
317 msg_Warn (vd, "Please enable XVideo 2.2 for faster video display");
321 p_sys->window = xcb_generate_id (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->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]; 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 p_sys->id = xfmt->id;
393 fmt.i_chroma = chroma;
394 if (xfmt->type == XCB_XV_IMAGE_FORMAT_INFO_TYPE_RGB)
396 fmt.i_rmask = xfmt->red_mask;
397 fmt.i_gmask = xfmt->green_mask;
398 fmt.i_bmask = xfmt->blue_mask;
404 if (xfmt == NULL) /* No acceptable image formats */
408 for (unsigned i = 0; i < a->num_ports; i++)
410 xcb_xv_port_t port = a->base_id + i;
411 xcb_xv_grab_port_reply_t *gr =
412 xcb_xv_grab_port_reply (conn,
413 xcb_xv_grab_port (conn, port, XCB_CURRENT_TIME), NULL);
414 uint8_t result = gr ? gr->result : 0xff;
422 msg_Dbg (vd, "cannot grab port %"PRIu32, port);
424 continue; /* No usable port */
427 /* Found port - initialize selected format */
428 name = strndup (xcb_xv_adaptor_info_name (a), a->name_size);
431 msg_Dbg (vd, "using adaptor %s", name);
434 msg_Dbg (vd, "using port %"PRIu32, p_sys->port);
435 msg_Dbg (vd, "using image format 0x%"PRIx32, p_sys->id);
437 /* Look for an X11 visual, create a window */
438 xcb_xv_format_t *f = xcb_xv_adaptor_info_formats (a);
439 for (uint_fast16_t i = a->num_formats; i > 0; i--, f++)
441 if (f->depth != depth)
442 continue; /* this would fail anyway */
444 const uint32_t mask =
445 /* XCB_CW_EVENT_MASK */
446 XCB_EVENT_MASK_VISIBILITY_CHANGE;
449 c = xcb_create_window_checked (conn, f->depth, p_sys->window,
450 p_sys->embed->xid, 0, 0, 1, 1, 0,
451 XCB_WINDOW_CLASS_INPUT_OUTPUT, f->visual,
452 XCB_CW_EVENT_MASK, &mask);
454 if (!CheckError (vd, conn, "cannot create X11 window", c))
456 msg_Dbg (vd, "using X11 visual ID 0x%"PRIx32
457 " (depth: %"PRIu8")", f->visual, f->depth);
458 msg_Dbg (vd, "using X11 window 0x%08"PRIx32, p_sys->window);
462 xcb_xv_ungrab_port (conn, p_sys->port, XCB_CURRENT_TIME);
463 continue; /* No workable XVideo format (visual/depth) */
466 found_adaptor = true;
472 msg_Err (vd, "no available XVideo adaptor");
477 xcb_map_window (conn, p_sys->window);
479 vout_display_place_t place;
481 vout_display_PlacePicture (&place, &vd->source, vd->cfg, false);
482 p_sys->width = place.width;
483 p_sys->height = place.height;
486 const uint32_t values[] = {
487 place.x, place.y, place.width, place.height };
488 xcb_configure_window (conn, p_sys->window,
489 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
490 XCB_CONFIG_WINDOW_WIDTH |
491 XCB_CONFIG_WINDOW_HEIGHT,
494 p_sys->visible = false;
496 /* Create graphic context */
497 p_sys->gc = xcb_generate_id (conn);
498 xcb_create_gc (conn, p_sys->gc, p_sys->window, 0, NULL);
499 msg_Dbg (vd, "using X11 graphic context 0x%08"PRIx32, p_sys->gc);
502 p_sys->cursor = CreateBlankCursor (conn, screen);
507 vout_display_info_t info = vd->info;
508 info.has_pictures_invalid = false;
510 /* Setup vout_display_t once everything is fine */
516 vd->display = Display;
517 vd->control = Control;
521 vout_display_SendEventFullscreen (vd, false);
522 unsigned width, height;
523 if (!GetWindowSize (p_sys->embed, conn, &width, &height))
524 vout_display_SendEventDisplaySize (vd, width, height, false);
535 * Disconnect from the X server.
537 static void Close (vlc_object_t *obj)
539 vout_display_t *vd = (vout_display_t *)obj;
540 vout_display_sys_t *p_sys = vd->sys;
544 for (unsigned i = 0; i < MAX_PICTURES; i++)
546 picture_resource_t *res = &p_sys->resource[i];
548 if (!res->p->p_pixels)
550 PictureResourceFree (res, NULL);
552 picture_pool_Delete (p_sys->pool);
556 xcb_disconnect (p_sys->conn);
557 vout_display_DeleteWindow (vd, p_sys->embed);
562 * Return a direct buffer
564 static picture_t *Get (vout_display_t *vd)
566 vout_display_sys_t *p_sys = vd->sys;
570 picture_t *pic = picture_New (vd->fmt.i_chroma, p_sys->att->width,
571 p_sys->att->height, 0);
575 memset (p_sys->resource, 0, sizeof(p_sys->resource));
577 const uint32_t *offsets =
578 xcb_xv_query_image_attributes_offsets (p_sys->att);
579 p_sys->data_size = p_sys->att->data_size;
582 picture_t *pic_array[MAX_PICTURES];
583 for (count = 0; count < MAX_PICTURES; count++)
585 picture_resource_t *res = &p_sys->resource[count];
587 for (int i = 0; i < pic->i_planes; i++)
589 res->p[i].i_lines = pic->p[i].i_lines; /* FIXME seems wrong*/
590 res->p[i].i_pitch = pic->p[i].i_pitch;
592 if (PictureResourceAlloc (vd, res, p_sys->att->data_size,
593 p_sys->conn, p_sys->shm))
596 /* Allocate further planes as specified by XVideo */
597 /* We assume that offsets[0] is zero */
598 for (int i = 1; i < pic->i_planes; i++)
599 res->p[i].p_pixels = res->p[0].p_pixels + offsets[i];
600 if (vd->fmt.i_chroma == VLC_CODEC_YV12)
601 { /* YVU: swap U and V planes */
602 uint8_t *buf = res->p[2].p_pixels;
603 res->p[2].p_pixels = res->p[1].p_pixels;
604 res->p[1].p_pixels = buf;
607 pic_array[count] = picture_NewFromResource (&vd->fmt, res);
608 if (!pic_array[count])
610 PictureResourceFree (res, p_sys->conn);
611 memset (res, 0, sizeof(*res));
615 picture_Release (pic);
620 p_sys->pool = picture_pool_New (count, pic_array);
623 /* TODO release picture resources */
626 /* FIXME should also do it in case of error ? */
627 xcb_flush (p_sys->conn);
630 return picture_pool_Get (p_sys->pool);
634 * Sends an image to the X server.
636 static void Display (vout_display_t *vd, picture_t *pic)
638 vout_display_sys_t *p_sys = vd->sys;
639 xcb_shm_seg_t segment = pic->p_sys->segment;
640 xcb_void_cookie_t ck;
645 ck = xcb_xv_shm_put_image_checked (p_sys->conn, p_sys->port,
646 p_sys->window, p_sys->gc, segment, p_sys->id, 0,
647 /* Src: */ vd->source.i_x_offset,
648 vd->source.i_y_offset,
649 vd->source.i_visible_width,
650 vd->source.i_visible_height,
651 /* Dst: */ 0, 0, p_sys->width, p_sys->height,
652 /* Memory: */ pic->p->i_pitch / pic->p->i_pixel_pitch,
653 pic->p->i_lines, false);
655 ck = xcb_xv_put_image_checked (p_sys->conn, p_sys->port, p_sys->window,
656 p_sys->gc, p_sys->id,
657 vd->source.i_x_offset,
658 vd->source.i_y_offset,
659 vd->source.i_visible_width,
660 vd->source.i_visible_height,
661 0, 0, p_sys->width, p_sys->height,
662 pic->p->i_pitch / pic->p->i_pixel_pitch,
664 p_sys->data_size, pic->p->p_pixels);
666 /* Wait for reply. See x11.c for rationale. */
667 xcb_generic_error_t *e = xcb_request_check (p_sys->conn, ck);
670 msg_Dbg (vd, "%s: X11 error %d", "cannot put image", e->error_code);
674 picture_Release (pic);
677 static int Control (vout_display_t *vd, int query, va_list ap)
679 vout_display_sys_t *p_sys = vd->sys;
683 case VOUT_DISPLAY_CHANGE_FULLSCREEN:
685 const vout_display_cfg_t *c = va_arg (ap, const vout_display_cfg_t *);
686 return vout_window_SetFullScreen (p_sys->embed, c->is_fullscreen);
689 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
690 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
691 case VOUT_DISPLAY_CHANGE_ZOOM:
692 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
693 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
695 const vout_display_cfg_t *cfg;
696 const video_format_t *source;
697 bool is_forced = false;
699 if (query == VOUT_DISPLAY_CHANGE_SOURCE_ASPECT
700 || query == VOUT_DISPLAY_CHANGE_SOURCE_CROP)
702 source = (const video_format_t *)va_arg (ap, const video_format_t *);
707 source = &vd->source;
708 cfg = (const vout_display_cfg_t*)va_arg (ap, const vout_display_cfg_t *);
709 if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE)
710 is_forced = (bool)va_arg (ap, int);
714 if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE
716 && (cfg->display.width != vd->cfg->display.width
717 ||cfg->display.height != vd->cfg->display.height)
718 && vout_window_SetSize (p_sys->embed,
720 cfg->display.height))
723 vout_display_place_t place;
724 vout_display_PlacePicture (&place, source, cfg, false);
725 p_sys->width = place.width;
726 p_sys->height = place.height;
728 /* Move the picture within the window */
729 const uint32_t values[] = { place.x, place.y,
730 place.width, place.height, };
731 xcb_configure_window (p_sys->conn, p_sys->window,
732 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y
733 | XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
735 xcb_flush (p_sys->conn);
738 case VOUT_DISPLAY_CHANGE_ON_TOP:
740 int on_top = (int)va_arg (ap, int);
741 return vout_window_SetOnTop (p_sys->embed, on_top);
744 /* Hide the mouse. It will be send when
745 * vout_display_t::info.b_hide_mouse is false */
746 case VOUT_DISPLAY_HIDE_MOUSE:
747 xcb_change_window_attributes (p_sys->conn, p_sys->embed->xid,
748 XCB_CW_CURSOR, &(uint32_t){ p_sys->cursor });
750 case VOUT_DISPLAY_RESET_PICTURES:
753 msg_Err (vd, "Unknown request in XCB vout display");
758 static void Manage (vout_display_t *vd)
760 vout_display_sys_t *p_sys = vd->sys;
762 ManageEvent (vd, p_sys->conn, &p_sys->visible);