#include "rom.h" #include // for remove #include // for system_clock #include // for size_t #include // for uint32_t, uint8_t #include // for memcpy #include // for ctime #include // for copy_options, copy_options... #include // for string, fstream, ifstream #include // for stack #include // for hash, operator==, char_traits #include // for unordered_map, operator!= #include // for tuple_element<>::type #include // for vector, vector<>::value_type #include "absl/container/flat_hash_map.h" // for flat_hash_map, BitMask #include "absl/status/status.h" // for OkStatus, InternalError #include "absl/status/statusor.h" // for StatusOr #include "absl/strings/str_cat.h" // for StrCat #include "absl/strings/string_view.h" // for string_view, operator== #include "app/core/constants.h" // for Bytes, ASSIGN_OR_RETURN #include "app/gfx/bitmap.h" // for Bitmap, BitmapTable #include "app/gfx/compression.h" // for DecompressV2 #include "app/gfx/snes_palette.h" // for PaletteGroup, SNESColor #include "app/gfx/snes_tile.h" // for SnesTo8bppSheet namespace yaze { namespace app { namespace { absl::Status LoadOverworldMainPalettes(const Bytes& rom_data, PaletteGroupMap& palette_groups) { auto data = rom_data.data(); for (int i = 0; i < 6; i++) { RETURN_IF_ERROR(palette_groups["ow_main"].AddPalette( gfx::ReadPaletteFromROM(core::overworldPaletteMain + (i * (35 * 2)), /*num_colors*/ 35, data))) } return absl::OkStatus(); } absl::Status LoadOverworldAuxiliaryPalettes(const Bytes& rom_data, PaletteGroupMap& palette_groups) { auto data = rom_data.data(); for (int i = 0; i < 20; i++) { RETURN_IF_ERROR(palette_groups["ow_aux"].AddPalette(gfx::ReadPaletteFromROM( core::overworldPaletteAuxialiary + (i * (21 * 2)), /*num_colors*/ 21, data))) } return absl::OkStatus(); } absl::Status LoadOverworldAnimatedPalettes(const Bytes& rom_data, PaletteGroupMap& palette_groups) { auto data = rom_data.data(); for (int i = 0; i < 14; i++) { RETURN_IF_ERROR( palette_groups["ow_animated"].AddPalette(gfx::ReadPaletteFromROM( core::overworldPaletteAnimated + (i * (7 * 2)), 7, data))) } return absl::OkStatus(); } absl::Status LoadHUDPalettes(const Bytes& rom_data, PaletteGroupMap& palette_groups) { auto data = rom_data.data(); for (int i = 0; i < 2; i++) { RETURN_IF_ERROR(palette_groups["hud"].AddPalette( gfx::ReadPaletteFromROM(core::hudPalettes + (i * 64), 32, data))) } return absl::OkStatus(); } absl::Status LoadGlobalSpritePalettes(const Bytes& rom_data, PaletteGroupMap& palette_groups) { auto data = rom_data.data(); RETURN_IF_ERROR(palette_groups["global_sprites"].AddPalette( gfx::ReadPaletteFromROM(core::globalSpritePalettesLW, 60, data))) RETURN_IF_ERROR(palette_groups["global_sprites"].AddPalette( gfx::ReadPaletteFromROM(core::globalSpritePalettesDW, 60, data))) return absl::OkStatus(); } absl::Status LoadArmorPalettes(const Bytes& rom_data, PaletteGroupMap& palette_groups) { auto data = rom_data.data(); for (int i = 0; i < 5; i++) { RETURN_IF_ERROR(palette_groups["armors"].AddPalette( gfx::ReadPaletteFromROM(core::armorPalettes + (i * 30), 15, data))) } return absl::OkStatus(); } absl::Status LoadSwordPalettes(const Bytes& rom_data, PaletteGroupMap& palette_groups) { auto data = rom_data.data(); for (int i = 0; i < 4; i++) { RETURN_IF_ERROR(palette_groups["swords"].AddPalette( gfx::ReadPaletteFromROM(core::swordPalettes + (i * 6), 3, data))) } return absl::OkStatus(); } absl::Status LoadShieldPalettes(const Bytes& rom_data, PaletteGroupMap& palette_groups) { auto data = rom_data.data(); for (int i = 0; i < 3; i++) { RETURN_IF_ERROR(palette_groups["shields"].AddPalette( gfx::ReadPaletteFromROM(core::shieldPalettes + (i * 8), 4, data))) } return absl::OkStatus(); } absl::Status LoadSpriteAux1Palettes(const Bytes& rom_data, PaletteGroupMap& palette_groups) { auto data = rom_data.data(); for (int i = 0; i < 12; i++) { RETURN_IF_ERROR(palette_groups["sprites_aux1"].AddPalette( gfx::ReadPaletteFromROM(core::spritePalettesAux1 + (i * 14), 7, data))) } return absl::OkStatus(); } absl::Status LoadSpriteAux2Palettes(const Bytes& rom_data, PaletteGroupMap& palette_groups) { auto data = rom_data.data(); for (int i = 0; i < 11; i++) { RETURN_IF_ERROR(palette_groups["sprites_aux2"].AddPalette( gfx::ReadPaletteFromROM(core::spritePalettesAux2 + (i * 14), 7, data))) } return absl::OkStatus(); } absl::Status LoadSpriteAux3Palettes(const Bytes& rom_data, PaletteGroupMap& palette_groups) { auto data = rom_data.data(); for (int i = 0; i < 24; i++) { RETURN_IF_ERROR(palette_groups["sprites_aux3"].AddPalette( gfx::ReadPaletteFromROM(core::spritePalettesAux3 + (i * 14), 7, data))) } return absl::OkStatus(); } absl::Status LoadDungeonMainPalettes(const Bytes& rom_data, PaletteGroupMap& palette_groups) { auto data = rom_data.data(); for (int i = 0; i < 20; i++) { RETURN_IF_ERROR( palette_groups["dungeon_main"].AddPalette(gfx::ReadPaletteFromROM( core::dungeonMainPalettes + (i * 180), 90, data))) } return absl::OkStatus(); } absl::Status LoadGrassColors(const Bytes& rom_data, PaletteGroupMap& palette_groups) { RETURN_IF_ERROR(palette_groups["grass"].AddColor( gfx::ReadColorFromROM(core::hardcodedGrassLW, rom_data.data()))) RETURN_IF_ERROR(palette_groups["grass"].AddColor( gfx::ReadColorFromROM(core::hardcodedGrassDW, rom_data.data()))) RETURN_IF_ERROR(palette_groups["grass"].AddColor( gfx::ReadColorFromROM(core::hardcodedGrassSpecial, rom_data.data()))) return absl::OkStatus(); } absl::Status Load3DObjectPalettes(const Bytes& rom_data, PaletteGroupMap& palette_groups) { auto data = rom_data.data(); RETURN_IF_ERROR(palette_groups["3d_object"].AddPalette( gfx::ReadPaletteFromROM(core::triforcePalette, 8, data))) RETURN_IF_ERROR(palette_groups["3d_object"].AddPalette( gfx::ReadPaletteFromROM(core::crystalPalette, 8, data))) return absl::OkStatus(); } absl::Status LoadOverworldMiniMapPalettes(const Bytes& rom_data, PaletteGroupMap& palette_groups) { auto data = rom_data.data(); for (int i = 0; i < 2; i++) { RETURN_IF_ERROR( palette_groups["ow_mini_map"].AddPalette(gfx::ReadPaletteFromROM( core::overworldMiniMapPalettes + (i * 256), 128, data))) } return absl::OkStatus(); } } // namespace absl::StatusOr ROM::Load2BppGraphics() { Bytes sheet; const uint8_t sheets[] = {113, 114, 218, 219, 220, 221}; for (const auto& sheet_id : sheets) { auto offset = GetGraphicsAddress(data(), sheet_id); ASSIGN_OR_RETURN(auto decomp_sheet, gfx::lc_lz2::DecompressV2(data(), offset)) auto converted_sheet = gfx::SnesTo8bppSheet(decomp_sheet, 2); for (const auto& each_pixel : converted_sheet) { sheet.push_back(each_pixel); } } return sheet; } absl::Status ROM::LoadLinkGraphics() { const auto link_gfx_offset = 0x80000; const auto link_gfx_length = 0x500; // Load Links graphics from the ROM for (int i = 0; i < 14; i++) { ASSIGN_OR_RETURN( auto link_sheet_data, ReadByteVector(/*offset=*/link_gfx_offset + (i * link_gfx_length), /*length=*/link_gfx_length)) auto link_sheet_8bpp = gfx::SnesTo8bppSheet(link_sheet_data, /*bpp=*/4); link_graphics_[i].Create(core::kTilesheetWidth, core::kTilesheetHeight, core::kTilesheetDepth, link_sheet_8bpp); link_graphics_[i].ApplyPalette(link_palette_); RenderBitmap(&link_graphics_[i]); } return absl::OkStatus(); } absl::Status ROM::LoadAllGraphicsData() { Bytes sheet; bool bpp3 = false; for (int i = 0; i < kNumGfxSheets; i++) { if (i >= 115 && i <= 126) { // uncompressed sheets sheet.resize(core::Uncompressed3BPPSize); auto offset = GetGraphicsAddress(data(), i); for (int j = 0; j < core::Uncompressed3BPPSize; j++) { sheet[j] = rom_data_[j + offset]; } bpp3 = true; } else if (i == 113 || i == 114 || i >= 218) { bpp3 = false; } else { auto offset = GetGraphicsAddress(data(), i); ASSIGN_OR_RETURN(sheet, gfx::lc_lz2::DecompressV2(data(), offset)) bpp3 = true; } if (bpp3) { auto converted_sheet = gfx::SnesTo8bppSheet(sheet, 3); if (flags()->kUseBitmapManager) { graphics_manager_.LoadBitmap(i, converted_sheet, core::kTilesheetWidth, core::kTilesheetHeight, core::kTilesheetDepth); graphics_manager_[i]->CreateTexture(renderer_); } graphics_bin_[i] = gfx::Bitmap(core::kTilesheetWidth, core::kTilesheetHeight, core::kTilesheetDepth, converted_sheet); graphics_bin_.at(i).CreateTexture(renderer_); if (flags()->kUseBitmapManager) { for (int j = 0; j < graphics_manager_[i].get()->size(); ++j) { graphics_buffer_.push_back(graphics_manager_[i]->at(j)); } } } else { for (int j = 0; j < graphics_bin_[0].size(); ++j) { graphics_buffer_.push_back(0xFF); } } } return absl::OkStatus(); } absl::Status ROM::LoadAllPalettes() { RETURN_IF_ERROR(LoadOverworldMainPalettes(rom_data_, palette_groups_)) RETURN_IF_ERROR(LoadOverworldAuxiliaryPalettes(rom_data_, palette_groups_)) RETURN_IF_ERROR(LoadOverworldAnimatedPalettes(rom_data_, palette_groups_)) RETURN_IF_ERROR(LoadHUDPalettes(rom_data_, palette_groups_)) RETURN_IF_ERROR(LoadGlobalSpritePalettes(rom_data_, palette_groups_)) RETURN_IF_ERROR(LoadArmorPalettes(rom_data_, palette_groups_)) RETURN_IF_ERROR(LoadSwordPalettes(rom_data_, palette_groups_)) RETURN_IF_ERROR(LoadShieldPalettes(rom_data_, palette_groups_)) RETURN_IF_ERROR(LoadSpriteAux1Palettes(rom_data_, palette_groups_)) RETURN_IF_ERROR(LoadSpriteAux2Palettes(rom_data_, palette_groups_)) RETURN_IF_ERROR(LoadSpriteAux3Palettes(rom_data_, palette_groups_)) RETURN_IF_ERROR(LoadDungeonMainPalettes(rom_data_, palette_groups_)) RETURN_IF_ERROR(LoadGrassColors(rom_data_, palette_groups_)) RETURN_IF_ERROR(Load3DObjectPalettes(rom_data_, palette_groups_)) RETURN_IF_ERROR(LoadOverworldMiniMapPalettes(rom_data_, palette_groups_)) return absl::OkStatus(); } absl::Status ROM::LoadFromFile(const absl::string_view& filename, bool z3_load) { // Set filename filename_ = filename; // Open file std::ifstream file(filename.data(), std::ios::binary); if (!file.is_open()) { return absl::InternalError( absl::StrCat("Could not open ROM file: ", filename)); } // Get file size and resize rom_data_ size_ = std::filesystem::file_size(filename); rom_data_.resize(size_); // Read file into rom_data_ file.read(reinterpret_cast(rom_data_.data()), size_); // Check if the sROM has a header constexpr size_t baseROMSize = 1048576; // 1MB constexpr size_t headerSize = 0x200; // 512 bytes if (size_ % baseROMSize == headerSize) { has_header_ = true; } // Remove header if present if (has_header_) { auto header = std::vector(rom_data_.begin(), rom_data_.begin() + 0x200); rom_data_.erase(rom_data_.begin(), rom_data_.begin() + 0x200); size_ -= 0x200; } // Close file file.close(); // Load Zelda 3 specific data if requested if (z3_load) { // Copy ROM title memcpy(title_, rom_data_.data() + kTitleStringOffset, kTitleStringLength); if (rom_data_[kTitleStringOffset + 0x19] == 0) { version_ = Z3_Version::JP; } else { version_ = Z3_Version::US; } RETURN_IF_ERROR(LoadAllPalettes()) LoadGfxGroups(); } // Set is_loaded_ flag and return success is_loaded_ = true; return absl::OkStatus(); } absl::Status ROM::LoadFromPointer(uchar* data, size_t length) { if (!data) return absl::InvalidArgumentError( "Could not load ROM: parameter `data` is empty."); for (int i = 0; i < length; ++i) rom_data_.push_back(data[i]); return absl::OkStatus(); } absl::Status ROM::LoadFromBytes(const Bytes& data) { if (data.empty()) { return absl::InvalidArgumentError( "Could not load ROM: parameter `data` is empty."); } rom_data_ = data; size_ = data.size(); is_loaded_ = true; return absl::OkStatus(); } absl::Status ROM::SaveToFile(bool backup, absl::string_view filename) { if (rom_data_.empty()) { return absl::InternalError("ROM data is empty."); } // Check if filename is empty if (filename == "") { filename = filename_; } // Check if backup is enabled if (backup) { // Create a backup file with timestamp in its name auto now = std::chrono::system_clock::now(); auto now_c = std::chrono::system_clock::to_time_t(now); std::string backup_filename = absl::StrCat(filename, "_backup_", std::ctime(&now_c)); // Remove newline character from ctime() backup_filename.erase( std::remove(backup_filename.begin(), backup_filename.end(), '\n'), backup_filename.end()); // Replace spaces with underscores std::replace(backup_filename.begin(), backup_filename.end(), ' ', '_'); // Now, copy the original file to the backup file std::filesystem::copy(filename, backup_filename, std::filesystem::copy_options::overwrite_existing); } // Run the other save functions if (flags()->kSaveAllPalettes) { SaveAllPalettes(); } if (flags()->kSaveWithChangeQueue) { while (!changes_.empty()) { auto change = changes_.top(); change(); changes_.pop(); } } // Open the file that we know exists for writing std::ofstream file(filename.data(), std::ios::binary); if (!file) { return absl::InternalError( absl::StrCat("Could not open ROM file: ", filename)); } // Save the data to the file try { file.write( static_cast(static_cast(rom_data_.data())), rom_data_.size()); } catch (const std::ofstream::failure& e) { return absl::InternalError(absl::StrCat( "Error while writing to ROM file: ", filename, " - ", e.what())); } // Check for write errors if (!file) { return absl::InternalError( absl::StrCat("Error while writing to ROM file: ", filename)); } return absl::OkStatus(); } void ROM::SavePalette(int index, const std::string& group_name, gfx::SNESPalette& palette) { // Iterate through all colors in the palette for (size_t j = 0; j < palette.size(); ++j) { gfx::SNESColor color = palette[j]; // If the color is modified, save the color to the ROM if (color.IsModified()) { WriteColor(gfx::GetPaletteAddress(group_name, index, j), color); color.SetModified(false); // Reset the modified flag after saving } } } void ROM::SaveAllPalettes() { // Iterate through all palette_groups_ for (auto& [group_name, palettes] : palette_groups_) { // Iterate through all palettes in the group for (size_t i = 0; i < palettes.size(); ++i) { auto palette = palettes[i]; SavePalette(i, group_name, palette); } } } absl::Status ROM::UpdatePaletteColor(const std::string& groupName, size_t paletteIndex, size_t colorIndex, const gfx::SNESColor& newColor) { // Check if the groupName exists in the palette_groups_ map if (palette_groups_.find(groupName) != palette_groups_.end()) { // Check if the paletteIndex is within the range of available palettes in // the group if (paletteIndex < palette_groups_[groupName].size()) { // Check if the colorIndex is within the range of available colors in the // palette if (colorIndex < palette_groups_[groupName][paletteIndex].size()) { // Update the color value in the palette palette_groups_[groupName][paletteIndex][colorIndex] = newColor; palette_groups_[groupName][paletteIndex][colorIndex].SetModified(true); } else { return absl::AbortedError( "Error: Invalid color index in UpdatePaletteColor."); } } else { return absl::AbortedError( "Error: Invalid palette index in UpdatePaletteColor."); } } else { return absl::AbortedError( "Error: Invalid group name in UpdatePaletteColor"); } return absl::OkStatus(); } std::shared_ptr SharedROM::shared_rom_ = nullptr; } // namespace app } // namespace yaze