Release v5.1: raw mouse menu cursor, drain-on-GetCursorPos, registration refactor, pump cap

Author: d3nd3

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v5.1
+
+- Raw mouse: hook `IN_MenuMouse` (SofExe `0x4A420`) with Pre/Post callbacks; while inside it, `GetCursorPos` uses the real API so menu cursor motion matches the OS (avoids synthetic cursor lag on connect / low FPS). `detours.yaml` uses `cvar_t*` parameters; `hooks.json` registers Pre/Post; new `in_menumouse.cpp` tracks scope with a depth counter.
+- Raw mouse: fold pending mickeys at read time — `GetCursorPos` calls `raw_mouse_drain_pending_raw_for_cursor()` (shared `GetRawInputBuffer` drain with bounded multi-batch emptying) so the virtual cursor stays fresh without waiting on the next pump boundary.
+- Raw mouse: `Sys_SendKeyEvents` only resets deltas (`consume_deltas`); raw queue draining is no longer done there — only the `GetCursorPos` path drains (plus lazy registration when not yet registered). Removed `raw_processed_this_frame` / `raw_mouse_on_peek_returned_no_message`; `raw_mouse_process_raw_mouse()` forwards to the same drain helper.
+- Raw mouse: registration cleanup — `RawMouseDropRegistration()`, single `RawMouseCommitRawInputRegistration()` for Win32 register + validation; `raw_mouse_ensure_registered` fast-paths when already registered for the same root (skips heavy window resolution on common `DispatchMessageA` calls). Dropped public `raw_mouse_register_input` (only `ensure_registered` needed it).
+- Raw mouse: message pump default `MAX_MSG_PER_FRAME` set to **10** with a short comment on the vanilla full-drain vs capped tradeoff.
+
 ## v5.0
 
 - Raw mouse: message pump no longer removes `WM_INPUT` from the queue (avoids high-frequency peel cost on high-poll mice). Uses filtered `PeekMessage` bands around `WM_INPUT` when it blocks the head; otherwise `GetMessage` for strict FIFO. When both low-ID and high-ID candidates exist, orders by `MSG.time` with high-band tie-break for mouse/client messages. Raises per-pump cap to 10 dispatched messages; updates `sys_msg_time` and centralizes quit/dispatch in `DispatchOneMsg`.

VERSION

@@ -1 +1 @@
-5.0
+5.1

build/generated_detours.cpp

@@ -153,6 +153,10 @@ namespace detour_Sys_SendKeyEvents {
     tSys_SendKeyEvents oSys_SendKeyEvents = nullptr;
 }
 
+namespace detour_IN_MenuMouse {
+    tIN_MenuMouse oIN_MenuMouse = nullptr;
+}
+
 namespace detour_GetCursorPos {
     tGetCursorPos oGetCursorPos = nullptr;
 }
@@ -568,6 +572,17 @@ namespace detour_Sys_SendKeyEvents {
     }
 }
 
+namespace detour_IN_MenuMouse {
+    ManagerType& GetManager() {
+        static ManagerType* instance = nullptr;
+        if (!instance) {
+            static char storage[sizeof(ManagerType)];
+            instance = new(storage) ManagerType();
+        }
+        return *instance;
+    }
+}
+
 namespace detour_GetCursorPos {
     ManagerType& GetManager() {
         static ManagerType* instance = nullptr;
@@ -735,6 +750,17 @@ namespace detour_CinematicFreeze {
     }
 }
 
+namespace detour_IN_MenuMouse {
+    void __cdecl hkIN_MenuMouse(cvar_t* cvar1, cvar_t* cvar2) {
+        ManagerType& mgr = GetManager();
+        if (mgr.GetPreCallbackCount() > 0) mgr.DispatchPre(cvar1, cvar2);
+        if (oIN_MenuMouse) {
+            oIN_MenuMouse(cvar1, cvar2);
+        }
+        if (mgr.GetPostCallbackCount() > 0) mgr.DispatchPost(cvar1, cvar2);
+    }
+}
+
 // Override hooks (hooks.json override: true)
 // Note: Override hooks with custom_detour: true are manually installed at runtime and not generated here
 namespace detour_CL_Precache_f {

build/generated_detours.h

@@ -1006,6 +1006,33 @@ namespace {
     static AutoDetour_Sys_SendKeyEvents g_AutoDetour_Sys_SendKeyEvents;
 }
 
+namespace detour_IN_MenuMouse {
+    using tIN_MenuMouse = void(__cdecl*)(cvar_t* cvar1, cvar_t* cvar2);
+    extern tIN_MenuMouse oIN_MenuMouse;
+    using ManagerType = TypedSharedHookManager<void, cvar_t*, cvar_t*>;
+    ManagerType& GetManager();
+    
+    void __cdecl hkIN_MenuMouse(cvar_t* cvar1, cvar_t* cvar2);
+}
+
+namespace {
+    struct AutoDetour_IN_MenuMouse {
+        AutoDetour_IN_MenuMouse() {
+            using namespace detour_IN_MenuMouse;
+            if (!GetDetourSystem().IsDetourRegistered("IN_MenuMouse")) {
+                GetDetourSystem().RegisterDetour(
+                    reinterpret_cast<void*>(0x0004A420),
+                    reinterpret_cast<void*>(detour_IN_MenuMouse::hkIN_MenuMouse),
+                    reinterpret_cast<void**>(&detour_IN_MenuMouse::oIN_MenuMouse),
+                    "IN_MenuMouse",
+                    DetourModule::SofExe,
+                    static_cast<size_t>(0));
+            }
+        }
+    };
+    static AutoDetour_IN_MenuMouse g_AutoDetour_IN_MenuMouse;
+}
+
 namespace detour_GetCursorPos {
     using tGetCursorPos = BOOL(__stdcall*)(LPPOINT lpPoint);
     extern tGetCursorPos oGetCursorPos;

build/generated_registrations.h

@@ -56,6 +56,8 @@ extern void r_blendlightmaps_post_callback();
 extern void r_blendlightmaps_pre_callback();
 extern void raw_mouse_EarlyStartup();
 extern void raw_mouse_RefDllLoaded(char const* name);
+extern void raw_mouse_in_menumouse_post(cvar_t* cvar1, cvar_t* cvar2);
+extern void raw_mouse_in_menumouse_pre(cvar_t*& cvar1, cvar_t*& cvar2);
 extern void scaledCon_EarlyStartup();
 extern void scaledHud_RefDllLoaded(char const* name);
 extern void scaledUIBase_RefDllLoaded(char const* name);
@@ -159,6 +161,19 @@ inline void RegisterAllFeatureHooks() {
             100);
         PrintOut(PRINT_LOG, "[RegisterAllFeatureHooks] R_BlendLightmaps post callbacks: %zu\n", mgr.GetPostCallbackCount());
     }
+    detour_IN_MenuMouse::GetManager().RegisterPreCallback(
+        "raw_mouse", "raw_mouse_in_menumouse_pre",
+        [](cvar_t*& cvar1, cvar_t*& cvar2) { raw_mouse_in_menumouse_pre(cvar1, cvar2); },
+        0);
+    {
+        auto& mgr = detour_IN_MenuMouse::GetManager();
+        PrintOut(PRINT_LOG, "[RegisterAllFeatureHooks] IN_MenuMouse manager at 0x%p\n", &mgr);
+        mgr.RegisterPostCallback(
+            "raw_mouse", "raw_mouse_in_menumouse_post",
+            [](cvar_t* cvar1, cvar_t* cvar2) { raw_mouse_in_menumouse_post(cvar1, cvar2); },
+            0);
+        PrintOut(PRINT_LOG, "[RegisterAllFeatureHooks] IN_MenuMouse post callbacks: %zu\n", mgr.GetPostCallbackCount());
+    }
     detour_GL_FindImage::GetManager().RegisterPostCallback(
         "scaled_ui_base", "gl_findimage_post_callback",
         [](void* result, char* filename, int imagetype, char mimap, char allowPicmip) { return gl_findimage_post_callback(result, filename, imagetype, mimap, allowPicmip); },

detours.yaml

@@ -438,9 +438,9 @@ functions:
     calling_convention: __cdecl
     detour_len: 0
     params:
-      - type: void*
+      - type: cvar_t*
         name: cvar1
-      - type: void*
+      - type: cvar_t*
         name: cvar2
 
   - name: GetCursorPos

hdr/version.h

@@ -7,4 +7,4 @@
     Increment version using: ./increment_version.sh
 */
 
-#define SOFBUDDY_VERSION "5.0"
+#define SOFBUDDY_VERSION "5.1"

src/features/raw_mouse/hooks/getcursorpos.cpp

@@ -16,6 +16,13 @@ BOOL getcursorpos_override_callback(
     return original(lpPoint);
   }
 
+  if (raw_mouse_in_menumouse_scope()) {
+    SOFBUDDY_ASSERT(original != nullptr);
+    return original(lpPoint);
+  }
+
+  raw_mouse_drain_pending_raw_for_cursor();
+
   if (!lpPoint) {
     SetLastError(ERROR_INVALID_PARAMETER);
     return FALSE;

src/features/raw_mouse/hooks/hooks.json

@@ -1,4 +1,16 @@
 [
+  {
+    "function": "IN_MenuMouse",
+    "callback": "raw_mouse_in_menumouse_pre",
+    "phase": "Pre",
+    "priority": 0
+  },
+  {
+    "function": "IN_MenuMouse",
+    "callback": "raw_mouse_in_menumouse_post",
+    "phase": "Post",
+    "priority": 0
+  },
   {
     "function": "GetCursorPos",
     "callback": "getcursorpos_override_callback",

src/features/raw_mouse/hooks/in_menumouse.cpp

@@ -0,0 +1,24 @@
+#include "feature_config.h"
+
+#if FEATURE_RAW_MOUSE
+
+#include "sof_compat.h"
+
+static int raw_mouse_in_menumouse_depth = 0;
+
+bool raw_mouse_in_menumouse_scope() { return raw_mouse_in_menumouse_depth > 0; }
+
+void raw_mouse_in_menumouse_pre(cvar_t*& cvar1, cvar_t*& cvar2) {
+  (void)cvar1;
+  (void)cvar2;
+  ++raw_mouse_in_menumouse_depth;
+}
+
+void raw_mouse_in_menumouse_post(cvar_t* cvar1, cvar_t* cvar2) {
+  (void)cvar1;
+  (void)cvar2;
+  if (raw_mouse_in_menumouse_depth > 0)
+    --raw_mouse_in_menumouse_depth;
+}
+
+#endif