1 /*****************************************************************************
2 * glwin32.c: Windows OpenGL provider
3 *****************************************************************************
4 * Copyright (C) 2001-2004 the VideoLAN team
7 * Authors: Gildas Bazin <gbazin@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program 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 License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 #include <errno.h> /* ENOMEM */
30 #include <vlc_common.h>
31 #include <vlc_plugin.h>
32 #include <vlc_interface.h>
40 #undef GetSystemMetrics
42 #ifndef MONITOR_DEFAULTTONEAREST
43 # define MONITOR_DEFAULTTONEAREST 2
50 /*****************************************************************************
52 *****************************************************************************/
53 static int OpenVideo ( vlc_object_t * );
54 static void CloseVideo ( vlc_object_t * );
56 static int Init ( vout_thread_t * );
57 static void End ( vout_thread_t * );
58 static int Manage ( vout_thread_t * );
59 static void GLSwapBuffers( vout_thread_t * );
60 static void FirstSwap( vout_thread_t * );
62 /*****************************************************************************
64 *****************************************************************************/
66 set_category( CAT_VIDEO );
67 set_subcategory( SUBCAT_VIDEO_VOUT );
68 set_shortname( "OpenGL" );
69 set_description( N_("OpenGL video output") );
70 set_capability( "opengl provider", 100 );
71 add_shortcut( "glwin32" );
72 set_callbacks( OpenVideo, CloseVideo );
74 /* FIXME: Hack to avoid unregistering our window class */
75 linked_with_a_crap_library_which_uses_atexit( );
79 /* check if we registered a window class because we need to
82 if( GetClassInfo( GetModuleHandle(NULL), "VLC DirectX", &wndclass ) )
83 UnregisterClass( "VLC DirectX", GetModuleHandle(NULL) );
86 /*****************************************************************************
87 * OpenVideo: allocate OpenGL provider
88 *****************************************************************************
89 * This function creates and initializes a video window.
90 *****************************************************************************/
91 static int OpenVideo( vlc_object_t *p_this )
93 vout_thread_t * p_vout = (vout_thread_t *)p_this;
96 /* Allocate structure */
97 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
98 if( p_vout->p_sys == NULL )
100 memset( p_vout->p_sys, 0, sizeof( vout_sys_t ) );
102 /* Initialisations */
103 p_vout->pf_init = Init;
104 p_vout->pf_end = End;
105 p_vout->pf_manage = Manage;
106 p_vout->pf_swap = FirstSwap;
108 p_vout->p_sys->hwnd = p_vout->p_sys->hvideownd = NULL;
109 p_vout->p_sys->hparent = p_vout->p_sys->hfswnd = NULL;
110 p_vout->p_sys->i_changes = 0;
111 vlc_mutex_init( &p_vout->p_sys->lock );
112 SetRectEmpty( &p_vout->p_sys->rect_display );
113 SetRectEmpty( &p_vout->p_sys->rect_parent );
115 var_Create( p_vout, "video-title", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
117 p_vout->p_sys->b_cursor_hidden = 0;
118 p_vout->p_sys->i_lastmoved = mdate();
119 p_vout->p_sys->i_mouse_hide_timeout =
120 var_GetInteger(p_vout, "mouse-hide-timeout") * 1000;
122 /* Set main window's size */
123 p_vout->p_sys->i_window_width = p_vout->i_window_width;
124 p_vout->p_sys->i_window_height = p_vout->i_window_height;
126 /* Create the Vout EventThread, this thread is created by us to isolate
127 * the Win32 PeekMessage function calls. We want to do this because
128 * Windows can stay blocked inside this call for a long time, and when
129 * this happens it thus blocks vlc's video_output thread.
130 * Vout EventThread will take care of the creation of the video
131 * window (because PeekMessage has to be called from the same thread which
132 * created the window). */
133 msg_Dbg( p_vout, "creating Vout EventThread" );
134 p_vout->p_sys->p_event =
135 vlc_object_create( p_vout, sizeof(event_thread_t) );
136 p_vout->p_sys->p_event->p_vout = p_vout;
137 if( vlc_thread_create( p_vout->p_sys->p_event, "Vout Events Thread",
138 EventThread, 0, 1 ) )
140 msg_Err( p_vout, "cannot create Vout EventThread" );
141 vlc_object_release( p_vout->p_sys->p_event );
142 p_vout->p_sys->p_event = NULL;
146 if( p_vout->p_sys->p_event->b_error )
148 msg_Err( p_vout, "Vout EventThread failed" );
152 vlc_object_attach( p_vout->p_sys->p_event, p_vout );
154 msg_Dbg( p_vout, "Vout EventThread running" );
156 /* Variable to indicate if the window should be on top of others */
157 /* Trigger a callback right now */
158 var_Get( p_vout, "video-on-top", &val );
159 var_Set( p_vout, "video-on-top", val );
164 CloseVideo( VLC_OBJECT(p_vout) );
168 /*****************************************************************************
169 * Init: initialize video thread output method
170 *****************************************************************************/
171 static int Init( vout_thread_t *p_vout )
173 PIXELFORMATDESCRIPTOR pfd;
176 /* Change the window title bar text */
177 PostMessage( p_vout->p_sys->hwnd, WM_VLC_CHANGE_TEXT, 0, 0 );
179 p_vout->p_sys->hGLDC = GetDC( p_vout->p_sys->hvideownd );
181 /* Set the pixel format for the DC */
182 memset( &pfd, 0, sizeof( pfd ) );
183 pfd.nSize = sizeof( pfd );
185 pfd.dwFlags = PFD_DRAW_TO_WINDOW | PFD_SUPPORT_OPENGL | PFD_DOUBLEBUFFER;
186 pfd.iPixelType = PFD_TYPE_RGBA;
189 pfd.iLayerType = PFD_MAIN_PLANE;
190 iFormat = ChoosePixelFormat( p_vout->p_sys->hGLDC, &pfd );
191 SetPixelFormat( p_vout->p_sys->hGLDC, iFormat, &pfd );
193 /* Create and enable the render context */
194 p_vout->p_sys->hGLRC = wglCreateContext( p_vout->p_sys->hGLDC );
195 wglMakeCurrent( p_vout->p_sys->hGLDC, p_vout->p_sys->hGLRC );
200 /*****************************************************************************
201 * End: terminate Sys video thread output method
202 *****************************************************************************
203 * Terminate an output method created by Create.
204 * It is called at the end of the thread.
205 *****************************************************************************/
206 static void End( vout_thread_t *p_vout )
208 wglMakeCurrent( NULL, NULL );
209 wglDeleteContext( p_vout->p_sys->hGLRC );
210 ReleaseDC( p_vout->p_sys->hvideownd, p_vout->p_sys->hGLDC );
214 /*****************************************************************************
215 * CloseVideo: destroy Sys video thread output method
216 *****************************************************************************
217 * Terminate an output method created by Create
218 *****************************************************************************/
219 static void CloseVideo( vlc_object_t *p_this )
221 vout_thread_t * p_vout = (vout_thread_t *)p_this;
223 if( p_vout->b_fullscreen )
225 msg_Dbg( p_vout, "Quitting fullscreen" );
226 Win32ToggleFullscreen( p_vout );
227 /* Force fullscreen in the core for the next video */
228 var_SetBool( p_vout, "fullscreen", true );
231 if( p_vout->p_sys->p_event )
233 vlc_object_detach( p_vout->p_sys->p_event );
235 /* Kill Vout EventThread */
236 vlc_object_kill( p_vout->p_sys->p_event );
238 /* we need to be sure Vout EventThread won't stay stuck in
239 * GetMessage, so we send a fake message */
240 if( p_vout->p_sys->hwnd )
242 PostMessage( p_vout->p_sys->hwnd, WM_NULL, 0, 0);
245 vlc_thread_join( p_vout->p_sys->p_event );
246 vlc_object_release( p_vout->p_sys->p_event );
249 vlc_mutex_destroy( &p_vout->p_sys->lock );
251 free( p_vout->p_sys );
252 p_vout->p_sys = NULL;
255 /*****************************************************************************
256 * Manage: handle Sys events
257 *****************************************************************************
258 * This function should be called regularly by the video output thread.
259 * It returns a non null value if an error occurred.
260 *****************************************************************************/
261 static int Manage( vout_thread_t *p_vout )
263 int i_width = p_vout->p_sys->rect_dest.right -
264 p_vout->p_sys->rect_dest.left;
265 int i_height = p_vout->p_sys->rect_dest.bottom -
266 p_vout->p_sys->rect_dest.top;
267 glViewport( 0, 0, i_width, i_height );
269 /* If we do not control our window, we check for geometry changes
270 * ourselves because the parent might not send us its events. */
271 vlc_mutex_lock( &p_vout->p_sys->lock );
272 if( p_vout->p_sys->hparent && !p_vout->b_fullscreen )
277 vlc_mutex_unlock( &p_vout->p_sys->lock );
279 GetClientRect( p_vout->p_sys->hparent, &rect_parent );
280 point.x = point.y = 0;
281 ClientToScreen( p_vout->p_sys->hparent, &point );
282 OffsetRect( &rect_parent, point.x, point.y );
284 if( !EqualRect( &rect_parent, &p_vout->p_sys->rect_parent ) )
286 p_vout->p_sys->rect_parent = rect_parent;
288 /* This one is to force the update even if only
289 * the position has changed */
290 SetWindowPos( p_vout->p_sys->hwnd, 0, 1, 1,
291 rect_parent.right - rect_parent.left,
292 rect_parent.bottom - rect_parent.top, 0 );
294 SetWindowPos( p_vout->p_sys->hwnd, 0, 0, 0,
295 rect_parent.right - rect_parent.left,
296 rect_parent.bottom - rect_parent.top, 0 );
301 vlc_mutex_unlock( &p_vout->p_sys->lock );
304 /* Check for cropping / aspect changes */
305 if( p_vout->i_changes & VOUT_CROP_CHANGE ||
306 p_vout->i_changes & VOUT_ASPECT_CHANGE )
308 p_vout->i_changes &= ~VOUT_CROP_CHANGE;
309 p_vout->i_changes &= ~VOUT_ASPECT_CHANGE;
311 p_vout->fmt_out.i_x_offset = p_vout->fmt_in.i_x_offset;
312 p_vout->fmt_out.i_y_offset = p_vout->fmt_in.i_y_offset;
313 p_vout->fmt_out.i_visible_width = p_vout->fmt_in.i_visible_width;
314 p_vout->fmt_out.i_visible_height = p_vout->fmt_in.i_visible_height;
315 p_vout->fmt_out.i_aspect = p_vout->fmt_in.i_aspect;
316 p_vout->fmt_out.i_sar_num = p_vout->fmt_in.i_sar_num;
317 p_vout->fmt_out.i_sar_den = p_vout->fmt_in.i_sar_den;
318 p_vout->output.i_aspect = p_vout->fmt_in.i_aspect;
319 UpdateRects( p_vout, true );
322 /* We used to call the Win32 PeekMessage function here to read the window
323 * messages. But since window can stay blocked into this function for a
324 * long time (for example when you move your window on the screen), I
325 * decided to isolate PeekMessage in another thread. */
330 if( p_vout->i_changes & VOUT_FULLSCREEN_CHANGE
331 || p_vout->p_sys->i_changes & VOUT_FULLSCREEN_CHANGE )
333 Win32ToggleFullscreen( p_vout );
335 p_vout->i_changes &= ~VOUT_FULLSCREEN_CHANGE;
336 p_vout->p_sys->i_changes &= ~VOUT_FULLSCREEN_CHANGE;
342 if( p_vout->b_fullscreen && !p_vout->p_sys->b_cursor_hidden &&
343 (mdate() - p_vout->p_sys->i_lastmoved) >
344 p_vout->p_sys->i_mouse_hide_timeout )
349 /* Hide the cursor only if it is inside our window */
350 GetCursorPos( &point );
351 hwnd = WindowFromPoint(point);
352 if( hwnd == p_vout->p_sys->hwnd || hwnd == p_vout->p_sys->hvideownd )
354 PostMessage( p_vout->p_sys->hwnd, WM_VLC_HIDE_MOUSE, 0, 0 );
358 p_vout->p_sys->i_lastmoved = mdate();
363 * "Always on top" status change
365 if( p_vout->p_sys->b_on_top_change )
368 HMENU hMenu = GetSystemMenu( p_vout->p_sys->hwnd, FALSE );
370 var_Get( p_vout, "video-on-top", &val );
372 /* Set the window on top if necessary */
373 if( val.b_bool && !( GetWindowLong( p_vout->p_sys->hwnd, GWL_EXSTYLE )
376 CheckMenuItem( hMenu, IDM_TOGGLE_ON_TOP,
377 MF_BYCOMMAND | MFS_CHECKED );
378 SetWindowPos( p_vout->p_sys->hwnd, HWND_TOPMOST, 0, 0, 0, 0,
379 SWP_NOSIZE | SWP_NOMOVE );
382 /* The window shouldn't be on top */
383 if( !val.b_bool && ( GetWindowLong( p_vout->p_sys->hwnd, GWL_EXSTYLE )
386 CheckMenuItem( hMenu, IDM_TOGGLE_ON_TOP,
387 MF_BYCOMMAND | MFS_UNCHECKED );
388 SetWindowPos( p_vout->p_sys->hwnd, HWND_NOTOPMOST, 0, 0, 0, 0,
389 SWP_NOSIZE | SWP_NOMOVE );
392 p_vout->p_sys->b_on_top_change = false;
395 /* Check if the event thread is still running */
396 if( !vlc_object_alive (p_vout->p_sys->p_event) )
398 return VLC_EGENERIC; /* exit */
404 /*****************************************************************************
405 * GLSwapBuffers: swap front/back buffers
406 *****************************************************************************/
407 static void GLSwapBuffers( vout_thread_t *p_vout )
409 SwapBuffers( p_vout->p_sys->hGLDC );
413 ** this function is only used once when the first picture is received
414 ** this function will show the video window once a picture is ready
417 static void FirstSwap( vout_thread_t *p_vout )
419 /* get initial picture buffer swapped to front buffer */
420 GLSwapBuffers( p_vout );
423 ** Video window is initially hidden, show it now since we got a
426 SetWindowPos( p_vout->p_sys->hvideownd, NULL, 0, 0, 0, 0,
434 /* use and restores proper swap function for further pictures */
435 p_vout->pf_swap = GLSwapBuffers;