[REMIX-1578] Fix window message handling and DirectInput forwarding via new policy option

- Track both the device focus window and presentation window handles
  - Default the Remix UI activation scheme to presentation window
- Add new DirectInput device forwarding policies and options
  - `client.DirectInput.forward.mousePolicy`
  - `client.DirectInput.forward.keyboardPolicy`
  - See `bridge.conf` for details
- Deprecate old DirectInput device forwarding option
  - `client.DirectInput.forwardMessages`

Author: nv-nfreybler

bridge.conf

@@ -50,15 +50,6 @@
 # client.overrideCustomWinHooks = False
 
 
-# Forces DirectInput message forwarding to the Remix Runtime UI.
-# Typically this forwarding is only done with the Remix UI is
-# visible.
-#
-# Supported values: True, False
-
-# client.DirectInput.forwardMessages = False
-
-
 # Disables DirectInput exclusive input. Only affects fullscreen modes.
 # When Remix UI input misbehaves in fullscreen mode, try disabling
 # DirectInput exclusive input.
@@ -68,6 +59,37 @@
 # client.DirectInput.disableExclusiveInput = False
 
 
+# Forwarding of DirectInput state to the standard windows message pump.
+# Some games disable some subset (or all) of keyboard/mouse input typically 
+# handled by windows messages, in favor of using DirectInput as the handler.
+# This can fundamentally break how Remix and the bridge accept user input
+# for interacting with the Remix UI. To work around this, we translate DI
+# input into standard windows messages. Most games only need this when the
+# Remix UI is already up, which is why that is the default mode.
+#
+# All games are different, so when opening/closing/interacting with the
+# Remix UI, take note of what sort of input is (not) happening, and try
+# setting the policy accordingly.
+# 
+# Common cases:
+# * If you notice that you are unable to bring up the Remix UI: Try setting
+#   the keyboard policy to 3 (Always), so that we can properly send the
+#   hotkey to active the UI. The game is likely swallowing all key input
+#   otherwise.
+# * If you notice that when the Remix UI is open, there are two mice, and
+#   sometimes one is even flickering: Try setting the mouse policy to 0 
+#   (Never) or 1 (Remix UI Inactive). The game is likely confused by our 
+#   bringing the standard system mouse back into play when this happens.
+#
+# Supported values: 0 (Never)             - Never forward.
+#                   1 (Remix UI Inactive) - Forward DI input only when Remix UI is inactive.
+#                   2 (Remix UI Active)   - Forward DI input only when Remix UI is active.
+#                   3 (Always)            - DI input is always forwarded.
+
+# client.DirectInput.forward.mousePolicy = False
+# client.DirectInput.forward.keyboardPolicy = False
+
+
 # Forces windowed mode even for games that try to launch in fullscreen,
 # which is useful for troubleshooting and debugging purposes. Turned
 # off by default.

src/client/client_options.h

@@ -26,6 +26,7 @@
 
 #include "config/config.h"
 #include "log/log.h"
+#include "di_hook.h"
 
 #include <d3d9.h>
 
@@ -46,14 +47,18 @@ namespace ClientOptions {
     return bridge_util::Config::getOption<bool>("client.overrideCustomWinHooks", false);
   }
 
-  inline bool getForwardDirectInputMessages() {
-    return bridge_util::Config::getOption<bool>("client.DirectInput.forwardMessages", false);
-  }
-
   inline bool getDisableExclusiveInput() {
     return bridge_util::Config::getOption<bool>("client.DirectInput.disableExclusiveInput", false);
   }
 
+  inline DI::ForwardPolicy getForwardDirectInputMousePolicy() {
+    return (DI::ForwardPolicy)bridge_util::Config::getOption<int>("client.DirectInput.forward.mousePolicy", DI::RemixUIActive);
+  }
+  
+  inline DI::ForwardPolicy getForwardDirectInputKeyboardPolicy() {
+    return (DI::ForwardPolicy)bridge_util::Config::getOption<int>("client.DirectInput.forward.keyboardPolicy", DI::RemixUIActive);
+  }
+
   inline bool getForceWindowed() {
     return bridge_util::Config::getOption<bool>("client.forceWindowed", false);
   }

src/client/d3d9_device.cpp

@@ -420,7 +420,7 @@ HRESULT Direct3DDevice9Ex_LSS<EnableSync>::Reset(D3DPRESENT_PARAMETERS* pPresent
     ResetState();
     const auto presParam = Direct3DSwapChain9_LSS::sanitizePresentationParameters(*pPresentationParameters, getCreateParams());
     // Add a hook into this window if we don't already have it.
-    setWinProc(presParam.hDeviceWindow);
+    setWinProc(getWinProcHwnd());
     // Tell Server to do the Reset
     size_t currentUID = 0;
     {
@@ -494,16 +494,8 @@ HRESULT Direct3DDevice9Ex_LSS<EnableSync>::Present(CONST RECT* pSourceRect, CONS
   }
 
   // Seeing this in the log could indicate the game is sending inputs to a different window
-  extern std::unordered_map<HWND, std::deque<WNDPROC>> ogWndProcList;
-  extern std::mutex gWndProcListMapMutex;
-  if (hDestWindowOverride != NULL) {
-    std::scoped_lock lock(gWndProcListMapMutex);
-    if(ogWndProcList.find(hDestWindowOverride) == ogWndProcList.end())
-      ONCE(Logger::info("Detected unhooked winproc on Direct3DDevice9::Present"));
-  }
-  const auto hWnd = (hDestWindowOverride != NULL) ? hDestWindowOverride : m_hWnd;
-  if(GetWindowLongPtr(hWnd,GWLP_WNDPROC) != reinterpret_cast<LONG_PTR>(RemixWndProc)) {
-    setWinProc(hWnd, true);
+  if(GetWindowLongPtr(getWinProcHwnd(),GWLP_WNDPROC) != reinterpret_cast<LONG_PTR>(RemixWndProc)) {
+    setWinProc(getWinProcHwnd(), true);
     Logger::warn("Detected non-Remix winproc on Present(), which is indicative of game resetting winproc after device creation. Remix winproc has been re-hooked. If this warning persists and remix GUI is not interactable, further intervention may be necessary.");
   }
 

src/client/d3d9_device_base.cpp

@@ -36,7 +36,8 @@ BaseDirect3DDevice9Ex_LSS::BaseDirect3DDevice9Ex_LSS(const bool bExtended,
   : D3DBase<IDirect3DDevice9Ex>(nullptr, pDirect3D)
   , m_ex(bExtended)
   , m_pDirect3D(pDirect3D)
-  , m_createParams(createParams) {
+  , m_createParams(createParams)
+  , m_presParams(presParams) {
   Logger::debug("Creating Device...");
 
   // D3D9 seems to inialize its state to this
@@ -53,19 +54,19 @@ BaseDirect3DDevice9Ex_LSS::BaseDirect3DDevice9Ex_LSS(const bool bExtended,
 
   // Initialize the implicit viewport
   memset(&m_state.viewport, 0, sizeof(m_state.viewport));
-  m_state.viewport.Width = presParams.BackBufferWidth;
-  m_state.viewport.Height = presParams.BackBufferHeight;
+  m_state.viewport.Width = m_presParams.BackBufferWidth;
+  m_state.viewport.Height = m_presParams.BackBufferHeight;
   m_state.viewport.MaxZ = 1.f;
 
   // Games may override client's exception handler when it was setup early.
   // Attempt to restore the exeption handler.
   SetupExceptionHandler();
 
-  // MSDN: For windowed mode, this parameter may be NULL only if the hDeviceWindow member
-  // of pPresentationParameters is set to a valid, non-NULL value.
+  assert(m_createParams.hFocusWindow || m_presParams.hDeviceWindow);
+
+  setWinProc(getWinProcHwnd());
+  Logger::info(format_string("WinProcWnd: %x", getWinProcHwnd()));
 
-  m_hWnd = createParams.hFocusWindow ? createParams.hFocusWindow : presParams.hDeviceWindow;
-  setWinProc(m_hWnd);
   m_previousPresentParams = presParams;
   DWORD customBehaviorFlags = createParams.BehaviorFlags | D3DCREATE_NOWINDOWCHANGES;
   InitRamp();
@@ -84,14 +85,14 @@ BaseDirect3DDevice9Ex_LSS::BaseDirect3DDevice9Ex_LSS(const bool bExtended,
       }
       c.send_data(sizeof(D3DDISPLAYMODEEX), pFullscreenDisplayMode);
     }
-    c.send_data(sizeof(D3DPRESENT_PARAMETERS), &presParams);
+    c.send_data(sizeof(D3DPRESENT_PARAMETERS), &m_presParams);
   }
   Logger::debug("...server-side D3D9 device creation command sent...");
 
   Logger::debug("...waiting for create device ack response from server...");
   if (Result::Success != ModuleBridge::waitForCommand(Commands::Bridge_Response, 0, nullptr, true, currentUID)) {
     Logger::err("...server-side D3D9 device creation failed with: no response from server.");
-    removeWinProc(m_hWnd);
+    removeWinProc(getWinProcHwnd());
     hresultOut = D3DERR_DEVICELOST;
     return;
   }
@@ -105,7 +106,7 @@ BaseDirect3DDevice9Ex_LSS::BaseDirect3DDevice9Ex_LSS(const bool bExtended,
   if (FAILED(hresultOut)) {
     Logger::err(format_string("...server-side D3D9 device creation failed with %x.", hresultOut));
     // Release client device and report server error to the app
-    removeWinProc(m_hWnd);
+    removeWinProc(getWinProcHwnd());
     return;
   }
   Logger::debug("...server-side D3D9 device successfully created...");

src/client/d3d9_device_base.h

@@ -140,7 +140,13 @@ class BaseDirect3DDevice9Ex_LSS: public D3DBase<IDirect3DDevice9Ex>
                             const D3DPRESENT_PARAMETERS& presParams,
                             const D3DDISPLAYMODEEX* const pFullscreenDisplayMode,
                             HRESULT& hresultOut);
+
+  HWND getFocusHwnd() const { return m_createParams.hFocusWindow; }
+  HWND getPresentationHwnd() const { return m_presParams.hDeviceWindow; }
+  HWND getWinProcHwnd() const { return getPresentationHwnd() ? getPresentationHwnd() : getFocusHwnd(); }
+
   void InitRamp();
+  
   using ShaderType = ShaderConstants::ShaderType;
   using ConstantType = ShaderConstants::ConstantType;
 
@@ -173,6 +179,7 @@ class BaseDirect3DDevice9Ex_LSS: public D3DBase<IDirect3DDevice9Ex>
   const bool m_ex;
   Direct3D9Ex_LSS* const m_pDirect3D = nullptr;
   const D3DDEVICE_CREATION_PARAMETERS m_createParams;
+  const D3DPRESENT_PARAMETERS m_presParams;
 
   D3DGAMMARAMP m_gammaRamp;
   D3DPRESENT_PARAMETERS m_previousPresentParams;
@@ -184,7 +191,6 @@ class BaseDirect3DDevice9Ex_LSS: public D3DBase<IDirect3DDevice9Ex>
   DWORD m_FVF;
   INT m_gpuThreadPriority;
   UINT m_maxFrameLatency;
-  HWND m_hWnd = NULL;
 
   struct StateCaptureDirtyFlags {
     // Vertex Decl