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

   1 /**
   2  * @file xcb.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 <sys/types.h>
  31 #include <sys/shm.h>
  32
  33 #include <xcb/xcb.h>
  34 #include <xcb/shm.h>
  35
  36 #include <xcb/xcb_aux.h>
  37 #include <xcb/xcb_image.h>
  38
  39 #include <vlc_common.h>
  40 #include <vlc_plugin.h>
  41 #include <vlc_vout.h>
  42 #include <vlc_window.h>
  43
  44 #include "xcb_vlc.h"
  45
  46 #define DISPLAY_TEXT N_("X11 display")
  47 #define DISPLAY_LONGTEXT N_( \
  48     "X11 hardware display to use. By default VLC will " \
  49     "use the value of the DISPLAY environment variable.")
  50
  51 #define SHM_TEXT N_("Use shared memory")
  52 #define SHM_LONGTEXT N_( \
  53     "Use shared memory to communicate between VLC and the X server.")
  54
  55 static int  Open (vlc_object_t *);
  56 static void Close (vlc_object_t *);
  57
  58 /*
  59  * Module descriptor
  60  */
  61 vlc_module_begin ()
  62     set_shortname (N_("XCB"))
  63     set_description (N_("(Experimental) XCB video output"))
  64     set_category (CAT_VIDEO)
  65     set_subcategory (SUBCAT_VIDEO_VOUT)
  66     set_capability ("video output", 0)
  67     set_callbacks (Open, Close)
  68
  69     add_string ("x11-display", NULL, NULL,
  70                 DISPLAY_TEXT, DISPLAY_LONGTEXT, true)
  71     add_bool ("x11-shm", true, NULL, SHM_TEXT, SHM_LONGTEXT, true)
  72 vlc_module_end ()
  73
  74 struct vout_sys_t
  75 {
  76     xcb_connection_t *conn;
  77     xcb_screen_t *screen;
  78     vout_window_t *embed; /* VLC window (when windowed) */
  79
  80     xcb_visualid_t vid; /* selected visual */
  81     xcb_window_t parent; /* parent X window */
  82     xcb_colormap_t cmap; /* colormap for selected visual */
  83     xcb_window_t window; /* drawable X window */
  84     xcb_gcontext_t gc; /* context to put images */
  85     bool shm; /* whether to use MIT-SHM */
  86     uint8_t bpp; /* bits per pixel */
  87 };
  88
  89 static int Init (vout_thread_t *);
  90 static void Deinit (vout_thread_t *);
  91 static void Render (vout_thread_t *, picture_t *);
  92 static void Display (vout_thread_t *, picture_t *);
  93 static int Manage (vout_thread_t *);
  94
  95 int CheckError (vout_thread_t *vout, const char *str, xcb_void_cookie_t ck)
  96 {
  97     xcb_generic_error_t *err;
  98
  99     err = xcb_request_check (vout->p_sys->conn, ck);
 100     if (err)
 101     {
 102         msg_Err (vout, "%s: X11 error %d", str, err->error_code);
 103         return VLC_EGENERIC;
 104     }
 105     return VLC_SUCCESS;
 106 }
 107
 108 #define p_vout vout
 109
 110 /**
 111  * Probe the X server.
 112  */
 113 static int Open (vlc_object_t *obj)
 114 {
 115     vout_thread_t *vout = (vout_thread_t *)obj;
 116     vout_sys_t *p_sys = malloc (sizeof (*p_sys));
 117     if (p_sys == NULL)
 118         return VLC_ENOMEM;
 119
 120     vout->p_sys = p_sys;
 121     p_sys->conn = NULL;
 122 #ifndef NDEBUG
 123     p_sys->embed = NULL;
 124 #endif
 125
 126     /* Connect to X */
 127     char *display = var_CreateGetNonEmptyString (vout, "x11-display");
 128     int snum;
 129     p_sys->conn = xcb_connect (display, &snum);
 130     if (xcb_connection_has_error (p_sys->conn) /*== NULL*/)
 131     {
 132         msg_Err (vout, "cannot connect to X server %s",
 133                  display ? display : "");
 134         free (display);
 135         goto error;
 136     }
 137     free (display);
 138
 139     /* Get the preferred screen */
 140     xcb_screen_t *scr = xcb_aux_get_screen (p_sys->conn, snum);
 141     p_sys->screen = scr;
 142     assert (p_sys->screen);
 143     msg_Dbg (vout, "using screen %d (depth %"PRIu8")", snum, scr->root_depth);
 144
 145     /* Determine the visual (color depth and palette) */
 146     xcb_visualtype_t *vt = NULL;
 147     bool gray = false;
 148
 149     if ((vt = xcb_aux_find_visual_by_attrs (scr, XCB_VISUAL_CLASS_TRUE_COLOR,
 150                                             scr->root_depth)) != NULL)
 151         msg_Dbg (vout, "using TrueColor visual ID %d", (int)vt->visual_id);
 152     else
 153 #if 0
 154     if ((vt = xcb_aux_find_visual_by_attrs (scr, XCB_VISUAL_CLASS_STATIC_COLOR,
 155                                             scr->root_depth)) != NULL)
 156         msg_Dbg (vout, "using static color visual ID %d", (int)vt->visual_id);
 157     else
 158 #endif
 159     if ((scr->root_depth == 8)
 160      && (vt = xcb_aux_find_visual_by_attrs (scr, XCB_VISUAL_CLASS_STATIC_GRAY,
 161                                             scr->root_depth)) != NULL)
 162     {
 163         msg_Dbg (vout, "using static gray visual ID %d", (int)vt->visual_id);
 164         gray = true;
 165     }
 166     else
 167     {
 168         vt = xcb_aux_find_visual_by_id (scr, scr->root_visual);
 169         assert (vt);
 170         msg_Err (vout, "unsupported visual class %"PRIu8, vt->_class);
 171         goto error;
 172     }
 173     p_sys->vid = vt->visual_id;
 174
 175     /* Determine our input format (normally, done in Init() but X11
 176      * never changes its format) */
 177     p_sys->bpp = scr->root_depth;
 178     switch (scr->root_depth)
 179     {
 180         case 24:
 181             p_sys->bpp = 32;
 182         case 32: /* FIXME: untested */
 183             vout->output.i_chroma = VLC_FOURCC ('R', 'V', '3', '2');
 184             break;
 185
 186         case 16:
 187             vout->output.i_chroma = VLC_FOURCC ('R', 'V', '1', '6');
 188             break;
 189
 190         case 15:
 191             p_sys->bpp = 16;
 192             vout->output.i_chroma = VLC_FOURCC ('R', 'V', '1', '5');
 193             break;
 194
 195         case 8: /* FIXME: VLC cannot convert */
 196             vout->output.i_chroma = gray ? VLC_FOURCC ('G', 'R', 'E', 'Y')
 197                                          : VLC_FOURCC ('R', 'G', 'B', '2');
 198             break;
 199
 200         default:
 201             msg_Err (vout, "unsupported %"PRIu8"-bits screen depth",
 202                      scr->root_depth);
 203             goto error;
 204     }
 205     vout->fmt_out.i_chroma = vout->output.i_chroma;
 206     if (!gray)
 207     {
 208         vout->output.i_rmask = vt->red_mask;
 209         vout->output.i_gmask = vt->green_mask;
 210         vout->output.i_bmask = vt->blue_mask;
 211     }
 212
 213     /* Create colormap (needed to select non-default visual) */
 214     p_sys->cmap = xcb_generate_id (p_sys->conn);
 215     xcb_create_colormap (p_sys->conn, XCB_COLORMAP_ALLOC_NONE,
 216                          p_sys->cmap, scr->root, p_sys->vid);
 217
 218     /* Check shared memory support */
 219     p_sys->shm = var_CreateGetBool (vout, "x11-shm") > 0;
 220     if (p_sys->shm)
 221     {
 222         xcb_shm_query_version_cookie_t ck;
 223         xcb_shm_query_version_reply_t *r;
 224         xcb_generic_error_t *err;
 225
 226         ck = xcb_shm_query_version (p_sys->conn);
 227         r = xcb_shm_query_version_reply (p_sys->conn, ck, &err);
 228         if (!r)
 229         {
 230             msg_Err (vout, "shared memory (MIT-SHM) not available");
 231             msg_Warn (vout, "display will be slow");
 232             p_sys->shm = false;
 233         }
 234     }
 235
 236     /* Get window */
 237     /* FIXME: WTH to put as initial width/height values??? */
 238     p_sys->embed = vout_RequestXWindow (vout, &(int){ 0 }, &(int){ 0 },
 239                                         &(unsigned){ 0 }, &(unsigned){ 0 });
 240     if (p_sys->embed == NULL)
 241     {
 242         msg_Err (vout, "parent window not available");
 243         goto error;
 244     }
 245
 246     vout->pf_init = Init;
 247     vout->pf_end = Deinit;
 248     vout->pf_render = Render;
 249     vout->pf_display = Display;
 250     vout->pf_manage = Manage;
 251     return VLC_SUCCESS;
 252
 253 error:
 254     Close (obj);
 255     return VLC_EGENERIC;
 256 }
 257
 258
 259 /**
 260  * Disconnect from the X server.
 261  */
 262 static void Close (vlc_object_t *obj)
 263 {
 264     vout_thread_t *vout = (vout_thread_t *)obj;
 265     vout_sys_t *p_sys = vout->p_sys;
 266
 267     if (p_sys->embed)
 268         vout_ReleaseWindow (p_sys->embed);
 269     /* colormap is garbage-ollected by X (?) */
 270     if (p_sys->conn)
 271         xcb_disconnect (p_sys->conn);
 272     free (p_sys);
 273 }
 274
 275 struct picture_sys_t
 276 {
 277     xcb_connection_t *conn; /* Shared connection to X server */
 278     xcb_image_t *image;  /* Picture buffer */
 279     xcb_image_t *native; /* Rendered picture buffer (in X server format) */
 280     xcb_shm_seg_t segment; /* Shared memory segment X ID */
 281 };
 282
 283 #define SHM_ERR ((void *)(intptr_t)(-1))
 284
 285 static int PictureInit (vout_thread_t *vout, picture_t *pic)
 286 {
 287     vout_sys_t *p_sys = vout->p_sys;
 288     picture_sys_t *priv = malloc (sizeof (*p_sys));
 289
 290     if (priv == NULL)
 291         return VLC_ENOMEM;
 292
 293     assert (pic->i_status == FREE_PICTURE);
 294     vout_InitPicture (vout, pic, vout->output.i_chroma,
 295                       vout->output.i_width, vout->output.i_height,
 296                       vout->output.i_aspect);
 297
 298     void *shm = SHM_ERR;
 299     const size_t size = pic->p->i_pitch * pic->p->i_lines;
 300
 301     if (p_sys->shm)
 302     {   /* Allocate shared memory segment */
 303         int id = shmget (IPC_PRIVATE, size, IPC_CREAT | 0700);
 304
 305         if (id == -1)
 306         {
 307             msg_Err (vout, "shared memory allocation error: %m");
 308             goto error;
 309         }
 310
 311         /* Attach the segment to VLC */
 312         shm = shmat (id, NULL, 0 /* read/write */);
 313         if (shm == SHM_ERR)
 314         {
 315             msg_Err (vout, "shared memory attachment error: %m");
 316             shmctl (id, IPC_RMID, 0);
 317             goto error;
 318         }
 319
 320         /* Attach the segment to X */
 321         xcb_void_cookie_t ck;
 322
 323         priv->segment = xcb_generate_id (p_sys->conn);
 324         ck = xcb_shm_attach_checked (p_sys->conn, priv->segment, id, 1);
 325         shmctl (id, IPC_RMID, 0);
 326
 327         if (CheckError (vout, "shared memory server-side error", ck))
 328         {
 329             msg_Info (vout, "using buggy X (remote) server? SSH?");
 330             shmdt (shm);
 331             shm = SHM_ERR;
 332         }
 333     }
 334     else
 335         priv->segment = 0;
 336
 337     const unsigned real_width = pic->p->i_pitch / (p_sys->bpp >> 3);
 338     /* FIXME: anyway to getthing more intuitive than that?? */
 339
 340     /* NOTE: 32-bits scanline_pad assumed, FIXME? (see xdpyinfo) */
 341     xcb_image_t *img;
 342     img = xcb_image_create (real_width, pic->p->i_lines,
 343                             XCB_IMAGE_FORMAT_Z_PIXMAP, 32,
 344                             p_sys->screen->root_depth, p_sys->bpp, p_sys->bpp,
 345 #ifdef WORDS_BIGENDIAN
 346                             XCB_IMAGE_ORDER_MSB_FIRST,
 347 #else
 348                             XCB_IMAGE_ORDER_LSB_FIRST,
 349 #endif
 350                             XCB_IMAGE_ORDER_MSB_FIRST,
 351                             NULL,
 352                             (shm != SHM_ERR) ? size : 0,
 353                             (shm != SHM_ERR) ? shm : NULL);
 354
 355     if (img == NULL)
 356     {
 357         if (shm != SHM_ERR)
 358             xcb_shm_detach (p_sys->conn, priv->segment);
 359         goto error;
 360     }
 361     if (shm != SHM_ERR && xcb_image_native (p_sys->conn, img, 0) == NULL)
 362         msg_Warn (vout, "incompatible X server image format");
 363
 364     priv->conn = p_sys->conn;
 365     priv->image = img;
 366     priv->native = NULL;
 367     pic->p_sys = priv;
 368     pic->p->p_pixels = img->data;
 369     pic->i_status = DESTROYED_PICTURE;
 370     pic->i_type = DIRECT_PICTURE;
 371     return VLC_SUCCESS;
 372
 373 error:
 374     if (shm != SHM_ERR)
 375         shmdt (shm);
 376     free (priv);
 377     return VLC_EGENERIC;
 378 }
 379
 380
 381 /**
 382  * Release picture private data
 383  */
 384 static void PictureDeinit (picture_t *pic)
 385 {
 386     struct picture_sys_t *p_sys = pic->p_sys;
 387
 388     if (p_sys->segment != 0)
 389     {
 390         xcb_shm_detach (p_sys->conn, p_sys->segment);
 391         shmdt (p_sys->image->data);
 392     }
 393     if ((p_sys->native != NULL) && (p_sys->native != p_sys->image))
 394         xcb_image_destroy (p_sys->native);
 395     xcb_image_destroy (p_sys->image);
 396     free (p_sys);
 397 }
 398
 399 /**
 400  * Allocate drawable window and picture buffers.
 401  */
 402 static int Init (vout_thread_t *vout)
 403 {
 404     vout_sys_t *p_sys = vout->p_sys;
 405     const xcb_screen_t *screen = p_sys->screen;
 406     unsigned x, y, width, height;
 407
 408     /* Determine parent window and size */
 409     if (vout->b_fullscreen)
 410     {
 411         p_sys->parent = screen->root;
 412         width = screen->width_in_pixels;
 413         height = screen->height_in_pixels;
 414     }
 415     else
 416     {
 417         p_sys->parent = p_sys->embed->handle.xid;
 418
 419         /* Subscribe to parent window resize events */
 420         const uint32_t value = XCB_EVENT_MASK_STRUCTURE_NOTIFY;
 421         xcb_change_window_attributes (p_sys->conn, p_sys->parent,
 422                                       XCB_CW_EVENT_MASK, &value);
 423
 424         xcb_get_geometry_cookie_t ck;
 425         ck = xcb_get_geometry (p_sys->conn, p_sys->parent);
 426
 427         xcb_get_geometry_reply_t *geo;
 428         xcb_generic_error_t *err;
 429         geo = xcb_get_geometry_reply (p_sys->conn, ck, &err);
 430         width = geo->width;
 431         height = geo->height;
 432         free (geo);
 433     }
 434
 435     vout_PlacePicture (vout, width, height, &x, &y, &width, &height);
 436
 437     /* FIXME: I don't get the subtlety between output and fmt_out here */
 438     vout->fmt_out.i_visible_width = width;
 439     vout->fmt_out.i_visible_height = height;
 440     vout->fmt_out.i_sar_num = vout->fmt_out.i_sar_den = 1;
 441
 442     vout->output.i_width = vout->fmt_out.i_width =
 443         width * vout->fmt_in.i_width / vout->fmt_in.i_visible_width;
 444     vout->output.i_height = vout->fmt_out.i_height =
 445         height * vout->fmt_in.i_height / vout->fmt_in.i_visible_height;
 446     vout->fmt_out.i_x_offset =
 447         width * vout->fmt_in.i_x_offset / vout->fmt_in.i_visible_width;
 448     p_vout->fmt_out.i_y_offset =
 449         height * vout->fmt_in.i_y_offset / vout->fmt_in.i_visible_height;
 450
 451     assert (height > 0);
 452     vout->output.i_aspect = vout->fmt_out.i_aspect =
 453         width * VOUT_ASPECT_FACTOR / height;
 454
 455     /* Create window */
 456     const uint32_t mask = XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK
 457                         | XCB_CW_COLORMAP;
 458     const uint32_t values[] = {
 459         /* XCB_CW_BACK_PIXEL */
 460         screen->black_pixel,
 461         /* XCB_CW_EVENT_MASK */
 462         XCB_EVENT_MASK_BUTTON_PRESS | XCB_EVENT_MASK_BUTTON_RELEASE |
 463         XCB_EVENT_MASK_POINTER_MOTION,
 464         /* XCB_CW_COLORMAP */
 465         p_sys->cmap,
 466     };
 467     xcb_void_cookie_t c;
 468     xcb_window_t window = xcb_generate_id (p_sys->conn);
 469
 470     c = xcb_create_window_checked (p_sys->conn, screen->root_depth, window,
 471                                    p_sys->parent, x, y, width, height, 0,
 472                                    XCB_WINDOW_CLASS_INPUT_OUTPUT,
 473                                    p_sys->vid, mask, values);
 474     if (CheckError (vout, "cannot create X11 window", c))
 475         goto error;
 476     p_sys->window = window;
 477     msg_Dbg (vout, "using X11 window %08"PRIx32, p_sys->window);
 478     xcb_map_window (p_sys->conn, window);
 479
 480     /* Create graphic context (I wonder why the heck do we need this) */
 481     p_sys->gc = xcb_generate_id (p_sys->conn);
 482     xcb_create_gc (p_sys->conn, p_sys->gc, p_sys->window, 0, NULL);
 483     msg_Dbg (vout, "using X11 graphic context %08"PRIx32, p_sys->gc);
 484     xcb_flush (p_sys->conn);
 485
 486     /* Allocate picture buffers */
 487     I_OUTPUTPICTURES = 0;
 488     for (size_t index = 0; I_OUTPUTPICTURES < 2; index++)
 489     {
 490         picture_t *pic = vout->p_picture + index;
 491
 492         if (index > sizeof (vout->p_picture) / sizeof (pic))
 493             break;
 494         if (pic->i_status != FREE_PICTURE)
 495             continue;
 496         if (PictureInit (vout, pic))
 497             break;
 498         PP_OUTPUTPICTURE[I_OUTPUTPICTURES++] = pic;
 499     }
 500
 501     return VLC_SUCCESS;
 502
 503 error:
 504     Deinit (vout);
 505     return VLC_EGENERIC;
 506 }
 507
 508 /**
 509  * Free picture buffers.
 510  */
 511 static void Deinit (vout_thread_t *vout)
 512 {
 513     vout_sys_t *p_sys = vout->p_sys;
 514
 515     while (I_OUTPUTPICTURES > 0)
 516         PictureDeinit (PP_OUTPUTPICTURE[--I_OUTPUTPICTURES]);
 517
 518     xcb_unmap_window (p_sys->conn, p_sys->window);
 519     xcb_destroy_window (p_sys->conn, p_sys->window);
 520 }
 521
 522 /**
 523  * Prepares an image ahead of display.
 524  */
 525 static void Render (vout_thread_t *vout, picture_t *pic)
 526 {
 527     vout_sys_t *p_sys = vout->p_sys;
 528     picture_sys_t *priv = pic->p_sys;
 529
 530     if ((priv->native != NULL) && (priv->native != priv->image))
 531         xcb_image_destroy (priv->native);
 532     priv->native = xcb_image_native (p_sys->conn, priv->image, 1);
 533 }
 534
 535
 536 /**
 537  * Sends an image to the X server.
 538  */
 539 static void Display (vout_thread_t *vout, picture_t *pic)
 540 {
 541     vout_sys_t *p_sys = vout->p_sys;
 542     picture_sys_t *priv = pic->p_sys;
 543     xcb_image_t *img = priv->image, *native = priv->native;
 544
 545     if ((native == img) && (img->base == NULL))
 546     {
 547         xcb_shm_segment_info_t info = {
 548             .shmseg = priv->segment,
 549             .shmid = -1, /* lost track of it, unimportant */
 550             .shmaddr = img->data,
 551         };
 552
 553         xcb_image_shm_put (p_sys->conn, p_sys->window, p_sys->gc, img, info,
 554                         0, 0, 0, 0, img->width, img->height, 0);
 555     }
 556     else
 557     if (native != NULL)
 558         xcb_image_put (p_sys->conn, p_sys->window, p_sys->gc, native, 0, 0, 0);
 559     xcb_flush (p_sys->conn);
 560 }
 561
 562 /**
 563  * Process incoming X events.
 564  */
 565 static int Manage (vout_thread_t *vout)
 566 {
 567     vout_sys_t *p_sys = vout->p_sys;
 568     xcb_generic_event_t *ev;
 569
 570     while ((ev = xcb_poll_for_event (p_sys->conn)) != NULL)
 571         ProcessEvent (vout, p_sys->conn, p_sys->window, ev);
 572
 573     if (xcb_connection_has_error (p_sys->conn))
 574     {
 575         msg_Err (vout, "X server failure");
 576         return VLC_EGENERIC;
 577     }
 578     return VLC_SUCCESS;
 579 }