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 ****************************************************************************/
30 #include <sys/types.h>
36 #include <xcb/xcb_aux.h>
37 #include <xcb/xcb_image.h>
39 #include <vlc_common.h>
40 #include <vlc_plugin.h>
42 #include <vlc_window.h>
46 #define DISPLAY_TEXT N_("X11 display")
47 #define DISPLAY_LONGTEXT N_( \
48 "X11 hardware display to use. By default VLC will " \
49 "use the value of the DISPLAY environment variable.")
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_("XCB"))
63 set_description (N_("(Experimental) XCB video output"))
64 set_category (CAT_VIDEO)
65 set_subcategory (SUBCAT_VIDEO_VOUT)
66 set_capability ("video output", 0)
67 set_callbacks (Open, Close)
69 add_string ("x11-display", NULL, NULL,
70 DISPLAY_TEXT, DISPLAY_LONGTEXT, true)
71 add_bool ("x11-shm", true, NULL, SHM_TEXT, SHM_LONGTEXT, true)
76 xcb_connection_t *conn;
78 vout_window_t *embed; /* VLC window (when windowed) */
80 xcb_visualid_t vid; /* selected visual */
81 xcb_window_t parent; /* parent X window */
82 xcb_colormap_t cmap; /* colormap for selected visual */
83 xcb_window_t window; /* drawable X window */
84 xcb_gcontext_t gc; /* context to put images */
85 bool shm; /* whether to use MIT-SHM */
86 uint8_t bpp; /* bits per pixel */
87 uint8_t pad; /* scanline pad */
88 uint8_t byte_order; /* server byte order */
91 static int Init (vout_thread_t *);
92 static void Deinit (vout_thread_t *);
93 static void Display (vout_thread_t *, picture_t *);
94 static int Manage (vout_thread_t *);
96 int CheckError (vout_thread_t *vout, const char *str, xcb_void_cookie_t ck)
98 xcb_generic_error_t *err;
100 err = xcb_request_check (vout->p_sys->conn, ck);
103 msg_Err (vout, "%s: X11 error %d", str, err->error_code);
112 * Probe the X server.
114 static int Open (vlc_object_t *obj)
116 vout_thread_t *vout = (vout_thread_t *)obj;
117 vout_sys_t *p_sys = malloc (sizeof (*p_sys));
126 char *display = var_CreateGetNonEmptyString (vout, "x11-display");
128 p_sys->conn = xcb_connect (display, &snum);
129 if (xcb_connection_has_error (p_sys->conn) /*== NULL*/)
131 msg_Err (vout, "cannot connect to X server %s",
132 display ? display : "");
138 const xcb_setup_t *setup = xcb_get_setup (p_sys->conn);
139 p_sys->byte_order = setup->image_byte_order;
141 /* Get the preferred screen */
142 xcb_screen_t *scr = xcb_aux_get_screen (p_sys->conn, snum);
144 assert (p_sys->screen);
145 msg_Dbg (vout, "using screen %d", snum);
147 /* Determine our video format. Normally, this is done in pf_init(), but
148 * this plugin always uses the same format for a given X11 screen. */
151 for (const xcb_format_t *fmt = xcb_setup_pixmap_formats (setup),
152 *end = fmt + xcb_setup_pixmap_formats_length (setup);
155 vlc_fourcc_t chroma = 0;
157 if (fmt->depth < depth)
158 continue; /* We already found a better format! */
160 /* Check that the pixmap format is supported by VLC. */
164 if (fmt->bits_per_pixel == 32)
165 chroma = VLC_FOURCC ('R', 'V', '3', '2');
166 else if (fmt->bits_per_pixel == 24)
167 chroma = VLC_FOURCC ('R', 'V', '2', '4');
172 if (fmt->bits_per_pixel != 16)
174 chroma = VLC_FOURCC ('R', 'V', '1', '6');
177 if (fmt->bits_per_pixel != 16)
179 chroma = VLC_FOURCC ('R', 'V', '1', '5');
182 if (fmt->bits_per_pixel != 8)
184 chroma = VLC_FOURCC ('R', 'G', 'B', '2');
189 if ((fmt->bits_per_pixel << 4) % fmt->scanline_pad)
190 continue; /* VLC pads lines to 16 pixels internally */
192 /* Byte sex is a non-issue for 8-bits. It can be worked around with
193 * RGB masks for 24-bits. Too bad for 15-bits and 16-bits. */
194 #ifdef WORDS_BIGENDIAN
195 # define ORDER XCB_IMAGE_ORDER_MSB_FIRST
197 # define ORDER XCB_IMAGE_ORDER_LSB_FIRST
199 if (fmt->bits_per_pixel == 16 && setup->image_byte_order != ORDER)
202 /* Check that the selected screen supports this depth */
203 xcb_depth_iterator_t it = xcb_screen_allowed_depths_iterator (scr);
204 while (it.rem > 0 && it.data->depth != fmt->depth)
205 xcb_depth_next (&it);
207 continue; /* Depth not supported on this screen */
209 /* Find a visual type for the selected depth */
210 const xcb_visualtype_t *vt = xcb_depth_visuals (it.data);
211 xcb_visualid_t vid = 0;
212 for (int i = xcb_depth_visuals_length (it.data); (i > 0) && !vid; i--)
214 if (vt->_class == XCB_VISUAL_CLASS_TRUE_COLOR)
217 "using TrueColor %"PRIu8"-bits visual ID 0x%0"PRIx32,
218 fmt->depth, vt->visual_id);
223 if (fmt->depth == 8 && vt->_class == XCB_VISUAL_CLASS_STATIC_GRAY)
226 continue; /* Prefer color over gray scale */
228 chroma = VLC_FOURCC ('G', 'R', 'E', 'Y');
230 "using static gray 8-bits visual ID 0x%x"PRIx32,
237 continue; /* The screen does not *really* support this depth */
239 vout->fmt_out.i_chroma = vout->output.i_chroma = chroma;
242 vout->output.i_rmask = vt->red_mask;
243 vout->output.i_gmask = vt->green_mask;
244 vout->output.i_bmask = vt->blue_mask;
247 p_sys->bpp = fmt->bits_per_pixel;
248 p_sys->pad = fmt->scanline_pad;
255 msg_Err (vout, "no supported pixmap formats");
259 msg_Dbg (vout, "using %"PRIu8" bits per pixels (line pad: %"PRIu8")",
260 p_sys->bpp, p_sys->pad);
262 /* Create colormap (needed to select non-default visual) */
263 if (p_sys->vid != scr->root_visual)
265 p_sys->cmap = xcb_generate_id (p_sys->conn);
266 xcb_create_colormap (p_sys->conn, XCB_COLORMAP_ALLOC_NONE,
267 p_sys->cmap, scr->root, p_sys->vid);
270 p_sys->cmap = scr->default_colormap;
272 /* Check shared memory support */
273 p_sys->shm = var_CreateGetBool (vout, "x11-shm") > 0;
276 xcb_shm_query_version_cookie_t ck;
277 xcb_shm_query_version_reply_t *r;
278 xcb_generic_error_t *err;
280 ck = xcb_shm_query_version (p_sys->conn);
281 r = xcb_shm_query_version_reply (p_sys->conn, ck, &err);
284 msg_Err (vout, "shared memory (MIT-SHM) not available");
285 msg_Warn (vout, "display will be slow");
291 /* FIXME: WTH to put as initial width/height values??? */
292 p_sys->embed = vout_RequestXWindow (vout, &(int){ 0 }, &(int){ 0 },
293 &(unsigned){ 0 }, &(unsigned){ 0 });
294 if (p_sys->embed == NULL)
296 msg_Err (vout, "parent window not available");
300 vout->pf_init = Init;
301 vout->pf_end = Deinit;
302 vout->pf_display = Display;
303 vout->pf_manage = Manage;
313 * Disconnect from the X server.
315 static void Close (vlc_object_t *obj)
317 vout_thread_t *vout = (vout_thread_t *)obj;
318 vout_sys_t *p_sys = vout->p_sys;
321 vout_ReleaseWindow (p_sys->embed);
322 /* colormap is garbage-ollected by X (?) */
324 xcb_disconnect (p_sys->conn);
330 xcb_connection_t *conn; /* Shared connection to X server */
331 xcb_image_t *image; /* Picture buffer */
332 xcb_shm_seg_t segment; /* Shared memory segment X ID */
335 #define SHM_ERR ((void *)(intptr_t)(-1))
337 static int PictureInit (vout_thread_t *vout, picture_t *pic)
339 vout_sys_t *p_sys = vout->p_sys;
340 picture_sys_t *priv = malloc (sizeof (*p_sys));
345 assert (pic->i_status == FREE_PICTURE);
346 vout_InitPicture (vout, pic, vout->output.i_chroma,
347 vout->output.i_width, vout->output.i_height,
348 vout->output.i_aspect);
351 const size_t size = pic->p->i_pitch * pic->p->i_lines;
354 { /* Allocate shared memory segment */
355 int id = shmget (IPC_PRIVATE, size, IPC_CREAT | 0700);
359 msg_Err (vout, "shared memory allocation error: %m");
363 /* Attach the segment to VLC */
364 shm = shmat (id, NULL, 0 /* read/write */);
367 msg_Err (vout, "shared memory attachment error: %m");
368 shmctl (id, IPC_RMID, 0);
372 /* Attach the segment to X */
373 xcb_void_cookie_t ck;
375 priv->segment = xcb_generate_id (p_sys->conn);
376 ck = xcb_shm_attach_checked (p_sys->conn, priv->segment, id, 1);
377 shmctl (id, IPC_RMID, 0);
379 if (CheckError (vout, "shared memory server-side error", ck))
381 msg_Info (vout, "using buggy X (remote) server? SSH?");
389 const unsigned real_width = pic->p->i_pitch / (p_sys->bpp >> 3);
390 /* FIXME: anyway to getthing more intuitive than that?? */
393 img = xcb_image_create (real_width, pic->p->i_lines,
394 XCB_IMAGE_FORMAT_Z_PIXMAP, p_sys->pad,
395 p_sys->screen->root_depth, p_sys->bpp, p_sys->bpp,
396 p_sys->byte_order, XCB_IMAGE_ORDER_MSB_FIRST,
398 (shm != SHM_ERR) ? size : 0,
399 (shm != SHM_ERR) ? shm : NULL);
404 xcb_shm_detach (p_sys->conn, priv->segment);
408 priv->conn = p_sys->conn;
411 pic->p->p_pixels = img->data;
412 pic->i_status = DESTROYED_PICTURE;
413 pic->i_type = DIRECT_PICTURE;
425 * Release picture private data
427 static void PictureDeinit (picture_t *pic)
429 struct picture_sys_t *p_sys = pic->p_sys;
431 if (p_sys->segment != 0)
433 xcb_shm_detach (p_sys->conn, p_sys->segment);
434 shmdt (p_sys->image->data);
436 xcb_image_destroy (p_sys->image);
441 * Allocate drawable window and picture buffers.
443 static int Init (vout_thread_t *vout)
445 vout_sys_t *p_sys = vout->p_sys;
446 const xcb_screen_t *screen = p_sys->screen;
447 unsigned x, y, width, height;
449 I_OUTPUTPICTURES = 0;
451 /* Determine parent window and size */
452 if (vout->b_fullscreen)
454 p_sys->parent = screen->root;
455 width = screen->width_in_pixels;
456 height = screen->height_in_pixels;
460 p_sys->parent = p_sys->embed->handle.xid;
462 /* Subscribe to parent window resize events */
463 const uint32_t value = XCB_EVENT_MASK_STRUCTURE_NOTIFY;
464 xcb_change_window_attributes (p_sys->conn, p_sys->parent,
465 XCB_CW_EVENT_MASK, &value);
467 xcb_get_geometry_cookie_t ck;
468 ck = xcb_get_geometry (p_sys->conn, p_sys->parent);
470 xcb_get_geometry_reply_t *geo;
471 xcb_generic_error_t *err;
472 geo = xcb_get_geometry_reply (p_sys->conn, ck, &err);
474 height = geo->height;
478 vout_PlacePicture (vout, width, height, &x, &y, &width, &height);
480 /* FIXME: I don't get the subtlety between output and fmt_out here */
481 vout->fmt_out.i_visible_width = width;
482 vout->fmt_out.i_visible_height = height;
483 vout->fmt_out.i_sar_num = vout->fmt_out.i_sar_den = 1;
485 vout->output.i_width = vout->fmt_out.i_width =
486 width * vout->fmt_in.i_width / vout->fmt_in.i_visible_width;
487 vout->output.i_height = vout->fmt_out.i_height =
488 height * vout->fmt_in.i_height / vout->fmt_in.i_visible_height;
489 vout->fmt_out.i_x_offset =
490 width * vout->fmt_in.i_x_offset / vout->fmt_in.i_visible_width;
491 p_vout->fmt_out.i_y_offset =
492 height * vout->fmt_in.i_y_offset / vout->fmt_in.i_visible_height;
495 vout->output.i_aspect = vout->fmt_out.i_aspect =
496 width * VOUT_ASPECT_FACTOR / height;
499 const uint32_t mask = XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK
501 const uint32_t values[] = {
502 /* XCB_CW_BACK_PIXEL */
504 /* XCB_CW_EVENT_MASK */
505 XCB_EVENT_MASK_BUTTON_PRESS | XCB_EVENT_MASK_BUTTON_RELEASE |
506 XCB_EVENT_MASK_POINTER_MOTION,
507 /* XCB_CW_COLORMAP */
511 xcb_window_t window = xcb_generate_id (p_sys->conn);
513 c = xcb_create_window_checked (p_sys->conn, screen->root_depth, window,
514 p_sys->parent, x, y, width, height, 0,
515 XCB_WINDOW_CLASS_INPUT_OUTPUT,
516 p_sys->vid, mask, values);
517 if (CheckError (vout, "cannot create X11 window", c))
519 p_sys->window = window;
520 msg_Dbg (vout, "using X11 window %08"PRIx32, p_sys->window);
521 xcb_map_window (p_sys->conn, window);
523 /* Create graphic context (I wonder why the heck do we need this) */
524 p_sys->gc = xcb_generate_id (p_sys->conn);
525 xcb_create_gc (p_sys->conn, p_sys->gc, p_sys->window, 0, NULL);
526 msg_Dbg (vout, "using X11 graphic context %08"PRIx32, p_sys->gc);
527 xcb_flush (p_sys->conn);
529 /* Allocate picture buffers */
530 I_OUTPUTPICTURES = 0;
531 for (size_t index = 0; I_OUTPUTPICTURES < 2; index++)
533 picture_t *pic = vout->p_picture + index;
535 if (index > sizeof (vout->p_picture) / sizeof (pic))
537 if (pic->i_status != FREE_PICTURE)
539 if (PictureInit (vout, pic))
541 PP_OUTPUTPICTURE[I_OUTPUTPICTURES++] = pic;
552 * Free picture buffers.
554 static void Deinit (vout_thread_t *vout)
556 vout_sys_t *p_sys = vout->p_sys;
558 for (int i = 0; i < I_OUTPUTPICTURES; i++)
559 PictureDeinit (PP_OUTPUTPICTURE[i]);
561 xcb_unmap_window (p_sys->conn, p_sys->window);
562 xcb_destroy_window (p_sys->conn, p_sys->window);
566 * Sends an image to the X server.
568 static void Display (vout_thread_t *vout, picture_t *pic)
570 vout_sys_t *p_sys = vout->p_sys;
571 picture_sys_t *priv = pic->p_sys;
572 xcb_image_t *img = priv->image;
574 if (img->base == NULL)
576 xcb_shm_segment_info_t info = {
577 .shmseg = priv->segment,
578 .shmid = -1, /* lost track of it, unimportant */
579 .shmaddr = img->data,
582 xcb_image_shm_put (p_sys->conn, p_sys->window, p_sys->gc, img, info,
583 0, 0, 0, 0, img->width, img->height, 0);
586 xcb_image_put (p_sys->conn, p_sys->window, p_sys->gc, img, 0, 0, 0);
587 xcb_flush (p_sys->conn);
591 * Process incoming X events.
593 static int Manage (vout_thread_t *vout)
595 vout_sys_t *p_sys = vout->p_sys;
596 xcb_generic_event_t *ev;
598 while ((ev = xcb_poll_for_event (p_sys->conn)) != NULL)
599 ProcessEvent (vout, p_sys->conn, p_sys->window, ev);
601 if (xcb_connection_has_error (p_sys->conn))
603 msg_Err (vout, "X server failure");