Script parser can read all TR2/TR3 PC/PSX Scripts

ChangeLog.md

@@ -5,6 +5,7 @@
     [ 20140807 ]
     * Script parser successfully loading level scripts
     * Can also read TR3 script now
+    * Also working with TR2/TR3 PSX Script (TOMBPSX.DAT)
 
     [ 20140806 ]
     * Improved Script reader and its Unit Test

include/Script.h

@@ -99,6 +99,9 @@ public:
     std::string getLevelName(unsigned int i);
     std::string getLevelFilename(unsigned int i);
 
+    unsigned int pictureCount();
+    std::string getPictureFilename(unsigned int i);
+
     unsigned int cutsceneCount();
     std::string getCutsceneFilename(unsigned int i);
 
@@ -149,7 +152,7 @@ private:
     };
 
     // Header
-    uint32_t version;
+    uint32_t version; // Always 3, for TR2/3 on PC and PSX
     std::string description;
 
     // Gameflow data
@@ -168,11 +171,14 @@ private:
     uint16_t numDemos;
     uint16_t titleTrack;
     int16_t singleLevel;
-    uint16_t flags;
+    uint16_t flags; // See ScriptFlag enum
     uint8_t cypherCode;
-    uint8_t language;
+    uint8_t language; // See ScriptLanguage enum
     uint16_t secretTrack;
 
+    uint16_t numPCStrings;
+    uint16_t numGameStrings;
+
     // Strings
     std::vector<std::string> levelNames; // numLevels
     std::vector<std::string> pictureFilenames; // numPictures
@@ -181,9 +187,8 @@ private:
     std::vector<std::string> levelFilenames; // numLevels
     std::vector<std::string> cutsceneFilenames; // numCutscenes
     std::vector<std::vector<uint16_t>> script; // numLevels + 1
-    uint16_t numGameStrings;
     std::vector<std::string> gameStrings; // numGameStrings
-    std::vector<std::string> pcStrings; // 41
+    std::vector<std::string> pcStrings; // 41 for TR2/3 on PC; 80 for TR2 on PSX
     std::vector<std::vector<std::string>> puzzles; // 4 * numLevels
     std::vector<std::vector<std::string>> pickups; // 2 * numLevels
     std::vector<std::vector<std::string>> keys; // 4 * numLevels

src/Script.cpp

@@ -81,7 +81,7 @@ int Script::load(const char *file) {
 
     // More strings...
     readStringPackage(f, gameStrings, numGameStrings);
-    readStringPackage(f, pcStrings, 41);
+    readStringPackage(f, pcStrings, numPCStrings);
     readStringPackage(f, puzzles[0], numLevels);
     readStringPackage(f, puzzles[1], numLevels);
     readStringPackage(f, puzzles[2], numLevels);
@@ -130,29 +130,51 @@ void Script::readScriptPackage(BinaryFile &f, std::vector<std::vector<uint16_t>>
     uint16_t numBytes = f.readU16();
     assertEqual(numBytes % 2, 0); // 16 bit opcodes and operands
 
-    // Only TR2, not TR3, has 6 "filler bytes" hex 13 00 14 00 15 00 here
-    // We need to skip these
-    uint16_t hack1 = f.readU16();
-    uint16_t hack2 = f.readU16();
-    uint16_t hack3 = f.readU16();
-    uint16_t hackStart = 0;
     uint16_t *list = new uint16_t[(numBytes + 6) / 2];
-    if ((hack1 == 19) && (hack2 == 20) && (hack3 == 21)) {
-        numBytes += 6;
+    for (uint16_t i = 0; i < (numBytes / 2); i++) {
+        list[i] = f.readU16();
+    }
+
+    // TR2 for PC and PSX has 6 "filler bytes" hex 13 00 14 00 15 00
+    // (for TR3 for PSX, the filler is hex 15 00 16 00 17 00 instead)
+    // at the end of the script block. We need to skip these...
+    uint16_t hack[3];
+    hack[0] = f.readU16();
+    hack[1] = f.readU16();
+    hack[2] = f.readU16();
+    if (((hack[0] == 19) && (hack[1] == 20) && (hack[2] == 21))
+            || ((hack[0] == 21) && (hack[1] == 22) && (hack[2] == 23))) {
+        list[numBytes / 2] = hack[0];
+        list[(numBytes / 2) + 1] = hack[1];
+        list[(numBytes / 2) + 2] = hack[2];
     } else {
-        list[0] = hack1;
-        list[1] = hack2;
-        list[2] = hack3;
-        hackStart = 3;
+        f.seek(f.tell() - 6);
     }
 
-    for (uint16_t i = hackStart; i < (numBytes / 2); i++) {
-        list[i] = f.readU16();
+    // TR2 for PSX has 64 bytes with unknown content (not zero!) here,
+    // TR3 for PSX has 40 bytes. We try to identify and skip them...
+    // This is also currently used to set the platform specific string count
+    hack[0] = f.readU16();
+    hack[1] = f.readU16();
+    hack[2] = f.readU16();
+    if ((hack[0] == 1) && (hack[1] == 0) && (hack[2] == 864)) {
+        f.seek(f.tell() + 58);
+        numPCStrings = 80; // TR2 has 80 PSX Strings
+    } else if ((hack[0] == 1) && (hack[1] == 0) && (hack[2] == 817)) {
+        f.seek(f.tell() + 34);
+        numPCStrings = 80; // TR3 also has 80 PSX Strings
+    } else {
+        f.seek(f.tell() - 6);
+        numPCStrings = 41;
     }
 
     for (unsigned int i = 0; i < n; i++) {
         unsigned int end = offset[i] / 2;
 
+        // We need to detect the OP_END opcode marking the end of a
+        // script sequence (like the '\0' for the strings).
+        // However, the numerical value of OP_END could also be used
+        // as an operand for another opcode, so we have to check for this
         bool readingOperand = false;
         while (readingOperand || (list[end] != OP_END)) {
             if (readingOperand) {
@@ -192,6 +214,15 @@ std::string Script::getLevelFilename(unsigned int i) {
     return levelFilenames.at(i);
 }
 
+unsigned int Script::pictureCount() {
+    return numPictures;
+}
+
+std::string Script::getPictureFilename(unsigned int i) {
+    assert(i < numPictures);
+    return pictureFilenames.at(i);
+}
+
 unsigned int Script::cutsceneCount() {
     return numCutscenes;
 }
@@ -229,11 +260,11 @@ std::string Script::getGameString(unsigned int i) {
 }
 
 unsigned int Script::pcStringCount() {
-    return 41;
+    return numPCStrings;
 }
 
 std::string Script::getPCString(unsigned int i) {
-    assert(i < 41);
+    assert(i < numPCStrings);
     return pcStrings.at(i);
 }
 

test/Script.cpp

@@ -51,6 +51,7 @@ namespace {
         if (strings) {
             printStrings(s.levelCount(), s.getLevelName, "Level Names");
             printStrings(s.levelCount(), s.getLevelFilename, "Level Filenames");
+            printStrings(s.pictureCount(), s.getPictureFilename, "Picture Filenames");
             printStrings(s.cutsceneCount(), s.getCutsceneFilename, "Cutscenes");
             printStrings(s.titleCount(), s.getTitleFilename, "Titles");
             printStrings(s.videoCount(), s.getVideoFilename, "Videos");
@@ -123,6 +124,14 @@ int main(int argc, char *argv[]) {
     error = test(f, !((argc > 1) && (argv[1][0] == 's')));
     delete [] f;
 
+    if (error != 0)
+        return error;
+
+    std::cout << std::endl << "Tomb Raider 3 PSX:" << std::endl;
+    f = fullPath("~/.OpenRaider/paks/tr3_psx/TOMBPSX.DAT", 0);
+    error = test(f, !((argc > 1) && (argv[1][0] == 's')));
+    delete [] f;
+
     return error;
 }