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 */
89 static int Init (vout_thread_t *);
90 static void Deinit (vout_thread_t *);
91 static void Render (vout_thread_t *, picture_t *);
92 static void Display (vout_thread_t *, picture_t *);
93 static int Manage (vout_thread_t *);
95 int CheckError (vout_thread_t *vout, const char *str, xcb_void_cookie_t ck)
97 xcb_generic_error_t *err;
99 err = xcb_request_check (vout->p_sys->conn, ck);
102 msg_Err (vout, "%s: X11 error %d", str, err->error_code);
111 * Probe the X server.
113 static int Open (vlc_object_t *obj)
115 vout_thread_t *vout = (vout_thread_t *)obj;
116 vout_sys_t *p_sys = malloc (sizeof (*p_sys));
127 char *display = var_CreateGetNonEmptyString (vout, "x11-display");
129 p_sys->conn = xcb_connect (display, &snum);
130 if (xcb_connection_has_error (p_sys->conn) /*== NULL*/)
132 msg_Err (vout, "cannot connect to X server %s",
133 display ? display : "");
139 /* Get the preferred screen */
140 xcb_screen_t *scr = xcb_aux_get_screen (p_sys->conn, snum);
142 assert (p_sys->screen);
143 msg_Dbg (vout, "using screen %d (depth %"PRIu8")", snum, scr->root_depth);
145 /* Determine the visual (color depth and palette) */
146 xcb_visualtype_t *vt = NULL;
149 if ((vt = xcb_aux_find_visual_by_attrs (scr, XCB_VISUAL_CLASS_TRUE_COLOR,
150 scr->root_depth)) != NULL)
151 msg_Dbg (vout, "using TrueColor visual ID %d", (int)vt->visual_id);
154 if ((vt = xcb_aux_find_visual_by_attrs (scr, XCB_VISUAL_CLASS_STATIC_COLOR,
155 scr->root_depth)) != NULL)
156 msg_Dbg (vout, "using static color visual ID %d", (int)vt->visual_id);
159 if ((scr->root_depth == 8)
160 && (vt = xcb_aux_find_visual_by_attrs (scr, XCB_VISUAL_CLASS_STATIC_GRAY,
161 scr->root_depth)) != NULL)
163 msg_Dbg (vout, "using static gray visual ID %d", (int)vt->visual_id);
168 vt = xcb_aux_find_visual_by_id (scr, scr->root_visual);
170 msg_Err (vout, "unsupported visual class %"PRIu8, vt->_class);
173 p_sys->vid = vt->visual_id;
175 /* Determine our input format (normally, done in Init() but X11
176 * never changes its format) */
177 p_sys->bpp = scr->root_depth;
178 switch (scr->root_depth)
182 case 32: /* FIXME: untested */
183 vout->output.i_chroma = VLC_FOURCC ('R', 'V', '3', '2');
187 vout->output.i_chroma = VLC_FOURCC ('R', 'V', '1', '6');
192 vout->output.i_chroma = VLC_FOURCC ('R', 'V', '1', '5');
195 case 8: /* FIXME: VLC cannot convert */
196 vout->output.i_chroma = gray ? VLC_FOURCC ('G', 'R', 'E', 'Y')
197 : VLC_FOURCC ('R', 'G', 'B', '2');
201 msg_Err (vout, "unsupported %"PRIu8"-bits screen depth",
205 vout->fmt_out.i_chroma = vout->output.i_chroma;
208 vout->output.i_rmask = vt->red_mask;
209 vout->output.i_gmask = vt->green_mask;
210 vout->output.i_bmask = vt->blue_mask;
213 /* Create colormap (needed to select non-default visual) */
214 p_sys->cmap = xcb_generate_id (p_sys->conn);
215 xcb_create_colormap (p_sys->conn, XCB_COLORMAP_ALLOC_NONE,
216 p_sys->cmap, scr->root, p_sys->vid);
218 /* Check shared memory support */
219 p_sys->shm = var_CreateGetBool (vout, "x11-shm") > 0;
222 xcb_shm_query_version_cookie_t ck;
223 xcb_shm_query_version_reply_t *r;
224 xcb_generic_error_t *err;
226 ck = xcb_shm_query_version (p_sys->conn);
227 r = xcb_shm_query_version_reply (p_sys->conn, ck, &err);
230 msg_Err (vout, "shared memory (MIT-SHM) not available");
231 msg_Warn (vout, "display will be slow");
236 vout->pf_init = Init;
237 vout->pf_end = Deinit;
238 vout->pf_render = Render;
239 vout->pf_display = Display;
240 vout->pf_manage = Manage;
250 * Disconnect from the X server.
252 static void Close (vlc_object_t *obj)
254 vout_thread_t *vout = (vout_thread_t *)obj;
255 vout_sys_t *p_sys = vout->p_sys;
257 assert (p_sys->embed == NULL);
258 /* colormap is garbage-ollected by X (?) */
260 xcb_disconnect (p_sys->conn);
266 xcb_connection_t *conn; /* Shared connection to X server */
267 xcb_image_t *image; /* Picture buffer */
268 xcb_image_t *native; /* Rendered picture buffer (in X server format) */
269 xcb_shm_seg_t segment; /* Shared memory segment X ID */
272 static void PictureRelease (picture_t *pic);
273 static void PictureShmRelease (picture_t *pic);
274 #define SHM_ERR ((void *)(intptr_t)(-1))
276 static int PictureInit (vout_thread_t *vout, picture_t *pic)
278 vout_sys_t *p_sys = vout->p_sys;
279 picture_sys_t *priv = malloc (sizeof (*p_sys));
284 assert (pic->i_status == FREE_PICTURE);
285 vout_InitPicture (vout, pic, vout->output.i_chroma,
286 vout->output.i_width, vout->output.i_height,
287 vout->output.i_aspect);
290 const size_t size = pic->p->i_pitch * pic->p->i_lines;
293 { /* Allocate shared memory segment */
294 int id = shmget (IPC_PRIVATE, size, IPC_CREAT | 0700);
298 msg_Err (vout, "shared memory allocation error: %m");
302 /* Attach the segment to VLC */
303 shm = shmat (id, NULL, 0 /* read/write */);
306 msg_Err (vout, "shared memory attachment error: %m");
307 shmctl (id, IPC_RMID, 0);
311 /* Attach the segment to X */
312 xcb_void_cookie_t ck;
314 priv->segment = xcb_generate_id (p_sys->conn);
315 ck = xcb_shm_attach_checked (p_sys->conn, priv->segment, id, 1);
316 shmctl (id, IPC_RMID, 0);
318 if (CheckError (vout, "shared memory server-side error", ck))
320 msg_Info (vout, "using buggy X (remote) server? SSH?");
326 const unsigned real_width = pic->p->i_pitch / (p_sys->bpp >> 3);
327 /* FIXME: anyway to getthing more intuitive than that?? */
329 /* NOTE: 32-bits scanline_pad assumed, FIXME? (see xdpyinfo) */
331 img = xcb_image_create (real_width, pic->p->i_lines,
332 XCB_IMAGE_FORMAT_Z_PIXMAP, 32,
333 p_sys->screen->root_depth, p_sys->bpp, p_sys->bpp,
334 #ifdef WORDS_BIGENDIAN
335 XCB_IMAGE_ORDER_MSB_FIRST,
337 XCB_IMAGE_ORDER_LSB_FIRST,
339 XCB_IMAGE_ORDER_MSB_FIRST,
341 (shm != SHM_ERR) ? size : 0,
342 (shm != SHM_ERR) ? shm : NULL);
347 xcb_shm_detach (p_sys->conn, priv->segment);
350 if (shm != SHM_ERR && xcb_image_native (p_sys->conn, img, 0) == NULL)
351 msg_Warn (vout, "incompatible X server image format");
353 priv->conn = p_sys->conn;
357 pic->p->p_pixels = img->data;
358 pic->pf_release = (shm != SHM_ERR) ? PictureShmRelease
360 pic->i_status = DESTROYED_PICTURE;
361 pic->i_type = DIRECT_PICTURE;
373 * Release picture private data
375 static void PictureRelease (picture_t *pic)
377 struct picture_sys_t *p_sys = pic->p_sys;
379 if ((p_sys->native != NULL) && (p_sys->native != p_sys->image))
380 xcb_image_destroy (p_sys->native);
381 xcb_image_destroy (p_sys->image);
386 * Release shared memory picture private data
388 static void PictureShmRelease (picture_t *pic)
390 struct picture_sys_t *p_sys = pic->p_sys;
392 xcb_shm_detach (p_sys->conn, p_sys->segment);
393 shmdt (p_sys->image->data);
394 PictureRelease (pic);
398 * Allocate drawable window and picture buffers.
400 static int Init (vout_thread_t *vout)
402 vout_sys_t *p_sys = vout->p_sys;
403 const xcb_screen_t *screen = p_sys->screen;
404 unsigned x, y, width, height;
406 /* Determine parent window */
407 if (vout->b_fullscreen)
410 p_sys->parent = screen->root;
411 width = screen->width_in_pixels;
412 height = screen->height_in_pixels;
416 p_sys->embed = vout_RequestXWindow (vout, &(int){ 0 }, &(int){ 0 },
418 if (p_sys->embed == NULL)
420 msg_Err (vout, "cannot get window");
423 p_sys->parent = p_sys->embed->handle.xid;
426 vout_PlacePicture (vout, width, height, &x, &y, &width, &height);
428 /* FIXME: I don't get the subtlety between output and fmt_out here */
429 vout->fmt_out.i_visible_width = width;
430 vout->fmt_out.i_visible_height = height;
431 vout->fmt_out.i_sar_num = vout->fmt_out.i_sar_den = 1;
433 vout->output.i_width = vout->fmt_out.i_width =
434 width * vout->fmt_in.i_width / vout->fmt_in.i_visible_width;
435 vout->output.i_height = vout->fmt_out.i_height =
436 height * vout->fmt_in.i_height / vout->fmt_in.i_visible_height;
437 vout->fmt_out.i_x_offset =
438 width * vout->fmt_in.i_x_offset / vout->fmt_in.i_visible_width;
439 p_vout->fmt_out.i_y_offset =
440 height * vout->fmt_in.i_y_offset / vout->fmt_in.i_visible_height;
443 vout->output.i_aspect = vout->fmt_out.i_aspect =
444 width * VOUT_ASPECT_FACTOR / height;
447 const uint32_t mask = XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK
449 uint32_t values[] = {
450 /* XCB_CW_BACK_PIXEL */
452 /* XCB_CW_EVENT_MASK */
453 XCB_EVENT_MASK_BUTTON_PRESS | XCB_EVENT_MASK_BUTTON_RELEASE |
454 XCB_EVENT_MASK_POINTER_MOTION,
455 /* XCB_CW_COLORMAP */
459 xcb_window_t window = xcb_generate_id (p_sys->conn);
461 c = xcb_create_window_checked (p_sys->conn, screen->root_depth, window,
462 p_sys->parent, x, y, width, height, 0,
463 XCB_WINDOW_CLASS_INPUT_OUTPUT,
464 p_sys->vid, mask, values);
465 if (CheckError (vout, "cannot create X11 window", c))
467 p_sys->window = window;
468 msg_Dbg (vout, "using X11 window %08"PRIx32, p_sys->window);
469 xcb_map_window (p_sys->conn, window);
471 /* Create graphic context (I wonder why the heck do we need this) */
472 p_sys->gc = xcb_generate_id (p_sys->conn);
473 xcb_create_gc (p_sys->conn, p_sys->gc, p_sys->window, 0, NULL);
474 msg_Dbg (vout, "using X11 graphic context %08"PRIx32, p_sys->gc);
475 xcb_flush (p_sys->conn);
477 /* Allocate picture buffers */
480 picture_t *pic = vout->p_picture + I_OUTPUTPICTURES;
482 if (PictureInit (vout, pic))
484 PP_OUTPUTPICTURE[I_OUTPUTPICTURES++] = pic;
486 while (I_OUTPUTPICTURES < 2);
496 * Free picture buffers.
498 static void Deinit (vout_thread_t *vout)
500 vout_sys_t *p_sys = vout->p_sys;
502 while (I_OUTPUTPICTURES > 0)
503 picture_Release (PP_OUTPUTPICTURE[--I_OUTPUTPICTURES]);
505 xcb_unmap_window (p_sys->conn, p_sys->window);
506 xcb_destroy_window (p_sys->conn, p_sys->window);
507 vout_ReleaseWindow (p_sys->embed);
512 * Prepares an image ahead of display.
514 static void Render (vout_thread_t *vout, picture_t *pic)
516 vout_sys_t *p_sys = vout->p_sys;
517 picture_sys_t *priv = pic->p_sys;
519 if ((priv->native != NULL) && (priv->native != priv->image))
520 xcb_image_destroy (priv->native);
521 priv->native = xcb_image_native (p_sys->conn, priv->image, 1);
526 * Sends an image to the X server.
528 static void Display (vout_thread_t *vout, picture_t *pic)
530 vout_sys_t *p_sys = vout->p_sys;
531 picture_sys_t *priv = pic->p_sys;
532 xcb_image_t *img = priv->image, *native = priv->native;
534 if ((native == img) && (img->base == NULL))
536 xcb_shm_segment_info_t info = {
537 .shmseg = priv->segment,
538 .shmid = -1, /* lost track of it, unimportant */
539 .shmaddr = img->data,
542 xcb_image_shm_put (p_sys->conn, p_sys->window, p_sys->gc, img, info,
543 0, 0, 0, 0, img->width, img->height, 0);
547 xcb_image_put (p_sys->conn, p_sys->window, p_sys->gc, native, 0, 0, 0);
548 xcb_flush (p_sys->conn);
552 * Process incoming X events.
554 static int Manage (vout_thread_t *vout)
556 vout_sys_t *p_sys = vout->p_sys;
557 xcb_generic_event_t *ev;
559 while ((ev = xcb_poll_for_event (p_sys->conn)) != NULL)
560 ProcessEvent (vout, ev);
562 if (xcb_connection_has_error (p_sys->conn))
564 msg_Err (vout, "X server failure");