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

   1 /**
   2  * @file glx.c
   3  * @brief GLX video output module for VLC media player
   4  */
   5 /*****************************************************************************
   6  * Copyright © 2004 the VideoLAN team
   7  * Copyright © 2009 Rémi Denis-Courmont
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * as published by the Free Software Foundation; either version 2
  12  * of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  22  ****************************************************************************/
  23
  24 #ifdef HAVE_CONFIG_H
  25 # include <config.h>
  26 #endif
  27
  28 #include <stdlib.h>
  29 #include <assert.h>
  30
  31 #include <xcb/xcb.h>
  32 #include <X11/Xlib-xcb.h>
  33 #include <GL/glx.h>
  34
  35 #include <vlc_common.h>
  36 #include <vlc_plugin.h>
  37 #include <vlc_vout_display.h>
  38 #include <vlc_vout_opengl.h>
  39 #include "../opengl.h"
  40
  41 #include "xcb_vlc.h"
  42
  43 static int  Open (vlc_object_t *);
  44 static void Close (vlc_object_t *);
  45
  46 /*
  47  * Module descriptor
  48  */
  49 vlc_module_begin ()
  50     set_shortname (N_("GLX"))
  51     set_description (N_("GLX video output (XCB)"))
  52     set_category (CAT_VIDEO)
  53     set_subcategory (SUBCAT_VIDEO_VOUT)
  54     set_capability ("vout display", 20)
  55     set_callbacks (Open, Close)
  56
  57     add_shortcut ("xcb-glx")
  58     add_shortcut ("glx")
  59 vlc_module_end ()
  60
  61 struct vout_display_sys_t
  62 {
  63     Display *display; /* Xlib instance */
  64     vout_window_t *embed; /* VLC window (when windowed) */
  65
  66     xcb_cursor_t cursor; /* blank cursor */
  67     xcb_window_t window; /* drawable X window */
  68     xcb_window_t glwin; /* GLX window */
  69     bool visible; /* whether to draw */
  70     bool v1_3; /* whether GLX >= 1.3 is available */
  71
  72     GLXContext ctx;
  73     vout_opengl_t gl;
  74     vout_display_opengl_t vgl;
  75     picture_pool_t *pool; /* picture pool */
  76 };
  77
  78 static picture_t *Get (vout_display_t *);
  79 static void PictureRender (vout_display_t *, picture_t *);
  80 static void PictureDisplay (vout_display_t *, picture_t *);
  81 static int Control (vout_display_t *, int, va_list);
  82 static void Manage (vout_display_t *);
  83
  84 static void SwapBuffers (vout_opengl_t *gl);
  85
  86 static vout_window_t *MakeWindow (vout_display_t *vd)
  87 {
  88     vout_window_cfg_t wnd_cfg;
  89
  90     memset (&wnd_cfg, 0, sizeof (wnd_cfg));
  91     wnd_cfg.type = VOUT_WINDOW_TYPE_XID;
  92     wnd_cfg.width  = vd->cfg->display.width;
  93     wnd_cfg.height = vd->cfg->display.height;
  94
  95     vout_window_t *wnd = vout_display_NewWindow (vd, &wnd_cfg);
  96     if (wnd == NULL)
  97         msg_Err (vd, "parent window not available");
  98     return wnd;
  99 }
 100
 101 static const xcb_screen_t *
 102 FindWindow (vout_display_t *vd, xcb_connection_t *conn,
 103             unsigned *restrict pnum, uint8_t *restrict pdepth,
 104             uint16_t *restrict pwidth, uint16_t *restrict pheight)
 105 {
 106     vout_display_sys_t *sys = vd->sys;
 107
 108     xcb_get_geometry_reply_t *geo =
 109         xcb_get_geometry_reply (conn,
 110             xcb_get_geometry (conn, sys->embed->xid), NULL);
 111     if (geo == NULL)
 112     {
 113         msg_Err (vd, "parent window not valid");
 114         return NULL;
 115     }
 116
 117     xcb_window_t root = geo->root;
 118     *pdepth = geo->depth;
 119     *pwidth = geo->width;
 120     *pheight = geo->height;
 121     free (geo);
 122
 123     /* Find the selected screen */
 124     const xcb_setup_t *setup = xcb_get_setup (conn);
 125     const xcb_screen_t *screen = NULL;
 126     unsigned num = 0;
 127
 128     for (xcb_screen_iterator_t i = xcb_setup_roots_iterator (setup);
 129          i.rem > 0;
 130          xcb_screen_next (&i))
 131     {
 132         if (i.data->root == root)
 133         {
 134             screen = i.data;
 135             break;
 136         }
 137         num++;
 138     }
 139
 140     if (screen == NULL)
 141     {
 142         msg_Err (vd, "parent window screen not found");
 143         return NULL;
 144     }
 145     msg_Dbg (vd, "using screen 0x%"PRIx32 " (number: %u)", root, num);
 146     *pnum = num;
 147     return screen;
 148 }
 149
 150 static bool CheckGLX (vout_display_t *vd, Display *dpy, bool *restrict pv13)
 151 {
 152     int major, minor;
 153     bool ok = false;
 154
 155     if (!glXQueryVersion (dpy, &major, &minor))
 156         msg_Dbg (vd, "GLX extension not available");
 157     else
 158     if (major != 1)
 159         msg_Dbg (vd, "GLX extension version %d.%d unknown", major, minor);
 160     else
 161     if (minor < 2)
 162         msg_Dbg (vd, "GLX extension version %d.%d too old", major, minor);
 163     else
 164     {
 165         msg_Dbg (vd, "using GLX extension version %d.%d", major, minor);
 166         ok = true;
 167         *pv13 = minor >= 3;
 168     }
 169     return ok;
 170 }
 171
 172 static int CreateWindow (vout_display_t *vd, xcb_connection_t *conn,
 173                          uint_fast8_t depth, xcb_visualid_t vid,
 174                          uint_fast16_t width, uint_fast16_t height)
 175 {
 176     vout_display_sys_t *sys = vd->sys;
 177     const uint32_t mask = XCB_CW_EVENT_MASK;
 178     const uint32_t values[] = {
 179         /* XCB_CW_EVENT_MASK */
 180         XCB_EVENT_MASK_VISIBILITY_CHANGE,
 181     };
 182     xcb_void_cookie_t cc, cm;
 183
 184     cc = xcb_create_window_checked (conn, depth, sys->window,
 185                                     sys->embed->xid, 0, 0,
 186                                     width, height, 0,
 187                                     XCB_WINDOW_CLASS_INPUT_OUTPUT,
 188                                     vid, mask, values);
 189     cm = xcb_map_window_checked (conn, sys->window);
 190     if (CheckError (vd, conn, "cannot create X11 window", cc)
 191      || CheckError (vd, conn, "cannot map X11 window", cm))
 192         return VLC_EGENERIC;
 193
 194     msg_Dbg (vd, "using X11 window %08"PRIx32, sys->window);
 195     return VLC_SUCCESS;
 196 }
 197
 198 /**
 199  * Probe the X server.
 200  */
 201 static int Open (vlc_object_t *obj)
 202 {
 203     vout_display_t *vd = (vout_display_t *)obj;
 204     vout_display_sys_t *sys = malloc (sizeof (*sys));
 205
 206     if (sys == NULL)
 207         return VLC_ENOMEM;
 208
 209     vd->sys = sys;
 210     sys->pool = NULL;
 211     sys->gl.sys = NULL;
 212
 213     /* Get window */
 214     sys->embed = MakeWindow (vd);
 215     if (sys->embed == NULL)
 216     {
 217         free (sys);
 218         return VLC_EGENERIC;
 219     }
 220
 221     /* Connect to X server */
 222     Display *dpy = XOpenDisplay (sys->embed->x11_display);
 223     if (dpy == NULL)
 224     {
 225         vout_display_DeleteWindow (vd, sys->embed);
 226         free (sys);
 227         return VLC_EGENERIC;
 228     }
 229     sys->display = dpy;
 230     sys->ctx = NULL;
 231     XSetEventQueueOwner (dpy, XCBOwnsEventQueue);
 232
 233     if (!CheckGLX (vd, dpy, &sys->v1_3))
 234         goto error;
 235
 236     xcb_connection_t *conn = XGetXCBConnection (dpy);
 237     assert (conn);
 238     RegisterMouseEvents (obj, conn, sys->embed->xid);
 239
 240     /* Find window parameters */
 241     unsigned snum;
 242     uint8_t depth;
 243     uint16_t width, height;
 244     const xcb_screen_t *scr = FindWindow (vd, conn, &snum, &depth,
 245                                           &width, &height);
 246     if (scr == NULL)
 247         goto error;
 248
 249     sys->window = xcb_generate_id (conn);
 250
 251     /* Determine our pixel format */
 252     if (sys->v1_3)
 253     {   /* GLX 1.3 */
 254         static const int attr[] = {
 255             GLX_RED_SIZE, 5,
 256             GLX_GREEN_SIZE, 5,
 257             GLX_BLUE_SIZE, 5,
 258             GLX_DOUBLEBUFFER, True,
 259             GLX_X_RENDERABLE, True,
 260             GLX_DRAWABLE_TYPE, GLX_WINDOW_BIT,
 261             None };
 262
 263         int nelem;
 264         GLXFBConfig *confs = glXChooseFBConfig (dpy, snum, attr, &nelem);
 265         if (confs == NULL)
 266         {
 267             msg_Err (vd, "no GLX frame bufer configurations");
 268             goto error;
 269         }
 270
 271         /*XVisualInfo *vi = glXGetVisualFromFBConfig (dpy, confs[0]);*/
 272         CreateWindow (vd, conn, depth, 0 /* ??? */, width, height);
 273         /*XFree (vi);*/
 274
 275         sys->glwin = glXCreateWindow (dpy, confs[0], sys->window, NULL );
 276         if (sys->glwin == None)
 277         {
 278             msg_Err (vd, "cannot create GLX window");
 279             XFree (confs);
 280             goto error;
 281         }
 282
 283         /* Create an OpenGL context */
 284         sys->ctx = glXCreateNewContext (dpy, confs[0], GLX_RGBA_TYPE, NULL,
 285                                         True);
 286         XFree (confs);
 287         if (sys->ctx == NULL)
 288         {
 289             msg_Err (vd, "cannot create GLX context");
 290             goto error;
 291         }
 292
 293         if (!glXMakeContextCurrent (dpy, sys->glwin, sys->glwin, sys->ctx))
 294             goto error;
 295     }
 296     else
 297     {   /* GLX 1.2 */
 298         int attr[] = {
 299             GLX_RGBA,
 300             GLX_RED_SIZE, 5,
 301             GLX_GREEN_SIZE, 5,
 302             GLX_BLUE_SIZE, 5,
 303             GLX_DOUBLEBUFFER,
 304             None };
 305
 306         XVisualInfo *vi = glXChooseVisual (dpy, snum, attr);
 307         if (vi == NULL)
 308         {
 309             msg_Err (vd, "cannot find GLX 1.2 visual" );
 310             goto error;
 311         }
 312         msg_Dbg (vd, "using GLX visual ID 0x%"PRIx32, (uint32_t)vi->visualid);
 313
 314         if (CreateWindow (vd, conn, depth, 0 /* ??? */, width, height) == 0)
 315             sys->ctx = glXCreateContext (dpy, vi, 0, True);
 316         XFree (vi);
 317         if (sys->ctx == NULL)
 318         {
 319             msg_Err (vd, "cannot create GLX context");
 320             goto error;
 321         }
 322
 323         if (glXMakeCurrent (dpy, sys->window, sys->ctx) == False)
 324             goto error;
 325         sys->glwin = sys->window;
 326     }
 327
 328     /* Initialize common OpenGL video display */
 329     sys->gl.lock = NULL;
 330     sys->gl.unlock = NULL;
 331     sys->gl.swap = SwapBuffers;
 332     sys->gl.sys = sys;
 333
 334     if (vout_display_opengl_Init (&sys->vgl, &vd->fmt, &sys->gl))
 335     {
 336         sys->gl.sys = NULL;
 337         goto error;
 338     }
 339
 340     sys->cursor = CreateBlankCursor (conn, scr);
 341     sys->visible = false;
 342
 343     /* */
 344     vout_display_info_t info = vd->info;
 345     info.has_pictures_invalid = false;
 346
 347     /* Setup vout_display_t once everything is fine */
 348     vd->info = info;
 349
 350     vd->get = Get;
 351     vd->prepare = PictureRender;
 352     vd->display = PictureDisplay;
 353     vd->control = Control;
 354     vd->manage = Manage;
 355
 356     /* */
 357     vout_display_SendEventFullscreen (vd, false);
 358     vout_display_SendEventDisplaySize (vd, width, height, false);
 359
 360     return VLC_SUCCESS;
 361
 362 error:
 363     Close (obj);
 364     return VLC_EGENERIC;
 365 }
 366
 367
 368 /**
 369  * Disconnect from the X server.
 370  */
 371 static void Close (vlc_object_t *obj)
 372 {
 373     vout_display_t *vd = (vout_display_t *)obj;
 374     vout_display_sys_t *sys = vd->sys;
 375     Display *dpy = sys->display;
 376
 377     if (sys->gl.sys != NULL)
 378         vout_display_opengl_Clean (&sys->vgl);
 379
 380     if (sys->ctx != NULL)
 381     {
 382         if (sys->v1_3)
 383         {
 384             glXMakeContextCurrent (dpy, None, None, NULL);
 385             glXDestroyWindow (dpy, sys->glwin);
 386         }
 387         else
 388             glXMakeCurrent (dpy, None, NULL);
 389         glXDestroyContext (dpy, sys->ctx);
 390     }
 391     XCloseDisplay (dpy);
 392     vout_display_DeleteWindow (vd, sys->embed);
 393     free (sys);
 394 }
 395
 396 static void SwapBuffers (vout_opengl_t *gl)
 397 {
 398     vout_display_sys_t *sys = gl->sys;
 399
 400     glXSwapBuffers (sys->display, sys->glwin);
 401 }
 402
 403 /**
 404  * Return a direct buffer
 405  */
 406 static picture_t *Get (vout_display_t *vd)
 407 {
 408     vout_display_sys_t *sys = vd->sys;
 409
 410     if (!sys->pool)
 411     {
 412         sys->pool = vout_display_opengl_GetPool (&sys->vgl);
 413         if (!sys->pool)
 414             return NULL;
 415     }
 416     return picture_pool_Get (sys->pool);
 417 }
 418
 419 static void PictureRender (vout_display_t *vd, picture_t *pic)
 420 {
 421    vout_display_sys_t *sys = vd->sys;
 422
 423     vout_display_opengl_Prepare (&sys->vgl, pic);
 424 }
 425
 426 static void PictureDisplay (vout_display_t *vd, picture_t *pic)
 427 {
 428     vout_display_sys_t *sys = vd->sys;
 429
 430     vout_display_opengl_Display (&sys->vgl, &vd->source);
 431     picture_Release (pic);
 432 }
 433
 434 static int Control (vout_display_t *vd, int query, va_list ap)
 435 {
 436     vout_display_sys_t *sys = vd->sys;
 437
 438     switch (query)
 439     {
 440     case VOUT_DISPLAY_CHANGE_FULLSCREEN:
 441     {
 442         const vout_display_cfg_t *c = va_arg (ap, const vout_display_cfg_t *);
 443         return vout_window_SetFullScreen (sys->embed, c->is_fullscreen);
 444     }
 445
 446     case VOUT_DISPLAY_CHANGE_ON_TOP:
 447     {
 448         int b_on_top = (int)va_arg (ap, int);
 449         return vout_window_SetOnTop (sys->embed, b_on_top);
 450     }
 451
 452     case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
 453     case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
 454     case VOUT_DISPLAY_CHANGE_ZOOM:
 455     case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
 456     case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
 457     {
 458         xcb_connection_t *conn = XGetXCBConnection (sys->display);
 459         const vout_display_cfg_t *cfg;
 460         const video_format_t *source;
 461         bool is_forced = false;
 462
 463         if (query == VOUT_DISPLAY_CHANGE_SOURCE_ASPECT
 464          || query == VOUT_DISPLAY_CHANGE_SOURCE_CROP)
 465         {
 466             source = (const video_format_t *)va_arg (ap, const video_format_t *);
 467             cfg = vd->cfg;
 468         }
 469         else
 470         {
 471             source = &vd->source;
 472             cfg = (const vout_display_cfg_t*)va_arg (ap, const vout_display_cfg_t *);
 473             if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE)
 474                 is_forced = (bool)va_arg (ap, int);
 475         }
 476
 477         /* */
 478         if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE
 479          && is_forced
 480          && (cfg->display.width  != vd->cfg->display.width
 481            ||cfg->display.height != vd->cfg->display.height)
 482          && vout_window_SetSize (sys->embed,
 483                                  cfg->display.width, cfg->display.height))
 484             return VLC_EGENERIC;
 485
 486         vout_display_place_t place;
 487         vout_display_PlacePicture (&place, source, cfg, false);
 488
 489         /* Move the picture within the window */
 490         const uint32_t values[] = { place.x, place.y,
 491                                     place.width, place.height, };
 492         xcb_void_cookie_t ck =
 493             xcb_configure_window_checked (conn, sys->window,
 494                             XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y
 495                           | XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
 496                               values);
 497         if (CheckError (vd, conn, "cannot resize X11 window", ck))
 498             return VLC_EGENERIC;
 499
 500         glViewport (0, 0, place.width, place.height);
 501         return VLC_SUCCESS;
 502     }
 503
 504     /* Hide the mouse. It will be send when
 505      * vout_display_t::info.b_hide_mouse is false */
 506     case VOUT_DISPLAY_HIDE_MOUSE:
 507         xcb_change_window_attributes (XGetXCBConnection (sys->display),
 508                                       sys->embed->xid,
 509                                     XCB_CW_CURSOR, &(uint32_t){ sys->cursor });
 510         return VLC_SUCCESS;
 511     case VOUT_DISPLAY_RESET_PICTURES:
 512         assert (0);
 513     default:
 514         msg_Err (vd, "Unknown request in XCB vout display");
 515         return VLC_EGENERIC;
 516     }
 517 }
 518
 519 static void Manage (vout_display_t *vd)
 520 {
 521     vout_display_sys_t *sys = vd->sys;
 522     xcb_connection_t *conn = XGetXCBConnection (sys->display);
 523
 524     ManageEvent (vd, conn, &sys->visible);
 525 }