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)
58 add_bool ("x11-shm", true, NULL, SHM_TEXT, SHM_LONGTEXT, true)
61 /* It must be large enough to absorb the server display jitter but it is
62 * useless to used a too large value, direct rendering cannot be used with
65 #define MAX_PICTURES (3)
67 struct vout_display_sys_t
69 xcb_connection_t *conn;
70 vout_window_t *embed; /* VLC window (when windowed) */
72 xcb_cursor_t cursor; /* blank cursor */
73 xcb_window_t window; /* drawable X window */
74 xcb_gcontext_t gc; /* context to put images */
75 bool shm; /* whether to use MIT-SHM */
76 bool visible; /* whether to draw */
77 uint8_t bpp; /* bits per pixel */
78 uint8_t pad; /* scanline pad */
79 uint8_t depth; /* useful bits per pixel */
80 uint8_t byte_order; /* server byte order */
82 picture_pool_t *pool; /* picture pool */
83 picture_resource_t resource[MAX_PICTURES];
86 static picture_t *Get (vout_display_t *);
87 static void Display (vout_display_t *, picture_t *);
88 static int Control (vout_display_t *, int, va_list);
89 static void Manage (vout_display_t *);
91 static void ResetPictures (vout_display_t *);
96 static int Open (vlc_object_t *obj)
98 vout_display_t *vd = (vout_display_t *)obj;
99 vout_display_sys_t *p_sys = malloc (sizeof (*p_sys));
106 /* Get window, connect to X server */
107 const xcb_screen_t *scr;
108 p_sys->embed = GetWindow (vd, &p_sys->conn, &scr, &p_sys->depth);
109 if (p_sys->embed == NULL)
115 const xcb_setup_t *setup = xcb_get_setup (p_sys->conn);
116 p_sys->byte_order = setup->image_byte_order;
119 video_format_t fmt_pic = vd->fmt;
121 /* Check that the selected screen supports this depth */
122 xcb_depth_t *d = NULL;
123 for (xcb_depth_iterator_t it = xcb_screen_allowed_depths_iterator (scr);
124 it.rem > 0 && d == NULL;
125 xcb_depth_next (&it))
126 if (it.data->depth == p_sys->depth)
130 msg_Err (obj, "unexpected color depth msimatch");
131 goto error; /* WTH? depth not supported on screen */
134 /* Find a visual type for the selected depth */
135 xcb_visualid_t vid = 0;
137 const xcb_visualtype_t *vt = xcb_depth_visuals (d);
138 for (int i = xcb_depth_visuals_length (d); i > 0; i--)
140 if (vt->_class == XCB_VISUAL_CLASS_TRUE_COLOR)
143 fmt_pic.i_rmask = vt->red_mask;
144 fmt_pic.i_gmask = vt->green_mask;
145 fmt_pic.i_bmask = vt->blue_mask;
149 if (p_sys->depth == 8 && vt->_class == XCB_VISUAL_CLASS_STATIC_GRAY
158 msg_Err (obj, "unexpected visual type mismatch");
161 msg_Dbg (vd, "using X11 visual ID 0x%"PRIx32" (depth: %"PRIu8")", vid,
164 /* Determine our pixel format */
166 for (const xcb_format_t *fmt = xcb_setup_pixmap_formats (setup),
167 *end = fmt + xcb_setup_pixmap_formats_length (setup);
168 fmt < end && !p_sys->bpp; fmt++)
170 if (fmt->depth != p_sys->depth)
171 continue; /* Wrong depth! */
173 /* Check that the pixmap format is supported by VLC. */
177 if (fmt->bits_per_pixel != 32)
179 fmt_pic.i_chroma = VLC_CODEC_RGBA;
182 if (fmt->bits_per_pixel == 32)
183 fmt_pic.i_chroma = VLC_CODEC_RGB32;
184 else if (fmt->bits_per_pixel == 24)
185 fmt_pic.i_chroma = VLC_CODEC_RGB24;
190 if (fmt->bits_per_pixel != 16)
192 fmt_pic.i_chroma = VLC_CODEC_RGB16;
195 if (fmt->bits_per_pixel != 16)
197 fmt_pic.i_chroma = VLC_CODEC_RGB15;
200 if (fmt->bits_per_pixel != 8)
202 fmt_pic.i_chroma = gray ? VLC_CODEC_GREY : VLC_CODEC_RGB8;
207 if ((fmt->bits_per_pixel << 4) % fmt->scanline_pad)
208 continue; /* VLC pads lines to 16 pixels internally */
210 /* Byte sex is a non-issue for 8-bits. It can be worked around with
211 * RGB masks for 24-bits. Too bad for 15-bits and 16-bits. */
212 if (fmt->bits_per_pixel == 16 && setup->image_byte_order != ORDER)
215 p_sys->bpp = fmt->bits_per_pixel;
216 p_sys->pad = fmt->scanline_pad;
217 msg_Dbg (vd, " %"PRIu8" bits per pixels, %"PRIu8" bits line pad",
218 p_sys->bpp, p_sys->pad);
223 msg_Err (vd, "no supported pixmap formats");
227 /* Create colormap (needed to select non-default visual) */
229 if (vid != scr->root_visual)
231 cmap = xcb_generate_id (p_sys->conn);
232 xcb_create_colormap (p_sys->conn, XCB_COLORMAP_ALLOC_NONE,
233 cmap, scr->root, vid);
236 cmap = scr->default_colormap;
239 unsigned width, height;
240 if (GetWindowSize (p_sys->embed, p_sys->conn, &width, &height))
243 p_sys->window = xcb_generate_id (p_sys->conn);
244 p_sys->gc = xcb_generate_id (p_sys->conn);
246 const uint32_t mask = XCB_CW_EVENT_MASK | XCB_CW_COLORMAP;
247 const uint32_t values[] = {
248 /* XCB_CW_EVENT_MASK */
249 XCB_EVENT_MASK_VISIBILITY_CHANGE,
250 /* XCB_CW_COLORMAP */
255 c = xcb_create_window_checked (p_sys->conn, p_sys->depth,
257 p_sys->embed->xid, 0, 0,
259 XCB_WINDOW_CLASS_INPUT_OUTPUT,
261 xcb_map_window (p_sys->conn, p_sys->window);
262 /* Create graphic context (I wonder why the heck do we need this) */
263 xcb_create_gc (p_sys->conn, p_sys->gc, p_sys->window, 0, NULL);
265 if (CheckError (vd, p_sys->conn, "cannot create X11 window", c))
268 msg_Dbg (vd, "using X11 window %08"PRIx32, p_sys->window);
269 msg_Dbg (vd, "using X11 graphic context %08"PRIx32, p_sys->gc);
270 p_sys->cursor = CreateBlankCursor (p_sys->conn, scr);
272 p_sys->visible = false;
274 CheckSHM (obj, p_sys->conn, &p_sys->shm);
277 vout_display_info_t info = vd->info;
278 info.has_pictures_invalid = true;
280 /* Setup vout_display_t once everything is fine */
286 vd->display = Display;
287 vd->control = Control;
291 vout_display_SendEventFullscreen (vd, false);
292 vout_display_SendEventDisplaySize (vd, width, height, false);
303 * Disconnect from the X server.
305 static void Close (vlc_object_t *obj)
307 vout_display_t *vd = (vout_display_t *)obj;
308 vout_display_sys_t *p_sys = vd->sys;
311 /* colormap, window and context are garbage-collected by X */
312 xcb_disconnect (p_sys->conn);
313 vout_display_DeleteWindow (vd, p_sys->embed);
318 * Return a direct buffer
320 static picture_t *Get (vout_display_t *vd)
322 vout_display_sys_t *p_sys = vd->sys;
326 vout_display_place_t place;
328 vout_display_PlacePicture (&place, &vd->source, vd->cfg, false);
331 const uint32_t values[] = { place.x, place.y, place.width, place.height };
332 xcb_configure_window (p_sys->conn, p_sys->window,
333 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
334 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
337 picture_t *pic = picture_NewFromFormat (&vd->fmt);
341 assert (pic->i_planes == 1);
342 memset (p_sys->resource, 0, sizeof(p_sys->resource));
345 picture_t *pic_array[MAX_PICTURES];
346 for (count = 0; count < MAX_PICTURES; count++)
348 picture_resource_t *res = &p_sys->resource[count];
350 res->p->i_lines = pic->p->i_lines;
351 res->p->i_pitch = pic->p->i_pitch;
352 if (PictureResourceAlloc (vd, res, res->p->i_pitch * res->p->i_lines,
353 p_sys->conn, p_sys->shm))
355 pic_array[count] = picture_NewFromResource (&vd->fmt, res);
356 if (!pic_array[count])
358 PictureResourceFree (res, p_sys->conn);
359 memset (res, 0, sizeof(*res));
363 picture_Release (pic);
368 p_sys->pool = picture_pool_New (count, pic_array);
371 /* TODO release picture resources */
374 /* FIXME should also do it in case of error ? */
375 xcb_flush (p_sys->conn);
378 return picture_pool_Get (p_sys->pool);
382 * Sends an image to the X server.
384 static void Display (vout_display_t *vd, picture_t *pic)
386 vout_display_sys_t *p_sys = vd->sys;
387 xcb_shm_seg_t segment = pic->p_sys->segment;
388 xcb_void_cookie_t ck;
393 ck = xcb_shm_put_image_checked (p_sys->conn, p_sys->window, p_sys->gc,
394 /* real width */ pic->p->i_pitch / pic->p->i_pixel_pitch,
395 /* real height */ pic->p->i_lines,
396 /* x */ vd->fmt.i_x_offset,
397 /* y */ vd->fmt.i_y_offset,
398 /* width */ vd->fmt.i_visible_width,
399 /* height */ vd->fmt.i_visible_height,
400 0, 0, p_sys->depth, XCB_IMAGE_FORMAT_Z_PIXMAP,
404 const size_t offset = vd->fmt.i_y_offset * pic->p->i_pitch;
405 const unsigned lines = pic->p->i_lines - vd->fmt.i_y_offset;
407 ck = xcb_put_image_checked (p_sys->conn, XCB_IMAGE_FORMAT_Z_PIXMAP,
408 p_sys->window, p_sys->gc,
409 pic->p->i_pitch / pic->p->i_pixel_pitch,
410 lines, -vd->fmt.i_x_offset, 0, 0, p_sys->depth,
411 pic->p->i_pitch * lines, pic->p->p_pixels + offset);
414 /* Wait for reply. This makes sure that the X server gets CPU time to
415 * display the picture. xcb_flush() is *not* sufficient: especially with
416 * shared memory the PUT requests are so short that many of them can fit in
417 * X11 socket output buffer before the kernel preempts VLC. */
418 xcb_generic_error_t *e = xcb_request_check (p_sys->conn, ck);
421 msg_Dbg (vd, "%s: X11 error %d", "cannot put image", e->error_code);
425 /* FIXME might be WAY better to wait in some case (be carefull with
426 * VOUT_DISPLAY_RESET_PICTURES if done) + does not work with
427 * vout_display wrapper. */
429 picture_Release (pic);
432 static int Control (vout_display_t *vd, int query, va_list ap)
434 vout_display_sys_t *p_sys = vd->sys;
438 case VOUT_DISPLAY_CHANGE_FULLSCREEN:
440 const vout_display_cfg_t *c = va_arg (ap, const vout_display_cfg_t *);
441 return vout_window_SetFullScreen (p_sys->embed, c->is_fullscreen);
444 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
446 const vout_display_cfg_t *p_cfg =
447 (const vout_display_cfg_t*)va_arg (ap, const vout_display_cfg_t *);
448 const bool is_forced = (bool)va_arg (ap, int);
451 && vout_window_SetSize (p_sys->embed,
452 p_cfg->display.width,
453 p_cfg->display.height))
456 vout_display_place_t place;
457 vout_display_PlacePicture (&place, &vd->source, p_cfg, false);
459 if (place.width != vd->fmt.i_visible_width ||
460 place.height != vd->fmt.i_visible_height)
462 vout_display_SendEventPicturesInvalid (vd);
466 /* Move the picture within the window */
467 const uint32_t values[] = { place.x, place.y };
468 xcb_configure_window (p_sys->conn, p_sys->window,
469 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y,
473 case VOUT_DISPLAY_CHANGE_ON_TOP:
475 int b_on_top = (int)va_arg (ap, int);
476 return vout_window_SetOnTop (p_sys->embed, b_on_top);
479 case VOUT_DISPLAY_CHANGE_ZOOM:
480 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
481 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
482 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
483 /* I am not sure it is always necessary, but it is way simpler ... */
484 vout_display_SendEventPicturesInvalid (vd);
487 case VOUT_DISPLAY_RESET_PICTURES:
491 vout_display_place_t place;
492 vout_display_PlacePicture (&place, &vd->source, vd->cfg, false);
494 vd->fmt.i_width = vd->source.i_width * place.width / vd->source.i_visible_width;
495 vd->fmt.i_height = vd->source.i_height * place.height / vd->source.i_visible_height;
497 vd->fmt.i_visible_width = place.width;
498 vd->fmt.i_visible_height = place.height;
499 vd->fmt.i_x_offset = vd->source.i_x_offset * place.width / vd->source.i_visible_width;
500 vd->fmt.i_y_offset = vd->source.i_y_offset * place.height / vd->source.i_visible_height;
504 /* Hide the mouse. It will be send when
505 * vout_display_t::info.b_hide_mouse is false */
506 case VOUT_DISPLAY_HIDE_MOUSE:
507 xcb_change_window_attributes (p_sys->conn, p_sys->embed->xid,
508 XCB_CW_CURSOR, &(uint32_t){ p_sys->cursor });
512 msg_Err (vd, "Unknown request in XCB vout display");
517 static void Manage (vout_display_t *vd)
519 vout_display_sys_t *p_sys = vd->sys;
521 ManageEvent (vd, p_sys->conn, &p_sys->visible);
524 static void ResetPictures (vout_display_t *vd)
526 vout_display_sys_t *p_sys = vd->sys;
531 for (unsigned i = 0; i < MAX_PICTURES; i++)
533 picture_resource_t *res = &p_sys->resource[i];
535 if (!res->p->p_pixels)
537 PictureResourceFree (res, p_sys->conn);
539 picture_pool_Delete (p_sys->pool);