1 /*****************************************************************************
2 * vout_events.c: Windows DirectX video output events handler
3 *****************************************************************************
4 * Copyright (C) 2001 VideoLAN
5 * $Id: vout_events.c,v 1.17 2002/05/18 15:34:04 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() */
33 #include <videolan/vlc.h>
38 #include "video_output.h"
46 #include "interface.h"
48 #include "vout_directx.h"
50 /*****************************************************************************
52 *****************************************************************************/
53 static int DirectXCreateWindow( vout_thread_t *p_vout );
54 static void DirectXCloseWindow ( vout_thread_t *p_vout );
55 static void DirectXUpdateRects( vout_thread_t *p_vout );
56 static long FAR PASCAL DirectXEventProc ( HWND hwnd, UINT message,
57 WPARAM wParam, LPARAM lParam );
59 /*****************************************************************************
60 * DirectXEventThread: Create video window & handle its messages
61 *****************************************************************************
62 * This function creates a video window and then enters an infinite loop
63 * that handles the messages sent to that window.
64 * The main goal of this thread is to isolate the Win32 PeekMessage function
65 * because this one can block for a long time.
66 *****************************************************************************/
67 void DirectXEventThread( vout_thread_t *p_vout )
74 /* Create a window for the video */
75 /* Creating a window under Windows also initializes the thread's event
77 vlc_mutex_lock( &p_vout->p_sys->event_thread_lock );
78 if( DirectXCreateWindow( p_vout ) )
80 intf_ErrMsg( "vout error: can't create window" );
81 p_vout->p_sys->i_event_thread_status = THREAD_FATAL;
82 p_vout->p_sys->b_event_thread_die = 1;
84 else p_vout->p_sys->i_event_thread_status = THREAD_READY;
86 /* signal the creation of the window */
87 vlc_cond_signal( &p_vout->p_sys->event_thread_wait );
88 vlc_mutex_unlock( &p_vout->p_sys->event_thread_lock );
91 /* GetMessage will sleep if there's no message in the queue */
92 while( !p_vout->p_sys->b_event_thread_die
93 && GetMessage( &msg, p_vout->p_sys->hwnd, 0, 0 ) )
96 /* Check if we are asked to exit */
97 if( p_vout->b_die || p_vout->p_sys->b_event_thread_die )
100 switch( msg.message )
105 if( (abs(GET_X_LPARAM(msg.lParam) - old_mouse_pos.x) > 2 ||
106 (abs(GET_Y_LPARAM(msg.lParam) - old_mouse_pos.y)) > 2 ) )
108 GetCursorPos( &old_mouse_pos );
109 p_vout->p_sys->i_lastmoved = mdate();
111 if( p_vout->p_sys->b_cursor_hidden )
113 p_vout->p_sys->b_cursor_hidden = 0;
119 case WM_VLC_HIDE_MOUSE:
120 GetCursorPos( &old_mouse_pos );
125 p_main->p_intf->b_menu_change = 1;
131 case WM_LBUTTONDBLCLK:
132 p_vout->p_sys->i_changes |= VOUT_FULLSCREEN_CHANGE;
136 /* the key events are first processed here. The next
137 * message processed by this main message loop will be the
138 * char translation of the key event */
139 intf_WarnMsg( 3, "vout: vout_Manage WM_KEYDOWN" );
144 /* exit application */
145 p_main->p_intf->b_die = p_vout->p_sys->b_event_thread_die = 1;
148 TranslateMessage(&msg);
156 /* exit application */
157 p_main->p_intf->b_die = p_vout->p_sys->b_event_thread_die = 1;
160 case 'f': /* switch to fullscreen */
162 p_vout->p_sys->i_changes |= VOUT_FULLSCREEN_CHANGE;
165 case 'c': /* toggle grayscale */
167 p_vout->b_grayscale = ! p_vout->b_grayscale;
168 p_vout->p_sys->i_changes |= VOUT_GRAYSCALE_CHANGE;
171 case 'i': /* toggle info */
173 p_vout->b_info = ! p_vout->b_info;
174 p_vout->p_sys->i_changes |= VOUT_INFO_CHANGE;
177 case 's': /* toggle scaling */
179 p_vout->b_scale = ! p_vout->b_scale;
180 p_vout->p_sys->i_changes |= VOUT_SCALE_CHANGE;
183 case ' ': /* toggle interface */
184 p_vout->b_interface = ! p_vout->b_interface;
185 p_vout->p_sys->i_changes |= VOUT_INTF_CHANGE;
188 case '0': network_ChannelJoin( 0 ); break;
189 case '1': network_ChannelJoin( 1 ); break;
190 case '2': network_ChannelJoin( 2 ); break;
191 case '3': network_ChannelJoin( 3 ); break;
192 case '4': network_ChannelJoin( 4 ); break;
193 case '5': network_ChannelJoin( 5 ); break;
194 case '6': network_ChannelJoin( 6 ); break;
195 case '7': network_ChannelJoin( 7 ); break;
196 case '8': network_ChannelJoin( 8 ); break;
197 case '9': network_ChannelJoin( 9 ); break;
204 /* Messages we don't handle directly are dispatched to the
205 * window procedure */
206 TranslateMessage(&msg);
207 DispatchMessage(&msg);
212 } /* End Main loop */
214 if( msg.message == WM_QUIT )
216 intf_WarnMsg( 3, "vout: DirectXEventThread WM_QUIT... "
217 "shouldn't happen!!" );
218 p_vout->p_sys->hwnd = NULL; /* Window already destroyed */
221 intf_WarnMsg( 3, "vout: DirectXEventThread Terminating" );
223 /* clear the changes formerly signaled */
224 p_vout->p_sys->i_changes = 0;
226 DirectXCloseWindow( p_vout );
230 /* following functions are local */
232 /*****************************************************************************
233 * DirectXCreateWindow: create a window for the video.
234 *****************************************************************************
235 * Before creating a direct draw surface, we need to create a window in which
236 * the video will be displayed. This window will also allow us to capture the
238 *****************************************************************************/
239 static int DirectXCreateWindow( vout_thread_t *p_vout )
242 WNDCLASSEX wc; /* window class components */
246 HICON vlc_icon = NULL;
247 char vlc_path[_MAX_PATH+1];
249 intf_WarnMsg( 3, "vout: DirectXCreateWindow" );
251 /* get this module's instance */
252 hInstance = GetModuleHandle(NULL);
254 /* Create a BRUSH that will be used by Windows to paint the window
256 * This window background is important for us as it will be used by the
257 * graphics card to display the overlay.
258 * This is why we carefully choose the color for this background, the goal
259 * being to choose a color which isn't complete black but nearly. We
260 * obviously don't want to use black as a colorkey for the overlay because
261 * black is one of the most used color and thus would give us undesirable
263 /* the first step is to find the colorkey we want to use. The difficulty
264 * comes from the potential dithering (depends on the display depth)
265 * because we need to know the real RGB value of the chosen colorkey */
267 for( colorkey = 5; colorkey < 0xFF /*all shades of red*/; colorkey++ )
269 if( colorkey == GetNearestColor( hdc, colorkey ) )
272 intf_WarnMsg(3,"vout: DirectXCreateWindow background color:%i", colorkey);
274 /* create the actual brush */
275 p_vout->p_sys->hbrush = CreateSolidBrush(colorkey);
276 p_vout->p_sys->i_rgb_colorkey = (int)colorkey;
278 /* Get the current size of the display and its colour depth */
279 p_vout->p_sys->rect_display.right = GetDeviceCaps( hdc, HORZRES );
280 p_vout->p_sys->rect_display.bottom = GetDeviceCaps( hdc, VERTRES );
281 p_vout->p_sys->i_display_depth = GetDeviceCaps( hdc, BITSPIXEL );
282 intf_WarnMsg( 3, "vout: Screen dimensions %ix%i colour depth %i",
283 p_vout->p_sys->rect_display.right,
284 p_vout->p_sys->rect_display.bottom,
285 p_vout->p_sys->i_display_depth );
287 ReleaseDC( p_vout->p_sys->hwnd, hdc );
289 /* Get the Icon from the main app */
291 if( GetModuleFileName( NULL, vlc_path, _MAX_PATH ) )
293 vlc_icon = ExtractIcon( hInstance, vlc_path, 0 );
297 /* fill in the window class structure */
298 wc.cbSize = sizeof(WNDCLASSEX);
299 wc.style = CS_DBLCLKS; /* style: dbl click */
300 wc.lpfnWndProc = (WNDPROC)DirectXEventProc; /* event handler */
301 wc.cbClsExtra = 0; /* no extra class data */
302 wc.cbWndExtra = 0; /* no extra window data */
303 wc.hInstance = hInstance; /* instance */
304 wc.hIcon = vlc_icon; /* load the vlc icon */
305 wc.hCursor = LoadCursor(NULL, IDC_ARROW); /* load a default cursor */
306 wc.hbrBackground = p_vout->p_sys->hbrush; /* background color */
307 wc.lpszMenuName = NULL; /* no menu */
308 wc.lpszClassName = "VLC DirectX"; /* use a special class */
309 wc.hIconSm = vlc_icon; /* load the vlc icon */
311 /* register the window class */
312 if (!RegisterClassEx(&wc))
316 /* free window background brush */
317 if( p_vout->p_sys->hbrush )
319 DeleteObject( p_vout->p_sys->hbrush );
320 p_vout->p_sys->hbrush = NULL;
324 DestroyIcon( vlc_icon );
326 /* Check why it failed. If it's because one already exists then fine */
327 if( !GetClassInfo( hInstance, "VLC DirectX", &wndclass ) )
329 intf_ErrMsg( "vout: DirectXCreateWindow RegisterClass FAILED" );
334 /* when you create a window you give the dimensions you wish it to have.
335 * Unfortunatly these dimensions will include the borders and title bar.
336 * We use the following function to find out the size of the window
337 * corresponding to the useable surface we want */
338 rect_window.top = 10;
339 rect_window.left = 10;
340 rect_window.right = rect_window.left + p_vout->p_sys->i_window_width;
341 rect_window.bottom = rect_window.top + p_vout->p_sys->i_window_height;
342 AdjustWindowRect( &rect_window, WS_OVERLAPPEDWINDOW|WS_SIZEBOX, 0 );
344 /* create the window */
345 p_vout->p_sys->hwnd = CreateWindow("VLC DirectX",/* name of window class */
346 "VLC DirectX", /* window title bar text */
348 | WS_SIZEBOX, /* window style */
349 CW_USEDEFAULT, /* default X coordinate */
350 0, /* default Y coordinate */
351 rect_window.right - rect_window.left, /* window width */
352 rect_window.bottom - rect_window.top, /* window height */
353 NULL, /* no parent window */
354 NULL, /* no menu in this window */
355 hInstance, /* handle of this program instance */
356 NULL); /* no additional arguments */
358 if (p_vout->p_sys->hwnd == NULL) {
359 intf_WarnMsg( 3, "vout: DirectXCreateWindow create window FAILED" );
363 /* store a p_vout pointer into the window local storage (for later use
364 * in DirectXEventProc).
365 * We need to use SetWindowLongPtr when it is available in mingw */
366 SetWindowLong( p_vout->p_sys->hwnd, GWL_USERDATA, (LONG)p_vout );
368 /* now display the window */
369 ShowWindow(p_vout->p_sys->hwnd, SW_SHOW);
374 /*****************************************************************************
375 * DirectXCloseWindow: close the window created by DirectXCreateWindow
376 *****************************************************************************
377 * This function returns all resources allocated by DirectXCreateWindow.
378 *****************************************************************************/
379 static void DirectXCloseWindow( vout_thread_t *p_vout )
381 intf_WarnMsg( 3, "vout: DirectXCloseWindow" );
382 if( p_vout->p_sys->hwnd != NULL )
384 DestroyWindow( p_vout->p_sys->hwnd );
385 p_vout->p_sys->hwnd = NULL;
388 /* We don't unregister the Window Class because it could lead to race
389 * conditions and it will be done anyway by the system when the app will
393 /*****************************************************************************
394 * DirectXUpdateRects:
395 *****************************************************************************
396 * This function is called when the window position and size is changed, and
397 * its job is to update the source and destination RECTs used to display the
399 *****************************************************************************/
400 static void DirectXUpdateRects( vout_thread_t *p_vout )
402 int i_width, i_height, i_x, i_y;
404 #define rect_src p_vout->p_sys->rect_src
405 #define rect_src_clipped p_vout->p_sys->rect_src_clipped
406 #define rect_dest p_vout->p_sys->rect_dest
407 #define rect_dest_clipped p_vout->p_sys->rect_dest_clipped
408 #define rect_display p_vout->p_sys->rect_display
410 vout_PlacePicture( p_vout, p_vout->p_sys->i_window_width,
411 p_vout->p_sys->i_window_height,
412 &i_x, &i_y, &i_width, &i_height );
414 /* Destination image position and dimensions */
415 rect_dest.left = i_x + p_vout->p_sys->i_window_x;
416 rect_dest.top = i_y + p_vout->p_sys->i_window_y;
417 rect_dest.right = rect_dest.left + i_width;
418 rect_dest.bottom = rect_dest.top + i_height;
421 /* UpdateOverlay directdraw function doesn't automatically clip to the
422 * display size so we need to do it otherwise it will fails */
424 /* Clip the destination window */
425 IntersectRect( &rect_dest_clipped, &rect_dest, &rect_display );
428 intf_WarnMsg( 3, "vout: DirectXUpdateRects image_dst_clipped coords:"
430 rect_dest_clipped.left, rect_dest_clipped.top,
431 rect_dest_clipped.right, rect_dest_clipped.bottom);
434 /* the 2 following lines are to fix a bug when clicking on the desktop */
435 if( (rect_dest_clipped.right - rect_dest_clipped.left)==0 ||
436 (rect_dest_clipped.bottom - rect_dest_clipped.top)==0 )
438 SetRectEmpty( &rect_src_clipped );
442 /* src image dimensions */
445 rect_src.right = p_vout->render.i_width;
446 rect_src.bottom = p_vout->render.i_height;
448 /* Clip the source image */
449 rect_src_clipped.left = (rect_dest_clipped.left - rect_dest.left) *
450 p_vout->render.i_width / (rect_dest.right - rect_dest.left);
451 rect_src_clipped.right = p_vout->render.i_width -
452 (rect_dest.right - rect_dest_clipped.right) * p_vout->render.i_width /
453 (rect_dest.right - rect_dest.left);
454 rect_src_clipped.top = (rect_dest_clipped.top - rect_dest.top) *
455 p_vout->render.i_height / (rect_dest.bottom - rect_dest.top);
456 rect_src_clipped.bottom = p_vout->render.i_height -
457 (rect_dest.bottom - rect_dest_clipped.bottom) * p_vout->render.i_height /
458 (rect_dest.bottom - rect_dest.top);
461 intf_WarnMsg( 3, "vout: DirectXUpdateRects image_src_clipped"
462 " coords: %i,%i,%i,%i",
463 rect_src_clipped.left, rect_src_clipped.top,
464 rect_src_clipped.right, rect_src_clipped.bottom);
468 #undef rect_src_clipped
470 #undef rect_dest_clipped
474 /*****************************************************************************
475 * DirectXEventProc: This is the window event processing function.
476 *****************************************************************************
477 * On Windows, when you create a window you have to attach an event processing
478 * function to it. The aim of this function is to manage "Queued Messages" and
479 * "Nonqueued Messages".
480 * Queued Messages are those picked up and retransmitted by vout_Manage
481 * (using the GetMessage and DispatchMessage functions).
482 * Nonqueued Messages are those that Windows will send directly to this
483 * procedure (like WM_DESTROY, WM_WINDOWPOSCHANGED...)
484 *****************************************************************************/
485 static long FAR PASCAL DirectXEventProc( HWND hwnd, UINT message,
486 WPARAM wParam, LPARAM lParam )
488 vout_thread_t *p_vout;
493 case WM_WINDOWPOSCHANGED:
498 p_vout = (vout_thread_t *)GetWindowLong( hwnd, GWL_USERDATA );
500 /* update the window position */
503 ClientToScreen( hwnd, &point_window );
504 p_vout->p_sys->i_window_x = point_window.x;
505 p_vout->p_sys->i_window_y = point_window.y;
507 /* update the window size */
508 GetClientRect( hwnd, &rect_window );
509 p_vout->p_sys->i_window_width = rect_window.right;
510 p_vout->p_sys->i_window_height = rect_window.bottom;
512 DirectXUpdateRects( p_vout );
513 if( p_vout->p_sys->b_using_overlay &&
514 !p_vout->p_sys->b_event_thread_die )
515 DirectXUpdateOverlay( p_vout );
517 /* signal the size change */
518 if( !p_vout->p_sys->b_using_overlay &&
519 !p_vout->p_sys->b_event_thread_die )
520 p_vout->p_sys->i_changes |= VOUT_SIZE_CHANGE;
526 /* the user wants to close the window */
528 intf_WarnMsg( 4, "vout: WinProc WM_CLOSE" );
529 /* exit application */
530 p_vout = (vout_thread_t *)GetWindowLong( hwnd, GWL_USERDATA );
531 p_main->p_intf->b_die = p_vout->p_sys->b_event_thread_die = 1;
538 case SC_SCREENSAVE: /* catch the screensaver */
539 case SC_MONITORPOWER: /* catch the monitor turn-off */
540 intf_WarnMsg( 3, "vout: WinProc WM_SYSCOMMAND" );
541 return 0; /* this stops them from happening */
546 p_vout = (vout_thread_t *)GetWindowLong( hwnd, GWL_USERDATA );
547 if( !p_vout->p_sys->b_using_overlay )
549 /* We want to eliminate unnecessary background redraws which create
550 * an annoying flickering */
551 int i_width, i_height, i_x, i_y;
553 GetClipBox( (HDC)wParam, &rect_temp );
555 intf_WarnMsg( 4, "vout: WinProc WM_ERASEBKGND %i,%i,%i,%i",
556 rect_temp.left, rect_temp.top,
557 rect_temp.right, rect_temp.bottom );
559 vout_PlacePicture( p_vout, p_vout->p_sys->i_window_width,
560 p_vout->p_sys->i_window_height,
561 &i_x, &i_y, &i_width, &i_height );
562 ExcludeClipRect( (HDC)wParam, i_x, i_y,
563 i_x + i_width, i_y + i_height );
568 //intf_WarnMsg( 4, "vout: WinProc WM Default %i", message );
572 return DefWindowProc(hwnd, message, wParam, lParam);