Refactored frame rate limiter

Author: ccw808

Client/core/CCore.cpp

@@ -1718,6 +1718,14 @@ void CCore::UpdateRecentlyPlayed()
     CCore::GetSingleton().SaveConfig();
 }
 
+//
+// Called just before GTA calculates frame time deltas
+//
+void CCore::OnGameTimerUpdate()
+{
+    ApplyQueuedFrameRateLimit();
+}
+
 //
 // Recalculate FPS limit to use
 //
@@ -1793,34 +1801,47 @@ void CCore::ApplyFrameRateLimit(uint uiOverrideRate)
 
     uint uiUseRate = uiOverrideRate != -1 ? uiOverrideRate : m_uiFrameRateLimit;
 
-    TIMING_GRAPH("Limiter");
-
     if (uiUseRate < 1)
         return DoReliablePulse();
 
-    if (m_DiagnosticDebug != EDiagnosticDebug::D3D_6732)
-        Sleep(1);            // Make frame rate smoother maybe
+    // Apply previous frame rate if is hasn't been done yet
+    ApplyQueuedFrameRateLimit();
 
-    // Calc required time in ms between frames
-    const double dTargetTimeToUse = 1000.0 / uiUseRate;
-
-    while(true)
-    {
-        // See if we need to wait
-        double dSpare = dTargetTimeToUse - m_FrameRateTimer.Get();
-        if (dSpare <= 0.0)
-            break;
-        if (dSpare >= 2.0)
-            Sleep(1);
-    }
-    m_FrameRateTimer.Reset();
+    // Limit is usually applied in OnGameTimerUpdate
+    m_uiQueuedFrameRate = uiUseRate;
+    m_bQueuedFrameRateValid = true;
 
     DoReliablePulse();
 
     TIMING_GRAPH("FrameEnd");
     TIMING_GRAPH("");
 }
 
+//
+// Frame rate limit (wait) is done here.
+//
+void CCore::ApplyQueuedFrameRateLimit()
+{
+    if (m_bQueuedFrameRateValid)
+    {
+        m_bQueuedFrameRateValid = false;
+        // Calc required time in ms between frames
+        const double dTargetTimeToUse = 1000.0 / m_uiQueuedFrameRate;
+
+        while(true)
+        {
+            // See if we need to wait
+            double dSpare = dTargetTimeToUse - m_FrameRateTimer.Get();
+            if (dSpare <= 0.0)
+                break;
+            if (dSpare >= 2.0)
+                Sleep(1);
+        }
+        m_FrameRateTimer.Reset();
+        TIMING_GRAPH("Limiter");
+    }
+}
+
 //
 // DoReliablePulse
 //

Client/core/CCore.h

@@ -124,6 +124,7 @@ class CCore : public CCoreInterface, public CSingleton<CCore>
     void EnableChatInput(char* szCommand, DWORD dwColor);
     bool IsChatInputEnabled(void);
     bool ClearChat();
+    void OnGameTimerUpdate(void);
 
     // Screenshots
     void TakeScreenShot(void);
@@ -213,6 +214,7 @@ class CCore : public CCoreInterface, public CSingleton<CCore>
     uint GetFrameRateLimit(void) { return m_uiFrameRateLimit; }
     void RecalculateFrameRateLimit(uint uiServerFrameRateLimit = -1, bool bLogToConsole = true);
     void ApplyFrameRateLimit(uint uiOverrideRate = -1);
+    void ApplyQueuedFrameRateLimit(void);
     void EnsureFrameRateLimitApplied(void);
     void SetClientScriptFrameRateLimit(uint uiClientScriptFrameRateLimit);
     void DoReliablePulse(void);
@@ -347,6 +349,8 @@ class CCore : public CCoreInterface, public CSingleton<CCore>
     uint                 m_uiClientScriptFrameRateLimit;
     uint                 m_uiFrameRateLimit;
     CElapsedTimeHD       m_FrameRateTimer;
+    uint                 m_uiQueuedFrameRate;
+    bool                 m_bQueuedFrameRateValid;
     bool                 m_bWaitToSetNick;
     uint                 m_uiNewNickWaitFrames;
     EDiagnosticDebugType m_DiagnosticDebug;

Client/mods/deathmatch/logic/CClientGame.cpp

@@ -3898,19 +3898,14 @@ void CClientGame::PostWorldProcessHandler(void)
     m_pManager->GetPointLightsManager()->DoPulse();
     m_pManager->GetObjectManager()->DoPulse();
 
-    // Update frame time slice
-    uint uiCurrentTick = GetTickCount32();
-    if (m_uiLastFrameTick)
-    {
-        m_uiFrameTimeSlice = uiCurrentTick - m_uiLastFrameTick;
-        m_uiFrameCount++;
+    double dTimeSlice = m_TimeSliceTimer.Get();
+    m_TimeSliceTimer.Reset();
+    m_uiFrameCount++;
 
-        // Call onClientPreRender LUA event
-        CLuaArguments Arguments;
-        Arguments.PushNumber(m_uiFrameTimeSlice);
-        m_pRootEntity->CallEvent("onClientPreRender", Arguments, false);
-    }
-    m_uiLastFrameTick = uiCurrentTick;
+    // Call onClientPreRender LUA event
+    CLuaArguments Arguments;
+    Arguments.PushNumber(dTimeSlice);
+    m_pRootEntity->CallEvent("onClientPreRender", Arguments, false);
 }
 
 void CClientGame::IdleHandler(void)

Client/mods/deathmatch/logic/CClientGame.h

@@ -239,7 +239,6 @@ class CClientGame
     void DoPulses(void);
     void DoPulses2(bool bCalledFromIdle);
 
-    uint GetFrameTimeSlice(void) { return m_uiFrameTimeSlice; }
     uint GetFrameCount(void) { return m_uiFrameCount; }
 
     void        HandleException(CExceptionInformation* pExceptionInformation);
@@ -766,9 +765,8 @@ class CClientGame
     unsigned long m_ulBigPacketBytesReceivedBase;
     CTransferBox* m_pBigPacketTransferBox;
 
-    uint m_uiFrameTimeSlice;            // how long it took (in ms) to process the current frame
-    uint m_uiLastFrameTick;             // time at which the previous frame was processed
-    uint m_uiFrameCount;                // Frame counter
+    CElapsedTimeHD m_TimeSliceTimer;
+    uint           m_uiFrameCount;
 
     long long m_llLastTransgressionTime;
     SString   m_strLastDiagnosticStatus;

Client/multiplayer_sa/CMultiplayerSA_Rendering.cpp

@@ -339,6 +339,33 @@ void _declspec(naked) HOOK_WinLoop()
     }
 }
 
+//////////////////////////////////////////////////////////////////////////////////////////
+//
+// CTimer::Update
+//
+// Just before GTA calculates frame time deltas
+//
+//////////////////////////////////////////////////////////////////////////////////////////
+#define HOOKPOS_CTimer_Update               0x561B10
+#define HOOKSIZE_CTimer_Update              6
+static const DWORD CONTINUE_CTimer_Update = 0x561B16;
+static void _declspec(naked) HOOK_CTimer_Update()
+{
+    _asm
+    {
+        pushad
+    }
+
+    g_pCore->OnGameTimerUpdate();
+
+    _asm
+    {
+        popad
+        mov     ecx,dword ptr ds:[0B7CB28h]
+        jmp     CONTINUE_CTimer_Update
+    }
+}
+
 //////////////////////////////////////////////////////////////////////////////////////////
 //
 // Photograph screen grab in windowed mode
@@ -624,6 +651,7 @@ void CMultiplayerSA::InitHooks_Rendering(void)
     EZHookInstall(Check_NoOfVisibleLods);
     EZHookInstall(Check_NoOfVisibleEntities);
     EZHookInstall(WinLoop);
+    EZHookInstall(CTimer_Update);
     EZHookInstall(psGrabScreen);
     EZHookInstallChecked(CClouds_RenderSkyPolys);
     EZHookInstallChecked(RwCameraSetNearClipPlane);

Client/sdk/core/CCoreInterface.h

@@ -172,6 +172,7 @@ class CCoreInterface
     virtual void        SetFakeLagCommandEnabled(bool bEnabled) = 0;
     virtual SString     GetBlueCopyrightString(void) = 0;
     virtual bool        ClearChat() = 0;
+    virtual void        OnGameTimerUpdate(void) = 0;
 };
 
 class CClientTime