[Scummvm-git-logs] scummvm master -> 813d5ca6c9ab04fab3092c9f9c17057340c984e9

[sluicebox]

This automated email contains information about 1 new commit which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .

Summary:
813d5ca6c9 SCI: Improve kPaletteSetIntensity speed throttling


Commit: 813d5ca6c9ab04fab3092c9f9c17057340c984e9
    https://github.com/scummvm/scummvm/commit/813d5ca6c9ab04fab3092c9f9c17057340c984e9
Author: sluicebox (22204938+sluicebox at users.noreply.github.com)
Date: 2021-04-12T11:12:01-07:00

Commit Message:
SCI: Improve kPaletteSetIntensity speed throttling

Detect when kPaletteSetIntensity is called from an unthrottled
script loop and only apply speed throttling in that situation.

This fixes several slow fade-in / fade-outs such as KQ6's Sierra
logo and title screen. We've been throttling kPaletteSetIntensity
on every call, even when it was being used once per game cycle
(which our kGameIsRestarting throttling already handles) or within
kWait-throttled loops. In both cases this has added delays on top
of delays and slowed things down even further.

Changed paths:
    engines/sci/engine/kgraphics.cpp
    engines/sci/engine/kmisc.cpp
    engines/sci/engine/state.cpp
    engines/sci/engine/state.h
    engines/sci/graphics/palette.cpp


diff --git a/engines/sci/engine/kgraphics.cpp b/engines/sci/engine/kgraphics.cpp
index 3865d30f24..a1d8fd70cc 100644
--- a/engines/sci/engine/kgraphics.cpp
+++ b/engines/sci/engine/kgraphics.cpp
@@ -403,6 +403,7 @@ reg_t kWait(EngineState *s, int argc, reg_t *argv) {
 		return NULL_REG;
 	}
 
+	s->_paletteSetIntensityCounter = 0;
 	return make_reg(0, delta);
 }
 
@@ -646,6 +647,22 @@ reg_t kPaletteSetIntensity(EngineState *s, int argc, reg_t *argv) {
 	if (g_sci->_gfxPalette16->getTotalColorCount() < 256)
 		return s->r_acc;
 
+	if (setPalette) {
+		// Detect if we're being called from an unthrottled script loop.
+		// Throttled loops that call kWait on each iteration are okay.
+		if (s->_paletteSetIntensityCounter > 0) {
+			// Call speed throttler, otherwise the palette fade from this
+			// unthrottled script loop won't have any visible effect.
+			// Examples: KQ6 intro text/credits and SQ4CD intro credits
+			s->speedThrottler(30);
+		}
+		s->_paletteSetIntensityCounter++;
+
+		// Enable normal throttling in case this is being called from a script that
+		// doesn't animate anything with kAnimate, such as the LB2 title screen.
+		s->_throttleTrigger = true;
+	}
+
 	g_sci->_gfxPalette16->kernelSetIntensity(fromColor, toColor, intensity, setPalette);
 	return s->r_acc;
 }
diff --git a/engines/sci/engine/kmisc.cpp b/engines/sci/engine/kmisc.cpp
index a285ed75ba..6aae982001 100644
--- a/engines/sci/engine/kmisc.cpp
+++ b/engines/sci/engine/kmisc.cpp
@@ -131,6 +131,8 @@ reg_t kGameIsRestarting(EngineState *s, int argc, reg_t *argv) {
 	}
 
 	s->speedThrottler(neededSleep);
+
+	s->_paletteSetIntensityCounter = 0;
 	return s->r_acc;
 }
 
diff --git a/engines/sci/engine/state.cpp b/engines/sci/engine/state.cpp
index 6648458bd7..0a92a07a43 100644
--- a/engines/sci/engine/state.cpp
+++ b/engines/sci/engine/state.cpp
@@ -107,6 +107,7 @@ void EngineState::reset(bool isRestoring) {
 #ifdef ENABLE_SCI32
 	_eventCounter = 0;
 #endif
+	_paletteSetIntensityCounter = 0;
 	_throttleLastTime = 0;
 	_throttleTrigger = false;
 	_gameIsBenchmarking = false;
diff --git a/engines/sci/engine/state.h b/engines/sci/engine/state.h
index 46161a3187..e673f6cebe 100644
--- a/engines/sci/engine/state.h
+++ b/engines/sci/engine/state.h
@@ -120,6 +120,7 @@ public:
 #ifdef ENABLE_SCI32
 	uint32 _eventCounter; /**< total times kGetEvent was invoked since the last call to kFrameOut */
 #endif
+	uint32 _paletteSetIntensityCounter; /**< total times kPaletteSetIntensity was invoked since the last call to kGameIsRestarting or kWait */
 	uint32 _throttleLastTime; /**< last time kAnimate was invoked */
 	bool _throttleTrigger;
 	bool _gameIsBenchmarking;
diff --git a/engines/sci/graphics/palette.cpp b/engines/sci/graphics/palette.cpp
index 841895203a..f82f99838c 100644
--- a/engines/sci/graphics/palette.cpp
+++ b/engines/sci/graphics/palette.cpp
@@ -557,11 +557,6 @@ void GfxPalette::kernelSetIntensity(uint16 fromColor, uint16 toColor, uint16 int
 	memset(&_sysPalette.intensity[0] + fromColor, intensity, toColor - fromColor);
 	if (setPalette) {
 		setOnScreen();
-		EngineState *state = g_sci->getEngineState();
-		// Call speed throttler from here as well just in case we need it
-		//  At least in kq6 intro the scripts call us in a tight loop for fadein/fadeout
-		state->speedThrottler(30);
-		state->_throttleTrigger = true;
 	}
 }