dlls/dinput/dinput_main.c

   1 /*              DirectInput
   2  *
   3  * Copyright 1998 Marcus Meissner
   4  * Copyright 1998,1999 Lionel Ulmer
   5  * Copyright 2000-2002 TransGaming Technologies Inc.
   6  * Copyright 2007 Vitaliy Margolen
   7  *
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2.1 of the License, or (at your option) any later version.
  13  *
  14  * This library 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 GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  22  */
  23
  24 #include <assert.h>
  25 #include <stdarg.h>
  26 #include <string.h>
  27
  28 #define COBJMACROS
  29 #define NONAMELESSUNION
  30
  31 #include "windef.h"
  32 #include "winbase.h"
  33 #include "winuser.h"
  34 #include "winerror.h"
  35 #include "objbase.h"
  36 #include "rpcproxy.h"
  37 #include "devguid.h"
  38 #include "hidusage.h"
  39 #include "initguid.h"
  40 #include "dinputd.h"
  41
  42 #include "dinput_private.h"
  43 #include "device_private.h"
  44
  45 #include "wine/asm.h"
  46 #include "wine/debug.h"
  47
  48 WINE_DEFAULT_DEBUG_CHANNEL(dinput);
  49
  50 #define INPUT_THREAD_MAX_DEVICES 128
  51
  52 #define INPUT_THREAD_NOTIFY     (WM_USER + 0x10)
  53 #define NOTIFY_THREAD_STOP      0
  54 #define NOTIFY_REFRESH_DEVICES  1
  55 #define NOTIFY_FOREGROUND_LOST  2
  56
  57 struct input_thread_state
  58 {
  59     BOOL running;
  60     UINT events_count;
  61     UINT devices_count;
  62     HHOOK mouse_ll_hook;
  63     HHOOK keyboard_ll_hook;
  64     RAWINPUTDEVICE rawinput_devices[2];
  65     struct dinput_device *devices[INPUT_THREAD_MAX_DEVICES];
  66     HANDLE events[INPUT_THREAD_MAX_DEVICES];
  67 };
  68
  69 static inline struct dinput_device *impl_from_IDirectInputDevice8W( IDirectInputDevice8W *iface )
  70 {
  71     return CONTAINING_RECORD( iface, struct dinput_device, IDirectInputDevice8W_iface );
  72 }
  73
  74 HINSTANCE DINPUT_instance;
  75
  76 static HWND di_em_win;
  77 static HANDLE dinput_thread;
  78 static UINT input_thread_user_count;
  79 static struct input_thread_state *input_thread_state;
  80
  81 static CRITICAL_SECTION dinput_hook_crit;
  82 static CRITICAL_SECTION_DEBUG dinput_critsect_debug =
  83 {
  84     0, 0, &dinput_hook_crit,
  85     { &dinput_critsect_debug.ProcessLocksList, &dinput_critsect_debug.ProcessLocksList },
  86       0, 0, { (DWORD_PTR)(__FILE__ ": dinput_hook_crit") }
  87 };
  88 static CRITICAL_SECTION dinput_hook_crit = { &dinput_critsect_debug, -1, 0, 0, 0, 0 };
  89
  90 static struct list acquired_device_list = LIST_INIT( acquired_device_list );
  91
  92 static void unhook_device_window_foreground_changes( struct dinput_device *device )
  93 {
  94     if (!device->cbt_hook) return;
  95     UnhookWindowsHookEx( device->cbt_hook );
  96     device->cbt_hook = NULL;
  97 }
  98
  99 static void dinput_device_internal_unacquire( IDirectInputDevice8W *iface, DWORD status )
 100 {
 101     struct dinput_device *impl = impl_from_IDirectInputDevice8W( iface );
 102
 103     TRACE( "iface %p.\n", iface );
 104
 105     unhook_device_window_foreground_changes( impl );
 106
 107     EnterCriticalSection( &impl->crit );
 108     if (impl->status == STATUS_ACQUIRED)
 109     {
 110         impl->vtbl->unacquire( iface );
 111         impl->status = status;
 112         list_remove( &impl->entry );
 113     }
 114     LeaveCriticalSection( &impl->crit );
 115 }
 116
 117 static LRESULT CALLBACK input_thread_ll_hook_proc( int code, WPARAM wparam, LPARAM lparam )
 118 {
 119     struct input_thread_state *state = input_thread_state;
 120     int i, skip = 0;
 121
 122     if (code != HC_ACTION) return CallNextHookEx( 0, code, wparam, lparam );
 123
 124     for (i = state->events_count; i < state->devices_count; ++i)
 125     {
 126         struct dinput_device *device = state->devices[i];
 127         if (device->use_raw_input) continue;
 128         if (device->instance.dwDevType & DIDEVTYPE_HID) continue;
 129         switch (GET_DIDEVICE_TYPE( device->instance.dwDevType ))
 130         {
 131         case DIDEVTYPE_MOUSE:
 132         case DI8DEVTYPE_MOUSE:
 133             TRACE( "calling dinput_mouse_hook (%p %Ix %Ix)\n", device, wparam, lparam );
 134             skip |= dinput_mouse_hook( &device->IDirectInputDevice8W_iface, wparam, lparam );
 135             break;
 136         case DIDEVTYPE_KEYBOARD:
 137         case DI8DEVTYPE_KEYBOARD:
 138             TRACE( "calling dinput_keyboard_hook (%p %Ix %Ix)\n", device, wparam, lparam );
 139             skip |= dinput_keyboard_hook( &device->IDirectInputDevice8W_iface, wparam, lparam );
 140             break;
 141         }
 142     }
 143
 144     return skip ? 1 : CallNextHookEx( 0, code, wparam, lparam );
 145 }
 146
 147 static void dinput_unacquire_window_devices( HWND window )
 148 {
 149     struct dinput_device *impl, *next;
 150
 151     EnterCriticalSection( &dinput_hook_crit );
 152
 153     LIST_FOR_EACH_ENTRY_SAFE( impl, next, &acquired_device_list, struct dinput_device, entry )
 154     {
 155         if (window != impl->win) continue;
 156         TRACE( "%p window is not foreground - unacquiring %p\n", impl->win, impl );
 157         dinput_device_internal_unacquire( &impl->IDirectInputDevice8W_iface, STATUS_UNACQUIRED );
 158     }
 159
 160     LeaveCriticalSection( &dinput_hook_crit );
 161 }
 162
 163 static void dinput_unacquire_devices(void)
 164 {
 165     struct dinput_device *impl, *next;
 166
 167     EnterCriticalSection( &dinput_hook_crit );
 168
 169     LIST_FOR_EACH_ENTRY_SAFE( impl, next, &acquired_device_list, struct dinput_device, entry )
 170         dinput_device_internal_unacquire( &impl->IDirectInputDevice8W_iface, STATUS_UNACQUIRED );
 171
 172     LeaveCriticalSection( &dinput_hook_crit );
 173 }
 174
 175 static LRESULT CALLBACK cbt_hook_proc( int code, WPARAM wparam, LPARAM lparam )
 176 {
 177     if (code == HCBT_ACTIVATE && di_em_win)
 178     {
 179         CBTACTIVATESTRUCT *data = (CBTACTIVATESTRUCT *)lparam;
 180         SendMessageW( di_em_win, INPUT_THREAD_NOTIFY, NOTIFY_FOREGROUND_LOST,
 181                       (LPARAM)data->hWndActive );
 182     }
 183
 184     return CallNextHookEx( 0, code, wparam, lparam );
 185 }
 186
 187 static void hook_device_window_foreground_changes( struct dinput_device *device )
 188 {
 189     DWORD tid, pid;
 190     if (!(tid = GetWindowThreadProcessId( device->win, &pid ))) return;
 191     device->cbt_hook = SetWindowsHookExW( WH_CBT, cbt_hook_proc, DINPUT_instance, tid );
 192 }
 193
 194 static void input_thread_update_device_list( struct input_thread_state *state )
 195 {
 196     RAWINPUTDEVICE rawinput_keyboard = {.usUsagePage = HID_USAGE_PAGE_GENERIC, .usUsage = HID_USAGE_GENERIC_KEYBOARD, .dwFlags = RIDEV_REMOVE};
 197     RAWINPUTDEVICE rawinput_mouse = {.usUsagePage = HID_USAGE_PAGE_GENERIC, .usUsage = HID_USAGE_GENERIC_MOUSE, .dwFlags = RIDEV_REMOVE};
 198     UINT count = 0, keyboard_ll_count = 0, mouse_ll_count = 0;
 199     struct dinput_device *device;
 200
 201     EnterCriticalSection( &dinput_hook_crit );
 202     LIST_FOR_EACH_ENTRY( device, &acquired_device_list, struct dinput_device, entry )
 203     {
 204         unhook_device_window_foreground_changes( device );
 205         if (device->dwCoopLevel & DISCL_FOREGROUND) hook_device_window_foreground_changes( device );
 206
 207         if (!device->read_event || !device->vtbl->read) continue;
 208         state->events[count] = device->read_event;
 209         dinput_device_internal_addref( (state->devices[count] = device) );
 210         if (++count >= INPUT_THREAD_MAX_DEVICES) break;
 211     }
 212     state->events_count = count;
 213
 214     LIST_FOR_EACH_ENTRY( device, &acquired_device_list, struct dinput_device, entry )
 215     {
 216         RAWINPUTDEVICE *rawinput_device = NULL;
 217
 218         if (device->read_event && device->vtbl->read) continue;
 219         switch (GET_DIDEVICE_TYPE( device->instance.dwDevType ))
 220         {
 221         case DIDEVTYPE_MOUSE:
 222         case DI8DEVTYPE_MOUSE:
 223             if (device->dwCoopLevel & DISCL_EXCLUSIVE) rawinput_mouse.dwFlags |= RIDEV_CAPTUREMOUSE;
 224             if (!device->use_raw_input) mouse_ll_count++;
 225             else rawinput_device = &rawinput_mouse;
 226             break;
 227         case DIDEVTYPE_KEYBOARD:
 228         case DI8DEVTYPE_KEYBOARD:
 229             if (device->dwCoopLevel & DISCL_EXCLUSIVE) rawinput_keyboard.dwFlags |= RIDEV_NOHOTKEYS;
 230             if (!device->use_raw_input) keyboard_ll_count++;
 231             else rawinput_device = &rawinput_keyboard;
 232             break;
 233         }
 234
 235         if (rawinput_device)
 236         {
 237             if (device->dwCoopLevel & DISCL_BACKGROUND) rawinput_device->dwFlags |= RIDEV_INPUTSINK;
 238             if (device->dwCoopLevel & DISCL_EXCLUSIVE) rawinput_device->dwFlags |= RIDEV_NOLEGACY;
 239             rawinput_device->dwFlags &= ~RIDEV_REMOVE;
 240             rawinput_device->hwndTarget = di_em_win;
 241         }
 242
 243         if (count < INPUT_THREAD_MAX_DEVICES) dinput_device_internal_addref( (state->devices[count++] = device) );
 244     }
 245     state->devices_count = count;
 246     LeaveCriticalSection( &dinput_hook_crit );
 247
 248     if (keyboard_ll_count && !state->keyboard_ll_hook)
 249         state->keyboard_ll_hook = SetWindowsHookExW( WH_KEYBOARD_LL, input_thread_ll_hook_proc, DINPUT_instance, 0 );
 250     else if (!keyboard_ll_count && state->keyboard_ll_hook)
 251     {
 252         UnhookWindowsHookEx( state->keyboard_ll_hook );
 253         state->keyboard_ll_hook = NULL;
 254     }
 255
 256     if (mouse_ll_count && !state->mouse_ll_hook)
 257         state->mouse_ll_hook = SetWindowsHookExW( WH_MOUSE_LL, input_thread_ll_hook_proc, DINPUT_instance, 0 );
 258     else if (!mouse_ll_count && state->mouse_ll_hook)
 259     {
 260         UnhookWindowsHookEx( state->mouse_ll_hook );
 261         state->mouse_ll_hook = NULL;
 262     }
 263
 264     if (!rawinput_mouse.hwndTarget != !state->rawinput_devices[0].hwndTarget &&
 265         !RegisterRawInputDevices( &rawinput_mouse, 1, sizeof(RAWINPUTDEVICE) ))
 266         WARN( "Failed to (un)register rawinput mouse device.\n" );
 267     if (!rawinput_keyboard.hwndTarget != !state->rawinput_devices[1].hwndTarget &&
 268         !RegisterRawInputDevices( &rawinput_keyboard, 1, sizeof(RAWINPUTDEVICE) ))
 269         WARN( "Failed to (un)register rawinput mouse device.\n" );
 270
 271     state->rawinput_devices[0] = rawinput_mouse;
 272     state->rawinput_devices[1] = rawinput_keyboard;
 273 }
 274
 275 static LRESULT WINAPI di_em_win_wndproc(HWND hwnd, UINT msg, WPARAM wparam, LPARAM lparam)
 276 {
 277     struct input_thread_state *state = input_thread_state;
 278     int rim = GET_RAWINPUT_CODE_WPARAM( wparam );
 279     UINT i, size = sizeof(RAWINPUT);
 280     RAWINPUT ri;
 281
 282     TRACE( "%p %d %Ix %Ix\n", hwnd, msg, wparam, lparam );
 283
 284     if (msg == WM_INPUT && (rim == RIM_INPUT || rim == RIM_INPUTSINK))
 285     {
 286         size = GetRawInputData( (HRAWINPUT)lparam, RID_INPUT, &ri, &size, sizeof(RAWINPUTHEADER) );
 287         if (size == (UINT)-1 || size < sizeof(RAWINPUTHEADER))
 288             WARN( "Unable to read raw input data\n" );
 289         else if (ri.header.dwType == RIM_TYPEHID)
 290             WARN( "Unexpected HID rawinput message\n" );
 291         else
 292         {
 293             for (i = state->events_count; i < state->devices_count; ++i)
 294             {
 295                 struct dinput_device *device = state->devices[i];
 296                 if (!device->use_raw_input) continue;
 297                 if (device->instance.dwDevType & DIDEVTYPE_HID) continue;
 298                 switch (GET_DIDEVICE_TYPE( device->instance.dwDevType ))
 299                 {
 300                 case DIDEVTYPE_MOUSE:
 301                 case DI8DEVTYPE_MOUSE:
 302                     if (ri.header.dwType != RIM_TYPEMOUSE) break;
 303                     dinput_mouse_rawinput_hook( &device->IDirectInputDevice8W_iface, wparam, lparam, &ri );
 304                     break;
 305                 case DIDEVTYPE_KEYBOARD:
 306                 case DI8DEVTYPE_KEYBOARD:
 307                     if (ri.header.dwType != RIM_TYPEKEYBOARD) break;
 308                     dinput_keyboard_rawinput_hook( &device->IDirectInputDevice8W_iface, wparam, lparam, &ri );
 309                     break;
 310                 default: break;
 311                 }
 312             }
 313         }
 314     }
 315
 316     if (msg == INPUT_THREAD_NOTIFY)
 317     {
 318         TRACE( "Processing hook change notification wparam %#Ix, lparam %#Ix.\n", wparam, lparam );
 319
 320         switch (wparam)
 321         {
 322         case NOTIFY_THREAD_STOP:
 323             state->running = FALSE;
 324             break;
 325         case NOTIFY_REFRESH_DEVICES:
 326             while (state->devices_count--) dinput_device_internal_release( state->devices[state->devices_count] );
 327             input_thread_update_device_list( state );
 328             break;
 329         case NOTIFY_FOREGROUND_LOST:
 330             dinput_unacquire_window_devices( (HWND)lparam );
 331             break;
 332         }
 333
 334         return 0;
 335     }
 336
 337     return DefWindowProcW( hwnd, msg, wparam, lparam );
 338 }
 339
 340 static void register_di_em_win_class(void)
 341 {
 342     WNDCLASSEXW class;
 343
 344     memset(&class, 0, sizeof(class));
 345     class.cbSize = sizeof(class);
 346     class.lpfnWndProc = di_em_win_wndproc;
 347     class.hInstance = DINPUT_instance;
 348     class.lpszClassName = L"DIEmWin";
 349
 350     if (!RegisterClassExW( &class ) && GetLastError() != ERROR_CLASS_ALREADY_EXISTS)
 351         WARN( "Unable to register message window class\n" );
 352 }
 353
 354 static void unregister_di_em_win_class(void)
 355 {
 356     if (!UnregisterClassW( L"DIEmWin", NULL ) && GetLastError() != ERROR_CLASS_DOES_NOT_EXIST)
 357         WARN( "Unable to unregister message window class\n" );
 358 }
 359
 360 static DWORD WINAPI dinput_thread_proc( void *params )
 361 {
 362     struct input_thread_state state = {.running = TRUE};
 363     struct dinput_device *device;
 364     HANDLE start_event = params;
 365     DWORD ret;
 366     MSG msg;
 367
 368     di_em_win = CreateWindowW( L"DIEmWin", L"DIEmWin", 0, 0, 0, 0, 0, HWND_MESSAGE, 0, DINPUT_instance, NULL );
 369     input_thread_state = &state;
 370     SetEvent( start_event );
 371
 372     while (state.running && (ret = MsgWaitForMultipleObjectsEx( state.events_count, state.events, INFINITE, QS_ALLINPUT, 0 )) <= state.events_count)
 373     {
 374         if (ret < state.events_count)
 375         {
 376             if ((device = state.devices[ret]) && FAILED( device->vtbl->read( &device->IDirectInputDevice8W_iface ) ))
 377             {
 378                 EnterCriticalSection( &dinput_hook_crit );
 379                 dinput_device_internal_unacquire( &device->IDirectInputDevice8W_iface, STATUS_UNPLUGGED );
 380                 LeaveCriticalSection( &dinput_hook_crit );
 381
 382                 state.events[ret] = state.events[--state.events_count];
 383                 state.devices[ret] = state.devices[state.events_count];
 384                 state.devices[state.events_count] = state.devices[--state.devices_count];
 385                 dinput_device_internal_release( device );
 386             }
 387         }
 388
 389         while (PeekMessageW( &msg, 0, 0, 0, PM_REMOVE ))
 390         {
 391             TranslateMessage(&msg);
 392             DispatchMessageW(&msg);
 393         }
 394     }
 395
 396     if (state.running)
 397     {
 398         ERR( "Unexpected termination, ret %#lx\n", ret );
 399         dinput_unacquire_devices();
 400     }
 401
 402     while (state.devices_count--) dinput_device_internal_release( state.devices[state.devices_count] );
 403     if (state.keyboard_ll_hook) UnhookWindowsHookEx( state.keyboard_ll_hook );
 404     if (state.mouse_ll_hook) UnhookWindowsHookEx( state.mouse_ll_hook );
 405     DestroyWindow( di_em_win );
 406     di_em_win = NULL;
 407     return 0;
 408 }
 409
 410 void input_thread_start(void)
 411 {
 412     HANDLE start_event;
 413
 414     TRACE( "Starting input thread.\n" );
 415
 416     if (!(start_event = CreateEventW( NULL, FALSE, FALSE, NULL )))
 417         ERR( "Failed to create start event, error %lu\n", GetLastError() );
 418     else if (!(dinput_thread = CreateThread( NULL, 0, dinput_thread_proc, start_event, 0, NULL )))
 419         ERR( "Failed to create internal thread, error %lu\n", GetLastError() );
 420     else
 421         WaitForSingleObject( start_event, INFINITE );
 422
 423     CloseHandle( start_event );
 424 }
 425
 426 void dinput_hooks_acquire_device( IDirectInputDevice8W *iface )
 427 {
 428     struct dinput_device *impl = impl_from_IDirectInputDevice8W( iface );
 429
 430     EnterCriticalSection( &dinput_hook_crit );
 431     /* start the input thread now if it wasn't started already */
 432     if (!dinput_thread) input_thread_start();
 433     list_add_tail( &acquired_device_list, &impl->entry );
 434     LeaveCriticalSection( &dinput_hook_crit );
 435
 436     SendMessageW( di_em_win, INPUT_THREAD_NOTIFY, NOTIFY_REFRESH_DEVICES, 0 );
 437 }
 438
 439 void dinput_hooks_unacquire_device( IDirectInputDevice8W *iface )
 440 {
 441     struct dinput_device *impl = impl_from_IDirectInputDevice8W( iface );
 442
 443     EnterCriticalSection( &dinput_hook_crit );
 444     list_remove( &impl->entry );
 445     LeaveCriticalSection( &dinput_hook_crit );
 446
 447     SendMessageW( di_em_win, INPUT_THREAD_NOTIFY, NOTIFY_REFRESH_DEVICES, 0 );
 448 }
 449
 450 void input_thread_add_user(void)
 451 {
 452     /* we cannot start the input thread here because some games create dinput objects from their DllMain, and
 453      * starting the thread will wait for it to initialize, which requires the loader lock to be released.
 454      */
 455     EnterCriticalSection( &dinput_hook_crit );
 456     input_thread_user_count++;
 457     LeaveCriticalSection( &dinput_hook_crit );
 458 }
 459
 460 void input_thread_remove_user(void)
 461 {
 462     EnterCriticalSection( &dinput_hook_crit );
 463     if (!--input_thread_user_count && dinput_thread)
 464     {
 465         TRACE( "Stopping input thread.\n" );
 466
 467         SendMessageW( di_em_win, INPUT_THREAD_NOTIFY, NOTIFY_THREAD_STOP, 0 );
 468         WaitForSingleObject( dinput_thread, INFINITE );
 469         CloseHandle( dinput_thread );
 470         dinput_thread = NULL;
 471     }
 472     LeaveCriticalSection( &dinput_hook_crit );
 473 }
 474
 475 void check_dinput_events(void)
 476 {
 477     /* Windows does not do that, but our current implementation of winex11
 478      * requires periodic event polling to forward events to the wineserver.
 479      *
 480      * We have to call this function from multiple places, because:
 481      * - some games do not explicitly poll for mouse events
 482      *   (for example Culpa Innata)
 483      * - some games only poll the device, and neither keyboard nor mouse
 484      *   (for example Civilization: Call to Power 2)
 485      * - some games do not explicitly poll for keyboard events
 486      *   (for example Morrowind in its key binding page)
 487      */
 488     MsgWaitForMultipleObjectsEx(0, NULL, 0, QS_ALLINPUT, 0);
 489 }
 490
 491 BOOL WINAPI DllMain( HINSTANCE inst, DWORD reason, void *reserved )
 492 {
 493     TRACE( "inst %p, reason %lu, reserved %p.\n", inst, reason, reserved );
 494
 495     switch(reason)
 496     {
 497       case DLL_PROCESS_ATTACH:
 498         DisableThreadLibraryCalls(inst);
 499         DINPUT_instance = inst;
 500         register_di_em_win_class();
 501         break;
 502       case DLL_PROCESS_DETACH:
 503         if (reserved) break;
 504         unregister_di_em_win_class();
 505         break;
 506     }
 507     return TRUE;
 508 }