snes_palette.cc

Go to the documentation of this file.

#include "app/gfx/types/snes_palette.h"
 
#include "app/platform/sdl_compat.h"
 
#include <array>
#include <cstdint>
#include <cstdlib>
#include <cstring>
#include <stdexcept>
#include <string_view>
#include <utility>
#include <vector>
 
#include "absl/status/status.h"
#include "absl/status/statusor.h"
#include "absl/strings/str_format.h"
#include "app/gfx/types/snes_color.h"
#include "imgui/imgui.h"
#include "util/macro.h"
 
namespace yaze::gfx {
 
SnesPalette::SnesPalette(char* data) {
  assert((sizeof(data) % 4 == 0) && (sizeof(data) <= 32));
  for (unsigned i = 0; i < sizeof(data); i += 2) {
    SnesColor col;
    col.set_snes(static_cast<uint8_t>(data[i + 1]) << 8);
    col.set_snes(col.snes() | static_cast<uint8_t>(data[i]));
    colors_[size_++] = col;
  }
}
 
SnesPalette::SnesPalette(const unsigned char* snes_pal) {
  assert((sizeof(snes_pal) % 4 == 0) && (sizeof(snes_pal) <= 32));
  for (unsigned i = 0; i < sizeof(snes_pal); i += 2) {
    SnesColor col;
    col.set_snes(snes_pal[i + 1] << (uint16_t)8);
    col.set_snes(col.snes() | snes_pal[i]);
    colors_[size_++] = col;
  }
}
 
SnesPalette::SnesPalette(const char* data, size_t length) : size_(0) {
  for (size_t i = 0; i < length && size_ < kMaxColors; i += 2) {
    uint16_t color = (static_cast<uint8_t>(data[i + 1]) << 8) |
                     static_cast<uint8_t>(data[i]);
    colors_[size_++] = SnesColor(color);
  }
}
 
SnesPalette::SnesPalette(const std::vector<uint16_t>& colors) : size_(0) {
  for (const auto& color : colors) {
    if (size_ < kMaxColors) {
      colors_[size_++] = SnesColor(color);
    }
  }
}
 
SnesPalette::SnesPalette(const std::vector<SnesColor>& colors) : size_(0) {
  for (const auto& color : colors) {
    if (size_ < kMaxColors) {
      colors_[size_++] = color;
    }
  }
}
 
SnesPalette::SnesPalette(const std::vector<ImVec4>& colors) : size_(0) {
  for (const auto& color : colors) {
    if (size_ < kMaxColors) {
      colors_[size_++] = SnesColor(color);
    }
  }
}
 
namespace palette_group_internal {
absl::Status LoadOverworldMainPalettes(const std::vector<uint8_t>& rom_data,
                                       gfx::PaletteGroupMap& palette_groups) {
  auto data = rom_data.data();
  size_t rom_size = rom_data.size();
  for (int i = 0; i < 6; i++) {
    int offset = kOverworldPaletteMain + (i * (35 * 2));
    int num_colors = 35;
    // Bounds check: each color is 2 bytes, so we need offset + (num_colors * 2) bytes
    if (offset < 0 || offset + (num_colors * 2) > static_cast<int>(rom_size)) {
      return absl::OutOfRangeError(absl::StrFormat(
          "Overworld main palette %d out of bounds: offset %d, size %zu", i,
          offset, rom_size));
    }
    palette_groups.overworld_main.AddPalette(
        gfx::ReadPaletteFromRom(offset, num_colors, data));
  }
  return absl::OkStatus();
}
 
absl::Status LoadOverworldAuxiliaryPalettes(
    const std::vector<uint8_t>& rom_data,
    gfx::PaletteGroupMap& palette_groups) {
  auto data = rom_data.data();
  size_t rom_size = rom_data.size();
  for (int i = 0; i < 20; i++) {
    int offset = kOverworldPaletteAux + (i * (21 * 2));
    int num_colors = 21;
    if (offset < 0 || offset + (num_colors * 2) > static_cast<int>(rom_size)) {
      return absl::OutOfRangeError(absl::StrFormat(
          "Overworld aux palette %d out of bounds: offset %d, size %zu", i,
          offset, rom_size));
    }
    palette_groups.overworld_aux.AddPalette(
        gfx::ReadPaletteFromRom(offset, num_colors, data));
  }
  return absl::OkStatus();
}
 
absl::Status LoadOverworldAnimatedPalettes(
    const std::vector<uint8_t>& rom_data,
    gfx::PaletteGroupMap& palette_groups) {
  auto data = rom_data.data();
  size_t rom_size = rom_data.size();
  for (int i = 0; i < 14; i++) {
    int offset = kOverworldPaletteAnimated + (i * (7 * 2));
    int num_colors = 7;
    if (offset < 0 || offset + (num_colors * 2) > static_cast<int>(rom_size)) {
      return absl::OutOfRangeError(absl::StrFormat(
          "Overworld animated palette %d out of bounds: offset %d, size %zu", i,
          offset, rom_size));
    }
    palette_groups.overworld_animated.AddPalette(
        gfx::ReadPaletteFromRom(offset, num_colors, data));
  }
  return absl::OkStatus();
}
 
absl::Status LoadHUDPalettes(const std::vector<uint8_t>& rom_data,
                             gfx::PaletteGroupMap& palette_groups) {
  auto data = rom_data.data();
  size_t rom_size = rom_data.size();
  for (int i = 0; i < 2; i++) {
    int offset = kHudPalettes + (i * 64);
    int num_colors = 32;
    if (offset < 0 || offset + (num_colors * 2) > static_cast<int>(rom_size)) {
      return absl::OutOfRangeError(
          absl::StrFormat("HUD palette %d out of bounds: offset %d, size %zu",
                          i, offset, rom_size));
    }
    palette_groups.hud.AddPalette(
        gfx::ReadPaletteFromRom(offset, num_colors, data));
  }
  return absl::OkStatus();
}
 
absl::Status LoadGlobalSpritePalettes(const std::vector<uint8_t>& rom_data,
                                      gfx::PaletteGroupMap& palette_groups) {
  auto data = rom_data.data();
  size_t rom_size = rom_data.size();
 
  // Check first palette
  int offset1 = kGlobalSpritesLW;
  int num_colors1 = 60;
  if (offset1 < 0 || offset1 + (num_colors1 * 2) > static_cast<int>(rom_size)) {
    return absl::OutOfRangeError(absl::StrFormat(
        "Global sprite LW palette out of bounds: offset %d, size %zu", offset1,
        rom_size));
  }
  palette_groups.global_sprites.AddPalette(
      gfx::ReadPaletteFromRom(offset1, num_colors1, data));
 
  // Check second palette
  int offset2 = kGlobalSpritePalettesDW;
  int num_colors2 = 60;
  if (offset2 < 0 || offset2 + (num_colors2 * 2) > static_cast<int>(rom_size)) {
    return absl::OutOfRangeError(absl::StrFormat(
        "Global sprite DW palette out of bounds: offset %d, size %zu", offset2,
        rom_size));
  }
  palette_groups.global_sprites.AddPalette(
      gfx::ReadPaletteFromRom(offset2, num_colors2, data));
  return absl::OkStatus();
}
 
absl::Status LoadArmorPalettes(const std::vector<uint8_t>& rom_data,
                               gfx::PaletteGroupMap& palette_groups) {
  auto data = rom_data.data();
  size_t rom_size = rom_data.size();
  for (int i = 0; i < 5; i++) {
    int offset = kArmorPalettes + (i * 30);
    int num_colors = 15;
    if (offset < 0 || offset + (num_colors * 2) > static_cast<int>(rom_size)) {
      return absl::OutOfRangeError(
          absl::StrFormat("Armor palette %d out of bounds: offset %d, size %zu",
                          i, offset, rom_size));
    }
    palette_groups.armors.AddPalette(
        gfx::ReadPaletteFromRom(offset, num_colors, data));
  }
  return absl::OkStatus();
}
 
absl::Status LoadSwordPalettes(const std::vector<uint8_t>& rom_data,
                               gfx::PaletteGroupMap& palette_groups) {
  auto data = rom_data.data();
  size_t rom_size = rom_data.size();
  for (int i = 0; i < 4; i++) {
    int offset = kSwordPalettes + (i * 6);
    int num_colors = 3;
    if (offset < 0 || offset + (num_colors * 2) > static_cast<int>(rom_size)) {
      return absl::OutOfRangeError(
          absl::StrFormat("Sword palette %d out of bounds: offset %d, size %zu",
                          i, offset, rom_size));
    }
    palette_groups.swords.AddPalette(
        gfx::ReadPaletteFromRom(offset, num_colors, data));
  }
  return absl::OkStatus();
}
 
absl::Status LoadShieldPalettes(const std::vector<uint8_t>& rom_data,
                                gfx::PaletteGroupMap& palette_groups) {
  auto data = rom_data.data();
  size_t rom_size = rom_data.size();
  for (int i = 0; i < 3; i++) {
    int offset = kShieldPalettes + (i * 8);
    int num_colors = 4;
    if (offset < 0 || offset + (num_colors * 2) > static_cast<int>(rom_size)) {
      return absl::OutOfRangeError(absl::StrFormat(
          "Shield palette %d out of bounds: offset %d, size %zu", i, offset,
          rom_size));
    }
    palette_groups.shields.AddPalette(
        gfx::ReadPaletteFromRom(offset, num_colors, data));
  }
  return absl::OkStatus();
}
 
absl::Status LoadSpriteAux1Palettes(const std::vector<uint8_t>& rom_data,
                                    gfx::PaletteGroupMap& palette_groups) {
  auto data = rom_data.data();
  size_t rom_size = rom_data.size();
  for (int i = 0; i < 12; i++) {
    int offset = kSpritesPalettesAux1 + (i * 14);
    int num_colors = 7;
    if (offset < 0 || offset + (num_colors * 2) > static_cast<int>(rom_size)) {
      return absl::OutOfRangeError(absl::StrFormat(
          "Sprite aux1 palette %d out of bounds: offset %d, size %zu", i,
          offset, rom_size));
    }
    palette_groups.sprites_aux1.AddPalette(
        gfx::ReadPaletteFromRom(offset, num_colors, data));
  }
  return absl::OkStatus();
}
 
absl::Status LoadSpriteAux2Palettes(const std::vector<uint8_t>& rom_data,
                                    gfx::PaletteGroupMap& palette_groups) {
  auto data = rom_data.data();
  size_t rom_size = rom_data.size();
  for (int i = 0; i < 11; i++) {
    int offset = kSpritesPalettesAux2 + (i * 14);
    int num_colors = 7;
    if (offset < 0 || offset + (num_colors * 2) > static_cast<int>(rom_size)) {
      return absl::OutOfRangeError(absl::StrFormat(
          "Sprite aux2 palette %d out of bounds: offset %d, size %zu", i,
          offset, rom_size));
    }
    palette_groups.sprites_aux2.AddPalette(
        gfx::ReadPaletteFromRom(offset, num_colors, data));
  }
  return absl::OkStatus();
}
 
absl::Status LoadSpriteAux3Palettes(const std::vector<uint8_t>& rom_data,
                                    gfx::PaletteGroupMap& palette_groups) {
  auto data = rom_data.data();
  size_t rom_size = rom_data.size();
  for (int i = 0; i < 24; i++) {
    int offset = kSpritesPalettesAux3 + (i * 14);
    int num_colors = 7;
    if (offset < 0 || offset + (num_colors * 2) > static_cast<int>(rom_size)) {
      return absl::OutOfRangeError(absl::StrFormat(
          "Sprite aux3 palette %d out of bounds: offset %d, size %zu", i,
          offset, rom_size));
    }
    palette_groups.sprites_aux3.AddPalette(
        gfx::ReadPaletteFromRom(offset, num_colors, data));
  }
  return absl::OkStatus();
}
 
absl::Status LoadDungeonMainPalettes(const std::vector<uint8_t>& rom_data,
                                     gfx::PaletteGroupMap& palette_groups) {
  auto data = rom_data.data();
  size_t rom_size = rom_data.size();
  for (int i = 0; i < 20; i++) {
    int offset = kDungeonMainPalettes + (i * 180);
    int num_colors = 90;
    if (offset < 0 || offset + (num_colors * 2) > static_cast<int>(rom_size)) {
      return absl::OutOfRangeError(absl::StrFormat(
          "Dungeon main palette %d out of bounds: offset %d, size %zu", i,
          offset, rom_size));
    }
    palette_groups.dungeon_main.AddPalette(
        gfx::ReadPaletteFromRom(offset, num_colors, data));
  }
  return absl::OkStatus();
}
 
absl::Status LoadGrassColors(const std::vector<uint8_t>& rom_data,
                             gfx::PaletteGroupMap& palette_groups) {
  size_t rom_size = rom_data.size();
 
  // Each color is 2 bytes
  if (kHardcodedGrassLW < 0 ||
      kHardcodedGrassLW + 2 > static_cast<int>(rom_size)) {
    return absl::OutOfRangeError(
        absl::StrFormat("Grass LW color out of bounds: offset %d, size %zu",
                        kHardcodedGrassLW, rom_size));
  }
  palette_groups.grass.AddColor(
      gfx::ReadColorFromRom(kHardcodedGrassLW, rom_data.data()));
 
  if (kHardcodedGrassDW < 0 ||
      kHardcodedGrassDW + 2 > static_cast<int>(rom_size)) {
    return absl::OutOfRangeError(
        absl::StrFormat("Grass DW color out of bounds: offset %d, size %zu",
                        kHardcodedGrassDW, rom_size));
  }
  palette_groups.grass.AddColor(
      gfx::ReadColorFromRom(kHardcodedGrassDW, rom_data.data()));
 
  if (kHardcodedGrassSpecial < 0 ||
      kHardcodedGrassSpecial + 2 > static_cast<int>(rom_size)) {
    return absl::OutOfRangeError(absl::StrFormat(
        "Grass special color out of bounds: offset %d, size %zu",
        kHardcodedGrassSpecial, rom_size));
  }
  palette_groups.grass.AddColor(
      gfx::ReadColorFromRom(kHardcodedGrassSpecial, rom_data.data()));
  return absl::OkStatus();
}
 
absl::Status Load3DObjectPalettes(const std::vector<uint8_t>& rom_data,
                                  gfx::PaletteGroupMap& palette_groups) {
  auto data = rom_data.data();
  size_t rom_size = rom_data.size();
 
  int offset1 = kTriforcePalette;
  int num_colors1 = 8;
  if (offset1 < 0 || offset1 + (num_colors1 * 2) > static_cast<int>(rom_size)) {
    return absl::OutOfRangeError(
        absl::StrFormat("Triforce palette out of bounds: offset %d, size %zu",
                        offset1, rom_size));
  }
  palette_groups.object_3d.AddPalette(
      gfx::ReadPaletteFromRom(offset1, num_colors1, data));
 
  int offset2 = kCrystalPalette;
  int num_colors2 = 8;
  if (offset2 < 0 || offset2 + (num_colors2 * 2) > static_cast<int>(rom_size)) {
    return absl::OutOfRangeError(
        absl::StrFormat("Crystal palette out of bounds: offset %d, size %zu",
                        offset2, rom_size));
  }
  palette_groups.object_3d.AddPalette(
      gfx::ReadPaletteFromRom(offset2, num_colors2, data));
  return absl::OkStatus();
}
 
absl::Status LoadOverworldMiniMapPalettes(
    const std::vector<uint8_t>& rom_data,
    gfx::PaletteGroupMap& palette_groups) {
  auto data = rom_data.data();
  size_t rom_size = rom_data.size();
  for (int i = 0; i < 2; i++) {
    int offset = kOverworldMiniMapPalettes + (i * 256);
    int num_colors = 128;
    if (offset < 0 || offset + (num_colors * 2) > static_cast<int>(rom_size)) {
      return absl::OutOfRangeError(absl::StrFormat(
          "Overworld minimap palette %d out of bounds: offset %d, size %zu", i,
          offset, rom_size));
    }
    palette_groups.overworld_mini_map.AddPalette(
        gfx::ReadPaletteFromRom(offset, num_colors, data));
  }
  return absl::OkStatus();
}
}  // namespace palette_group_internal
 
constexpr std::array<std::pair<absl::string_view, uint32_t>, 15>
    kPaletteGroupAddressMap = {{
        {"ow_main", kOverworldPaletteMain},
        {"ow_aux", kOverworldPaletteAux},
        {"ow_animated", kOverworldPaletteAnimated},
        {"hud", kHudPalettes},
        {"global_sprites", kGlobalSpritesLW},
        {"armors", kArmorPalettes},
        {"swords", kSwordPalettes},
        {"shields", kShieldPalettes},
        {"sprites_aux1", kSpritesPalettesAux1},
        {"sprites_aux2", kSpritesPalettesAux2},
        {"sprites_aux3", kSpritesPalettesAux3},
        {"dungeon_main", kDungeonMainPalettes},
        {"grass", kHardcodedGrassLW},
        {"3d_object", kTriforcePalette},
        {"ow_mini_map", kOverworldMiniMapPalettes},
    }};
 
constexpr std::array<std::pair<absl::string_view, uint32_t>, 15>
    kPaletteGroupColorCounts = {{
        {"ow_main", 35},
        {"ow_aux", 21},
        {"ow_animated", 7},
        {"hud", 32},
        {"global_sprites", 60},
        {"armors", 15},
        {"swords", 3},
        {"shields", 4},
        {"sprites_aux1", 7},
        {"sprites_aux2", 7},
        {"sprites_aux3", 7},
        {"dungeon_main", 90},
        {"grass", 1},
        {"3d_object", 8},
        {"ow_mini_map", 128},
    }};
 
template <size_t N>
uint32_t LookupPaletteGroupValue(
    absl::string_view group_name,
    const std::array<std::pair<absl::string_view, uint32_t>, N>& table) {
  for (const auto& [name, value] : table) {
    if (name == group_name) {
      return value;
    }
  }
  throw std::out_of_range(
      absl::StrFormat("Unknown palette group: %s", group_name));
}
 
uint32_t GetPaletteAddress(const std::string& group_name, size_t palette_index,
                           size_t color_index) {
  // Retrieve the base address and palette width for the palette group.
  const uint32_t base_address =
      LookupPaletteGroupValue(group_name, kPaletteGroupAddressMap);
  const uint32_t colors_per_palette =
      LookupPaletteGroupValue(group_name, kPaletteGroupColorCounts);
 
  // Calculate the address for thes specified color in the ROM
  uint32_t address = base_address + (palette_index * colors_per_palette * 2) +
                     (color_index * 2);
 
  return address;
}
 
SnesPalette ReadPaletteFromRom(int offset, int num_colors, const uint8_t* rom) {
  int color_offset = 0;
  std::vector<gfx::SnesColor> colors(num_colors);
 
  while (color_offset < num_colors) {
    // Bounds check before accessing ROM data
    // Each color is 2 bytes, so we need at least offset + 1 bytes available
    // Note: We can't check full bounds here without ROM size, but we can at least
    // validate the immediate access. Full bounds should be checked by caller.
 
    // Read SNES 15-bit color (little endian)
    uint16_t snes_color_word = (uint16_t)((rom[offset + 1]) << 8) | rom[offset];
 
    // Extract RGB components (5-bit each) and expand to 8-bit (0-255)
    snes_color new_color;
    new_color.red = (snes_color_word & 0x1F) * 8;           // Bits 0-4
    new_color.green = ((snes_color_word >> 5) & 0x1F) * 8;  // Bits 5-9
    new_color.blue = ((snes_color_word >> 10) & 0x1F) * 8;  // Bits 10-14
 
    // Create SnesColor by converting RGB back to SNES format
    // (This ensures all internal representations are consistent)
    colors[color_offset].set_snes(ConvertRgbToSnes(new_color));
 
    // DO NOT mark as transparent - preserve actual ROM color data!
    // Transparency is handled at render time, not in the data
 
    color_offset++;
    offset += 2;  // SNES colors are 2 bytes each
  }
 
  return gfx::SnesPalette(colors);
}
 
std::array<float, 4> ToFloatArray(const SnesColor& color) {
  std::array<float, 4> colorArray;
  colorArray[0] = color.rgb().x / 255.0f;
  colorArray[1] = color.rgb().y / 255.0f;
  colorArray[2] = color.rgb().z / 255.0f;
  colorArray[3] = color.rgb().w;
  return colorArray;
}
 
absl::StatusOr<PaletteGroup> CreatePaletteGroupFromColFile(
    std::vector<SnesColor>& palette_rows) {
  PaletteGroup palette_group;
  for (int i = 0; i < palette_rows.size(); i += 8) {
    SnesPalette palette;
    for (int j = 0; j < 8; j++) {
      palette.AddColor(palette_rows[i + j]);
    }
    palette_group.AddPalette(palette);
  }
  return palette_group;
}
 
absl::StatusOr<PaletteGroup> CreatePaletteGroupFromLargePalette(
    SnesPalette& palette, int num_colors) {
  PaletteGroup palette_group;
  for (int i = 0; i < palette.size(); i += num_colors) {
    SnesPalette new_palette;
    if (i + num_colors <= palette.size()) {
      for (int j = 0; j < num_colors; j++) {
        auto color = palette[i + j];
        // DO NOT mark as transparent - preserve actual color data!
        // Transparency is handled at render time, not in the data
        new_palette.AddColor(color);
      }
    }
    palette_group.AddPalette(new_palette);
  }
  return palette_group;
}
 
using namespace palette_group_internal;
 
// TODO: Refactor LoadAllPalettes to use group names, move to zelda3 namespace
absl::Status LoadAllPalettes(const std::vector<uint8_t>& rom_data,
                             PaletteGroupMap& groups) {
  RETURN_IF_ERROR(LoadOverworldMainPalettes(rom_data, groups))
  RETURN_IF_ERROR(LoadOverworldAuxiliaryPalettes(rom_data, groups))
  RETURN_IF_ERROR(LoadOverworldAnimatedPalettes(rom_data, groups))
  RETURN_IF_ERROR(LoadHUDPalettes(rom_data, groups))
  RETURN_IF_ERROR(LoadGlobalSpritePalettes(rom_data, groups))
  RETURN_IF_ERROR(LoadArmorPalettes(rom_data, groups))
  RETURN_IF_ERROR(LoadSwordPalettes(rom_data, groups))
  RETURN_IF_ERROR(LoadShieldPalettes(rom_data, groups))
  RETURN_IF_ERROR(LoadSpriteAux1Palettes(rom_data, groups))
  RETURN_IF_ERROR(LoadSpriteAux2Palettes(rom_data, groups))
  RETURN_IF_ERROR(LoadSpriteAux3Palettes(rom_data, groups))
  RETURN_IF_ERROR(LoadDungeonMainPalettes(rom_data, groups))
  RETURN_IF_ERROR(LoadGrassColors(rom_data, groups))
  RETURN_IF_ERROR(Load3DObjectPalettes(rom_data, groups))
  RETURN_IF_ERROR(LoadOverworldMiniMapPalettes(rom_data, groups))
  return absl::OkStatus();
}
 
std::unordered_map<uint8_t, gfx::Paletteset> GfxContext::palettesets_;
 
}  // namespace yaze::gfx