1 /*****************************************************************************
2 * events.c: Windows DirectX video output events handler
3 *****************************************************************************
4 * Copyright (C) 2001 VideoLAN
5 * $Id: events.c,v 1.2 2002/10/01 20:43:35 ipkiss 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() */
47 /*****************************************************************************
49 *****************************************************************************/
50 static int DirectXCreateWindow( vout_thread_t *p_vout );
51 static void DirectXCloseWindow ( vout_thread_t *p_vout );
52 static void DirectXUpdateRects( vout_thread_t *p_vout );
53 static long FAR PASCAL DirectXEventProc ( HWND hwnd, UINT message,
54 WPARAM wParam, LPARAM lParam );
56 /*****************************************************************************
57 * DirectXEventThread: Create video window & handle its messages
58 *****************************************************************************
59 * This function creates a video window and then enters an infinite loop
60 * that handles the messages sent to that window.
61 * The main goal of this thread is to isolate the Win32 PeekMessage function
62 * because this one can block for a long time.
63 *****************************************************************************/
64 void DirectXEventThread( event_thread_t *p_event )
71 /* Create a window for the video */
72 /* Creating a window under Windows also initializes the thread's event
74 if( DirectXCreateWindow( p_event->p_vout ) )
76 msg_Err( p_event, "out of memory" );
80 /* signal the creation of the window */
81 vlc_thread_ready( p_event );
84 /* GetMessage will sleep if there's no message in the queue */
85 while( !p_event->b_die
86 && GetMessage( &msg, p_event->p_vout->p_sys->hwnd, 0, 0 ) )
88 /* Check if we are asked to exit */
97 if( (abs(GET_X_LPARAM(msg.lParam) - old_mouse_pos.x) > 2 ||
98 (abs(GET_Y_LPARAM(msg.lParam) - old_mouse_pos.y)) > 2 ) )
100 GetCursorPos( &old_mouse_pos );
101 p_event->p_vout->p_sys->i_lastmoved = mdate();
103 if( p_event->p_vout->p_sys->b_cursor_hidden )
105 p_event->p_vout->p_sys->b_cursor_hidden = 0;
111 case WM_VLC_HIDE_MOUSE:
112 GetCursorPos( &old_mouse_pos );
118 intf_thread_t *p_intf;
119 p_intf = vlc_object_find( p_event, VLC_OBJECT_INTF,
123 p_intf->b_menu_change = 1;
124 vlc_object_release( p_intf );
132 case WM_LBUTTONDBLCLK:
133 p_event->p_vout->p_sys->i_changes |= VOUT_FULLSCREEN_CHANGE;
137 /* the key events are first processed here. The next
138 * message processed by this main message loop will be the
139 * char translation of the key event */
140 msg_Dbg( p_event, "WM_KEYDOWN" );
144 /* exit application */
145 p_event->p_vlc->b_die = 1;
148 case VK_F1: network_ChannelJoin( p_event, 1 ); break;
149 case VK_F2: network_ChannelJoin( p_event, 2 ); break;
150 case VK_F3: network_ChannelJoin( p_event, 3 ); break;
151 case VK_F4: network_ChannelJoin( p_event, 4 ); break;
152 case VK_F5: network_ChannelJoin( p_event, 5 ); break;
153 case VK_F6: network_ChannelJoin( p_event, 6 ); break;
154 case VK_F7: network_ChannelJoin( p_event, 7 ); break;
155 case VK_F8: network_ChannelJoin( p_event, 8 ); break;
156 case VK_F9: network_ChannelJoin( p_event, 9 ); break;
157 case VK_F10: network_ChannelJoin( p_event, 10 ); break;
158 case VK_F11: network_ChannelJoin( p_event, 11 ); break;
159 case VK_F12: network_ChannelJoin( p_event, 12 ); break;
161 TranslateMessage(&msg);
169 /* exit application */
170 p_event->p_vlc->b_die = 1;
173 case 'f': /* switch to fullscreen */
175 p_event->p_vout->p_sys->i_changes |= VOUT_FULLSCREEN_CHANGE;
178 case 'c': /* toggle grayscale */
180 p_event->p_vout->b_grayscale = ! p_event->p_vout->b_grayscale;
181 p_event->p_vout->p_sys->i_changes |= VOUT_GRAYSCALE_CHANGE;
184 case 'i': /* toggle info */
186 p_event->p_vout->b_info = ! p_event->p_vout->b_info;
187 p_event->p_vout->p_sys->i_changes |= VOUT_INFO_CHANGE;
190 case 's': /* toggle scaling */
192 p_event->p_vout->b_scale = ! p_event->p_vout->b_scale;
193 p_event->p_vout->p_sys->i_changes |= VOUT_SCALE_CHANGE;
196 case ' ': /* toggle interface */
197 p_event->p_vout->b_interface = ! p_event->p_vout->b_interface;
198 p_event->p_vout->p_sys->i_changes |= VOUT_INTF_CHANGE;
206 /* Messages we don't handle directly are dispatched to the
207 * window procedure */
208 TranslateMessage(&msg);
209 DispatchMessage(&msg);
214 } /* End Main loop */
216 if( msg.message == WM_QUIT )
218 msg_Warn( p_event, "WM_QUIT... should not happen!!" );
219 p_event->p_vout->p_sys->hwnd = NULL; /* Window already destroyed */
222 msg_Dbg( p_event, "DirectXEventThread Terminating" );
224 /* clear the changes formerly signaled */
225 p_event->p_vout->p_sys->i_changes = 0;
227 DirectXCloseWindow( p_event->p_vout );
231 /* following functions are local */
233 /*****************************************************************************
234 * DirectXCreateWindow: create a window for the video.
235 *****************************************************************************
236 * Before creating a direct draw surface, we need to create a window in which
237 * the video will be displayed. This window will also allow us to capture the
239 *****************************************************************************/
240 static int DirectXCreateWindow( vout_thread_t *p_vout )
243 WNDCLASSEX wc; /* window class components */
248 HICON vlc_icon = NULL;
249 char vlc_path[_MAX_PATH+1];
251 msg_Dbg( p_vout, "DirectXCreateWindow" );
253 /* get this module's instance */
254 hInstance = GetModuleHandle(NULL);
256 /* Create a BRUSH that will be used by Windows to paint the window
258 * This window background is important for us as it will be used by the
259 * graphics card to display the overlay.
260 * This is why we carefully choose the color for this background, the goal
261 * being to choose a color which isn't complete black but nearly. We
262 * obviously don't want to use black as a colorkey for the overlay because
263 * black is one of the most used color and thus would give us undesirable
265 /* the first step is to find the colorkey we want to use. The difficulty
266 * comes from the potential dithering (depends on the display depth)
267 * because we need to know the real RGB value of the chosen colorkey */
269 for( colorkey = 5; colorkey < 0xFF /*all shades of red*/; colorkey++ )
271 if( colorkey == GetNearestColor( hdc, colorkey ) )
274 msg_Dbg( p_vout, "background color: %i", colorkey );
276 /* create the actual brush */
277 p_vout->p_sys->hbrush = CreateSolidBrush(colorkey);
278 p_vout->p_sys->i_rgb_colorkey = (int)colorkey;
280 /* Get the current size of the display and its colour depth */
281 p_vout->p_sys->rect_display.right = GetDeviceCaps( hdc, HORZRES );
282 p_vout->p_sys->rect_display.bottom = GetDeviceCaps( hdc, VERTRES );
283 p_vout->p_sys->i_display_depth = GetDeviceCaps( hdc, BITSPIXEL );
284 msg_Dbg( p_vout, "screen dimensions %ix%i colour depth %i",
285 p_vout->p_sys->rect_display.right,
286 p_vout->p_sys->rect_display.bottom,
287 p_vout->p_sys->i_display_depth );
289 ReleaseDC( NULL, hdc );
291 /* Get the Icon from the main app */
293 if( GetModuleFileName( NULL, vlc_path, _MAX_PATH ) )
295 vlc_icon = ExtractIcon( hInstance, vlc_path, 0 );
299 /* fill in the window class structure */
300 wc.cbSize = sizeof(WNDCLASSEX);
301 wc.style = CS_DBLCLKS; /* style: dbl click */
302 wc.lpfnWndProc = (WNDPROC)DirectXEventProc; /* event handler */
303 wc.cbClsExtra = 0; /* no extra class data */
304 wc.cbWndExtra = 0; /* no extra window data */
305 wc.hInstance = hInstance; /* instance */
306 wc.hIcon = vlc_icon; /* load the vlc icon */
307 wc.hCursor = LoadCursor(NULL, IDC_ARROW); /* load a default cursor */
308 wc.hbrBackground = p_vout->p_sys->hbrush; /* background color */
309 wc.lpszMenuName = NULL; /* no menu */
310 wc.lpszClassName = "VLC DirectX"; /* use a special class */
311 wc.hIconSm = vlc_icon; /* load the vlc icon */
313 /* register the window class */
314 if (!RegisterClassEx(&wc))
318 /* free window background brush */
319 if( p_vout->p_sys->hbrush )
321 DeleteObject( p_vout->p_sys->hbrush );
322 p_vout->p_sys->hbrush = NULL;
326 DestroyIcon( vlc_icon );
328 /* Check why it failed. If it's because one already exists then fine */
329 if( !GetClassInfo( hInstance, "VLC DirectX", &wndclass ) )
331 msg_Err( p_vout, "DirectXCreateWindow RegisterClass FAILED" );
336 /* when you create a window you give the dimensions you wish it to have.
337 * Unfortunatly these dimensions will include the borders and title bar.
338 * We use the following function to find out the size of the window
339 * corresponding to the useable surface we want */
340 rect_window.top = 10;
341 rect_window.left = 10;
342 rect_window.right = rect_window.left + p_vout->p_sys->i_window_width;
343 rect_window.bottom = rect_window.top + p_vout->p_sys->i_window_height;
344 AdjustWindowRect( &rect_window, WS_OVERLAPPEDWINDOW|WS_SIZEBOX, 0 );
346 /* create the window */
347 p_vout->p_sys->hwnd = CreateWindow("VLC DirectX",/* name of window class */
348 VOUT_TITLE " (DirectX Output)", /* window title bar text */
350 | WS_SIZEBOX, /* window style */
351 CW_USEDEFAULT, /* default X coordinate */
352 0, /* default Y coordinate */
353 rect_window.right - rect_window.left, /* window width */
354 rect_window.bottom - rect_window.top, /* window height */
355 NULL, /* no parent window */
356 NULL, /* no menu in this window */
357 hInstance, /* handle of this program instance */
358 NULL); /* no additional arguments */
360 if (p_vout->p_sys->hwnd == NULL) {
361 msg_Warn( p_vout, "DirectXCreateWindow create window FAILED" );
365 /* store a p_vout pointer into the window local storage (for later use
366 * in DirectXEventProc).
367 * We need to use SetWindowLongPtr when it is available in mingw */
368 SetWindowLong( p_vout->p_sys->hwnd, GWL_USERDATA, (LONG)p_vout );
370 /* append a "Always On Top" entry in the system menu */
371 hMenu = GetSystemMenu( p_vout->p_sys->hwnd, FALSE );
372 AppendMenu( hMenu, MF_SEPARATOR, 0, "" );
373 AppendMenu( hMenu, MF_STRING | MF_UNCHECKED, IDM_TOGGLE_ON_TOP, "Always on &Top");
375 /* now display the window */
376 ShowWindow(p_vout->p_sys->hwnd, SW_SHOW);
381 /*****************************************************************************
382 * DirectXCloseWindow: close the window created by DirectXCreateWindow
383 *****************************************************************************
384 * This function returns all resources allocated by DirectXCreateWindow.
385 *****************************************************************************/
386 static void DirectXCloseWindow( vout_thread_t *p_vout )
388 msg_Dbg( p_vout, "DirectXCloseWindow" );
390 if( p_vout->p_sys->hwnd != NULL )
392 DestroyWindow( p_vout->p_sys->hwnd );
393 p_vout->p_sys->hwnd = NULL;
396 /* We don't unregister the Window Class because it could lead to race
397 * conditions and it will be done anyway by the system when the app will
401 /*****************************************************************************
402 * DirectXUpdateRects:
403 *****************************************************************************
404 * This function is called when the window position and size is changed, and
405 * its job is to update the source and destination RECTs used to display the
407 *****************************************************************************/
408 static void DirectXUpdateRects( vout_thread_t *p_vout )
410 int i_width, i_height, i_x, i_y;
412 #define rect_src p_vout->p_sys->rect_src
413 #define rect_src_clipped p_vout->p_sys->rect_src_clipped
414 #define rect_dest p_vout->p_sys->rect_dest
415 #define rect_dest_clipped p_vout->p_sys->rect_dest_clipped
416 #define rect_display p_vout->p_sys->rect_display
418 vout_PlacePicture( p_vout, p_vout->p_sys->i_window_width,
419 p_vout->p_sys->i_window_height,
420 &i_x, &i_y, &i_width, &i_height );
422 /* Destination image position and dimensions */
423 rect_dest.left = i_x + p_vout->p_sys->i_window_x;
424 rect_dest.top = i_y + p_vout->p_sys->i_window_y;
425 rect_dest.right = rect_dest.left + i_width;
426 rect_dest.bottom = rect_dest.top + i_height;
429 /* UpdateOverlay directdraw function doesn't automatically clip to the
430 * display size so we need to do it otherwise it will fails */
432 /* Clip the destination window */
433 IntersectRect( &rect_dest_clipped, &rect_dest, &rect_display );
436 msg_Dbg( p_vout, "DirectXUpdateRects image_dst_clipped coords:"
438 rect_dest_clipped.left, rect_dest_clipped.top,
439 rect_dest_clipped.right, rect_dest_clipped.bottom );
442 /* the 2 following lines are to fix a bug when clicking on the desktop */
443 if( (rect_dest_clipped.right - rect_dest_clipped.left)==0 ||
444 (rect_dest_clipped.bottom - rect_dest_clipped.top)==0 )
446 SetRectEmpty( &rect_src_clipped );
450 /* src image dimensions */
453 rect_src.right = p_vout->render.i_width;
454 rect_src.bottom = p_vout->render.i_height;
456 /* Clip the source image */
457 rect_src_clipped.left = (rect_dest_clipped.left - rect_dest.left) *
458 p_vout->render.i_width / (rect_dest.right - rect_dest.left);
459 rect_src_clipped.right = p_vout->render.i_width -
460 (rect_dest.right - rect_dest_clipped.right) * p_vout->render.i_width /
461 (rect_dest.right - rect_dest.left);
462 rect_src_clipped.top = (rect_dest_clipped.top - rect_dest.top) *
463 p_vout->render.i_height / (rect_dest.bottom - rect_dest.top);
464 rect_src_clipped.bottom = p_vout->render.i_height -
465 (rect_dest.bottom - rect_dest_clipped.bottom) * p_vout->render.i_height /
466 (rect_dest.bottom - rect_dest.top);
469 msg_Dbg( p_vout, "DirectXUpdateRects image_src_clipped"
470 " coords: %i,%i,%i,%i",
471 rect_src_clipped.left, rect_src_clipped.top,
472 rect_src_clipped.right, rect_src_clipped.bottom );
476 #undef rect_src_clipped
478 #undef rect_dest_clipped
482 /*****************************************************************************
483 * DirectXEventProc: This is the window event processing function.
484 *****************************************************************************
485 * On Windows, when you create a window you have to attach an event processing
486 * function to it. The aim of this function is to manage "Queued Messages" and
487 * "Nonqueued Messages".
488 * Queued Messages are those picked up and retransmitted by vout_Manage
489 * (using the GetMessage and DispatchMessage functions).
490 * Nonqueued Messages are those that Windows will send directly to this
491 * procedure (like WM_DESTROY, WM_WINDOWPOSCHANGED...)
492 *****************************************************************************/
493 static long FAR PASCAL DirectXEventProc( HWND hwnd, UINT message,
494 WPARAM wParam, LPARAM lParam )
496 vout_thread_t *p_vout =
497 (vout_thread_t *)GetWindowLong( hwnd, GWL_USERDATA );
502 case WM_WINDOWPOSCHANGED:
507 /* update the window position */
510 ClientToScreen( hwnd, &point_window );
511 p_vout->p_sys->i_window_x = point_window.x;
512 p_vout->p_sys->i_window_y = point_window.y;
514 /* update the window size */
515 GetClientRect( hwnd, &rect_window );
516 p_vout->p_sys->i_window_width = rect_window.right;
517 p_vout->p_sys->i_window_height = rect_window.bottom;
519 DirectXUpdateRects( p_vout );
520 if( p_vout->p_sys->b_using_overlay &&
521 !p_vout->p_sys->p_event->b_die )
522 DirectXUpdateOverlay( p_vout );
524 /* signal the size change */
525 if( !p_vout->p_sys->b_using_overlay &&
526 !p_vout->p_sys->p_event->b_die )
527 p_vout->p_sys->i_changes |= VOUT_SIZE_CHANGE;
533 /* the user wants to close the window */
535 msg_Dbg( p_vout, "WinProc WM_CLOSE" );
536 /* exit application */
537 p_vout->p_vlc->b_die = 1;
541 /* the window has been closed so shut down everything now */
543 msg_Dbg( p_vout, "WinProc WM_DESTROY" );
544 /* just destroy the window */
545 PostQuitMessage( 0 );
552 case SC_SCREENSAVE: /* catch the screensaver */
553 case SC_MONITORPOWER: /* catch the monitor turn-off */
554 msg_Dbg( p_vout, "WinProc WM_SYSCOMMAND" );
555 return 0; /* this stops them from happening */
556 case IDM_TOGGLE_ON_TOP: /* toggle the "on top" status */
558 HMENU hMenu = GetSystemMenu( hwnd , FALSE );
560 msg_Dbg( p_vout, "WinProc WM_SYSCOMMAND: IDM_TOGGLE_ON_TOP");
562 // Check if the window is already on top
563 if( GetWindowLong( hwnd, GWL_EXSTYLE ) & WS_EX_TOPMOST )
565 CheckMenuItem( hMenu, IDM_TOGGLE_ON_TOP,
566 MF_BYCOMMAND | MFS_UNCHECKED );
567 SetWindowPos( hwnd, HWND_NOTOPMOST,
569 SWP_NOSIZE | SWP_NOMOVE );
573 CheckMenuItem( hMenu, IDM_TOGGLE_ON_TOP,
574 MF_BYCOMMAND | MFS_CHECKED );
575 SetWindowPos( hwnd, HWND_TOPMOST,
577 SWP_NOSIZE | SWP_NOMOVE );
586 if( !p_vout->p_sys->b_using_overlay )
588 /* We want to eliminate unnecessary background redraws which create
589 * an annoying flickering */
590 int i_width, i_height, i_x, i_y;
592 GetClipBox( (HDC)wParam, &rect_temp );
594 msg_Dbg( p_vout, "WinProc WM_ERASEBKGND %i,%i,%i,%i",
595 rect_temp.left, rect_temp.top,
596 rect_temp.right, rect_temp.bottom );
598 vout_PlacePicture( p_vout, p_vout->p_sys->i_window_width,
599 p_vout->p_sys->i_window_height,
600 &i_x, &i_y, &i_width, &i_height );
601 ExcludeClipRect( (HDC)wParam, i_x, i_y,
602 i_x + i_width, i_y + i_height );
607 //msg_Dbg( p_vout, "WinProc WM Default %i", message );
611 return DefWindowProc(hwnd, message, wParam, lParam);