music_bank.h

Go to the documentation of this file.

#ifndef YAZE_ZELDA3_MUSIC_MUSIC_BANK_H
#define YAZE_ZELDA3_MUSIC_MUSIC_BANK_H
 
#include <cstdint>
#include <string>
#include <vector>
 
#include "absl/status/status.h"
#include "absl/status/statusor.h"
#include "rom/rom.h"
#include "nlohmann/json.hpp"
#include "zelda3/music/song_data.h"
 
namespace yaze {
namespace zelda3 {
namespace music {
 
class MusicBank {
 public:
  // Bank identifiers
  enum class Bank : uint8_t {
    Overworld = 0,
    Dungeon = 1,
    Credits = 2,
    OverworldExpanded = 3,  // Oracle of Secrets expanded dark world bank
    Auxiliary = 4           // SONG_POINTERS_AUX bank at $2B00
  };
 
  // Space usage information
  struct SpaceInfo {
    int used_bytes;
    int free_bytes;
    int total_bytes;
    float usage_percent;
    bool is_warning = false;   // >75% usage
    bool is_critical = false;  // >90% usage
    std::string recommendation;
  };
 
  // Expanded bank detection info (Oracle of Secrets format)
  struct ExpandedBankInfo {
    uint32_t main_rom_offset = 0;      // SongBank_OverworldExpanded_Main
    uint32_t aux_rom_offset = 0;       // SongBank_Overworld_Auxiliary
    uint16_t aux_aram_address = 0;     // SONG_POINTERS_AUX ($2B00)
    uint32_t hook_address = 0;         // LoadOverworldSongsExpanded location
    bool detected = false;
  };
 
  MusicBank() = default;
  ~MusicBank() = default;
 
  // Non-copyable, moveable
  MusicBank(const MusicBank&) = delete;
  MusicBank& operator=(const MusicBank&) = delete;
  MusicBank(MusicBank&&) = default;
  MusicBank& operator=(MusicBank&&) = default;
 
  // =========================================================================
  // ROM Loading/Saving
  // =========================================================================
 
  absl::Status LoadFromRom(Rom& rom);
 
  absl::Status SaveToRom(Rom& rom);
 
  bool IsLoaded() const { return loaded_; }
 
  // =========================================================================
  // Song Access
  // =========================================================================
 
  size_t GetSongCount() const { return songs_.size(); }
 
  MusicSong* GetSong(int index);
  const MusicSong* GetSong(int index) const;
 
  MusicSong* GetSongById(int song_id);
 
  int CreateNewSong(const std::string& name, Bank bank);
 
  absl::Status DeleteSong(int index);
 
  int DuplicateSong(int index);
 
  bool IsVanilla(int index) const;
 
  bool HasExpandedMusicPatch() const { return expanded_bank_info_.detected; }
 
  bool IsExpandedSong(int index) const;
 
  const ExpandedBankInfo& GetExpandedBankInfo() const {
    return expanded_bank_info_;
  }
 
  std::vector<MusicSong*> GetSongsInBank(Bank bank);
 
  // =========================================================================
  // Instrument Access
  // =========================================================================
 
  size_t GetInstrumentCount() const { return instruments_.size(); }
 
  MusicInstrument* GetInstrument(int index);
  const MusicInstrument* GetInstrument(int index) const;
 
  int CreateNewInstrument(const std::string& name);
 
  // =========================================================================
  // Sample Access
  // =========================================================================
 
  size_t GetSampleCount() const { return samples_.size(); }
 
  MusicSample* GetSample(int index);
  const MusicSample* GetSample(int index) const;
 
  absl::StatusOr<int> ImportSampleFromWav(const std::string& filepath,
                                           const std::string& name);
 
  // =========================================================================
  // Space Management
  // =========================================================================
 
  SpaceInfo CalculateSpaceUsage(Bank bank) const;
 
  bool AllSongsFit() const;
 
  static int GetBankMaxSize(Bank bank);
 
  static uint32_t GetBankRomAddress(Bank bank);
 
  // =========================================================================
  // Modification Tracking
  // =========================================================================
 
  bool HasModifications() const;
 
  void ClearModifications();
 
  // Serialization helpers for persistence (e.g., WASM storage)
  nlohmann::json ToJson() const;
  absl::Status LoadFromJson(const nlohmann::json& j);
 
 private:
  // Internal loading methods
  absl::Status LoadSongTable(Rom& rom, Bank bank,
                             std::vector<MusicSong>* custom_songs);
  absl::Status LoadInstruments(Rom& rom);
  absl::Status LoadSamples(Rom& rom);
 
  // Expanded bank detection and loading
  absl::Status DetectExpandedMusicPatch(Rom& rom);
  absl::Status LoadExpandedSongTable(Rom& rom,
                                     std::vector<MusicSong>* custom_songs);
 
  // Internal saving methods
  absl::Status SaveSongTable(Rom& rom, Bank bank);
  absl::Status SaveInstruments(Rom& rom);
  absl::Status SaveSamples(Rom& rom);
 
  // Calculate size of serialized song
  int CalculateSongSize(const MusicSong& song) const;
 
  // Data storage
  std::vector<MusicSong> songs_;
  std::vector<MusicInstrument> instruments_;
  std::vector<MusicSample> samples_;
 
  // State
  bool loaded_ = false;
  bool instruments_modified_ = false;
  bool samples_modified_ = false;
 
  // Song counts per bank (from original ROM)
  int overworld_song_count_ = 0;
  int dungeon_song_count_ = 0;
  int credits_song_count_ = 0;
  int expanded_song_count_ = 0;
  int auxiliary_song_count_ = 0;
 
  // Expanded bank info (Oracle of Secrets format)
  ExpandedBankInfo expanded_bank_info_;
 
  // Helper metadata for ROM banks
  struct BankSongRange {
    int start_id = 0;
    int end_id = -1;
 
    int Count() const {
      return (end_id >= start_id) ? (end_id - start_id + 1) : 0;
    }
  };
 
  static BankSongRange GetBankSongRange(Bank bank);
  static uint8_t GetSpcBankId(Bank bank);
  static constexpr uint16_t GetSongTableAddress() { return kSongTableAram; }
};
 
// =============================================================================
// Vanilla Song Names
// =============================================================================
 
const char* GetVanillaSongName(int song_id);
 
MusicBank::Bank GetVanillaSongBank(int song_id);
 
}  // namespace music
}  // namespace zelda3
}  // namespace yaze
 
#endif  // YAZE_ZELDA3_MUSIC_MUSIC_BANK_H