Abstracted some of the sprite dumper functionality out

4 files changed, 199 insertions, 93 deletions

@@ -8,8 +8,12 @@ pkg_check_modules(GraphicsMagick GraphicsMagick++ REQUIRED)
 
 include_directories(${GraphicsMagick_INCLUDE_DIRS})
 
-add_executable(sprite_dumper main.cpp)
-
+add_executable(sprite_dumper sprite_dumper.cpp)
 set_property(TARGET sprite_dumper PROPERTY CXX_STANDARD 17)
 set_property(TARGET sprite_dumper PROPERTY CXX_STANDARD_REQUIRED ON)
 target_link_libraries(sprite_dumper ${GraphicsMagick_LIBRARIES})
+
+add_executable(tileset_dumper tileset_dumper.cpp)
+set_property(TARGET tileset_dumper PROPERTY CXX_STANDARD 17)
+set_property(TARGET tileset_dumper PROPERTY CXX_STANDARD_REQUIRED ON)
+target_link_libraries(tileset_dumper ${GraphicsMagick_LIBRARIES})
@@ -0,0 +1,139 @@
+#ifndef COMMON_H_04DD2B2A
+#define COMMON_H_04DD2B2A
+
+#include <vector>
+#include <string_view>
+#include <fstream>
+#include <stdexcept>
+
+class BufferView {
+public:
+
+  BufferView(const std::vector<char>& buffer) : data_(&buffer) {}
+
+  int ReadNextByte() {
+    int o2r = offset_;
+    offset_++;
+    return ReadByte(o2r);
+  }
+
+  int ReadByte(int addr) const {
+    return static_cast<unsigned char>((*data_)[addr]);
+  }
+
+  int ReadNextTwoBytes() {
+    int o2r = offset_;
+    offset_+=2;
+    return ReadTwoBytes(o2r);
+  }
+
+  int ReadTwoBytes(int addr) const {
+    return static_cast<unsigned char>((*data_)[addr]) | (static_cast<unsigned char>((*data_)[addr + 1]) << 8);
+  }
+
+  int ReadNextFourBytes() {
+    int o2r = offset_;
+    offset_+=4;
+    return ReadFourBytes(o2r);
+  }
+
+  unsigned long ReadFourBytes(int addr) const {
+    return static_cast<unsigned char>((*data_)[addr]) | (static_cast<unsigned char>((*data_)[addr + 1]) << 8) | (static_cast<unsigned char>((*data_)[addr + 2]) << 16) | (static_cast<unsigned char>((*data_)[addr + 3]) << 24);
+  }
+
+  void Seek(int offset) {
+    offset_ = offset;
+  }
+
+  void SeekAdd(int delta) {
+    offset_ += delta;
+  }
+
+  std::vector<char> Decompress(int addr) {
+    int start = addr;
+    Seek(addr);
+    if (ReadNextByte() != 0x10) {
+      throw std::domain_error("No LZ77 signature");
+    }
+
+    int length = ReadNextByte();
+    length += (ReadNextByte() << 8);
+    length += (ReadNextByte() << 16);
+
+    std::vector<char> result(length, 0);
+
+    int bPos = 0;
+    while (bPos < length) {
+      unsigned char ch = ReadNextByte();
+      for (int i=0;i<8;i++) {
+        switch ((ch >> (7-i)) & 1) {
+          case 0: {
+            if (bPos >= length) break;
+            result[bPos++] = ReadNextByte();
+            break;
+          }
+          case 1: {
+            int t = (ReadNextByte() << 8);
+            t += ReadNextByte();
+            int n = ((t >> 12) & 0xF) + 3; // num of bytes to copy
+            int o = (t & 0xFFF);
+
+            memcpy(result.data() + bPos, result.data() + bPos - o - 1, n);
+            bPos += n;
+            break;
+          }
+          default: break;
+        }
+      }
+    }
+
+    return result;
+  }
+
+private:
+
+  const std::vector<char>* data_;
+  int offset_ = 0;
+};
+
+class Rom {
+public:
+
+  explicit Rom(std::string_view filename) {
+    std::ifstream romfile(filename.data(), std::ios::binary);
+    if (!romfile.is_open()) {
+      throw std::invalid_argument("Could not find ROM file: " + std::string(filename));
+    }
+
+    romfile.seekg(0, romfile.end);
+    int length = romfile.tellg();
+    romfile.seekg(0, romfile.beg);
+
+    if (length != 0x2000000) {
+      throw std::invalid_argument("Incorrect ROM length");
+    }
+
+    data_ = std::vector<char>(length, 0);
+    romfile.read(data_.data(), length);
+
+    const char header[] = {'M','O','T','H','E','R','3',0,0,0,0,0,'A','3','U','J'};
+    std::string headerTest;
+    for (int i = 0xA0; i < 0xB0; i++) {
+      if (data_.at(i) != header[i-0xA0]) {
+        std::cout << i << std::endl;
+
+        throw std::invalid_argument("Invalid ROM header");
+      }
+    }
+  }
+
+  const std::vector<char>& data() const { return data_; }
+
+  BufferView buffer() const { return {data_}; }
+
+private:
+
+  std::vector<char> data_;
+};
+
+#endif /* end of include guard: COMMON_H_04DD2B2A */
@@ -8,90 +8,14 @@
 #include <iostream>
 #include <Magick++.h>
 #include <sstream>
-
-class Rom {
-public:
-
-  explicit Rom(std::string_view filename) {
-    std::ifstream romfile(filename.data(), std::ios::binary);
-    if (!romfile.is_open()) {
-      throw std::invalid_argument("Could not find ROM file: " + std::string(filename));
-    }
-
-    romfile.seekg(0, romfile.end);
-    int length = romfile.tellg();
-    romfile.seekg(0, romfile.beg);
-
-    if (length != 0x2000000) {
-      throw std::invalid_argument("Incorrect ROM length");
-    }
-
-    data_ = std::vector<char>(length, 0);
-    romfile.read(data_.data(), length);
-
-    const char header[] = {'M','O','T','H','E','R','3',0,0,0,0,0,'A','3','U','J'};
-    std::string headerTest;
-    for (int i = 0xA0; i < 0xB0; i++) {
-      if (data_.at(i) != header[i-0xA0]) {
-        std::cout << i << std::endl;
-
-        throw std::invalid_argument("Invalid ROM header");
-      }
-    }
-  }
-
-  const std::vector<char>& data() const { return data_; }
-
-  int ReadNextByte() {
-    int o2r = offset_;
-    offset_++;
-    return ReadByte(o2r);
-  }
-
-  int ReadByte(int addr) const {
-    return static_cast<unsigned char>(data_[addr]);
-  }
-
-  int ReadNextTwoBytes() {
-    int o2r = offset_;
-    offset_+=2;
-    return ReadTwoBytes(o2r);
-  }
-
-  int ReadTwoBytes(int addr) const {
-    return static_cast<unsigned char>(data_[addr]) | (static_cast<unsigned char>(data_[addr + 1]) << 8);
-  }
-
-  int ReadNextFourBytes() {
-    int o2r = offset_;
-    offset_+=4;
-    return ReadFourBytes(o2r);
-  }
-
-  unsigned long ReadFourBytes(int addr) const {
-    return static_cast<unsigned char>(data_[addr]) | (static_cast<unsigned char>(data_[addr + 1]) << 8) | (static_cast<unsigned char>(data_[addr + 2]) << 16) | (static_cast<unsigned char>(data_[addr + 3]) << 24);
-  }
-
-  void Seek(int offset) {
-    offset_ = offset;
-  }
-
-  void SeekAdd(int delta) {
-    offset_ += delta;
-  }
-
-private:
-
-  std::vector<char> data_;
-  int offset_ = 0;
-};
+#include "common.h"
 
 class Palette {
 public:
 
   Palette() = default;
 
-  Palette(Rom& m3, const int addr) {
+  Palette(BufferView m3, const int addr) {
     for (int i=0; i<16; i++) {
       unsigned short ch = m3.ReadTwoBytes(addr + (i << 1));
       int r = (ch & 0x1F);
@@ -109,7 +33,7 @@ private:
 
 class PaletteSet {
 public:
-  PaletteSet(Rom& m3) : m3_(m3) {
+  PaletteSet(BufferView m3) : m3_(m3) {
     for (int i=0; i<16; i++) {
       defaultPals_.emplace_back(m3, GetPointer(0) + (i << 5));
     }
@@ -147,7 +71,7 @@ private:
     return ADDR + a;
   }
 
-  Rom& m3_;
+  BufferView m3_;
   std::vector<Palette> defaultPals_;
   std::map<int, Palette> specialPals_;
 };
@@ -182,7 +106,7 @@ struct FrameOutput {
 struct Sprite {
   std::vector<Subsprite> subsprites;
 
-  FrameOutput render(Rom& m3, const Palette& palette, const int gfxPtr) const {
+  FrameOutput render(BufferView m3, const Palette& palette, const int gfxPtr) const {
     FrameOutput output;
 
     if (subsprites.empty()) return output;
@@ -271,7 +195,7 @@ struct SpriteSheet {
   int gfxPtr;
   std::vector<Sprite> sprites;
 
-  void render(Rom& m3, PaletteSet& palettes, std::vector<FrameOutput>& frames) const {
+  void render(BufferView m3, PaletteSet& palettes, std::vector<FrameOutput>& frames) const {
     const Palette& palette = palettes.GetPalette(spriteindex);
     for (int i=0; i<sprites.size(); i++) {
       FrameOutput f = sprites[i].render(m3, palette, gfxPtr);
@@ -283,7 +207,7 @@ struct SpriteSheet {
 class Bank {
 public:
 
-  Bank(Rom& m3, const int baseAddr, const int gfxAddr) : baseAddr_(baseAddr), gfxAddr_(gfxAddr) {
+  Bank(BufferView m3, const int baseAddr, const int gfxAddr) : baseAddr_(baseAddr), gfxAddr_(gfxAddr) {
     int numEntries = m3.ReadFourBytes(baseAddr);
     std::cout << numEntries << std::endl;
 
@@ -337,7 +261,7 @@ public:
 
 private:
 
-  int GetPointerToSheet(Rom& m3, int index) {
+  int GetPointerToSheet(BufferView m3, int index) {
     int readAt = baseAddr_ + 4 + (index << 2);
     int a = m3.ReadFourBytes(readAt);
     //std::cout << readAt << " :: " << a << std::hex << std::endl;
@@ -345,7 +269,7 @@ private:
     return a + baseAddr_;
   }
 
-  int GetGfxPointer(Rom& m3, int index) {
+  int GetGfxPointer(BufferView m3, int index) {
     return m3.ReadFourBytes(gfxAddr_ + 4 + (index << 2)) + gfxAddr_;
   }
 
@@ -365,11 +289,11 @@ int main(int argc, char** argv) {
   Magick::InitializeMagick(nullptr);
 
   Rom m3(argv[1]);
-  PaletteSet palettes(m3);
-  Bank b1(m3, 0x1A442A4, 0x14383E4);
-  Bank b2(m3, 0x1AE0638, 0x194BC30);
-  Bank b3(m3, 0x1AEE4C4, 0x1A012B8);
-  Bank b4(m3, 0x1AF1ED0, 0x1A36AA0);
+  PaletteSet palettes(m3.buffer());
+  Bank b1(m3.buffer(), 0x1A442A4, 0x14383E4);
+  Bank b2(m3.buffer(), 0x1AE0638, 0x194BC30);
+  Bank b3(m3.buffer(), 0x1AEE4C4, 0x1A012B8);
+  Bank b4(m3.buffer(), 0x1AF1ED0, 0x1A36AA0);
 
   std::vector<FrameOutput> frames;
 
@@ -394,7 +318,7 @@ int main(int argc, char** argv) {
       }
     }();
 
-    bankToRead.SpriteSheets().at(sheetNum).render(m3, palettes, frames);
+    bankToRead.SpriteSheets().at(sheetNum).render(m3.buffer(), palettes, frames);
   }
 
   int maxWidth = 0;
@@ -0,0 +1,39 @@
+#include <iostream>
+#include <Magick++.h>
+#include <vector>
+#include <string>
+#include "common.h"
+
+int main(int argc, char** argv) {
+  if (argc < 3) {
+    std::cout << "Usage: ./tileset_dumper [path to rom] {map ID}" << std::endl;
+    return -1;
+  }
+
+  Magick::InitializeMagick(nullptr);
+
+  Rom m3(argv[1]);
+
+  int roomNum = std::stoi(argv[2]);
+  const unsigned long ROOM_TILES_BASE = 0x104D9CC;
+  unsigned long metatilesInfoAddr = ROOM_TILES_BASE + 4 + (roomNum << 2);
+  unsigned long metatilesOffset = m3.buffer().ReadFourBytes(metatilesInfoAddr);
+  unsigned long metatilesAddr = metatilesOffset + ROOM_TILES_BASE;
+  std::vector<char> metatiles = m3.buffer().Decompress(metatilesAddr);
+  std::cout << (metatiles.size()/8) << std::endl;
+
+  for (int i=0; i<10; i++) {
+    int tile00 = metatiles[i*8+4];
+    int tile01 = metatiles[i*8+5];
+    int tile10 = metatiles[i*8+6];
+    int tile11 = metatiles[i*8+7];
+
+    int mask = metatiles[i*8+2];
+    if ((mask & 0x1) == 0) tile00 = -1;
+    if ((mask & 0x2) == 0) tile01 = -1;
+    if ((mask & 0x4) == 0) tile10 = -1;
+    if ((mask & 0x8) == 0) tile11 = -1;
+
+    std::cout << tile00 << "," << tile01 << "," << tile10 << "," << tile11 << std::endl;
+  }
+}
\ No newline at end of file