2bf4f8fea8ce9003a0256522228fb655b9b35136
[vlc.git] / modules / video_output / x11 / glx.c
1 /*****************************************************************************
2  * glx.c: GLX OpenGL provider
3  *****************************************************************************
4  * Copyright (C) 2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Cyril Deguet <asmax@videolan.org>
8  *          Gildas Bazin <gbazin@videolan.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28
29 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #include <errno.h>                                                 /* ENOMEM */
34
35 #include <vlc_common.h>
36 #include <vlc_plugin.h>
37 #include <vlc_interface.h>
38 #include <vlc_vout.h>
39
40 #ifdef HAVE_SYS_SHM_H
41 #   include <sys/shm.h>                                /* shmget(), shmctl() */
42 #endif
43
44 #include <X11/Xlib.h>
45 #include <X11/Xmd.h>
46 #include <X11/Xutil.h>
47 #include <X11/keysym.h>
48 #ifdef HAVE_SYS_SHM_H
49 #   include <X11/extensions/XShm.h>
50 #endif
51 #ifdef DPMSINFO_IN_DPMS_H
52 #   include <X11/extensions/dpms.h>
53 #endif
54
55 #include <GL/glx.h>
56
57 #include "xcommon.h"
58
59 /* RV16 */
60 //#define VLCGL_RGB_FORMAT GL_RGB
61 //#define VLCGL_RGB_TYPE GL_UNSIGNED_SHORT_5_6_5
62
63 /* RV24 */
64 //#define VLCGL_RGB_FORMAT GL_RGB
65 //#define VLCGL_RGB_TYPE GL_UNSIGNED_BYTE
66
67 /* RV32 */
68 #define VLCGL_RGB_FORMAT GL_RGBA
69 #define VLCGL_RGB_TYPE GL_UNSIGNED_BYTE
70
71
72 /*****************************************************************************
73  * OpenGL provider interface
74  *****************************************************************************/
75 static int  CreateOpenGL ( vlc_object_t * );
76 static void DestroyOpenGL( vlc_object_t * );
77 static int  InitOpenGL   ( vout_thread_t * );
78 static void SwapBuffers  ( vout_thread_t * );
79
80 /*****************************************************************************
81  * Local prototypes
82  *****************************************************************************/
83 static int  InitGLX12    ( vout_thread_t * );
84 static int  InitGLX13    ( vout_thread_t * );
85 static void SwitchContext( vout_thread_t * );
86
87 /*****************************************************************************
88  * Module descriptor
89  *****************************************************************************/
90 #define ADAPTOR_TEXT N_("XVideo adaptor number")
91 #define ADAPTOR_LONGTEXT N_( \
92     "If your graphics card provides several adaptors, you have " \
93     "to choose which one will be used (you shouldn't have to change this).")
94
95 #define ALT_FS_TEXT N_("Alternate fullscreen method")
96 #define ALT_FS_LONGTEXT N_( \
97     "There are two ways to make a fullscreen window, unfortunately each one " \
98     "has its drawbacks.\n" \
99     "1) Let the window manager handle your fullscreen window (default), but " \
100     "things like taskbars will likely show on top of the video.\n" \
101     "2) Completely bypass the window manager, but then nothing will be able " \
102     "to show on top of the video.")
103
104 #define DISPLAY_TEXT N_("X11 display")
105 #define DISPLAY_LONGTEXT N_( \
106     "X11 hardware display to use. By default VLC will " \
107     "use the value of the DISPLAY environment variable.")
108
109 #define SHM_TEXT N_("Use shared memory")
110 #define SHM_LONGTEXT N_( \
111     "Use shared memory to communicate between VLC and the X server.")
112
113 vlc_module_begin ()
114     set_shortname( "OpenGL(GLX)" )
115     set_category( CAT_VIDEO )
116     set_subcategory( SUBCAT_VIDEO_VOUT )
117     set_description( N_("OpenGL(GLX) provider") )
118     set_capability( "opengl provider", 50 )
119     set_callbacks( CreateOpenGL, DestroyOpenGL )
120
121     add_string( "glx-display", NULL, NULL, DISPLAY_TEXT, DISPLAY_LONGTEXT, true )
122     add_integer( "glx-adaptor", -1, NULL, ADAPTOR_TEXT, ADAPTOR_LONGTEXT, true )
123     add_bool( "glx-altfullscreen", 0, NULL, ALT_FS_TEXT, ALT_FS_LONGTEXT, true )
124 #ifdef HAVE_SYS_SHM_H
125     add_bool( "glx-shm", 1, NULL, SHM_TEXT, SHM_LONGTEXT, true )
126 #endif
127 vlc_module_end ()
128
129 /*****************************************************************************
130  * Exported prototypes
131  *****************************************************************************/
132 extern int  Activate   ( vlc_object_t * );
133 extern void Deactivate ( vlc_object_t * );
134
135 /*****************************************************************************
136  * CreateOpenGL: initialize an OpenGL provider
137  *****************************************************************************/
138 static int CreateOpenGL( vlc_object_t *p_this )
139 {
140     vout_thread_t *p_vout = (vout_thread_t *)p_this;
141
142     if( Activate( p_this ) != VLC_SUCCESS )
143     {
144         return VLC_EGENERIC;
145     }
146
147     /* Set the function pointer */
148     p_vout->pf_init = InitOpenGL;
149     p_vout->pf_swap = SwapBuffers;
150
151     return VLC_SUCCESS;
152 }
153
154 /*****************************************************************************
155  * DestroyOpenGL: destroys an OpenGL provider
156  *****************************************************************************/
157 static void DestroyOpenGL( vlc_object_t *p_this )
158 {
159     vout_thread_t *p_vout = (vout_thread_t *)p_this;
160     vout_sys_t *p_sys = p_vout->p_sys;
161
162     glXDestroyContext( p_sys->p_display, p_sys->gwctx );
163     if( p_sys->b_glx13 )
164     {
165         glXDestroyWindow( p_sys->p_display, p_sys->gwnd );
166     }
167
168     Deactivate( p_this );
169 }
170
171 /*****************************************************************************
172  * InitOpenGL: initializes OpenGL provider
173  *****************************************************************************/
174 static int InitOpenGL( vout_thread_t *p_vout )
175 {
176     /* Initialize GLX */
177     if( !p_vout->p_sys->b_glx13 )
178     {
179         if( InitGLX12( p_vout ) != VLC_SUCCESS )
180         {
181             return VLC_EGENERIC;
182         }
183     }
184     else
185     {
186         if( InitGLX13( p_vout ) != VLC_SUCCESS )
187         {
188             return VLC_EGENERIC;
189         }
190     }
191
192     /* Set the OpenGL context _for the current thread_ */
193     SwitchContext( p_vout );
194
195     return VLC_SUCCESS;
196 }
197
198 int InitGLX12( vout_thread_t *p_vout )
199 {
200     vout_sys_t *p_sys = p_vout->p_sys;
201     XVisualInfo *p_vi;
202     int p_attr[] = { GLX_RGBA, GLX_RED_SIZE, 5, GLX_GREEN_SIZE, 5,
203                      GLX_BLUE_SIZE, 5, GLX_DOUBLEBUFFER, 0 };
204
205     p_vi = glXChooseVisual( p_sys->p_display,
206                             DefaultScreen( p_sys->p_display), p_attr );
207     if(! p_vi )
208     {
209         msg_Err( p_vout, "Cannot get GLX 1.2 visual" );
210         return VLC_EGENERIC;
211     }
212
213     /* Create an OpenGL context */
214     p_sys->gwctx = glXCreateContext( p_sys->p_display, p_vi, 0, True );
215     XFree( p_vi );
216     if( !p_sys->gwctx )
217     {
218         msg_Err( p_vout, "Cannot create OpenGL context");
219         return VLC_EGENERIC;
220     }
221
222     return VLC_SUCCESS;
223 }
224
225 int InitGLX13( vout_thread_t *p_vout )
226 {
227     vout_sys_t *p_sys = p_vout->p_sys;
228     int i_nb, ret = VLC_EGENERIC;
229     GLXFBConfig *p_fbconfs = NULL, fbconf = NULL;
230     XWindowAttributes att;
231     static const int p_attr[] = {
232         GLX_RED_SIZE, 5, GLX_GREEN_SIZE, 5, GLX_BLUE_SIZE, 5,
233         GLX_DOUBLEBUFFER, True, GLX_X_RENDERABLE, True,
234         GLX_DRAWABLE_TYPE, GLX_WINDOW_BIT,
235         None,
236     };
237
238     /* Get the FB configuration */
239     p_fbconfs = glXChooseFBConfig( p_sys->p_display, p_sys->i_screen, p_attr, &i_nb );
240     if( p_fbconfs == NULL )
241     {
242         msg_Err( p_vout, "Cannot get FB configurations");
243         return VLC_EGENERIC;
244     }
245
246     /* We should really create the window _after_ the frame buffer
247      * configuration was chosen, instead of selecting the frame buffer from
248      * the window. That requires reworking xcommon.c though.
249      * -- Courmisch */
250     XGetWindowAttributes( p_sys->p_display, p_sys->window.video_window, &att );
251     for( int i = 0; i < i_nb && !fbconf; i++ )
252     {
253         XVisualInfo *p_vi;
254
255         /* Get the X11 visual */
256         p_vi = glXGetVisualFromFBConfig( p_sys->p_display, p_fbconfs[i] );
257         if( !p_vi )
258             continue; /* OoM? */
259
260         if( p_vi->visualid == att.visual->visualid )
261             fbconf = p_fbconfs[i];
262         XFree( p_vi );
263     }
264     if( !fbconf )
265     {
266         msg_Err( p_vout, "Cannot find matching frame buffer" );
267         goto out;
268     }
269
270     /* Create the GLX window */
271     p_sys->gwnd = glXCreateWindow( p_sys->p_display, fbconf,
272                                    p_sys->window.video_window, NULL );
273     if( p_sys->gwnd == None )
274     {
275         msg_Err( p_vout, "Cannot create GLX window" );
276         goto out;
277     }
278
279     /* Create an OpenGL context */
280     p_sys->gwctx = glXCreateNewContext( p_sys->p_display, fbconf,
281                                         GLX_RGBA_TYPE, NULL, True );
282     if( !p_sys->gwctx )
283         msg_Err( p_vout, "Cannot create OpenGL context");
284     else
285         ret = VLC_SUCCESS;
286
287 out:
288     XFree( p_fbconfs );
289     return ret;
290 }
291
292 /*****************************************************************************
293  * SwapBuffers: swap front/back buffers
294  *****************************************************************************/
295 static void SwapBuffers( vout_thread_t *p_vout )
296 {
297     vout_sys_t *p_sys = p_vout->p_sys;
298     unsigned int i_width, i_height, i_x, i_y;
299
300     vout_PlacePicture( p_vout, p_vout->p_sys->window.i_width,
301                        p_vout->p_sys->window.i_height,
302                        &i_x, &i_y, &i_width, &i_height );
303
304     glViewport( 0, 0, (GLint)i_width, (GLint)i_height );
305
306     if( p_sys->b_glx13 )
307     {
308         glXSwapBuffers( p_sys->p_display, p_sys->gwnd );
309     }
310     else
311     {
312         glXSwapBuffers( p_sys->p_display, p_sys->window.video_window );
313     }
314 }
315
316 void SwitchContext( vout_thread_t *p_vout )
317 {
318     vout_sys_t *p_sys = p_vout->p_sys;
319
320     /* Change the current OpenGL context */
321     if( p_sys->b_glx13 )
322     {
323         glXMakeContextCurrent( p_sys->p_display, p_sys->gwnd,
324                                p_sys->gwnd, p_sys->gwctx );
325     }
326     else
327     {
328         glXMakeCurrent( p_sys->p_display, p_sys->window.video_window,
329                         p_sys->gwctx );
330     }
331 }