git.sesse.net Git - vlc/blob - modules/video_output/msw/glwin32.c

   1 /*****************************************************************************
   2  * glwin32.c: Windows OpenGL provider
   3  *****************************************************************************
   4  * Copyright (C) 2001-2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Gildas Bazin <gbazin@videolan.org>
   8  *
   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.
  13  *
  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.
  18  *
  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  *****************************************************************************/
  23
  24 #include <errno.h>                                                 /* ENOMEM */
  25
  26 #ifdef HAVE_CONFIG_H
  27 # include "config.h"
  28 #endif
  29
  30 #include <vlc/vlc.h>
  31 #include <vlc_plugin.h>
  32 #include <vlc_interface.h>
  33 #include <vlc_vout.h>
  34
  35 #include <windows.h>
  36 #include <ddraw.h>
  37 #include <commctrl.h>
  38
  39 #include <multimon.h>
  40 #undef GetSystemMetrics
  41
  42 #ifndef MONITOR_DEFAULTTONEAREST
  43 #   define MONITOR_DEFAULTTONEAREST 2
  44 #endif
  45
  46 #include <GL/gl.h>
  47
  48 #include "vout.h"
  49
  50 /*****************************************************************************
  51  * Local prototypes.
  52  *****************************************************************************/
  53 static int  OpenVideo  ( vlc_object_t * );
  54 static void CloseVideo ( vlc_object_t * );
  55
  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 * );
  61
  62 /*****************************************************************************
  63  * Module descriptor
  64  *****************************************************************************/
  65 vlc_module_begin();
  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 );
  73
  74     /* FIXME: Hack to avoid unregistering our window class */
  75     linked_with_a_crap_library_which_uses_atexit( );
  76 vlc_module_end();
  77
  78 #if 0 /* FIXME */
  79     /* check if we registered a window class because we need to
  80      * unregister it */
  81     WNDCLASS wndclass;
  82     if( GetClassInfo( GetModuleHandle(NULL), "VLC DirectX", &wndclass ) )
  83         UnregisterClass( "VLC DirectX", GetModuleHandle(NULL) );
  84 #endif
  85
  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 )
  92 {
  93     vout_thread_t * p_vout = (vout_thread_t *)p_this;
  94     vlc_value_t val;
  95
  96     /* Allocate structure */
  97     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
  98     if( p_vout->p_sys == NULL )
  99         return VLC_ENOMEM;
 100     memset( p_vout->p_sys, 0, sizeof( vout_sys_t ) );
 101
 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;
 107
 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 );
 114
 115     var_Create( p_vout, "video-title", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 116
 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;
 121
 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;
 125
 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 ) )
 139     {
 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;
 143         goto error;
 144     }
 145
 146     if( p_vout->p_sys->p_event->b_error )
 147     {
 148         msg_Err( p_vout, "Vout EventThread failed" );
 149         goto error;
 150     }
 151
 152     vlc_object_attach( p_vout->p_sys->p_event, p_vout );
 153
 154     msg_Dbg( p_vout, "Vout EventThread running" );
 155
 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 );
 160
 161     return VLC_SUCCESS;
 162
 163  error:
 164     CloseVideo( VLC_OBJECT(p_vout) );
 165     return VLC_EGENERIC;
 166 }
 167
 168 /*****************************************************************************
 169  * Init: initialize video thread output method
 170  *****************************************************************************/
 171 static int Init( vout_thread_t *p_vout )
 172 {
 173     PIXELFORMATDESCRIPTOR pfd;
 174     int iFormat;
 175
 176     /* Change the window title bar text */
 177     PostMessage( p_vout->p_sys->hwnd, WM_VLC_CHANGE_TEXT, 0, 0 );
 178
 179     p_vout->p_sys->hGLDC = GetDC( p_vout->p_sys->hvideownd );
 180
 181     /* Set the pixel format for the DC */
 182     memset( &pfd, 0, sizeof( pfd ) );
 183     pfd.nSize = sizeof( pfd );
 184     pfd.nVersion = 1;
 185     pfd.dwFlags = PFD_DRAW_TO_WINDOW | PFD_SUPPORT_OPENGL | PFD_DOUBLEBUFFER;
 186     pfd.iPixelType = PFD_TYPE_RGBA;
 187     pfd.cColorBits = 24;
 188     pfd.cDepthBits = 16;
 189     pfd.iLayerType = PFD_MAIN_PLANE;
 190     iFormat = ChoosePixelFormat( p_vout->p_sys->hGLDC, &pfd );
 191     SetPixelFormat( p_vout->p_sys->hGLDC, iFormat, &pfd );
 192
 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 );
 196
 197     return VLC_SUCCESS;
 198 }
 199
 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 )
 207 {
 208     wglMakeCurrent( NULL, NULL );
 209     wglDeleteContext( p_vout->p_sys->hGLRC );
 210     ReleaseDC( p_vout->p_sys->hvideownd, p_vout->p_sys->hGLDC );
 211     return;
 212 }
 213
 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 )
 220 {
 221     vout_thread_t * p_vout = (vout_thread_t *)p_this;
 222
 223     msg_Dbg( p_vout, "closing video" );
 224
 225     if( p_vout->p_sys->p_event )
 226     {
 227         vlc_object_detach( p_vout->p_sys->p_event );
 228
 229         /* Kill Vout EventThread */
 230         vlc_object_kill( p_vout->p_sys->p_event );
 231
 232         /* we need to be sure Vout EventThread won't stay stuck in
 233          * GetMessage, so we send a fake message */
 234         if( p_vout->p_sys->hwnd )
 235         {
 236             PostMessage( p_vout->p_sys->hwnd, WM_NULL, 0, 0);
 237         }
 238
 239         vlc_thread_join( p_vout->p_sys->p_event );
 240         vlc_object_release( p_vout->p_sys->p_event );
 241     }
 242
 243     vlc_mutex_destroy( &p_vout->p_sys->lock );
 244
 245     if( p_vout->p_sys )
 246     {
 247         free( p_vout->p_sys );
 248         p_vout->p_sys = NULL;
 249     }
 250 }
 251
 252 /*****************************************************************************
 253  * Manage: handle Sys events
 254  *****************************************************************************
 255  * This function should be called regularly by the video output thread.
 256  * It returns a non null value if an error occurred.
 257  *****************************************************************************/
 258 static int Manage( vout_thread_t *p_vout )
 259 {
 260     int i_width = p_vout->p_sys->rect_dest.right -
 261         p_vout->p_sys->rect_dest.left;
 262     int i_height = p_vout->p_sys->rect_dest.bottom -
 263         p_vout->p_sys->rect_dest.top;
 264     glViewport( 0, 0, i_width, i_height );
 265
 266     /* If we do not control our window, we check for geometry changes
 267      * ourselves because the parent might not send us its events. */
 268     vlc_mutex_lock( &p_vout->p_sys->lock );
 269     if( p_vout->p_sys->hparent && !p_vout->b_fullscreen )
 270     {
 271         RECT rect_parent;
 272         POINT point;
 273
 274         vlc_mutex_unlock( &p_vout->p_sys->lock );
 275
 276         GetClientRect( p_vout->p_sys->hparent, &rect_parent );
 277         point.x = point.y = 0;
 278         ClientToScreen( p_vout->p_sys->hparent, &point );
 279         OffsetRect( &rect_parent, point.x, point.y );
 280
 281         if( !EqualRect( &rect_parent, &p_vout->p_sys->rect_parent ) )
 282         {
 283             p_vout->p_sys->rect_parent = rect_parent;
 284
 285             /* This one is to force the update even if only
 286              * the position has changed */
 287             SetWindowPos( p_vout->p_sys->hwnd, 0, 1, 1,
 288                           rect_parent.right - rect_parent.left,
 289                           rect_parent.bottom - rect_parent.top, 0 );
 290
 291             SetWindowPos( p_vout->p_sys->hwnd, 0, 0, 0,
 292                           rect_parent.right - rect_parent.left,
 293                           rect_parent.bottom - rect_parent.top, 0 );
 294         }
 295     }
 296     else
 297     {
 298         vlc_mutex_unlock( &p_vout->p_sys->lock );
 299     }
 300
 301     /* Check for cropping / aspect changes */
 302     if( p_vout->i_changes & VOUT_CROP_CHANGE ||
 303         p_vout->i_changes & VOUT_ASPECT_CHANGE )
 304     {
 305         p_vout->i_changes &= ~VOUT_CROP_CHANGE;
 306         p_vout->i_changes &= ~VOUT_ASPECT_CHANGE;
 307
 308         p_vout->fmt_out.i_x_offset = p_vout->fmt_in.i_x_offset;
 309         p_vout->fmt_out.i_y_offset = p_vout->fmt_in.i_y_offset;
 310         p_vout->fmt_out.i_visible_width = p_vout->fmt_in.i_visible_width;
 311         p_vout->fmt_out.i_visible_height = p_vout->fmt_in.i_visible_height;
 312         p_vout->fmt_out.i_aspect = p_vout->fmt_in.i_aspect;
 313         p_vout->fmt_out.i_sar_num = p_vout->fmt_in.i_sar_num;
 314         p_vout->fmt_out.i_sar_den = p_vout->fmt_in.i_sar_den;
 315         p_vout->output.i_aspect = p_vout->fmt_in.i_aspect;
 316         UpdateRects( p_vout, true );
 317     }
 318
 319     /* We used to call the Win32 PeekMessage function here to read the window
 320      * messages. But since window can stay blocked into this function for a
 321      * long time (for example when you move your window on the screen), I
 322      * decided to isolate PeekMessage in another thread. */
 323
 324     /*
 325      * Fullscreen change
 326      */
 327     if( p_vout->i_changes & VOUT_FULLSCREEN_CHANGE
 328         || p_vout->p_sys->i_changes & VOUT_FULLSCREEN_CHANGE )
 329     {
 330         Win32ToggleFullscreen( p_vout );
 331
 332         p_vout->i_changes &= ~VOUT_FULLSCREEN_CHANGE;
 333         p_vout->p_sys->i_changes &= ~VOUT_FULLSCREEN_CHANGE;
 334     }
 335
 336     /*
 337      * Pointer change
 338      */
 339     if( p_vout->b_fullscreen && !p_vout->p_sys->b_cursor_hidden &&
 340         (mdate() - p_vout->p_sys->i_lastmoved) >
 341             p_vout->p_sys->i_mouse_hide_timeout )
 342     {
 343         POINT point;
 344         HWND hwnd;
 345
 346         /* Hide the cursor only if it is inside our window */
 347         GetCursorPos( &point );
 348         hwnd = WindowFromPoint(point);
 349         if( hwnd == p_vout->p_sys->hwnd || hwnd == p_vout->p_sys->hvideownd )
 350         {
 351             PostMessage( p_vout->p_sys->hwnd, WM_VLC_HIDE_MOUSE, 0, 0 );
 352         }
 353         else
 354         {
 355             p_vout->p_sys->i_lastmoved = mdate();
 356         }
 357     }
 358
 359     /*
 360      * "Always on top" status change
 361      */
 362     if( p_vout->p_sys->b_on_top_change )
 363     {
 364         vlc_value_t val;
 365         HMENU hMenu = GetSystemMenu( p_vout->p_sys->hwnd, FALSE );
 366
 367         var_Get( p_vout, "video-on-top", &val );
 368
 369         /* Set the window on top if necessary */
 370         if( val.b_bool && !( GetWindowLong( p_vout->p_sys->hwnd, GWL_EXSTYLE )
 371                            & WS_EX_TOPMOST ) )
 372         {
 373             CheckMenuItem( hMenu, IDM_TOGGLE_ON_TOP,
 374                            MF_BYCOMMAND | MFS_CHECKED );
 375             SetWindowPos( p_vout->p_sys->hwnd, HWND_TOPMOST, 0, 0, 0, 0,
 376                           SWP_NOSIZE | SWP_NOMOVE );
 377         }
 378         else
 379         /* The window shouldn't be on top */
 380         if( !val.b_bool && ( GetWindowLong( p_vout->p_sys->hwnd, GWL_EXSTYLE )
 381                            & WS_EX_TOPMOST ) )
 382         {
 383             CheckMenuItem( hMenu, IDM_TOGGLE_ON_TOP,
 384                            MF_BYCOMMAND | MFS_UNCHECKED );
 385             SetWindowPos( p_vout->p_sys->hwnd, HWND_NOTOPMOST, 0, 0, 0, 0,
 386                           SWP_NOSIZE | SWP_NOMOVE );
 387         }
 388
 389         p_vout->p_sys->b_on_top_change = false;
 390     }
 391
 392     /* Check if the event thread is still running */
 393     if( p_vout->p_sys->p_event->b_die )
 394     {
 395         return VLC_EGENERIC; /* exit */
 396     }
 397
 398     return VLC_SUCCESS;
 399 }
 400
 401 /*****************************************************************************
 402  * GLSwapBuffers: swap front/back buffers
 403  *****************************************************************************/
 404 static void GLSwapBuffers( vout_thread_t *p_vout )
 405 {
 406     SwapBuffers( p_vout->p_sys->hGLDC );
 407 }
 408
 409 /*
 410 ** this function is only used once when the first picture is received
 411 ** this function will show the video window once a picture is ready
 412 */
 413
 414 static void FirstSwap( vout_thread_t *p_vout )
 415 {
 416     /* get initial picture buffer swapped to front buffer */
 417     GLSwapBuffers( p_vout );
 418
 419     /*
 420     ** Video window is initially hidden, show it now since we got a
 421     ** picture to show.
 422     */
 423     SetWindowPos( p_vout->p_sys->hvideownd, NULL, 0, 0, 0, 0,
 424         SWP_ASYNCWINDOWPOS|
 425         SWP_FRAMECHANGED|
 426         SWP_SHOWWINDOW|
 427         SWP_NOMOVE|
 428         SWP_NOSIZE|
 429         SWP_NOZORDER );
 430
 431     /* use and restores proper swap function for further pictures */
 432     p_vout->pf_swap = GLSwapBuffers;
 433 }