GOB: Implement the copy protection in Once Upon A Time

4 files changed, 306 insertions, 0 deletions

diff --git a/engines/gob/pregob/onceupon/abracadabra.cpp b/engines/gob/pregob/onceupon/abracadabra.cpp
index 6cfdfa7822..d8dd8b3be0 100644
--- a/engines/gob/pregob/onceupon/abracadabra.cpp
+++ b/engines/gob/pregob/onceupon/abracadabra.cpp
@@ -22,8 +22,28 @@
 
 #include "common/textconsole.h"
 
+#include "gob/gob.h"
+
 #include "gob/pregob/onceupon/abracadabra.h"
 
+static const uint8 kCopyProtectionColors[7] = {
+	14, 11, 13,  1,  7, 12,  2
+};
+
+static const uint8 kCopyProtectionShapes[7 * 20] = {
+	3, 4, 3, 0, 1, 2, 0, 2, 2, 0, 2, 4, 0, 3, 4, 1, 1, 4, 1, 3,
+	0, 2, 0, 4, 2, 4, 4, 2, 3, 0, 1, 1, 1, 1, 3, 0, 4, 2, 3, 4,
+	0, 0, 1, 2, 1, 1, 2, 4, 3, 1, 4, 2, 4, 4, 2, 4, 1, 2, 3, 3,
+	1, 0, 2, 3, 4, 2, 3, 2, 2, 0, 0, 0, 4, 2, 3, 4, 4, 0, 4, 1,
+	4, 2, 1, 1, 1, 1, 4, 3, 4, 2, 3, 0, 0, 3, 0, 2, 3, 0, 2, 4,
+	4, 2, 4, 3, 0, 4, 0, 2, 3, 1, 4, 1, 3, 1, 0, 0, 2, 1, 3, 2,
+	3, 1, 0, 3, 1, 3, 4, 2, 4, 4, 3, 2, 0, 2, 0, 1, 2, 0, 1, 4
+};
+
+static const uint8 kCopyProtectionObfuscate[4] = {
+	1, 0, 2, 3
+};
+
 namespace Gob {
 
 namespace OnceUpon {
@@ -37,6 +57,10 @@ Abracadabra::~Abracadabra() {
 void Abracadabra::run() {
 	init();
 
+	bool correctCP = doCopyProtection(kCopyProtectionColors, kCopyProtectionShapes, kCopyProtectionObfuscate);
+	if (_vm->shouldQuit() || !correctCP)
+		return;
+
 	warning("TODO: Abracadabra::run()");
 }
 
diff --git a/engines/gob/pregob/onceupon/babayaga.cpp b/engines/gob/pregob/onceupon/babayaga.cpp
index 9f4f53c4e0..aad1fc6aca 100644
--- a/engines/gob/pregob/onceupon/babayaga.cpp
+++ b/engines/gob/pregob/onceupon/babayaga.cpp
@@ -22,8 +22,28 @@
 
 #include "common/textconsole.h"
 
+#include "gob/gob.h"
+
 #include "gob/pregob/onceupon/babayaga.h"
 
+static const uint8 kCopyProtectionColors[7] = {
+	14, 11, 13,  1,  7, 12,  2
+};
+
+static const uint8 kCopyProtectionShapes[7 * 20] = {
+	0, 0, 1, 2, 1, 1, 2, 4, 3, 1, 4, 2, 4, 4, 2, 4, 1, 2, 3, 3,
+	3, 1, 0, 3, 1, 3, 4, 2, 4, 4, 3, 2, 0, 2, 0, 1, 2, 0, 1, 4,
+	1, 0, 2, 3, 4, 2, 3, 2, 2, 0, 0, 0, 4, 2, 3, 4, 4, 0, 4, 1,
+	0, 2, 0, 4, 2, 4, 4, 2, 3, 0, 1, 1, 1, 1, 3, 0, 4, 2, 3, 4,
+	3, 4, 3, 0, 1, 2, 0, 2, 2, 0, 2, 4, 0, 3, 4, 1, 1, 4, 1, 3,
+	4, 2, 1, 1, 1, 1, 4, 3, 4, 2, 3, 0, 0, 3, 0, 2, 3, 0, 2, 4,
+	4, 2, 4, 3, 0, 4, 0, 2, 3, 1, 4, 1, 3, 1, 0, 0, 2, 1, 3, 2
+};
+
+static const uint8 kCopyProtectionObfuscate[4] = {
+	0, 1, 2, 3
+};
+
 namespace Gob {
 
 namespace OnceUpon {
@@ -37,6 +57,10 @@ BabaYaga::~BabaYaga() {
 void BabaYaga::run() {
 	init();
 
+	bool correctCP = doCopyProtection(kCopyProtectionColors, kCopyProtectionShapes, kCopyProtectionObfuscate);
+	if (_vm->shouldQuit() || !correctCP)
+		return;
+
 	warning("TODO: BabaYaga::run()");
 }
 
diff --git a/engines/gob/pregob/onceupon/onceupon.cpp b/engines/gob/pregob/onceupon/onceupon.cpp
index adea776297..aa85e1c095 100644
--- a/engines/gob/pregob/onceupon/onceupon.cpp
+++ b/engines/gob/pregob/onceupon/onceupon.cpp
@@ -27,6 +27,8 @@
 #include "gob/surface.h"
 #include "gob/draw.h"
 #include "gob/video.h"
+#include "gob/anifile.h"
+#include "gob/aniobject.h"
 
 #include "gob/pregob/onceupon/onceupon.h"
 
@@ -163,6 +165,62 @@ static const byte kGamePalettes[kPaletteCount][3 * kPaletteSize] = {
 	}
 };
 
+static const uint kLanguageCount = 5;
+
+static const uint kCopyProtectionHelpStringCount = 3;
+
+static const char *kCopyProtectionHelpStrings[kLanguageCount][kCopyProtectionHelpStringCount] = {
+	{ // French
+		"Consulte le livret des animaux, rep\212re la",
+		"page correspondant \205 la couleur de l\'\202cran",
+		"et clique le symbole associ\202 \205 l\'animal affich\202.",
+	},
+	{ // German
+		"Suche im Tieralbum die Seite, die der Farbe auf",
+		"dem Bildschirm entspricht und klicke auf das",
+		"Tiersymbol.",
+	},
+	{ // English
+		"Consult the book of animals, find the page",
+		"corresponding to the colour of screen and click",
+		"the symbol associated with the animal displayed.",
+	},
+	{ // Spanish
+		"Consulta el libro de los animales, localiza la ",
+		"p\240gina que corresponde al color de la pantalla.",
+		"Cliquea el s\241mbolo asociado al animal que aparece.",
+	},
+	{ // Italian
+		"Guarda il libretto degli animali, trova la",
+		"pagina che corrisponde al colore dello schermo,",
+		"clicca il simbolo associato all\'animale presentato",
+	}
+};
+
+static const char *kCopyProtectionWrongStrings[kLanguageCount] = {
+	"Tu t\'es tromp\202, dommage...", // French
+	"Schade, du hast dich geirrt."  , // German
+	"You are wrong, what a pity!"   , // English
+	"Te equivocas, l\240stima..."   , // Spanish
+	"Sei Sbagliato, peccato..."       // Italian
+};
+
+static const uint kCopyProtectionShapeCount = 5;
+
+static const int16 kCopyProtectionShapeCoords[kCopyProtectionShapeCount][6] = {
+	{  0,  51,  26,  75,  60, 154},
+	{ 28,  51,  58,  81,  96, 151},
+	{ 60,  51,  94,  79, 136, 152},
+	{ 96,  51, 136,  71, 180, 155},
+	{140,  51, 170,  77, 228, 153}
+};
+
+enum ClownAnimation {
+	kClownAnimationClownCheer = 0,
+	kClownAnimationClownStand = 1,
+	kClownAnimationClownCry   = 6
+};
+
 namespace Gob {
 
 namespace OnceUpon {
@@ -240,6 +298,195 @@ void OnceUpon::setGamePalette(uint palette) {
 	setPalette(kGamePalettes[palette], kPaletteSize);
 }
 
+enum CopyProtectionState {
+	kCPStateSetup,     // Set up the screen
+	kCPStateWaitUser,  // Waiting for the user to pick a shape
+	kCPStateWaitClown, // Waiting for the clown animation to finish
+	kCPStateFinish     // Finishing
+};
+
+bool OnceUpon::doCopyProtection(const uint8 colors[7], const uint8 shapes[7 * 20], const uint8 obfuscate[4]) {
+	fadeOut();
+	setCopyProtectionPalette();
+
+	Surface sprites[2] = {Surface(320, 200, 1), Surface(320, 200, 1)};
+
+	_vm->_video->drawPackedSprite("grille1.cmp", sprites[0]);
+	_vm->_video->drawPackedSprite("grille2.cmp", sprites[1]);
+
+	ANIFile   ani  (_vm, "grille.ani", 320);
+	ANIObject clown(ani);
+
+	setCursor(sprites[1], 5, 110, 20, 134, 3, 0);
+
+	CopyProtectionState state = kCPStateSetup;
+
+	uint8 triesLeft   =  2;
+	int8  animalShape = -1;
+	bool  hasCorrect  = false;
+
+	while (!_vm->shouldQuit() && (state != kCPStateFinish)) {
+		clearAnim(clown);
+
+		// Set up the screen
+		if (state == kCPStateSetup) {
+			animalShape = cpSetup(colors, shapes, obfuscate, sprites);
+
+			setAnimState(clown, kClownAnimationClownStand, false, false);
+			state = kCPStateWaitUser;
+		}
+
+		drawAnim(clown);
+
+		// If we're waiting for the clown and he finished, evaluate if we're finished
+		if (!clown.isVisible() && (state == kCPStateWaitClown))
+			state = (hasCorrect || (--triesLeft == 0)) ? kCPStateFinish : kCPStateSetup;
+
+		showCursor();
+		fadeIn();
+
+		endFrame(true);
+
+		int16 mouseX, mouseY;
+		MouseButtons mouseButtons;
+
+		checkInput(mouseX, mouseY, mouseButtons);
+
+		if (state == kCPStateWaitUser) {
+			// Look if we clicked a shaped and got it right
+
+			int8 guessedShape = -1;
+			if (mouseButtons == kMouseButtonsLeft)
+				guessedShape = cpFindShape(mouseX, mouseY);
+
+			if (guessedShape >= 0) {
+				hasCorrect  = guessedShape == animalShape;
+				animalShape = -1;
+
+				setAnimState(clown, hasCorrect ? kClownAnimationClownCheer : kClownAnimationClownCry, true, false);
+				state = kCPStateWaitClown;
+			}
+		}
+	}
+
+	fadeOut();
+	hideCursor();
+	clearScreen();
+
+	// Display the "You are wrong" screen
+	if (!hasCorrect)
+		cpWrong();
+
+	return hasCorrect;
+}
+
+int8 OnceUpon::cpSetup(const uint8 colors[7], const uint8 shapes[7 * 20], const uint8 obfuscate[4],
+                       const Surface sprites[2]) {
+
+	fadeOut();
+	hideCursor();
+
+	// Get a random animal and animal color
+	int8 animalColor = _vm->_util->getRandom(7);
+	while ((colors[animalColor] == 1) || (colors[animalColor] == 7) || (colors[animalColor] == 11))
+		animalColor = _vm->_util->getRandom(7);
+
+	int8 animal = _vm->_util->getRandom(20);
+
+	int8 animalShape = shapes[animalColor * 20 + animal];
+	if (animal < 4)
+		animal = obfuscate[animal];
+
+	// Get the position of the animal sprite
+	int16 animalLeft = (animal % 4) * 80;
+	int16 animalTop  = (animal / 4) * 50;
+
+	uint8 sprite = 0;
+	if (animalTop >= 200) {
+		animalTop -= 200;
+		sprite = 1;
+	}
+
+	int16 animalRight  = animalLeft + 80 - 1;
+	int16 animalBottom = animalTop  + 50 - 1;
+
+	// Fill with the animal color
+	_vm->_draw->_backSurface->fill(colors[animalColor]);
+
+	// Print the help line strings
+	for (uint i = 0; i < kCopyProtectionHelpStringCount; i++) {
+		const char * const helpString = kCopyProtectionHelpStrings[_vm->_global->_language][i];
+
+		const int x = 160 - (strlen(helpString) * _plettre->getCharWidth()) / 2;
+		const int y = i * 10 + 5;
+
+		_plettre->drawString(helpString, x, y, 8, 0, true, *_vm->_draw->_backSurface);
+	}
+
+	// White rectangle with black border
+	_vm->_draw->_backSurface->fillRect( 93, 43, 226, 134, 15);
+	_vm->_draw->_backSurface->drawRect( 92, 42, 227, 135,  0);
+
+	// Draw the animal in the animal color
+	_vm->_draw->_backSurface->fillRect(120, 63, 199, 112, colors[animalColor]);
+	_vm->_draw->_backSurface->blit(sprites[sprite], animalLeft, animalTop, animalRight, animalBottom, 120, 63, 0);
+
+	// Draw the shapes
+	for (uint i = 0; i < kCopyProtectionShapeCount; i++) {
+		const int16 * const coords = kCopyProtectionShapeCoords[i];
+
+		_vm->_draw->_backSurface->blit(sprites[1], coords[0], coords[1], coords[2], coords[3], coords[4], coords[5], 0);
+	}
+
+	_vm->_draw->forceBlit();
+
+	return animalShape;
+}
+
+int8 OnceUpon::cpFindShape(int16 x, int16 y) const {
+	// Look through all shapes and check if the coordinates are inside one of them
+	for (uint i = 0; i < kCopyProtectionShapeCount; i++) {
+		const int16 * const coords = kCopyProtectionShapeCoords[i];
+
+		const int16 left   = coords[4];
+		const int16 top    = coords[5];
+		const int16 right  = coords[4] + (coords[2] - coords[0] + 1) - 1;
+		const int16 bottom = coords[5] + (coords[3] - coords[1] + 1) - 1;
+
+		if ((x >= left) && (x <= right) && (y >= top) && (y <= bottom))
+			return i;
+	}
+
+	return -1;
+}
+
+void OnceUpon::cpWrong() {
+	// Display the "You are wrong" string, centered
+
+	const char * const wrongString = kCopyProtectionWrongStrings[_vm->_global->_language];
+	const int          wrongX      = 160 - (strlen(wrongString) * _plettre->getCharWidth()) / 2;
+
+	_vm->_draw->_backSurface->clear();
+	_plettre->drawString(wrongString, wrongX, 100, 15, 0, true, *_vm->_draw->_backSurface);
+
+	_vm->_draw->forceBlit();
+
+	fadeIn();
+
+	waitInput();
+
+	fadeOut();
+	clearScreen();
+}
+
+void OnceUpon::setAnimState(ANIObject &ani, uint16 state, bool once, bool pause) const {
+	ani.setAnimation(state);
+	ani.setMode(once ? ANIObject::kModeOnce : ANIObject::kModeContinuous);
+	ani.setPause(pause);
+	ani.setVisible(true);
+	ani.setPosition();
+}
+
 } // End of namespace OnceUpon
 
 } // End of namespace Gob
diff --git a/engines/gob/pregob/onceupon/onceupon.h b/engines/gob/pregob/onceupon/onceupon.h
index cfc12532dd..abcde68b81 100644
--- a/engines/gob/pregob/onceupon/onceupon.h
+++ b/engines/gob/pregob/onceupon/onceupon.h
@@ -32,6 +32,8 @@ namespace Gob {
 class Surface;
 class Font;
 
+class ANIObject;
+
 namespace OnceUpon {
 
 class OnceUpon : public PreGob {
@@ -45,6 +47,8 @@ protected:
 
 	void setGamePalette(uint palette);
 
+	bool doCopyProtection(const uint8 colors[7], const uint8 shapes[7 * 20], const uint8 obfuscate[4]);
+
 
 	Font *_jeudak;
 	Font *_lettre;
@@ -54,6 +58,13 @@ protected:
 private:
 	void setCopyProtectionPalette();
 
+	void setAnimState(ANIObject &ani, uint16 state, bool once, bool pause) const;
+
+	// Copy protection helpers
+	int8 cpSetup(const uint8 colors[7], const uint8 shapes[7 * 20], const uint8 obfuscate[4], const Surface sprites[2]);
+	int8 cpFindShape(int16 x, int16 y) const;
+	void cpWrong();
+
 
 	bool _openedArchives;
 };