1 /*****************************************************************************
2 * events.c: Windows DirectX video output events handler
3 *****************************************************************************
4 * Copyright (C) 2001 VideoLAN
5 * $Id: events.c,v 1.24 2003/10/17 16:40:09 gbazin Exp $
7 * Authors: Gildas Bazin <gbazin@netcourrier.com>
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
25 /*****************************************************************************
26 * Preamble: This file contains the functions related to the creation of
27 * a window and the handling of its messages (events).
28 *****************************************************************************/
29 #include <errno.h> /* ENOMEM */
30 #include <stdlib.h> /* free() */
31 #include <string.h> /* strerror() */
35 #include <vlc/input.h>
46 /*****************************************************************************
48 *****************************************************************************/
49 static int DirectXCreateWindow( vout_thread_t *p_vout );
50 static void DirectXCloseWindow ( vout_thread_t *p_vout );
51 static long FAR PASCAL DirectXEventProc ( HWND hwnd, UINT message,
52 WPARAM wParam, LPARAM lParam );
54 static void DirectXPopupMenu( event_thread_t *p_event, vlc_bool_t b_open )
56 playlist_t *p_playlist =
57 vlc_object_find( p_event, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
58 if( p_playlist != NULL )
62 var_Set( p_playlist, "intf-popupmenu", val );
63 vlc_object_release( p_playlist );
67 /*****************************************************************************
68 * DirectXEventThread: Create video window & handle its messages
69 *****************************************************************************
70 * This function creates a video window and then enters an infinite loop
71 * that handles the messages sent to that window.
72 * The main goal of this thread is to isolate the Win32 PeekMessage function
73 * because this one can block for a long time.
74 *****************************************************************************/
75 void DirectXEventThread( event_thread_t *p_event )
78 POINT old_mouse_pos = {0,0};
80 int i_width, i_height, i_x, i_y;
84 /* Create a window for the video */
85 /* Creating a window under Windows also initializes the thread's event
87 if( DirectXCreateWindow( p_event->p_vout ) )
89 msg_Err( p_event, "out of memory" );
90 p_event->b_dead = VLC_TRUE;
93 /* signal the creation of the window */
94 vlc_thread_ready( p_event );
97 /* GetMessage will sleep if there's no message in the queue */
98 while( !p_event->b_die && ( p_event->p_vout->p_sys->hparent ||
99 GetMessage( &msg, p_event->p_vout->p_sys->hwnd, 0, 0 ) ) )
101 /* Check if we are asked to exit */
105 if( p_event->p_vout->p_sys->hparent ) msleep( INTF_IDLE_SLEEP );
107 switch( msg.message )
112 vout_PlacePicture( p_event->p_vout,
113 p_event->p_vout->p_sys->i_window_width,
114 p_event->p_vout->p_sys->i_window_height,
115 &i_x, &i_y, &i_width, &i_height );
117 val.i_int = ( GET_X_LPARAM(msg.lParam) - i_x )
118 * p_event->p_vout->render.i_width / i_width;
119 var_Set( p_event->p_vout, "mouse-x", val );
120 val.i_int = ( GET_Y_LPARAM(msg.lParam) - i_y )
121 * p_event->p_vout->render.i_height / i_height;
122 var_Set( p_event->p_vout, "mouse-y", val );
124 val.b_bool = VLC_TRUE;
125 var_Set( p_event->p_vout, "mouse-moved", val );
127 if( (abs(GET_X_LPARAM(msg.lParam) - old_mouse_pos.x) > 2 ||
128 (abs(GET_Y_LPARAM(msg.lParam) - old_mouse_pos.y)) > 2 ) )
130 GetCursorPos( &old_mouse_pos );
131 p_event->p_vout->p_sys->i_lastmoved = mdate();
133 if( p_event->p_vout->p_sys->b_cursor_hidden )
135 p_event->p_vout->p_sys->b_cursor_hidden = 0;
141 case WM_VLC_HIDE_MOUSE:
142 GetCursorPos( &old_mouse_pos );
147 var_Get( p_event->p_vout, "mouse-button-down", &val );
149 var_Set( p_event->p_vout, "mouse-button-down", val );
150 DirectXPopupMenu( p_event, VLC_FALSE );
154 var_Get( p_event->p_vout, "mouse-button-down", &val );
156 var_Set( p_event->p_vout, "mouse-button-down", val );
158 val.b_bool = VLC_TRUE;
159 var_Set( p_event->p_vout, "mouse-clicked", val );
162 case WM_LBUTTONDBLCLK:
163 p_event->p_vout->p_sys->i_changes |= VOUT_FULLSCREEN_CHANGE;
167 var_Get( p_event->p_vout, "mouse-button-down", &val );
169 var_Set( p_event->p_vout, "mouse-button-down", val );
170 DirectXPopupMenu( p_event, VLC_FALSE );
174 var_Get( p_event->p_vout, "mouse-button-down", &val );
176 var_Set( p_event->p_vout, "mouse-button-down", val );
180 var_Get( p_event->p_vout, "mouse-button-down", &val );
182 var_Set( p_event->p_vout, "mouse-button-down", val );
183 DirectXPopupMenu( p_event, VLC_FALSE );
187 var_Get( p_event->p_vout, "mouse-button-down", &val );
189 var_Set( p_event->p_vout, "mouse-button-down", val );
190 DirectXPopupMenu( p_event, VLC_TRUE );
194 /* the key events are first processed here. The next
195 * message processed by this main message loop will be the
196 * char translation of the key event */
197 msg_Dbg( p_event, "WM_KEYDOWN" );
201 if( p_event->p_vout->b_fullscreen )
203 p_event->p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
207 /* close video window */
208 PostMessage( msg.hwnd, WM_CLOSE, 0, 0 );
214 playlist_t *p_playlist =
215 vlc_object_find( p_event, VLC_OBJECT_PLAYLIST,
217 if( p_playlist != NULL )
220 var_Set( p_playlist, "intf-popupmenu", val );
221 vlc_object_release( p_playlist );
227 if( GetKeyState(VK_CONTROL) & 0x8000 )
229 input_Seek( p_event->p_vout, -60,
230 INPUT_SEEK_SECONDS | INPUT_SEEK_CUR );
234 val.psz_string = "LEFT";
235 var_Set( p_event->p_vout, "key-pressed", val );
239 if( GetKeyState(VK_CONTROL) & 0x8000 )
241 input_Seek( p_event->p_vout, 60,
242 INPUT_SEEK_SECONDS | INPUT_SEEK_CUR );
246 val.psz_string = "RIGHT";
247 var_Set( p_event->p_vout, "key-pressed", val );
251 val.psz_string = "UP";
252 var_Set( p_event->p_vout, "key-pressed", val );
255 val.psz_string = "DOWN";
256 var_Set( p_event->p_vout, "key-pressed", val );
259 val.psz_string = "ENTER";
260 var_Set( p_event->p_vout, "key-pressed", val );
263 input_Seek( p_event->p_vout, 0,
264 INPUT_SEEK_BYTES | INPUT_SEEK_SET );
267 input_Seek( p_event->p_vout, 0,
268 INPUT_SEEK_BYTES | INPUT_SEEK_END );
271 input_Seek( p_event->p_vout, 10,
272 INPUT_SEEK_SECONDS | INPUT_SEEK_CUR );
275 input_Seek( p_event->p_vout, -10,
276 INPUT_SEEK_SECONDS | INPUT_SEEK_CUR );
279 input_SetStatus( p_event->p_vout, INPUT_STATUS_PAUSE );
282 TranslateMessage(&msg);
290 /* exit application */
291 p_event->p_vlc->b_die = VLC_TRUE;
294 case 'f': /* switch to fullscreen */
296 p_event->p_vout->p_sys->i_changes |= VOUT_FULLSCREEN_CHANGE;
304 /* Messages we don't handle directly are dispatched to the
305 * window procedure */
306 TranslateMessage(&msg);
307 DispatchMessage(&msg);
312 } /* End Main loop */
314 if( msg.message == WM_QUIT )
316 msg_Warn( p_event, "WM_QUIT... should not happen!!" );
317 p_event->p_vout->p_sys->hwnd = NULL; /* Window already destroyed */
320 msg_Dbg( p_event, "DirectXEventThread terminating" );
322 /* clear the changes formerly signaled */
323 p_event->p_vout->p_sys->i_changes = 0;
325 DirectXCloseWindow( p_event->p_vout );
329 /* following functions are local */
331 /*****************************************************************************
332 * DirectXCreateWindow: create a window for the video.
333 *****************************************************************************
334 * Before creating a direct draw surface, we need to create a window in which
335 * the video will be displayed. This window will also allow us to capture the
337 *****************************************************************************/
338 static int DirectXCreateWindow( vout_thread_t *p_vout )
348 msg_Dbg( p_vout, "DirectXCreateWindow" );
350 /* Get this module's instance */
351 hInstance = GetModuleHandle(NULL);
353 /* Create a BRUSH that will be used by Windows to paint the window
355 * This window background is important for us as it will be used by the
356 * graphics card to display the overlay.
357 * This is why we carefully choose the color for this background, the goal
358 * being to choose a color which isn't complete black but nearly. We
359 * obviously don't want to use black as a colorkey for the overlay because
360 * black is one of the most used color and thus would give us undesirable
362 /* the first step is to find the colorkey we want to use. The difficulty
363 * comes from the potential dithering (depends on the display depth)
364 * because we need to know the real RGB value of the chosen colorkey */
366 for( colorkey = 0x0a; colorkey < 0xff /* all shades of red */; colorkey++ )
368 if( colorkey == GetNearestColor( hdc, colorkey ) )
373 msg_Dbg( p_vout, "background color: %i", colorkey );
375 /* Create the actual brush */
376 p_vout->p_sys->hbrush = CreateSolidBrush(colorkey);
377 p_vout->p_sys->i_rgb_colorkey = (int)colorkey;
379 /* Get the current size of the display and its colour depth */
380 p_vout->p_sys->rect_display.right = GetDeviceCaps( hdc, HORZRES );
381 p_vout->p_sys->rect_display.bottom = GetDeviceCaps( hdc, VERTRES );
382 p_vout->p_sys->i_display_depth = GetDeviceCaps( hdc, BITSPIXEL );
383 msg_Dbg( p_vout, "screen dimensions %ix%i colour depth %i",
384 p_vout->p_sys->rect_display.right,
385 p_vout->p_sys->rect_display.bottom,
386 p_vout->p_sys->i_display_depth );
388 ReleaseDC( NULL, hdc );
390 /* If an external window was specified, we'll draw in it. */
391 var_Get( p_vout->p_vlc, "drawable", &val );
392 p_vout->p_sys->hparent = p_vout->p_sys->hwnd =
393 val.i_int ? (void*)(ptrdiff_t) val.i_int : NULL;
395 if( p_vout->p_sys->hparent )
397 msg_Dbg( p_vout, "using external window %p\n", p_vout->p_sys->hwnd );
399 /* Set stuff in the window that we can not put directly in
400 * a class (see below). */
401 SetClassLong( p_vout->p_sys->hwnd,
402 GCL_STYLE, CS_DBLCLKS );
403 SetClassLong( p_vout->p_sys->hwnd,
404 GCL_HBRBACKGROUND, (LONG)p_vout->p_sys->hbrush );
405 SetClassLong( p_vout->p_sys->hwnd,
406 GCL_HCURSOR, (LONG)LoadCursor(NULL, IDC_ARROW) );
407 /* Store a p_vout pointer into the window local storage (for later
408 * use in DirectXEventProc). */
409 SetWindowLong( p_vout->p_sys->hwnd, GWL_USERDATA, (LONG)p_vout );
411 p_vout->p_sys->pf_wndproc =
412 (WNDPROC)SetWindowLong( p_vout->p_sys->hwnd,
413 GWL_WNDPROC, (LONG)DirectXEventProc );
415 /* Blam! Erase everything that might have been there. */
416 RedrawWindow( p_vout->p_sys->hwnd, NULL, NULL,
417 RDW_INVALIDATE | RDW_ERASE );
421 WNDCLASSEX wc; /* window class components */
422 HICON vlc_icon = NULL;
423 char vlc_path[MAX_PATH+1];
425 /* Get the Icon from the main app */
427 if( GetModuleFileName( NULL, vlc_path, MAX_PATH ) )
429 vlc_icon = ExtractIcon( hInstance, vlc_path, 0 );
432 /* Fill in the window class structure */
433 wc.cbSize = sizeof(WNDCLASSEX);
434 wc.style = CS_DBLCLKS; /* style: dbl click */
435 wc.lpfnWndProc = (WNDPROC)DirectXEventProc; /* event handler */
436 wc.cbClsExtra = 0; /* no extra class data */
437 wc.cbWndExtra = 0; /* no extra window data */
438 wc.hInstance = hInstance; /* instance */
439 wc.hIcon = vlc_icon; /* load the vlc big icon */
440 wc.hCursor = LoadCursor(NULL, IDC_ARROW); /* default cursor */
441 wc.hbrBackground = p_vout->p_sys->hbrush; /* background color */
442 wc.lpszMenuName = NULL; /* no menu */
443 wc.lpszClassName = "VLC DirectX"; /* use a special class */
444 wc.hIconSm = vlc_icon; /* load the vlc small icon */
446 /* Register the window class */
447 if( !RegisterClassEx(&wc) )
451 /* Free window background brush */
452 if( p_vout->p_sys->hbrush )
454 DeleteObject( p_vout->p_sys->hbrush );
455 p_vout->p_sys->hbrush = NULL;
460 DestroyIcon( vlc_icon );
463 /* Check why it failed. If it's because one already exists
464 * then fine, otherwise return with an error. */
465 if( !GetClassInfo( hInstance, "VLC DirectX", &wndclass ) )
467 msg_Err( p_vout, "DirectXCreateWindow RegisterClass FAILED" );
472 /* When you create a window you give the dimensions you wish it to
473 * have. Unfortunatly these dimensions will include the borders and
474 * titlebar. We use the following function to find out the size of
475 * the window corresponding to the useable surface we want */
476 rect_window.top = 10;
477 rect_window.left = 10;
478 rect_window.right = rect_window.left + p_vout->p_sys->i_window_width;
479 rect_window.bottom = rect_window.top + p_vout->p_sys->i_window_height;
480 AdjustWindowRect( &rect_window, WS_OVERLAPPEDWINDOW|WS_SIZEBOX, 0 );
482 /* Create the window */
483 p_vout->p_sys->hwnd =
484 CreateWindow( "VLC DirectX", /* name of window class */
485 VOUT_TITLE " (DirectX Output)", /* window title bar text */
486 WS_OVERLAPPEDWINDOW | WS_SIZEBOX, /* window style */
487 CW_USEDEFAULT, /* default X coordinate */
488 0, /* default Y coordinate */
489 rect_window.right - rect_window.left, /* window width */
490 rect_window.bottom - rect_window.top, /* window height */
491 NULL, /* no parent window */
492 NULL, /* no menu in this window */
493 hInstance, /* handle of this program instance */
494 (LPVOID)p_vout ); /* send p_vout to WM_CREATE */
496 if( !p_vout->p_sys->hwnd )
498 msg_Warn( p_vout, "DirectXCreateWindow create window FAILED" );
503 /* Append a "Always On Top" entry in the system menu */
504 hMenu = GetSystemMenu( p_vout->p_sys->hwnd, FALSE );
505 AppendMenu( hMenu, MF_SEPARATOR, 0, "" );
506 AppendMenu( hMenu, MF_STRING | MF_UNCHECKED,
507 IDM_TOGGLE_ON_TOP, "Always on &Top" );
509 /* Now display the window */
510 ShowWindow( p_vout->p_sys->hwnd, SW_SHOW );
515 /*****************************************************************************
516 * DirectXCloseWindow: close the window created by DirectXCreateWindow
517 *****************************************************************************
518 * This function returns all resources allocated by DirectXCreateWindow.
519 *****************************************************************************/
520 static void DirectXCloseWindow( vout_thread_t *p_vout )
522 msg_Dbg( p_vout, "DirectXCloseWindow" );
524 if( p_vout->p_sys->hwnd && !p_vout->p_sys->hparent )
526 DestroyWindow( p_vout->p_sys->hwnd );
528 else if( p_vout->p_sys->hparent )
530 /* We don't want our windowproc to be called anymore */
531 SetWindowLong( p_vout->p_sys->hwnd,
532 GWL_WNDPROC, (LONG)p_vout->p_sys->pf_wndproc );
534 /* Blam! Erase everything that might have been there. */
535 InvalidateRect( p_vout->p_sys->hwnd, NULL, TRUE );
538 p_vout->p_sys->hwnd = NULL;
540 /* We don't unregister the Window Class because it could lead to race
541 * conditions and it will be done anyway by the system when the app will
545 /*****************************************************************************
546 * DirectXUpdateRects: update clipping rectangles
547 *****************************************************************************
548 * This function is called when the window position or size are changed, and
549 * its job is to update the source and destination RECTs used to display the
551 *****************************************************************************/
552 void DirectXUpdateRects( vout_thread_t *p_vout, vlc_bool_t b_force )
554 #define rect_src p_vout->p_sys->rect_src
555 #define rect_src_clipped p_vout->p_sys->rect_src_clipped
556 #define rect_dest p_vout->p_sys->rect_dest
557 #define rect_dest_clipped p_vout->p_sys->rect_dest_clipped
559 int i_width, i_height, i_x, i_y;
564 /* Retrieve the window size */
565 GetClientRect( p_vout->p_sys->hwnd, &rect );
567 /* Retrieve the window position */
568 point.x = point.y = 0;
569 ClientToScreen( p_vout->p_sys->hwnd, &point );
571 /* If nothing changed, we can return */
573 && p_vout->p_sys->i_window_width == rect.right
574 && p_vout->p_sys->i_window_height == rect.bottom
575 && p_vout->p_sys->i_window_x == point.x
576 && p_vout->p_sys->i_window_y == point.y )
581 /* Update the window position and size */
582 p_vout->p_sys->i_window_x = point.x;
583 p_vout->p_sys->i_window_y = point.y;
584 p_vout->p_sys->i_window_width = rect.right;
585 p_vout->p_sys->i_window_height = rect.bottom;
587 vout_PlacePicture( p_vout, rect.right, rect.bottom,
588 &i_x, &i_y, &i_width, &i_height );
590 /* Destination image position and dimensions */
591 rect_dest.left = point.x + i_x;
592 rect_dest.right = rect_dest.left + i_width;
593 rect_dest.top = point.y + i_y;
594 rect_dest.bottom = rect_dest.top + i_height;
597 /* UpdateOverlay directdraw function doesn't automatically clip to the
598 * display size so we need to do it otherwise it will fail */
600 /* Clip the destination window */
601 IntersectRect( &rect_dest_clipped,
603 &p_vout->p_sys->rect_display );
606 msg_Dbg( p_vout, "DirectXUpdateRects image_dst_clipped coords:"
608 rect_dest_clipped.left, rect_dest_clipped.top,
609 rect_dest_clipped.right, rect_dest_clipped.bottom );
612 /* the 2 following lines are to fix a bug when clicking on the desktop */
613 if( (rect_dest_clipped.right - rect_dest_clipped.left)==0 ||
614 (rect_dest_clipped.bottom - rect_dest_clipped.top)==0 )
616 SetRectEmpty( &rect_src_clipped );
620 /* src image dimensions */
623 rect_src.right = p_vout->render.i_width;
624 rect_src.bottom = p_vout->render.i_height;
626 /* Clip the source image */
627 rect_src_clipped.left = (rect_dest_clipped.left - rect_dest.left) *
628 p_vout->render.i_width / (rect_dest.right - rect_dest.left);
629 rect_src_clipped.right = p_vout->render.i_width -
630 (rect_dest.right - rect_dest_clipped.right) * p_vout->render.i_width /
631 (rect_dest.right - rect_dest.left);
632 rect_src_clipped.top = (rect_dest_clipped.top - rect_dest.top) *
633 p_vout->render.i_height / (rect_dest.bottom - rect_dest.top);
634 rect_src_clipped.bottom = p_vout->render.i_height -
635 (rect_dest.bottom - rect_dest_clipped.bottom) * p_vout->render.i_height /
636 (rect_dest.bottom - rect_dest.top);
639 msg_Dbg( p_vout, "DirectXUpdateRects image_src_clipped"
640 " coords: %i,%i,%i,%i",
641 rect_src_clipped.left, rect_src_clipped.top,
642 rect_src_clipped.right, rect_src_clipped.bottom );
645 /* Signal the size change */
646 if( !p_vout->p_sys->p_event->b_die )
648 if( p_vout->p_sys->b_using_overlay )
650 DirectXUpdateOverlay( p_vout );
654 p_vout->p_sys->i_changes |= VOUT_SIZE_CHANGE;
659 #undef rect_src_clipped
661 #undef rect_dest_clipped
664 /*****************************************************************************
665 * DirectXEventProc: This is the window event processing function.
666 *****************************************************************************
667 * On Windows, when you create a window you have to attach an event processing
668 * function to it. The aim of this function is to manage "Queued Messages" and
669 * "Nonqueued Messages".
670 * Queued Messages are those picked up and retransmitted by vout_Manage
671 * (using the GetMessage and DispatchMessage functions).
672 * Nonqueued Messages are those that Windows will send directly to this
673 * procedure (like WM_DESTROY, WM_WINDOWPOSCHANGED...)
674 *****************************************************************************/
675 static long FAR PASCAL DirectXEventProc( HWND hwnd, UINT message,
676 WPARAM wParam, LPARAM lParam )
678 vout_thread_t *p_vout;
680 if( message == WM_CREATE )
682 /* Store p_vout for future use */
683 p_vout = (vout_thread_t *)((CREATESTRUCT *)lParam)->lpCreateParams;
684 SetWindowLong( hwnd, GWL_USERDATA, (LONG)p_vout );
688 p_vout = (vout_thread_t *)GetWindowLong( hwnd, GWL_USERDATA );
694 case WM_WINDOWPOSCHANGED:
695 DirectXUpdateRects( p_vout, VLC_TRUE );
698 /* the user wants to close the window */
701 playlist_t * p_playlist =
702 (playlist_t *)vlc_object_find( p_vout, VLC_OBJECT_PLAYLIST,
704 if( p_playlist == NULL )
709 playlist_Stop( p_playlist );
710 vlc_object_release( p_playlist );
714 /* the window has been closed so shut down everything now */
716 msg_Dbg( p_vout, "WinProc WM_DESTROY" );
717 /* just destroy the window */
718 PostQuitMessage( 0 );
724 case SC_SCREENSAVE: /* catch the screensaver */
725 case SC_MONITORPOWER: /* catch the monitor turn-off */
726 msg_Dbg( p_vout, "WinProc WM_SYSCOMMAND" );
727 return 0; /* this stops them from happening */
728 case IDM_TOGGLE_ON_TOP: /* toggle the "on top" status */
731 msg_Dbg( p_vout, "WinProc WM_SYSCOMMAND: IDM_TOGGLE_ON_TOP");
733 /* Get the current value... */
734 if( var_Get( p_vout, "directx-on-top", &val ) < 0 )
736 /* ...and change it */
737 val.b_bool = !val.b_bool;
738 var_Set( p_vout, "directx-on-top", val );
746 if( !p_vout->p_sys->b_using_overlay )
748 /* We want to eliminate unnecessary background redraws which create
749 * an annoying flickering */
750 int i_width, i_height, i_x, i_y;
752 GetClipBox( (HDC)wParam, &rect_temp );
754 msg_Dbg( p_vout, "WinProc WM_ERASEBKGND %i,%i,%i,%i",
755 rect_temp.left, rect_temp.top,
756 rect_temp.right, rect_temp.bottom );
758 vout_PlacePicture( p_vout, p_vout->p_sys->i_window_width,
759 p_vout->p_sys->i_window_height,
760 &i_x, &i_y, &i_width, &i_height );
761 ExcludeClipRect( (HDC)wParam, i_x, i_y,
762 i_x + i_width, i_y + i_height );
767 //msg_Dbg( p_vout, "WinProc WM Default %i", message );
771 return DefWindowProc(hwnd, message, wParam, lParam);