sprite_oam_tables.cc

Go to the documentation of this file.

#include "zelda3/sprite/sprite_oam_tables.h"
 
#include <algorithm>
#include <cctype>
#include <filesystem>
#include <fstream>
#include <string>
#include <unordered_map>
 
namespace yaze {
namespace zelda3 {
 
namespace {
 
// Oracle Sprites/Enemies/puffstool.asm, Sprite_Puffstool_Draw frame 0:
// CHR C0/D0, properties 33 (page 1, OBJ palette 1), 16x16 at (0,-8)/(0,0).
// Core/sprite_macros.asm DrawSprite emits the source entries in reverse order.
// This is a source-backed static preview, not an emulator-verified animation.
const SpriteOamLayout kOraclePuffstoolPreview = {
    .sprite_id = 0xB1,
    .name = "Puffstool",
    .tiles = {{0, 0, 0x1D0, 1, true, false, false},
              {0, -8, 0x1C0, 1, true, false, false}},
    .required_sheets = {0, 0, 0, 0}};
 
// Oracle Sprites/Bosses/manhandla.asm, Sprite_Manhandla_Draw frame 0. Its
// descending loop emits CHR20 at (0,8) before CHR00 at (0,-8); properties $33
// select OBJ page 1 and palette 1. This is the static front head, not the spawned
// heads, BG body, or Big Chuchu phase. ApplyManhandlaGraphics loads an external
// $2000-byte page at VRAM $5000; ordinary base-ROM room sheets are not this art.
const SpriteOamLayout kOracleManhandlaPreview = {
    .sprite_id = 0x88,
    .name = "Manhandla (static head)",
    .tiles = {{0, 8, 0x120, 1, true, false, false},
              {0, -8, 0x100, 1, true, false, false}},
    .required_sheets = {0, 0, 0, 0},
    .graphics_resource = "Bosses/manhandla.bin"};
 
// usdasm bank_0D SpriteDraw_Stalfos .oam_groups frame 0 ($0D:C0F3): CHR $00
// at (0,-10) and CHR $06 at (0,0), both 16x16. SpriteData_OAMProp[$A7] = $19
// selects OBJ page 1 and palette 1, so the tiles are OAM 0x100/0x106: the
// first spriteset slot. required_sheets stays empty; the preview draws from
// the current spriteset slots (Sprite Editor > Spriteset preview).
const SpriteOamLayout kStalfosLayout = {
    .sprite_id = 0xA7,
    .name = "Stalfos",
    .tiles = {{0, 0, 0x106, 1, true, false, false},     // Body
              {0, -10, 0x100, 1, true, false, false}},  // Head
    .required_sheets = {0, 0, 0, 0}};
 
// Static registry of all sprite layouts
const std::unordered_map<uint8_t, const SpriteOamLayout*>& GetLayoutMap() {
  static const std::unordered_map<uint8_t, const SpriteOamLayout*> layouts = {
      {0x01, &kVultureLayout},        {0x08, &kOctorokLayout},
      {0x0B, &kChickenLayout},        {0x0E, &kGreenSoldierLayout},
      {0x0F, &kBlueSoldierLayout},    {0x10, &kRedSoldierLayout},
      {0x29, &kBlueGuardLayout},      {0x41, &kGreenPatrolLayout},
      {0x44, &kArmosKnightLayout},    {0x4B, &kOctoballoonLayout},
      {0x53, &kRedEyegoreLayout},     {0x54, &kGreenEyegoreLayout},
      {0x64, &kMoblinLayout},         {0x81, &kHinoxLayout},
      {0x88, &kUncleLayout},          {0xA7, &kStalfosLayout},
      {0xD8, &kHeartContainerLayout}, {0xDA, &kGreenRupeeLayout},
      {0xDB, &kBlueRupeeLayout},      {0xDC, &kRedRupeeLayout},
      {0xDE, &kSmallHeartLayout},     {0xDF, &kKeyLayout},
      {0xE1, &kSmallMagicLayout},     {0xE2, &kLargeMagicLayout},
  };
  return layouts;
}
 
}  // namespace
 
const SpriteOamLayout* SpriteOamRegistry::GetLayout(uint8_t sprite_id) {
  const auto& layouts = GetLayoutMap();
  auto it = layouts.find(sprite_id);
  if (it != layouts.end()) {
    return it->second;
  }
  return nullptr;
}
 
const SpriteOamLayout* SpriteOamRegistry::GetPreviewOverride(
    uint8_t sprite_id, std::string_view hack_name) {
  if ((sprite_id != 0xB1 && sprite_id != 0x88) || hack_name.empty()) {
    return nullptr;
  }
  // Match the existing Oracle hack-workflow name fallback. This is per-call,
  // never global state, so switching projects cannot retain an old override.
  std::string normalized(hack_name);
  std::transform(normalized.begin(), normalized.end(), normalized.begin(),
                 [](unsigned char c) { return std::tolower(c); });
  if (normalized.find("oracle") == std::string::npos) {
    return nullptr;
  }
  return sprite_id == 0x88 ? &kOracleManhandlaPreview
                           : &kOraclePuffstoolPreview;
}
 
bool SpritePreviewResourceCache::SetContext(std::string_view project_path,
                                            std::string_view assets_path,
                                            std::string_view hack_name) {
  if (project_path_ == project_path && assets_path_ == assets_path &&
      hack_name_ == hack_name) {
    return false;
  }
  project_path_ = project_path;
  assets_path_ = assets_path;
  hack_name_ = hack_name;
  resource_.clear();
  graphics_.clear();
  return true;
}
 
std::span<const uint8_t> SpritePreviewResourceCache::GetGraphics(
    const SpriteOamLayout* layout) {
  if (layout == nullptr || layout->graphics_resource == nullptr ||
      project_path_.empty() || assets_path_.empty() ||
      SpriteOamRegistry::GetPreviewOverride(layout->sprite_id, hack_name_) ==
          nullptr) {
    return {};
  }
  if (resource_ == layout->graphics_resource) {
    return graphics_;
  }
  resource_ = layout->graphics_resource;
  graphics_.clear();
  // Match ApplyManhandlaGraphics' whole OBJ page transfer, not a partial file.
  // Read at most this small fixed payload; reject truncated or oversized files.
  constexpr size_t kObjPageBytes = 0x2000;
  const auto path = std::filesystem::path(assets_path_) / resource_;
  std::ifstream file(path, std::ios::binary | std::ios::ate);
  if (!file || file.tellg() != static_cast<std::streamoff>(kObjPageBytes)) {
    return {};
  }
  file.seekg(0);
  graphics_.resize(kObjPageBytes);
  if (!file.read(reinterpret_cast<char*>(graphics_.data()), graphics_.size()) ||
      file.peek() != std::char_traits<char>::eof()) {
    graphics_.clear();
  }
  return graphics_;
}
 
std::optional<std::array<uint8_t, 4>> SpriteOamRegistry::GetRequiredSheets(
    uint8_t sprite_id) {
  const auto* layout = GetLayout(sprite_id);
  if (layout) {
    return layout->required_sheets;
  }
  return std::nullopt;
}
 
bool SpriteOamRegistry::HasLayout(uint8_t sprite_id) {
  const auto& layouts = GetLayoutMap();
  return layouts.find(sprite_id) != layouts.end();
}
 
std::vector<const SpriteOamLayout*> SpriteOamRegistry::GetAllLayouts() {
  std::vector<const SpriteOamLayout*> result;
  const auto& layouts = GetLayoutMap();
  result.reserve(layouts.size());
  for (const auto& [id, layout] : layouts) {
    result.push_back(layout);
  }
  return result;
}
 
}  // namespace zelda3
}  // namespace yaze