rom_info.h

Go to the documentation of this file.

 
#ifndef ROM_INFO_H__
#define ROM_INFO_H__
 
#include <stdbool.h>
#include <stdint.h>
 
#include "path.h"
 
typedef enum {
    ROM_OK,                
    ROM_ERR_LOAD_IO,       
    ROM_ERR_SAVE_IO,       
    ROM_ERR_NO_FILE,       
} rom_err_t;
 
typedef enum {
    ENDIANNESS_BIG,        
    ENDIANNESS_LITTLE,     
    ENDIANNESS_BYTE_SWAP,  
} rom_endianness_t;
 
typedef enum {
    N64_CART = 'N',                
    N64_DISK  = 'D',               
    N64_CART_EXPANDABLE = 'C',     
    N64_DISK_EXPANDABLE = 'E',     
    N64_ALECK64  = 'Z'             
} rom_category_type_t;
 
typedef enum {
    MARKET_JAPANESE_MULTI = 'A',   
    MARKET_BRAZILIAN  = 'B',       
    MARKET_CHINESE = 'C',          
    MARKET_GERMAN = 'D',           
    MARKET_NORTH_AMERICA  = 'E',   
    MARKET_FRENCH = 'F',           
    MARKET_GATEWAY64_NTSC = 'G',   
    MARKET_DUTCH = 'H',            
    MARKET_ITALIAN = 'I',          
    MARKET_JAPANESE = 'J',         
    MARKET_KOREAN = 'K',           
    MARKET_GATEWAY64_PAL = 'L',    
    MARKET_CANADIAN = 'N',         
    MARKET_EUROPEAN_BASIC = 'P',   
    MARKET_SPANISH = 'S',          
    MARKET_AUSTRALIAN = 'U',       
    MARKET_SCANDINAVIAN = 'W',     
    MARKET_OTHER_X = 'X',          
    MARKET_OTHER_Y = 'Y',          
    MARKET_OTHER_Z = 'Z'           
} rom_destination_type_t;
 
typedef enum {
    ROM_CIC_TYPE_UNKNOWN = 0,       
    ROM_CIC_TYPE_5101 = 5101,       
    ROM_CIC_TYPE_5167 = 5167,       
    ROM_CIC_TYPE_6101 = 6101,       
    ROM_CIC_TYPE_7102 = 7102,       
    ROM_CIC_TYPE_x102 = 6102,       
    ROM_CIC_TYPE_x103 = 6103,       
    ROM_CIC_TYPE_x105 = 6105,       
    ROM_CIC_TYPE_x106 = 6106,       
    ROM_CIC_TYPE_8301 = 8301,       
    ROM_CIC_TYPE_8302 = 8302,       
    ROM_CIC_TYPE_8303 = 8303,       
    ROM_CIC_TYPE_8401 = 8401,       
    ROM_CIC_TYPE_8501 = 8501,       
    ROM_CIC_TYPE_AUTOMATIC = -1,    
} rom_cic_type_t;
 
typedef enum {
    SAVE_TYPE_NONE = 0,             
    SAVE_TYPE_EEPROM_4KBIT = 1,     
    SAVE_TYPE_EEPROM_16KBIT = 2,    
    SAVE_TYPE_SRAM_256KBIT = 3,     
    SAVE_TYPE_SRAM_BANKED = 4,      
    SAVE_TYPE_SRAM_1MBIT = 5,       
    SAVE_TYPE_FLASHRAM_1MBIT = 6,   
    SAVE_TYPE_FLASHRAM_PKST2 = 7,   
    SAVE_TYPE_AUTOMATIC = -1,       
} rom_save_type_t;
 
typedef enum {
    ROM_TV_TYPE_PAL = 0,            
    ROM_TV_TYPE_NTSC = 1,           
    ROM_TV_TYPE_MPAL = 2,           
    ROM_TV_TYPE_UNKNOWN = 3,        
    ROM_TV_TYPE_AUTOMATIC = -1,     
} rom_tv_type_t;
 
typedef enum {
    EXPANSION_PAK_NONE,             
    EXPANSION_PAK_REQUIRED,         
    EXPANSION_PAK_RECOMMENDED,      
    EXPANSION_PAK_SUGGESTED,        
    EXPANSION_PAK_FAULTY,           
} rom_expansion_pak_t;
 
typedef struct {
    rom_endianness_t endianness;    
    float clock_rate;               
    uint32_t boot_address;          
    struct {
        uint8_t version;            
        char revision;              
    } libultra;
 
    uint64_t check_code;            
    char title[20];                 
    union {
        char game_code[4];          
        struct {
            rom_category_type_t category_code : 8; 
            char unique_code[2];                   
            rom_destination_type_t destination_code : 8; 
        };
    };
 
    uint8_t version;                
    rom_cic_type_t cic_type;        
    rom_save_type_t save_type;      
    rom_tv_type_t tv_type;          
    struct {
        bool cic;                   
        rom_cic_type_t cic_type;    
        bool save;                  
        rom_save_type_t save_type;  
        bool tv;                    
        rom_tv_type_t tv_type;      
    } boot_override;                
    struct {
        bool controller_pak;        
        bool rumble_pak;            
        bool transfer_pak;          
        bool voice_recognition_unit; 
        bool real_time_clock;       
        bool disk_conversion;       
        bool combo_rom_disk_game;   
        rom_expansion_pak_t expansion_pak; 
    } features;                     
    struct {
        bool cheats_enabled;        
        bool patches_enabled;       
    } settings;                     
    struct {
        char description[300];      
    } metadata;                     
} rom_info_t;
 
bool rom_info_get_cic_seed(rom_info_t *rom_info, uint8_t *seed);
 
rom_err_t rom_info_load(path_t *path, rom_info_t *rom_info);
 
rom_cic_type_t rom_info_get_cic_type(rom_info_t *rom_info);
 
rom_err_t rom_info_override_cic_type(path_t *path, rom_info_t *rom_info, rom_cic_type_t cic_type);
 
rom_save_type_t rom_info_get_save_type(rom_info_t *rom_info);
 
rom_err_t rom_info_override_save_type(path_t *path, rom_info_t *rom_info, rom_save_type_t save_type);
 
rom_tv_type_t rom_info_get_tv_type(rom_info_t *rom_info);
 
rom_err_t rom_info_override_tv_type(path_t *path, rom_info_t *rom_info, rom_tv_type_t tv_type);
 
#endif // ROM_INFO_H__