rom.h

Go to the documentation of this file.

#ifndef YAZE_APP_ROM_H
#define YAZE_APP_ROM_H
 
#include <SDL.h>
 
#include <cstddef>
#include <cstdint>
#include <cstring>
#include <ctime>
#include <iostream>
#include <map>
#include <memory>
#include <string>
#include <variant>
#include <vector>
 
#include "absl/status/status.h"
#include "absl/status/statusor.h"
#include "absl/strings/match.h"
#include "absl/strings/str_format.h"
#include "absl/strings/string_view.h"
#include "app/core/common.h"
#include "app/core/constants.h"
#include "app/core/project.h"
#include "app/gfx/bitmap.h"
#include "app/gfx/snes_palette.h"
#include "app/gfx/snes_tile.h"
 
namespace yaze {
namespace app {
 
enum class Z3_Version {
  US = 1,     // US version
  JP = 2,     // JP version
  SD = 3,     // Super Donkey Proto (Experimental)
  RANDO = 4,  // Randomizer (Unimplemented)
};
 
struct VersionConstants {
  uint32_t kGfxAnimatedPointer;
  uint32_t kOverworldGfxGroups1;
  uint32_t kOverworldGfxGroups2;
  uint32_t kCompressedAllMap32PointersHigh;
  uint32_t kCompressedAllMap32PointersLow;
  uint32_t overworldMapPaletteGroup;
  uint32_t overlayPointers;
  uint32_t overlayPointersBank;
  uint32_t overworldTilesType;
  uint32_t kOverworldGfxPtr1;
  uint32_t kOverworldGfxPtr2;
  uint32_t kOverworldGfxPtr3;
  uint32_t kMap32TileTL;
  uint32_t kMap32TileTR;
  uint32_t kMap32TileBL;
  uint32_t kMap32TileBR;
  uint32_t kSpriteBlocksetPointer;
  uint32_t kDungeonPalettesGroups;
};
 
static const std::map<Z3_Version, VersionConstants> kVersionConstantsMap = {
    {Z3_Version::US,
     {
         0x10275,  // kGfxAnimatedPointer
         0x5D97,   // kOverworldGfxGroups1
         0x6073,   // kOverworldGfxGroups2
         0x1794D,  // kCompressedAllMap32PointersHigh
         0x17B2D,  // kCompressedAllMap32PointersLow
         0x75504,  // overworldMapPaletteGroup
         0x77664,  // overlayPointers
         0x0E,     // overlayPointersBank
         0x71459,  // overworldTilesType
         0x4F80,   // kOverworldGfxPtr1
         0x505F,   // kOverworldGfxPtr2
         0x513E,   // kOverworldGfxPtr3
         0x18000,  // kMap32TileTL
         0x1B400,  // kMap32TileTR
         0x20000,  // kMap32TileBL
         0x23400,  // kMap32TileBR
         0x5B57,   // kSpriteBlocksetPointer
         0x75460,  // kDungeonPalettesGroups
     }},
    {Z3_Version::JP,
     {
         0x10624,  // kGfxAnimatedPointer
         0x5DD7,   // kOverworldGfxGroups1
         0x60B3,   // kOverworldGfxGroups2
         0x176B1,  // kCompressedAllMap32PointersHigh
         0x17891,  // kCompressedAllMap32PointersLow
         0x67E74,  // overworldMapPaletteGroup
         0x3FAF4,  // overlayPointers
         0x07,     // overlayPointersBank
         0x7FD94,  // overworldTilesType
         0x4FC0,   // kOverworldGfxPtr1
         0x509F,   // kOverworldGfxPtr2
         0x517E,   // kOverworldGfxPtr3
         0x18000,  // kMap32TileTL
         0x1B3C0,  // kMap32TileTR
         0x20000,  // kMap32TileBL
         0x233C0,  // kMap32TileBR
         0x5B97,   // kSpriteBlocksetPointer
         0x67DD0,  // kDungeonPalettesGroups
     }},
    {Z3_Version::SD, {}},
    {Z3_Version::RANDO, {}},
};
 
constexpr uint32_t kNumGfxSheets = 223;
constexpr uint32_t kNumLinkSheets = 14;
constexpr uint32_t kTile16Ptr = 0x78000;
constexpr uint32_t kNormalGfxSpaceStart = 0x87000;
constexpr uint32_t kNormalGfxSpaceEnd = 0xC4200;
constexpr uint32_t kFontSpriteLocation = 0x70000;
constexpr uint32_t kGfxGroupsPointer = 0x6237;
constexpr uint32_t kUncompressedSheetSize = 0x0800;
constexpr uint32_t kNumMainBlocksets = 37;
constexpr uint32_t kNumRoomBlocksets = 82;
constexpr uint32_t kNumSpritesets = 144;
constexpr uint32_t kNumPalettesets = 72;
constexpr uint32_t kEntranceGfxGroup = 0x5D97;
 
// TODO: Verify what this was used for in ZS
constexpr uint32_t kMaxGraphics = 0xC3FB5;
 
class Rom : public core::ExperimentFlags {
 public:
  absl::StatusOr<std::vector<uint8_t>> Load2BppGraphics();
 
  absl::Status LoadLinkGraphics();
 
  absl::Status LoadAllGraphicsData(bool defer_render = false);
 
  absl::Status LoadFromFile(const std::string& filename, bool z3_load = true);
  absl::Status LoadFromPointer(uchar* data, size_t length, bool z3_load = true);
  absl::Status LoadFromBytes(const std::vector<uint8_t>& data);
 
  absl::Status SaveToFile(bool backup, bool save_new = false,
                          std::string filename = "");
 
  absl::Status SaveAllGraphicsData();
 
  absl::Status SavePalette(int index, const std::string& group_name,
                           gfx::SnesPalette& palette);
 
  absl::Status SaveAllPalettes();
 
  void Expand(int size) {
    rom_data_.resize(size);
    size_ = size;
  }
 
  absl::Status Close() {
    rom_data_.clear();
    size_ = 0;
    is_loaded_ = false;
    return absl::OkStatus();
  }
 
  absl::Status ReadWritePreconditions() {
    if (!is_loaded_) {
      return absl::FailedPreconditionError("ROM file not loaded");
    }
    if (rom_data_.empty() || size_ == 0) {
      return absl::FailedPreconditionError(
          "File was loaded, but ROM data was empty.");
    }
    return absl::OkStatus();
  }
 
  // Read functions
  absl::StatusOr<uint8_t> ReadByte(int offset) {
    RETURN_IF_ERROR(ReadWritePreconditions());
    if (offset >= static_cast<int>(rom_data_.size())) {
      return absl::FailedPreconditionError("Offset out of range");
    }
    return rom_data_[offset];
  }
 
  absl::StatusOr<uint16_t> ReadWord(int offset) {
    RETURN_IF_ERROR(ReadWritePreconditions());
    if (offset + 1 >= static_cast<int>(rom_data_.size())) {
      return absl::FailedPreconditionError("Offset out of range");
    }
    auto result = (uint16_t)(rom_data_[offset] | (rom_data_[offset + 1] << 8));
    return result;
  }
 
  uint16_t toint16(int offset) {
    return (uint16_t)(rom_data_[offset] | (rom_data_[offset + 1] << 8));
  }
 
  absl::StatusOr<uint32_t> ReadLong(int offset) {
    RETURN_IF_ERROR(ReadWritePreconditions());
    if (offset + 2 >= static_cast<int>(rom_data_.size())) {
      return absl::OutOfRangeError("Offset out of range");
    }
    auto result = (uint32_t)(rom_data_[offset] | (rom_data_[offset + 1] << 8) |
                             (rom_data_[offset + 2] << 16));
    return result;
  }
 
  absl::StatusOr<std::vector<uint8_t>> ReadByteVector(uint32_t offset,
                                                      uint32_t length) {
    RETURN_IF_ERROR(ReadWritePreconditions());
    if (offset + length > static_cast<uint32_t>(rom_data_.size())) {
      return absl::OutOfRangeError("Offset and length out of range");
    }
    std::vector<uint8_t> result;
    for (uint32_t i = offset; i < offset + length; i++) {
      result.push_back(rom_data_[i]);
    }
    return result;
  }
 
  absl::StatusOr<gfx::Tile16> ReadTile16(uint32_t tile16_id) {
    // Skip 8 bytes per tile.
    auto tpos = kTile16Ptr + (tile16_id * 0x08);
    gfx::Tile16 tile16;
    ASSIGN_OR_RETURN(auto new_tile0, ReadWord(tpos))
    tile16.tile0_ = gfx::WordToTileInfo(new_tile0);
    tpos += 2;
    ASSIGN_OR_RETURN(auto new_tile1, ReadWord(tpos))
    tile16.tile1_ = gfx::WordToTileInfo(new_tile1);
    tpos += 2;
    ASSIGN_OR_RETURN(auto new_tile2, ReadWord(tpos))
    tile16.tile2_ = gfx::WordToTileInfo(new_tile2);
    tpos += 2;
    ASSIGN_OR_RETURN(auto new_tile3, ReadWord(tpos))
    tile16.tile3_ = gfx::WordToTileInfo(new_tile3);
    return tile16;
  }
 
  absl::Status WriteTile16(int tile16_id, const gfx::Tile16& tile) {
    // Skip 8 bytes per tile.
    auto tpos = kTile16Ptr + (tile16_id * 0x08);
    RETURN_IF_ERROR(WriteShort(tpos, gfx::TileInfoToWord(tile.tile0_)));
    tpos += 2;
    RETURN_IF_ERROR(WriteShort(tpos, gfx::TileInfoToWord(tile.tile1_)));
    tpos += 2;
    RETURN_IF_ERROR(WriteShort(tpos, gfx::TileInfoToWord(tile.tile2_)));
    tpos += 2;
    RETURN_IF_ERROR(WriteShort(tpos, gfx::TileInfoToWord(tile.tile3_)));
    return absl::OkStatus();
  }
 
  // Write functions
  absl::Status Write(int addr, int value) {
    if (addr >= static_cast<int>(rom_data_.size())) {
      return absl::InvalidArgumentError(absl::StrFormat(
          "Attempt to write %d value failed, address %d out of range", value,
          addr));
    }
    rom_data_[addr] = value;
    return absl::OkStatus();
  }
 
  absl::Status WriteByte(int addr, uint8_t value) {
    RETURN_IF_ERROR(ReadWritePreconditions());
    if (addr >= static_cast<int>(rom_data_.size())) {
      return absl::OutOfRangeError(absl::StrFormat(
          "Attempt to write byte %#02x value failed, address %d out of range",
          value, addr));
    }
    rom_data_[addr] = value;
    std::string log_str = absl::StrFormat("WriteByte: %#06X: %s", addr,
                                          core::UppercaseHexByte(value).data());
    core::Logger::log(log_str);
    return absl::OkStatus();
  }
 
  absl::Status WriteWord(int addr, uint16_t value) {
    RETURN_IF_ERROR(ReadWritePreconditions());
    if (addr + 1 >= static_cast<int>(rom_data_.size())) {
      return absl::OutOfRangeError(absl::StrFormat(
          "Attempt to write word %#04x value failed, address %d out of range",
          value, addr));
    }
    rom_data_[addr] = (uint8_t)(value & 0xFF);
    rom_data_[addr + 1] = (uint8_t)((value >> 8) & 0xFF);
    core::Logger::log(absl::StrFormat("WriteWord: %#06X: %s", addr,
                                      core::UppercaseHexWord(value)));
    return absl::OkStatus();
  }
 
  absl::Status WriteShort(int addr, uint16_t value) {
    RETURN_IF_ERROR(ReadWritePreconditions());
    if (addr + 1 >= static_cast<int>(rom_data_.size())) {
      return absl::OutOfRangeError(absl::StrFormat(
          "Attempt to write short %#04x value failed, address %d out of range",
          value, addr));
    }
    rom_data_[addr] = (uint8_t)(value & 0xFF);
    rom_data_[addr + 1] = (uint8_t)((value >> 8) & 0xFF);
    core::Logger::log(absl::StrFormat("WriteShort: %#06X: %s", addr,
                                      core::UppercaseHexWord(value)));
    return absl::OkStatus();
  }
 
  absl::Status WriteLong(uint32_t addr, uint32_t value) {
    RETURN_IF_ERROR(ReadWritePreconditions());
    if (addr + 2 >= static_cast<uint32_t>(rom_data_.size())) {
      return absl::OutOfRangeError(absl::StrFormat(
          "Attempt to write long %#06x value failed, address %d out of range",
          value, addr));
    }
    rom_data_[addr] = (uint8_t)(value & 0xFF);
    rom_data_[addr + 1] = (uint8_t)((value >> 8) & 0xFF);
    rom_data_[addr + 2] = (uint8_t)((value >> 16) & 0xFF);
    core::Logger::log(absl::StrFormat("WriteLong: %#06X: %s", addr,
                                      core::UppercaseHexLong(value)));
    return absl::OkStatus();
  }
 
  absl::Status WriteVector(int addr, std::vector<uint8_t> data) {
    if (addr + static_cast<int>(data.size()) >
        static_cast<int>(rom_data_.size())) {
      return absl::InvalidArgumentError(absl::StrFormat(
          "Attempt to write vector value failed, address %d out of range",
          addr));
    }
    for (int i = 0; i < static_cast<int>(data.size()); i++) {
      rom_data_[addr + i] = data[i];
    }
    core::Logger::log(absl::StrFormat("WriteVector: %#06X: %s", addr,
                                      core::UppercaseHexByte(data[0])));
    return absl::OkStatus();
  }
 
  absl::Status WriteColor(uint32_t address, const gfx::SnesColor& color) {
    uint16_t bgr = ((color.snes() >> 10) & 0x1F) |
                   ((color.snes() & 0x1F) << 10) | (color.snes() & 0x7C00);
 
    // Write the 16-bit color value to the ROM at the specified address
    core::Logger::log(absl::StrFormat("WriteColor: %#06X: %s", address,
                                      core::UppercaseHexWord(bgr)));
    return WriteShort(address, bgr);
  }
 
  template <typename... Args>
  absl::Status WriteTransaction(Args... args) {
    absl::Status status;
    // Fold expression to apply the Write function on each argument
    ((status = WriteHelper(args)), ...);
    return status;
  }
 
  template <typename T, typename... Args>
  absl::Status ReadTransaction(T& var, int address, Args&&... args) {
    absl::Status status = ReadHelper<T>(var, address);
    if (!status.ok()) {
      return status;
    }
 
    if constexpr (sizeof...(args) > 0) {
      status = ReadTransaction(std::forward<Args>(args)...);
    }
 
    return status;
  }
 
  uint8_t& operator[](unsigned long i) {
    if (i > size_) {
      std::cout << "ROM: Index " << i << " out of bounds, size: " << size_
                << std::endl;
      return rom_data_[0];
    }
    return rom_data_[i];
  }
 
  bool is_loaded() const {
    if (!absl::StrContains(filename_, ".sfc") &&
        !absl::StrContains(filename_, ".smc")) {
      return false;
    }
    return is_loaded_;
  }
 
  // Full graphical data for the game
  std::vector<uint8_t> graphics_buffer() const { return graphics_buffer_; }
 
  auto title() const { return title_; }
  auto size() const { return size_; }
  auto begin() { return rom_data_.begin(); }
  auto end() { return rom_data_.end(); }
  auto data() { return rom_data_.data(); }
  auto vector() const { return rom_data_; }
  auto version() const { return version_; }
  auto filename() const { return filename_; }
  auto set_filename(std::string name) { filename_ = name; }
 
  auto link_graphics() { return link_graphics_; }
  auto mutable_link_graphics() { return &link_graphics_; }
  auto gfx_sheets() { return graphics_sheets_; }
  auto mutable_gfx_sheets() { return &graphics_sheets_; }
 
  auto palette_group() { return palette_groups_; }
  auto mutable_palette_group() { return &palette_groups_; }
  auto dungeon_palette(int i) { return palette_groups_.dungeon_main[i]; }
  auto mutable_dungeon_palette(int i) {
    return palette_groups_.dungeon_main.mutable_palette(i);
  }
 
  ResourceLabelManager* resource_label() { return &resource_label_manager_; }
  VersionConstants version_constants() const {
    return kVersionConstantsMap.at(version_);
  }
 
  std::array<std::array<uint8_t, 8>, kNumMainBlocksets> main_blockset_ids;
  std::array<std::array<uint8_t, 4>, kNumRoomBlocksets> room_blockset_ids;
  std::array<std::array<uint8_t, 4>, kNumSpritesets> spriteset_ids;
  std::array<std::array<uint8_t, 4>, kNumPalettesets> paletteset_ids;
 
  struct WriteAction {
    int address;
    std::variant<int, uint8_t, uint16_t, short, std::vector<uint8_t>,
                 gfx::SnesColor, std::vector<gfx::SnesColor>>
        value;
  };
 
 private:
  virtual absl::Status WriteHelper(const WriteAction& action) {
    if (std::holds_alternative<uint8_t>(action.value)) {
      return Write(action.address, std::get<uint8_t>(action.value));
    } else if (std::holds_alternative<uint16_t>(action.value) ||
               std::holds_alternative<short>(action.value)) {
      return WriteShort(action.address, std::get<uint16_t>(action.value));
    } else if (std::holds_alternative<std::vector<uint8_t>>(action.value)) {
      return WriteVector(action.address,
                         std::get<std::vector<uint8_t>>(action.value));
    } else if (std::holds_alternative<gfx::SnesColor>(action.value)) {
      return WriteColor(action.address, std::get<gfx::SnesColor>(action.value));
    } else if (std::holds_alternative<std::vector<gfx::SnesColor>>(
                   action.value)) {
      return absl::UnimplementedError(
          "WriteHelper: std::vector<gfx::SnesColor>");
    }
    auto error_message = absl::StrFormat("Invalid write argument type: %s",
                                         typeid(action.value).name());
    return absl::InvalidArgumentError(error_message);
  }
 
  template <typename T>
  absl::Status ReadHelper(T& var, int address) {
    if constexpr (std::is_same_v<T, uint8_t>) {
      ASSIGN_OR_RETURN(auto result, ReadByte(address));
      var = result;
    } else if constexpr (std::is_same_v<T, uint16_t>) {
      ASSIGN_OR_RETURN(auto result, ReadWord(address));
      var = result;
    } else if constexpr (std::is_same_v<T, std::vector<uint8_t>>) {
      ASSIGN_OR_RETURN(auto result, ReadByteVector(address, var.size()));
      var = result;
    }
    return absl::OkStatus();
  }
 
  absl::Status LoadZelda3();
  absl::Status LoadGfxGroups();
  absl::Status SaveGroupsToRom();
 
  // ROM file loaded flag
  bool is_loaded_ = false;
 
  // Size of the ROM data.
  unsigned long size_ = 0;
 
  // Title of the ROM loaded from the header
  std::string title_ = "ROM not loaded";
 
  // Filename of the ROM
  std::string filename_ = "";
 
  // Full contiguous rom space
  std::vector<uint8_t> rom_data_;
 
  // Full contiguous graphics space
  std::vector<uint8_t> graphics_buffer_;
 
  // All graphics sheets in the game
  std::array<gfx::Bitmap, kNumGfxSheets> graphics_sheets_;
 
  // All graphics sheets for Link
  std::array<gfx::Bitmap, kNumLinkSheets> link_graphics_;
 
  // Label manager for unique resource names.
  ResourceLabelManager resource_label_manager_;
 
  // All palette groups in the game
  gfx::PaletteGroupMap palette_groups_;
 
  // Version of the game
  Z3_Version version_ = Z3_Version::US;
};
 
class SharedRom {
 public:
  SharedRom() = default;
  virtual ~SharedRom() = default;
 
  std::shared_ptr<Rom> shared_rom() {
    if (!shared_rom_) {
      shared_rom_ = std::make_shared<Rom>();
    }
    return shared_rom_;
  }
 
  auto rom() {
    if (!shared_rom_) {
      shared_rom_ = std::make_shared<Rom>();
    }
    Rom* rom = shared_rom_.get();
    return rom;
  }
 
  // private:
  static std::shared_ptr<Rom> shared_rom_;
};
 
}  // namespace app
}  // namespace yaze
 
#endif