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.0
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 Lesser 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>
37 #include <vlc_window.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 SHM_TEXT N_("Use shared memory")
47 #define SHM_LONGTEXT N_( \
48 "Use shared memory to communicate between VLC and the X server.")
50 static int Open (vlc_object_t *);
51 static void Close (vlc_object_t *);
57 set_shortname (N_("XVideo"))
58 set_description (N_("(Experimental) XVideo output"))
59 set_category (CAT_VIDEO)
60 set_subcategory (SUBCAT_VIDEO_VOUT)
61 set_capability ("video output", 0)
62 set_callbacks (Open, Close)
64 add_string ("x11-display", NULL, NULL,
65 DISPLAY_TEXT, DISPLAY_LONGTEXT, true)
66 add_bool ("x11-shm", true, NULL, SHM_TEXT, SHM_LONGTEXT, true)
67 add_shortcut ("xcb-xv")
72 xcb_connection_t *conn;
73 xcb_xv_query_adaptors_reply_t *adaptors;
74 vout_window_t *embed;/* VLC window */
76 xcb_window_t window; /* drawable X window */
77 xcb_gcontext_t gc; /* context to put images */
78 xcb_xv_port_t port; /* XVideo port */
79 uint32_t id; /* XVideo format */
80 uint16_t width; /* display width */
81 uint16_t height; /* display height */
82 uint32_t data_size; /* picture byte size (for non-SHM) */
83 bool shm; /* whether to use MIT-SHM */
86 static int Init (vout_thread_t *);
87 static void Deinit (vout_thread_t *);
88 static void Display (vout_thread_t *, picture_t *);
89 static int Manage (vout_thread_t *);
90 static int Control (vout_thread_t *, int, va_list);
92 int CheckError (vout_thread_t *vout, const char *str, xcb_void_cookie_t ck)
94 xcb_generic_error_t *err;
96 err = xcb_request_check (vout->p_sys->conn, ck);
99 msg_Err (vout, "%s: X11 error %d", str, err->error_code);
106 * Check that the X server supports the XVideo extension.
108 static bool CheckXVideo (vout_thread_t *vout, xcb_connection_t *conn)
110 xcb_xv_query_extension_reply_t *r;
111 xcb_xv_query_extension_cookie_t ck = xcb_xv_query_extension (conn);
114 r = xcb_xv_query_extension_reply (conn, ck, NULL);
116 { /* We need XVideo 2.2 for PutImage */
117 if ((r->major > 2) || (r->major == 2 && r->minor >= 2))
119 msg_Dbg (vout, "using XVideo extension v%"PRIu8".%"PRIu8,
124 msg_Dbg (vout, "XVideo extension too old (v%"PRIu8".%"PRIu8,
129 msg_Dbg (vout, "XVideo extension not available");
134 * Get a list of XVideo adaptors for a given window.
136 static xcb_xv_query_adaptors_reply_t *GetAdaptors (vout_window_t *wnd,
137 xcb_connection_t *conn)
139 xcb_xv_query_adaptors_cookie_t ck;
141 ck = xcb_xv_query_adaptors (conn, wnd->handle.xid);
142 return xcb_xv_query_adaptors_reply (conn, ck, NULL);
148 * Probe the X server.
150 static int Open (vlc_object_t *obj)
152 vout_thread_t *vout = (vout_thread_t *)obj;
153 vout_sys_t *p_sys = malloc (sizeof (*p_sys));
160 p_sys->conn = Connect (obj);
161 if (p_sys->conn == NULL)
164 if (!CheckXVideo (vout, p_sys->conn))
166 msg_Warn (vout, "Please enable XVideo 2.2 for faster video display");
167 xcb_disconnect (p_sys->conn);
171 const xcb_screen_t *screen;
172 p_sys->embed = GetWindow (vout, p_sys->conn, &screen, &p_sys->shm);
173 if (p_sys->embed == NULL)
175 xcb_disconnect (p_sys->conn);
179 /* Cache adaptors infos */
180 p_sys->adaptors = GetAdaptors (p_sys->embed, p_sys->conn);
181 if (p_sys->adaptors == NULL)
186 const uint32_t mask =
187 /* XCB_CW_EVENT_MASK */
188 XCB_EVENT_MASK_BUTTON_PRESS | XCB_EVENT_MASK_BUTTON_RELEASE |
189 XCB_EVENT_MASK_POINTER_MOTION;
191 xcb_window_t window = xcb_generate_id (p_sys->conn);
193 c = xcb_create_window_checked (p_sys->conn, screen->root_depth, window,
194 p_sys->embed->handle.xid, 0, 0, 1, 1, 0,
195 XCB_WINDOW_CLASS_INPUT_OUTPUT,
197 XCB_CW_EVENT_MASK, &mask);
198 if (CheckError (vout, "cannot create X11 window", c))
200 p_sys->window = window;
201 msg_Dbg (vout, "using X11 window %08"PRIx32, p_sys->window);
202 xcb_map_window (p_sys->conn, window);
205 p_sys->gc = xcb_generate_id (p_sys->conn);
206 xcb_create_gc (p_sys->conn, p_sys->gc, p_sys->window, 0, NULL);
207 msg_Dbg (vout, "using X11 graphic context %08"PRIx32, p_sys->gc);
209 vout->pf_init = Init;
210 vout->pf_end = Deinit;
211 vout->pf_display = Display;
212 vout->pf_manage = Manage;
213 vout->pf_control = Control;
223 * Disconnect from the X server.
225 static void Close (vlc_object_t *obj)
227 vout_thread_t *vout = (vout_thread_t *)obj;
228 vout_sys_t *p_sys = vout->p_sys;
230 free (p_sys->adaptors);
231 vout_ReleaseWindow (p_sys->embed);
232 xcb_disconnect (p_sys->conn);
236 static vlc_fourcc_t ParseFormat (vout_thread_t *vout,
237 const xcb_xv_image_format_info_t *restrict f)
239 if (f->byte_order != ORDER && f->bpp != 8)
240 return 0; /* Argh! */
244 case XCB_XV_IMAGE_FORMAT_INFO_TYPE_RGB:
245 switch (f->num_planes)
252 return VLC_FOURCC ('R', 'V', '3', '2');
256 return VLC_FOURCC ('R', 'V', '2', '4');
260 return VLC_FOURCC ('R', 'V', '1', '6');
262 return VLC_FOURCC ('R', 'V', '1', '5');
266 return VLC_FOURCC ('R', 'G', 'B', '2');
271 msg_Err (vout, "unknown XVideo RGB format %"PRIx32" (%.4s)",
273 msg_Dbg (vout, " %"PRIu8" planes, %"PRIu8" bits/pixel, "
274 "depth %"PRIu8, f->num_planes, f->bpp, f->depth);
277 case XCB_XV_IMAGE_FORMAT_INFO_TYPE_YUV:
278 if (f->u_sample_bits != f->v_sample_bits
279 || f->vhorz_u_period != f->vhorz_v_period
280 || f->vvert_u_period != f->vvert_v_period
281 || f->y_sample_bits != 8 || f->u_sample_bits != 8
282 || f->vhorz_y_period != 1 || f->vvert_y_period != 1)
284 switch (f->num_planes)
290 if (f->vhorz_u_period == 1 && f->vvert_u_period == 1)
291 return VLC_FOURCC ('I', '4', '4', '4');
294 if (f->vhorz_u_period == 2 && f->vvert_u_period == 1)
296 if (!strcmp ((const char *)f->vcomp_order, "YUYV"))
297 return VLC_FOURCC ('Y', 'U', 'Y', '2');
298 if (!strcmp ((const char *)f->vcomp_order, "UYVY"))
299 return VLC_FOURCC ('U', 'Y', 'V', 'Y');
308 if (f->vhorz_u_period == 2 && f->vvert_u_period == 2)
310 if (!strcmp ((const char *)f->vcomp_order, "YVU"))
311 return VLC_FOURCC ('Y', 'V', '1', '2');
312 if (!strcmp ((const char *)f->vcomp_order, "YUV"))
313 return VLC_FOURCC ('I', '4', '2', '0');
319 msg_Err (vout, "unknown XVideo YUV format %"PRIx32" (%.4s)", f->id,
321 msg_Dbg (vout, " %"PRIu8" planes, %"PRIu32" bits/pixel, "
322 "%"PRIu32"/%"PRIu32"/%"PRIu32" bits/sample", f->num_planes,
323 f->bpp, f->y_sample_bits, f->u_sample_bits, f->v_sample_bits);
324 msg_Dbg (vout, " period: %"PRIu32"/%"PRIu32"/%"PRIu32"x"
325 "%"PRIu32"/%"PRIu32"/%"PRIu32,
326 f->vhorz_y_period, f->vhorz_u_period, f->vhorz_v_period,
327 f->vvert_y_period, f->vvert_u_period, f->vvert_v_period);
328 msg_Warn (vout, " order: %.32s", f->vcomp_order);
335 static const xcb_xv_image_format_info_t *
336 FindFormat (vout_thread_t *vout, vlc_fourcc_t chroma, xcb_xv_port_t port,
337 const xcb_xv_list_image_formats_reply_t *list,
338 xcb_xv_query_image_attributes_reply_t **restrict pa)
340 xcb_connection_t *conn = vout->p_sys->conn;
341 const xcb_xv_image_format_info_t *f, *end;
343 f = xcb_xv_list_image_formats_format (list);
344 end = f + xcb_xv_list_image_formats_format_length (list);
347 if (chroma != ParseFormat (vout, f))
350 xcb_xv_query_image_attributes_reply_t *i;
351 i = xcb_xv_query_image_attributes_reply (conn,
352 xcb_xv_query_image_attributes (conn, port, f->id,
353 vout->fmt_in.i_width, vout->fmt_in.i_height), NULL);
357 if (i->width != vout->fmt_in.i_width
358 || i->height != vout->fmt_in.i_height)
360 msg_Warn (vout, "incompatible size %ux%u -> %"PRIu32"x%"PRIu32,
361 vout->fmt_in.i_width, vout->fmt_in.i_height,
362 i->width, i->height);
373 * Allocate drawable window and picture buffers.
375 static int Init (vout_thread_t *vout)
377 vout_sys_t *p_sys = vout->p_sys;
378 xcb_xv_query_image_attributes_reply_t *att = NULL;
379 bool swap_planes = false; /* whether X wants V before U */
381 /* FIXME: check max image size */
382 xcb_xv_adaptor_info_iterator_t it;
383 for (it = xcb_xv_query_adaptors_info_iterator (p_sys->adaptors);
385 xcb_xv_adaptor_info_next (&it))
387 const xcb_xv_adaptor_info_t *a = it.data;
389 /* FIXME: Open() should fail if none of the ports are usable to VLC */
390 if (!(a->type & XCB_XV_TYPE_IMAGE_MASK))
393 xcb_xv_list_image_formats_reply_t *r;
394 r = xcb_xv_list_image_formats_reply (p_sys->conn,
395 xcb_xv_list_image_formats (p_sys->conn, a->base_id), NULL);
399 const xcb_xv_image_format_info_t *fmt;
401 /* Video chroma in preference order */
402 const vlc_fourcc_t chromas[] = {
403 vout->fmt_in.i_chroma,
404 VLC_FOURCC ('Y', 'U', 'Y', '2'),
405 VLC_FOURCC ('R', 'V', '2', '4'),
406 VLC_FOURCC ('R', 'V', '1', '5'),
408 for (size_t i = 0; i < sizeof (chromas) / sizeof (chromas[0]); i++)
410 vlc_fourcc_t chroma = chromas[i];
411 fmt = FindFormat (vout, chroma, a->base_id, r, &att);
414 vout->output.i_chroma = chroma;
422 /* TODO: grab port */
423 p_sys->port = a->base_id;
424 msg_Dbg (vout, "using port %"PRIu32, p_sys->port);
427 msg_Dbg (vout, "using image format 0x%"PRIx32, p_sys->id);
428 if (fmt->type == XCB_XV_IMAGE_FORMAT_INFO_TYPE_RGB)
430 vout->fmt_out.i_rmask = vout->output.i_rmask = fmt->red_mask;
431 vout->fmt_out.i_gmask = vout->output.i_gmask = fmt->green_mask;
432 vout->fmt_out.i_bmask = vout->output.i_bmask = fmt->blue_mask;
435 if (fmt->num_planes == 3)
436 swap_planes = !strcmp ((const char *)fmt->vcomp_order, "YVU");
440 msg_Err (vout, "no available XVideo adaptor");
441 return VLC_EGENERIC; /* no usable adaptor */
443 /* Allocate picture buffers */
444 const uint32_t *offsets;
446 offsets = xcb_xv_query_image_attributes_offsets (att);
447 p_sys->data_size = att->data_size;
449 I_OUTPUTPICTURES = 0;
450 for (size_t index = 0; I_OUTPUTPICTURES < 2; index++)
452 picture_t *pic = vout->p_picture + index;
454 if (index > sizeof (vout->p_picture) / sizeof (pic))
456 if (pic->i_status != FREE_PICTURE)
459 vout_InitPicture (vout, pic, vout->output.i_chroma,
460 att->width, att->height,
461 vout->fmt_in.i_aspect);
462 if (PictureAlloc (vout, pic, att->data_size,
463 p_sys->shm ? p_sys->conn : NULL))
465 /* Allocate further planes as specified by XVideo */
466 /* We assume that offsets[0] is zero */
467 for (int i = 1; i < pic->i_planes; i++)
469 pic->p->p_pixels + offsets[swap_planes ? (3 - i) : i];
470 PP_OUTPUTPICTURE[I_OUTPUTPICTURES++] = pic;
474 unsigned x, y, width, height;
476 if (GetWindowSize (p_sys->embed, p_sys->conn, &width, &height))
478 vout_PlacePicture (vout, width, height, &x, &y, &width, &height);
480 const uint32_t values[] = { x, y, width, height, };
481 xcb_configure_window (p_sys->conn, p_sys->window,
482 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
483 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
485 xcb_flush (p_sys->conn);
486 p_sys->height = height;
487 p_sys->width = width;
489 vout->fmt_out.i_chroma = vout->output.i_chroma;
490 vout->fmt_out.i_visible_width = vout->fmt_in.i_visible_width;
491 vout->fmt_out.i_visible_height = vout->fmt_in.i_visible_height;
492 vout->fmt_out.i_sar_num = vout->fmt_out.i_sar_den = 1;
494 vout->output.i_width = vout->fmt_out.i_width = vout->fmt_in.i_width;
495 vout->output.i_height = vout->fmt_out.i_height = vout->fmt_in.i_height;
496 vout->fmt_out.i_x_offset = vout->fmt_in.i_x_offset;
497 vout->fmt_out.i_y_offset = vout->fmt_in.i_y_offset;
500 vout->output.i_aspect = vout->fmt_out.i_aspect =
501 width * VOUT_ASPECT_FACTOR / height;
507 * Free picture buffers.
509 static void Deinit (vout_thread_t *vout)
511 vout_sys_t *p_sys = vout->p_sys;
513 for (int i = 0; i < I_OUTPUTPICTURES; i++)
514 PictureFree (PP_OUTPUTPICTURE[i], p_sys->conn);
518 * Sends an image to the X server.
520 static void Display (vout_thread_t *vout, picture_t *pic)
522 vout_sys_t *p_sys = vout->p_sys;
523 xcb_shm_seg_t segment = (uintptr_t)pic->p_sys;
526 xcb_xv_shm_put_image (p_sys->conn, p_sys->port, p_sys->window,
527 p_sys->gc, segment, p_sys->id, 0,
528 /* Src: */ vout->fmt_out.i_x_offset,
529 vout->fmt_out.i_y_offset,
530 vout->fmt_out.i_visible_width,
531 vout->fmt_out.i_visible_height,
532 /* Dst: */ 0, 0, p_sys->width, p_sys->height,
534 pic->p->i_pitch / pic->p->i_pixel_pitch,
535 pic->p->i_lines, false);
537 xcb_xv_put_image (p_sys->conn, p_sys->port, p_sys->window,
538 p_sys->gc, p_sys->id,
539 vout->fmt_out.i_x_offset, vout->fmt_out.i_y_offset,
540 vout->fmt_out.i_visible_width,
541 vout->fmt_out.i_visible_height,
542 0, 0, p_sys->width, p_sys->height,
543 vout->fmt_out.i_width, vout->fmt_out.i_height,
544 p_sys->data_size, pic->p->p_pixels);
545 xcb_flush (p_sys->conn);
549 * Process incoming X events.
551 static int Manage (vout_thread_t *vout)
553 vout_sys_t *p_sys = vout->p_sys;
554 xcb_generic_event_t *ev;
556 while ((ev = xcb_poll_for_event (p_sys->conn)) != NULL)
557 ProcessEvent (vout, p_sys->conn, p_sys->window, ev);
559 if (xcb_connection_has_error (p_sys->conn))
561 msg_Err (vout, "X server failure");
566 if (vout->i_changes & VOUT_SIZE_CHANGE)
567 { /* TODO: factor this code with XV and X11 Init() */
568 unsigned x, y, width, height;
570 if (GetWindowSize (p_sys->embed, p_sys->conn, &width, &height))
572 vout_PlacePicture (vout, width, height, &x, &y, &width, &height);
574 const uint32_t values[] = { x, y, width, height, };
575 xcb_configure_window (p_sys->conn, p_sys->window, XCB_CONFIG_WINDOW_X |
576 XCB_CONFIG_WINDOW_Y | XCB_CONFIG_WINDOW_WIDTH |
577 XCB_CONFIG_WINDOW_HEIGHT, values);
578 vout->p_sys->width = width; // XXX: <-- this is useless, as the zoom is
579 vout->p_sys->height = height; // handled with VOUT_SET_SIZE anyway.
580 vout->i_changes &= ~VOUT_SIZE_CHANGE;
586 HandleParentStructure (vout_thread_t *vout, xcb_connection_t *conn,
587 xcb_window_t xid, xcb_configure_notify_event_t *ev)
589 unsigned width, height, x, y;
591 vout_PlacePicture (vout, ev->width, ev->height, &x, &y, &width, &height);
593 /* Move the picture within the window */
594 const uint32_t values[] = { x, y, width, height, };
595 xcb_configure_window (conn, xid,
596 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y
597 | XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
599 vout->p_sys->width = width;
600 vout->p_sys->height = height;
603 static int Control (vout_thread_t *vout, int query, va_list ap)
605 return vout_ControlWindow (vout->p_sys->embed, query, ap);