3 * @brief GLX video output module for VLC media player
5 /*****************************************************************************
6 * Copyright © 2004 the VideoLAN team
7 * Copyright © 2009 Rémi Denis-Courmont
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.
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.
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 ****************************************************************************/
32 #include <X11/Xlib-xcb.h>
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"
43 static int Open (vlc_object_t *);
44 static void Close (vlc_object_t *);
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)
57 add_shortcut ("xcb-glx")
61 struct vout_display_sys_t
63 Display *display; /* Xlib instance */
64 vout_window_t *embed; /* VLC window (when windowed) */
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 */
74 vout_display_opengl_t vgl;
75 picture_pool_t *pool; /* picture pool */
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 *);
84 static void SwapBuffers (vout_opengl_t *gl);
86 static vout_window_t *MakeWindow (vout_display_t *vd)
88 vout_window_cfg_t wnd_cfg;
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;
95 vout_window_t *wnd = vout_display_NewWindow (vd, &wnd_cfg);
97 msg_Err (vd, "parent window not available");
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)
106 vout_display_sys_t *sys = vd->sys;
108 xcb_get_geometry_reply_t *geo =
109 xcb_get_geometry_reply (conn,
110 xcb_get_geometry (conn, sys->embed->xid), NULL);
113 msg_Err (vd, "parent window not valid");
117 xcb_window_t root = geo->root;
118 *pdepth = geo->depth;
119 *pwidth = geo->width;
120 *pheight = geo->height;
123 /* Find the selected screen */
124 const xcb_setup_t *setup = xcb_get_setup (conn);
125 const xcb_screen_t *screen = NULL;
128 for (xcb_screen_iterator_t i = xcb_setup_roots_iterator (setup);
130 xcb_screen_next (&i))
132 if (i.data->root == root)
142 msg_Err (vd, "parent window screen not found");
145 msg_Dbg (vd, "using screen 0x%"PRIx32 " (number: %u)", root, num);
150 static bool CheckGLX (vout_display_t *vd, Display *dpy, bool *restrict pv13)
155 if (!glXQueryVersion (dpy, &major, &minor))
156 msg_Dbg (vd, "GLX extension not available");
159 msg_Dbg (vd, "GLX extension version %d.%d unknown", major, minor);
162 msg_Dbg (vd, "GLX extension version %d.%d too old", major, minor);
165 msg_Dbg (vd, "using GLX extension version %d.%d", major, minor);
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)
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,
182 xcb_void_cookie_t cc, cm;
184 cc = xcb_create_window_checked (conn, depth, sys->window,
185 sys->embed->xid, 0, 0,
187 XCB_WINDOW_CLASS_INPUT_OUTPUT,
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))
194 msg_Dbg (vd, "using X11 window %08"PRIx32, sys->window);
199 * Probe the X server.
201 static int Open (vlc_object_t *obj)
203 vout_display_t *vd = (vout_display_t *)obj;
204 vout_display_sys_t *sys = malloc (sizeof (*sys));
214 sys->embed = MakeWindow (vd);
215 if (sys->embed == NULL)
221 /* Connect to X server */
222 Display *dpy = XOpenDisplay (sys->embed->x11_display);
225 vout_display_DeleteWindow (vd, sys->embed);
231 XSetEventQueueOwner (dpy, XCBOwnsEventQueue);
233 if (!CheckGLX (vd, dpy, &sys->v1_3))
236 xcb_connection_t *conn = XGetXCBConnection (dpy);
238 RegisterMouseEvents (obj, conn, sys->embed->xid);
240 /* Find window parameters */
243 uint16_t width, height;
244 const xcb_screen_t *scr = FindWindow (vd, conn, &snum, &depth,
249 sys->window = xcb_generate_id (conn);
251 /* Determine our pixel format */
254 static const int attr[] = {
258 GLX_DOUBLEBUFFER, True,
259 GLX_X_RENDERABLE, True,
260 GLX_DRAWABLE_TYPE, GLX_WINDOW_BIT,
263 xcb_get_window_attributes_reply_t *wa =
264 xcb_get_window_attributes_reply (conn,
265 xcb_get_window_attributes (conn, sys->embed->xid), NULL);
268 xcb_visualid_t visual = wa->visual;
272 GLXFBConfig *confs = glXChooseFBConfig (dpy, snum, attr, &nelem);
275 msg_Err (vd, "no GLX frame bufer configurations");
282 for (int i = 0; i < nelem && !found; i++)
286 XVisualInfo *vi = glXGetVisualFromFBConfig (dpy, conf);
290 if (vi->visualid == visual)
298 msg_Err (vd, "no matching GLX frame buffer configuration");
303 if (!CreateWindow (vd, conn, depth, 0 /* ??? */, width, height))
304 sys->glwin = glXCreateWindow (dpy, conf, sys->window, NULL );
305 if (sys->glwin == None)
307 msg_Err (vd, "cannot create GLX window");
311 /* Create an OpenGL context */
312 sys->ctx = glXCreateNewContext (dpy, conf, GLX_RGBA_TYPE, NULL,
314 if (sys->ctx == NULL)
316 msg_Err (vd, "cannot create GLX context");
320 if (!glXMakeContextCurrent (dpy, sys->glwin, sys->glwin, sys->ctx))
333 XVisualInfo *vi = glXChooseVisual (dpy, snum, attr);
336 msg_Err (vd, "cannot find GLX 1.2 visual" );
339 msg_Dbg (vd, "using GLX visual ID 0x%"PRIx32, (uint32_t)vi->visualid);
341 if (CreateWindow (vd, conn, depth, 0 /* ??? */, width, height) == 0)
342 sys->ctx = glXCreateContext (dpy, vi, 0, True);
344 if (sys->ctx == NULL)
346 msg_Err (vd, "cannot create GLX context");
350 if (glXMakeCurrent (dpy, sys->window, sys->ctx) == False)
352 sys->glwin = sys->window;
355 /* Initialize common OpenGL video display */
357 sys->gl.unlock = NULL;
358 sys->gl.swap = SwapBuffers;
361 if (vout_display_opengl_Init (&sys->vgl, &vd->fmt, &sys->gl))
367 sys->cursor = CreateBlankCursor (conn, scr);
368 sys->visible = false;
371 vout_display_info_t info = vd->info;
372 info.has_pictures_invalid = false;
374 /* Setup vout_display_t once everything is fine */
378 vd->prepare = PictureRender;
379 vd->display = PictureDisplay;
380 vd->control = Control;
384 vout_display_SendEventFullscreen (vd, false);
385 vout_display_SendEventDisplaySize (vd, width, height, false);
396 * Disconnect from the X server.
398 static void Close (vlc_object_t *obj)
400 vout_display_t *vd = (vout_display_t *)obj;
401 vout_display_sys_t *sys = vd->sys;
402 Display *dpy = sys->display;
404 if (sys->gl.sys != NULL)
405 vout_display_opengl_Clean (&sys->vgl);
407 if (sys->ctx != NULL)
411 glXMakeContextCurrent (dpy, None, None, NULL);
412 glXDestroyWindow (dpy, sys->glwin);
415 glXMakeCurrent (dpy, None, NULL);
416 glXDestroyContext (dpy, sys->ctx);
419 vout_display_DeleteWindow (vd, sys->embed);
423 static void SwapBuffers (vout_opengl_t *gl)
425 vout_display_sys_t *sys = gl->sys;
427 glXSwapBuffers (sys->display, sys->glwin);
431 * Return a direct buffer
433 static picture_t *Get (vout_display_t *vd)
435 vout_display_sys_t *sys = vd->sys;
439 sys->pool = vout_display_opengl_GetPool (&sys->vgl);
443 return picture_pool_Get (sys->pool);
446 static void PictureRender (vout_display_t *vd, picture_t *pic)
448 vout_display_sys_t *sys = vd->sys;
450 vout_display_opengl_Prepare (&sys->vgl, pic);
453 static void PictureDisplay (vout_display_t *vd, picture_t *pic)
455 vout_display_sys_t *sys = vd->sys;
457 vout_display_opengl_Display (&sys->vgl, &vd->source);
458 picture_Release (pic);
461 static int Control (vout_display_t *vd, int query, va_list ap)
463 vout_display_sys_t *sys = vd->sys;
467 case VOUT_DISPLAY_CHANGE_FULLSCREEN:
469 const vout_display_cfg_t *c = va_arg (ap, const vout_display_cfg_t *);
470 return vout_window_SetFullScreen (sys->embed, c->is_fullscreen);
473 case VOUT_DISPLAY_CHANGE_ON_TOP:
475 int b_on_top = (int)va_arg (ap, int);
476 return vout_window_SetOnTop (sys->embed, b_on_top);
479 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
480 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
481 case VOUT_DISPLAY_CHANGE_ZOOM:
482 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
483 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
485 xcb_connection_t *conn = XGetXCBConnection (sys->display);
486 const vout_display_cfg_t *cfg;
487 const video_format_t *source;
488 bool is_forced = false;
490 if (query == VOUT_DISPLAY_CHANGE_SOURCE_ASPECT
491 || query == VOUT_DISPLAY_CHANGE_SOURCE_CROP)
493 source = (const video_format_t *)va_arg (ap, const video_format_t *);
498 source = &vd->source;
499 cfg = (const vout_display_cfg_t*)va_arg (ap, const vout_display_cfg_t *);
500 if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE)
501 is_forced = (bool)va_arg (ap, int);
505 if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE
507 && (cfg->display.width != vd->cfg->display.width
508 ||cfg->display.height != vd->cfg->display.height)
509 && vout_window_SetSize (sys->embed,
510 cfg->display.width, cfg->display.height))
513 vout_display_place_t place;
514 vout_display_PlacePicture (&place, source, cfg, false);
516 /* Move the picture within the window */
517 const uint32_t values[] = { place.x, place.y,
518 place.width, place.height, };
519 xcb_void_cookie_t ck =
520 xcb_configure_window_checked (conn, sys->window,
521 XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y
522 | XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
524 if (CheckError (vd, conn, "cannot resize X11 window", ck))
527 glViewport (0, 0, place.width, place.height);
531 /* Hide the mouse. It will be send when
532 * vout_display_t::info.b_hide_mouse is false */
533 case VOUT_DISPLAY_HIDE_MOUSE:
534 xcb_change_window_attributes (XGetXCBConnection (sys->display),
536 XCB_CW_CURSOR, &(uint32_t){ sys->cursor });
538 case VOUT_DISPLAY_RESET_PICTURES:
541 msg_Err (vd, "Unknown request in XCB vout display");
546 static void Manage (vout_display_t *vd)
548 vout_display_sys_t *sys = vd->sys;
549 xcb_connection_t *conn = XGetXCBConnection (sys->display);
551 ManageEvent (vd, conn, &sys->visible);