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)
124 const xcb_screen_t *scr;
125 p_sys->embed = GetWindow (vout, p_sys->conn, &scr, &p_sys->shm);
126 if (p_sys->embed == NULL)
128 xcb_disconnect (p_sys->conn);
133 const xcb_setup_t *setup = xcb_get_setup (p_sys->conn);
134 p_sys->byte_order = setup->image_byte_order;
136 /* Determine our video format. Normally, this is done in pf_init(), but
137 * this plugin always uses the same format for a given X11 screen. */
138 xcb_visualid_t vid = 0;
141 for (const xcb_format_t *fmt = xcb_setup_pixmap_formats (setup),
142 *end = fmt + xcb_setup_pixmap_formats_length (setup);
145 vlc_fourcc_t chroma = 0;
147 if (fmt->depth < depth)
148 continue; /* We already found a better format! */
150 /* Check that the pixmap format is supported by VLC. */
154 if (fmt->bits_per_pixel == 32)
155 chroma = VLC_CODEC_RGB32;
156 else if (fmt->bits_per_pixel == 24)
157 chroma = VLC_CODEC_RGB24;
162 if (fmt->bits_per_pixel != 16)
164 chroma = VLC_CODEC_RGB16;
167 if (fmt->bits_per_pixel != 16)
169 chroma = VLC_CODEC_RGB15;
172 if (fmt->bits_per_pixel != 8)
174 chroma = VLC_CODEC_RGB8;
179 if ((fmt->bits_per_pixel << 4) % fmt->scanline_pad)
180 continue; /* VLC pads lines to 16 pixels internally */
182 /* Byte sex is a non-issue for 8-bits. It can be worked around with
183 * RGB masks for 24-bits. Too bad for 15-bits and 16-bits. */
184 if (fmt->bits_per_pixel == 16 && setup->image_byte_order != ORDER)
187 /* Check that the selected screen supports this depth */
188 xcb_depth_iterator_t it = xcb_screen_allowed_depths_iterator (scr);
189 while (it.rem > 0 && it.data->depth != fmt->depth)
190 xcb_depth_next (&it);
192 continue; /* Depth not supported on this screen */
194 /* Find a visual type for the selected depth */
195 const xcb_visualtype_t *vt = xcb_depth_visuals (it.data);
196 for (int i = xcb_depth_visuals_length (it.data); i > 0; i--)
198 if (vt->_class == XCB_VISUAL_CLASS_TRUE_COLOR)
204 if (fmt->depth == 8 && vt->_class == XCB_VISUAL_CLASS_STATIC_GRAY)
207 continue; /* Prefer color over gray scale */
209 chroma = VLC_CODEC_GREY;
214 continue; /* The screen does not *really* support this depth */
216 vout->fmt_out.i_chroma = vout->output.i_chroma = chroma;
219 vout->fmt_out.i_rmask = vout->output.i_rmask = vt->red_mask;
220 vout->fmt_out.i_gmask = vout->output.i_gmask = vt->green_mask;
221 vout->fmt_out.i_bmask = vout->output.i_bmask = vt->blue_mask;
223 p_sys->bpp = fmt->bits_per_pixel;
224 p_sys->pad = fmt->scanline_pad;
225 p_sys->depth = depth = fmt->depth;
230 msg_Err (vout, "no supported pixmap formats or visual types");
234 msg_Dbg (vout, "using X11 visual ID 0x%"PRIx32, vid);
235 msg_Dbg (vout, " %"PRIu8" bits per pixels, %"PRIu8" bits line pad",
236 p_sys->bpp, p_sys->pad);
238 /* Create colormap (needed to select non-default visual) */
240 if (vid != scr->root_visual)
242 cmap = xcb_generate_id (p_sys->conn);
243 xcb_create_colormap (p_sys->conn, XCB_COLORMAP_ALLOC_NONE,
244 cmap, scr->root, vid);
247 cmap = scr->default_colormap;
251 const uint32_t mask = XCB_CW_EVENT_MASK | XCB_CW_COLORMAP;
252 const uint32_t values[] = {
253 /* XCB_CW_EVENT_MASK */
254 XCB_EVENT_MASK_BUTTON_PRESS | XCB_EVENT_MASK_BUTTON_RELEASE |
255 XCB_EVENT_MASK_POINTER_MOTION,
256 /* XCB_CW_COLORMAP */
260 xcb_window_t window = xcb_generate_id (p_sys->conn);
262 c = xcb_create_window_checked (p_sys->conn, depth, window,
263 p_sys->embed->handle.xid, 0, 0, 1, 1, 0,
264 XCB_WINDOW_CLASS_INPUT_OUTPUT,
266 if (CheckError (vout, "cannot create X11 window", c))
268 p_sys->window = window;
269 msg_Dbg (vout, "using X11 window %08"PRIx32, p_sys->window);
270 xcb_map_window (p_sys->conn, window);
273 /* Create graphic context (I wonder why the heck do we need this) */
274 p_sys->gc = xcb_generate_id (p_sys->conn);
275 xcb_create_gc (p_sys->conn, p_sys->gc, p_sys->window, 0, NULL);
276 msg_Dbg (vout, "using X11 graphic context %08"PRIx32, p_sys->gc);
278 vout->pf_init = Init;
279 vout->pf_end = Deinit;
280 vout->pf_display = Display;
281 vout->pf_manage = Manage;
282 vout->pf_control = Control;
292 * Disconnect from the X server.
294 static void Close (vlc_object_t *obj)
296 vout_thread_t *vout = (vout_thread_t *)obj;
297 vout_sys_t *p_sys = vout->p_sys;
299 vout_ReleaseWindow (p_sys->embed);
300 /* colormap and window are garbage-collected by X */
301 xcb_disconnect (p_sys->conn);
307 * Allocate drawable window and picture buffers.
309 static int Init (vout_thread_t *vout)
311 vout_sys_t *p_sys = vout->p_sys;
312 unsigned x, y, width, height;
314 if (GetWindowSize (p_sys->embed, p_sys->conn, &width, &height))
316 vout_PlacePicture (vout, width, height, &x, &y, &width, &height);
318 const uint32_t values[] = { x, y, width, height, };
319 xcb_configure_window (p_sys->conn, p_sys->window,
320 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
321 XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
324 /* FIXME: I don't get the subtlety between output and fmt_out here */
325 vout->fmt_out.i_visible_width = width;
326 vout->fmt_out.i_visible_height = height;
327 vout->fmt_out.i_sar_num = vout->fmt_out.i_sar_den = 1;
329 vout->output.i_width = vout->fmt_out.i_width =
330 width * vout->fmt_in.i_width / vout->fmt_in.i_visible_width;
331 vout->output.i_height = vout->fmt_out.i_height =
332 height * vout->fmt_in.i_height / vout->fmt_in.i_visible_height;
333 vout->fmt_out.i_x_offset =
334 width * vout->fmt_in.i_x_offset / vout->fmt_in.i_visible_width;
335 p_vout->fmt_out.i_y_offset =
336 height * vout->fmt_in.i_y_offset / vout->fmt_in.i_visible_height;
339 vout->output.i_aspect = vout->fmt_out.i_aspect =
340 width * VOUT_ASPECT_FACTOR / height;
342 /* Allocate picture buffers */
343 I_OUTPUTPICTURES = 0;
344 for (size_t index = 0; I_OUTPUTPICTURES < 2; index++)
346 picture_t *pic = vout->p_picture + index;
348 if (index > sizeof (vout->p_picture) / sizeof (pic))
350 if (pic->i_status != FREE_PICTURE)
353 picture_Setup (pic, vout->output.i_chroma,
354 vout->output.i_width, vout->output.i_height,
355 vout->output.i_aspect);
356 if (PictureAlloc (vout, pic, pic->p->i_pitch * pic->p->i_lines,
357 p_sys->shm ? p_sys->conn : NULL))
359 PP_OUTPUTPICTURE[I_OUTPUTPICTURES++] = pic;
361 xcb_flush (p_sys->conn);
366 * Free picture buffers.
368 static void Deinit (vout_thread_t *vout)
370 for (int i = 0; i < I_OUTPUTPICTURES; i++)
371 PictureFree (PP_OUTPUTPICTURE[i], vout->p_sys->conn);
375 * Sends an image to the X server.
377 static void Display (vout_thread_t *vout, picture_t *pic)
379 vout_sys_t *p_sys = vout->p_sys;
380 xcb_shm_seg_t segment = (uintptr_t)pic->p_sys;
383 xcb_shm_put_image (p_sys->conn, p_sys->window, p_sys->gc,
384 /* real width */ pic->p->i_pitch / pic->p->i_pixel_pitch,
385 /* real height */ pic->p->i_lines,
386 /* x */ vout->fmt_out.i_x_offset,
387 /* y */ vout->fmt_out.i_y_offset,
388 /* width */ vout->fmt_out.i_visible_width,
389 /* height */ vout->fmt_out.i_visible_height,
390 0, 0, p_sys->depth, XCB_IMAGE_FORMAT_Z_PIXMAP,
394 const size_t offset = vout->fmt_out.i_y_offset * pic->p->i_pitch;
395 const unsigned lines = pic->p->i_lines - vout->fmt_out.i_y_offset;
397 xcb_put_image (p_sys->conn, XCB_IMAGE_FORMAT_Z_PIXMAP,
398 p_sys->window, p_sys->gc,
399 pic->p->i_pitch / pic->p->i_pixel_pitch,
400 lines, -vout->fmt_out.i_x_offset, 0, 0, p_sys->depth,
401 pic->p->i_pitch * lines, pic->p->p_pixels + offset);
403 xcb_flush (p_sys->conn);
407 * Process incoming X events.
409 static int Manage (vout_thread_t *vout)
411 vout_sys_t *p_sys = vout->p_sys;
412 xcb_generic_event_t *ev;
414 while ((ev = xcb_poll_for_event (p_sys->conn)) != NULL)
415 ProcessEvent (vout, p_sys->conn, p_sys->window, ev);
417 if (xcb_connection_has_error (p_sys->conn))
419 msg_Err (vout, "X server failure");
423 CommonManage (vout); /* FIXME: <-- move that to core */
428 HandleParentStructure (vout_thread_t *vout, xcb_connection_t *conn,
429 xcb_window_t xid, xcb_configure_notify_event_t *ev)
431 unsigned width, height, x, y;
433 vout_PlacePicture (vout, ev->width, ev->height, &x, &y, &width, &height);
434 if (width != vout->fmt_out.i_visible_width
435 || height != vout->fmt_out.i_visible_height)
437 vout->i_changes |= VOUT_SIZE_CHANGE;
438 return; /* vout will be reinitialized */
441 /* Move the picture within the window */
442 const uint32_t values[] = { x, y, };
443 xcb_configure_window (conn, xid,
444 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y,
448 static int Control (vout_thread_t *vout, int query, va_list ap)
450 return vout_ControlWindow (vout->p_sys->embed, query, ap);