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 ****************************************************************************/
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
36 #include <vlc_window.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_("XCB"))
57 set_description (N_("(Experimental) XCB video output"))
58 set_category (CAT_VIDEO)
59 set_subcategory (SUBCAT_VIDEO_VOUT)
60 set_capability ("video output", 0)
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)
70 xcb_connection_t *conn;
71 vout_window_t *embed; /* VLC window (when windowed) */
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 uint8_t bpp; /* bits per pixel */
77 uint8_t pad; /* scanline pad */
78 uint8_t depth; /* useful bits per pixel */
79 uint8_t byte_order; /* server byte order */
82 static int Init (vout_thread_t *);
83 static void Deinit (vout_thread_t *);
84 static void Display (vout_thread_t *, picture_t *);
85 static int Manage (vout_thread_t *);
86 static int Control (vout_thread_t *, int, va_list);
88 int CheckError (vout_thread_t *vout, const char *str, xcb_void_cookie_t ck)
90 xcb_generic_error_t *err;
92 err = xcb_request_check (vout->p_sys->conn, ck);
95 msg_Err (vout, "%s: X11 error %d", str, err->error_code);
104 * Probe the X server.
106 static int Open (vlc_object_t *obj)
108 vout_thread_t *vout = (vout_thread_t *)obj;
109 vout_sys_t *p_sys = malloc (sizeof (*p_sys));
116 p_sys->conn = Connect (obj);
117 if (p_sys->conn == NULL)
121 const xcb_screen_t *scr;
122 p_sys->embed = GetWindow (vout, p_sys->conn, &scr, &p_sys->shm);
123 if (p_sys->embed == NULL)
125 xcb_disconnect (p_sys->conn);
129 const xcb_setup_t *setup = xcb_get_setup (p_sys->conn);
130 p_sys->byte_order = setup->image_byte_order;
132 /* Determine our video format. Normally, this is done in pf_init(), but
133 * this plugin always uses the same format for a given X11 screen. */
134 xcb_visualid_t vid = 0;
137 for (const xcb_format_t *fmt = xcb_setup_pixmap_formats (setup),
138 *end = fmt + xcb_setup_pixmap_formats_length (setup);
141 vlc_fourcc_t chroma = 0;
143 if (fmt->depth < depth)
144 continue; /* We already found a better format! */
146 /* Check that the pixmap format is supported by VLC. */
150 if (fmt->bits_per_pixel == 32)
151 chroma = VLC_CODEC_RGB32;
152 else if (fmt->bits_per_pixel == 24)
153 chroma = VLC_CODEC_RGB24;
158 if (fmt->bits_per_pixel != 16)
160 chroma = VLC_CODEC_RGB16;
163 if (fmt->bits_per_pixel != 16)
165 chroma = VLC_CODEC_RGB15;
168 if (fmt->bits_per_pixel != 8)
170 chroma = VLC_CODEC_RGB8;
175 if ((fmt->bits_per_pixel << 4) % fmt->scanline_pad)
176 continue; /* VLC pads lines to 16 pixels internally */
178 /* Byte sex is a non-issue for 8-bits. It can be worked around with
179 * RGB masks for 24-bits. Too bad for 15-bits and 16-bits. */
180 if (fmt->bits_per_pixel == 16 && setup->image_byte_order != ORDER)
183 /* Check that the selected screen supports this depth */
184 xcb_depth_iterator_t it = xcb_screen_allowed_depths_iterator (scr);
185 while (it.rem > 0 && it.data->depth != fmt->depth)
186 xcb_depth_next (&it);
188 continue; /* Depth not supported on this screen */
190 /* Find a visual type for the selected depth */
191 const xcb_visualtype_t *vt = xcb_depth_visuals (it.data);
192 for (int i = xcb_depth_visuals_length (it.data); i > 0; i--)
194 if (vt->_class == XCB_VISUAL_CLASS_TRUE_COLOR)
200 if (fmt->depth == 8 && vt->_class == XCB_VISUAL_CLASS_STATIC_GRAY)
203 continue; /* Prefer color over gray scale */
205 chroma = VLC_CODEC_GREY;
210 continue; /* The screen does not *really* support this depth */
212 vout->fmt_out.i_chroma = vout->output.i_chroma = chroma;
215 vout->fmt_out.i_rmask = vout->output.i_rmask = vt->red_mask;
216 vout->fmt_out.i_gmask = vout->output.i_gmask = vt->green_mask;
217 vout->fmt_out.i_bmask = vout->output.i_bmask = vt->blue_mask;
219 p_sys->bpp = fmt->bits_per_pixel;
220 p_sys->pad = fmt->scanline_pad;
221 p_sys->depth = depth = fmt->depth;
226 msg_Err (vout, "no supported pixmap formats or visual types");
230 msg_Dbg (vout, "using X11 visual ID 0x%"PRIx32, vid);
231 msg_Dbg (vout, " %"PRIu8" bits per pixels, %"PRIu8" bits line pad",
232 p_sys->bpp, p_sys->pad);
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;
247 const uint32_t mask = XCB_CW_EVENT_MASK | XCB_CW_COLORMAP;
248 const uint32_t values[] = {
249 /* XCB_CW_EVENT_MASK */
250 XCB_EVENT_MASK_BUTTON_PRESS | XCB_EVENT_MASK_BUTTON_RELEASE |
251 XCB_EVENT_MASK_POINTER_MOTION,
252 /* XCB_CW_COLORMAP */
256 xcb_window_t window = xcb_generate_id (p_sys->conn);
258 c = xcb_create_window_checked (p_sys->conn, depth, window,
259 p_sys->embed->handle.xid, 0, 0, 1, 1, 0,
260 XCB_WINDOW_CLASS_INPUT_OUTPUT,
262 if (CheckError (vout, "cannot create X11 window", c))
264 p_sys->window = window;
265 msg_Dbg (vout, "using X11 window %08"PRIx32, p_sys->window);
266 xcb_map_window (p_sys->conn, window);
269 /* Create graphic context (I wonder why the heck do we need this) */
270 p_sys->gc = xcb_generate_id (p_sys->conn);
271 xcb_create_gc (p_sys->conn, p_sys->gc, p_sys->window, 0, NULL);
272 msg_Dbg (vout, "using X11 graphic context %08"PRIx32, p_sys->gc);
274 vout->pf_init = Init;
275 vout->pf_end = Deinit;
276 vout->pf_display = Display;
277 vout->pf_manage = Manage;
278 vout->pf_control = Control;
288 * Disconnect from the X server.
290 static void Close (vlc_object_t *obj)
292 vout_thread_t *vout = (vout_thread_t *)obj;
293 vout_sys_t *p_sys = vout->p_sys;
295 vout_ReleaseWindow (p_sys->embed);
296 /* colormap and window are garbage-collected by X */
297 xcb_disconnect (p_sys->conn);
303 * Allocate drawable window and picture buffers.
305 static int Init (vout_thread_t *vout)
307 vout_sys_t *p_sys = vout->p_sys;
308 unsigned x, y, width, height;
310 if (GetWindowSize (p_sys->embed, p_sys->conn, &width, &height))
312 vout_PlacePicture (vout, width, height, &x, &y, &width, &height);
314 const uint32_t values[] = { x, y, width, height, };
315 xcb_configure_window (p_sys->conn, p_sys->window,
316 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
317 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
320 /* FIXME: I don't get the subtlety between output and fmt_out here */
321 vout->fmt_out.i_visible_width = width;
322 vout->fmt_out.i_visible_height = height;
323 vout->fmt_out.i_sar_num = vout->fmt_out.i_sar_den = 1;
325 vout->output.i_width = vout->fmt_out.i_width =
326 width * vout->fmt_in.i_width / vout->fmt_in.i_visible_width;
327 vout->output.i_height = vout->fmt_out.i_height =
328 height * vout->fmt_in.i_height / vout->fmt_in.i_visible_height;
329 vout->fmt_out.i_x_offset =
330 width * vout->fmt_in.i_x_offset / vout->fmt_in.i_visible_width;
331 p_vout->fmt_out.i_y_offset =
332 height * vout->fmt_in.i_y_offset / vout->fmt_in.i_visible_height;
335 vout->output.i_aspect = vout->fmt_out.i_aspect =
336 width * VOUT_ASPECT_FACTOR / height;
338 /* Allocate picture buffers */
339 I_OUTPUTPICTURES = 0;
340 for (size_t index = 0; I_OUTPUTPICTURES < 2; index++)
342 picture_t *pic = vout->p_picture + index;
344 if (index > sizeof (vout->p_picture) / sizeof (pic))
346 if (pic->i_status != FREE_PICTURE)
349 vout_InitPicture (vout, pic, vout->output.i_chroma,
350 vout->output.i_width, vout->output.i_height,
351 vout->output.i_aspect);
352 if (PictureAlloc (vout, pic, pic->p->i_pitch * pic->p->i_lines,
353 p_sys->shm ? p_sys->conn : NULL))
355 PP_OUTPUTPICTURE[I_OUTPUTPICTURES++] = pic;
357 xcb_flush (p_sys->conn);
362 * Free picture buffers.
364 static void Deinit (vout_thread_t *vout)
366 for (int i = 0; i < I_OUTPUTPICTURES; i++)
367 PictureFree (PP_OUTPUTPICTURE[i], vout->p_sys->conn);
371 * Sends an image to the X server.
373 static void Display (vout_thread_t *vout, picture_t *pic)
375 vout_sys_t *p_sys = vout->p_sys;
376 xcb_shm_seg_t segment = (uintptr_t)pic->p_sys;
379 xcb_shm_put_image (p_sys->conn, p_sys->window, p_sys->gc,
380 /* real width */ pic->p->i_pitch / pic->p->i_pixel_pitch,
381 /* real height */ pic->p->i_lines,
382 /* x */ vout->fmt_out.i_x_offset,
383 /* y */ vout->fmt_out.i_y_offset,
384 /* width */ vout->fmt_out.i_visible_width,
385 /* height */ vout->fmt_out.i_visible_height,
386 0, 0, p_sys->depth, XCB_IMAGE_FORMAT_Z_PIXMAP,
390 const size_t offset = vout->fmt_out.i_y_offset * pic->p->i_pitch;
391 const unsigned lines = pic->p->i_lines - vout->fmt_out.i_y_offset;
393 xcb_put_image (p_sys->conn, XCB_IMAGE_FORMAT_Z_PIXMAP,
394 p_sys->window, p_sys->gc,
395 pic->p->i_pitch / pic->p->i_pixel_pitch,
396 lines, -vout->fmt_out.i_x_offset, 0, 0, p_sys->depth,
397 pic->p->i_pitch * lines, pic->p->p_pixels + offset);
399 xcb_flush (p_sys->conn);
403 * Process incoming X events.
405 static int Manage (vout_thread_t *vout)
407 vout_sys_t *p_sys = vout->p_sys;
408 xcb_generic_event_t *ev;
410 while ((ev = xcb_poll_for_event (p_sys->conn)) != NULL)
411 ProcessEvent (vout, p_sys->conn, p_sys->window, ev);
413 if (xcb_connection_has_error (p_sys->conn))
415 msg_Err (vout, "X server failure");
419 CommonManage (vout); /* FIXME: <-- move that to core */
424 HandleParentStructure (vout_thread_t *vout, xcb_connection_t *conn,
425 xcb_window_t xid, xcb_configure_notify_event_t *ev)
427 unsigned width, height, x, y;
429 vout_PlacePicture (vout, ev->width, ev->height, &x, &y, &width, &height);
430 if (width != vout->fmt_out.i_visible_width
431 || height != vout->fmt_out.i_visible_height)
433 vout->i_changes |= VOUT_SIZE_CHANGE;
434 return; /* vout will be reinitialized */
437 /* Move the picture within the window */
438 const uint32_t values[] = { x, y, };
439 xcb_configure_window (conn, xid,
440 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y,
444 static int Control (vout_thread_t *vout, int query, va_list ap)
446 return vout_ControlWindow (vout->p_sys->embed, query, ap);