git.sesse.net Git - vlc/blob - modules/video_output/xcb/x11.c

   1 /**
   2  * @file x11.c
   3  * @brief X C Bindings video output module for VLC media player
   4  */
   5 /*****************************************************************************
   6  * Copyright © 2009 Rémi Denis-Courmont
   7  *
   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.
  12  *
  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.
  17  *
  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  ****************************************************************************/
  22
  23 #ifdef HAVE_CONFIG_H
  24 # include <config.h>
  25 #endif
  26
  27 #include <stdlib.h>
  28 #include <assert.h>
  29
  30 #include <xcb/xcb.h>
  31 #include <xcb/shm.h>
  32
  33 #include <vlc_common.h>
  34 #include <vlc_plugin.h>
  35 #include <vlc_vout.h>
  36 #include <vlc_window.h>
  37
  38 #include "xcb_vlc.h"
  39
  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.")
  44
  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.")
  48
  49 static int  Open (vlc_object_t *);
  50 static void Close (vlc_object_t *);
  51
  52 /*
  53  * Module descriptor
  54  */
  55 vlc_module_begin ()
  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)
  62
  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)
  66 vlc_module_end ()
  67
  68 struct vout_sys_t
  69 {
  70     xcb_connection_t *conn;
  71     vout_window_t *embed; /* VLC window (when windowed) */
  72
  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 */
  80 };
  81
  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
  87 int CheckError (vout_thread_t *vout, const char *str, xcb_void_cookie_t ck)
  88 {
  89     xcb_generic_error_t *err;
  90
  91     err = xcb_request_check (vout->p_sys->conn, ck);
  92     if (err)
  93     {
  94         msg_Err (vout, "%s: X11 error %d", str, err->error_code);
  95         return VLC_EGENERIC;
  96     }
  97     return VLC_SUCCESS;
  98 }
  99
 100 #define p_vout vout
 101
 102 /**
 103  * Probe the X server.
 104  */
 105 static int Open (vlc_object_t *obj)
 106 {
 107     vout_thread_t *vout = (vout_thread_t *)obj;
 108     vout_sys_t *p_sys = malloc (sizeof (*p_sys));
 109     if (p_sys == NULL)
 110         return VLC_ENOMEM;
 111
 112     vout->p_sys = p_sys;
 113
 114     /* Connect to X */
 115     p_sys->conn = Connect (obj);
 116     if (p_sys->conn == NULL)
 117         return VLC_EGENERIC;
 118
 119     /* Get window */
 120     const xcb_screen_t *scr;
 121     p_sys->embed = GetWindow (vout, p_sys->conn, &scr, &p_sys->shm);
 122     if (p_sys->embed == NULL)
 123     {
 124         xcb_disconnect (p_sys->conn);
 125         return VLC_EGENERIC;
 126     }
 127
 128     const xcb_setup_t *setup = xcb_get_setup (p_sys->conn);
 129     p_sys->byte_order = setup->image_byte_order;
 130
 131     /* Determine our video format. Normally, this is done in pf_init(), but
 132      * this plugin always uses the same format for a given X11 screen. */
 133     xcb_visualid_t vid = 0;
 134     uint8_t depth = 0;
 135     bool gray = true;
 136     for (const xcb_format_t *fmt = xcb_setup_pixmap_formats (setup),
 137              *end = fmt + xcb_setup_pixmap_formats_length (setup);
 138          fmt < end; fmt++)
 139     {
 140         vlc_fourcc_t chroma = 0;
 141
 142         if (fmt->depth < depth)
 143             continue; /* We already found a better format! */
 144
 145         /* Check that the pixmap format is supported by VLC. */
 146         switch (fmt->depth)
 147         {
 148           case 24:
 149             if (fmt->bits_per_pixel == 32)
 150                 chroma = VLC_FOURCC ('R', 'V', '3', '2');
 151             else if (fmt->bits_per_pixel == 24)
 152                 chroma = VLC_FOURCC ('R', 'V', '2', '4');
 153             else
 154                 continue;
 155             break;
 156           case 16:
 157             if (fmt->bits_per_pixel != 16)
 158                 continue;
 159             chroma = VLC_FOURCC ('R', 'V', '1', '6');
 160             break;
 161           case 15:
 162             if (fmt->bits_per_pixel != 16)
 163                 continue;
 164             chroma = VLC_FOURCC ('R', 'V', '1', '5');
 165             break;
 166           case 8:
 167             if (fmt->bits_per_pixel != 8)
 168                 continue;
 169             chroma = VLC_FOURCC ('R', 'G', 'B', '2');
 170             break;
 171           default:
 172             continue;
 173         }
 174         if ((fmt->bits_per_pixel << 4) % fmt->scanline_pad)
 175             continue; /* VLC pads lines to 16 pixels internally */
 176
 177         /* Byte sex is a non-issue for 8-bits. It can be worked around with
 178          * RGB masks for 24-bits. Too bad for 15-bits and 16-bits. */
 179         if (fmt->bits_per_pixel == 16 && setup->image_byte_order != ORDER)
 180             continue;
 181
 182         /* Check that the selected screen supports this depth */
 183         xcb_depth_iterator_t it = xcb_screen_allowed_depths_iterator (scr);
 184         while (it.rem > 0 && it.data->depth != fmt->depth)
 185              xcb_depth_next (&it);
 186         if (!it.rem)
 187             continue; /* Depth not supported on this screen */
 188
 189         /* Find a visual type for the selected depth */
 190         const xcb_visualtype_t *vt = xcb_depth_visuals (it.data);
 191         for (int i = xcb_depth_visuals_length (it.data); i > 0; i--)
 192         {
 193             if (vt->_class == XCB_VISUAL_CLASS_TRUE_COLOR)
 194             {
 195                 vid = vt->visual_id;
 196                 gray = false;
 197                 break;
 198             }
 199             if (fmt->depth == 8 && vt->_class == XCB_VISUAL_CLASS_STATIC_GRAY)
 200             {
 201                 if (!gray)
 202                     continue; /* Prefer color over gray scale */
 203                 vid = vt->visual_id;
 204                 chroma = VLC_FOURCC ('G', 'R', 'E', 'Y');
 205             }
 206         }
 207
 208         if (!vid)
 209             continue; /* The screen does not *really* support this depth */
 210
 211         vout->fmt_out.i_chroma = vout->output.i_chroma = chroma;
 212         if (!gray)
 213         {
 214             vout->output.i_rmask = vt->red_mask;
 215             vout->output.i_gmask = vt->green_mask;
 216             vout->output.i_bmask = vt->blue_mask;
 217         }
 218         p_sys->bpp = fmt->bits_per_pixel;
 219         p_sys->pad = fmt->scanline_pad;
 220         p_sys->depth = depth = fmt->depth;
 221     }
 222
 223     if (depth == 0)
 224     {
 225         msg_Err (vout, "no supported pixmap formats or visual types");
 226         goto error;
 227     }
 228
 229     msg_Dbg (vout, "using X11 visual ID 0x%"PRIx32, vid);
 230     msg_Dbg (vout, " %"PRIu8" bits per pixels, %"PRIu8" bits line pad",
 231              p_sys->bpp, p_sys->pad);
 232
 233     /* Create colormap (needed to select non-default visual) */
 234     xcb_colormap_t cmap;
 235     if (vid != scr->root_visual)
 236     {
 237         cmap = xcb_generate_id (p_sys->conn);
 238         xcb_create_colormap (p_sys->conn, XCB_COLORMAP_ALLOC_NONE,
 239                              cmap, scr->root, vid);
 240     }
 241     else
 242         cmap = scr->default_colormap;
 243
 244     /* Create window */
 245     {
 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_BUTTON_PRESS | XCB_EVENT_MASK_BUTTON_RELEASE |
 250             XCB_EVENT_MASK_POINTER_MOTION,
 251             /* XCB_CW_COLORMAP */
 252             cmap,
 253         };
 254         xcb_void_cookie_t c;
 255         xcb_window_t window = xcb_generate_id (p_sys->conn);
 256
 257         c = xcb_create_window_checked (p_sys->conn, depth, window,
 258                                        p_sys->embed->handle.xid, 0, 0, 1, 1, 0,
 259                                        XCB_WINDOW_CLASS_INPUT_OUTPUT,
 260                                        vid, mask, values);
 261         if (CheckError (vout, "cannot create X11 window", c))
 262             goto error;
 263         p_sys->window = window;
 264         msg_Dbg (vout, "using X11 window %08"PRIx32, p_sys->window);
 265         xcb_map_window (p_sys->conn, window);
 266     }
 267
 268     /* Create graphic context (I wonder why the heck do we need this) */
 269     p_sys->gc = xcb_generate_id (p_sys->conn);
 270     xcb_create_gc (p_sys->conn, p_sys->gc, p_sys->window, 0, NULL);
 271     msg_Dbg (vout, "using X11 graphic context %08"PRIx32, p_sys->gc);
 272
 273     vout->pf_init = Init;
 274     vout->pf_end = Deinit;
 275     vout->pf_display = Display;
 276     vout->pf_manage = Manage;
 277     return VLC_SUCCESS;
 278
 279 error:
 280     Close (obj);
 281     return VLC_EGENERIC;
 282 }
 283
 284
 285 /**
 286  * Disconnect from the X server.
 287  */
 288 static void Close (vlc_object_t *obj)
 289 {
 290     vout_thread_t *vout = (vout_thread_t *)obj;
 291     vout_sys_t *p_sys = vout->p_sys;
 292
 293     vout_ReleaseWindow (p_sys->embed);
 294     /* colormap and window are garbage-collected by X */
 295     xcb_disconnect (p_sys->conn);
 296     free (p_sys);
 297 }
 298
 299
 300 /**
 301  * Allocate drawable window and picture buffers.
 302  */
 303 static int Init (vout_thread_t *vout)
 304 {
 305     vout_sys_t *p_sys = vout->p_sys;
 306     unsigned x, y, width, height;
 307
 308     if (GetWindowSize (p_sys->embed, p_sys->conn, &width, &height))
 309         return VLC_EGENERIC;
 310     vout_PlacePicture (vout, width, height, &x, &y, &width, &height);
 311
 312     const uint32_t values[] = { x, y, width, height, };
 313     xcb_configure_window (p_sys->conn, p_sys->window,
 314                           XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
 315                           XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
 316                           values);
 317
 318     /* FIXME: I don't get the subtlety between output and fmt_out here */
 319     vout->fmt_out.i_visible_width = width;
 320     vout->fmt_out.i_visible_height = height;
 321     vout->fmt_out.i_sar_num = vout->fmt_out.i_sar_den = 1;
 322
 323     vout->output.i_width = vout->fmt_out.i_width =
 324         width * vout->fmt_in.i_width / vout->fmt_in.i_visible_width;
 325     vout->output.i_height = vout->fmt_out.i_height =
 326         height * vout->fmt_in.i_height / vout->fmt_in.i_visible_height;
 327     vout->fmt_out.i_x_offset =
 328         width * vout->fmt_in.i_x_offset / vout->fmt_in.i_visible_width;
 329     p_vout->fmt_out.i_y_offset =
 330         height * vout->fmt_in.i_y_offset / vout->fmt_in.i_visible_height;
 331
 332     assert (height > 0);
 333     vout->output.i_aspect = vout->fmt_out.i_aspect =
 334         width * VOUT_ASPECT_FACTOR / height;
 335
 336     /* Allocate picture buffers */
 337     I_OUTPUTPICTURES = 0;
 338     for (size_t index = 0; I_OUTPUTPICTURES < 2; index++)
 339     {
 340         picture_t *pic = vout->p_picture + index;
 341
 342         if (index > sizeof (vout->p_picture) / sizeof (pic))
 343             break;
 344         if (pic->i_status != FREE_PICTURE)
 345             continue;
 346         if (PictureInit (vout, pic, p_sys->shm ? p_sys->conn : NULL))
 347             break;
 348         PP_OUTPUTPICTURE[I_OUTPUTPICTURES++] = pic;
 349     }
 350     xcb_flush (p_sys->conn);
 351     return VLC_SUCCESS;
 352 }
 353
 354 /**
 355  * Free picture buffers.
 356  */
 357 static void Deinit (vout_thread_t *vout)
 358 {
 359     for (int i = 0; i < I_OUTPUTPICTURES; i++)
 360         PictureDeinit (PP_OUTPUTPICTURE[i], vout->p_sys->conn);
 361 }
 362
 363 /**
 364  * Sends an image to the X server.
 365  */
 366 static void Display (vout_thread_t *vout, picture_t *pic)
 367 {
 368     vout_sys_t *p_sys = vout->p_sys;
 369     xcb_shm_seg_t segment = (uintptr_t)pic->p_sys;
 370
 371     if (segment != 0)
 372         xcb_shm_put_image (p_sys->conn, p_sys->window, p_sys->gc,
 373           /* real width */ pic->p->i_pitch / pic->p->i_pixel_pitch,
 374          /* real height */ pic->p->i_lines, /* x */ 0, /* y */ 0,
 375                /* width */ pic->p->i_visible_pitch / pic->p->i_pixel_pitch,
 376               /* height */ pic->p->i_visible_lines, /* x */ 0, /* y */ 0,
 377                            p_sys->depth, XCB_IMAGE_FORMAT_Z_PIXMAP,
 378                            0, segment, 0);
 379     else
 380         xcb_put_image (p_sys->conn, XCB_IMAGE_FORMAT_Z_PIXMAP,
 381                        p_sys->window, p_sys->gc,
 382                        pic->p->i_pitch / pic->p->i_pixel_pitch,
 383                        pic->p->i_lines, 0, 0, 0, p_sys->depth,
 384                        pic->p->i_pitch * pic->p->i_lines, pic->p->p_pixels);
 385     xcb_flush (p_sys->conn);
 386 }
 387
 388 /**
 389  * Process incoming X events.
 390  */
 391 static int Manage (vout_thread_t *vout)
 392 {
 393     vout_sys_t *p_sys = vout->p_sys;
 394     xcb_generic_event_t *ev;
 395
 396     while ((ev = xcb_poll_for_event (p_sys->conn)) != NULL)
 397         ProcessEvent (vout, p_sys->conn, p_sys->window, ev);
 398
 399     if (xcb_connection_has_error (p_sys->conn))
 400     {
 401         msg_Err (vout, "X server failure");
 402         return VLC_EGENERIC;
 403     }
 404     return VLC_SUCCESS;
 405 }
 406
 407 void
 408 HandleParentStructure (vout_thread_t *vout, xcb_connection_t *conn,
 409                        xcb_window_t xid, xcb_configure_notify_event_t *ev)
 410 {
 411     unsigned width, height, x, y;
 412
 413     vout_PlacePicture (vout, ev->width, ev->height, &x, &y, &width, &height);
 414     if (width != vout->fmt_out.i_visible_width
 415      || height != vout->fmt_out.i_visible_height)
 416     {
 417         vout->i_changes |= VOUT_SIZE_CHANGE;
 418         return; /* vout will be reinitialized */
 419     }
 420
 421     /* Move the picture within the window */
 422     const uint32_t values[] = { x, y, };
 423     xcb_configure_window (conn, xid,
 424                           XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y,
 425                           values);
 426 }