[Scummvm-git-logs] scummvm master -> 0243c1f775a9e3c8070d0dd292960066255d5c13

[sluicebox]

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

Summary:
636e2d341d SCI: Speed up the palette animation for Mr. Bigg's closeup in LSL5
0243c1f775 SCI: Update LSL5 palette animation patch


Commit: 636e2d341daf30dbc96cd9e6221657f4dfe339c5
    https://github.com/scummvm/scummvm/commit/636e2d341daf30dbc96cd9e6221657f4dfe339c5
Author: Torbjörn Andersson (eriktorbjorn at users.sourceforge.net)
Date: 2023-07-12T21:57:00-07:00

Commit Message:
SCI: Speed up the palette animation for Mr. Bigg's closeup in LSL5

This happens during the first meeting in the LSL5 intro. There is no
consensus on how fast this animation should run, but ScummVM runs it
extremely slow, possibly due to speed throttling. This speeds it up
by updating the animation ever 6th time the doit script is run,
rather than the original every 32nd time.

Changed paths:
    engines/sci/engine/script_patches.cpp


diff --git a/engines/sci/engine/script_patches.cpp b/engines/sci/engine/script_patches.cpp
index 66bc1700385..7f05301efa9 100644
--- a/engines/sci/engine/script_patches.cpp
+++ b/engines/sci/engine/script_patches.cpp
@@ -8910,10 +8910,32 @@ static const uint16 larry5PatchTPrintUninitParameter[] = {
 	PATCH_END
 };
 
+// The palette animation for the Mr. Bigg close-up in the LSL5 intro is running
+// very slowly, probably because of speed throttling. It updates every 32th
+// time the doit script is run. There is no consensus on how fast the animation
+// should run, so we arbitrarily change it to every 6th time.
+//
+// Applies to: All known versions
+// Responsible method: Mr. Bigg::doit (script 130)
+
+static const uint16 larry5SignatureMrBiggPaletteAnimation[] = {
+	SIG_MAGICDWORD,
+	0x35, 0x20,                         // ldi 20
+	0x0a,                               // mod
+	0x18,                               // not
+	SIG_END
+};
+
+static const uint16 larry5PatchMrBiggPaletteAnimation[] = {
+	0x35, 0x06,                         // ldi 06
+	PATCH_END
+};
+
 //          script, description,                                      signature                               patch
 static const SciScriptPatcherEntry larry5Signatures[] = {
 	{  true,     0, "update stopGroop client",                     1, larry5SignatureUpdateStopGroopClient,   larry5PatchUpdateStopGroopClient },
 	{  true,     0, "TPrint uninit parameter",                     1, larry5SignatureHTPrintUninitParameter,  larry5PatchTPrintUninitParameter },
+	{  true,   130, "speed up palette animation",                  1, larry5SignatureMrBiggPaletteAnimation,  larry5PatchMrBiggPaletteAnimation },
 	{  true,   190, "hollywood sign",                              1, larry5SignatureHollywoodSign,           larry5PatchHollywoodSign },
 	{  true,   280, "English-only: fix green card limo bug",       1, larry5SignatureGreenCardLimoBug,        larry5PatchGreenCardLimoBug },
 	{  true,   380, "German-only: Enlarge Patti Textbox",          1, larry5SignatureGermanEndingPattiTalker, larry5PatchGermanEndingPattiTalker },


Commit: 0243c1f775a9e3c8070d0dd292960066255d5c13
    https://github.com/scummvm/scummvm/commit/0243c1f775a9e3c8070d0dd292960066255d5c13
Author: sluicebox (22204938+sluicebox at users.noreply.github.com)
Date: 2023-07-12T21:57:00-07:00

Commit Message:
SCI: Update LSL5 palette animation patch

Changed paths:
    engines/sci/engine/script_patches.cpp


diff --git a/engines/sci/engine/script_patches.cpp b/engines/sci/engine/script_patches.cpp
index 7f05301efa9..77e7d02dceb 100644
--- a/engines/sci/engine/script_patches.cpp
+++ b/engines/sci/engine/script_patches.cpp
@@ -8910,14 +8910,22 @@ static const uint16 larry5PatchTPrintUninitParameter[] = {
 	PATCH_END
 };
 
-// The palette animation for the Mr. Bigg close-up in the LSL5 intro is running
-// very slowly, probably because of speed throttling. It updates every 32th
-// time the doit script is run. There is no consensus on how fast the animation
-// should run, so we arbitrarily change it to every 6th time.
+// The palette animations for the Mr. Bigg close-up in the introduction, and in
+//  room 500, both run too slow due to a conflict with our speed throttlers.
 //
-// Applies to: All known versions
-// Responsible method: Mr. Bigg::doit (script 130)
-
+// Both scripts limit animation to once every X game cycles, but the game ran
+//  unthrottled so the animation speed was still relative to machine speed.
+//  We throttle game cycles for consistent speed, and the combination causes
+//  both animations to run slower than ever.
+//
+// We fix this by lowering each script's throttle value so that the animations
+//  run at a faster yet consistent speed. Room 500 is handled by our throttler
+//  in kGameIsRestarting. Mr. Bigg displays a message box in "fast cast" mode,
+//  preventing kGameIsRestarting from being called, so our kGetEvent throttler
+//  detects and handles that.
+//
+// Applies to: All versions
+// Responsible methods: Mr Bigg:doit (script 130), rm500:doit
 static const uint16 larry5SignatureMrBiggPaletteAnimation[] = {
 	SIG_MAGICDWORD,
 	0x35, 0x20,                         // ldi 20
@@ -8931,6 +8939,19 @@ static const uint16 larry5PatchMrBiggPaletteAnimation[] = {
 	PATCH_END
 };
 
+static const uint16 larry5SignatureRoom500PaletteAnimation[] = {
+	SIG_MAGICDWORD,
+	0x35, 0x0a,                         // ldi 0a
+	0x0a,                               // mod
+	0x18,                               // not
+	SIG_END
+};
+
+static const uint16 larry5PatchRoom500PaletteAnimation[] = {
+	0x35, 0x03,                         // ldi 03
+	PATCH_END
+};
+
 //          script, description,                                      signature                               patch
 static const SciScriptPatcherEntry larry5Signatures[] = {
 	{  true,     0, "update stopGroop client",                     1, larry5SignatureUpdateStopGroopClient,   larry5PatchUpdateStopGroopClient },
@@ -8939,6 +8960,7 @@ static const SciScriptPatcherEntry larry5Signatures[] = {
 	{  true,   190, "hollywood sign",                              1, larry5SignatureHollywoodSign,           larry5PatchHollywoodSign },
 	{  true,   280, "English-only: fix green card limo bug",       1, larry5SignatureGreenCardLimoBug,        larry5PatchGreenCardLimoBug },
 	{  true,   380, "German-only: Enlarge Patti Textbox",          1, larry5SignatureGermanEndingPattiTalker, larry5PatchGermanEndingPattiTalker },
+	{  true,   500, "speed up palette animation",                  1, larry5SignatureRoom500PaletteAnimation, larry5PatchRoom500PaletteAnimation },
 	SCI_SIGNATUREENTRY_TERMINATOR
 };