#include "rom.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include "absl/container/flat_hash_map.h" #include "absl/status/status.h" #include "absl/status/statusor.h" #include "absl/strings/str_cat.h" #include "absl/strings/string_view.h" #include "app/core/constants.h" #include "app/core/platform/renderer.h" #include "app/gfx/bitmap.h" #include "app/gfx/compression.h" #include "app/gfx/snes_color.h" #include "app/gfx/snes_palette.h" #include "app/gfx/snes_tile.h" namespace yaze { namespace app { using core::Renderer; constexpr int Uncompressed3BPPSize = 0x0600; constexpr int kEntranceGfxGroup = 0x5D97; namespace { int GetGraphicsAddress(const uchar* data, uint8_t addr, uint32_t ptr1, uint32_t ptr2, uint32_t ptr3) { return core::SnesToPc(core::AddressFromBytes( data[ptr1 + addr], data[ptr2 + addr], data[ptr3 + addr])); } } // namespace absl::StatusOr> Rom::Load2BppGraphics() { std::vector sheet; const uint8_t sheets[] = {113, 114, 218, 219, 220, 221}; for (const auto& sheet_id : sheets) { auto offset = GetGraphicsAddress(data(), sheet_id, version_constants().kOverworldGfxPtr1, version_constants().kOverworldGfxPtr2, version_constants().kOverworldGfxPtr3); 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 uint32_t link_gfx_offset = 0x80000; // $10:8000 const uint16_t link_gfx_length = 0x800; // 0x4000 or 0x7000? // Load Links graphics from the ROM for (int i = 0; i < kNumLinkSheets; 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); RETURN_IF_ERROR(link_graphics_[i].ApplyPalette(palette_groups_.armors[0]);) Renderer::GetInstance().RenderBitmap(&link_graphics_[i]); } return absl::OkStatus(); } absl::Status Rom::LoadAllGraphicsData() { std::vector sheet; bool bpp3 = false; for (int i = 0; i < kNumGfxSheets; i++) { if (i >= 115 && i <= 126) { // uncompressed sheets sheet.resize(Uncompressed3BPPSize); auto offset = GetGraphicsAddress(data(), i, version_constants().kOverworldGfxPtr1, version_constants().kOverworldGfxPtr2, version_constants().kOverworldGfxPtr3); for (int j = 0; j < 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, version_constants().kOverworldGfxPtr1, version_constants().kOverworldGfxPtr2, version_constants().kOverworldGfxPtr3); ASSIGN_OR_RETURN(sheet, gfx::lc_lz2::DecompressV2(rom_data_.data(), offset)) bpp3 = true; } if (bpp3) { auto converted_sheet = gfx::SnesTo8bppSheet(sheet, 3); graphics_sheets_[i].Create(core::kTilesheetWidth, core::kTilesheetHeight, core::kTilesheetDepth, converted_sheet); if (graphics_sheets_[i].is_active()) { if (i > 115) { // Apply sprites palette RETURN_IF_ERROR(graphics_sheets_[i].ApplyPaletteWithTransparent( palette_groups_.global_sprites[0], 0)); } else { RETURN_IF_ERROR(graphics_sheets_[i].ApplyPaletteWithTransparent( palette_groups_.dungeon_main[0], 0)); } } graphics_sheets_[i].CreateTexture(Renderer::GetInstance().renderer()); for (int j = 0; j < graphics_sheets_[i].size(); ++j) { graphics_buffer_.push_back(graphics_sheets_[i].at(j)); } } else { for (int j = 0; j < graphics_sheets_[0].size(); ++j) { graphics_buffer_.push_back(0xFF); } } } return absl::OkStatus(); } absl::Status Rom::LoadFromFile(const std::string& filename, bool z3_load) { if (filename.empty()) { return absl::InvalidArgumentError( "Could not load ROM: parameter `filename` is empty."); } std::string full_filename = std::filesystem::absolute(filename).string(); filename_ = full_filename; // Open file std::ifstream file(filename_, std::ios::binary); if (!file.is_open()) { return absl::NotFoundError( absl::StrCat("Could not open ROM file: ", filename_)); } // Get file size and resize rom_data_ try { size_ = std::filesystem::file_size(filename_); } catch (const std::filesystem::filesystem_error& e) { // Try to get the file size from the open file stream file.seekg(0, std::ios::end); if (!file) { return absl::InternalError(absl::StrCat( "Could not get file size: ", filename_, " - ", e.what())); } size_ = file.tellg(); } rom_data_.resize(size_); // Read file into rom_data_ file.read(reinterpret_cast(rom_data_.data()), size_); // Close file file.close(); // Set is_loaded_ flag and return success is_loaded_ = true; if (z3_load) { RETURN_IF_ERROR(LoadZelda3()); } // Set up the resource labels std::string resource_label_filename = absl::StrFormat("%s.labels", filename); resource_label_manager_.LoadLabels(resource_label_filename); return absl::OkStatus(); } absl::Status Rom::LoadFromPointer(uchar* data, size_t length, bool z3_load) { if (!data || length == 0) return absl::InvalidArgumentError( "Could not load ROM: parameter `data` is empty."); if (!palette_groups_.empty()) palette_groups_.clear(); if (rom_data_.size() < length) rom_data_.resize(length); std::copy(data, data + length, rom_data_.begin()); size_ = length; is_loaded_ = true; if (z3_load) { RETURN_IF_ERROR(LoadZelda3()); } return absl::OkStatus(); } absl::Status Rom::LoadZelda3() { // Check if the ROM has a header constexpr size_t baseROMSize = 1048576; // 1MB constexpr size_t headerSize = 0x200; // 512 bytes if (size_ % baseROMSize == headerSize) { auto header = std::vector(rom_data_.begin(), rom_data_.begin() + 0x200); rom_data_.erase(rom_data_.begin(), rom_data_.begin() + 0x200); size_ -= 0x200; } // Copy ROM title constexpr uint32_t kTitleStringOffset = 0x7FC0; constexpr uint32_t kTitleStringLength = 20; std::copy(rom_data_.begin() + kTitleStringOffset, rom_data_.begin() + kTitleStringOffset + kTitleStringLength, title_.begin()); if (rom_data_[kTitleStringOffset + 0x19] == 0) { version_ = Z3_Version::JP; } else { version_ = Z3_Version::US; } // Load additional resources RETURN_IF_ERROR(gfx::LoadAllPalettes(rom_data_, palette_groups_)); RETURN_IF_ERROR(LoadGfxGroups()); // Expand the ROM data to 2MB without changing the data in the first 1MB rom_data_.resize(baseROMSize * 2); size_ = baseROMSize * 2; return absl::OkStatus(); } absl::Status Rom::LoadFromBytes(const std::vector& 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, bool save_new, std::string filename) { absl::Status non_firing_status; 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 try { std::filesystem::copy(filename_, backup_filename, std::filesystem::copy_options::overwrite_existing); } catch (const std::filesystem::filesystem_error& e) { non_firing_status = absl::InternalError(absl::StrCat( "Could not create backup file: ", backup_filename, " - ", e.what())); } } // Run the other save functions if (flags()->kSaveAllPalettes) { RETURN_IF_ERROR(SaveAllPalettes()); } if (flags()->kSaveGfxGroups) { RETURN_IF_ERROR(SaveGroupsToRom()); } if (save_new) { // Create a file of the same name and append the date between the filename // and file extension auto now = std::chrono::system_clock::now(); auto now_c = std::chrono::system_clock::to_time_t(now); auto filename_no_ext = filename.substr(0, filename.find_last_of(".")); std::cout << filename_no_ext << std::endl; filename = absl::StrCat(filename_no_ext, "_", std::ctime(&now_c)); // Remove spaces from new_filename and replace with _ filename.erase(std::remove(filename.begin(), filename.end(), ' '), filename.end()); // Remove newline character from ctime() filename.erase(std::remove(filename.begin(), filename.end(), '\n'), filename.end()); // Add the file extension back to the new_filename filename = filename + ".sfc"; std::cout << filename << std::endl; } // Open the file that we know exists for writing std::ofstream file(filename.data(), std::ios::binary | std::ios::app); if (!file) { // Create the file if it does not exist file.open(filename.data(), std::ios::binary); if (!file) { return absl::InternalError( absl::StrCat("Could not open or create 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)); } if (!non_firing_status.ok()) { return non_firing_status; } return absl::OkStatus(); } absl::Status 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.is_modified()) { RETURN_IF_ERROR( WriteColor(gfx::GetPaletteAddress(group_name, index, j), color)); color.set_modified(false); // Reset the modified flag after saving } } return absl::OkStatus(); } absl::Status Rom::SaveAllPalettes() { RETURN_IF_ERROR( palette_groups_.for_each([&](gfx::PaletteGroup& group) -> absl::Status { for (size_t i = 0; i < group.size(); ++i) { RETURN_IF_ERROR( SavePalette(i, group.name(), *group.mutable_palette(i))); } return absl::OkStatus(); })); return absl::OkStatus(); } absl::Status Rom::LoadGfxGroups() { main_blockset_ids.resize(kNumMainBlocksets, std::vector(8)); room_blockset_ids.resize(kNumRoomBlocksets, std::vector(4)); spriteset_ids.resize(kNumSpritesets, std::vector(4)); paletteset_ids.resize(kNumPalettesets, std::vector(4)); ASSIGN_OR_RETURN(auto main_blockset_ptr, ReadWord(kGfxGroupsPointer)); main_blockset_ptr = core::SnesToPc(main_blockset_ptr); for (int i = 0; i < kNumMainBlocksets; i++) { for (int j = 0; j < 8; j++) { main_blockset_ids[i][j] = rom_data_[main_blockset_ptr + (i * 8) + j]; } } for (int i = 0; i < kNumRoomBlocksets; i++) { for (int j = 0; j < 4; j++) { room_blockset_ids[i][j] = rom_data_[kEntranceGfxGroup + (i * 4) + j]; } } for (int i = 0; i < kNumSpritesets; i++) { for (int j = 0; j < 4; j++) { spriteset_ids[i][j] = rom_data_[version_constants().kSpriteBlocksetPointer + (i * 4) + j]; } } for (int i = 0; i < kNumPalettesets; i++) { for (int j = 0; j < 4; j++) { paletteset_ids[i][j] = rom_data_[version_constants().kDungeonPalettesGroups + (i * 4) + j]; } } return absl::OkStatus(); } absl::Status Rom::SaveGroupsToRom() { ASSIGN_OR_RETURN(auto main_blockset_ptr, ReadWord(kGfxGroupsPointer)); main_blockset_ptr = core::SnesToPc(main_blockset_ptr); for (int i = 0; i < kNumMainBlocksets; i++) { for (int j = 0; j < 8; j++) { rom_data_[main_blockset_ptr + (i * 8) + j] = main_blockset_ids[i][j]; } } for (int i = 0; i < kNumRoomBlocksets; i++) { for (int j = 0; j < 4; j++) { rom_data_[kEntranceGfxGroup + (i * 4) + j] = room_blockset_ids[i][j]; } } for (int i = 0; i < kNumSpritesets; i++) { for (int j = 0; j < 4; j++) { rom_data_[version_constants().kSpriteBlocksetPointer + (i * 4) + j] = spriteset_ids[i][j]; } } for (int i = 0; i < kNumPalettesets; i++) { for (int j = 0; j < 4; j++) { rom_data_[version_constants().kDungeonPalettesGroups + (i * 4) + j] = paletteset_ids[i][j]; } } return absl::OkStatus(); } std::shared_ptr SharedRom::shared_rom_ = nullptr; } // namespace app } // namespace yaze