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 */
90 static int Init (vout_thread_t *);
91 static void Deinit (vout_thread_t *);
92 static void Render (vout_thread_t *, picture_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);
140 /* Get the preferred screen */
141 xcb_screen_t *scr = xcb_aux_get_screen (p_sys->conn, snum);
143 assert (p_sys->screen);
144 msg_Dbg (vout, "using screen %d (depth %"PRIu8")", snum, scr->root_depth);
146 /* Determine the visual (color depth and palette) */
147 xcb_visualtype_t *vt = NULL;
150 if ((vt = xcb_aux_find_visual_by_attrs (scr, XCB_VISUAL_CLASS_TRUE_COLOR,
151 scr->root_depth)) != NULL)
152 msg_Dbg (vout, "using TrueColor visual ID %d", (int)vt->visual_id);
155 if ((vt = xcb_aux_find_visual_by_attrs (scr, XCB_VISUAL_CLASS_STATIC_COLOR,
156 scr->root_depth)) != NULL)
157 msg_Dbg (vout, "using static color visual ID %d", (int)vt->visual_id);
160 if ((scr->root_depth == 8)
161 && (vt = xcb_aux_find_visual_by_attrs (scr, XCB_VISUAL_CLASS_STATIC_GRAY,
162 scr->root_depth)) != NULL)
164 msg_Dbg (vout, "using static gray visual ID %d", (int)vt->visual_id);
169 msg_Err (vout, "no supported visual class");
172 p_sys->vid = vt->visual_id;
174 /* Determine our input format (normally, done in Init() but X11
175 * never changes its format) */
176 vout->output.i_chroma = 0;
177 for (const xcb_format_t *fmt = xcb_setup_pixmap_formats (setup),
178 *end = fmt + xcb_setup_pixmap_formats_length (setup);
181 if (fmt->depth != scr->root_depth)
187 if (fmt->bits_per_pixel == 32)
188 vout->output.i_chroma = VLC_FOURCC ('R', 'V', '3', '2');
189 else if (fmt->bits_per_pixel == 24)
190 vout->output.i_chroma = VLC_FOURCC ('R', 'V', '2', '4');
195 if (fmt->bits_per_pixel != 16)
197 vout->output.i_chroma = VLC_FOURCC ('R', 'V', '1', '6');
200 if (fmt->bits_per_pixel != 16)
202 vout->output.i_chroma = VLC_FOURCC ('R', 'V', '1', '5');
205 if (fmt->bits_per_pixel != 8)
207 vout->output.i_chroma = gray ? VLC_FOURCC ('G', 'R', 'E', 'Y')
208 : VLC_FOURCC ('R', 'G', 'B', '2');
211 if ((fmt->bits_per_pixel << 4) % fmt->scanline_pad)
212 continue; /* VLC pads lines to 16 pixels internally */
213 p_sys->bpp = fmt->bits_per_pixel;
214 p_sys->pad = fmt->scanline_pad;
215 msg_Dbg (vout, "using %"PRIu8" bits per pixels (line pad: %"PRIu8")",
216 p_sys->bpp, p_sys->pad);
220 if (!vout->output.i_chroma)
222 msg_Err (vout, "no supported pixmap formats");
226 vout->fmt_out.i_chroma = vout->output.i_chroma;
229 vout->output.i_rmask = vt->red_mask;
230 vout->output.i_gmask = vt->green_mask;
231 vout->output.i_bmask = vt->blue_mask;
234 /* Create colormap (needed to select non-default visual) */
235 p_sys->cmap = xcb_generate_id (p_sys->conn);
236 xcb_create_colormap (p_sys->conn, XCB_COLORMAP_ALLOC_NONE,
237 p_sys->cmap, scr->root, p_sys->vid);
239 /* Check shared memory support */
240 p_sys->shm = var_CreateGetBool (vout, "x11-shm") > 0;
243 xcb_shm_query_version_cookie_t ck;
244 xcb_shm_query_version_reply_t *r;
245 xcb_generic_error_t *err;
247 ck = xcb_shm_query_version (p_sys->conn);
248 r = xcb_shm_query_version_reply (p_sys->conn, ck, &err);
251 msg_Err (vout, "shared memory (MIT-SHM) not available");
252 msg_Warn (vout, "display will be slow");
258 /* FIXME: WTH to put as initial width/height values??? */
259 p_sys->embed = vout_RequestXWindow (vout, &(int){ 0 }, &(int){ 0 },
260 &(unsigned){ 0 }, &(unsigned){ 0 });
261 if (p_sys->embed == NULL)
263 msg_Err (vout, "parent window not available");
267 vout->pf_init = Init;
268 vout->pf_end = Deinit;
269 vout->pf_render = Render;
270 vout->pf_display = Display;
271 vout->pf_manage = Manage;
281 * Disconnect from the X server.
283 static void Close (vlc_object_t *obj)
285 vout_thread_t *vout = (vout_thread_t *)obj;
286 vout_sys_t *p_sys = vout->p_sys;
289 vout_ReleaseWindow (p_sys->embed);
290 /* colormap is garbage-ollected by X (?) */
292 xcb_disconnect (p_sys->conn);
298 xcb_connection_t *conn; /* Shared connection to X server */
299 xcb_image_t *image; /* Picture buffer */
300 xcb_image_t *native; /* Rendered picture buffer (in X server format) */
301 xcb_shm_seg_t segment; /* Shared memory segment X ID */
304 #define SHM_ERR ((void *)(intptr_t)(-1))
306 static int PictureInit (vout_thread_t *vout, picture_t *pic)
308 vout_sys_t *p_sys = vout->p_sys;
309 picture_sys_t *priv = malloc (sizeof (*p_sys));
314 assert (pic->i_status == FREE_PICTURE);
315 vout_InitPicture (vout, pic, vout->output.i_chroma,
316 vout->output.i_width, vout->output.i_height,
317 vout->output.i_aspect);
320 const size_t size = pic->p->i_pitch * pic->p->i_lines;
323 { /* Allocate shared memory segment */
324 int id = shmget (IPC_PRIVATE, size, IPC_CREAT | 0700);
328 msg_Err (vout, "shared memory allocation error: %m");
332 /* Attach the segment to VLC */
333 shm = shmat (id, NULL, 0 /* read/write */);
336 msg_Err (vout, "shared memory attachment error: %m");
337 shmctl (id, IPC_RMID, 0);
341 /* Attach the segment to X */
342 xcb_void_cookie_t ck;
344 priv->segment = xcb_generate_id (p_sys->conn);
345 ck = xcb_shm_attach_checked (p_sys->conn, priv->segment, id, 1);
346 shmctl (id, IPC_RMID, 0);
348 if (CheckError (vout, "shared memory server-side error", ck))
350 msg_Info (vout, "using buggy X (remote) server? SSH?");
358 const unsigned real_width = pic->p->i_pitch / (p_sys->bpp >> 3);
359 /* FIXME: anyway to getthing more intuitive than that?? */
362 img = xcb_image_create (real_width, pic->p->i_lines,
363 XCB_IMAGE_FORMAT_Z_PIXMAP, p_sys->pad,
364 p_sys->screen->root_depth, p_sys->bpp, p_sys->bpp,
365 #ifdef WORDS_BIGENDIAN
366 XCB_IMAGE_ORDER_MSB_FIRST,
368 XCB_IMAGE_ORDER_LSB_FIRST,
370 XCB_IMAGE_ORDER_MSB_FIRST,
372 (shm != SHM_ERR) ? size : 0,
373 (shm != SHM_ERR) ? shm : NULL);
378 xcb_shm_detach (p_sys->conn, priv->segment);
381 if (shm != SHM_ERR && xcb_image_native (p_sys->conn, img, 0) == NULL)
382 msg_Warn (vout, "incompatible X server image format");
384 priv->conn = p_sys->conn;
388 pic->p->p_pixels = img->data;
389 pic->i_status = DESTROYED_PICTURE;
390 pic->i_type = DIRECT_PICTURE;
402 * Release picture private data
404 static void PictureDeinit (picture_t *pic)
406 struct picture_sys_t *p_sys = pic->p_sys;
408 if (p_sys->segment != 0)
410 xcb_shm_detach (p_sys->conn, p_sys->segment);
411 shmdt (p_sys->image->data);
413 if ((p_sys->native != NULL) && (p_sys->native != p_sys->image))
414 xcb_image_destroy (p_sys->native);
415 xcb_image_destroy (p_sys->image);
420 * Allocate drawable window and picture buffers.
422 static int Init (vout_thread_t *vout)
424 vout_sys_t *p_sys = vout->p_sys;
425 const xcb_screen_t *screen = p_sys->screen;
426 unsigned x, y, width, height;
428 I_OUTPUTPICTURES = 0;
430 /* Determine parent window and size */
431 if (vout->b_fullscreen)
433 p_sys->parent = screen->root;
434 width = screen->width_in_pixels;
435 height = screen->height_in_pixels;
439 p_sys->parent = p_sys->embed->handle.xid;
441 /* Subscribe to parent window resize events */
442 const uint32_t value = XCB_EVENT_MASK_STRUCTURE_NOTIFY;
443 xcb_change_window_attributes (p_sys->conn, p_sys->parent,
444 XCB_CW_EVENT_MASK, &value);
446 xcb_get_geometry_cookie_t ck;
447 ck = xcb_get_geometry (p_sys->conn, p_sys->parent);
449 xcb_get_geometry_reply_t *geo;
450 xcb_generic_error_t *err;
451 geo = xcb_get_geometry_reply (p_sys->conn, ck, &err);
453 height = geo->height;
457 vout_PlacePicture (vout, width, height, &x, &y, &width, &height);
459 /* FIXME: I don't get the subtlety between output and fmt_out here */
460 vout->fmt_out.i_visible_width = width;
461 vout->fmt_out.i_visible_height = height;
462 vout->fmt_out.i_sar_num = vout->fmt_out.i_sar_den = 1;
464 vout->output.i_width = vout->fmt_out.i_width =
465 width * vout->fmt_in.i_width / vout->fmt_in.i_visible_width;
466 vout->output.i_height = vout->fmt_out.i_height =
467 height * vout->fmt_in.i_height / vout->fmt_in.i_visible_height;
468 vout->fmt_out.i_x_offset =
469 width * vout->fmt_in.i_x_offset / vout->fmt_in.i_visible_width;
470 p_vout->fmt_out.i_y_offset =
471 height * vout->fmt_in.i_y_offset / vout->fmt_in.i_visible_height;
474 vout->output.i_aspect = vout->fmt_out.i_aspect =
475 width * VOUT_ASPECT_FACTOR / height;
478 const uint32_t mask = XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK
480 const uint32_t values[] = {
481 /* XCB_CW_BACK_PIXEL */
483 /* XCB_CW_EVENT_MASK */
484 XCB_EVENT_MASK_BUTTON_PRESS | XCB_EVENT_MASK_BUTTON_RELEASE |
485 XCB_EVENT_MASK_POINTER_MOTION,
486 /* XCB_CW_COLORMAP */
490 xcb_window_t window = xcb_generate_id (p_sys->conn);
492 c = xcb_create_window_checked (p_sys->conn, screen->root_depth, window,
493 p_sys->parent, x, y, width, height, 0,
494 XCB_WINDOW_CLASS_INPUT_OUTPUT,
495 p_sys->vid, mask, values);
496 if (CheckError (vout, "cannot create X11 window", c))
498 p_sys->window = window;
499 msg_Dbg (vout, "using X11 window %08"PRIx32, p_sys->window);
500 xcb_map_window (p_sys->conn, window);
502 /* Create graphic context (I wonder why the heck do we need this) */
503 p_sys->gc = xcb_generate_id (p_sys->conn);
504 xcb_create_gc (p_sys->conn, p_sys->gc, p_sys->window, 0, NULL);
505 msg_Dbg (vout, "using X11 graphic context %08"PRIx32, p_sys->gc);
506 xcb_flush (p_sys->conn);
508 /* Allocate picture buffers */
509 I_OUTPUTPICTURES = 0;
510 for (size_t index = 0; I_OUTPUTPICTURES < 2; index++)
512 picture_t *pic = vout->p_picture + index;
514 if (index > sizeof (vout->p_picture) / sizeof (pic))
516 if (pic->i_status != FREE_PICTURE)
518 if (PictureInit (vout, pic))
520 PP_OUTPUTPICTURE[I_OUTPUTPICTURES++] = pic;
531 * Free picture buffers.
533 static void Deinit (vout_thread_t *vout)
535 vout_sys_t *p_sys = vout->p_sys;
537 for (int i = 0; i < I_OUTPUTPICTURES; i++)
538 PictureDeinit (PP_OUTPUTPICTURE[i]);
540 xcb_unmap_window (p_sys->conn, p_sys->window);
541 xcb_destroy_window (p_sys->conn, p_sys->window);
545 * Prepares an image ahead of display.
547 static void Render (vout_thread_t *vout, picture_t *pic)
549 vout_sys_t *p_sys = vout->p_sys;
550 picture_sys_t *priv = pic->p_sys;
552 if ((priv->native != NULL) && (priv->native != priv->image))
553 xcb_image_destroy (priv->native);
554 priv->native = xcb_image_native (p_sys->conn, priv->image, 1);
559 * Sends an image to the X server.
561 static void Display (vout_thread_t *vout, picture_t *pic)
563 vout_sys_t *p_sys = vout->p_sys;
564 picture_sys_t *priv = pic->p_sys;
565 xcb_image_t *img = priv->image, *native = priv->native;
567 if ((native == img) && (img->base == NULL))
569 xcb_shm_segment_info_t info = {
570 .shmseg = priv->segment,
571 .shmid = -1, /* lost track of it, unimportant */
572 .shmaddr = img->data,
575 xcb_image_shm_put (p_sys->conn, p_sys->window, p_sys->gc, img, info,
576 0, 0, 0, 0, img->width, img->height, 0);
580 xcb_image_put (p_sys->conn, p_sys->window, p_sys->gc, native, 0, 0, 0);
581 xcb_flush (p_sys->conn);
585 * Process incoming X events.
587 static int Manage (vout_thread_t *vout)
589 vout_sys_t *p_sys = vout->p_sys;
590 xcb_generic_event_t *ev;
592 while ((ev = xcb_poll_for_event (p_sys->conn)) != NULL)
593 ProcessEvent (vout, p_sys->conn, p_sys->window, ev);
595 if (xcb_connection_has_error (p_sys->conn))
597 msg_Err (vout, "X server failure");