game_data.h

Go to the documentation of this file.

#ifndef YAZE_ZELDA3_GAME_DATA_H
#define YAZE_ZELDA3_GAME_DATA_H
 
#include <array>
#include <cstdint>
#include <map>
#include <vector>
 
#include "absl/status/status.h"
#include "absl/status/statusor.h"
#include "app/gfx/core/bitmap.h"
#include "app/gfx/types/snes_palette.h"
#include "rom/rom.h"
#include "rom/rom_diagnostics.h"
#include "zelda.h"
#include "zelda3/dungeon/pit_damage_table.h"
#include "zelda3/dungeon/room_default_entrance.h"
#include "zelda3/graphics_sheet_store.h"
 
namespace yaze {
namespace zelda3 {
 
// ============================================================================
// Graphics Constants
// ============================================================================
 
// Sheet counts
constexpr uint32_t kNumGfxSheets = 223;
constexpr uint32_t kNumLinkSheets = 14;
 
// Blockset/Group counts
constexpr uint32_t kNumMainBlocksets = 37;
constexpr uint32_t kNumRoomBlocksets = 82;
constexpr uint32_t kNumSpritesets = 144;
constexpr uint32_t kNumPalettesets = 72;
 
// ROM pointer locations
constexpr uint32_t kEntranceGfxGroup = 0x5D97;
// Note: kGfxGroupsPointer defined in zelda3/dungeon/dungeon_rom_addresses.h
constexpr uint32_t kMaxGraphics = 0x0C3FFF;
 
// Dungeon palette lookup tables
// Room headers store a "palette set ID" (0-71), NOT a direct palette index!
// Two-level lookup: paletteset_ids[room.palette][0] gives a byte offset into
// kDungeonPalettePointerTable. The word there, divided by 180, is the palette.
constexpr uint32_t kPalettesetIdsAddress = 0x75460;
constexpr uint32_t kDungeonPalettePointerTable = 0xDEC4B;
constexpr int kDungeonPaletteBytes = 180;
 
// Link graphics location ($10:8000)
constexpr uint32_t kLinkGfxOffset = 0x80000;
constexpr uint16_t kLinkGfxLength = 0x800;
 
// Font graphics location
constexpr uint32_t kFontSpriteLocation = 0x70000;
 
// Sheet sizes
constexpr uint32_t kUncompressedSheetSize = 0x0800;  // 2048 bytes
 
// Tile16 pointer location
constexpr uint32_t kTile16Ptr = 0x78000;
 
// Version constants map
static const std::map<zelda3_version, zelda3_version_pointers>
    kVersionConstantsMap = {
        {zelda3_version::US, zelda3_us_pointers},
        {zelda3_version::JP, zelda3_jp_pointers},
        {zelda3_version::SD, {}},
        {zelda3_version::RANDO, {}},
};
 
// Sheet pixels live in `sheet_store` (inherited, with the legacy
// `graphics_buffer` alias); see graphics_sheet_store.h.
struct GameData : GraphicsSheetStoreHolder {
  // Constructors
  GameData() = default;
  explicit GameData(Rom* rom) : rom_(rom) {}
 
  // ROM reference (non-owning)
  Rom* rom() const { return rom_; }
  void set_rom(Rom* rom) { rom_ = rom; }
 
  // Version info
  zelda3_version version = zelda3_version::US;
  std::string title;
 
  // Graphics Resources (`graphics_buffer` and `sheet_store` are inherited)
  std::array<std::vector<uint8_t>, kNumGfxSheets>
      raw_gfx_sheets;                                  // 8BPP indexed
  std::array<gfx::Bitmap, kNumGfxSheets> gfx_bitmaps;  // Renderable bitmaps
  std::array<gfx::Bitmap, kNumLinkSheets> link_graphics;
  gfx::Bitmap font_graphics;
 
  // Game Data Structures
  gfx::PaletteGroupMap palette_groups;
 
  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{};
  // Zero is a valid assignment. Do not infer readiness from table contents.
  bool gfx_groups_loaded = false;
  uint32_t gfx_main_group_address = 0;
 
  // Palette set lookup table (72 entries × 4 bytes each)
  // Entry format: [bg_palette_offset, aux1, aux2, aux3]
  // NOTE: paletteset_ids[n][0] is a BYTE OFFSET into kDungeonPalettePointerTable,
  // NOT a direct palette index! See room.cc for correct lookup algorithm.
  std::array<std::array<uint8_t, 4>, kNumPalettesets> paletteset_ids{};
 
  // Diagnostics
  GraphicsLoadDiagnostics diagnostics;
 
  // Global RoomsWithPitDamage membership table (bank $07).
  PitDamageTable pit_damage_table;
 
  // Per-room default entrance and the main graphics set it selects; see
  // room_default_entrance.h. Empty until LoadGameData runs.
  std::vector<RoomDefaultEntrance> room_default_entrances;
 
  void Clear() {
    gfx_groups_loaded = false;
    gfx_main_group_address = 0;
    room_default_entrances.clear();
    sheet_store.Clear();
    for (auto& sheet : raw_gfx_sheets)
      sheet.clear();
    // gfx_bitmaps don't need explicit clearing if reloaded
    palette_groups.clear();
    pit_damage_table = PitDamageTable();
  }
 
 private:
  Rom* rom_ = nullptr;
};
 
struct LoadOptions {
  bool load_graphics = true;
  bool load_palettes = true;
  bool load_gfx_groups = true;
  bool expand_rom = true;
  bool populate_metadata = true;
};
 
absl::Status LoadGameData(Rom& rom, GameData& data,
                          const LoadOptions& options = {});
 
absl::Status SaveGameData(Rom& rom, GameData& data);
 
// Individual loaders (internal use or fine-grained control)
absl::Status LoadMetadata(const Rom& rom, GameData& data);
absl::Status LoadPalettes(const Rom& rom, GameData& data);
absl::Status LoadGfxGroups(Rom& rom, GameData& data);
absl::Status LoadGraphics(Rom& rom, GameData& data);
struct GfxGroupDiff {
  bool main_blocksets = false;
  bool room_blocksets = false;
  bool spritesets = false;
  bool palettesets = false;
  int changed_bytes = 0;
 
  bool any() const { return changed_bytes > 0; }
};
 
absl::StatusOr<GfxGroupDiff> DiffGfxGroups(const Rom& rom,
                                           const GameData& data);
 
absl::Status SaveGfxGroups(Rom& rom, const GameData& data);
 
absl::StatusOr<std::array<gfx::Bitmap, kNumLinkSheets>> LoadLinkGraphics(
    const Rom& rom);
 
absl::StatusOr<std::vector<uint8_t>> Load2BppGraphics(const Rom& rom);
 
absl::StatusOr<gfx::Bitmap> LoadFontGraphics(const Rom& rom);
 
absl::Status SaveAllGraphicsData(
    Rom& rom, const std::array<gfx::Bitmap, kNumGfxSheets>& sheets);
 
uint32_t GetGraphicsAddress(const uint8_t* data, uint8_t addr, uint32_t ptr1,
                            uint32_t ptr2, uint32_t ptr3, size_t rom_size);
 
}  // namespace zelda3
}  // namespace yaze
 
#endif  // YAZE_ZELDA3_GAME_DATA_H