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 {
 105     vout_display_sys_t *sys = vd->sys;
 106
 107     xcb_get_geometry_reply_t *geo =
 108         xcb_get_geometry_reply (conn,
 109             xcb_get_geometry (conn, sys->embed->xid), NULL);
 110     if (geo == NULL)
 111     {
 112         msg_Err (vd, "parent window not valid");
 113         return NULL;
 114     }
 115
 116     xcb_window_t root = geo->root;
 117     *pdepth = geo->depth;
 118     free (geo);
 119
 120     /* Find the selected screen */
 121     const xcb_setup_t *setup = xcb_get_setup (conn);
 122     const xcb_screen_t *screen = NULL;
 123     unsigned num = 0;
 124
 125     for (xcb_screen_iterator_t i = xcb_setup_roots_iterator (setup);
 126          i.rem > 0;
 127          xcb_screen_next (&i))
 128     {
 129         if (i.data->root == root)
 130         {
 131             screen = i.data;
 132             break;
 133         }
 134         num++;
 135     }
 136
 137     if (screen == NULL)
 138     {
 139         msg_Err (vd, "parent window screen not found");
 140         return NULL;
 141     }
 142     msg_Dbg (vd, "using screen 0x%"PRIx32 " (number: %u)", root, num);
 143     *pnum = num;
 144     return screen;
 145 }
 146
 147 static bool CheckGLX (vout_display_t *vd, Display *dpy, bool *restrict pv13)
 148 {
 149     int major, minor;
 150     bool ok = false;
 151
 152     if (!glXQueryVersion (dpy, &major, &minor))
 153         msg_Dbg (vd, "GLX extension not available");
 154     else
 155     if (major != 1)
 156         msg_Dbg (vd, "GLX extension version %d.%d unknown", major, minor);
 157     else
 158     if (minor < 2)
 159         msg_Dbg (vd, "GLX extension version %d.%d too old", major, minor);
 160     else
 161     {
 162         msg_Dbg (vd, "using GLX extension version %d.%d", major, minor);
 163         ok = true;
 164         *pv13 = minor >= 3;
 165     }
 166     return ok;
 167 }
 168
 169 static int CreateWindow (vout_display_t *vd, xcb_connection_t *conn,
 170                          uint_fast8_t depth, xcb_visualid_t vid)
 171 {
 172     vout_display_sys_t *sys = vd->sys;
 173
 174     unsigned width, height;
 175     if (GetWindowSize (sys->embed, conn, &width, &height))
 176         return VLC_EGENERIC;
 177
 178     const uint32_t mask = XCB_CW_EVENT_MASK;
 179     const uint32_t values[] = {
 180         /* XCB_CW_EVENT_MASK */
 181         XCB_EVENT_MASK_VISIBILITY_CHANGE,
 182     };
 183     xcb_void_cookie_t cc, cm;
 184
 185     cc = xcb_create_window_checked (conn, depth, sys->window,
 186                                     sys->embed->xid, 0, 0, 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     const xcb_screen_t *scr = FindWindow (vd, conn, &snum, &depth);
 244     if (scr == NULL)
 245         goto error;
 246
 247     sys->window = xcb_generate_id (conn);
 248
 249     /* Determine our pixel format */
 250     if (sys->v1_3)
 251     {   /* GLX 1.3 */
 252         static const int attr[] = {
 253             GLX_RED_SIZE, 5,
 254             GLX_GREEN_SIZE, 5,
 255             GLX_BLUE_SIZE, 5,
 256             GLX_DOUBLEBUFFER, True,
 257             GLX_X_RENDERABLE, True,
 258             GLX_DRAWABLE_TYPE, GLX_WINDOW_BIT,
 259             None };
 260
 261         int nelem;
 262         GLXFBConfig *confs = glXChooseFBConfig (dpy, snum, attr, &nelem);
 263         if (confs == NULL)
 264         {
 265             msg_Err (vd, "no GLX frame bufer configurations");
 266             goto error;
 267         }
 268
 269         /*XVisualInfo *vi = glXGetVisualFromFBConfig (dpy, confs[0]);*/
 270         CreateWindow (vd, conn, depth, 0 /* ??? */);
 271         /*XFree (vi);*/
 272
 273         sys->glwin = glXCreateWindow (dpy, confs[0], sys->window, NULL );
 274         if (sys->glwin == None)
 275         {
 276             msg_Err (vd, "cannot create GLX window");
 277             XFree (confs);
 278             goto error;
 279         }
 280
 281         /* Create an OpenGL context */
 282         sys->ctx = glXCreateNewContext (dpy, confs[0], GLX_RGBA_TYPE, NULL,
 283                                         True);
 284         XFree (confs);
 285         if (sys->ctx == NULL)
 286         {
 287             msg_Err (vd, "cannot create GLX context");
 288             goto error;
 289         }
 290
 291         if (glXMakeContextCurrent (dpy, sys->glwin, sys->glwin, sys->ctx))
 292             goto error;
 293     }
 294     else
 295     {   /* GLX 1.2 */
 296         int attr[] = {
 297             GLX_RGBA,
 298             GLX_RED_SIZE, 5,
 299             GLX_GREEN_SIZE, 5,
 300             GLX_BLUE_SIZE, 5,
 301             GLX_DOUBLEBUFFER,
 302             None };
 303
 304         XVisualInfo *vi = glXChooseVisual (dpy, snum, attr);
 305         if (vi == NULL)
 306         {
 307             msg_Err (vd, "cannot find GLX 1.2 visual" );
 308             goto error;
 309         }
 310         msg_Dbg (vd, "using GLX visual ID 0x%"PRIx32, (uint32_t)vi->visualid);
 311
 312         if (CreateWindow (vd, conn, depth, 0 /* ??? */) == 0)
 313             sys->ctx = glXCreateContext (dpy, vi, 0, True);
 314         XFree (vi);
 315         if (sys->ctx == NULL)
 316         {
 317             msg_Err (vd, "cannot create GLX context");
 318             goto error;
 319         }
 320
 321         if (glXMakeCurrent (dpy, sys->window, sys->ctx) == False)
 322             goto error;
 323         sys->glwin = sys->window;
 324     }
 325
 326     /* Initialize common OpenGL video display */
 327     sys->gl.lock = NULL;
 328     sys->gl.unlock = NULL;
 329     sys->gl.swap = SwapBuffers;
 330     sys->gl.sys = sys;
 331
 332     if (vout_display_opengl_Init (&sys->vgl, &vd->fmt, &sys->gl))
 333     {
 334         sys->gl.sys = NULL;
 335         goto error;
 336     }
 337
 338     sys->cursor = CreateBlankCursor (conn, scr);
 339     sys->visible = false;
 340
 341     /* */
 342     vout_display_info_t info = vd->info;
 343     info.has_pictures_invalid = false;
 344
 345     /* Setup vout_display_t once everything is fine */
 346     vd->info = info;
 347
 348     vd->get = Get;
 349     vd->prepare = PictureRender;
 350     vd->display = PictureDisplay;
 351     vd->control = Control;
 352     vd->manage = Manage;
 353
 354     /* */
 355     vout_display_SendEventFullscreen (vd, false);
 356     //vout_display_SendEventDisplaySize (vd, width, height, false);
 357
 358     return VLC_SUCCESS;
 359
 360 error:
 361     Close (obj);
 362     return VLC_EGENERIC;
 363 }
 364
 365
 366 /**
 367  * Disconnect from the X server.
 368  */
 369 static void Close (vlc_object_t *obj)
 370 {
 371     vout_display_t *vd = (vout_display_t *)obj;
 372     vout_display_sys_t *sys = vd->sys;
 373     Display *dpy = sys->display;
 374
 375     if (sys->gl.sys != NULL)
 376         vout_display_opengl_Clean (&sys->vgl);
 377
 378     if (sys->ctx != NULL)
 379     {
 380         if (sys->v1_3)
 381         {
 382             glXMakeContextCurrent (dpy, None, None, NULL);
 383             glXDestroyWindow (dpy, sys->glwin);
 384         }
 385         else
 386             glXMakeCurrent (dpy, None, NULL);
 387         glXDestroyContext (dpy, sys->ctx);
 388     }
 389     XCloseDisplay (dpy);
 390     vout_display_DeleteWindow (vd, sys->embed);
 391     free (sys);
 392 }
 393
 394 static void SwapBuffers (vout_opengl_t *gl)
 395 {
 396     vout_display_sys_t *sys = gl->sys;
 397
 398     glXSwapBuffers (sys->display, sys->glwin);
 399 }
 400
 401 /**
 402  * Return a direct buffer
 403  */
 404 static picture_t *Get (vout_display_t *vd)
 405 {
 406     vout_display_sys_t *sys = vd->sys;
 407
 408     if (!sys->pool)
 409     {
 410         sys->pool = vout_display_opengl_GetPool (&sys->vgl);
 411         if (!sys->pool)
 412             return NULL;
 413     }
 414     return picture_pool_Get (sys->pool);
 415 }
 416
 417 static void PictureRender (vout_display_t *vd, picture_t *pic)
 418 {
 419    vout_display_sys_t *sys = vd->sys;
 420
 421     vout_display_opengl_Prepare (&sys->vgl, pic);
 422 }
 423
 424 static void PictureDisplay (vout_display_t *vd, picture_t *pic)
 425 {
 426     vout_display_sys_t *sys = vd->sys;
 427
 428     vout_display_opengl_Display (&sys->vgl, &vd->source);
 429     picture_Release (pic);
 430 }
 431
 432 static int Control (vout_display_t *vd, int query, va_list ap)
 433 {
 434     vout_display_sys_t *sys = vd->sys;
 435
 436     switch (query)
 437     {
 438     case VOUT_DISPLAY_CHANGE_FULLSCREEN:
 439     {
 440         const vout_display_cfg_t *c = va_arg (ap, const vout_display_cfg_t *);
 441         return vout_window_SetFullScreen (sys->embed, c->is_fullscreen);
 442     }
 443
 444     case VOUT_DISPLAY_CHANGE_ON_TOP:
 445     {
 446         int b_on_top = (int)va_arg (ap, int);
 447         return vout_window_SetOnTop (sys->embed, b_on_top);
 448     }
 449
 450     case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
 451     case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
 452     case VOUT_DISPLAY_CHANGE_ZOOM:
 453     case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
 454     case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
 455         msg_Err (vd, "unimplemented control request");
 456         return VLC_EGENERIC;
 457
 458     /* Hide the mouse. It will be send when
 459      * vout_display_t::info.b_hide_mouse is false */
 460     case VOUT_DISPLAY_HIDE_MOUSE:
 461         xcb_change_window_attributes (XGetXCBConnection (sys->display),
 462                                       sys->embed->xid,
 463                                     XCB_CW_CURSOR, &(uint32_t){ sys->cursor });
 464         return VLC_SUCCESS;
 465     case VOUT_DISPLAY_RESET_PICTURES:
 466         assert (0);
 467     default:
 468         msg_Err (vd, "Unknown request in XCB vout display");
 469         return VLC_EGENERIC;
 470     }
 471 }
 472
 473 static void Manage (vout_display_t *vd)
 474 {
 475     vout_display_sys_t *sys = vd->sys;
 476     xcb_connection_t *conn = XGetXCBConnection (sys->display);
 477
 478     ManageEvent (vd, conn, &sys->visible);
 479 }