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