KYRA: move HOF sequence player into its own class

(also cleaning up and fixing things while doing that)

1 files changed, 31 insertions, 121 deletions

diff --git a/engines/kyra/staticres.cpp b/engines/kyra/staticres.cpp
index 00dc4f9e13..04e111b51e 100644
--- a/engines/kyra/staticres.cpp
+++ b/engines/kyra/staticres.cpp
@@ -31,6 +31,7 @@
 #include "kyra/gui_lok.h"
 #include "kyra/gui_hof.h"
 #include "kyra/gui_mr.h"
+#include "kyra/sequences_hof.h"
 #include "kyra/sound_intern.h"
 
 #include "common/endian.h"
@@ -245,8 +246,8 @@ bool StaticResource::init() {
 		{ kAmigaSfxTable, proc(loadAmigaSfxTable), proc(freeAmigaSfxTable) },
 		{ kRawData, proc(loadRawData), proc(freeRawData) },
 
-		{ k2SeqData, proc(loadHofSequenceData), proc(freeHofSequenceData) },
-		{ k2ShpAnimDataV1, proc(loadShapeAnimData_v1), proc(freeHofShapeAnimDataV1) },
+		{ k2SeqData, proc(loadHoFSequenceData), proc(freeHoFSequenceData) },
+		{ k2SeqItemAnimData, proc(loadHoFSeqItemAnimData), proc(freeHoFSeqItemAnimData) },
 		{ k2ItemAnimDefinition, proc(loadItemAnimDefinition), proc(freeItemAnimDefinition) },
 
 #ifdef ENABLE_LOL
@@ -308,12 +309,12 @@ const Room *StaticResource::loadRoomTable(int id, int &entries) {
 	return (const Room *)getData(id, StaticResource::kRoomList, entries);
 }
 
-const HofSeqData *StaticResource::loadHofSequenceData(int id, int &entries) {
-	return (const HofSeqData *)getData(id, k2SeqData, entries);
+const HoFSeqData *StaticResource::loadHoFSequenceData(int id, int &entries) {
+	return (const HoFSeqData *)getData(id, k2SeqData, entries);
 }
 
-const ItemAnimData_v1 *StaticResource::loadShapeAnimData_v1(int id, int &entries) {
-	return (const ItemAnimData_v1 *)getData(id, k2ShpAnimDataV1, entries);
+const HoFSeqItemAnimData *StaticResource::loadHoFSeqItemAnimData(int id, int &entries) {
+	return (const HoFSeqItemAnimData *)getData(id, k2SeqItemAnimData, entries);
 }
 
 const ItemAnimDefinition *StaticResource::loadItemAnimDefinition(int id, int &entries) {
@@ -513,12 +514,12 @@ bool StaticResource::loadRoomTable(Common::SeekableReadStream &stream, void *&pt
 	return true;
 }
 
-bool StaticResource::loadHofSequenceData(Common::SeekableReadStream &stream, void *&ptr, int &size) {
+bool StaticResource::loadHoFSequenceData(Common::SeekableReadStream &stream, void *&ptr, int &size) {
 	int numSeq = stream.readUint16BE();
 	uint32 offset = 2;
-	Sequence *tmp_s = new Sequence[numSeq];
+	HoFSequence *tmp_s = new HoFSequence[numSeq];
 
-	size = sizeof(HofSeqData) + numSeq * (sizeof(Sequence) + 28);
+	size = sizeof(HoFSeqData) + numSeq * (sizeof(HoFSequence) + 28);
 
 	for (int i = 0; i < numSeq; i++) {
 		stream.seek(offset, SEEK_SET); offset += 2;
@@ -529,22 +530,22 @@ bool StaticResource::loadHofSequenceData(Common::SeekableReadStream &stream, voi
 		stream.read(const_cast<char *>(tmp_s[i].wsaFile), 14);
 		tmp_s[i].cpsFile = new char[14];
 		stream.read(const_cast<char *>(tmp_s[i].cpsFile), 14);
-		tmp_s[i].startupCommand = stream.readByte();
-		tmp_s[i].finalCommand = stream.readByte();
+		tmp_s[i].fadeInTransitionType = stream.readByte();
+		tmp_s[i].fadeOutTransitionType = stream.readByte();
 		tmp_s[i].stringIndex1 = stream.readUint16BE();
 		tmp_s[i].stringIndex2 = stream.readUint16BE();
 		tmp_s[i].startFrame = stream.readUint16BE();
 		tmp_s[i].numFrames = stream.readUint16BE();
-		tmp_s[i].frameDelay = stream.readUint16BE();
+		tmp_s[i].duration = stream.readUint16BE();
 		tmp_s[i].xPos = stream.readUint16BE();
 		tmp_s[i].yPos = stream.readUint16BE();
-		tmp_s[i].duration = stream.readUint16BE();
+		tmp_s[i].timeout = stream.readUint16BE();
 	}
 
 	stream.seek(offset, SEEK_SET); offset += 2;
 	int numSeqN = stream.readUint16BE();
-	NestedSequence *tmp_n = new NestedSequence[numSeqN];
-	size += (numSeqN * (sizeof(NestedSequence) + 14));
+	HoFNestedSequence *tmp_n = new HoFNestedSequence[numSeqN];
+	size += (numSeqN * (sizeof(HoFNestedSequence) + 14));
 
 	for (int i = 0; i < numSeqN; i++) {
 		stream.seek(offset, SEEK_SET); offset += 2;
@@ -559,8 +560,8 @@ bool StaticResource::loadHofSequenceData(Common::SeekableReadStream &stream, voi
 		tmp_n[i].x = stream.readUint16BE();
 		tmp_n[i].y = stream.readUint16BE();
 		uint16 ctrlOffs = stream.readUint16BE();
-		tmp_n[i].startupCommand = stream.readUint16BE();
-		tmp_n[i].finalCommand = stream.readUint16BE();
+		tmp_n[i].fadeInTransitionType = stream.readUint16BE();
+		tmp_n[i].fadeOutTransitionType = stream.readUint16BE();
 
 		if (ctrlOffs) {
 			stream.seek(ctrlOffs, SEEK_SET);
@@ -580,21 +581,21 @@ bool StaticResource::loadHofSequenceData(Common::SeekableReadStream &stream, voi
 		}
 	}
 
-	HofSeqData *loadTo = new HofSeqData;
+	HoFSeqData *loadTo = new HoFSeqData;
 	assert(loadTo);
 
 	loadTo->seq = tmp_s;
-	loadTo->seqn = tmp_n;
+	loadTo->nestedSeq = tmp_n;
 	loadTo->numSeq = numSeq;
-	loadTo->numSeqn = numSeqN;
+	loadTo->numNestedSeq = numSeqN;
 
 	ptr = loadTo;
 	return true;
 }
 
-bool StaticResource::loadShapeAnimData_v1(Common::SeekableReadStream &stream, void *&ptr, int &size) {
+bool StaticResource::loadHoFSeqItemAnimData(Common::SeekableReadStream &stream, void *&ptr, int &size) {
 	size = stream.readByte();
-	ItemAnimData_v1 *loadTo = new ItemAnimData_v1[size];
+	HoFSeqItemAnimData *loadTo = new HoFSeqItemAnimData[size];
 	assert(loadTo);
 
 	for (int i = 0; i < size; i++) {
@@ -670,8 +671,8 @@ void StaticResource::freeRoomTable(void *&ptr, int &size) {
 	size = 0;
 }
 
-void StaticResource::freeHofSequenceData(void *&ptr, int &size) {
-	HofSeqData *h = (HofSeqData *)ptr;
+void StaticResource::freeHoFSequenceData(void *&ptr, int &size) {
+	HoFSeqData *h = (HoFSeqData *)ptr;
 
 	for (int i = 0; i < h->numSeq; i++) {
 		delete[] h->seq[i].wsaFile;
@@ -679,19 +680,19 @@ void StaticResource::freeHofSequenceData(void *&ptr, int &size) {
 	}
 	delete[] h->seq;
 
-	for (int i = 0; i < h->numSeqn; i++) {
-		delete[] h->seqn[i].wsaFile;
-		delete[] h->seqn[i].wsaControl;
+	for (int i = 0; i < h->numNestedSeq; i++) {
+		delete[] h->nestedSeq[i].wsaFile;
+		delete[] h->nestedSeq[i].wsaControl;
 	}
-	delete[] h->seqn;
+	delete[] h->nestedSeq;
 
 	delete h;
 	ptr = 0;
 	size = 0;
 }
 
-void StaticResource::freeHofShapeAnimDataV1(void *&ptr, int &size) {
-	ItemAnimData_v1 *d = (ItemAnimData_v1 *)ptr;
+void StaticResource::freeHoFSeqItemAnimData(void *&ptr, int &size) {
+	HoFSeqItemAnimData *d = (HoFSeqItemAnimData *)ptr;
 	for (int i = 0; i < size; i++)
 		delete[] d[i].frames;
 	delete[] d;
@@ -994,9 +995,7 @@ void KyraEngine_LoK::loadMainScreen(int page) {
 void KyraEngine_HoF::initStaticResource() {
 	int tmpSize = 0;
 
-	_sequencePakList = _staticres->loadStrings(k2SeqplayPakFiles, _sequencePakListSize);
 	_ingamePakList = _staticres->loadStrings(k2IngamePakFiles, _ingamePakListSize);
-	_sequenceStrings = _staticres->loadStrings(k2SeqplayStrings, _sequenceStringsSize);
 	_ingameSoundList = _staticres->loadStrings(k2IngameSfxFiles, _ingameSoundListSize);
 	_ingameSoundIndex = (const uint16 *)_staticres->loadRawData(k2IngameSfxIndex, _ingameSoundIndexSize);
 	_musicFileListIntro = _staticres->loadStrings(k2SeqplayIntroTracks, _musicFileListIntroSize);
@@ -1009,33 +1008,6 @@ void KyraEngine_HoF::initStaticResource() {
 	_ingameTimJpStr = _staticres->loadStrings(k2IngameTimJpStrings, _ingameTimJpStrSize);
 	_itemAnimDefinition = _staticres->loadItemAnimDefinition(k2IngameShapeAnimData, _itemAnimDefinitionSize);
 
-	// replace sequence talkie files with localized versions
-	const char *const *seqSoundList = _staticres->loadStrings(k2SeqplaySfxFiles, _sequenceSoundListSize);
-	const char *const *tlkfiles = _staticres->loadStrings(k2SeqplayTlkFiles, tmpSize);
-	char **tmpSndLst = new char *[_sequenceSoundListSize];
-
-	for (int i = 0; i < _sequenceSoundListSize; i++) {
-		const int len = strlen(seqSoundList[i]);
-
-		tmpSndLst[i] = new char[len + 1];
-		tmpSndLst[i][0] = 0;
-
-		if (tlkfiles && len > 1) {
-			for (int ii = 0; ii < tmpSize; ii++) {
-				if (strlen(tlkfiles[ii]) > 1 && !scumm_stricmp(&seqSoundList[i][1], &tlkfiles[ii][1]))
-					strcpy(tmpSndLst[i], tlkfiles[ii]);
-			}
-		}
-
-		if (tmpSndLst[i][0] == 0)
-			strcpy(tmpSndLst[i], seqSoundList[i]);
-	}
-
-	tlkfiles = seqSoundList = 0;
-	_staticres->unloadId(k2SeqplayTlkFiles);
-	_staticres->unloadId(k2SeqplaySfxFiles);
-	_sequenceSoundList = tmpSndLst;
-
 	// assign music data
 	static const char *const fmtMusicFileListIntro[] = { "intro%d.twn" };
 	static const char *const fmtMusicFileListFinale[] = { "finale%d.twn" };
@@ -1074,66 +1046,6 @@ void KyraEngine_HoF::initStaticResource() {
 		_soundData[2].fileList = pc98MusicFileListFinale;
 		_soundData[2].fileListLen = 1;
 	}
-
-	// setup sequence data
-	_sequences = _staticres->loadHofSequenceData(k2SeqplaySeqData, tmpSize);
-
-	static const SeqProc hofSequenceCallbacks[] = {
-		0, &KyraEngine_HoF::seq_introWestwood,
-		&KyraEngine_HoF::seq_introTitle, &KyraEngine_HoF::seq_introOverview,
-		&KyraEngine_HoF::seq_introLibrary, &KyraEngine_HoF::seq_introHand,
-		&KyraEngine_HoF::seq_introPoint, &KyraEngine_HoF::seq_introZanfaun,
-		&KyraEngine_HoF::seq_finaleFunters, &KyraEngine_HoF::seq_finaleFerb,
-		&KyraEngine_HoF::seq_finaleFish, &KyraEngine_HoF::seq_finaleFheep,
-		&KyraEngine_HoF::seq_finaleFarmer, &KyraEngine_HoF::seq_finaleFuards,
-		&KyraEngine_HoF::seq_finaleFirates, &KyraEngine_HoF::seq_finaleFrash
-	};
-
-	static const SeqProc hofNestedSequenceCallbacks[] = {
-		&KyraEngine_HoF::seq_finaleFiggle, &KyraEngine_HoF::seq_introOver1,
-		&KyraEngine_HoF::seq_introOver2, &KyraEngine_HoF::seq_introForest,
-		&KyraEngine_HoF::seq_introDragon, &KyraEngine_HoF::seq_introDarm,
-		&KyraEngine_HoF::seq_introLibrary2, &KyraEngine_HoF::seq_introLibrary2,
-		&KyraEngine_HoF::seq_introMarco, &KyraEngine_HoF::seq_introHand1a,
-		&KyraEngine_HoF::seq_introHand1b, &KyraEngine_HoF::seq_introHand1c,
-		&KyraEngine_HoF::seq_introHand2, &KyraEngine_HoF::seq_introHand3, 0
-	};
-
-	static const SeqProc hofDemoSequenceCallbacks[] = {
-		&KyraEngine_HoF::seq_demoVirgin, &KyraEngine_HoF::seq_demoWestwood,
-		&KyraEngine_HoF::seq_demoTitle, &KyraEngine_HoF::seq_demoHill,
-		&KyraEngine_HoF::seq_demoOuthome, &KyraEngine_HoF::seq_demoWharf,
-		&KyraEngine_HoF::seq_demoDinob, &KyraEngine_HoF::seq_demoFisher, 0
-	};
-
-	static const SeqProc hofDemoNestedSequenceCallbacks[] = {
-		&KyraEngine_HoF::seq_demoWharf2, &KyraEngine_HoF::seq_demoDinob2,
-		&KyraEngine_HoF::seq_demoWater, &KyraEngine_HoF::seq_demoBail,
-		&KyraEngine_HoF::seq_demoDig, 0
-	};
-
-#ifdef ENABLE_LOL
-	static const SeqProc kLoLDemoSequenceCallbacks[] = {
-		&KyraEngine_HoF::seq_lolDemoScene1, 0, &KyraEngine_HoF::seq_lolDemoScene2, 0,
-		&KyraEngine_HoF::seq_lolDemoScene3, 0, &KyraEngine_HoF::seq_lolDemoScene4, 0,
-		&KyraEngine_HoF::seq_lolDemoScene5, &KyraEngine_HoF::seq_lolDemoText5,
-		&KyraEngine_HoF::seq_lolDemoScene6, 0
-	};
-
-	static const SeqProc kLoLDemoNestedSequenceCallbacks[] = { 0 };
-#endif // ENABLE_LOL
-
-	_callbackS =
-#ifdef ENABLE_LOL
-	    _flags.gameID == GI_LOL ? kLoLDemoSequenceCallbacks :
-#endif // ENABLE_LOL
-	    ((_flags.isDemo && !_flags.isTalkie) ? hofDemoSequenceCallbacks : hofSequenceCallbacks);
-
-	_callbackN =
-#ifdef ENABLE_LOL
-	    _flags.gameID == GI_LOL ? kLoLDemoNestedSequenceCallbacks :
-#endif // ENABLE_LOL
-	    ((_flags.isDemo && !_flags.isTalkie) ? hofDemoNestedSequenceCallbacks : hofNestedSequenceCallbacks);
 }
 
 void KyraEngine_MR::initStaticResource() {
@@ -1412,8 +1324,6 @@ const int GUI_v2::_sliderBarsPosition[] = {
 
 // kyra 2 static res
 
-const uint8 KyraEngine_HoF::_seqTextColorPresets[] = { 0x01, 0x01, 0x00, 0x3f, 0x3f, 0x3f };
-
 const char *const KyraEngine_HoF::_languageExtension[] = {
 	"ENG",
 	"FRE",