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 ****************************************************************************/
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_vout_display.h>
36 #include <vlc_picture_pool.h>
40 #define SHM_TEXT N_("Use shared memory")
41 #define SHM_LONGTEXT N_( \
42 "Use shared memory to communicate between VLC and the X server.")
44 static int Open (vlc_object_t *);
45 static void Close (vlc_object_t *);
51 set_shortname (N_("X11"))
52 set_description (N_("X11 video output (XCB)"))
53 set_category (CAT_VIDEO)
54 set_subcategory (SUBCAT_VIDEO_VOUT)
55 set_capability ("vout display", 75)
56 set_callbacks (Open, Close)
57 add_shortcut ("xcb-x11")
60 add_bool ("x11-shm", true, NULL, SHM_TEXT, SHM_LONGTEXT, true)
63 /* It must be large enough to absorb the server display jitter but it is
64 * useless to used a too large value, direct rendering cannot be used with
67 #define MAX_PICTURES (3)
69 struct vout_display_sys_t
71 xcb_connection_t *conn;
72 vout_window_t *embed; /* VLC window (when windowed) */
74 xcb_cursor_t cursor; /* blank cursor */
75 xcb_window_t window; /* drawable X window */
76 xcb_gcontext_t gc; /* context to put images */
77 bool shm; /* whether to use MIT-SHM */
78 bool visible; /* whether to draw */
79 uint8_t bpp; /* bits per pixel */
80 uint8_t pad; /* scanline pad */
81 uint8_t depth; /* useful bits per pixel */
82 uint8_t byte_order; /* server byte order */
84 picture_pool_t *pool; /* picture pool */
85 picture_resource_t resource[MAX_PICTURES];
88 static picture_pool_t *Pool (vout_display_t *, unsigned);
89 static void Display (vout_display_t *, picture_t *);
90 static int Control (vout_display_t *, int, va_list);
91 static void Manage (vout_display_t *);
93 static void ResetPictures (vout_display_t *);
98 static int Open (vlc_object_t *obj)
100 vout_display_t *vd = (vout_display_t *)obj;
101 vout_display_sys_t *p_sys = malloc (sizeof (*p_sys));
108 /* Get window, connect to X server */
109 const xcb_screen_t *scr;
110 p_sys->embed = GetWindow (vd, &p_sys->conn, &scr, &p_sys->depth);
111 if (p_sys->embed == NULL)
117 const xcb_setup_t *setup = xcb_get_setup (p_sys->conn);
118 p_sys->byte_order = setup->image_byte_order;
121 video_format_t fmt_pic = vd->fmt;
123 /* Check that the selected screen supports this depth */
124 xcb_depth_t *d = NULL;
125 for (xcb_depth_iterator_t it = xcb_screen_allowed_depths_iterator (scr);
126 it.rem > 0 && d == NULL;
127 xcb_depth_next (&it))
128 if (it.data->depth == p_sys->depth)
132 msg_Err (obj, "unexpected color depth msimatch");
133 goto error; /* WTH? depth not supported on screen */
136 /* Find a visual type for the selected depth */
137 xcb_visualid_t vid = 0;
139 const xcb_visualtype_t *vt = xcb_depth_visuals (d);
140 for (int i = xcb_depth_visuals_length (d); i > 0; i--)
142 if (vt->_class == XCB_VISUAL_CLASS_TRUE_COLOR)
145 fmt_pic.i_rmask = vt->red_mask;
146 fmt_pic.i_gmask = vt->green_mask;
147 fmt_pic.i_bmask = vt->blue_mask;
151 if (p_sys->depth == 8 && vt->_class == XCB_VISUAL_CLASS_STATIC_GRAY
160 msg_Err (obj, "unexpected visual type mismatch");
163 msg_Dbg (vd, "using X11 visual ID 0x%"PRIx32" (depth: %"PRIu8")", vid,
166 /* Determine our pixel format */
168 for (const xcb_format_t *fmt = xcb_setup_pixmap_formats (setup),
169 *end = fmt + xcb_setup_pixmap_formats_length (setup);
170 fmt < end && !p_sys->bpp; fmt++)
172 if (fmt->depth != p_sys->depth)
173 continue; /* Wrong depth! */
175 /* Check that the pixmap format is supported by VLC. */
179 if (fmt->bits_per_pixel != 32)
181 #ifdef FIXED_VLC_RGBA_MASK
182 fmt_pic.i_chroma = VLC_CODEC_RGBA;
185 msg_Dbg (vd, "X11 visual with alpha-channel not supported");
189 if (fmt->bits_per_pixel == 32)
190 fmt_pic.i_chroma = VLC_CODEC_RGB32;
191 else if (fmt->bits_per_pixel == 24)
192 fmt_pic.i_chroma = VLC_CODEC_RGB24;
197 if (fmt->bits_per_pixel != 16)
199 fmt_pic.i_chroma = VLC_CODEC_RGB16;
202 if (fmt->bits_per_pixel != 16)
204 fmt_pic.i_chroma = VLC_CODEC_RGB15;
207 if (fmt->bits_per_pixel != 8)
209 fmt_pic.i_chroma = gray ? VLC_CODEC_GREY : VLC_CODEC_RGB8;
214 if ((fmt->bits_per_pixel << 4) % fmt->scanline_pad)
215 continue; /* VLC pads lines to 16 pixels internally */
217 /* Byte sex is a non-issue for 8-bits. It can be worked around with
218 * RGB masks for 24-bits. Too bad for 15-bits and 16-bits. */
219 if (fmt->bits_per_pixel == 16 && setup->image_byte_order != ORDER)
222 p_sys->bpp = fmt->bits_per_pixel;
223 p_sys->pad = fmt->scanline_pad;
224 msg_Dbg (vd, " %"PRIu8" bits per pixels, %"PRIu8" bits line pad",
225 p_sys->bpp, p_sys->pad);
230 msg_Err (vd, "no supported pixmap formats");
234 /* Create colormap (needed to select non-default visual) */
236 if (vid != scr->root_visual)
238 cmap = xcb_generate_id (p_sys->conn);
239 xcb_create_colormap (p_sys->conn, XCB_COLORMAP_ALLOC_NONE,
240 cmap, scr->root, vid);
243 cmap = scr->default_colormap;
246 unsigned width, height;
247 if (GetWindowSize (p_sys->embed, p_sys->conn, &width, &height))
250 p_sys->window = xcb_generate_id (p_sys->conn);
251 p_sys->gc = xcb_generate_id (p_sys->conn);
253 const uint32_t mask = XCB_CW_EVENT_MASK | XCB_CW_COLORMAP;
254 const uint32_t values[] = {
255 /* XCB_CW_EVENT_MASK */
256 XCB_EVENT_MASK_VISIBILITY_CHANGE,
257 /* XCB_CW_COLORMAP */
262 c = xcb_create_window_checked (p_sys->conn, p_sys->depth,
264 p_sys->embed->handle.xid, 0, 0,
266 XCB_WINDOW_CLASS_INPUT_OUTPUT,
268 xcb_map_window (p_sys->conn, p_sys->window);
269 /* Create graphic context (I wonder why the heck do we need this) */
270 xcb_create_gc (p_sys->conn, p_sys->gc, p_sys->window, 0, NULL);
272 if (CheckError (vd, p_sys->conn, "cannot create X11 window", c))
275 msg_Dbg (vd, "using X11 window %08"PRIx32, p_sys->window);
276 msg_Dbg (vd, "using X11 graphic context %08"PRIx32, p_sys->gc);
277 p_sys->cursor = CreateBlankCursor (p_sys->conn, scr);
279 p_sys->visible = false;
281 CheckSHM (obj, p_sys->conn, &p_sys->shm);
284 vout_display_info_t info = vd->info;
285 info.has_pictures_invalid = true;
286 info.has_event_thread = true;
288 /* Setup vout_display_t once everything is fine */
294 vd->display = Display;
295 vd->control = Control;
299 bool is_fullscreen = vd->cfg->is_fullscreen;
300 if (is_fullscreen && vout_window_SetFullScreen (p_sys->embed, true))
301 is_fullscreen = false;
302 vout_display_SendEventFullscreen (vd, is_fullscreen);
303 vout_display_SendEventDisplaySize (vd, width, height, is_fullscreen);
314 * Disconnect from the X server.
316 static void Close (vlc_object_t *obj)
318 vout_display_t *vd = (vout_display_t *)obj;
319 vout_display_sys_t *p_sys = vd->sys;
323 /* show the default cursor */
324 xcb_change_window_attributes (p_sys->conn, p_sys->embed->handle.xid, XCB_CW_CURSOR,
325 &(uint32_t) { XCB_CURSOR_NONE });
326 xcb_flush (p_sys->conn);
328 /* colormap, window and context are garbage-collected by X */
329 xcb_disconnect (p_sys->conn);
330 vout_display_DeleteWindow (vd, p_sys->embed);
335 * Return a direct buffer
337 static picture_pool_t *Pool (vout_display_t *vd, unsigned requested_count)
339 vout_display_sys_t *p_sys = vd->sys;
340 (void)requested_count;
344 vout_display_place_t place;
346 vout_display_PlacePicture (&place, &vd->source, vd->cfg, false);
349 const uint32_t values[] = { place.x, place.y, place.width, place.height };
350 xcb_configure_window (p_sys->conn, p_sys->window,
351 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
352 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
355 picture_t *pic = picture_NewFromFormat (&vd->fmt);
359 assert (pic->i_planes == 1);
360 memset (p_sys->resource, 0, sizeof(p_sys->resource));
363 picture_t *pic_array[MAX_PICTURES];
364 for (count = 0; count < MAX_PICTURES; count++)
366 picture_resource_t *res = &p_sys->resource[count];
368 res->p->i_lines = pic->p->i_lines;
369 res->p->i_pitch = pic->p->i_pitch;
370 if (PictureResourceAlloc (vd, res, res->p->i_pitch * res->p->i_lines,
371 p_sys->conn, p_sys->shm))
373 pic_array[count] = picture_NewFromResource (&vd->fmt, res);
374 if (!pic_array[count])
376 PictureResourceFree (res, p_sys->conn);
377 memset (res, 0, sizeof(*res));
381 picture_Release (pic);
386 p_sys->pool = picture_pool_New (count, pic_array);
387 /* TODO release picture resources if NULL */
388 xcb_flush (p_sys->conn);
395 * Sends an image to the X server.
397 static void Display (vout_display_t *vd, picture_t *pic)
399 vout_display_sys_t *p_sys = vd->sys;
400 xcb_shm_seg_t segment = pic->p_sys->segment;
401 xcb_void_cookie_t ck;
406 ck = xcb_shm_put_image_checked (p_sys->conn, p_sys->window, p_sys->gc,
407 /* real width */ pic->p->i_pitch / pic->p->i_pixel_pitch,
408 /* real height */ pic->p->i_lines,
409 /* x */ vd->fmt.i_x_offset,
410 /* y */ vd->fmt.i_y_offset,
411 /* width */ vd->fmt.i_visible_width,
412 /* height */ vd->fmt.i_visible_height,
413 0, 0, p_sys->depth, XCB_IMAGE_FORMAT_Z_PIXMAP,
417 const size_t offset = vd->fmt.i_y_offset * pic->p->i_pitch;
418 const unsigned lines = pic->p->i_lines - vd->fmt.i_y_offset;
420 ck = xcb_put_image_checked (p_sys->conn, XCB_IMAGE_FORMAT_Z_PIXMAP,
421 p_sys->window, p_sys->gc,
422 pic->p->i_pitch / pic->p->i_pixel_pitch,
423 lines, -vd->fmt.i_x_offset, 0, 0, p_sys->depth,
424 pic->p->i_pitch * lines, pic->p->p_pixels + offset);
427 /* Wait for reply. This makes sure that the X server gets CPU time to
428 * display the picture. xcb_flush() is *not* sufficient: especially with
429 * shared memory the PUT requests are so short that many of them can fit in
430 * X11 socket output buffer before the kernel preempts VLC. */
431 xcb_generic_error_t *e = xcb_request_check (p_sys->conn, ck);
434 msg_Dbg (vd, "%s: X11 error %d", "cannot put image", e->error_code);
438 /* FIXME might be WAY better to wait in some case (be carefull with
439 * VOUT_DISPLAY_RESET_PICTURES if done) + does not work with
440 * vout_display wrapper. */
442 picture_Release (pic);
445 static int Control (vout_display_t *vd, int query, va_list ap)
447 vout_display_sys_t *p_sys = vd->sys;
451 case VOUT_DISPLAY_CHANGE_FULLSCREEN:
453 const vout_display_cfg_t *c = va_arg (ap, const vout_display_cfg_t *);
454 return vout_window_SetFullScreen (p_sys->embed, c->is_fullscreen);
457 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
459 const vout_display_cfg_t *p_cfg =
460 (const vout_display_cfg_t*)va_arg (ap, const vout_display_cfg_t *);
461 const bool is_forced = (bool)va_arg (ap, int);
464 && vout_window_SetSize (p_sys->embed,
465 p_cfg->display.width,
466 p_cfg->display.height))
469 vout_display_place_t place;
470 vout_display_PlacePicture (&place, &vd->source, p_cfg, false);
472 if (place.width != vd->fmt.i_visible_width ||
473 place.height != vd->fmt.i_visible_height)
475 vout_display_SendEventPicturesInvalid (vd);
479 /* Move the picture within the window */
480 const uint32_t values[] = { place.x, place.y };
481 xcb_configure_window (p_sys->conn, p_sys->window,
482 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y,
486 case VOUT_DISPLAY_CHANGE_WINDOW_STATE:
488 unsigned state = va_arg (ap, unsigned);
489 return vout_window_SetState (p_sys->embed, state);
492 case VOUT_DISPLAY_CHANGE_ZOOM:
493 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
494 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
495 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
496 /* I am not sure it is always necessary, but it is way simpler ... */
497 vout_display_SendEventPicturesInvalid (vd);
500 case VOUT_DISPLAY_RESET_PICTURES:
504 vout_display_place_t place;
505 vout_display_PlacePicture (&place, &vd->source, vd->cfg, false);
507 vd->fmt.i_width = vd->source.i_width * place.width / vd->source.i_visible_width;
508 vd->fmt.i_height = vd->source.i_height * place.height / vd->source.i_visible_height;
510 vd->fmt.i_visible_width = place.width;
511 vd->fmt.i_visible_height = place.height;
512 vd->fmt.i_x_offset = vd->source.i_x_offset * place.width / vd->source.i_visible_width;
513 vd->fmt.i_y_offset = vd->source.i_y_offset * place.height / vd->source.i_visible_height;
517 /* Hide the mouse. It will be send when
518 * vout_display_t::info.b_hide_mouse is false */
519 case VOUT_DISPLAY_HIDE_MOUSE:
520 xcb_change_window_attributes (p_sys->conn, p_sys->embed->handle.xid,
521 XCB_CW_CURSOR, &(uint32_t){ p_sys->cursor });
525 msg_Err (vd, "Unknown request in XCB vout display");
530 static void Manage (vout_display_t *vd)
532 vout_display_sys_t *p_sys = vd->sys;
534 ManageEvent (vd, p_sys->conn, &p_sys->visible);
537 static void ResetPictures (vout_display_t *vd)
539 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, p_sys->conn);
552 picture_pool_Delete (p_sys->pool);