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 DISPLAY_TEXT N_("X11 display")
41 #define DISPLAY_LONGTEXT N_( \
42 "X11 hardware display to use. By default VLC will " \
43 "use the value of the DISPLAY environment variable.")
45 #define SHM_TEXT N_("Use shared memory")
46 #define SHM_LONGTEXT N_( \
47 "Use shared memory to communicate between VLC and the X server.")
49 static int Open (vlc_object_t *);
50 static void Close (vlc_object_t *);
56 set_shortname (N_("X11"))
57 set_description (N_("X11 video output (XCB)"))
58 set_category (CAT_VIDEO)
59 set_subcategory (SUBCAT_VIDEO_VOUT)
60 set_capability ("vout display", 75)
61 set_callbacks (Open, Close)
63 add_string ("x11-display", NULL, NULL,
64 DISPLAY_TEXT, DISPLAY_LONGTEXT, true)
65 add_bool ("x11-shm", true, NULL, SHM_TEXT, SHM_LONGTEXT, true)
68 /* It must be large enough to absorb the server display jitter but it is
69 * useless to used a too large value, direct rendering cannot be used with
72 #define MAX_PICTURES (3)
74 struct vout_display_sys_t
76 xcb_connection_t *conn;
77 vout_window_t *embed; /* VLC window (when windowed) */
79 xcb_window_t window; /* drawable X window */
80 xcb_gcontext_t gc; /* context to put images */
81 bool shm; /* whether to use MIT-SHM */
82 bool visible; /* whether to draw */
83 uint8_t bpp; /* bits per pixel */
84 uint8_t pad; /* scanline pad */
85 uint8_t depth; /* useful bits per pixel */
86 uint8_t byte_order; /* server byte order */
88 picture_pool_t *pool; /* picture pool */
89 picture_resource_t resource[MAX_PICTURES];
92 static picture_t *Get (vout_display_t *);
93 static void Display (vout_display_t *, picture_t *);
94 static int Control (vout_display_t *, int, va_list);
95 static void Manage (vout_display_t *);
97 static void ResetPictures (vout_display_t *);
100 * Probe the X server.
102 static int Open (vlc_object_t *obj)
104 vout_display_t *vd = (vout_display_t *)obj;
105 vout_display_sys_t *p_sys = malloc (sizeof (*p_sys));
113 p_sys->conn = Connect (obj);
114 if (p_sys->conn == NULL)
121 const xcb_screen_t *scr;
122 p_sys->embed = GetWindow (vd, p_sys->conn, &scr, &p_sys->shm);
123 if (p_sys->embed == NULL)
125 xcb_disconnect (p_sys->conn);
130 const xcb_setup_t *setup = xcb_get_setup (p_sys->conn);
131 p_sys->byte_order = setup->image_byte_order;
134 video_format_t fmt_pic = vd->fmt;
136 /* Determine our video format. */
137 xcb_visualid_t vid = 0;
140 for (const xcb_format_t *fmt = xcb_setup_pixmap_formats (setup),
141 *end = fmt + xcb_setup_pixmap_formats_length (setup);
144 vlc_fourcc_t chroma = 0;
146 if (fmt->depth < depth)
147 continue; /* We already found a better format! */
149 /* Check that the pixmap format is supported by VLC. */
153 if (fmt->bits_per_pixel == 32)
154 chroma = VLC_CODEC_RGB32;
155 else if (fmt->bits_per_pixel == 24)
156 chroma = VLC_CODEC_RGB24;
161 if (fmt->bits_per_pixel != 16)
163 chroma = VLC_CODEC_RGB16;
166 if (fmt->bits_per_pixel != 16)
168 chroma = VLC_CODEC_RGB15;
171 if (fmt->bits_per_pixel != 8)
173 chroma = VLC_CODEC_RGB8;
178 if ((fmt->bits_per_pixel << 4) % fmt->scanline_pad)
179 continue; /* VLC pads lines to 16 pixels internally */
181 /* Byte sex is a non-issue for 8-bits. It can be worked around with
182 * RGB masks for 24-bits. Too bad for 15-bits and 16-bits. */
183 if (fmt->bits_per_pixel == 16 && setup->image_byte_order != ORDER)
186 /* Check that the selected screen supports this depth */
187 xcb_depth_iterator_t it = xcb_screen_allowed_depths_iterator (scr);
188 while (it.rem > 0 && it.data->depth != fmt->depth)
189 xcb_depth_next (&it);
191 continue; /* Depth not supported on this screen */
193 /* Find a visual type for the selected depth */
194 const xcb_visualtype_t *vt = xcb_depth_visuals (it.data);
195 for (int i = xcb_depth_visuals_length (it.data); i > 0; i--)
197 if (vt->_class == XCB_VISUAL_CLASS_TRUE_COLOR)
202 if (fmt->depth == 8 && vt->_class == XCB_VISUAL_CLASS_STATIC_GRAY)
205 continue; /* Prefer color over gray scale */
206 chroma = VLC_CODEC_GREY;
210 continue; /* The screen does not *really* support this depth */
213 fmt_pic.i_chroma = chroma;
217 fmt_pic.i_rmask = vt->red_mask;
218 fmt_pic.i_gmask = vt->green_mask;
219 fmt_pic.i_bmask = vt->blue_mask;
221 p_sys->bpp = fmt->bits_per_pixel;
222 p_sys->pad = fmt->scanline_pad;
223 p_sys->depth = depth = fmt->depth;
228 msg_Err (vd, "no supported pixmap formats or visual types");
232 msg_Dbg (vd, "using X11 visual ID 0x%"PRIx32" (depth: %"PRIu8")", vid,
234 msg_Dbg (vd, " %"PRIu8" bits per pixels, %"PRIu8" bits line pad",
235 p_sys->bpp, p_sys->pad);
237 /* Create colormap (needed to select non-default visual) */
239 if (vid != scr->root_visual)
241 cmap = xcb_generate_id (p_sys->conn);
242 xcb_create_colormap (p_sys->conn, XCB_COLORMAP_ALLOC_NONE,
243 cmap, scr->root, vid);
246 cmap = scr->default_colormap;
249 unsigned width, height;
250 if (GetWindowSize (p_sys->embed, p_sys->conn, &width, &height))
253 p_sys->window = xcb_generate_id (p_sys->conn);
254 p_sys->gc = xcb_generate_id (p_sys->conn);
256 const uint32_t mask = XCB_CW_EVENT_MASK | XCB_CW_COLORMAP;
257 const uint32_t values[] = {
258 /* XCB_CW_EVENT_MASK */
259 XCB_EVENT_MASK_BUTTON_PRESS | XCB_EVENT_MASK_BUTTON_RELEASE |
260 XCB_EVENT_MASK_POINTER_MOTION | XCB_EVENT_MASK_VISIBILITY_CHANGE,
261 /* XCB_CW_COLORMAP */
266 c = xcb_create_window_checked (p_sys->conn, depth, p_sys->window,
267 p_sys->embed->handle.xid, 0, 0,
269 XCB_WINDOW_CLASS_INPUT_OUTPUT,
271 xcb_map_window (p_sys->conn, p_sys->window);
272 /* Create graphic context (I wonder why the heck do we need this) */
273 xcb_create_gc (p_sys->conn, p_sys->gc, p_sys->window, 0, NULL);
275 if (CheckError (vd, p_sys->conn, "cannot create X11 window", c))
278 msg_Dbg (vd, "using X11 window %08"PRIx32, p_sys->window);
279 msg_Dbg (vd, "using X11 graphic context %08"PRIx32, p_sys->gc);
280 p_sys->visible = false;
283 vout_display_info_t info = vd->info;
284 info.has_pictures_invalid = true;
286 /* Setup vout_display_t once everything is fine */
292 vd->display = Display;
293 vd->control = Control;
297 vout_display_SendEventFullscreen (vd, false);
298 vout_display_SendEventDisplaySize (vd, width, height, false);
309 * Disconnect from the X server.
311 static void Close (vlc_object_t *obj)
313 vout_display_t *vd = (vout_display_t *)obj;
314 vout_display_sys_t *p_sys = vd->sys;
317 vout_display_DeleteWindow (vd, p_sys->embed);
318 /* colormap, window and context are garbage-collected by X */
319 xcb_disconnect (p_sys->conn);
324 * Return a direct buffer
326 static picture_t *Get (vout_display_t *vd)
328 vout_display_sys_t *p_sys = vd->sys;
332 vout_display_place_t place;
334 vout_display_PlacePicture (&place, &vd->source, vd->cfg, false);
337 const uint32_t values[] = { place.x, place.y, place.width, place.height };
338 xcb_configure_window (p_sys->conn, p_sys->window,
339 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
340 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
343 picture_t *pic = picture_NewFromFormat (&vd->fmt);
347 assert (pic->i_planes == 1);
348 memset (p_sys->resource, 0, sizeof(p_sys->resource));
351 picture_t *pic_array[MAX_PICTURES];
352 for (count = 0; count < MAX_PICTURES; count++)
354 picture_resource_t *res = &p_sys->resource[count];
356 res->p->i_lines = pic->p->i_lines;
357 res->p->i_pitch = pic->p->i_pitch;
358 if (PictureResourceAlloc (vd, res, res->p->i_pitch * res->p->i_lines,
359 p_sys->conn, p_sys->shm))
361 pic_array[count] = picture_NewFromResource (&vd->fmt, res);
362 if (!pic_array[count])
364 PictureResourceFree (res, p_sys->conn);
365 memset (res, 0, sizeof(*res));
369 picture_Release (pic);
374 p_sys->pool = picture_pool_New (count, pic_array);
377 /* TODO release picture resources */
380 /* FIXME should also do it in case of error ? */
381 xcb_flush (p_sys->conn);
384 return picture_pool_Get (p_sys->pool);
388 * Sends an image to the X server.
390 static void Display (vout_display_t *vd, picture_t *pic)
392 vout_display_sys_t *p_sys = vd->sys;
393 xcb_shm_seg_t segment = pic->p_sys->segment;
394 xcb_void_cookie_t ck;
399 ck = xcb_shm_put_image_checked (p_sys->conn, p_sys->window, p_sys->gc,
400 /* real width */ pic->p->i_pitch / pic->p->i_pixel_pitch,
401 /* real height */ pic->p->i_lines,
402 /* x */ vd->fmt.i_x_offset,
403 /* y */ vd->fmt.i_y_offset,
404 /* width */ vd->fmt.i_visible_width,
405 /* height */ vd->fmt.i_visible_height,
406 0, 0, p_sys->depth, XCB_IMAGE_FORMAT_Z_PIXMAP,
410 const size_t offset = vd->fmt.i_y_offset * pic->p->i_pitch;
411 const unsigned lines = pic->p->i_lines - vd->fmt.i_y_offset;
413 ck = xcb_put_image_checked (p_sys->conn, XCB_IMAGE_FORMAT_Z_PIXMAP,
414 p_sys->window, p_sys->gc,
415 pic->p->i_pitch / pic->p->i_pixel_pitch,
416 lines, -vd->fmt.i_x_offset, 0, 0, p_sys->depth,
417 pic->p->i_pitch * lines, pic->p->p_pixels + offset);
420 /* Wait for reply. This makes sure that the X server gets CPU time to
421 * display the picture. xcb_flush() is *not* sufficient: especially with
422 * shared memory the PUT requests are so short that many of them can fit in
423 * X11 socket output buffer before the kernel preempts VLC. */
424 xcb_generic_error_t *e = xcb_request_check (p_sys->conn, ck);
427 msg_Dbg (vd, "%s: X11 error %d", "cannot put image", e->error_code);
431 /* FIXME might be WAY better to wait in some case (be carefull with
432 * VOUT_DISPLAY_RESET_PICTURES if done) + does not work with
433 * vout_display wrapper. */
435 picture_Release (pic);
438 static int Control (vout_display_t *vd, int query, va_list ap)
440 vout_display_sys_t *p_sys = vd->sys;
444 case VOUT_DISPLAY_CHANGE_FULLSCREEN:
446 const vout_display_cfg_t *c = va_arg (ap, const vout_display_cfg_t *);
447 return vout_window_SetFullScreen (p_sys->embed, c->is_fullscreen);
450 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
452 const vout_display_cfg_t *p_cfg =
453 (const vout_display_cfg_t*)va_arg (ap, const vout_display_cfg_t *);
454 const bool is_forced = (bool)va_arg (ap, int);
457 && vout_window_SetSize (p_sys->embed,
458 p_cfg->display.width,
459 p_cfg->display.height))
462 vout_display_place_t place;
463 vout_display_PlacePicture (&place, &vd->source, p_cfg, false);
465 if (place.width != vd->fmt.i_visible_width ||
466 place.height != vd->fmt.i_visible_height)
468 vout_display_SendEventPicturesInvalid (vd);
472 /* Move the picture within the window */
473 const uint32_t values[] = { place.x, place.y };
474 xcb_configure_window (p_sys->conn, p_sys->window,
475 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y,
479 case VOUT_DISPLAY_CHANGE_ON_TOP:
481 int b_on_top = (int)va_arg (ap, int);
482 return vout_window_SetOnTop (p_sys->embed, b_on_top);
485 case VOUT_DISPLAY_CHANGE_ZOOM:
486 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
487 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
488 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
489 /* I am not sure it is always necessary, but it is way simpler ... */
490 vout_display_SendEventPicturesInvalid (vd);
493 case VOUT_DISPLAY_RESET_PICTURES:
497 vout_display_place_t place;
498 vout_display_PlacePicture (&place, &vd->source, vd->cfg, false);
500 vd->fmt.i_width = vd->source.i_width * place.width / vd->source.i_visible_width;
501 vd->fmt.i_height = vd->source.i_height * place.height / vd->source.i_visible_height;
503 vd->fmt.i_visible_width = place.width;
504 vd->fmt.i_visible_height = place.height;
505 vd->fmt.i_x_offset = vd->source.i_x_offset * place.width / vd->source.i_visible_width;
506 vd->fmt.i_y_offset = vd->source.i_y_offset * place.height / vd->source.i_visible_height;
512 /* Hide the mouse. It will be send when
513 * vout_display_t::info.b_hide_mouse is false */
514 VOUT_DISPLAY_HIDE_MOUSE,
517 msg_Err (vd, "Unknown request in XCB vout display");
522 static void Manage (vout_display_t *vd)
524 vout_display_sys_t *p_sys = vd->sys;
526 ManageEvent (vd, p_sys->conn, &p_sys->visible);
529 static void ResetPictures (vout_display_t *vd)
531 vout_display_sys_t *p_sys = vd->sys;
536 for (unsigned i = 0; i < MAX_PICTURES; i++)
538 picture_resource_t *res = &p_sys->resource[i];
540 if (!res->p->p_pixels)
542 PictureResourceFree (res, p_sys->conn);
544 picture_pool_Delete (p_sys->pool);