#ifndef GUARD_GBA_TYPES_H #define GUARD_GBA_TYPES_H #include typedef uint8_t u8; typedef uint16_t u16; typedef uint32_t u32; typedef uint64_t u64; typedef int8_t s8; typedef int16_t s16; typedef int32_t s32; typedef int64_t s64; // If the DISPLAY_HEIGHT was >255, scanline effects would break, // so we have to #ifdef PORTABLE typedef u32 int_vcount; #else typedef u8 int_vcount; #endif typedef volatile u8 vu8; typedef volatile u16 vu16; typedef volatile u32 vu32; typedef volatile u64 vu64; typedef volatile s8 vs8; typedef volatile s16 vs16; typedef volatile s32 vs32; typedef volatile s64 vs64; typedef float f32; typedef double f64; typedef u8 bool8; typedef u16 bool16; typedef u32 bool32; struct BgCnt { u16 priority:2; u16 charBaseBlock:2; u16 dummy:2; u16 mosaic:1; u16 palettes:1; u16 screenBaseBlock:5; u16 areaOverflowMode:1; u16 screenSize:2; }; typedef volatile struct BgCnt vBgCnt; struct PlttData { u16 r:5; // red u16 g:5; // green u16 b:5; // blue u16 unused_15:1; }; // NOTE: Inside the ROM the OAM data used for layouting // is stored without an affine parameter, which makes sense // since they're relatively unrelated and affine values are // usually generated during runtime, anyway. // That's what this variation of 'OamData' is for, // as well using this to determine the size for some DMAs to gOamBuffer. typedef struct PACKED { /*0x00*/ u32 y : 8; /*0x01*/ u32 affineMode : 2; // 0x1, 0x2 -> 0x4 u32 objMode : 2; // 0x4, 0x8 -> 0xC u32 mosaic : 1; // 0x10 u32 bpp : 1; // 0x20 u32 shape : 2; // 0x40, 0x80 -> 0xC0 /*0x02*/ u32 x : 9; u32 matrixNum : 5; // bits 3/4 are h-flip/v-flip if not in affine mode u32 size : 2; // 0x4000, 0x8000 -> 0xC000 /*0x04*/ u16 tileNum : 10; // 0x3FF u16 priority : 2; // 0x400, 0x800 -> 0xC00 u16 paletteNum : 4; } OamDataShort; /* size: 0x6 (important to not be 0x8, see comment above struct!) */ typedef union { struct { /*0x00*/ u32 y:8; /*0x01*/ u32 affineMode:2; // 0x1, 0x2 -> 0x4 u32 objMode:2; // 0x4, 0x8 -> 0xC u32 mosaic:1; // 0x10 u32 bpp:1; // 0x20 u32 shape:2; // 0x40, 0x80 -> 0xC0 /*0x02*/ u32 x:9; u32 matrixNum:5; // bits 3/4 are h-flip/v-flip if not in affine mode u32 size:2; // 0x4000, 0x8000 -> 0xC000 /*0x04*/ u16 tileNum:10; // 0x3FF u16 priority:2; // 0x400, 0x800 -> 0xC00 u16 paletteNum:4; /*0x06*/ u16 fractional:8; u16 integer:7; u16 sign:1; } split; struct { u16 attr0; u16 attr1; u16 attr2; u16 affineParam; } all; u16 raw[4]; } OamData; #define ST_OAM_HFLIP 0x08 #define ST_OAM_VFLIP 0x10 #define ST_OAM_MNUM_FLIP_MASK 0x18 #define ST_OAM_OBJ_NORMAL 0 #define ST_OAM_OBJ_BLEND 1 #define ST_OAM_OBJ_WINDOW 2 #define ST_OAM_AFFINE_OFF 0 #define ST_OAM_AFFINE_NORMAL 1 #define ST_OAM_AFFINE_ERASE 2 #define ST_OAM_AFFINE_DOUBLE 3 #define ST_OAM_AFFINE_ON_MASK 1 #define ST_OAM_AFFINE_DOUBLE_MASK 2 #define ST_OAM_4BPP 0 #define ST_OAM_8BPP 1 #define ST_OAM_SQUARE 0 #define ST_OAM_H_RECTANGLE 1 #define ST_OAM_V_RECTANGLE 2 #define ST_OAM_SIZE_0 0 #define ST_OAM_SIZE_1 1 #define ST_OAM_SIZE_2 2 #define ST_OAM_SIZE_3 3 #define SPRITE_SIZE_8x8 ((ST_OAM_SIZE_0 << 2) | (ST_OAM_SQUARE)) #define SPRITE_SIZE_16x16 ((ST_OAM_SIZE_1 << 2) | (ST_OAM_SQUARE)) #define SPRITE_SIZE_32x32 ((ST_OAM_SIZE_2 << 2) | (ST_OAM_SQUARE)) #define SPRITE_SIZE_64x64 ((ST_OAM_SIZE_3 << 2) | (ST_OAM_SQUARE)) #define SPRITE_SIZE_16x8 ((ST_OAM_SIZE_0 << 2) | (ST_OAM_H_RECTANGLE)) #define SPRITE_SIZE_32x8 ((ST_OAM_SIZE_1 << 2) | (ST_OAM_H_RECTANGLE)) #define SPRITE_SIZE_32x16 ((ST_OAM_SIZE_2 << 2) | (ST_OAM_H_RECTANGLE)) #define SPRITE_SIZE_64x32 ((ST_OAM_SIZE_3 << 2) | (ST_OAM_H_RECTANGLE)) #define SPRITE_SIZE_8x16 ((ST_OAM_SIZE_0 << 2) | (ST_OAM_V_RECTANGLE)) #define SPRITE_SIZE_8x32 ((ST_OAM_SIZE_1 << 2) | (ST_OAM_V_RECTANGLE)) #define SPRITE_SIZE_16x32 ((ST_OAM_SIZE_2 << 2) | (ST_OAM_V_RECTANGLE)) #define SPRITE_SIZE_32x64 ((ST_OAM_SIZE_3 << 2) | (ST_OAM_V_RECTANGLE)) #define SPRITE_SIZE(dim) ((SPRITE_SIZE_##dim >> 2) & 0x03) #define SPRITE_SHAPE(dim) (SPRITE_SIZE_##dim & 0x03) struct BgAffineSrcData { s32 texX; s32 texY; s16 scrX; s16 scrY; s16 sx; s16 sy; u16 alpha; }; struct BgAffineDstData { s16 pa; s16 pb; s16 pc; s16 pd; s32 dx; s32 dy; }; struct ObjAffineSrcData { s16 xScale; s16 yScale; u16 rotation; }; // Normal SIO Control Structure struct SioNormalCnt { u16 sck_I_O:1; // Clock I/O Select u16 sck:1; // Internal Clock Select u16 ackRecv:1; // Transfer Enable Flag Receive u16 ackSend:1; // Transfer Enable Flag Send u16 unused_6_4:3; u16 enable:1; // SIO Enable u16 unused_11_8:4; u16 mode:2; // Communication Mode Select u16 ifEnable:1; // Interrupt Request Enable u16 unused_15:1; u8 data; // Data u8 unused_31_24; }; #define ST_SIO_8BIT_MODE 0 // Normal 8-bit communication mode #define ST_SIO_32BIT_MODE 1 // Normal 32-bit communication mode #define ST_SIO_SCK_OUT 0 // Select external clock #define ST_SIO_SCK_IN 1 // Select internal clock #define ST_SIO_IN_SCK_256K 0 // Select internal clock 256KHz #define ST_SIO_IN_SCK_2M 1 // Select 2MHz // Multi-player SIO Control Structure struct SioMultiCnt { u16 baudRate:2; // baud rate u16 si:1; // SI terminal u16 sd:1; // SD terminal u16 id:2; // ID u16 error:1; // error flag u16 enable:1; // SIO enable u16 unused_11_8:4; u16 mode:2; // communication mode (should equal 2) u16 ifEnable:1; // IRQ enable u16 unused_15:1; u16 data; // data }; #define ST_SIO_MULTI_MODE 2 // Multi-play communication mode #define ST_SIO_9600_BPS 0 // Baud rate 9600 bps #define ST_SIO_38400_BPS 1 // 38400 bps #define ST_SIO_57600_BPS 2 // 57600 bps #define ST_SIO_115200_BPS 3 // 115200 bps #define ST_SIO_MULTI_PARENT 1 // Multi-play communication Connect master #define ST_SIO_MULTI_CHILD 0 // Connect slave // UART - SIO Control Structure struct SioUartCnt { u16 baudRate:2; // Baud Rate u16 ctsEnable:1; // Send Signal Enable u16 paritySelect:1; // Parity Even/Odd u16 transDataFull:1; // Transmit Data Full u16 recvDataEmpty:1; // Receive Data Empty u16 error:1; // Error Detect u16 length:1; // Data Length u16 fifoEnable:1; // FIFO Enable u16 parityEnable:1; // Parity Enable u16 transEnable:1; // Transmitter Enable u16 recvEnable:1; // Receiver Enable u16 mode:2; // Communication Mode Select u16 ifEnable:1; // Interrupt Request Enable u16 unused_15:1; u8 data; // Data u8 unused_31_24; }; #define ST_SIO_UART_MODE 3 // UART communication mode #define ST_SIO_UART_7BIT 0 // UART communication data length 7 bits #define ST_SIO_UART_8BIT 1 // 8 bits #define ST_SIO_PARITY_EVEN 0 // Even parity #define ST_SIO_PARITY_ODD 1 // Odd parity // JOY Bus Communication Control Structure struct JoyCnt { u8 ifReset:1; // JOY Bus Reset Interrupt Request u8 ifRecv:1; // JOY Bus Received Interrupt Request u8 ifSend:1; // JOY Bus Sent Interrupt Request u8 unused_5_3:3; u8 ifEnable:1; // Interrupt Request Enable u8 unused_7:1; }; // JOY Bus Communication Status Structure struct JoyStat { u8 unused_0:1; u8 recv:1; // Receive Status u8 unused_2:1; u8 send:1; // Send Status u8 flags:2; // General Flag u8 unused_7_6:2; }; // General Input/Output Control Structure struct RCnt { u8 sc:1; // Data u8 sd:1; u8 si:1; u8 so:1; u8 sc_i_o:1; // I/O Select u8 sd_i_o:1; u8 si_i_o:1; u8 so_i_o:1; u8 ifEnable:1; // Interrupt Request Enable u8 unused_13_9:5; u8 sioModeMaster:2; // SIO Mode Master }; #define ST_R_SIO_MASTER_MODE 0 // SIO master mode #define ST_R_DIRECT_MODE 2 // General input/output communication mode #define ST_R_JOY_MODE 3 // JOY communication mode #define ST_R_IN 0 // Select input #define ST_R_OUT 1 // Select output #endif // GUARD_GBA_TYPES_H #ifndef GUARD_GBA_MULTIBOOT_H #define GUARD_GBA_MULTIBOOT_H #define MULTIBOOT_NCHILD 3 // Maximum number of slaves #define MULTIBOOT_HEADER_SIZE 0xc0 // Header size #define MULTIBOOT_SEND_SIZE_MIN 0x100 // Minimum transmission size #define MULTIBOOT_SEND_SIZE_MAX 0x40000 // Maximum transmission size struct MultiBootParam { u32 system_work[5]; u8 handshake_data; u8 padding; u16 handshake_timeout; u8 probe_count; u8 client_data[MULTIBOOT_NCHILD]; u8 palette_data; u8 response_bit; u8 client_bit; u8 reserved1; u8 *boot_srcp; u8 *boot_endp; u8 *masterp; u8 *reserved2[MULTIBOOT_NCHILD]; u32 system_work2[4]; u8 sendflag; u8 probe_target_bit; u8 check_wait; u8 server_type; }; #define MULTIBOOT_ERROR_04 0x04 #define MULTIBOOT_ERROR_08 0x08 #define MULTIBOOT_ERROR_0c 0x0c #define MULTIBOOT_ERROR_40 0x40 #define MULTIBOOT_ERROR_44 0x44 #define MULTIBOOT_ERROR_48 0x48 #define MULTIBOOT_ERROR_4c 0x4c #define MULTIBOOT_ERROR_80 0x80 #define MULTIBOOT_ERROR_84 0x84 #define MULTIBOOT_ERROR_88 0x88 #define MULTIBOOT_ERROR_8c 0x8c #define MULTIBOOT_ERROR_NO_PROBE_TARGET 0x50 #define MULTIBOOT_ERROR_NO_DLREADY 0x60 #define MULTIBOOT_ERROR_BOOT_FAILURE 0x70 #define MULTIBOOT_ERROR_HANDSHAKE_FAILURE 0x71 #define MULTIBOOT_CONNECTION_CHECK_WAIT 15 #define MULTIBOOT_SERVER_TYPE_NORMAL 0 #define MULTIBOOT_SERVER_TYPE_QUICK 1 #define MULTIBOOT_HANDSHAKE_TIMEOUT 400 #endif // GUARD_GBA_MULTIBOOT_H #ifndef GUARD_GBA_DEFINES #define GUARD_GBA_DEFINES #include #define TRUE 1 #define FALSE 0 #define IWRAM_DATA __attribute__((section("iwram_data"))) #define EWRAM_DATA __attribute__((section("ewram_data"))) #define NAKED __attribute__((naked)) #define UNUSED __attribute__((unused)) #define PACKED __attribute__((packed)) #define ALIGNED(n) __attribute__((aligned(n))) #define SOUND_INFO_PTR (*(struct SoundInfo **)0x3007FF0) #define INTR_CHECK (*(u16 *)0x3007FF8) #define INTR_VECTOR (*(void **)0x3007FFC) #define EWRAM_START 0x02000000 #define EWRAM_SIZE 0x40000 #define IWRAM_START 0x03000000 #define IWRAM_SIZE 0x7E00 #define PLTT 0x5000000 #define PLTT_SIZE 0x400 #define BG_PLTT PLTT #define BG_PLTT_SIZE 0x200 #define OBJ_PLTT (PLTT + 0x200) #define OBJ_PLTT_SIZE 0x200 #define VRAM 0x6000000 #define VRAM_SIZE 0x18000 #define BG_VRAM VRAM #define BG_VRAM_SIZE 0x10000 #define BG_CHAR_ADDR(n) (BG_VRAM + (0x4000 * (n))) #define BG_SCREEN_ADDR(n) (BG_VRAM + (0x800 * (n))) #define BG_TILE_ADDR(n) (BG_VRAM + (0x80 * (n))) // text-mode BG #define OBJ_VRAM0 (VRAM + 0x10000) #define OBJ_VRAM0_SIZE 0x8000 // bitmap-mode BG #define OBJ_VRAM1 (VRAM + 0x14000) #define OBJ_VRAM1_SIZE 0x4000 #define OAM 0x7000000 #define OAM_ENTRY_COUNT 128 #define OAM_SIZE (OAM_ENTRY_COUNT*sizeof(OamData)) #define DISPLAY_WIDTH 240 #define DISPLAY_HEIGHT 160 #define TILE_SIZE_4BPP 32 #define TILE_SIZE_8BPP 64 // NOTE/TODO: Maybe this should somewhere else? #define GET_TILE_NUM_COMMON(vramPtr, tileSize) (((size_t)(vramPtr) - OBJ_VRAM0) / (tileSize)) #define GET_TILE_NUM(vramPtr) GET_TILE_NUM_COMMON((vramPtr), TILE_SIZE_4BPP) #define TOTAL_OBJ_TILE_COUNT 1024 #define RGB(r, g, b) ((r) | ((g) << 5) | ((b) << 10)) #define RGB_BLACK RGB(0, 0, 0) #define RGB_WHITE RGB(31, 31, 31) #define RGB_RED RGB(31, 0, 0) #define RGB_GREEN RGB(0, 31, 0) #define RGB_BLUE RGB(0, 0, 31) #define RGB_YELLOW RGB(31, 31, 0) #define RGB_MAGENTA RGB(31, 0, 31) #define RGB_CYAN RGB(0, 31, 31) #define RGB_WHITEALPHA (RGB_WHITE | 0x8000) #define WIN_RANGE(a, b) (((a) << 8) | (b)) #define SYSTEM_CLOCK (16 * 1024 * 1024) // System Clock #endif // GUARD_GBA_DEFINES #ifndef GUARD_GBA_FLASH_INTERNAL_H #define GUARD_GBA_FLASH_INTERNAL_H #define FLASH_BASE ((u8 *)0xE000000) #define FLASH_WRITE(addr, data) ((*(vu8 *)(FLASH_BASE + (addr))) = (data)) #define FLASH_ROM_SIZE_1M 131072 // 1 megabit ROM #define SECTORS_PER_BANK 16 /* Manufacturers */ #define FLASH_MAKER__SST 0xBF #define FLASH_MAKER__MX 0xC2 /* Chips */ #define FLASH_CHIP__SST_39VF512 0xD4 struct FlashSector { u32 size; u8 shift; u16 count; u16 top; }; struct FlashType { u32 romSize; struct FlashSector sector; u16 wait[2]; // game pak bus read/write wait // TODO: add support for anonymous unions/structs if possible union { struct { u8 makerId; u8 deviceId; } separate; u16 joined; } ids; }; struct FlashSetupInfo { u16 (*programFlashSector)(u16, void *); u16 (*eraseFlashChip)(void); u16 (*eraseFlashSector)(u16); u16 (*WaitForFlashWrite)(u8, u8 *, u8); const u16 *maxTime; struct FlashType type; }; extern u16 gFlashNumRemainingBytes; extern u16 (*ProgramFlashSector)(u16, void *); extern u16 (*EraseFlashChip)(void); extern u16 (*EraseFlashSector)(u16); extern const u16 *gFlashMaxTime; extern const struct FlashType *gFlash; extern u8 gFlashTimeoutFlag; extern u8 (*PollFlashStatus)(u8 *); extern u16 (*WaitForFlashWrite)(u8, u8 *, u8); extern const struct FlashSetupInfo LE39FW512; //extern const struct FlashSetupInfo AT29LV512; extern const struct FlashSetupInfo MN63F805MNP; extern const struct FlashSetupInfo MX29L512; extern const struct FlashSetupInfo DefaultFlash512K; // extern const struct FlashSetupInfo MX29L010; // extern const struct FlashSetupInfo LE26FV10N1TS; // extern const struct FlashSetupInfo DefaultFlash1M; void SwitchFlashBank(u8 bankNum); u16 ReadFlashId(void); void StartFlashTimer(u8 phase); void SetReadFlash1(u16 *dest); void StopFlashTimer(void); u16 SetFlashTimerIntr(u8 timerNum, void (**intrFunc)(void)); u32 ProgramFlashSectorAndVerify(u16 sectorNum, u8 *src); void ReadFlash(u16 sectorNum, u32 offset, void *dest, u32 size); u32 ProgramFlashSectorAndVerifyNBytes(u16 sectorNum, void *dataSrc, u32 n); u16 WaitForFlashWrite512K_Common(u8 phase, u8 *addr, u8 lastData); u16 WaitForFlashWrite_Common(u8 phase, u8 *addr, u8 lastData); u16 ProgramByte(u8 *src, u8 *dest); u16 EraseFlashChip_LE(void); u16 EraseFlashSector_LE(u16 sectorNum); u16 ProgramFlashSector_LE(u16 sectorNum, void *src); u16 ProgramFlashSector_MX(u16 sectorNum, void *src); u16 EraseFlashChip_MX(void); u16 EraseFlashSector_MX(u16 sectorNum); // agb_flash_1m u16 IdentifyFlash(void); #endif // GUARD_GBA_FLASH_INTERNAL_H #ifndef GUARD_GBA_IO_REG_H #define GUARD_GBA_IO_REG_H #define REG_BASE 0x4000000 // I/O register base address // I/O register offsets #define REG_OFFSET_DISPCNT 0x0 #define REG_OFFSET_DISPSTAT 0x4 #define REG_OFFSET_VCOUNT 0x6 #define REG_OFFSET_BG0CNT 0x8 #define REG_OFFSET_BG1CNT 0xa #define REG_OFFSET_BG2CNT 0xc #define REG_OFFSET_BG3CNT 0xe #define REG_OFFSET_BG0HOFS 0x10 #define REG_OFFSET_BG0VOFS 0x12 #define REG_OFFSET_BG1HOFS 0x14 #define REG_OFFSET_BG1VOFS 0x16 #define REG_OFFSET_BG2HOFS 0x18 #define REG_OFFSET_BG2VOFS 0x1a #define REG_OFFSET_BG3HOFS 0x1c #define REG_OFFSET_BG3VOFS 0x1e #define REG_OFFSET_BG2PA 0x20 #define REG_OFFSET_BG2PB 0x22 #define REG_OFFSET_BG2PC 0x24 #define REG_OFFSET_BG2PD 0x26 #define REG_OFFSET_BG2X 0x28 #define REG_OFFSET_BG2X_L 0x28 #define REG_OFFSET_BG2X_H 0x2a #define REG_OFFSET_BG2Y 0x2c #define REG_OFFSET_BG2Y_L 0x2c #define REG_OFFSET_BG2Y_H 0x2e #define REG_OFFSET_BG3PA 0x30 #define REG_OFFSET_BG3PB 0x32 #define REG_OFFSET_BG3PC 0x34 #define REG_OFFSET_BG3PD 0x36 #define REG_OFFSET_BG3X 0x38 #define REG_OFFSET_BG3X_L 0x38 #define REG_OFFSET_BG3X_H 0x3a #define REG_OFFSET_BG3Y 0x3c #define REG_OFFSET_BG3Y_L 0x3c #define REG_OFFSET_BG3Y_H 0x3e #define REG_OFFSET_WIN0H 0x40 #define REG_OFFSET_WIN1H 0x42 #define REG_OFFSET_WIN0V 0x44 #define REG_OFFSET_WIN1V 0x46 #define REG_OFFSET_WININ 0x48 #define REG_OFFSET_WINOUT 0x4a #define REG_OFFSET_MOSAIC 0x4c #define REG_OFFSET_BLDCNT 0x50 #define REG_OFFSET_BLDALPHA 0x52 #define REG_OFFSET_BLDY 0x54 #define REG_OFFSET_SOUND1CNT_L 0x60 #define REG_OFFSET_NR10 0x60 #define REG_OFFSET_SOUND1CNT_H 0x62 #define REG_OFFSET_NR11 0x62 #define REG_OFFSET_NR12 0x63 #define REG_OFFSET_SOUND1CNT_X 0x64 #define REG_OFFSET_NR13 0x64 #define REG_OFFSET_NR14 0x65 #define REG_OFFSET_SOUND2CNT_L 0x68 #define REG_OFFSET_NR21 0x68 #define REG_OFFSET_NR22 0x69 #define REG_OFFSET_SOUND2CNT_H 0x6c #define REG_OFFSET_NR23 0x6c #define REG_OFFSET_NR24 0x6d #define REG_OFFSET_SOUND3CNT_L 0x70 #define REG_OFFSET_NR30 0x70 #define REG_OFFSET_SOUND3CNT_H 0x72 #define REG_OFFSET_NR31 0x72 #define REG_OFFSET_NR32 0x73 #define REG_OFFSET_SOUND3CNT_X 0x74 #define REG_OFFSET_NR33 0x74 #define REG_OFFSET_NR34 0x75 #define REG_OFFSET_SOUND4CNT_L 0x78 #define REG_OFFSET_NR41 0x78 #define REG_OFFSET_NR42 0x79 #define REG_OFFSET_SOUND4CNT_H 0x7c #define REG_OFFSET_NR43 0x7c #define REG_OFFSET_NR44 0x7d #define REG_OFFSET_SOUNDCNT_L 0x80 #define REG_OFFSET_NR50 0x80 #define REG_OFFSET_NR51 0x81 #define REG_OFFSET_SOUNDCNT_H 0x82 #define REG_OFFSET_SOUNDCNT_X 0x84 #define REG_OFFSET_NR52 0x84 #define REG_OFFSET_SOUNDBIAS 0x88 #define REG_OFFSET_SOUNDBIAS_L 0x88 #define REG_OFFSET_SOUNDBIAS_H 0x89 #define REG_OFFSET_WAVE_RAM0 0x90 #define REG_OFFSET_WAVE_RAM1 0x94 #define REG_OFFSET_WAVE_RAM2 0x98 #define REG_OFFSET_WAVE_RAM3 0x9c #define REG_OFFSET_FIFO_A 0xa0 #define REG_OFFSET_FIFO_B 0xa4 #define REG_OFFSET_DMA0 0xb0 #define REG_OFFSET_DMA0SAD 0xb0 #define REG_OFFSET_DMA0SAD_L 0xb0 #define REG_OFFSET_DMA0SAD_H 0xb2 #define REG_OFFSET_DMA0DAD 0xb4 #define REG_OFFSET_DMA0DAD_L 0xb4 #define REG_OFFSET_DMA0DAD_H 0xb6 #define REG_OFFSET_DMA0CNT 0xb8 #define REG_OFFSET_DMA0CNT_L 0xb8 #define REG_OFFSET_DMA0CNT_H 0xba #define REG_OFFSET_DMA1 0xbc #define REG_OFFSET_DMA1SAD 0xbc #define REG_OFFSET_DMA1SAD_L 0xbc #define REG_OFFSET_DMA1SAD_H 0xbe #define REG_OFFSET_DMA1DAD 0xc0 #define REG_OFFSET_DMA1DAD_L 0xc0 #define REG_OFFSET_DMA1DAD_H 0xc2 #define REG_OFFSET_DMA1CNT 0xc4 #define REG_OFFSET_DMA1CNT_L 0xc4 #define REG_OFFSET_DMA1CNT_H 0xc6 #define REG_OFFSET_DMA2 0xc8 #define REG_OFFSET_DMA2SAD 0xc8 #define REG_OFFSET_DMA2SAD_L 0xc8 #define REG_OFFSET_DMA2SAD_H 0xca #define REG_OFFSET_DMA2DAD 0xcc #define REG_OFFSET_DMA2DAD_L 0xcc #define REG_OFFSET_DMA2DAD_H 0xce #define REG_OFFSET_DMA2CNT 0xd0 #define REG_OFFSET_DMA2CNT_L 0xd0 #define REG_OFFSET_DMA2CNT_H 0xd2 #define REG_OFFSET_DMA3 0xd4 #define REG_OFFSET_DMA3SAD 0xd4 #define REG_OFFSET_DMA3SAD_L 0xd4 #define REG_OFFSET_DMA3SAD_H 0xd6 #define REG_OFFSET_DMA3DAD 0xd8 #define REG_OFFSET_DMA3DAD_L 0xd8 #define REG_OFFSET_DMA3DAD_H 0xda #define REG_OFFSET_DMA3CNT 0xdc #define REG_OFFSET_DMA3CNT_L 0xdc #define REG_OFFSET_DMA3CNT_H 0xde #define REG_OFFSET_TMCNT 0x100 #define REG_OFFSET_TMCNT_L 0x100 #define REG_OFFSET_TMCNT_H 0x102 #define REG_OFFSET_TM0CNT 0x100 #define REG_OFFSET_TM0CNT_L 0x100 #define REG_OFFSET_TM0CNT_H 0x102 #define REG_OFFSET_TM1CNT 0x104 #define REG_OFFSET_TM1CNT_L 0x104 #define REG_OFFSET_TM1CNT_H 0x106 #define REG_OFFSET_TM2CNT 0x108 #define REG_OFFSET_TM2CNT_L 0x108 #define REG_OFFSET_TM2CNT_H 0x10a #define REG_OFFSET_TM3CNT 0x10c #define REG_OFFSET_TM3CNT_L 0x10c #define REG_OFFSET_TM3CNT_H 0x10e #define REG_OFFSET_SIOCNT 0x128 #define REG_OFFSET_SIODATA8 0x12a #define REG_OFFSET_SIODATA32 0x120 #define REG_OFFSET_SIOMLT_SEND 0x12a #define REG_OFFSET_SIOMLT_RECV 0x120 #define REG_OFFSET_SIOMULTI0 0x120 #define REG_OFFSET_SIOMULTI1 0x122 #define REG_OFFSET_SIOMULTI2 0x124 #define REG_OFFSET_SIOMULTI3 0x126 #define REG_OFFSET_KEYINPUT 0x130 #define REG_OFFSET_KEYCNT 0x132 #define REG_OFFSET_RCNT 0x134 #define REG_OFFSET_JOYCNT 0x140 #define REG_OFFSET_JOYSTAT 0x158 #define REG_OFFSET_JOY_RECV 0x150 #define REG_OFFSET_JOY_RECV_L 0x150 #define REG_OFFSET_JOY_RECV_H 0x152 #define REG_OFFSET_JOY_TRANS 0x154 #define REG_OFFSET_JOY_TRANS_L 0x154 #define REG_OFFSET_JOY_TRANS_H 0x156 #define REG_OFFSET_IME 0x208 #define REG_OFFSET_IE 0x200 #define REG_OFFSET_IF 0x202 #define REG_OFFSET_WAITCNT 0x204 // I/O register addresses #define REG_ADDR_DISPCNT (REG_BASE + REG_OFFSET_DISPCNT) #define REG_ADDR_DISPSTAT (REG_BASE + REG_OFFSET_DISPSTAT) #define REG_ADDR_VCOUNT (REG_BASE + REG_OFFSET_VCOUNT) #define REG_ADDR_BG0CNT (REG_BASE + REG_OFFSET_BG0CNT) #define REG_ADDR_BG1CNT (REG_BASE + REG_OFFSET_BG1CNT) #define REG_ADDR_BG2CNT (REG_BASE + REG_OFFSET_BG2CNT) #define REG_ADDR_BG3CNT (REG_BASE + REG_OFFSET_BG3CNT) #define REG_ADDR_BG0HOFS (REG_BASE + REG_OFFSET_BG0HOFS) #define REG_ADDR_BG0VOFS (REG_BASE + REG_OFFSET_BG0VOFS) #define REG_ADDR_BG1HOFS (REG_BASE + REG_OFFSET_BG1HOFS) #define REG_ADDR_BG1VOFS (REG_BASE + REG_OFFSET_BG1VOFS) #define REG_ADDR_BG2HOFS (REG_BASE + REG_OFFSET_BG2HOFS) #define REG_ADDR_BG2VOFS (REG_BASE + REG_OFFSET_BG2VOFS) #define REG_ADDR_BG3HOFS (REG_BASE + REG_OFFSET_BG3HOFS) #define REG_ADDR_BG3VOFS (REG_BASE + REG_OFFSET_BG3VOFS) #define REG_ADDR_BG2PA (REG_BASE + REG_OFFSET_BG2PA) #define REG_ADDR_BG2PB (REG_BASE + REG_OFFSET_BG2PB) #define REG_ADDR_BG2PC (REG_BASE + REG_OFFSET_BG2PC) #define REG_ADDR_BG2PD (REG_BASE + REG_OFFSET_BG2PD) #define REG_ADDR_BG2X (REG_BASE + REG_OFFSET_BG2X) #define REG_ADDR_BG2X_L (REG_BASE + REG_OFFSET_BG2X_L) #define REG_ADDR_BG2X_H (REG_BASE + REG_OFFSET_BG2X_H) #define REG_ADDR_BG2Y (REG_BASE + REG_OFFSET_BG2Y) #define REG_ADDR_BG2Y_L (REG_BASE + REG_OFFSET_BG2Y_L) #define REG_ADDR_BG2Y_H (REG_BASE + REG_OFFSET_BG2Y_H) #define REG_ADDR_BG3PA (REG_BASE + REG_OFFSET_BG3PA) #define REG_ADDR_BG3PB (REG_BASE + REG_OFFSET_BG3PB) #define REG_ADDR_BG3PC (REG_BASE + REG_OFFSET_BG3PC) #define REG_ADDR_BG3PD (REG_BASE + REG_OFFSET_BG3PD) #define REG_ADDR_BG3X (REG_BASE + REG_OFFSET_BG3X) #define REG_ADDR_BG3X_L (REG_BASE + REG_OFFSET_BG3X_L) #define REG_ADDR_BG3X_H (REG_BASE + REG_OFFSET_BG3X_H) #define REG_ADDR_BG3Y (REG_BASE + REG_OFFSET_BG3Y) #define REG_ADDR_BG3Y_L (REG_BASE + REG_OFFSET_BG3Y_L) #define REG_ADDR_BG3Y_H (REG_BASE + REG_OFFSET_BG3Y_H) #define REG_ADDR_WIN0H (REG_BASE + REG_OFFSET_WIN0H) #define REG_ADDR_WIN1H (REG_BASE + REG_OFFSET_WIN1H) #define REG_ADDR_WIN0V (REG_BASE + REG_OFFSET_WIN0V) #define REG_ADDR_WIN1V (REG_BASE + REG_OFFSET_WIN1V) #define REG_ADDR_WININ (REG_BASE + REG_OFFSET_WININ) #define REG_ADDR_WINOUT (REG_BASE + REG_OFFSET_WINOUT) #define REG_ADDR_MOSAIC (REG_BASE + REG_OFFSET_MOSAIC) #define REG_ADDR_BLDCNT (REG_BASE + REG_OFFSET_BLDCNT) #define REG_ADDR_BLDALPHA (REG_BASE + REG_OFFSET_BLDALPHA) #define REG_ADDR_BLDY (REG_BASE + REG_OFFSET_BLDY) #define REG_ADDR_SOUND1CNT_L (REG_BASE + REG_OFFSET_SOUND1CNT_L) #define REG_ADDR_NR10 (REG_BASE + REG_OFFSET_NR10) #define REG_ADDR_SOUND1CNT_H (REG_BASE + REG_OFFSET_SOUND1CNT_H) #define REG_ADDR_NR11 (REG_BASE + REG_OFFSET_NR11) #define REG_ADDR_NR12 (REG_BASE + REG_OFFSET_NR12) #define REG_ADDR_SOUND1CNT_X (REG_BASE + REG_OFFSET_SOUND1CNT_X) #define REG_ADDR_NR13 (REG_BASE + REG_OFFSET_NR13) #define REG_ADDR_NR14 (REG_BASE + REG_OFFSET_NR14) #define REG_ADDR_SOUND2CNT_L (REG_BASE + REG_OFFSET_SOUND2CNT_L) #define REG_ADDR_NR21 (REG_BASE + REG_OFFSET_NR21) #define REG_ADDR_NR22 (REG_BASE + REG_OFFSET_NR22) #define REG_ADDR_SOUND2CNT_H (REG_BASE + REG_OFFSET_SOUND2CNT_H) #define REG_ADDR_NR23 (REG_BASE + REG_OFFSET_NR23) #define REG_ADDR_NR24 (REG_BASE + REG_OFFSET_NR24) #define REG_ADDR_SOUND3CNT_L (REG_BASE + REG_OFFSET_SOUND3CNT_L) #define REG_ADDR_NR30 (REG_BASE + REG_OFFSET_NR30) #define REG_ADDR_SOUND3CNT_H (REG_BASE + REG_OFFSET_SOUND3CNT_H) #define REG_ADDR_NR31 (REG_BASE + REG_OFFSET_NR31) #define REG_ADDR_NR32 (REG_BASE + REG_OFFSET_NR32) #define REG_ADDR_SOUND3CNT_X (REG_BASE + REG_OFFSET_SOUND3CNT_X) #define REG_ADDR_NR33 (REG_BASE + REG_OFFSET_NR33) #define REG_ADDR_NR34 (REG_BASE + REG_OFFSET_NR34) #define REG_ADDR_SOUND4CNT_L (REG_BASE + REG_OFFSET_SOUND4CNT_L) #define REG_ADDR_NR41 (REG_BASE + REG_OFFSET_NR41) #define REG_ADDR_NR42 (REG_BASE + REG_OFFSET_NR42) #define REG_ADDR_SOUND4CNT_H (REG_BASE + REG_OFFSET_SOUND4CNT_H) #define REG_ADDR_NR43 (REG_BASE + REG_OFFSET_NR43) #define REG_ADDR_NR44 (REG_BASE + REG_OFFSET_NR44) #define REG_ADDR_SOUNDCNT_L (REG_BASE + REG_OFFSET_SOUNDCNT_L) #define REG_ADDR_NR50 (REG_BASE + REG_OFFSET_NR50) #define REG_ADDR_NR51 (REG_BASE + REG_OFFSET_NR51) #define REG_ADDR_SOUNDCNT_H (REG_BASE + REG_OFFSET_SOUNDCNT_H) #define REG_ADDR_SOUNDCNT_X (REG_BASE + REG_OFFSET_SOUNDCNT_X) #define REG_ADDR_NR52 (REG_BASE + REG_OFFSET_NR52) #define REG_ADDR_SOUNDBIAS (REG_BASE + REG_OFFSET_SOUNDBIAS) #define REG_ADDR_SOUNDBIAS_L (REG_BASE + REG_OFFSET_SOUNDBIAS_L) #define REG_ADDR_SOUNDBIAS_H (REG_BASE + REG_OFFSET_SOUNDBIAS_H) #define REG_ADDR_WAVE_RAM0 (REG_BASE + REG_OFFSET_WAVE_RAM0) #define REG_ADDR_WAVE_RAM1 (REG_BASE + REG_OFFSET_WAVE_RAM1) #define REG_ADDR_WAVE_RAM2 (REG_BASE + REG_OFFSET_WAVE_RAM2) #define REG_ADDR_WAVE_RAM3 (REG_BASE + REG_OFFSET_WAVE_RAM3) #define REG_ADDR_FIFO_A (REG_BASE + REG_OFFSET_FIFO_A) #define REG_ADDR_FIFO_B (REG_BASE + REG_OFFSET_FIFO_B) #define REG_ADDR_DMA0 (REG_BASE + REG_OFFSET_DMA0) #define REG_ADDR_DMA0SAD (REG_BASE + REG_OFFSET_DMA0SAD) #define REG_ADDR_DMA0DAD (REG_BASE + REG_OFFSET_DMA0DAD) #define REG_ADDR_DMA0CNT (REG_BASE + REG_OFFSET_DMA0CNT) #define REG_ADDR_DMA0CNT_L (REG_BASE + REG_OFFSET_DMA0CNT_L) #define REG_ADDR_DMA0CNT_H (REG_BASE + REG_OFFSET_DMA0CNT_H) #define REG_ADDR_DMA1 (REG_BASE + REG_OFFSET_DMA1) #define REG_ADDR_DMA1SAD (REG_BASE + REG_OFFSET_DMA1SAD) #define REG_ADDR_DMA1DAD (REG_BASE + REG_OFFSET_DMA1DAD) #define REG_ADDR_DMA1CNT (REG_BASE + REG_OFFSET_DMA1CNT) #define REG_ADDR_DMA1CNT_L (REG_BASE + REG_OFFSET_DMA1CNT_L) #define REG_ADDR_DMA1CNT_H (REG_BASE + REG_OFFSET_DMA1CNT_H) #define REG_ADDR_DMA2 (REG_BASE + REG_OFFSET_DMA2) #define REG_ADDR_DMA2SAD (REG_BASE + REG_OFFSET_DMA2SAD) #define REG_ADDR_DMA2DAD (REG_BASE + REG_OFFSET_DMA2DAD) #define REG_ADDR_DMA2CNT (REG_BASE + REG_OFFSET_DMA2CNT) #define REG_ADDR_DMA2CNT_L (REG_BASE + REG_OFFSET_DMA2CNT_L) #define REG_ADDR_DMA2CNT_H (REG_BASE + REG_OFFSET_DMA2CNT_H) #define REG_ADDR_DMA3 (REG_BASE + REG_OFFSET_DMA3) #define REG_ADDR_DMA3SAD (REG_BASE + REG_OFFSET_DMA3SAD) #define REG_ADDR_DMA3DAD (REG_BASE + REG_OFFSET_DMA3DAD) #define REG_ADDR_DMA3CNT (REG_BASE + REG_OFFSET_DMA3CNT) #define REG_ADDR_DMA3CNT_L (REG_BASE + REG_OFFSET_DMA3CNT_L) #define REG_ADDR_DMA3CNT_H (REG_BASE + REG_OFFSET_DMA3CNT_H) #define REG_ADDR_TMCNT (REG_BASE + REG_OFFSET_TMCNT) #define REG_ADDR_TMCNT_L (REG_BASE + REG_OFFSET_TMCNT_L) #define REG_ADDR_TMCNT_H (REG_BASE + REG_OFFSET_TMCNT_H) #define REG_ADDR_TM0CNT (REG_BASE + REG_OFFSET_TM0CNT) #define REG_ADDR_TM0CNT_L (REG_BASE + REG_OFFSET_TM0CNT_L) #define REG_ADDR_TM0CNT_H (REG_BASE + REG_OFFSET_TM0CNT_H) #define REG_ADDR_TM1CNT (REG_BASE + REG_OFFSET_TM1CNT) #define REG_ADDR_TM1CNT_L (REG_BASE + REG_OFFSET_TM1CNT_L) #define REG_ADDR_TM1CNT_H (REG_BASE + REG_OFFSET_TM1CNT_H) #define REG_ADDR_TM2CNT (REG_BASE + REG_OFFSET_TM2CNT) #define REG_ADDR_TM2CNT_L (REG_BASE + REG_OFFSET_TM2CNT_L) #define REG_ADDR_TM2CNT_H (REG_BASE + REG_OFFSET_TM2CNT_H) #define REG_ADDR_TM3CNT (REG_BASE + REG_OFFSET_TM3CNT) #define REG_ADDR_TM3CNT_L (REG_BASE + REG_OFFSET_TM3CNT_L) #define REG_ADDR_TM3CNT_H (REG_BASE + REG_OFFSET_TM3CNT_H) #define REG_ADDR_SIOCNT (REG_BASE + REG_OFFSET_SIOCNT) #define REG_ADDR_SIODATA8 (REG_BASE + REG_OFFSET_SIODATA8) #define REG_ADDR_SIODATA32 (REG_BASE + REG_OFFSET_SIODATA32) #define REG_ADDR_SIOMLT_SEND (REG_BASE + REG_OFFSET_SIOMLT_SEND) #define REG_ADDR_SIOMLT_RECV (REG_BASE + REG_OFFSET_SIOMLT_RECV) #define REG_ADDR_SIOMULTI0 (REG_BASE + REG_OFFSET_SIOMULTI0) #define REG_ADDR_SIOMULTI1 (REG_BASE + REG_OFFSET_SIOMULTI1) #define REG_ADDR_SIOMULTI2 (REG_BASE + REG_OFFSET_SIOMULTI2) #define REG_ADDR_SIOMULTI3 (REG_BASE + REG_OFFSET_SIOMULTI3) #define REG_ADDR_KEYINPUT (REG_BASE + REG_OFFSET_KEYINPUT) #define REG_ADDR_KEYCNT (REG_BASE + REG_OFFSET_KEYCNT) #define REG_ADDR_RCNT (REG_BASE + REG_OFFSET_RCNT) #define REG_ADDR_JOYCNT (REG_BASE + REG_OFFSET_JOYCNT) #define REG_ADDR_JOYSTAT (REG_BASE + REG_OFFSET_JOYSTAT) #define REG_ADDR_JOY_RECV (REG_BASE + REG_OFFSET_JOY_RECV) #define REG_ADDR_JOY_RECV_L (REG_BASE + REG_OFFSET_JOY_RECV_L) #define REG_ADDR_JOY_RECV_H (REG_BASE + REG_OFFSET_JOY_RECV_H) #define REG_ADDR_JOY_TRANS (REG_BASE + REG_OFFSET_JOY_TRANS) #define REG_ADDR_JOY_TRANS_L (REG_BASE + REG_OFFSET_JOY_TRANS_L) #define REG_ADDR_JOY_TRANS_H (REG_BASE + REG_OFFSET_JOY_TRANS_H) #define REG_ADDR_IME (REG_BASE + REG_OFFSET_IME) #define REG_ADDR_IE (REG_BASE + REG_OFFSET_IE) #define REG_ADDR_IF (REG_BASE + REG_OFFSET_IF) #define REG_ADDR_WAITCNT (REG_BASE + REG_OFFSET_WAITCNT) // I/O registers #define REG_DISPCNT (*(vu16 *)REG_ADDR_DISPCNT) #define REG_DISPSTAT (*(vu16 *)REG_ADDR_DISPSTAT) #define REG_VCOUNT (*(vu16 *)REG_ADDR_VCOUNT) #define REG_BG0CNT (*(vu16 *)REG_ADDR_BG0CNT) #define REG_BG1CNT (*(vu16 *)REG_ADDR_BG1CNT) #define REG_BG2CNT (*(vu16 *)REG_ADDR_BG2CNT) #define REG_BG3CNT (*(vu16 *)REG_ADDR_BG3CNT) #define REG_BG0HOFS (*(vu16 *)REG_ADDR_BG0HOFS) #define REG_BG0VOFS (*(vu16 *)REG_ADDR_BG0VOFS) #define REG_BG1HOFS (*(vu16 *)REG_ADDR_BG1HOFS) #define REG_BG1VOFS (*(vu16 *)REG_ADDR_BG1VOFS) #define REG_BG2HOFS (*(vu16 *)REG_ADDR_BG2HOFS) #define REG_BG2VOFS (*(vu16 *)REG_ADDR_BG2VOFS) #define REG_BG3HOFS (*(vu16 *)REG_ADDR_BG3HOFS) #define REG_BG3VOFS (*(vu16 *)REG_ADDR_BG3VOFS) #define REG_BG2PA (*(vu16 *)REG_ADDR_BG2PA) #define REG_BG2PB (*(vu16 *)REG_ADDR_BG2PB) #define REG_BG2PC (*(vu16 *)REG_ADDR_BG2PC) #define REG_BG2PD (*(vu16 *)REG_ADDR_BG2PD) #define REG_BG2X (*(vu32 *)REG_ADDR_BG2X) #define REG_BG2X_L (*(vu16 *)REG_ADDR_BG2X_L) #define REG_BG2X_H (*(vu16 *)REG_ADDR_BG2X_H) #define REG_BG2Y (*(vu32 *)REG_ADDR_BG2Y) #define REG_BG2Y_L (*(vu16 *)REG_ADDR_BG2Y_L) #define REG_BG2Y_H (*(vu16 *)REG_ADDR_BG2Y_H) #define REG_BG3PA (*(vu16 *)REG_ADDR_BG3PA) #define REG_BG3PB (*(vu16 *)REG_ADDR_BG3PB) #define REG_BG3PC (*(vu16 *)REG_ADDR_BG3PC) #define REG_BG3PD (*(vu16 *)REG_ADDR_BG3PD) #define REG_BG3X (*(vu32 *)REG_ADDR_BG3X) #define REG_BG3X_L (*(vu16 *)REG_ADDR_BG3X_L) #define REG_BG3X_H (*(vu16 *)REG_ADDR_BG3X_H) #define REG_BG3Y (*(vu32 *)REG_ADDR_BG3Y) #define REG_BG3Y_L (*(vu16 *)REG_ADDR_BG3Y_L) #define REG_BG3Y_H (*(vu16 *)REG_ADDR_BG3Y_H) #define REG_WIN0H (*(vu16 *)REG_ADDR_WIN0H) #define REG_WIN1H (*(vu16 *)REG_ADDR_WIN1H) #define REG_WIN0V (*(vu16 *)REG_ADDR_WIN0V) #define REG_WIN1V (*(vu16 *)REG_ADDR_WIN1V) #define REG_WININ (*(vu16 *)REG_ADDR_WININ) #define REG_WINOUT (*(vu16 *)REG_ADDR_WINOUT) #define REG_MOSAIC (*(vu16 *)REG_ADDR_MOSAIC) #define REG_BLDCNT (*(vu16 *)REG_ADDR_BLDCNT) #define REG_BLDALPHA (*(vu16 *)REG_ADDR_BLDALPHA) #define REG_BLDY (*(vu16 *)REG_ADDR_BLDY) #define REG_SOUND1CNT_L (*(vu16 *)REG_ADDR_SOUND1CNT_L) #define REG_NR10 (*(vu8 *)REG_ADDR_NR10) #define REG_SOUND1CNT_H (*(vu16 *)REG_ADDR_SOUND1CNT_H) #define REG_NR11 (*(vu8 *)REG_ADDR_NR11) #define REG_NR12 (*(vu8 *)REG_ADDR_NR12) #define REG_SOUND1CNT_X (*(vu16 *)REG_ADDR_SOUND1CNT_X) #define REG_NR13 (*(vu8 *)REG_ADDR_NR13) #define REG_NR14 (*(vu8 *)REG_ADDR_NR14) #define REG_SOUND2CNT_L (*(vu16 *)REG_ADDR_SOUND2CNT_L) #define REG_NR21 (*(vu8 *)REG_ADDR_NR21) #define REG_NR22 (*(vu8 *)REG_ADDR_NR22) #define REG_SOUND2CNT_H (*(vu16 *)REG_ADDR_SOUND2CNT_H) #define REG_NR23 (*(vu8 *)REG_ADDR_NR23) #define REG_NR24 (*(vu8 *)REG_ADDR_NR24) #define REG_SOUND3CNT_L (*(vu16 *)REG_ADDR_SOUND3CNT_L) #define REG_NR30 (*(vu8 *)REG_ADDR_NR30) #define REG_SOUND3CNT_H (*(vu16 *)REG_ADDR_SOUND3CNT_H) #define REG_NR31 (*(vu8 *)REG_ADDR_NR31) #define REG_NR32 (*(vu8 *)REG_ADDR_NR32) #define REG_SOUND3CNT_X (*(vu16 *)REG_ADDR_SOUND3CNT_X) #define REG_NR33 (*(vu8 *)REG_ADDR_NR33) #define REG_NR34 (*(vu8 *)REG_ADDR_NR34) #define REG_SOUND4CNT_L (*(vu16 *)REG_ADDR_SOUND4CNT_L) #define REG_NR41 (*(vu8 *)REG_ADDR_NR41) #define REG_NR42 (*(vu8 *)REG_ADDR_NR42) #define REG_SOUND4CNT_H (*(vu16 *)REG_ADDR_SOUND4CNT_H) #define REG_NR43 (*(vu8 *)REG_ADDR_NR43) #define REG_NR44 (*(vu8 *)REG_ADDR_NR44) #define REG_SOUNDCNT_L (*(vu16 *)REG_ADDR_SOUNDCNT_L) #define REG_NR50 (*(vu8 *)REG_ADDR_NR50) #define REG_NR51 (*(vu8 *)REG_ADDR_NR51) #define REG_SOUNDCNT_H (*(vu16 *)REG_ADDR_SOUNDCNT_H) #define REG_SOUNDCNT_X (*(vu16 *)REG_ADDR_SOUNDCNT_X) #define REG_NR52 (*(vu8 *)REG_ADDR_NR52) #define REG_SOUNDBIAS (*(vu16 *)REG_ADDR_SOUNDBIAS) #define REG_SOUNDBIAS_L (*(vu8 *)REG_ADDR_SOUNDBIAS_L) #define REG_SOUNDBIAS_H (*(vu8 *)REG_ADDR_SOUNDBIAS_H) #define REG_WAVE_RAM0 (*(vu32 *)REG_ADDR_WAVE_RAM0) #define REG_WAVE_RAM1 (*(vu32 *)REG_ADDR_WAVE_RAM1) #define REG_WAVE_RAM2 (*(vu32 *)REG_ADDR_WAVE_RAM2) #define REG_WAVE_RAM3 (*(vu32 *)REG_ADDR_WAVE_RAM3) #define REG_FIFO_A (*(vu32 *)REG_ADDR_FIFO_A) #define REG_FIFO_B (*(vu32 *)REG_ADDR_FIFO_B) #define REG_DMA0SAD (*(vu32 *)REG_ADDR_DMA0SAD) #define REG_DMA0DAD (*(vu32 *)REG_ADDR_DMA0DAD) #define REG_DMA0CNT (*(vu32 *)REG_ADDR_DMA0CNT) #define REG_DMA0CNT_L (*(vu16 *)REG_ADDR_DMA0CNT_L) #define REG_DMA0CNT_H (*(vu16 *)REG_ADDR_DMA0CNT_H) #define REG_DMA1SAD (*(vu32 *)REG_ADDR_DMA1SAD) #define REG_DMA1DAD (*(vu32 *)REG_ADDR_DMA1DAD) #define REG_DMA1CNT (*(vu32 *)REG_ADDR_DMA1CNT) #define REG_DMA1CNT_L (*(vu16 *)REG_ADDR_DMA1CNT_L) #define REG_DMA1CNT_H (*(vu16 *)REG_ADDR_DMA1CNT_H) #define REG_DMA2SAD (*(vu32 *)REG_ADDR_DMA2SAD) #define REG_DMA2DAD (*(vu32 *)REG_ADDR_DMA2DAD) #define REG_DMA2CNT (*(vu32 *)REG_ADDR_DMA2CNT) #define REG_DMA2CNT_L (*(vu16 *)REG_ADDR_DMA2CNT_L) #define REG_DMA2CNT_H (*(vu16 *)REG_ADDR_DMA2CNT_H) #define REG_DMA3SAD (*(vu32 *)REG_ADDR_DMA3SAD) #define REG_DMA3DAD (*(vu32 *)REG_ADDR_DMA3DAD) #define REG_DMA3CNT (*(vu32 *)REG_ADDR_DMA3CNT) #define REG_DMA3CNT_L (*(vu16 *)REG_ADDR_DMA3CNT_L) #define REG_DMA3CNT_H (*(vu16 *)REG_ADDR_DMA3CNT_H) #define REG_TMCNT(n) (*(vu16 *)(REG_ADDR_TMCNT + ((n) * 4))) #define REG_TM0CNT (*(vu32 *)REG_ADDR_TM0CNT) #define REG_TM0CNT_L (*(vu16 *)REG_ADDR_TM0CNT_L) #define REG_TM0CNT_H (*(vu16 *)REG_ADDR_TM0CNT_H) #define REG_TM1CNT (*(vu32 *)REG_ADDR_TM1CNT) #define REG_TM1CNT_L (*(vu16 *)REG_ADDR_TM1CNT_L) #define REG_TM1CNT_H (*(vu16 *)REG_ADDR_TM1CNT_H) #define REG_TM2CNT (*(vu32 *)REG_ADDR_TM2CNT) #define REG_TM2CNT_L (*(vu16 *)REG_ADDR_TM2CNT_L) #define REG_TM2CNT_H (*(vu16 *)REG_ADDR_TM2CNT_H) #define REG_TM3CNT (*(vu32 *)REG_ADDR_TM3CNT) #define REG_TM3CNT_L (*(vu16 *)REG_ADDR_TM3CNT_L) #define REG_TM3CNT_H (*(vu16 *)REG_ADDR_TM3CNT_H) #define REG_SIOCNT (*(vu16 *)REG_ADDR_SIOCNT) #define REG_SIOCNT_32 (*(vu32 *)REG_ADDR_SIOCNT) #define REG_SIODATA8 (*(vu16 *)REG_ADDR_SIODATA8) #define REG_SIODATA32 (*(vu32 *)REG_ADDR_SIODATA32) #define REG_SIOMLT_SEND (*(vu16 *)REG_ADDR_SIOMLT_SEND) #define REG_SIOMLT_RECV (*(vu64 *)REG_ADDR_SIOMLT_RECV) #define REG_SIOMULTI0 (*(vu16 *)REG_ADDR_SIOMULTI0) #define REG_SIOMULTI1 (*(vu16 *)REG_ADDR_SIOMULTI1) #define REG_SIOMULTI2 (*(vu16 *)REG_ADDR_SIOMULTI2) #define REG_SIOMULTI3 (*(vu16 *)REG_ADDR_SIOMULTI3) #define REG_KEYINPUT (*(vu16 *)REG_ADDR_KEYINPUT) #define REG_KEYCNT (*(vu16 *)REG_ADDR_KEYCNT) #define REG_RCNT (*(vu16 *)REG_ADDR_RCNT) #define REG_IME (*(vu16 *)REG_ADDR_IME) #define REG_IE (*(vu16 *)REG_ADDR_IE) #define REG_IF (*(vu16 *)REG_ADDR_IF) #define REG_WAITCNT (*(vu16 *)REG_ADDR_WAITCNT) // I/O register fields // DISPCNT #define DISPCNT_MODE_0 0x0000 // BG0: text, BG1: text, BG2: text, BG3: text #define DISPCNT_MODE_1 0x0001 // BG0: text, BG1: text, BG2: affine, BG3: off #define DISPCNT_MODE_2 0x0002 // BG0: off, BG1: off, BG2: affine, BG3: affine #define DISPCNT_MODE_3 0x0003 // Bitmap mode, 240x160, BGR555 color #define DISPCNT_MODE_4 0x0004 // Bitmap mode, 240x160, 256 color palette #define DISPCNT_MODE_5 0x0005 // Bitmap mode, 160x128, BGR555 color #define DISPCNT_OBJ_1D_MAP 0x0040 #define DISPCNT_FORCED_BLANK 0x0080 #define DISPCNT_BG0_ON 0x0100 #define DISPCNT_BG1_ON 0x0200 #define DISPCNT_BG2_ON 0x0400 #define DISPCNT_BG3_ON 0x0800 #define DISPCNT_BG_ALL_ON 0x0F00 #define DISPCNT_OBJ_ON 0x1000 #define DISPCNT_WIN0_ON 0x2000 #define DISPCNT_WIN1_ON 0x4000 #define DISPCNT_OBJWIN_ON 0x8000 // DISPSTAT #define DISPSTAT_VBLANK 0x0001 // in V-Blank #define DISPSTAT_HBLANK 0x0002 // in H-Blank #define DISPSTAT_VCOUNT 0x0004 // V-Count match #define DISPSTAT_VBLANK_INTR 0x0008 // V-Blank interrupt enabled #define DISPSTAT_HBLANK_INTR 0x0010 // H-Blank interrupt enabled #define DISPSTAT_VCOUNT_INTR 0x0020 // V-Count interrupt enabled // BGCNT #define BGCNT_PRIORITY(n) (n) // Values 0 - 3. Lower priority BGs will be drawn on top of higher priority BGs. #define BGCNT_CHARBASE(n) ((n) << 2) // Values 0 - 3. Base block for tile pixel data. #define BGCNT_MOSAIC 0x0040 #define BGCNT_16COLOR 0x0000 // 4 bits per pixel #define BGCNT_256COLOR 0x0080 // 8 bits per pixel #define BGCNT_SCREENBASE(n) ((n) << 8) // Values 0 - 31. Base block for tile map. #define BGCNT_WRAP 0x2000 // Only affects affine BGs. Text BGs wrap by default. #define BGCNT_TXT256x256 0x0000 // Internal screen size size of text mode BG in pixels. #define BGCNT_TXT512x256 0x4000 #define BGCNT_TXT256x512 0x8000 #define BGCNT_TXT512x512 0xC000 #define BGCNT_AFF128x128 0x0000 // Internal screen size size of affine mode BG in pixels. #define BGCNT_AFF256x256 0x4000 #define BGCNT_AFF512x512 0x8000 #define BGCNT_AFF1024x1024 0xC000 // WININ/OUT #define WININ_WIN0_BG0 (1 << 0) #define WININ_WIN0_BG1 (1 << 1) #define WININ_WIN0_BG2 (1 << 2) #define WININ_WIN0_BG3 (1 << 3) #define WININ_WIN0_BG_ALL (WININ_WIN0_BG0 | WININ_WIN0_BG1 | WININ_WIN0_BG2 | WININ_WIN0_BG3) #define WININ_WIN0_OBJ (1 << 4) #define WININ_WIN0_CLR (1 << 5) #define WININ_WIN0_ALL (WININ_WIN0_BG_ALL | WININ_WIN0_OBJ | WININ_WIN0_CLR) #define WININ_WIN1_BG0 (1 << 8) #define WININ_WIN1_BG1 (1 << 9) #define WININ_WIN1_BG2 (1 << 10) #define WININ_WIN1_BG3 (1 << 11) #define WININ_WIN1_BG_ALL (WININ_WIN1_BG0 | WININ_WIN1_BG1 | WININ_WIN1_BG2 | WININ_WIN1_BG3) #define WININ_WIN1_OBJ (1 << 12) #define WININ_WIN1_CLR (1 << 13) #define WININ_WIN1_ALL (WININ_WIN1_BG_ALL | WININ_WIN1_OBJ | WININ_WIN1_CLR) #define WINOUT_WIN01_BG0 (1 << 0) #define WINOUT_WIN01_BG1 (1 << 1) #define WINOUT_WIN01_BG2 (1 << 2) #define WINOUT_WIN01_BG3 (1 << 3) #define WINOUT_WIN01_BG_ALL (WINOUT_WIN01_BG0 | WINOUT_WIN01_BG1 | WINOUT_WIN01_BG2 | WINOUT_WIN01_BG3) #define WINOUT_WIN01_OBJ (1 << 4) #define WINOUT_WIN01_CLR (1 << 5) #define WINOUT_WIN01_ALL (WINOUT_WIN01_BG_ALL | WINOUT_WIN01_OBJ | WINOUT_WIN01_CLR) #define WINOUT_WINOBJ_BG0 (1 << 8) #define WINOUT_WINOBJ_BG1 (1 << 9) #define WINOUT_WINOBJ_BG2 (1 << 10) #define WINOUT_WINOBJ_BG3 (1 << 11) #define WINOUT_WINOBJ_BG_ALL (WINOUT_WINOBJ_BG0 | WINOUT_WINOBJ_BG1 | WINOUT_WINOBJ_BG2 | WINOUT_WINOBJ_BG3) #define WINOUT_WINOBJ_OBJ (1 << 12) #define WINOUT_WINOBJ_CLR (1 << 13) #define WINOUT_WINOBJ_ALL (WINOUT_WINOBJ_BG_ALL | WINOUT_WINOBJ_OBJ | WINOUT_WINOBJ_CLR) // BLDCNT // Bits 0-5 select layers for the 1st target #define BLDCNT_TGT1_BG0 (1 << 0) #define BLDCNT_TGT1_BG1 (1 << 1) #define BLDCNT_TGT1_BG2 (1 << 2) #define BLDCNT_TGT1_BG3 (1 << 3) #define BLDCNT_TGT1_OBJ (1 << 4) #define BLDCNT_TGT1_BD (1 << 5) #define BLDCNT_TGT1_ALL (BLDCNT_TGT1_BG0 | BLDCNT_TGT1_BG1 | BLDCNT_TGT1_BG2 | BLDCNT_TGT1_BG3 | BLDCNT_TGT1_OBJ | BLDCNT_TGT1_BD) // Bits 6-7 select the special effect #define BLDCNT_EFFECT_NONE (0 << 6) // no special effect #define BLDCNT_EFFECT_BLEND (1 << 6) // 1st+2nd targets mixed (controlled by BLDALPHA) #define BLDCNT_EFFECT_LIGHTEN (2 << 6) // 1st target becomes whiter (controlled by BLDY) #define BLDCNT_EFFECT_DARKEN (3 << 6) // 1st target becomes blacker (controlled by BLDY) // Bits 8-13 select layers for the 2nd target #define BLDCNT_TGT2_BG0 (1 << 8) #define BLDCNT_TGT2_BG1 (1 << 9) #define BLDCNT_TGT2_BG2 (1 << 10) #define BLDCNT_TGT2_BG3 (1 << 11) #define BLDCNT_TGT2_OBJ (1 << 12) #define BLDCNT_TGT2_BD (1 << 13) #define BLDCNT_TGT2_ALL (BLDCNT_TGT2_BG0 | BLDCNT_TGT2_BG1 | BLDCNT_TGT2_BG2 | BLDCNT_TGT2_BG3 | BLDCNT_TGT2_OBJ | BLDCNT_TGT2_BD) // BLDALPHA #define BLDALPHA_BLEND(target1, target2) (((target2) << 8) | (target1)) // SOUNDCNT_H #define SOUND_CGB_MIX_QUARTER 0x0000 #define SOUND_CGB_MIX_HALF 0x0001 #define SOUND_CGB_MIX_FULL 0x0002 #define SOUND_A_MIX_HALF 0x0000 #define SOUND_A_MIX_FULL 0x0004 #define SOUND_B_MIX_HALF 0x0000 #define SOUND_B_MIX_FULL 0x0008 #define SOUND_ALL_MIX_FULL 0x000E #define SOUND_A_RIGHT_OUTPUT 0x0100 #define SOUND_A_LEFT_OUTPUT 0x0200 #define SOUND_A_TIMER_0 0x0000 #define SOUND_A_TIMER_1 0x0400 #define SOUND_A_FIFO_RESET 0x0800 #define SOUND_B_RIGHT_OUTPUT 0x1000 #define SOUND_B_LEFT_OUTPUT 0x2000 #define SOUND_B_TIMER_0 0x0000 #define SOUND_B_TIMER_1 0x4000 #define SOUND_B_FIFO_RESET 0x8000 // SOUNDCNT_X #define SOUND_1_ON 0x0001 #define SOUND_2_ON 0x0002 #define SOUND_3_ON 0x0004 #define SOUND_4_ON 0x0008 #define SOUND_MASTER_ENABLE 0x0080 // DMA #define DMA_DEST_INC 0x0000 #define DMA_DEST_DEC 0x0020 #define DMA_DEST_FIXED 0x0040 #define DMA_DEST_RELOAD 0x0060 #define DMA_SRC_INC 0x0000 #define DMA_SRC_DEC 0x0080 #define DMA_SRC_FIXED 0x0100 #define DMA_REPEAT 0x0200 #define DMA_16BIT 0x0000 #define DMA_32BIT 0x0400 #define DMA_DREQ_ON 0x0800 #define DMA_START_NOW 0x0000 #define DMA_START_VBLANK 0x1000 #define DMA_START_HBLANK 0x2000 #define DMA_START_SPECIAL 0x3000 #define DMA_START_MASK 0x3000 #define DMA_INTR_ENABLE 0x4000 #define DMA_ENABLE 0x8000 // timer #define TIMER_1CLK 0x00 #define TIMER_64CLK 0x01 #define TIMER_256CLK 0x02 #define TIMER_1024CLK 0x03 #define TIMER_INTR_ENABLE 0x40 #define TIMER_ENABLE 0x80 // serial // serial #define SIO_ID 0x0030 // Communication ID #define SIO_8BIT_MODE 0x0000 // Normal 8-bit communication mode #define SIO_32BIT_MODE 0x1000 // Normal 32-bit communication mode #define SIO_MULTI_MODE 0x2000 // Multi-player communication mode #define SIO_UART_MODE 0x3000 // UART communication mode #define SIO_SCK_OUT 0x0000 // Select external clock #define SIO_SCK_IN 0x0001 // Select internal clock #define SIO_IN_SCK_256K 0x0000 // Select internal clock 256KHz #define SIO_IN_SCK_2M 0x0002 // Select 2MHz #define SIO_ACK_RECV 0x0004 // Request transfer #define SIO_ACK_SEND 0x0008 // Enable transfer #define SIO_9600_BPS 0x0000 // baud rate 9600 bps #define SIO_38400_BPS 0x0001 // 38400 bps #define SIO_57600_BPS 0x0002 // 57600 bps #define SIO_115200_BPS 0x0003 // 115200 bps #define SIO_MULTI_CONNECT 0x0004 // Connecting multi-play communication #define SIO_MULTI_DISCONNECT 0x0000 // Disconnect #define SIO_MULTI_PARENT 0x0008 // Multi-play communication Connect master #define SIO_MULTI_CHILD 0x0000 // Connect slave #define SIO_MULTI_SI 0x0004 // Multi-play communication SI terminal #define SIO_MULTI_SD 0x0008 // SD terminal #define SIO_MULTI_BUSY 0x0080 // Multi-play communicating #define SIO_CTS_ENABLE 0x0004 // Enable UART send enable signal #define SIO_UART_7BIT 0x0000 // UART communication data length 7 bit #define SIO_UART_8BIT 0x0080 // 8 bit #define SIO_ERROR 0x0040 // Detect error #define SIO_START 0x0080 // Start transfer #define SIO_ENABLE 0x0080 // Enable SIO #define SIO_PARITY_ENABLE 0x0200 // Enable parity #define SIO_PARITY_EVEN 0x0000 // Even parity #define SIO_PARITY_ODD 0x0008 // Odd parity #define SIO_TRANS_ENABLE 0x0400 // Enable transmitter #define SIO_TRANS_DATA_FULL 0x0010 // Transmitted data full #define SIO_RECV_ENABLE 0x0800 // Enable receiver #define SIO_RECV_DATA_EMPTY 0x0020 // No data received #define SIO_INTR_ENABLE 0x4000 // Enable interrupt request #define SIO_MULTI_SI_SHIFT 2 #define SIO_MULTI_SI_MASK 0x1 #define SIO_MULTI_DI_SHIFT 3 #define SIO_MULTI_DI_MASK 0x1 // keys #define A_BUTTON 0x0001 #define B_BUTTON 0x0002 #define SELECT_BUTTON 0x0004 #define START_BUTTON 0x0008 #define DPAD_RIGHT 0x0010 #define DPAD_LEFT 0x0020 #define DPAD_UP 0x0040 #define DPAD_DOWN 0x0080 #define R_BUTTON 0x0100 #define L_BUTTON 0x0200 #define KEYS_MASK 0x03FF #define KEY_INTR_ENABLE 0x0400 #define KEY_OR_INTR 0x0000 #define KEY_AND_INTR 0x8000 #define DPAD_ANY 0x00F0 #define DPAD_SIDEWAYS (DPAD_LEFT | DPAD_RIGHT) #define JOY_EXCL_DPAD 0x030F // interrupt flags #define INTR_FLAG_VBLANK (1 << 0) #define INTR_FLAG_HBLANK (1 << 1) #define INTR_FLAG_VCOUNT (1 << 2) #define INTR_FLAG_TIMER0 (1 << 3) #define INTR_FLAG_TIMER1 (1 << 4) #define INTR_FLAG_TIMER2 (1 << 5) #define INTR_FLAG_TIMER3 (1 << 6) #define INTR_FLAG_SERIAL (1 << 7) #define INTR_FLAG_DMA0 (1 << 8) #define INTR_FLAG_DMA1 (1 << 9) #define INTR_FLAG_DMA2 (1 << 10) #define INTR_FLAG_DMA3 (1 << 11) #define INTR_FLAG_KEYPAD (1 << 12) #define INTR_FLAG_GAMEPAK (1 << 13) // WAITCNT #define WAITCNT_SRAM_4 (0 << 0) #define WAITCNT_SRAM_3 (1 << 0) #define WAITCNT_SRAM_2 (2 << 0) #define WAITCNT_SRAM_8 (3 << 0) #define WAITCNT_SRAM_MASK (3 << 0) #define WAITCNT_WS0_N_4 (0 << 2) #define WAITCNT_WS0_N_3 (1 << 2) #define WAITCNT_WS0_N_2 (2 << 2) #define WAITCNT_WS0_N_8 (3 << 2) #define WAITCNT_WS0_N_MASK (3 << 2) #define WAITCNT_WS0_S_2 (0 << 4) #define WAITCNT_WS0_S_1 (1 << 4) #define WAITCNT_WS1_N_4 (0 << 5) #define WAITCNT_WS1_N_3 (1 << 5) #define WAITCNT_WS1_N_2 (2 << 5) #define WAITCNT_WS1_N_8 (3 << 5) #define WAITCNT_WS1_N_MASK (3 << 5) #define WAITCNT_WS1_S_4 (0 << 7) #define WAITCNT_WS1_S_1 (1 << 7) #define WAITCNT_WS2_N_4 (0 << 8) #define WAITCNT_WS2_N_3 (1 << 8) #define WAITCNT_WS2_N_2 (2 << 8) #define WAITCNT_WS2_N_8 (3 << 8) #define WAITCNT_WS2_N_MASK (3 << 8) #define WAITCNT_WS2_S_8 (0 << 10) #define WAITCNT_WS2_S_1 (1 << 10) #define WAITCNT_PHI_OUT_NONE (0 << 11) #define WAITCNT_PHI_OUT_4MHZ (1 << 11) #define WAITCNT_PHI_OUT_8MHZ (2 << 11) #define WAITCNT_PHI_OUT_16MHZ (3 << 11) #define WAITCNT_PHI_OUT_MASK (3 << 11) #define WAITCNT_PREFETCH_ENABLE (1 << 14) #define WAITCNT_AGB (0 << 15) #define WAITCNT_CGB (1 << 15) #endif // GUARD_GBA_IO_REG_H #ifndef GUARD_GBA_ISAGBPRINT_H #define GUARD_GBA_ISAGBPRINT_H #ifdef NDEBUG #define AGBPrintInit() #define AGBPutc(cChr) #define AGBPrint(pBuf) #define AGBPrintf(pBuf, ...) #define AGBPrintFlush1Block() #define AGBPrintFlush() #define AGBAssert(pFile, nLine, pExpression, nStopProgram) #else void AGBPrintInit(void); void AGBPutc(const char cChr); void AGBPrint(const char *pBuf); void AGBPrintf(const char *pBuf, ...); void AGBPrintFlush1Block(void); void AGBPrintFlush(void); void AGBAssert(const char *pFile, int nLine, const char *pExpression, int nStopProgram); #endif #undef AGB_ASSERT #ifdef NDEBUG #define AGB_ASSERT(exp) #else #define AGB_ASSERT(exp) (exp) ? ((void*)0) : AGBAssert(__FILE__, __LINE__, #exp, 1); #endif #undef AGB_WARNING #ifdef NDEBUG #define AGB_WARNING(exp) #else #define AGB_WARNING(exp) (exp) ? ((void*)0) : AGBAssert(__FILE__, __LINE__, #exp, 0); #endif // for matching purposes #ifdef NDEBUG #define AGB_ASSERT_EX(exp, file, line) #else #define AGB_ASSERT_EX(exp, file, line) (exp) ? ((void*)0) : AGBAssert(file, line, #exp, 1); #endif #ifdef NDEBUG #define AGB_WARNING_EX(exp, file, line) #else #define AGB_WARNING_EX(exp, file, line) (exp) ? ((void*)0) : AGBAssert(file, line, #exp, 0); #endif #endif // GUARD_GBA_ISAGBPRINT_H #ifndef GUARD_GBA_MACRO_H #define GUARD_GBA_MACRO_H #define CPU_FILL(value, dest, size, bit) \ { \ vu##bit tmp = (vu##bit)(value); \ CpuSet((void *)&tmp, \ dest, \ CPU_SET_##bit##BIT | CPU_SET_SRC_FIXED | ((size)/(bit/8) & 0x1FFFFF)); \ } #define CpuFill16(value, dest, size) CPU_FILL(value, dest, size, 16) #define CpuFill32(value, dest, size) CPU_FILL(value, dest, size, 32) #define CPU_COPY(src, dest, size, bit) CpuSet(src, dest, CPU_SET_##bit##BIT | ((size)/(bit/8) & 0x1FFFFF)) #define CpuCopy16(src, dest, size) CPU_COPY(src, dest, size, 16) #define CpuCopy32(src, dest, size) CPU_COPY(src, dest, size, 32) #define CpuFastFill(value, dest, size) \ { \ vu32 tmp = (vu32)(value); \ CpuFastSet((void *)&tmp, \ dest, \ CPU_FAST_SET_SRC_FIXED | ((size)/(32/8) & 0x1FFFFF)); \ } #define CpuFastFill16(value, dest, size) CpuFastFill(((value) << 16) | (value), (dest), (size)) #define CpuFastCopy(src, dest, size) CpuFastSet(src, dest, ((size)/(32/8) & 0x1FFFFF)) #define DmaSet(dmaNum, src, dest, control) \ { \ vu32 *dmaRegs = (vu32 *)REG_ADDR_DMA##dmaNum; \ dmaRegs[0] = (vu32)(src); \ dmaRegs[1] = (vu32)(dest); \ dmaRegs[2] = (vu32)(control); \ dmaRegs[2]; \ } #define DMA_FILL(dmaNum, value, dest, size, bit) \ { \ vu##bit tmp = (vu##bit)(value); \ DmaSet(dmaNum, \ &tmp, \ dest, \ (DMA_ENABLE | DMA_START_NOW | DMA_##bit##BIT | DMA_SRC_FIXED | DMA_DEST_INC) << 16 \ | ((size)/(bit/8))); \ } #define DmaFill16(dmaNum, value, dest, size) DMA_FILL(dmaNum, value, dest, size, 16) #define DmaFill32(dmaNum, value, dest, size) DMA_FILL(dmaNum, value, dest, size, 32) // Note that the DMA clear macros cause the DMA control value to be calculated // at runtime rather than compile time. The size is divided by the DMA transfer // unit size (2 or 4 bytes) and then combined with the DMA control flags using a // bitwise OR operation. #define DMA_CLEAR(dmaNum, dest, size, bit) \ { \ vu##bit *_dest = (vu##bit *)(dest); \ u32 _size = size; \ DmaFill##bit(dmaNum, 0, _dest, _size); \ } #define DmaClear16(dmaNum, dest, size) DMA_CLEAR(dmaNum, dest, size, 16) #define DmaClear32(dmaNum, dest, size) DMA_CLEAR(dmaNum, dest, size, 32) #define DMA_COPY(dmaNum, src, dest, size, bit) \ DmaSet(dmaNum, \ src, \ dest, \ (DMA_ENABLE | DMA_START_NOW | DMA_##bit##BIT | DMA_SRC_INC | DMA_DEST_INC) << 16 \ | ((size)/(bit/8))) #define DmaCopy16(dmaNum, src, dest, size) DMA_COPY(dmaNum, src, dest, size, 16) #define DmaCopy32(dmaNum, src, dest, size) DMA_COPY(dmaNum, src, dest, size, 32) #define DmaStop(dmaNum) \ { \ vu16 *dmaRegs = (vu16 *)REG_ADDR_DMA##dmaNum; \ dmaRegs[5] &= ~(DMA_START_MASK | DMA_DREQ_ON | DMA_REPEAT); \ dmaRegs[5] &= ~DMA_ENABLE; \ dmaRegs[5]; \ } #define DmaCopyLarge(dmaNum, src, dest, size, block, bit) \ { \ const void *_src = src; \ void *_dest = (void *)(dest); \ u32 _size = size; \ while (1) \ { \ DmaCopy##bit(dmaNum, _src, _dest, (block)); \ _src += (block); \ _dest += (block); \ _size -= (block); \ if (_size <= (block)) \ { \ DmaCopy##bit(dmaNum, _src, _dest, _size); \ break; \ } \ } \ } #define DmaClearLarge(dmaNum, dest, size, block, bit) \ { \ void *_dest = dest; \ u32 _size = size; \ while (1) \ { \ DmaFill##bit(dmaNum, 0, _dest, (block)); \ _dest += (block); \ _size -= (block); \ if (_size <= (block)) \ { \ DmaFill##bit(dmaNum, 0, _dest, _size); \ break; \ } \ } \ } #define DmaCopyLarge16(dmaNum, src, dest, size, block) DmaCopyLarge(dmaNum, src, dest, size, block, 16) #define DmaCopyLarge32(dmaNum, src, dest, size, block) DmaCopyLarge(dmaNum, src, dest, size, block, 32) #define DmaClearLarge16(dmaNum, dest, size, block) DmaClearLarge(dmaNum, dest, size, block, 16) #define DmaClearLarge32(dmaNum, dest, size, block) DmaClearLarge(dmaNum, dest, size, block, 32) #define DmaCopyDefvars(dmaNum, src, dest, size, bit) \ { \ const void *_src = src; \ void *_dest = (void *)(dest); \ u32 _size = size; \ DmaCopy##bit(dmaNum, _src, _dest, _size); \ } #define DmaCopy16Defvars(dmaNum, src, dest, size) DmaCopyDefvars(dmaNum, src, dest, size, 16) #define DmaCopy32Defvars(dmaNum, src, dest, size) DmaCopyDefvars(dmaNum, src, dest, size, 32) #define DmaFillLarge(dmaNum, fillval, dest, size, block, bit) \ { \ void *_dest = (void *)(dest); \ u32 _size = (u32)(size); \ while (1) \ { \ DmaFill##bit(dmaNum, fillval, _dest, (block)); \ _dest += (block); \ _size -= (block); \ if (_size <= (block)) \ { \ DmaFill##bit(dmaNum, fillval, _dest, _size); \ break; \ } \ } \ } #define DmaFill16Large(dmaNum, fillval, dest, size, block) DmaFillLarge(dmaNum, fillval, dest, size, block, 16) #define DmaFill32Large(dmaNum, fillval, dest, size, block) DmaFillLarge(dmaNum, fillval, dest, size, block, 32) #define DmaFillDefvars(dmaNum, fillval, dest, size, bit) \ { \ void *_dest = (void *)(dest); \ u32 _size = (u##bit)(size); \ DmaFill##bit(dmaNum, fillval, _dest, _size); \ } #define DmaFill16Defvars(dmaNum, fillval, dest, size) DmaFillDefvars(dmaNum, fillval, dest, size, 16) #define DmaFill32Defvars(dmaNum, fillval, dest, size) DmaFillDefvars(dmaNum, fillval, dest, size, 32) #define DmaWait(dmaNum) \ { \ vu32 *dmaRegs = (vu32 *)REG_ADDR_DMA##dmaNum; \ while (dmaRegs[2] & (DMA_ENABLE << 16)) \ ; \ } // from pokeemerald // Maximum amount of data we will transfer in one operation #define MAX_DMA_BLOCK_SIZE 0x1000 #define MAX_DMA_REQUESTS 128 #define DMA_REQUEST_COPY32 1 #define DMA_REQUEST_FILL32 2 #define DMA_REQUEST_COPY16 3 #define DMA_REQUEST_FILL16 4 #define Dma3CopyLarge_(src, dest, size, bit) \ { \ const void *_src = src; \ void *_dest = dest; \ u32 _size = size; \ while (1) \ { \ if (_size <= MAX_DMA_BLOCK_SIZE) \ { \ DmaCopy##bit(3, _src, _dest, _size); \ break; \ } \ DmaCopy##bit(3, _src, _dest, MAX_DMA_BLOCK_SIZE); \ _src += MAX_DMA_BLOCK_SIZE; \ _dest += MAX_DMA_BLOCK_SIZE; \ _size -= MAX_DMA_BLOCK_SIZE; \ } \ } #define Dma3CopyLarge16_(src, dest, size) Dma3CopyLarge_(src, dest, size, 16) #define Dma3CopyLarge32_(src, dest, size) Dma3CopyLarge_(src, dest, size, 32) #define Dma3FillLarge_(value, dest, size, bit) \ { \ void *_dest = dest; \ u32 _size = size; \ while (1) \ { \ if (_size <= MAX_DMA_BLOCK_SIZE) \ { \ DmaFill##bit(3, value, _dest, _size); \ break; \ } \ DmaFill##bit(3, value, _dest, MAX_DMA_BLOCK_SIZE); \ _dest += MAX_DMA_BLOCK_SIZE; \ _size -= MAX_DMA_BLOCK_SIZE; \ } \ } #define Dma3FillLarge16_(value, dest, size) Dma3FillLarge_(value, dest, size, 16) #define Dma3FillLarge32_(value, dest, size) Dma3FillLarge_(value, dest, size, 32) #endif // GUARD_GBA_MACRO_H #ifndef GUARD_GBA_SYSCALL_H #define GUARD_GBA_SYSCALL_H #define RESET_EWRAM 0x01 #define RESET_IWRAM 0x02 #define RESET_PALETTE 0x04 #define RESET_VRAM 0x08 #define RESET_OAM 0x10 #define RESET_SIO_REGS 0x20 #define RESET_SOUND_REGS 0x40 #define RESET_REGS 0x80 #define RESET_ALL 0xFF void SoftReset(u32 resetFlags); void SoftResetExram(u32 resetFlags); void RegisterRamReset(u32 resetFlags); void VBlankIntrWait(void); u16 Sqrt(u32 num); u16 ArcTan2(s16 x, s16 y); #define CPU_SET_SRC_FIXED 0x01000000 #define CPU_SET_16BIT 0x00000000 #define CPU_SET_32BIT 0x04000000 void CpuSet(const void *src, void *dest, u32 control); #define CPU_FAST_SET_SRC_FIXED 0x01000000 void CpuFastSet(const void *src, void *dest, u32 control); void BgAffineSet(struct BgAffineSrcData *src, struct BgAffineDstData *dest, s32 count); void ObjAffineSet(struct ObjAffineSrcData *src, void *dest, s32 count, s32 offset); void LZ77UnCompWram(const void *src, void *dest); void LZ77UnCompVram(const void *src, void *dest); void RLUnCompWram(const void *src, void *dest); void RLUnCompVram(const void *src, void *dest); int MultiBoot(struct MultiBootParam *mp); s32 Div(s32 num, s32 denom); s32 Mod(s32 num, s32 denom); void SoundBiasReset(void); void SoundBiasSet(void); #endif // GUARD_GBA_SYSCALL_H #ifndef GUARD_GBA_GBA_H #define GUARD_GBA_GBA_H #endif // GUARD_GBA_GBA_H #ifndef GUARD_GLOBAL_H #define GUARD_GLOBAL_H #define CONST_DATA __attribute__((section(".data"))) // #include "types.h" // #include "variables.h" #define SIO_MULTI_CNT ((volatile struct SioMultiCnt *)REG_ADDR_SIOCNT) typedef void (*VoidFn)(void); // helper macros #if ((defined PORTABLE) || (defined NON_MATCHING)) #define BUG_FIX #define UB_FIX #endif #if ((defined PORTABLE) && !(defined NON_MATCHING)) #define NON_MATCHING 1 #endif #ifdef NON_MATCHING #define ASM_FUNC(path, decl) #else #define ASM_FUNC(path, decl) \ NAKED decl { asm(".include " #path); } #endif #ifdef NON_MATCHING #define NONMATCH(path, decl) decl #define END_NONMATCH #else #define NONMATCH(path, decl) \ NAKED decl \ { \ asm(".include " #path); \ if (0) #define END_NONMATCH } #endif /// IDE support #if defined(__APPLE__) || defined(__CYGWIN__) || defined(__INTELLISENSE__) // We define these when using certain IDEs to fool preproc #define _(x) (x) #define __(x) (x) #define INCBIN(...) \ { \ 0 \ } #define INCBIN_U8 INCBIN #define INCBIN_U16 INCBIN #define INCBIN_U32 INCBIN #define INCBIN_S8 INCBIN #define INCBIN_S16 INCBIN #define INCBIN_S32 INCBIN #endif // IDE support #define ARRAY_COUNT(array) (sizeof(array) / sizeof((array)[0])) // Converts a number to Q8.8 fixed-point format #define Q_8_8(n) ((s16)((n)*256)) // Converts a number to Q16.16 fixed-point format (<< 0x10) #define Q_16_16(n) ((s32)((n)*0x10000)) // Converts a number to Q4.12 fixed-point format #define Q_4_12(n) ((s16)((n)*4096)) // Converts a number to Q2.14 fixed-point format #define Q_2_14(n) ((s16)((n)*0x4000)) // Converts a number to Q20.12 fixed-point format #define Q_20_12(n) ((s32)((n)*4096)) // Converts a number to Q24.8 fixed-point format #define Q_24_8(n) ((s32)((n)*256)) #define Q_24_8_FRAC(n) ((u8)(n)) // This may be the "real" version as we are seeing better matches with // it in some cases #define Q_24_8_NEW(n) ((s32)((n) << 8)) // Converts a Q8.8 fixed-point format number to a regular integer #define Q_8_8_TO_INT(n) ((int)((n) >> 8)) // Converts a Q4.12 fixed-point format number to a regular integer #define Q_4_12_TO_INT(n) ((int)((n) >> 12)) // Converts a Q2.12 fixed-point format number to a regular integer #define Q_2_14_TO_INT(n) ((int)((n) >> 14)) // Converts a Q24.8 fixed-point format number to a regular integer #define Q_24_8_TO_INT(n) ((int)((n) >> 8)) // Converts a Q20.12 fixed-point format number to a regular integer #define Q_20_12_TO_INT(n) ((int)((n) >> 12)) // Converts a Q16.16 fixed-point format number to a regular integer #define Q_16_16_TO_INT(n) ((int)((n) >> 0x10)) // Converts a Q2.12 fixed-point format number to a Q24.8 fixed point number #define Q_2_14_TO_Q_24_8(n) ((int)((n) >> 6)) #define Q_24_8_MULTIPLY(intVal, floatVal) Q_24_8_TO_INT((intVal)*Q_24_8(floatVal)) /* * Aliases for common macros */ // Converts a number to Q24.8 fixed-point format #define Q(n) Q_24_8(n) // Converts a number to Q24.8 fixed-point format #define QS(n) Q_24_8_NEW(n) // Converts a Q24.8 fixed-point format number to a regular integer #define I(n) Q_24_8_TO_INT(n) #define RED_VALUE(color) (((color) >> 0) & 0x1F) #define GREEN_VALUE(color) (((color) >> 5) & 0x1F) #define BLUE_VALUE(color) (((color) >> 10) & 0x1F) #define MIN(a, b) (((a) < (b)) ? (a) : (b)) #define MAX(a, b) (((a) > (b)) ? (a) : (b)) #define CLAMP(value, min, max) \ ({ \ s32 clamped; \ if ((value) < (min)) { \ clamped = (min); \ } else { \ clamped = (value) > (max) ? (max) : (value); \ } \ clamped; \ }) #define CLAMP_T(type, value, min, max) \ ({ \ type clamped; \ if ((value) >= (min)) { \ clamped = (value) > (max) ? (max) : (value); \ } else { \ clamped = (min); \ } \ clamped; \ }) #define CLAMP_16(value, min, max) CLAMP_T(s16, value, min, max) #define CLAMP_32(value, min, max) CLAMP_T(s32, value, min, max) #define CLAMP_INLINE(var, min, max) \ ({ \ if ((var) < (min)) { \ var = (min); \ } else if ((var) > (max)) { \ var = (max); \ } \ }) #define CLAMP_INLINE_NO_ELSE(var, min, max) \ ({ \ if ((var) < (min)) { \ var = (min); \ } \ \ if ((var) > (max)) { \ var = (max); \ } \ }) #define CLAMP_INLINE_NO_ELSE_2(var, min, max) \ ({ \ if ((var) > (max)) { \ var = (max); \ } \ \ if ((var) < (min)) { \ var = (min); \ } \ }) #define CLAMP_INLINE2(var, min, max) \ ({ \ if ((var) > (max)) { \ var = (max); \ } else if ((var) < (min)) { \ var = (min); \ } \ }) #define ABS(aValue) ((aValue) >= 0 ? (aValue) : -(aValue)) #define RECT_DISTANCE(aXA, aYA, aXB, aYB) (ABS((aXA) - (aXB)) + ABS((aYA) - (aYB))) #define GetBit(x, y) (((x) >> (y)) & 1) // 60 is not exactly true as the GBA's FPS, but it's what they went // with for the calculation #define GBA_FRAMES_PER_SECOND 60 // TODO: fix casts here(?) #define XOR_SWAP(a, b) \ a ^= (u8)b; \ b ^= (u8)a; \ a = ((u8)b ^ (u8)a); // TODO: fix casts here #define SWAP_AND_NEGATE(a, b) \ a ^= (u8)b; \ b ^= (u8)a; \ a = ((u8)b ^ (u8)a) * -1; \ b = (u8)b * -1; #define NEGATE(var) \ ({ \ s32 temp = var; \ var = -temp; \ }) #define DIRECT_NEGATE(var) (var = -var;) typedef struct { s16 x; s16 y; } Vec2_16; typedef struct { u16 x; u16 y; } Vec2_u16; typedef struct { s32 x; s32 y; } Vec2_32; typedef struct { u8 reserved : 4; u8 compressedType : 4; u32 size : 24; void *data; } RLCompressed; struct BlendRegs { u16 bldCnt; u16 bldAlpha; u16 bldY; }; // TODO: Should this be in a GBA-specific header file? #define NUM_AFFINE_BACKGROUNDS 2 // Values to be passed top the affine registers // (used by BG2/BG3 in affine screen modes) typedef struct { /* 0x00 */ u16 pa, pb, pc, pd; /* 0x08 */ u32 x, y; } BgAffineReg; // TODO: Find better place for this typedef void (*HBlankFunc)(int_vcount vcount); typedef void (*IntrFunc)(void); typedef void (*FuncType_030053A0)(void); typedef u32 (*SpriteUpdateFunc)(void); extern void *iwram_end; extern void *ewram_end; extern void *rom_footer; #endif // GUARD_GLOBAL_H #ifndef GUARD_M4A_INTERNAL_H #define GUARD_M4A_INTERNAL_H // ASCII encoding of 'Smsh' in reverse // This is presumably short for SMASH, the developer of MKS4AGB. #define ID_NUMBER 0x68736D53 #define C_V 0x40 // center value for PAN, BEND, and TUNE #define SOUND_MODE_REVERB_VAL 0x0000007F #define SOUND_MODE_REVERB_SET 0x00000080 #define SOUND_MODE_MAXCHN 0x00000F00 #define SOUND_MODE_MAXCHN_SHIFT 8 #define SOUND_MODE_MASVOL 0x0000F000 #define SOUND_MODE_MASVOL_SHIFT 12 #define SOUND_MODE_FREQ_05734 0x00010000 #define SOUND_MODE_FREQ_07884 0x00020000 #define SOUND_MODE_FREQ_10512 0x00030000 #define SOUND_MODE_FREQ_13379 0x00040000 #define SOUND_MODE_FREQ_15768 0x00050000 #define SOUND_MODE_FREQ_18157 0x00060000 #define SOUND_MODE_FREQ_21024 0x00070000 #define SOUND_MODE_FREQ_26758 0x00080000 #define SOUND_MODE_FREQ_31536 0x00090000 #define SOUND_MODE_FREQ_36314 0x000A0000 #define SOUND_MODE_FREQ_40137 0x000B0000 #define SOUND_MODE_FREQ_42048 0x000C0000 #define SOUND_MODE_FREQ 0x000F0000 #define SOUND_MODE_FREQ_SHIFT 16 #define SOUND_MODE_DA_BIT_9 0x00800000 #define SOUND_MODE_DA_BIT_8 0x00900000 #define SOUND_MODE_DA_BIT_7 0x00A00000 #define SOUND_MODE_DA_BIT_6 0x00B00000 #define SOUND_MODE_DA_BIT 0x00B00000 #define SOUND_MODE_DA_BIT_SHIFT 20 struct WaveData { u16 type; u16 status; u32 freq; u32 loopStart; u32 size; // number of samples s8 data[1]; // samples }; #define TONEDATA_TYPE_CGB 0x07 #define TONEDATA_TYPE_FIX 0x08 #define TONEDATA_TYPE_SPL 0x40 // key split #define TONEDATA_TYPE_RHY 0x80 // rhythm #define TONEDATA_P_S_PAN 0xc0 #define TONEDATA_P_S_PAM TONEDATA_P_S_PAN struct ToneData { u8 type; u8 key; u8 length; // sound length (compatible sound) u8 pan_sweep; // pan or sweep (compatible sound ch. 1) struct WaveData *wav; u8 attack; u8 decay; u8 sustain; u8 release; }; struct CgbChannel { u8 sf; u8 ty; u8 rightVolume; u8 leftVolume; u8 at; u8 de; u8 su; u8 re; u8 ky; u8 ev; u8 eg; u8 ec; u8 echoVolume; u8 echoLength; u8 d1; u8 d2; u8 gt; u8 mk; u8 ve; u8 pr; u8 rp; u8 d3[3]; u8 d5; u8 sg; u8 n4; u8 pan; u8 panMask; u8 mo; u8 le; u8 sw; u32 fr; u32 *wp; u32 cp; u32 tp; u32 pp; u32 np; u8 d4[8]; }; struct MusicPlayerTrack; struct SoundChannel { u8 status; u8 type; u8 rightVolume; u8 leftVolume; u8 attack; u8 decay; u8 sustain; u8 release; u8 ky; u8 ev; u8 er; u8 el; u8 echoVolume; u8 echoLength; u8 d1; u8 d2; u8 gt; u8 mk; u8 ve; u8 pr; u8 rp; u8 d3[3]; u32 ct; u32 fw; u32 freq; struct WaveData *wav; u32 cp; struct MusicPlayerTrack *track; u32 pp; u32 np; u32 d4; u16 xpi; u16 xpc; }; #define MAX_DIRECTSOUND_CHANNELS 12 #define PCM_DMA_BUF_SIZE 1584 // size of Direct Sound buffer struct MusicPlayerInfo; typedef void (*MPlayFunc)(); typedef void (*PlyNoteFunc)(u32, struct MusicPlayerInfo *, struct MusicPlayerTrack *); typedef void (*CgbSoundFunc)(void); typedef void (*CgbOscOffFunc)(u8); typedef u32 (*MidiKeyToCgbFreqFunc)(u8, u8, u8); typedef void (*ExtVolPitFunc)(void); typedef void (*MPlayMainFunc)(struct MusicPlayerInfo *); // TODO: update this struct with better names from pret struct SoundInfo { // This field is normally equal to ID_NUMBER but it is set to other // values during sensitive operations for locking purposes. // This field should be volatile but isn't. This could potentially cause // race conditions. u32 ident; vu8 pcmDmaCounter; // Direct Sound u8 reverb; u8 maxChans; u8 masterVolume; u8 freq; u8 mode; u8 c15; // periodically counts from 14 down to 0 (15 states) u8 pcmDmaPeriod; // number of V-blanks per PCM DMA u8 maxLines; u8 gap[3]; s32 pcmSamplesPerVBlank; s32 pcmFreq; s32 divFreq; struct CgbChannel *cgbChans; u32 func; u32 intp; void (*CgbSound)(void); void (*CgbOscOff)(u8); u32 (*MidiKeyToCgbFreq)(u8, u8, u8); u32 MPlayJumpTable; u32 plynote; u32 ExtVolPit; u8 gap2[16]; struct SoundChannel chans[MAX_DIRECTSOUND_CHANNELS]; s8 pcmBuffer[PCM_DMA_BUF_SIZE * 2]; }; struct SongHeader { u8 trackCount; u8 blockCount; u8 priority; u8 reverb; struct ToneData *tone; u8 *part[1]; }; struct PokemonCrySong { u8 trackCount; u8 blockCount; u8 priority; u8 reverb; struct ToneData *tone; u8 *part[2]; u8 gap; u8 part0; // 0x11 u8 tuneValue; // 0x12 u8 gotoCmd; // 0x13 u32 gotoTarget; // 0x14 u8 part1; // 0x18 u8 tuneValue2; // 0x19 u8 cont[2]; // 0x1A u8 volCmd; // 0x1C u8 volumeValue; // 0x1D u8 unkCmd0D[2]; // 0x1E u32 unkCmd0DParam; // 0x20 u8 xreleCmd[2]; // 0x24 u8 releaseValue; // 0x26 u8 panCmd; u8 panValue; // 0x28 u8 tieCmd; // 0x29 u8 tieKeyValue; // 0x2A u8 tieVelocityValue; // 0x2B u8 unkCmd0C[2]; // 0x2C u16 unkCmd0CParam; // 0x2E u8 end[2]; // 0x30 }; #define MPT_FLG_VOLSET 0x01 #define MPT_FLG_VOLCHG 0x03 #define MPT_FLG_PITSET 0x04 #define MPT_FLG_PITCHG 0x0C #define MPT_FLG_START 0x40 #define MPT_FLG_EXIST 0x80 struct MusicPlayerTrack { u8 flags; u8 wait; u8 patternLevel; u8 repN; u8 gateTime; u8 key; u8 velocity; u8 runningStatus; u8 keyM; u8 pitM; s8 keyShift; s8 keyShiftX; s8 tune; u8 pitX; s8 bend; u8 bendRange; u8 volMR; u8 volML; u8 vol; u8 volX; s8 pan; s8 panX; s8 modM; u8 mod; u8 modT; u8 lfoSpeed; u8 lfoSpeedC; u8 lfoDelay; u8 lfoDelayC; u8 priority; u8 echoVolume; u8 echoLength; struct SoundChannel *chan; struct ToneData tone; u8 gap[10]; u16 unk_3A; u32 unk_3C; u8 *cmdPtr; u8 *patternStack[3]; }; #define MUSICPLAYER_STATUS_TRACK 0x0000ffff #define MUSICPLAYER_STATUS_PAUSE 0x80000000 #define MAX_MUSICPLAYER_TRACKS 16 #define TEMPORARY_FADE 0x0001 #define FADE_IN 0x0002 #define FADE_VOL_MAX 64 #define FADE_VOL_SHIFT 2 struct MusicPlayerInfo { struct SongHeader *songHeader; u32 status; u8 trackCount; u8 priority; u8 cmd; u8 unk_B; u32 clock; u8 gap[8]; u8 *memAccArea; u16 tempoD; u16 tempoU; u16 tempoI; u16 tempoC; u16 fadeOI; u16 fadeOC; u16 fadeOV; struct MusicPlayerTrack *tracks; struct ToneData *tone; u32 ident; u32 func; u32 intp; }; struct MusicPlayer { struct MusicPlayerInfo *info; struct MusicPlayerTrack *track; u8 unk_8; u16 unk_A; }; struct Song { struct SongHeader *header; u16 ms; u16 me; }; extern const struct MusicPlayer gMPlayTable[]; extern const struct Song gSongTable[]; extern u8 gMPlayMemAccArea[]; extern char SoundMainRAM[]; extern MPlayFunc gMPlayJumpTable[]; typedef void (*XcmdFunc)(struct MusicPlayerInfo *, struct MusicPlayerTrack *); extern const XcmdFunc gXcmdTable[]; extern struct CgbChannel gCgbChans[]; extern const u8 gCgb3Vol[]; extern const u8 gScaleTable[]; extern const u32 gFreqTable[]; extern const u16 gPcmSamplesPerVBlankTable[]; extern const u8 gCgbScaleTable[]; extern const s16 gCgbFreqTable[]; extern const u8 gNoiseTable[]; extern const struct PokemonCrySong gPokemonCrySongTemplate; extern const struct ToneData voicegroup_pokemon_cry; extern char gNumMusicPlayers[]; extern char gMaxLines[]; #define NUM_MUSIC_PLAYERS ((u16)gNumMusicPlayers) #define MAX_LINES ((u32)gMaxLines) u32 umul3232H32(u32 multiplier, u32 multiplicand); void SoundMain(void); void SoundMainBTM(void); void TrackStop(struct MusicPlayerInfo *mplayInfo, struct MusicPlayerTrack *track); void MPlayMain(void); void RealClearChain(void *x); void MPlayContinue(struct MusicPlayerInfo *mplayInfo); void MPlayStart(struct MusicPlayerInfo *mplayInfo, struct SongHeader *songHeader); void MPlayStop(struct MusicPlayerInfo *mplayInfo); void FadeOutBody(struct MusicPlayerInfo *mplayInfo); void TrkVolPitSet(struct MusicPlayerInfo *mplayInfo, struct MusicPlayerTrack *track); void MPlayFadeOut(struct MusicPlayerInfo *mplayInfo, u16 speed); void ClearChain(void *x); void Clear64byte(void *addr); void SoundInit(struct SoundInfo *soundInfo); void MPlayExtender(struct CgbChannel *cgbChans); void m4aSoundMode(u32 mode); void MPlayOpen(struct MusicPlayerInfo *mplayInfo, struct MusicPlayerTrack *track, u8 a3); void CgbSound(void); void CgbOscOff(u8); u32 MidiKeyToCgbFreq(u8, u8, u8); void MPlayJumpTableCopy(MPlayFunc *mplayJumpTable); void SampleFreqSet(u32 freq); void m4aSoundVSyncOn(void); void m4aSoundVSyncOff(void); void ClearModM(struct MusicPlayerTrack *track); void m4aMPlayModDepthSet(struct MusicPlayerInfo *mplayInfo, u16 trackBits, u8 modDepth); void m4aMPlayLFOSpeedSet(struct MusicPlayerInfo *mplayInfo, u16 trackBits, u8 lfoSpeed); // sound command handler functions void ply_fine(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_goto(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_patt(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_pend(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_rept(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_memacc(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_prio(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_tempo(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_keysh(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_voice(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_vol(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_pan(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_bend(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_bendr(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_lfos(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_lfodl(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_mod(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_modt(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_tune(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_port(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_xcmd(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_endtie(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_note(struct MusicPlayerInfo *, struct MusicPlayerTrack *); // extended sound command handler functions void ply_xxx(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_xwave(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_xtype(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_xatta(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_xdeca(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_xsust(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_xrele(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_xiecv(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_xiecl(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_xleng(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_xswee(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_xcmd_0C(struct MusicPlayerInfo *, struct MusicPlayerTrack *); void ply_xcmd_0D(struct MusicPlayerInfo *, struct MusicPlayerTrack *); #endif // GUARD_M4A_INTERNAL_H #ifndef GUARD_FLAGS_H #define GUARD_FLAGS_H // used by 'animCmd_GetPalette_COPY' (0x08004314 in SA2) #define FLAGS_UPDATE_BACKGROUND_PALETTES 0x1 #define FLAGS_UPDATE_SPRITE_PALETTES 0x2 #define FLAGS_4 0x4 #define FLAGS_EXECUTE_HBLANK_CALLBACKS 0x8 #define FLAGS_10 0x10 #define FLAGS_20 0x20 #define FLAGS_40 0x40 #define FLAGS_80 0x80 #define FLAGS_NO_FLASH_MEMORY 0x100 #define FLAGS_200 0x200 #define FLAGS_PAUSE_GAME 0x400 #define FLAGS_800 0x800 #define FLAGS_SKIP_INTRO 0x1000 #define FLAGS_4000 0x4000 #define FLAGS_8000 0x8000 extern u32 gFlags; #endif #ifndef GUARD_MALLOC_EWRAM_H #define GUARD_MALLOC_EWRAM_H struct EwramNode { /* 0x0 */ struct EwramNode *next; // Heap is implemented as a forward list. /* 0x4 */ s32 state; // It records how much space is corresponding // to this node. When you want to mark it as // occupied/busy, negate it. /* 0x8 */ u8 space[0]; // space for general purposes }; void EwramInitHeap(void); void *EwramMalloc(u32); void EwramFree(void *); extern u8 gEwramHeap[0x20080]; #endif // GUARD_MALLOC_EWRAM_H #ifndef GUARD_MALLOC_VRAM_H #define GUARD_MALLOC_VRAM_H #define VRAM_HEAP_SEGMENT_SIZE 0x80 #define VRAM_TILE_SLOTS_PER_SEGMENT (VRAM_HEAP_SEGMENT_SIZE / TILE_SIZE_4BPP) void *VramMalloc(u32); void VramResetHeapState(void); void VramFree(void *); #endif // GUARD_MALLOC_VRAM_H #ifndef GUARD_MULTI_BOOT_H #define GUARD_MULTI_BOOT_H /* From MASTER_INFO to MASTER_START_DL are upper values. * From MASTER_REQUEST_CRC to MASTER_VERIFY_CRC are lower values * (Upper=0) */ #define MULTIBOOT_MASTER_INFO 0x62 #define MULTIBOOT_CLIENT_INFO 0x72 #define MULTIBOOT_MASTER_START_PROBE 0x61 #define MULTIBOOT_MASTER_REQUEST_DLREADY 0x63 #define MULTIBOOT_CLIENT_DLREADY 0x73 #define MULTIBOOT_MASTER_START_DL 0x64 #define MULTIBOOT_MASTER_REQUEST_CRC 0x65 #define MULTIBOOT_CLIENT_CALC_CRC 0x74 #define MULTIBOOT_CLIENT_CRCREADY 0x75 #define MULTIBOOT_MASTER_VERIFY_CRC 0x66 /*------------------------------------------------------------------*/ /* Initialize Multi-play Boot */ /*------------------------------------------------------------------*/ extern void MultiBootInit(struct MultiBootParam *mp); //* Sets serial communication mode as multi-play mode. //* Basically, SIO_INTR_FLAG of IE is cleared, however it is // acceptable to use SIO interrupt. // //* does not set mp -> masterp. // Make sure to set up before calling this initialization function. /*------------------------------------------------------------------*/ /* Multi-play Boot Main */ /*------------------------------------------------------------------*/ extern s32 MultiBootMain(struct MultiBootParam *mp); //* Basically, call it once per frame. // However, if there is a wait long enough, it is acceptable to call // it multiple times per frame. The safe length of wait time depends // on the application. (It is necessary to make the wait longer than // the time it takes to process the interrupts of long period of // time, including V-Blank interrupts.) // //* Returns 0 in normal completion. // //* Returns 0 when transfer ends (successfully) and a value of // MultiBootCheckComplete() other than 0. // //* Once it is in the transfer end status, it simply returns 0 // immediately. // In order to cancel this status, call MultiBootInit(). // It is acceptable to call MultiBootStartProbe() or // MultiBootStartMaster(), however, they are internally calling // MultiBootInit(). /*------------------------------------------------------------------*/ /* Starts Client Recognition */ /*------------------------------------------------------------------*/ extern void MultiBootStartProbe(struct MultiBootParam *mp); // After calling this, the client's recognition processing is done // with // MultiBootMain(). Call after verifying mp -> // probe_count is 0. /*------------------------------------------------------------------*/ /* Starts Transfer from Master Server */ /*------------------------------------------------------------------*/ extern void MultiBootStartMaster(struct MultiBootParam *mp, const u8 *srcp, s32 length, u8 palette_color, s8 palette_speed); //* Among the units connected by multi-play communication cable, only // those units with game pak inserted // can become master server. // // srcp Pointer for the program that you want to boot // (requires 4-byte alignment) // For clients, it is downloaded immediately after // the header. // length Transfer byte count of program. // MULTIBOOT_SEND_SIZE_MIN (0x100) bytes or more and // MULTIBOOT_SEND_SIZE_MAX (0x40000) bytes or less. // "palette_color" and "palette_speed" are palette flash parameters // of client while loading. palette_color uses 0 to 6 to specify the // basic palettes (7 types) With "palette_speed", it flashes in // reversal order from -4 to -1 (-4 being the fastest) and it flashes // in normal from +1 to +4 (+4 being the fastest) Palette is fixed // (no flash) at 0. Do not specify any values other than listed // above. /*------------------------------------------------------------------*/ /* Check Transfer Completion */ /*------------------------------------------------------------------*/ extern s32 MultiBootCheckComplete(struct MultiBootParam *mp); //* Check if transfer has completed. // //* Returns a value other than 0 if transfer has completed //(successfully). // Returns 0 if it is still recognizing, has not started transfer, or // transfer has failed. // //* Calling any one of MultiBootInit(), MultiBootStartProbe() or // MultiBootStartMaster() // cancels the transfer completion status. /* magic value below aren't documented in SDK header */ /* probe_count */ #define MULTIBOOT_REQ_PREP_REC 0x0 #define MULTIBOOT_REQ_START_REC 0x1 #define MULTIBOOT_REQ_PROC_REC 0x2 #define MULTIBOOT_REC_COMPLETE 0xc4 #define MULTIBOOT_REQ_TX_CHECK 0xd0 #define MULTIBOOT_REQ_TX_START 0xd1 #define MULTIBOOT_REQ_HANDSHAKE_START 0xe0 #define MULTIBOOT_REQ_HANDSHAKE_HEADER_CHECK_1 0xe1 #define MULTIBOOT_REQ_HANDSHAKE_HEADER_CHECK_2 0xe2 #define MULTIBOOT_REQ_HANDSHAKE_HEADER_CHECK_3 0xe3 #define MULTIBOOT_REQ_HANDSHAKE_HEADER_CHECK_4 0xe4 #define MULTIBOOT_REQ_HANDSHAKE_HEADER_CHECK_5 0xe5 #define MULTIBOOT_REQ_HANDSHAKE_HEADER_CHECK_6 0xe6 #define MULTIBOOT_REQ_HANDSHAKE_HEADER_CHECK_7 0xe7 #define MULTIBOOT_REQ_HANDSHAKE_HEADER_CHECK_8 0xe8 #define MULTIBOOT_HANDSHAKE_SUCCESS 0xe9 #endif // GUARD_MULTI_BOOT_H #ifndef GUARD_MULTI_SIO_H #define GUARD_MULTI_SIO_H // Optimize the following settings based on the software // specifications #define MULTI_SIO_BLOCK_SIZE 24 // Communication Data Block Size (Max. 24 Bytes) #define MULTI_SIO_PLAYERS_MAX 4 // Maximum Number of Players #define MULTI_SIO_SYNC_DATA 0xfefe // Synchronized Data (0x0000/0xfffa~0xffff prohibited) // Comment out if no space in CPU internal Work RAM #define MULTI_SIO_DI_FUNC_FAST // SIO Interrupt Prohibit Function High // Speed Flag (CPU Internal RAM // Execution) // Update if maximum delay for communication interrupt is larger than // following. #define MULTI_SIO_INTR_DELAY_MAX 2000 // Communication Interrupt Allowed Delay Clocks #ifdef MULTI_SIO_DI_FUNC_FAST #define MULTI_SIO_INTR_CLOCK_MAX 400 // Communication Interrupt Processing Maximum Clocks #else #define MULTI_SIO_INTR_CLOCK_MAX 1000 #endif #define MULTI_SIO_1P_SEND_CLOCKS 3000 // Communication Time for 1 unit #if MULTI_SIO_PLAYERS_MAX == 4 #define MULTI_SIO_START_BIT_WAIT 0 // Start Bit Wait Time #else #define MULTI_SIO_START_BIT_WAIT 512 #endif // During development set NDEBUG to undefined and value below to 0, // define with last check and confirm operation with changed to 600. // (Even if increase setting the communication interval increases, but // processing doesn't slow). //#define NDEBUG // Can define with // Makefile (MakefileDemo) #ifdef NDEBUG #define MULTI_SIO_INTR_MARGIN 600 // Communication Interrupt Error Guarantee Value #else #define MULTI_SIO_INTR_MARGIN 0 #endif #define MULTI_SIO_BAUD_RATE 115200 // Baud Rate #define MULTI_SIO_BAUD_RATE_NO SIO_115200_BPS // Baud Rate No. #define MULTI_SIO_TIMER_NO 3 // Timer No. #define MULTI_SIO_TIMER_INTR_FLAG (INTR_FLAG_TIMER0 << MULTI_SIO_TIMER_NO) #define REG_MULTI_SIO_TIMER (*(vu32 *)(REG_ADDR_TMCNT + (MULTI_SIO_TIMER_NO * 4))) #define REG_MULTI_SIO_TIMER_L (*(vu16 *)(REG_ADDR_TMCNT_L + (MULTI_SIO_TIMER_NO * 4))) #define REG_MULTI_SIO_TIMER_H (*(vu16 *)(REG_ADDR_TMCNT_H + (MULTI_SIO_TIMER_NO * 4))) // Timer Register // Timer count number is calculated from communication data block // size. #define MULTI_SIO_TIMER_COUNT_TMP (SYSTEM_CLOCK / 60 / ((2 + 4 + MULTI_SIO_BLOCK_SIZE + 6) / (16 / 8))) // Timer Count Temporary Value #define MULTI_SIO_TIMER_COUNT_MIN \ (MULTI_SIO_1P_SEND_CLOCKS * MULTI_SIO_PLAYERS_MAX + MULTI_SIO_START_BIT_WAIT + MULTI_SIO_INTR_MARGIN + MULTI_SIO_INTR_DELAY_MAX \ + MULTI_SIO_INTR_CLOCK_MAX) // Timer Count Minimum Value #define MULTI_SIO_TIMER_COUNT_MAX 0x10000 // Timer Count Maximum Value #define MULTI_SIO_TIMER_COUNT (MULTI_SIO_TIMER_COUNT_MAX - MULTI_SIO_TIMER_COUNT_TMP) // Timer Count // Timer Count Setting Error #if MULTI_SIO_TIMER_COUNT_TMP < MULTI_SIO_TIMER_COUNT_MIN #error MULTI_SIO_TIMER_COUNT is too short, #error because MULTI_SIO_BLOCK_SIZE or MULTI_SIO_INTR_DELAY_MAX is too large. #elif MULTI_SIO_TIMER_COUNT_TMP > MULTI_SIO_TIMER_COUNT_MAX #error MULTI_SIO_TIMER_COUNT is too long. #endif // Multi-play Communication Packet Structure struct MultiSioPacket { u8 frameCounter; // Frame Counter u8 recvErrorFlags : 4; // Receive Error Flag u8 loadRequest : 1; // Load Request u8 downloadSuccessFlag : 1; // Download Success Flag u8 loadSuccessFlag : 1; // Load Success u8 reserved_0 : 1; // Reserved u16 checkSum; // Checksum u16 data[MULTI_SIO_BLOCK_SIZE / 2]; // Communication Data u16 overrunCatch[2]; // Overrun Protect Area }; // Multi-play Communication Work Area Structure struct MultiSioArea { u8 type; // Connection (Master/Slave) u8 state; // Communication Function State u8 connectedFlags; // Connection History Flag u8 recvSuccessFlags; // Receive Success Flag u8 syncRecvFlag[4]; // Receive Confirmation Flag u8 downloadSuccessFlags : 4; // Download Success Flag u8 loadEnable : 1; // Enable Load u8 loadRequest : 1; // Load Request u8 loadSuccessFlag : 1; // Load Success u8 startFlag : 1; // Communication Start Flag u8 hardError; // Hard error u8 recvFlagsAvailableCounter; // Receiving success flag validation // counter u8 sendFrameCounter; // Send Frame Counter u8 recvFrameCounter[4][2]; // Receive Frame Counter s32 sendBufCounter; // Send Buffer Counter s32 recvBufCounter[4]; // Receive Buffer Counter u16 *nextSendBufp; // Send Buffer Pointer u16 *currentSendBufp; u16 *currentRecvBufp[4]; // Receive Buffer Pointer u16 *lastRecvBufp[4]; u16 *recvCheckBufp[4]; struct MultiSioPacket sendBuf[2]; // Send Buffer (Double Buffer) struct MultiSioPacket recvBuf[MULTI_SIO_PLAYERS_MAX][3]; // Receive Buffer (Triple Buffer) }; extern u32 gMultiSioRecvFuncBuf[0x40 / 4]; // Receive Data/Check Buffer Change Routine // RAM Execution Buffer extern u32 gMultiSioIntrFuncBuf[0x120 / 4]; // Interrupt Routine RAM Execution Buffer extern struct MultiSioArea gMultiSioArea; // Multi-play Communication Work Area /*------------------------------------------------------------------*/ /* Multi-play Communication Initialization */ /*------------------------------------------------------------------*/ extern void MultiSioInit(u32 connectedFlags); //* Set serial communication mode to multi-play mode. //* Initialize register and buffer. //* Arguments: // u32 connectedFlags Set appropriate flag if a unit recognized // as connected /*------------------------------------------------------------------*/ /* Start Multi-play Communication */ /*------------------------------------------------------------------*/ void MultiSioStart(void); //* If following master recognition set flag to start send. //* If slave or prior to master recognition do nothing. /*------------------------------------------------------------------*/ /* Stop Multi-play Communication */ /*------------------------------------------------------------------*/ void MultiSioStop(void); //* Stop Communication /*------------------------------------------------------------------*/ /* Multi-play Communication Main */ /*------------------------------------------------------------------*/ extern u32 MultiSioMain(void *sendp, void *recvp, u32 loadRequest); //* First determine if master or slave. If master recognized, // initialize // timer. //* Call MultiSioSendDataSet() and set send data. //* Call MultiSioRecvDataCheck() and check if normal receive done, // and copy receive data to Recvp. // //* Set so called with as close a timing as possible within 1 frame. //* Safer not to send data that matches flag data (SIO_SYNC_DATA) // prior // to connection determination. // //* Arguments: // void *sendp User Send Buffer Pointer // void *recvp User Receive Buffer Pointer // u32 loadRequest Load Request //* Return Value: #define MULTI_SIO_RECV_ID_MASK 0x000f // Receive success flag #define MULTI_SIO_CONNECTED_ID_MASK 0x0f00 // Connection history flag #define MULTI_SIO_RECV_ID_SHIFT 0 #define MULTI_SIO_CONNECTED_ID_SHIFT 8 #define MULTI_SIO_RECV_ID0 0x0001 // Receive success flag Master #define MULTI_SIO_RECV_ID1 0x0002 // Slave 1 #define MULTI_SIO_RECV_ID2 0x0004 // Slave 2 #define MULTI_SIO_RECV_ID3 0x0008 // Slave 3 #define MULTI_SIO_LD_ENABLE 0x0010 // Enable load #define MULTI_SIO_LD_REQUEST 0x0020 // Load request #define MULTI_SIO_LD_SUCCESS 0x0040 // Load success #define MULTI_SIO_TYPE 0x0080 // Connection (Master/Slave) #define MULTI_SIO_PARENT 0x0080 // Connect Master #define MULTI_SIO_CHILD 0x0000 // Connect Slave #define MULTI_SIO_CONNECTED_ID0 0x0100 // Connection history flag Master #define MULTI_SIO_CONNECTED_ID1 0x0200 // Slave 1 #define MULTI_SIO_CONNECTED_ID2 0x0400 // Slave 2 #define MULTI_SIO_CONNECTED_ID3 0x0800 // Slave 3 #define MULTI_SIO_HARD_ERROR 0x1000 // Hard error #define MULTI_SIO_ID_OVER_ERROR 0x2000 // ID over error #define MULTI_SIO_RECV_FLAGS_AVAILABLE 0x8000 // Validate receive success flag #define MULTI_SIO_RECV_ID(x) (0x0001 << (x)) #define MULTI_SIO_CONNECTED_ID(x) (0x0100 << (x)) #define MULTI_SIO_ALL_CONNECTED \ (MULTI_SIO_CONNECTED_ID(0) | MULTI_SIO_CONNECTED_ID(1) | MULTI_SIO_CONNECTED_ID(2) | MULTI_SIO_CONNECTED_ID(3)) // Return Value Structure struct MultiSioReturn { u32 recvSuccessFlags : 4; // Receive success flag u32 loadEnable : 1; // Enable load u32 loadRequest : 1; // Load request u32 loadSuccessFlag : 1; // Load success u32 type : 1; // Connection (master/slave) u32 connectedFlags : 4; // Connection history flag u32 hardError : 1; // Hard error u32 idOverError : 1; // ID over error u32 reserved : 1; // Reservation u32 recvFlagsAvailable : 1; // Validate receive success flag }; /*------------------------------------------------------------------*/ /* Multi-play Communication Interrupt */ /*------------------------------------------------------------------*/ extern void MultiSioIntr(void); //* During communication interrupt, store receive data from each unit // in each receive buffer and set the send buffer data to the // register. //* If master, reset timer and restart send. // //* Program so slave is called with communication interrupt and master // is called with timer interrupt. //* Adjust setting so 1 packet (Except for OverRunCatch[]) can be // transfered with 1 frame. /*------------------------------------------------------------------*/ /* Set Send Data */ /*------------------------------------------------------------------*/ extern void MultiSioSendDataSet(void *sendp, u32 loadReq); //* Set the user send buffer data to send buffer. // //* Called from MultiSioMain(). //* Not necessary to call directly. // //* Arguments: // void *sendp User Send Buffer Pointer // u32 loadReq Load Request /*------------------------------------------------------------------*/ /* Check Receive Data */ /*------------------------------------------------------------------*/ extern u32 MultiSioRecvDataCheck(void *recvp); //* Check if receive done normally. If normal, copy the receive data // to the user receive buffer. // //* Called from MultiSioMain(). //* Do not need to call directly. // //* Arguments: // void *recvp User Receive Buffer Pointer #endif // GUARD_MULTI_SIO_H #ifndef GUARD_RECT_H #define GUARD_RECT_H typedef struct { /* 0x00 */ s8 left; /* 0x01 */ s8 top; /* 0x02 */ s8 right; /* 0x03 */ s8 bottom; } Rect8; // TODO: Maybe the integer- and FP-macros can be merged somehow? /* Rect collision checks using integer values */ #define RECT_WIDTH(hb) ((hb)->right - (hb)->left) #define RECT_HEIGHT(hb) ((hb)->bottom - (hb)->top) #define RECT_LEFT(x, hb) ((x) + (hb)->left) #define RECT_RIGHT(x, hb) (RECT_LEFT(x, hb) + RECT_WIDTH(hb)) #define RECT_TOP(y, hb) ((y) + (hb)->top) #define RECT_BOTTOM(y, hb) (RECT_TOP(y, hb) + RECT_HEIGHT(hb)) #define RECT_COLLISION_A_X(x0, hb0, x1, hb1) (RECT_LEFT(x0, hb0) <= RECT_LEFT(x1, hb1) && RECT_RIGHT(x0, hb0) >= RECT_LEFT(x1, hb1)) #define RECT_COLLISION_B_X(x0, hb0, x1, hb1) (RECT_LEFT(x0, hb0) >= RECT_LEFT(x1, hb1) && RECT_RIGHT(x1, hb1) >= RECT_LEFT(x0, hb0)) #define RECT_COLLISION_A_Y(y0, hb0, y1, hb1) (RECT_TOP((y0), hb0) <= RECT_TOP((y1), hb1) && RECT_BOTTOM((y0), hb0) >= RECT_TOP((y1), hb1)) #define RECT_COLLISION_B_Y(y0, hb0, y1, hb1) (RECT_TOP((y0), hb0) >= RECT_TOP((y1), hb1) && RECT_BOTTOM((y1), hb1) >= RECT_TOP((y0), hb0)) #define RECT_COLLISION_X(x0, hb0, x1, hb1) (RECT_COLLISION_A_X(x0, hb0, x1, hb1) || RECT_COLLISION_B_X(x0, hb0, x1, hb1)) #define RECT_COLLISION_Y(y0, hb0, y1, hb1) (RECT_COLLISION_A_Y(y0, hb0, y1, hb1) || RECT_COLLISION_B_Y(y0, hb0, y1, hb1)) #define RECT_COLLISION(x0, y0, hb0, x1, y1, hb1) (RECT_COLLISION_X(x0, hb0, x1, hb1) && RECT_COLLISION_Y(y0, hb0, y1, hb1)) /* Rect collision checks using Fixed-point values */ #define Q_RECT_WIDTH(hb) Q_24_8_NEW(RECT_WIDTH(hb)) #define Q_RECT_HEIGHT(hb) Q_24_8_NEW(RECT_HEIGHT(hb)) #define Q_RECT_LEFT(x, hb) ((x) + Q_24_8((hb)->left)) #define Q_RECT_LEFT2(x, hb) Q_24_8_NEW((hb)->left + (x)) #define Q_RECT_RIGHT(x, hb) (Q_RECT_LEFT(x, hb) + Q_RECT_WIDTH(hb)) #define Q_RECT_RIGHT2(x, hb) (Q_RECT_LEFT2(x, hb) + Q_RECT_WIDTH(hb)) #define Q_RECT_TOP(y, hb) (((y) + Q_24_8((hb)->top))) #define Q_RECT_TOP2(y, hb) Q_24_8_NEW(((hb)->top) + (y)) #define Q_RECT_BOTTOM(y, hb) (Q_RECT_TOP(y, hb) + Q_RECT_HEIGHT(hb)) #define Q_RECT_BOTTOM2(y, hb) (Q_RECT_TOP2(y, hb) + Q_RECT_HEIGHT(hb)) #define Q_RECT_COLLISION_A_X(x0, hb0, x1, hb1) \ (Q_RECT_LEFT2(x0, hb0) <= Q_RECT_LEFT(x1, hb1) && Q_RECT_RIGHT2(x0, hb0) >= Q_RECT_LEFT(x1, hb1)) #define Q_RECT_COLLISION_B_X(x0, hb0, x1, hb1) \ (Q_RECT_LEFT2(x0, hb0) >= Q_RECT_LEFT(x1, hb1) && Q_RECT_RIGHT(x1, hb1) >= Q_RECT_LEFT2(x0, hb0)) #define Q_RECT_COLLISION_A_Y(y0, hb0, y1, hb1) \ (Q_RECT_TOP2((y0), hb0) <= Q_RECT_TOP((y1), hb1) && Q_RECT_BOTTOM2((y0), hb0) >= Q_RECT_TOP((y1), hb1)) #define Q_RECT_COLLISION_B_Y(y0, hb0, y1, hb1) \ (Q_RECT_TOP2((y0), hb0) >= Q_RECT_TOP((y1), hb1) && Q_RECT_BOTTOM((y1), hb1) >= Q_RECT_TOP2((y0), hb0)) #define Q_RECT_COLLISION_X(x0, hb0, x1, hb1) (Q_RECT_COLLISION_A_X(x0, hb0, x1, hb1) || Q_RECT_COLLISION_B_X(x0, hb0, x1, hb1)) #define Q_RECT_COLLISION_Y(y0, hb0, y1, hb1) (Q_RECT_COLLISION_A_Y(y0, hb0, y1, hb1) || Q_RECT_COLLISION_B_Y(y0, hb0, y1, hb1)) #define RECT_COLLISION_2(x0, y0, hb0, x1, y1, hb1) (Q_RECT_COLLISION_X(x0, hb0, x1, hb1) && Q_RECT_COLLISION_Y(y0, hb0, y1, hb1)) /* Rect collision checks using integer values Clones of the RECT_ ,macros that access values directly */ #define HB_WIDTH(hb) ((hb).right - (hb).left) #define HB_HEIGHT(hb) ((hb).bottom - (hb).top) #define HB_LEFT(x, hb) ((x) + hb.left) #define HB_RIGHT(x, hb) (HB_LEFT((x), (hb)) + HB_WIDTH(hb)) #define HB_TOP(y, hb) ((y) + hb.top) #define HB_BOTTOM(y, hb) (HB_TOP(y, hb) + HB_HEIGHT(hb)) #define HB_COLLISION_A_X(x0, hb0, x1, hb1) (HB_LEFT(x0, hb0) <= HB_LEFT(x1, hb1) && HB_RIGHT(x0, hb0) >= HB_LEFT(x1, hb1)) #define HB_COLLISION_B_X(x0, hb0, x1, hb1) (HB_LEFT(x0, hb0) >= HB_LEFT(x1, hb1) && HB_RIGHT(x1, hb1) >= HB_LEFT(x0, hb0)) #define HB_COLLISION_A_Y(y0, hb0, y1, hb1) (HB_TOP((y0), hb0) <= HB_TOP((y1), hb1) && HB_BOTTOM((y0), hb0) >= HB_TOP((y1), hb1)) #define HB_COLLISION_B_Y(y0, hb0, y1, hb1) (HB_TOP((y0), hb0) >= HB_TOP((y1), hb1) && HB_BOTTOM((y1), hb1) >= HB_TOP((y0), hb0)) #define HB_COLLISION_X(x0, hb0, x1, hb1) (HB_COLLISION_A_X(x0, hb0, x1, hb1) || HB_COLLISION_B_X(x0, hb0, x1, hb1)) #define HB_COLLISION_Y(y0, hb0, y1, hb1) (HB_COLLISION_A_Y(y0, hb0, y1, hb1) || HB_COLLISION_B_Y(y0, hb0, y1, hb1)) #define HB_COLLISION(x0, y0, hb0, x1, y1, hb1) (HB_COLLISION_X(x0, hb0, x1, hb1) && HB_COLLISION_Y(y0, hb0, y1, hb1)) #endif // GUARD_RECT_H #ifndef GUARD_TASK_H #define GUARD_TASK_H struct Task; typedef struct Task Task; typedef void (*TaskMain)(void); typedef void (*TaskDestructor)(struct Task *); // The task system uses the GBA's unique memory layout to halve the size of pointers. // Other platforms need to have the same logical behavior, but done differently. #ifndef PORTABLE typedef u16 TaskPtr; // Mainly used to silence (void* -> u16) warnings typedef u32 TaskPtr32; #define TASK_PTR(taskRef) (IWRAM_START + (taskRef)) #define TASK_IS_NULL(taskp) ((taskp) == (void *)IWRAM_START) typedef u16 IwramData; #else typedef struct Task *TaskPtr; typedef TaskPtr TaskPtr32; #define TASK_PTR(taskRef) (taskRef) #define TASK_IS_NULL(task) ((task) == NULL) typedef void *IwramData; #endif #define TASK_IS_NOT_NULL(taskp) !TASK_IS_NULL(taskp) #define MAX_TASK_NUM 128 #define TASK_INACTIVE 0x0001 #define TASK_DESTROY_DISABLED 0x0002 #define TASK_x0004 0x0004 #define TASK_USE_EWRAM 0x0010 #define USE_OLD_TASK_SYSTEM FALSE struct Task { /* 0x00 */ TaskPtr parent; /* 0x02 */ TaskPtr prev; /* 0x04 */ TaskPtr next; /* 0x06 */ IwramData data; /* 0x08 */ TaskMain main; /* 0x0C */ TaskDestructor dtor; /* 0x10 */ u16 priority; // priority? /* 0x12 */ u16 flags; // 0x1 = active // 0x2 = ??? // 0x10 = use ewram for struct #if USE_SA2_TASK_SYSTEM /* 0x14 */ u8 unk14; /* 0x15 */ u8 unk15; /* 0x16 */ u16 unk16; /* 0x18 */ u16 unk18; #endif }; #ifndef PORTABLE typedef u16 IwramNodePtr; typedef u32 IwramNodePtr32; #else struct IwramNode; typedef struct IwramNode *IwramNodePtr; typedef IwramNodePtr IwramNodePtr32; #endif #define IWRAM_PTR(ptr) TASK_PTR(ptr) struct IwramNode { IwramNodePtr next; s16 state; u8 space[0]; }; #define TASK_DATA(taskp) (void *)TASK_PTR((taskp)->data) #define TASK_PARENT(taskp) (struct Task *)TASK_PTR((taskp)->parent) #define TASK_NEXT(taskp) (struct Task *)TASK_PTR((taskp)->next) #define TasksDestroyAll() TasksDestroyInPriorityRange(0, 0xFFFF) extern struct Task gTasks[MAX_TASK_NUM]; extern struct Task gEmptyTask; extern struct Task *gTaskPtrs[MAX_TASK_NUM]; extern s32 gNumTasks; #if !USE_OLD_TASK_SYSTEM extern struct Task *gNextTaskToCheckForDestruction; #endif extern struct Task *gNextTask; extern struct Task *gCurTask; extern u8 gIwramHeap[0x2204]; u32 TasksInit(void); void TasksExec(void); struct Task *TaskCreate(TaskMain taskMain, u16 structSize, u16 priority, u16 flags, TaskDestructor taskDestructor); void TaskDestroy(struct Task *); void *IwramMalloc(u16); void IwramFree(void *p); void TasksDestroyInPriorityRange(u16, u16); #endif #ifndef GUARD_TRIG_H #define GUARD_TRIG_H extern const s16 gSineTable[1280]; #define SIN_PERIOD 1024 #define CLAMP_SIN_PERIOD(val) \ ({ \ s16 clamped = (val) & (SIN_PERIOD - 1); \ clamped; \ }) #define ONE_CYCLE (SIN_PERIOD - 1) #define SIN(radAngle) (gSineTable[(radAngle)]) #define COS(radAngle) (gSineTable[(radAngle) + 256]) #define SIN_INT(radAngle) (Q_2_14_TO_INT(SIN(radAngle))) #define COS_INT(radAngle) (Q_2_14_TO_INT(COS(radAngle))) #define SIN_24_8(radAngle) Q_2_14_TO_Q_24_8(SIN(radAngle)) #define COS_24_8(radAngle) Q_2_14_TO_Q_24_8(COS(radAngle)) #define DEG_TO_SIN(deg) ((int)((((double)(deg)) / 360.0) * SIN_PERIOD)) // NOTE: Returns a Q_24_8! #define SIN_DEG(degrees) Q_2_14_TO_Q_24_8(gSineTable[DEG_TO_SIN(degrees)]) #define COS_DEG(degrees) Q_2_14_TO_Q_24_8(gSineTable[DEG_TO_SIN(degrees) + 256]) #define SQUARE(v) ((v) * (v)) #define CUBE(v) ((v) * (v) * (v)) #endif // GUARD_TRIG_H #ifndef GUARD_SA3_TYPES_H #define GUARD_SA3_TYPES_H // NOTE: Once the codebase is portable, // we should #include each platform's types.h here. // // None of the code should #include platform-specific types.h files directly. #endif // GUARD_SA3_TYPES_H #ifndef GUARD_ANIMATIONS_SA3_H #define GUARD_ANIMATIONS_SA3_H /* Collection of animation indices for Sonic Advance 3. * - By JaceCear */ // "x_PROJ" means "projectile belonging to x" #define ANIM_SONIC_IDLE 0 #define ANIM_CREAM_IDLE 163 #define ANIM_TAILS_IDLE 326 #define ANIM_KNUCKLES_IDLE 489 #define ANIM_AMY_IDLE 652 #define ANIM_CHAR_133 133 // UI elements etc. #define ANIM_CHAOS_EMERALD_BIG 854 #define ANIM_ARROWUP 855 #define ANIM_CHAOMAP_EMERALD 858 #define ANIM_ACT_EMBLEM 860 /*ANIM_ACT_EMBLEM: 0="ACT 01" 1="ACT 02" 2="ACT 03" 3="ACT 04" 4="VS BOSS" */ #define ANIM_CHARACTER_NAMES 861 /*ANIM_CHARACTER_NAMES: 0="SONIC" */ #define ANIM_ACT_MEDALS 862 /*ANIM_ACT_MEDALS: 0=Gold 1=Silver 2=Bronze */ #define ANIM_ACT_NAMES_JP 863 // 864: White ??? #define ANIM_ACT_NAMES_ENG 865 // Interactables #define ANIM_SPRING 866 #define ANIM_LAUNCH_RING 867 #define ANIM_BOOSTER 868 #define ANIM_SPIKES 869 #define ANIM_RAMP 870 #define ANIM_PLATFORM_1 871 #define ANIM_ZONE_TELEPORT 872 #define ANIM_BOUNCY_BAR 873 #define ANIM_ROTATING_HANDLE 874 #define ANIM_CHECKPOINT 875 #define ANIM_HANG_HANDLE 876 #define ANIM_PLATFORM_2 877 #define ANIM_TRAMPOLINE 878 #define ANIM_PLATFORM_WITH_SWITCH_W01 879 #define ANIM_SPRING_WITH_SWITCH 880 #define ANIM_BREAKABLE_WALL_1 881 #define ANIM_ROCK 882 #define ANIM_FLAT_SPRING 883 #define ANIM_PLATFORM_RAISING_WHEEL 884 // 0: Still, 1: Rotating, 2: Platform #define ANIM_SEESAW_1 885 #define ANIM_YELLOW_SPRING_SH 886 #define ANIM_BUNGEE_CORD 891 #define ANIM_SUNSET_BRIDGE 892 #define ANIM_WAGGLE_COIL 894 #define ANIM_PLATFORM_SH 897 #define ANIM_PLATFORM_ON_A_PATH 898 #define ANIM_BREAKABLE_WALL_3 899 #define ANIM_PLATFORM_3_0 900 #define ANIM_SUCTION_VERT 901 #define ANIM_SUCTION_HORZ 902 #define ANIM_DEATH_CRUSHER_SPIKED 903 #define ANIM_PLATFORM_3 904 #define ANIM_DEATH_CRUSHER 905 #define ANIM_PLATFORM_CRUMBLE_3_IDLE 906 #define ANIM_PLATFORM_CRUMBLE_3 907 #define ANIM_PROPELLER_BUTTON_PLATFORM 908 #define ANIM_PLATFORM_SQUARE_3 909 #define ANIM_WATER_CANNON 910 #define ANIM_FACTORY_RING 911 #define ANIM_SPECIAL_SPRING 912 #define ANIM_BONUS_UFO 913 #define ANIM_BONUS_UFO_RAY 914 #define ANIM_ROCKET 915 #define ANIM_FERRIS_WHEEL 916 #define ANIM_TOY_BALLOON 917 #define ANIM_SPRING_IN_A_BOX 918 #define ANIM_PANDA_CART 919 #define ANIM_PENDULUM 920 #define ANIM_PLATFORM_SPIKED 921 #define ANIM_ICE_SPIKE 922 #define ANIM_ICE_LAUNCHER 923 #define ANIM_CHARGE_LAUNCHER 924 #define ANIM_MINECART 925 #define ANIM_AIR_BUBBLES 926 #define ANIM_ATTACHED_PLATFORM 927 #define ANIM_GONDOLA 928 #define ANIM_FALLING_BOULDER 929 #define ANIM_CLOSING_WALL 930 #define ANIM_UFO_PLATFORM 931 #define ANIM_PLATFORM_CA 932 #define ANIM_FALL_PLATFORM_CA 933 #define ANIM_WATER_CANNON_SPLASH 934 #define ANIM_PLATFORM_CRUMBLE_CA 935 #define ANIM_SPRING_6 936 #define ANIM_PLATFORM_CRUMBLING_6 938 #define ANIM_SPRING_PLATFORM_6 939 #define ANIM_MAZE_LAUNCHER 940 /* ANIM_MAZE_LAUNCHER: 0=Std 1=Blink Left 2=Blink Right 3=Downward std 6=Corner 7=Un-Launcher */ #define ANIM_PENDULUM_CYBER 943 #define ANIM_MUD_FX 945 #define ANIM_GOAL_RING 948 #define ANIM_BREAKABLE_WALL_4 953 #define ANIM_BREAKABLE_WALL_5 954 #define ANIM_BREAKABLE_WALL_6 966 #define ANIM_PLATFORM_CRUMBLE_6 967 #define ANIM_SEESAW_3 968 #define ANIM_PLATFORM_TS 974 #define ANIM_TOY_BALLOON_POPPED 976 #define ANIM_OMOCHAO0 977 #define ANIM_OMOCHAO1 978 #define ANIM_OMOCHAO2 979 #define ANIM_OMOCHAO3 980 #define ANIM_OMOCHAO4 981 #define ANIM_OMOCHAO5 982 #define ANIM_ACT_RING 983 /* ANIM_ACT_RINGS: 0=Act 1 1=Act 2 2=Act 3 3=Crown (completed stage) */ #define ANIM_SPRING_PLATFORM_4 984 #define ANIM_PLATFORM_CA_ACT3 986 #define ANIM_SPRING_TK 987 #define ANIM_SPIKES_TK 988 #define ANIM_PLATFORM_WITH_SWITCH_W02 989 #define ANIM_PLATFORM_WITH_SWITCH_W03 990 #define ANIM_PLATFORM_WITH_SWITCH_W04 991 #define ANIM_PLATFORM_WITH_SWITCH_W05 992 #define ANIM_PLATFORM_WITH_SWITCH_W06 993 #define ANIM_PLATFORM_WITH_SWITCH_W07 994 #define ANIM_SPRING_WITH_SWITCH_2 995 #define ANIM_FINALZONE_RING 996 #define ANIM_PLATFORM_BONUS 997 // ANIM_MUD_FX with lighter colors, only used in Chaos Angel #define ANIM_MUD_FX_CHAOS_ANGEL 999 #define ANIM_CHAO_SITTING 1004 #define ANIM_CHAO_STANDING 1005 #define ANIM_CHAO_WALKING 1006 // Variant 0: PRESS START // Variant 1: GBA COLOR SETTING // Variant 2: GBA SP COLOR SETTING #define ANIM_TITLE_PRESS_START_JP 1007 #define ANIM_TITLE_COPYRIGHT 1008 // Variant 0: PRESS START // Variant 1: GBA COLOR SETTING // Variant 2: GBA SP COLOR SETTING #define ANIM_TITLE_PRESS_START_EN 1009 #define ANIM_TITLE_PRESS_START_DE 1010 #define ANIM_TITLE_PRESS_START_FR 1011 #define ANIM_TITLE_PRESS_START_ES 1012 #define ANIM_TITLE_PRESS_START_IT 1012 #define ANIM_UI_PROMPT_BUTTON 1042 #define ANIM_SOUNDTEST_DIGITS 1043 #define ANIM_SOUNDTEST_WHEEL 1044 #define ANIM_SOUNDTEST_PLAY 1045 #define ANIM_SOUNDTEST_STOP_EN 1046 #define ANIM_SOUNDTEST_BACK_EN 1047 #define ANIM_SOUNDTEST_STOP_FR 1046 #define ANIM_SOUNDTEST_BACK_FR 1047 #define ANIM_SOUNDTEST_STOP_DE 1046 #define ANIM_SOUNDTEST_BACK_DE 1047 #define ANIM_SOUNDTEST_STOP_ES 1046 #define ANIM_SOUNDTEST_BACK_ES 1047 #define ANIM_SOUNDTEST_STOP_IT 1046 #define ANIM_SOUNDTEST_BACK_IT 1047 #define ANIM_RING_SP_STAGE 1117 #define ANIM_BONUS_CAPSULE 1154 // SA3 - Enemies #define ANIM_SPINNER 1166 #define ANIM_CONDOR 1167 #define ANIM_AKATENTO 1168 #define ANIM_AOTENTO 1169 #define ANIM_APE 1171 #define ANIM_FROG 1173 #define ANIM_MINIMOLE 1174 #define ANIM_BUZZER 1175 #define ANIM_JOUSUN 1177 /* Green Plane */ #define ANIM_TAKKON 1178 /* Red Octopus */ #define ANIM_UUTSUBO 1179 /* Yellow Eel */ #define ANIM_BUBU 1181 #define ANIM_GAOGAO 1182 #define ANIM_GUARD 1183 #define ANIM_GUARD_PROJ 1184 #define ANIM_JUGGLING 1185 #define ANIM_JUGGLING_PROJ 1186 #define ANIM_GINPE 1187 /* Penguin */ #define ANIM_GINPE_PROJ 1188 #define ANIM_PUFFER 1189 #define ANIM_PUFFER_PROJ 1190 // Crab with spin projectile (which isn't its own anim?) #define ANIM_YADOKKA 1191 #define ANIM_SNOWMAN 1192 #define ANIM_SNOWMAN_PROJ 1193 #define ANIM_KYACCHAA 1194 /* Spider */ #define ANIM_KYACCHAA_PROJ 1195 #define ANIM_GURUGURU 1196 #define ANIM_KAMAKI 1197 /* Mantis */ #define ANIM_KAMAKI_PROJ 1198 #define ANIM_CLAMP 1199 #define ANIM_CLAMP_PROJ 1200 #define ANIM_MARRUN 1201 #define ANIM_MUUGADEN 1202 #define ANIM_MUUGADEN_PART 1203 #define ANIM_MUUGADEN_PROJ 1204 #define ANIM_ITEMBOX_TYPE 1315 #define ANIM_ITEMBOX 1316 #define ANIM_RING 1333 #define ANIM_RING_COLLECT_EFFECT 1334 #define ANIM_ICE_SHIVER 1344 #define ANIM_SPECIAL_KEY 1348 #define ANIM_ZONEX_NAME 1424 /* Substate-Index == Zone number */ #endif // GUARD_ANIMATIONS_SA3_H #ifndef GUARD_CONST_ANIM_COMMANDS_H #define ANIM_CMD__GET_TILES -1 #define ANIM_CMD__GET_PALETTE -2 #define ANIM_CMD__LOOP -3 #define ANIM_CMD__END -4 #define ANIM_CMD__PLAY_SFX -5 #define ANIM_CMD__6 -6 #define ANIM_CMD__TranslateSprite -7 #define ANIM_CMD__8 -8 #define ANIM_CMD__SetIdAndVariant -9 #define ANIM_CMD__10 -10 #define ANIM_CMD__11 -11 #define ANIM_CMD__12 -12 #define GUARD_CONST_ANIM_COMMANDS_H #endif // TODO: Auto-generate this file #define MAX_TILES(_animName) ((_animName##_WIDTH / 8) * (_animName##_HEIGHT / 8)) #define MAX_TILES_VARIANT(_animName, _variant) ((_animName##_VAR##_variant##_WIDTH / 8) * (_animName##_VAR##_variant##_HEIGHT / 8)) #define ALLOC_TILES(_animName) VramMalloc(((_animName##_WIDTH / 8) * (_animName##_HEIGHT / 8))) #define ALLOC_TILES_VARIANT(_animName, _variant) \ VramMalloc(((_animName##_VAR##_variant##_WIDTH / 8) * (_animName##_VAR##_variant##_HEIGHT / 8))) // 858 #define ANIM_CHAOMAP_EMERALD_WIDTH 24 #define ANIM_CHAOMAP_EMERALD_HEIGHT 16 // 873 #define ANIM_BOUNCY_BAR_WIDTH 32 #define ANIM_BOUNCY_BAR_HEIGHT 24 // 875 #define ANIM_CHECKPOINT_WIDTH 24 #define ANIM_CHECKPOINT_HEIGHT 48 #define ANIM_CHECKPOINT_VAR0_WIDTH 16 #define ANIM_CHECKPOINT_VAR0_HEIGHT 48 #define ANIM_CHECKPOINT_VAR1_WIDTH 24 #define ANIM_CHECKPOINT_VAR1_HEIGHT 48 // 878 #define ANIM_TRAMPOLINE_WIDTH 48 #define ANIM_TRAMPOLINE_HEIGHT 32 // 883 #define ANIM_FLAT_SPRING_WIDTH 32 #define ANIM_FLAT_SPRING_HEIGHT 32 // 884 #define ANIM_PLATFORM_RAISING_WHEEL_WIDTH 32 #define ANIM_PLATFORM_RAISING_WHEEL_HEIGHT 24 #define ANIM_PLATFORM_RAISING_WHEEL_PLATFORM_WIDTH 24 #define ANIM_PLATFORM_RAISING_WHEEL_PLATFORM_HEIGHT 24 // 891 #define ANIM_BUNGEE_CORD_WIDTH 8 #define ANIM_BUNGEE_CORD_HEIGHT 8 // 892 #define ANIM_SUNSET_BRIDGE_WIDTH 24 #define ANIM_SUNSET_BRIDGE_HEIGHT 32 // 894 #define ANIM_WAGGLE_COIL_WIDTH 48 #define ANIM_WAGGLE_COIL_HEIGHT 56 // 910 #define ANIM_WATER_CANNON_WIDTH 32 #define ANIM_WATER_CANNON_HEIGHT 48 // 911 #define ANIM_FACTORY_RING_WIDTH 48 #define ANIM_FACTORY_RING_HEIGHT 48 // 912 #define ANIM_SPECIAL_SPRING_WIDTH 32 #define ANIM_SPECIAL_SPRING_HEIGHT 48 // 913 #define ANIM_BONUS_UFO_WIDTH 24 #define ANIM_BONUS_UFO_HEIGHT 48 // 914 #define ANIM_BONUS_UFO_RAY_WIDTH 24 #define ANIM_BONUS_UFO_RAY_HEIGHT 56 // 917 #define ANIM_TOY_BALLOON_WIDTH 32 #define ANIM_TOY_BALLOON_HEIGHT 48 // 920 #define ANIM_PENDULUM_WIDTH 40 #define ANIM_PENDULUM_HEIGHT 40 #define ANIM_PENDULUM_VAR0_WIDTH 40 #define ANIM_PENDULUM_VAR0_HEIGHT 40 #define ANIM_PENDULUM_VAR1_WIDTH 8 #define ANIM_PENDULUM_VAR1_HEIGHT 8 // 921 // Mirrored on X-axis #define ANIM_PLATFORM_SPIKED_WIDTH 32 #define ANIM_PLATFORM_SPIKED_HEIGHT 48 // 923 #define ANIM_ICE_LAUNCHER_WIDTH 48 #define ANIM_ICE_LAUNCHER_HEIGHT 64 // 931 #define ANIM_UFO_PLATFORM_WIDTH 48 #define ANIM_UFO_PLATFORM_HEIGHT 24 // 930 #define ANIM_CLOSING_WALL_WIDTH 72 #define ANIM_CLOSING_WALL_HEIGHT 24 // 933 #define ANIM_FALL_PLATFORM_CA_WIDTH 48 #define ANIM_FALL_PLATFORM_CA_HEIGHT 16 // 934 #define ANIM_WATER_CANNON_SPLASH_WIDTH 48 #define ANIM_WATER_CANNON_SPLASH_HEIGHT 40 // 939 #define ANIM_SPRING_PLATFORM_6_WIDTH 24 #define ANIM_SPRING_PLATFORM_6_HEIGHT 64 // 945 #define ANIM_MUD_FX_WIDTH 48 #define ANIM_MUD_FX_HEIGHT 24 #define ANIM_MUD_FX_CHAOS_ANGEL_WIDTH 48 #define ANIM_MUD_FX_CHAOS_ANGEL_HEIGHT 24 // 948 #define ANIM_GOAL_RING_WIDTH 24 #define ANIM_GOAL_RING_HEIGHT 24 #define ANIM_GOAL_RING_VAR8_WIDTH 24 // Sparkle effect #define ANIM_GOAL_RING_VAR8_HEIGHT 16 // 976 #define ANIM_TOY_BALLOON_POPPED_WIDTH 32 #define ANIM_TOY_BALLOON_POPPED_HEIGHT 48 // 983 #define ANIM_ACT_RING_WIDTH 32 #define ANIM_ACT_RING_HEIGHT 32 #define ANIM_ACT_RING_VAR0_WIDTH 32 #define ANIM_ACT_RING_VAR0_HEIGHT 32 #define ANIM_ACT_RING_VAR1_WIDTH 32 #define ANIM_ACT_RING_VAR1_HEIGHT 32 #define ANIM_ACT_RING_VAR2_WIDTH 32 #define ANIM_ACT_RING_VAR2_HEIGHT 32 // "Crown" signalling completion #define ANIM_ACT_RING_VAR3_WIDTH 24 #define ANIM_ACT_RING_VAR3_HEIGHT 16 // 984 #define ANIM_SPRING_PLATFORM_4_WIDTH 24 #define ANIM_SPRING_PLATFORM_4_HEIGHT 64 // 997 #define ANIM_PLATFORM_BONUS_WIDTH 48 #define ANIM_PLATFORM_BONUS_HEIGHT 48 // 1004 #define ANIM_CHAO_SITTING_WIDTH 32 #define ANIM_CHAO_SITTING_HEIGHT 32 // Enemies // 1166 #define ANIM_SPINNER_WIDTH 48 #define ANIM_SPINNER_HEIGHT 32 // 1168 #define ANIM_AKATENTO_WIDTH 32 #define ANIM_AKATENTO_HEIGHT 24 // 1173 #define ANIM_FROG_WIDTH 32 #define ANIM_FROG_HEIGHT 48 // 1174 #define ANIM_MINIMOLE_WIDTH 48 #define ANIM_MINIMOLE_HEIGHT 24 #define ANIM_MINIMOLE_VAR0_WIDTH 48 #define ANIM_MINIMOLE_VAR0_HEIGHT 24 #define ANIM_MINIMOLE_VAR1_WIDTH 32 #define ANIM_MINIMOLE_VAR1_HEIGHT 8 // 1182 #define ANIM_GAOGAO_WIDTH 32 #define ANIM_GAOGAO_HEIGHT 32 // 1344 #define ANIM_ICE_SHIVER_WIDTH 16 #define ANIM_ICE_SHIVER_HEIGHT 16 // 1348 #define ANIM_SPECIAL_KEY_WIDTH 32 #define ANIM_SPECIAL_KEY_HEIGHT 32 #ifndef GUARD_CONSTANTS_CHARACTERS_H #define GUARD_CONSTANTS_CHARACTERS_H #define CHARACTER_SONIC 0 #define CHARACTER_CREAM 1 #define CHARACTER_TAILS 2 #define CHARACTER_KNUCKLES 3 #define CHARACTER_AMY 4 #define NUM_CHARACTERS 5 #define CHARACTER_BIT(character) (1 << (character)) #define MAIN_CHARACTERS \ (CHARACTER_BIT(CHARACTER_SONIC) | CHARACTER_BIT(CHARACTER_CREAM) | CHARACTER_BIT(CHARACTER_TAILS) | CHARACTER_BIT(CHARACTER_KNUCKLES)) #endif #ifndef GUARD_CONSTANTS_ENEMIES_H #define GUARD_CONSTANTS_ENEMIES_H #define ENEMY__SPINNER 0 #define ENEMY__AKATENTO 1 #define ENEMY__AOTENTO 2 #define ENEMY__CONDOR 3 #define ENEMY__GEKOGEKO 4 #define ENEMY__BUZZER 5 #define ENEMY__MINIMOLE 6 #define ENEMY__APE_0 7 #define ENEMY__APE_1 8 #define ENEMY__TAKKON 9 #define ENEMY__JOUSUN_0 10 #define ENEMY__JOUSUN_1 11 #define ENEMY__UUTSUBO_0 12 #define ENEMY__UUTSUBO_1 13 #define ENEMY__UUTSUBO_2 14 #define ENEMY__UUTSUBO_3 15 #define ENEMY__GUARD 16 #define ENEMY__JUGGLING 17 #define ENEMY__GAOGAO 18 #define ENEMY__BUBU 19 #define ENEMY__GINPE 20 #define ENEMY__YADOKK 21 #define ENEMY__YUKIGASEN_RIGHT 22 #define ENEMY__YUKIGASEN_LEFT 23 #define ENEMY__YUKIGASEN_RIGHT_HI_COOLDOWN 24 #define ENEMY__YUKIGASEN_LEFT_HI_COOLDOWN 25 #define ENEMY__HARIISEN 26 #define ENEMY__CLAM 27 #define ENEMY__KYACCHAA 28 #define ENEMY__KAMAKI 29 #define ENEMY__GURUGURU 30 #define ENEMY__MARUN 31 #define ENEMY__MUUKADEN_0 32 #define ENEMY__MUUKADEN_1 33 #endif // GUARD_CONSTANTS_ENEMIES_H #ifndef GUARD_CONSTANTS_INTERACTABLES_H #define GUARD_CONSTANTS_INTERACTABLES_H #define IA__IA000 0 #define IA__CHECKPOINT 54 #define IA__MUD_FX 95 #define IA__IA105 105 #define IA__SPECIAL_KEY 141 #endif // GUARD_CONSTANTS_INTERACTABLES_H #ifndef GUARD_CONSTANTS_ITEMS_H #define GUARD_CONSTANTS_ITEMS_H #define ITEM__ONE_UP 0 #define ITEM__SHIELD 1 #define ITEM__SHIELD_MAGNETIC 2 #define ITEM__INVINCIBILITY 3 #define ITEM__SPEED_UP 4 #define ITEM__RINGS_RANDOM 5 #define ITEM__RINGS_5 6 #define ITEM__RINGS_10 7 #define ITEM__MP_8 8 #define ITEM__MP_9 9 #define ITEM__MP_10 10 #define ITEM__MP_11 11 #define ITEM__MP_12 12 #endif // GUARD_CONSTANTS_ITEMS_H #ifndef GUARD_MOVESTATES_H #define GUARD_MOVESTATES_H // NOTE(Jace): Movestates are different across games. /* Sonic Advance 3 */ #define MOVESTATE_FACING_LEFT 0x00000001 #define MOVESTATE_2 0x00000002 #define MOVESTATE_IN_AIR 0x00000004 // differs from SA2! #define MOVESTATE_JUMPING (MOVESTATE_IN_AIR | MOVESTATE_2) #define MOVESTATE_8 0x00000008 #define MOVESTATE_10 0x00000010 #define MOVESTATE_20 0x00000020 // Touching switch? #define MOVESTATE_40 0x00000040 // Touching wheel? #define MOVESTATE_80 0x00000080 #define MOVESTATE_100 0x00000100 #define MOVESTATE_200 0x00000200 #define MOVESTATE_400 0x00000400 #define MOVESTATE_800 0x00000800 #define MOVESTATE_1000 0x00001000 #define MOVESTATE_2000 0x00002000 #define MOVESTATE_4000 0x00004000 #define MOVESTATE_8000 0x00008000 #define MOVESTATE_GRAVITY_SWITCHED 0x00010000 #define MOVESTATE_20000 0x00020000 #define MOVESTATE_40000 0x00040000 #define MOVESTATE_80000 0x00080000 #define MOVESTATE_100000 0x00100000 #define MOVESTATE_200000 0x00200000 #define MOVESTATE_400000 0x00400000 #define MOVESTATE_800000 0x00800000 #define MOVESTATE_1000000 0x01000000 #define MOVESTATE_2000000 0x02000000 #define MOVESTATE_4000000 0x04000000 #define MOVESTATE_IGNORE_INPUT 0x08000000 // does not ignore Start-Button #define MOVESTATE_10000000 0x10000000 #define MOVESTATE_20000000 0x20000000 #define MOVESTATE_40000000 0x40000000 #define MOVESTATE_80000000 0x80000000 #endif // GUARD_MOVESTATES_H #ifndef GUARD_PLAYER_TRANSITIONS_H #define GUARD_PLAYER_TRANSITIONS_H // 0x07 = Set in Egg Utopia - Launcher // 0x0A = Player cleared the stage (only for Acts, not Bosses?) // 0x0B = Something Grinding // 0x0C = Something Grinding // 0x0D = Something Grinding // 0x16 = Set in IA Ramp // 0x17 = Used in Interactable_044 // 0x18 = Dash Ring Object // 0x1C = Set by IA ClearPipe_End if data[1] is 0 #define PLTRANS_NONE 0 #define PLTRANS_PT1 1 #define PLTRANS_PT2 2 #define PLTRANS_PT3 3 #define PLTRANS_PT4 4 #define PLTRANS_PT5 5 #define PLTRANS_PT6 6 #define PLTRANS_PT7 7 #define PLTRANS_PT8 8 #define PLTRANS_PT9 9 #define PLTRANS_PT10 10 #define PLTRANS_PT11 11 #define PLTRANS_PT12 12 #define PLTRANS_PT13 13 #define PLTRANS_SPRING_UP 14 #define PLTRANS_SPRING_DOWN 15 #define PLTRANS_SPRING_LEFT 16 #define PLTRANS_SPRING_RIGHT 17 #define PLTRANS_SPRING_UP_LEFT 18 #define PLTRANS_SPRING_UP_RIGHT 19 #define PLTRANS_SPRING_DOWN_LEFT 20 #define PLTRANS_SPRING_DOWN_RIGHT 21 #define PLTRANS_PT22 22 #define PLTRANS_PT23 23 #define PLTRANS_PT24 24 #define PLTRANS_PT25 25 #define PLTRANS_PT26 26 #define PLTRANS_PT27 27 #define PLTRANS_PT28 28 #endif // GUARD_PLAYER_TRANSITIONS_H #ifndef GUARD_CONSTANTS_SONGS_H #define GUARD_CONSTANTS_SONGS_H #define MUS_INTRO 0x0 #define MUS_TITLE_SCREEN 0x1 #define MUS_MAIN_MENU 0x2 #define MUS_CHARACTER_SELECT 0x3 #define MUS_SONIC_FACTORY 0x4 #define MUS_OPTIONS 0x5 #define MUS_OPTIONS_COPY 0x6 #define MUS_CHAO_PLAYGROUND 0x7 #define MUS_NEWGAME_INTRO 0x8 #define MUS_DUMMY__9 0x9 #define MUS_OVERWORLD__ROUTE_99 0xA #define MUS_OVERWORLD__SUNSET_HILL 0xB #define MUS_OVERWORLD__OCEAN_BASE 0xC #define MUS_OVERWORLD__TOY_KINGDOM 0xD #define MUS_OVERWORLD__TWINKLE_SNOW 0xE #define MUS_OVERWORLD__CYBER_TRACK 0xF #define MUS_OVERWORLD__CHAOS_ANGEL 0x10 #define MUS_OVERWORLD__ALTAR_EMERALD 0x11 // @TODO: Find better name? (Not really an overworld in Altar Emerald's case) #define MUS_INTACT_MUSIC_1 0x12 #define MUS_DUMMY__19 0x13 /* Act Themes */ #define MUS_ROUTE_99__ACT_1 0x14 #define MUS_ROUTE_99__ACT_2 0x15 #define MUS_ROUTE_99__ACT_3 0x16 // MUS_ROUTE_99__ACT_4 0x17 // Placeholder. One of many signs showing that 4 // Acts per Zone were most likely planned #define MUS_SUNSET_HILL__ACT_1 0x18 #define MUS_SUNSET_HILL__ACT_2 0x19 #define MUS_SUNSET_HILL__ACT_3 0x1A // MUS_SUNSET_HILL__ACT_4 0x1B // Placeholder/Dummy #define MUS_OCEAN_BASE__ACT_1 0x1C #define MUS_OCEAN_BASE__ACT_2 0x1D #define MUS_OCEAN_BASE__ACT_3 0x1E // MUS_OCEAN_BASE__ACT_4 0x1F // Placeholder/Dummy #define MUS_TOY_KINGDOM__ACT_1 0x20 #define MUS_TOY_KINGDOM__ACT_2 0x21 #define MUS_TOY_KINGDOM__ACT_3 0x22 // MUS_TOY_KINGDOM__ACT_4 0x23 // Placeholder/Dummy #define MUS_TWINKLE_SNOW__ACT_1 0x24 #define MUS_TWINKLE_SNOW__ACT_2 0x25 #define MUS_TWINKLE_SNOW__ACT_3 0x26 // MUS_TWINKLE_SNOW__ACT_4 0x27 // Placeholder/Dummy #define MUS_CYBER_TRACK__ACT_1 0x28 #define MUS_CYBER_TRACK__ACT_2 0x29 #define MUS_CYBER_TRACK__ACT_3 0x2A // MUS_CYBER_TRACK__ACT_4 0x2B // Placeholder/Dummy #define MUS_CHAOS_ANGEL__ACT_1 0x2C #define MUS_CHAOS_ANGEL__ACT_2 0x2D #define MUS_CHAOS_ANGEL__ACT_3 0x2E // MUS_CHAOS_ANGEL__ACT_4 0x2F // Placeholder/Dummy #define MUS_DUMMY__48 0x30 #define MUS_DUMMY__49 0x31 #define MUS_VS__BOSS 0x32 #define MUS_VS__BOSS_PINCH 0x33 #define MUS_VS__7_BOSS 0x34 #define MUS_VS__7_BOSS_PINCH 0x35 #define MUS_VS__FINAL_BOSS 0x36 #define MUS_VS__FINAL_BOSS_PINCH 0x37 #define MUS_VS__EX_BOSS 0x38 // NONAGRESSION? #define MUS_VS__EX_BOSS_PINCH 0x39 #define MUS_INTACT_MUSIC_2 0x3A #define MUS_DEMO 0x3B // @TODO Better name? (this one is from soundtest) #define MUS_EX_DEMO_1 0x3C #define MUS_EX_DEMO_2 0x3D #define MUS_ENDING_A 0x3E #define MUS_ENDING_B 0x3F #define MUS_STAFF_CREDITS 0x40 #define MUS_SPECIAL_STAGE 0x41 #define MUS_SPECIAL_STAGE_RESULT_1 0x42 #define MUS_SPECIAL_STAGE_RESULT_2 0x43 #define MUS_VS_MUSIC_1 0x44 // Checking connection #define MUS_VS_MUSIC_2 0x45 #define MUS_VS_MUSIC_3 0x46 #define MUS_TIME_ATTACK_1 0x47 // Choose stage #define MUS_TIME_ATTACK_2 0x48 // Try again #define MUS_INVINCIBILITY 0x49 #define MUS_DUMMY__74 0x4A #define MUS_DROWNING 0x4B #define MUS_MINIGAME 0x4C #define MUS_DUMMY__77 0x4D #define MUS_78 0x4E #define MUS_ENDING_A_COPY 0x4F // @TODO: Find out whether there are differences between this and MUS_ENDING_A #define MUS_DUMMY__80 0x50 #define MUS_EMERALD_GET 0x51 #define MUS_GAME_OVER 0x52 #define MUS_1_UP 0x53 #define MUS_EXTRALIFE 0x53 #define MUS_STAGE_CLEAR_GOLD 0x54 #define MUS_STAGE_CLEAR 0x55 #define MUS_BOSS_CLEAR_GOLD 0x56 #define MUS_BOSS_CLEAR 0x57 #define MUS_FINAL_CLEAR 0x58 #define MUS_EXTRA_CLEAR 0x59 #define MUS_DUMMY__90 0x5A #define MUS_MESSAGE 0x5B #define MUS_SPECIAL_STAGE_CLEAR 0x5C #define MUS_DUMMY__93 0x5D #define MUS_DUMMY__94 0x5E #define MUS_TIME_ATTACK_CLEAR_1 0x5F #define MUS_TIME_ATTACK_CLEAR_2 0x60 #define MUS_VS_BGM_4 0x61 #define MUS_VS_BGM_5 0x62 #define MUS_VS_SUCCESS 0x63 #define MUS_VS_MISS 0x64 #define MUS_DUMMY__101 0x65 #define SE_RING_OLD 0x66 #define SE_CHARSELECT_SLIDE 0x67 #define SE_104 0x68 #define SE_105 0x69 #define SE_SELECT 0x6A #define SE_ABORT 0x6B #define SE_DPAD_SELECT 0x6C // @TODO: Look up official names for moves! #define SE_SPIN_ATTACK 0x6D #define SE_SPIN_RELEASE 0x6E #define SE_GROUND_SLIDE 0x6F #define SE_GRINDING 0x72 #define SE_STOPPING 0x73 #define SE_JUMP 0x74 #define SE_RING_OLD_2 0x75 #define SE_LOST_RINGS 0x76 #define SE_HIT_WITH_NO_RINGS 0x77 #define SE_TAILS__FLYING 0x78 #define SE_TAILS__TAIL_HIT 0x79 #define MUS_DUMMY__122 0x7A #define MUS_DUMMY__123 0x7B #define MUS_DUMMY__124 0x7C #define SE_KNUCKLES__WALL_CLIMBING 0x7D #define SE_126 0x7E #define MUS_DUMMY__127 0x7F #define SE_AMY__PIKO_PIKO_NEUTRAL 0x80 #define SE_AMY__PIKO_PIKO_NEUTRAL_AIR 0x81 #define MUS_DUMMY__130 0x82 #define SE_AMY__DOWN_B 0x83 #define MUS_DUMMY__132 0x84 #define MUS_DUMMY__133 0x85 #define MUS_DUMMY__134 0x86 #define SE_GOAL_POST_OLD 0x87 #define MUS_DUMMY__136 0x88 #define MUS_DUMMY__137 0x89 #define MUS_DUMMY__140 0x8C #define MUS_DUMMY__141 0x8D #define SE_PAUSE 0x8E #define MUS_DUMMY__144 0x91 #define MUS_DUMMY__145 0x92 #define MUS_DUMMY__146 0x93 #define SE_BOUNCE_PAD 0x94 #define SE_148 0x95 #define SE_ITEMBOX 0x96 #define SE_SHIELD_ACTIVATE 0x97 #define SE_CHECKPOINT 0x98 #define MUS_DUMMY__153 0x99 #define SE_SPIKES 0x9A #define SE_SPEED_BOOSTER 0x9B #define SE_156 0x9C #define SE_157 0x9D #define SE_158 0x9E /* Dummy Entries from 0x9F to 0xA8 */ #define SE_BOUNCY_BAR 0xA9 #define SE_TRAMPOLINE 0xAA /* Dummy Entries from 0xAB to 0xDB */ #define SE_DC 0xDC #define SE_CHAR_BOOST 0xDD #define MUS_DUMMY__225 0xE1 #define SE_226 0xE2 #define SE_CREAM__FLYING 0xE3 #define MUS_DUMMY__228 0xE4 #define MUS_DUMMY__229 0xE5 #define SE_AIR_TRICK_SA2 0xE6 #define SE_231 0xE7 // @TODO: Maybe water effect from SA2's intro? #define MUS_DUMMY__232 0xE8 #define MUS_DUMMY__233 0xE9 #define MUS_DUMMY__234 0xEA #define SE_235 0xEB #define MUS_DUMMY__236 0xEC #define SE_237 0xED /* Dummy Entries from 0xEE to 0x113 */ #define SE_LAUNCH_PAD 0x114 #define SE_277 0x115 #define MUS_DUMMY__278 0x116 #define MUS_DUMMY__279 0x117 #define SE_ROTATING_HANDLE 0x118 #define SE_281 0x119 #define SE_282 0x11A /* Dummy Entries from 0x11B to 0x121 */ #define SE_290 0x122 /* Dummy Entries from 0x123 to 0x1F3 */ // XYZ_LOW: Low enthusiasm // XYZ_HIGH: High enthusiasm #define VOICE__ANNOUNCER__SONIC_ADVANCE_3 0x1F4 #define VOICE__ANNOUNCER__SONIC_LOW 0x1F5 #define VOICE__ANNOUNCER__SONIC_HIGH 0x1F6 #define VOICE__ANNOUNCER__TAILS_LOW 0x1F7 #define VOICE__ANNOUNCER__TAILS_HIGH 0x1F8 #define VOICE__ANNOUNCER__KNUCKLES_LOW 0x1F9 #define VOICE__ANNOUNCER__KNUCKLES_HIGH 0x1FA #define VOICE__ANNOUNCER__AMY_LOW 0x1FB #define VOICE__ANNOUNCER__AMY_HIGH 0x1FC #define VOICE__ANNOUNCER__CREAM_LOW 0x1FD #define VOICE__ANNOUNCER__CREAM_HIGH 0x1FE #define VOICE__ANNOUNCER__AND 0x1FF #define VOICE__ANNOUNCER__CONGRATULATIONS 0x200 // When Omochao gets picked up by the player... #define SE_PICKUP_OMOCHAO_1 0x201 // This plays second #define SE_PICKUP_OMOCHAO_2 0x202 // This plays first #define SE_515 0x203 #define VOICE__CHAO__COLLECTED 0x204 #define SE_SPECIAL_KEY 0x205 #define SE_SPECIAL_SPRING 0x206 #define SE_GOAL_RING 0x207 #define SE_GOAL_RING_RESULT 0x208 #define SE_BIG_WARP_RING 0x209 #define SE_BONUS_UFO 0x20A #define SE_523 0x20B // Bonus Capsule switch? #define SE_BONUS_DEFEATED_ENEMY 0x20C #define SE_BONUS_1UP_COUNTER 0x20D #define SE_526 0x20E #define SE_527 0x20F #define SE_CREAM__CHEESE_ATTACK 0x210 #define SE_TAILS__SWIM 0x21B #define SE_TAGACTION_CHARGED 0x21B #define SE_TAGACTION_BUILDUP 0x21C #define SE_ELEVATING_HANDLE 0x247 #define SE_TIMED_SWITCH 0x249 #define SE_588 0x24C #define SE_WAGGLE_COIL 0x250 #define SE_WATER_CANNON 0x255 #define SE_ROCKET_ACCELERATING 0x256 #define SE_599 0x257 // Also used for Toy Balloon in Toy Kingdom #define SE_MINECART_DESTROYED 0x258 #define SE_PENDULUM_HIT 0x25B #define SE_MINECART_ROLL 0x25E #define SE_607 0x25F #define SE_GONDOLA 0x261 // SE_610 sounds like Knuckles climbing a wall, but is used in an IA #define SE_610 0x262 #define SE_UFO_PLATFORM 0x263 #define VOICE__SONIC__OKAY 0x265 #define VOICE__SONIC__YEAH 0x266 #define VOICE__SONIC__WHOA 0x267 #define VOICE__SONIC__ALRIGHT 0x268 #define VOICE__TAILS__OKAY 0x269 #define VOICE__TAILS__YEAH 0x26A #define VOICE__TAILS__UARGH 0x26B #define VOICE__TAILS__HEHEHE 0x26C #define VOICE__TAILS__ALRIGHT 0x26D #define VOICE__KNUCKLES__COOL 0x26E #define MUS_DUMMY__623 0x26F #define VOICE__KNUCKLES__HUH 0x270 #define VOICE__KNUCKLES__HUARGH 0x271 #define VOICE__KNUCKLES__LETS_GO 0x272 #define VOICE__KNUCKLES__ALRIGHT 0x273 #define VOICE__AMY__WOOHOO 0x274 #define VOICE__AMY__HEY 0x275 #define VOICE__AMY__NO 0x276 #define VOICE__AMY__YEAH 0x277 #define VOICE__CREAM__HERE_WE_GO 0x278 #define VOICE__CREAM__YEAH 0x279 #define VOICE__CREAM__OH 0x27A #define VOICE__CREAM__ALRIGHT 0x27B #define VOICE__EGGMAN__OW 0x27C #define VOICE__EGGMAN__YOU_LITTLE 0x27D #define VOICE__EGGMAN__YOURE_GOING_TO_PAY_FOR_THIS 0x27E /* Dummy entries from 0x27F to 0x298 */ #define SE_ROCKET_EXPLODING 0x299 #define SE_666 0x29A #define SE_667 0x29B #define SE_668 0x29C #define SE_PHOTO_CAMERA 0x29D #define SE_670 0x29E #define SE_671 0x29F #define SE_672 0x2A0 #define SE_673 0x2A1 /* Dummy entries from 0x2A2 to 0x320 */ #define MUS_VS_BGM_6 0x321 #define MUS_VS_BGM_7 0x322 #define MUS_VS_BGM_9 0x323 #define MUS_DUMMY__804 0x324 #define MUS_VS_BGM_8 0x325 #define MUS_DUMMY__806 0x326 #define MUS_DUMMY__807 0x327 #define MUS_DUMMY__808 0x328 #define MUS_DUMMY__809 0x329 #define SE_VS__SELECT 0x32A #define SE_VS__811 0x32B #define SE_VS__812 0x32C #define SE_VS__813 0x32D #define SE_VS__JUMP 0x32E #define MUS_DUMMY__815 0x32F #define MUS_DUMMY__816 0x330 #define MUS_DUMMY__817 0x331 #define MUS_DUMMY__818 0x332 #define SE_VS__ITEMBOX 0x333 #define SE_VS__SPRING 0x334 #define SE_VS__SPIKE 0x335 #define SE_VS__DING_DONG 0x336 #define SE_VS__823 0x337 #define MUS_DUMMY__824 0x338 #define MUS_DUMMY__825 0x339 #define SE_VS__GRINDING 0x33A #define SE_VS__SPEED_BOOSTER 0x33B #define VOICE_VS__CHAO_COLLECTED 0x33C #endif #define NUM_LANGUAGES 6 #define LANG_DEFAULT 0 #define LANG_JAPANESE 1 #define LANG_ENGLISH 2 #define LANG_GERMAN 3 #define LANG_FRENCH 4 #define LANG_SPANISH 5 #define LANG_ITALIAN 6 #define LanguageIndex(lang) (lang - 1) #define TextElementOffset(lang, elementsPerLang, element) (element + ((lang) * (elementsPerLang))) #define TextElementOffsetAlt(lang, elementsPerLang, element) (((lang) * (elementsPerLang)) + element) // TODO: move these to a better place #define TextElementAlt(elementsPerLang, lang, element, a, b) \ [(lang) * (elementsPerLang) + (element - 1)] = { .numTiles = (a), .anim = (b), .variant = (element) } #define TextElement(elementsPerLang, lang, element, a, b) \ [TextElementOffset(lang, elementsPerLang, element)] = { .numTiles = (a), .anim = (b), .variant = (element) } #define TextElementAlt2(lang, element, a, b) [lang] = { .numTiles = (a), .anim = (b), .variant = (element) } #define TextElementAlt3(element, a, b) [element] = { .numTiles = (a), .anim = (b), .variant = (element) } #define TextElementAlt4(_variant, _numTiles, _anim) \ { \ .numTiles = (_numTiles), .anim = (_anim), .variant = (_variant) \ } #ifndef GUARD_TILEMAPS #define GUARD_TILEMAPS // NOTE: * 0-92 are MapHeaders // * 93 == NULL #define TM_LEVEL_METATILES_0(level) (((level)*3) + 0) #define TM_LEVEL_METATILES_1(level) (((level)*3) + 1) #define TM_LEVEL_BG(level) (((level)*3) + 2) #define TM_EMPTY_93 93 #define TM_SA1_TITLE_LOGO 94 #define TM_SA1_TITLE_BG 95 #define TM_INTRO_PRESENTED_BY_SEGA 96 #define TM_INTRO_CREATED_BY_SONIC_TEAM 97 #define TM_CHARACTER_SELECT_BACKGROUND 98 #define TM_CHARACTER_SELECT_WHEEL 99 #define TM_STAGE_SELECT_BG_SONIC 100 #define TM_STAGE_SELECT_BG_CREAM 101 #define TM_STAGE_SELECT_BG_TAILS 102 #define TM_STAGE_SELECT_BG_KNUCKLES 103 #define TM_STAGE_SELECT_BG_AMY 104 #define TM_STAGE_SELECT_MAP 105 #define TM_EGG_SAUCER_WHEEL_COPY 106 #define TM_UNKNOWN_OPTIONS_BG 107 #define TM_TILEMAP_108 108 #define TM_SA2_TITLE_LOGO_JP 109 #define TM_TA_AND_MP_WHITE_BG 110 #define TM_MP_ORANGE_BG 111 #define TM_TA_ORANGE_BG 112 #define TM_STAGE_1_BG_0_COPY 113 #define TM_MP_WAIT_CONNECTION 114 #define TM_MP_MESSAGE_BOX_UNKNOWN 115 #define TM_MP_CHARACTERS_SELECTED_JP 116 #define TM_MP_CHARACTERS_SELECTED_EN 117 #define TM_MP_CHARACTERS_SELECTED_DE 118 #define TM_MP_CHARACTERS_SELECTED_FR 119 #define TM_MP_CHARACTERS_SELECTED_ES 120 #define TM_MP_CHARACTERS_SELECTED_IT 121 #define TM_MP_UNKNOWN_ORANGE_ZIGZAG 122 #define TM_MP_UNKNOWN_GREEN 123 #define TM_UNKNOWN_MESSAGE_BOX_WHITE 124 #define TM_UNKNOWN_MESSAGE_BOX_WHITE_SMALL 125 #define TM_MP_VS_BACKGROUND_TEXT 126 #define TM_MP_CHEESE_PLEASE_WAIT_JP 127 #define TM_MP_CHEESE_PLEASE_WAIT_EN 128 #define TM_MP_CHEESE_PLEASE_WAIT_DE 129 #define TM_MP_CHEESE_PLEASE_WAIT_FR 130 #define TM_MP_CHEESE_PLEASE_WAIT_ES 131 #define TM_MP_CHEESE_PLEASE_WAIT_IT 132 #define TM_OPTIONS_BG0 133 #define TM_OPTIONS_LANGUAGE_SELECT 134 #define TM_OPTIONS_ENTER_NAME 135 #define TM_OPTIONS_ENTER_NAME_CHARACTERS 136 #define TM_OPTIONS_TIME_RECORD_BG0 137 #define TM_OPTIONS_TIME_RECORD_BG1 138 #define TM_TILEMAP_139 139 #define TM_MP_CHARACTER_SELECTED_SONIC_BG 140 #define TM_MP_CHARACTER_SELECTED_SONIC 141 #define TM_MP_CHARACTER_SELECTED_TAILS_BG 142 #define TM_MP_CHARACTER_SELECTED_TAILS 143 #define TM_MP_CHARACTER_SELECTED_KNUCKLES_BG 144 #define TM_MP_CHARACTER_SELECTED_KNUCKLES 145 #define TM_MP_CHARACTER_SELECTED_AMY_BG 146 #define TM_MP_CHARACTER_SELECTED_AMY 147 #define TM_MP_CHARACTER_SELECTED_CREAM_BG 148 #define TM_MP_CHARACTER_SELECTED_CREAM 149 #define TM_MESSAGE_BOX_BLACK 150 #define TM_GREEN_CARET 151 #define TM_OPTIONS_VS_RECORD_BG1 152 #define TM_SPECIAL_STAGE_1 153 #define TM_SPECIAL_STAGE_1_BG 154 #define TM_SPECIAL_STAGE_2 155 #define TM_SPECIAL_STAGE_2_BG 156 #define TM_SPECIAL_STAGE_3 157 #define TM_SPECIAL_STAGE_3_BG 158 #define TM_SPECIAL_STAGE_4 159 #define TM_SPECIAL_STAGE_4_BG 160 #define TM_SPECIAL_STAGE_5 161 #define TM_SPECIAL_STAGE_5_BG 162 #define TM_SPECIAL_STAGE_6 163 #define TM_SPECIAL_STAGE_6_BG 164 #define TM_SPECIAL_STAGE_7 165 #define TM_SPECIAL_STAGE_7_BG 166 #define TM_TECHNO_BASE_BG_PURPLE_GRID 167 #define TM_TECHNO_BASE_BG_CIRCUIT_MASK 168 #define TM_SOUND_TEST_BG 169 #define TM_CUTSCENE_POST_EXTRA_BOSS_BG 170 #define TM_CUTSCENE_FINAL_ENDING_FALL_BG 171 #define TM_CUTSCENE_FINAL_ENDING_FALL_CLOUDS 172 #define TM_CUTSCENE_FINAL_ENDING_FALL_BG_DARK 173 #define TM_CUTSCENE_FINAL_ENDING_FALL_BG_DARK_2 174 // This has an image of Eggman, other languages are only the textbox #define TM_COLLECT_ALL_CHAOS_EMERALDS_JP 175 #define TM_COLLECT_ALL_CHAOS_EMERALDS_EN 176 #define TM_COLLECT_ALL_CHAOS_EMERALDS_FR 177 #define TM_COLLECT_ALL_CHAOS_EMERALDS_DE 178 #define TM_COLLECT_ALL_CHAOS_EMERALDS_IT 179 #define TM_COLLECT_ALL_CHAOS_EMERALDS_ES 180 // (Also used as BG for SoundTest unlock) This fills the entire screen, other // languages are only the textbox #define TM_UNLOCKED_TINY_CHAO_GARDEN_JP 181 #define TM_UNLOCKED_TINY_CHAO_GARDEN_EN 182 #define TM_UNLOCKED_TINY_CHAO_GARDEN_FR 183 #define TM_UNLOCKED_TINY_CHAO_GARDEN_DE 184 #define TM_UNLOCKED_TINY_CHAO_GARDEN_IT 185 #define TM_UNLOCKED_TINY_CHAO_GARDEN_ES 186 // Uses TM_UNLOCKED_TINY_CHAO_GARDEN_JP as BG #define TM_UNLOCKED_SOUND_TEST_JP 187 #define TM_UNLOCKED_SOUND_TEST_EN 188 #define TM_UNLOCKED_SOUND_TEST_FR 189 #define TM_UNLOCKED_SOUND_TEST_DE 190 #define TM_UNLOCKED_SOUND_TEST_IT 191 #define TM_UNLOCKED_SOUND_TEST_ES 192 // Uses TM_UNLOCKED_TINY_CHAO_GARDEN_JP as BG #define TM_UNLOCKED_BOSSES_TIME_ATTACK_JP 193 #define TM_UNLOCKED_BOSSES_TIME_ATTACK_EN 194 #define TM_UNLOCKED_BOSSES_TIME_ATTACK_FR 195 #define TM_UNLOCKED_BOSSES_TIME_ATTACK_DE 196 #define TM_UNLOCKED_BOSSES_TIME_ATTACK_IT 197 #define TM_UNLOCKED_BOSSES_TIME_ATTACK_ES 198 #define TM_UNLOCKED_AMY_JP 199 #define TM_UNLOCKED_AMY_EN 200 #define TM_UNLOCKED_AMY_FR 201 #define TM_UNLOCKED_AMY_DE 202 #define TM_UNLOCKED_AMY_IT 203 #define TM_UNLOCKED_AMY_ES 204 #define TM_CUTSCENE_FINAL_ENDING_LAND_FG 205 #define TM_CUTSCENE_FINAL_ENDING_LAND_BG 206 #define TM_CUTSCENE_FINAL_ENDING_LAND_FLOWER_FIELD 207 #define TM_CUTSCENE_FINAL_ENDING_LAND_BG_ALT 208 #define TM_UNK_SPACE_BG 209 #define TM_STORYFRAME_SONIC_CATCHES_VANILLA 210 #define TM_STORYFRAME_SONIC_FINDS_FRIENDS 211 #define TM_STORYFRAME_SONIC_PATS_TAILS 212 #define TM_STORYFRAME_CREAM_HUGS_VANILLA 213 #define TM_STORYFRAME_CREAM_TAILS_VANILLA_LOOK_AROUND 214 #define TM_STORYFRAME_CREAM_CHEESE_VANILLA_HAPPY 215 #define TM_STORYFRAME_SONIC_LEAVES_0 216 #define TM_STORYFRAME_SONIC_LEAVES_1 217 #define TM_STORYFRAME_SONIC_LEAVES_2 218 #define TM_STORYFRAME_SONIC_LEAVES_3 219 #define TM_STORYFRAME_SONIC_LEAVES_4 220 #define TM_STORYFRAME_SONIC_LEAVES_5 221 #define TM_STORYFRAME_SONIC_LEAVES_6 222 #define TM_STORYFRAME_SONIC_LEAVES_7 223 #define TM_STORYFRAME_SONIC_LEAVES_8 224 #define TM_STORYFRAME_SONIC_LEAVES_9 225 #define TM_STORYFRAME_SONIC_LEAVES_10 226 #define TM_STORYFRAME_CREAM_UNLOCK_0_SEPIA 227 #define TM_STORYFRAME_CREAM_UNLOCK_1_SEPIA 228 #define TM_STORYFRAME_TAILS_UNLOCK_1_SEPIA 229 #define TM_STORYFRAME_KNUCKLES_UNLOCK_1_SEPIA 230 #define TM_STORYFRAME_CREAM_UNLOCK_3_SEPIA 231 #define TM_CREDITS_SA2_LOGO_JP 232 #define TM_CREDITS_SA2_LOGO_EN 233 #define TM_CREDITS_0 234 #define TM_CREDITS_1 235 #define TM_CREDITS_2 236 #define TM_CREDITS_3 237 #define TM_CREDITS_4 238 #define TM_CREDITS_5 239 #define TM_CREDITS_6 240 #define TM_CREDITS_7 241 #define TM_CREDITS_8 242 #define TM_CREDITS_9 243 #define TM_CREDITS_10 244 #define TM_CREDITS_11 245 #define TM_CREDITS_12 246 #define TM_CREDITS_13 247 #define TM_CREDITS_14 248 #define TM_CREDITS_15 249 #define TM_CREDITS_16 250 #define TM_CREDITS_17 251 #define TM_CREDITS_18 252 #define TM_CREDITS_19 253 #define TM_CREDITS_20 254 #define TM_CREDITS_21 255 #define TM_CREDITS_22 256 #define TM_CREDITS_23 257 #define TM_CREDITS_24 258 #define TM_CREDITS_COPYRIGHT 259 #define TM_CREDITS_PRESENTED_BY_SEGA 260 #define TM_TITLE_SCREEN_BG 261 #define TM_INTRO_WATER 262 #define TM_LENS_FLARE_BG 263 #define TM_SA2_LOGO_JP 264 #define TM_SA2_LOGO_EN 265 #define TM_STORYFRAME_CREAM_UNLOCK_0 266 #define TM_STORYFRAME_CREAM_UNLOCK_1 267 #define TM_STORYFRAME_CREAM_UNLOCK_2 268 #define TM_STORYFRAME_CREAM_UNLOCK_3 269 #define TM_STORYFRAME_CREAM_UNLOCK_0_DLG_JP 270 #define TM_STORYFRAME_CREAM_UNLOCK_1_DLG_JP 271 #define TM_STORYFRAME_CREAM_UNLOCK_2_DLG_JP 272 #define TM_STORYFRAME_CREAM_UNLOCK_3_DLG_JP 273 #define TM_STORYFRAME_CREAM_UNLOCKED_JP 274 #define TM_STORYFRAME_CREAM_UNLOCK_0_DLG_EN 275 #define TM_STORYFRAME_CREAM_UNLOCK_1_DLG_EN 276 #define TM_STORYFRAME_CREAM_UNLOCK_2_DLG_EN 277 #define TM_STORYFRAME_CREAM_UNLOCK_3_DLG_EN 278 #define TM_STORYFRAME_CREAM_UNLOCKED_EN 279 #define TM_STORYFRAME_CREAM_UNLOCK_0_DLG_FR 280 #define TM_STORYFRAME_CREAM_UNLOCK_1_DLG_FR 281 #define TM_STORYFRAME_CREAM_UNLOCK_2_DLG_FR 282 #define TM_STORYFRAME_CREAM_UNLOCK_3_DLG_FR 283 #define TM_STORYFRAME_CREAM_UNLOCKED_FR 284 #define TM_STORYFRAME_CREAM_UNLOCK_0_DLG_DE 285 #define TM_STORYFRAME_CREAM_UNLOCK_1_DLG_DE 286 #define TM_STORYFRAME_CREAM_UNLOCK_2_DLG_DE 287 #define TM_STORYFRAME_CREAM_UNLOCK_3_DLG_DE 288 #define TM_STORYFRAME_CREAM_UNLOCKED_DE 289 #define TM_STORYFRAME_CREAM_UNLOCK_0_DLG_IT 290 #define TM_STORYFRAME_CREAM_UNLOCK_1_DLG_IT 291 #define TM_STORYFRAME_CREAM_UNLOCK_2_DLG_IT 292 #define TM_STORYFRAME_CREAM_UNLOCK_3_DLG_IT 293 #define TM_STORYFRAME_CREAM_UNLOCKED_IT 294 #define TM_STORYFRAME_CREAM_UNLOCK_0_DLG_ES 295 #define TM_STORYFRAME_CREAM_UNLOCK_1_DLG_ES 296 #define TM_STORYFRAME_CREAM_UNLOCK_2_DLG_ES 297 #define TM_STORYFRAME_CREAM_UNLOCK_3_DLG_ES 298 #define TM_STORYFRAME_CREAM_UNLOCKED_ES 299 #define TM_STORYFRAME_KNUCKLES_UNLOCK_0 300 #define TM_STORYFRAME_KNUCKLES_UNLOCK_1 301 #define TM_STORYFRAME_KNUCKLES_UNLOCK_2 302 #define TM_STORYFRAME_KNUCKLES_UNLOCK_3 303 #define TM_STORYFRAME_KNUCKLES_UNLOCK_0_DLG_JP 304 #define TM_STORYFRAME_KNUCKLES_UNLOCK_1_DLG_JP 305 #define TM_STORYFRAME_KNUCKLES_UNLOCK_2_DLG_JP 306 #define TM_STORYFRAME_KNUCKLES_UNLOCK_3_DLG_JP 307 #define TM_STORYFRAME_KNUCKLES_UNLOCKED_JP 308 #define TM_STORYFRAME_KNUCKLES_UNLOCK_0_DLG_EN 309 #define TM_STORYFRAME_KNUCKLES_UNLOCK_1_DLG_EN 310 #define TM_STORYFRAME_KNUCKLES_UNLOCK_2_DLG_EN 311 #define TM_STORYFRAME_KNUCKLES_UNLOCK_3_DLG_EN 312 #define TM_STORYFRAME_KNUCKLES_UNLOCKED_EN 313 #define TM_STORYFRAME_KNUCKLES_UNLOCK_0_DLG_FR 314 #define TM_STORYFRAME_KNUCKLES_UNLOCK_1_DLG_FR 315 #define TM_STORYFRAME_KNUCKLES_UNLOCK_2_DLG_FR 316 #define TM_STORYFRAME_KNUCKLES_UNLOCK_3_DLG_FR 317 #define TM_STORYFRAME_KNUCKLES_UNLOCKED_FR 318 #define TM_STORYFRAME_KNUCKLES_UNLOCK_0_DLG_DE 319 #define TM_STORYFRAME_KNUCKLES_UNLOCK_1_DLG_DE 320 #define TM_STORYFRAME_KNUCKLES_UNLOCK_2_DLG_DE 321 #define TM_STORYFRAME_KNUCKLES_UNLOCK_3_DLG_DE 322 #define TM_STORYFRAME_KNUCKLES_UNLOCKED_DE 323 #define TM_STORYFRAME_KNUCKLES_UNLOCK_0_DLG_IT 324 #define TM_STORYFRAME_KNUCKLES_UNLOCK_1_DLG_IT 325 #define TM_STORYFRAME_KNUCKLES_UNLOCK_2_DLG_IT 326 #define TM_STORYFRAME_KNUCKLES_UNLOCK_3_DLG_IT 327 #define TM_STORYFRAME_KNUCKLES_UNLOCKED_IT 328 #define TM_STORYFRAME_KNUCKLES_UNLOCK_0_DLG_ES 329 #define TM_STORYFRAME_KNUCKLES_UNLOCK_1_DLG_ES 330 #define TM_STORYFRAME_KNUCKLES_UNLOCK_2_DLG_ES 331 #define TM_STORYFRAME_KNUCKLES_UNLOCK_3_DLG_ES 332 #define TM_STORYFRAME_KNUCKLES_UNLOCKED_ES 333 #define TM_STORYFRAME_TAILS_UNLOCK_0 334 #define TM_STORYFRAME_TAILS_UNLOCK_1 335 #define TM_STORYFRAME_TAILS_UNLOCK_2 336 #define TM_STORYFRAME_TAILS_UNLOCK_3 337 #define TM_STORYFRAME_TAILS_UNLOCK_0_DLG_JP 338 #define TM_STORYFRAME_TAILS_UNLOCK_1_DLG_JP 339 #define TM_STORYFRAME_TAILS_UNLOCK_2_DLG_JP 340 #define TM_STORYFRAME_TAILS_UNLOCK_3_DLG_JP 341 #define TM_STORYFRAME_TAILS_UNLOCKED_JP 342 #define TM_STORYFRAME_TAILS_UNLOCK_0_DLG_EN 343 #define TM_STORYFRAME_TAILS_UNLOCK_1_DLG_EN 344 #define TM_STORYFRAME_TAILS_UNLOCK_2_DLG_EN 345 #define TM_STORYFRAME_TAILS_UNLOCK_3_DLG_EN 346 #define TM_STORYFRAME_TAILS_UNLOCKED_EN 347 #define TM_STORYFRAME_TAILS_UNLOCK_0_DLG_FR 348 #define TM_STORYFRAME_TAILS_UNLOCK_1_DLG_FR 349 #define TM_STORYFRAME_TAILS_UNLOCK_2_DLG_FR 350 #define TM_STORYFRAME_TAILS_UNLOCK_3_DLG_FR 351 #define TM_STORYFRAME_TAILS_UNLOCKED_FR 352 #define TM_STORYFRAME_TAILS_UNLOCK_0_DLG_DE 353 #define TM_STORYFRAME_TAILS_UNLOCK_1_DLG_DE 354 #define TM_STORYFRAME_TAILS_UNLOCK_2_DLG_DE 355 #define TM_STORYFRAME_TAILS_UNLOCK_3_DLG_DE 356 #define TM_STORYFRAME_TAILS_UNLOCKED_DE 357 #define TM_STORYFRAME_TAILS_UNLOCK_0_DLG_IT 358 #define TM_STORYFRAME_TAILS_UNLOCK_1_DLG_IT 359 #define TM_STORYFRAME_TAILS_UNLOCK_2_DLG_IT 360 #define TM_STORYFRAME_TAILS_UNLOCK_3_DLG_IT 361 #define TM_STORYFRAME_TAILS_UNLOCKED_IT 362 #define TM_STORYFRAME_TAILS_UNLOCK_0_DLG_ES 363 #define TM_STORYFRAME_TAILS_UNLOCK_1_DLG_ES 364 #define TM_STORYFRAME_TAILS_UNLOCK_2_DLG_ES 365 #define TM_STORYFRAME_TAILS_UNLOCK_3_DLG_ES 366 #define TM_STORYFRAME_TAILS_UNLOCKED_ES 367 #define TM_REGULAR_FINAL_BOSS 368 #define TM_UNKNOWN_STARS 369 #define TM_SKY_CANYON_CLOUDS_FOREGROUND 370 #define TM_SPOTLIGHT_SNOW 371 #define TM_EXTRA_BOSS_BACKGROUND 372 #define TM_CHARACTER_SELECT_BACKGROUND_0 373 #define TM_CHARACTER_SELECT_BACKGROUND_1 374 #define TM_EXTRA_BOSS_COCKPIT 375 #define TM_EXTRA_BOSS_BACKGROUND_COPY 376 #define TM_CUTSCENE_VANILLA_KIDNAPPED_FULL_MAP 377 #define TM_CUTSCENE_VANILLA_KIDNAPPED_FULL_MAP_COPY 378 #define TM_CUTSCENE_VANILLA_KIDNAPPED_SUPER_SONIC_ART 379 #define TM_REGULAR_FINAL_BOSS_BUILDING_BG 380 #define TM_COUNT 381 #endif // GUARD_TILEMAPS #ifndef GUARD_ZONES_H #define GUARD_ZONES_H #define ZONE_1 0 #define ZONE_2 1 #define ZONE_3 2 #define ZONE_4 3 #define ZONE_5 4 #define ZONE_6 5 #define ZONE_7 6 #define ZONE_FINAL 7 #define ZONE_UNUSED 8 #define ACT_HUB 2 #define ACT_1 3 #define ACT_2 4 #define ACT_3 5 #define ACT_4 6 // Unused in final game #define ACT_BOSS 7 #define ACT_BONUS_CAPSULE 8 #define ACT_BONUS_ENEMIES 9 #define ACT_XX_FINAL_ZONE ACT_1 #define ACT_TRUE_AREA_53 ACT_2 #define NUM_COURSE_ZONES 7 #define ACTS_PER_ZONE 4 #define ACT_SLOTS_PER_ZONE (ACTS_PER_ZONE + 1) #define STAGE_ALTAR_EMERALD 71 #define STAGE_NONAGGRESSION 72 #define LEVEL_INDEX(zone, act) ((zone)*ACT_SLOTS_PER_ZONE) + (act) #define ACT_INDEX(lvl) ((lvl) & (ACT_SLOTS_PER_ZONE - 1)) #define NUM_LEVEL_IDS 73 #define LEVEL_TO_ZONE(level) ((level) >> 2) // ((((level) / (ACTS_PER_ZONE + 1)) * 2) | ((level) & 1)) #define LEVEL_TO_COURSE_INDEX(level) ((((level) / ACT_SLOTS_PER_ZONE) << 0x19 >> 0x18) | ((level)&1)) #define COURSE_LEVEL_TO_COURSE_INDEX(level) (((level) >> 1) + ((level)&1)) #define COURSE_INDEX(zone, act) (LEVEL_TO_COURSE_INDEX(LEVEL_INDEX(zone, act))) #define CHAOS_EMERALD(zone) (1 << (zone)) #define ALL_ZONE_CHAOS_EMERALDS \ (CHAOS_EMERALD(ZONE_1) | CHAOS_EMERALD(ZONE_2) | CHAOS_EMERALD(ZONE_3) | CHAOS_EMERALD(ZONE_4) | CHAOS_EMERALD(ZONE_5) \ | CHAOS_EMERALD(ZONE_6) | CHAOS_EMERALD(ZONE_7)) #define CHAOS_EMERALDS_COMPLETED CHAOS_EMERALD(7) #define IS_BOSS_STAGE(lvl) \ ((ACT_INDEX(lvl) == ACT_BOSS) || (((lvl) == LEVEL_INDEX(ZONE_FINAL, ACT_XX_FINAL_ZONE)) && (gUnknown_030054B0 == 0)) \ || (((lvl) == LEVEL_INDEX(ZONE_FINAL, ACT_TRUE_AREA_53)))) #define ZONE_TIME_TO_INT(minutes, seconds) (int)(((minutes * 60.) + seconds) * GBA_FRAMES_PER_SECOND) #define MAX_COURSE_TIME (ZONE_TIME_TO_INT(10, 0)) #endif // GUARD_ZONES_H #ifndef GUARD_SAKIT_CAMERA_H #define GUARD_SAKIT_CAMERA_H //#include "core.h" //#include "tilemap.h" // TODO: Move TILE_WIDTH into "include/tilemap.h" #define TILE_WIDTH 8 #define CAM_REGION_WIDTH 256 #define TILES_PER_METATILE_AXIS 12 #define TO_WORLD_POS(pos, region) ((pos)*TILE_WIDTH + (region)*CAM_REGION_WIDTH) // Some entities (e.g. Enemy GaoGao) set the region-internal position // on initialization, including the ((pos) * TILE_WIDTH) multiplication. // That's why we need a separate macro for those cases. #define TO_WORLD_POS_RAW(rawPos, region) ((rawPos) + (region)*CAM_REGION_WIDTH) #define CAM_BOUND_X ((DISPLAY_WIDTH) + (CAM_REGION_WIDTH)) #define CAM_BOUND_Y ((DISPLAY_HEIGHT) + ((CAM_REGION_WIDTH) / 2)) typedef void (*BgUpdate)(s32, s32); #define CAM_MODE_SPECTATOR 4 // struct Camera is from SA2! struct Camera { /* 0x00 */ s32 x; /* 0x04 */ s32 y; /* 0x08 */ s32 unk8; /* 0x0C */ s32 unkC; /* 0x10 */ s32 unk10; /* 0x14 */ s32 unk14; /* 0x18 */ s32 shiftX; /* 0x1C */ s32 shiftY; /* 0x20 */ s32 unk20; /* 0x24 */ s32 unk24; // TODO: Why are X/Y swapped? // Did they make this a matrix or sth.? // (Used to calc min/max cam pos in UpdateCamera()) /* 0x28 */ s32 minY; /* 0x2c */ s32 maxY; /* 0x30 */ s32 minX; /* 0x34 */ s32 maxX; /* 0x38 */ s32 unk38; // movementX? /* 0x3c */ s32 unk3C; // movementY? /* 0x40 */ s16 unk40; /* 0x44 */ s32 unk44; /* 0x48 */ s32 unk48; /* 0x4c */ s32 unk4C; // 0x4 = spectator // mode /* 0x50 */ u16 unk50; /* 0x52 */ u16 unk52; /* 0x54 */ u16 unk54; /* 0x56 */ s16 unk56; /* 0x58 */ BgUpdate fnBgUpdate; /* 0x5C */ struct Task *movementTask; /* 0x60 */ s16 unk60; /* 0x62 */ s16 unk62; /* 0x64 */ s16 unk64; /* 0x66 */ u8 spectatorTarget; }; /* size 0x80 */ extern struct Camera gCamera; // TODO: Merge all these into one! #define IS_OUT_OF_RANGE_2(x, y, radiusX, radiusY) \ ((x < -(radiusX)) || (x > DISPLAY_WIDTH + (radiusX)) || (y < -(radiusY)) || (y > DISPLAY_HEIGHT + (radiusY))) // No idea on this one #define IS_OUT_OF_RANGE_3(x, y, radiusX, radiusY) \ ((x < -(radiusX)) || (x > DISPLAY_WIDTH + (radiusX)) || ((y) + (radiusY) < 0) || (y > DISPLAY_HEIGHT + (radiusY))) // TODO: Merge all these into one! #define IS_OUT_OF_RANGE_(UNUSED, x, y, radius) IS_OUT_OF_RANGE_2(x, y, radius, radius) #define IS_OUT_OF_RANGE_OLD(castType, x, y, dim) \ (((castType)(x + (dim / 2)) > DISPLAY_WIDTH + dim) || (y + (dim / 2) < 0) || (y > DISPLAY_HEIGHT + (dim / 2))) #define IS_OUT_OF_RANGE IS_OUT_OF_RANGE_OLD // @NOTE/INVESTIGATE: Some places match with u16, some with u32, // but u16 is more common, so it's the default. #define IS_OUT_OF_CAM_RANGE(_x, _y) IS_OUT_OF_RANGE(u16, _x, _y, CAM_REGION_WIDTH) #define IS_OUT_OF_CAM_RANGE_TYPED(castType, _x, _y) IS_OUT_OF_RANGE(castType, _x, _y, CAM_REGION_WIDTH) #define IS_OUT_OF_DISPLAY_RANGE(_x, _y) \ ((_x) > gCamera.x + (DISPLAY_WIDTH + (CAM_REGION_WIDTH / 2)) || (_x) < gCamera.x - (CAM_REGION_WIDTH / 2) \ || (_y) > gCamera.y + CAM_BOUND_Y || (_y) < gCamera.y - (CAM_REGION_WIDTH / 2)) // TODO: Remove macro and replace calls of it with 'IS_OUT_OF_RANGE' once rewritten. #define IS_OUT_OF_GRAV_TRIGGER_RANGE(x, y) IS_OUT_OF_RANGE_(u16, x, y, (CAM_REGION_WIDTH / 2)) #define IS_OUT_OF_LOOP_TRIGGER_RANGE(x, y) IS_OUT_OF_RANGE_3(x, y, (CAM_REGION_WIDTH / 2), (CAM_REGION_WIDTH / 2)) bool32 IsPointInScreenRect(s32 worldX, s32 worldY); #endif // GUARD_SAKIT_CAMERA_H #ifndef GUARD_SA3_GAME_CHAO_H #define GUARD_SA3_GAME_CHAO_H #define NUM_CHAO_PER_ZONE 10 extern u16 GetChaoFlag(u16 zoneIndex, u16 chaoIndex); extern void SetChaoFlag(u16 chaoIndex); extern s16 GetChaoCount(u16 ZoneIndex); #endif // GUARD_SA3_GAME_CHAO_H #ifndef GUARD_SCREEN_TRANSITION_H #define GUARD_SCREEN_TRANSITION_H #define SCREEN_FADE_USE_WINDOW_0 0 #define SCREEN_FADE_USE_WINDOW_1 1 #define SCREEN_FADE_FLAG_DARKEN (0 << 0) #define SCREEN_FADE_FLAG_LIGHTEN (1 << 0) #define SCREEN_FADE_FLAG_2 (1 << 1) #define SCREEN_FADE_FLAG_FF00 0xFF00 #define SCREEN_FADE_RUNNING 0 #define SCREEN_FADE_COMPLETE 1 // NOTE: The GBA's internal brightness coefficient (BLDY) // only has a range of 0 to 16, // representing 0/16 to 16/16 of brightness. // Any value above 16 will just cap out at 16/16. #define SCREEN_FADE_BLEND_MAX 32 typedef struct { // TODO: Is this a bool16? /* 0x00 */ s16 window; /* 0x02 */ s16 flags; // ((flags & 0x1) == TRANSITION_LIGHTEN) => // Q_8_8( 0) = Dark // Q_8_8(32) = Light // // ((flags & 0x1) == TRANSITION_DARKEN) => // Q_8_8( 0) = Light // Q_8_8(32) = Dark /* 0x04 */ s16 brightness; /* 0x06 */ s16 speed; /* 0x08 */ s16 bldCnt; /* 0x0A */ s16 bldAlpha; } ScreenFade; // Some sort of fade transition function? extern u8 UpdateScreenFade(ScreenFade *); void ScreenFadeUpdateValues(ScreenFade *fade); #endif // GUARD_SCREEN_TRANSITION_H #ifndef GUARD_SA3_ICE_LAUNCHER_H #define GUARD_SA3_ICE_LAUNCHER_H void CreateIceShiver(s16 param0, s16 param1, s16 param2, u16 param3, u8 param4); #endif // GUARD_SA3_ICE_LAUNCHER_H #ifndef GUARD_AGB_FLASH_512k_H #define GUARD_AGB_FLASH_512k_H u16 IdentifyFlash(void); void ReadFlash(u16 sectorNum, u32 offset, void *dest, u32 size); u32 ProgramFlashSectorAndVerifyNBytes(u16 sectorNum, void *dataSrc, u32 n); u16 SetFlashTimerIntr(u8 timerNum, void (**intrFunc)(void)); extern u16 (*EraseFlashSector)(u16); #endif // GUARD_AGB_FLASH_512k_H #ifndef GUARD_M4A_H #define GUARD_M4A_H extern struct SoundInfo gSoundInfo; extern struct MusicPlayerInfo gMPlayInfo_BGM; extern struct MusicPlayerInfo gMPlayInfo_SE1; extern struct MusicPlayerInfo gMPlayInfo_SE2; extern struct MusicPlayerInfo gMPlayInfo_SE3; void m4aSoundVSync(void); void m4aSoundInit(void); void m4aSoundMain(void); void m4aSongNumStart(u16); void m4aSongNumStartOrChange(u16); void m4aSongNumStartOrContinue(u16); void m4aSongNumStop(u16 n); void m4aMPlayAllStop(void); void m4aMPlayAllContinue(void); void m4aMPlayContinue(struct MusicPlayerInfo *mplayInfo); void m4aMPlayFadeOut(struct MusicPlayerInfo *mplayInfo, u16 speed); void m4aMPlayFadeOutTemporarily(struct MusicPlayerInfo *mplayInfo, u16 speed); void m4aMPlayFadeIn(struct MusicPlayerInfo *mplayInfo, u16 speed); void m4aMPlayImmInit(struct MusicPlayerInfo *mplayInfo); void m4aMPlayTempoControl(struct MusicPlayerInfo *mplayInfo, u16 tempo); void m4aMPlayVolumeControl(struct MusicPlayerInfo *mplayInfo, u16 trackBits, u16 volume); void m4aMPlayPitchControl(struct MusicPlayerInfo *mplayInfo, u16 trackBits, s16 pitch); void m4aMPlayPanpotControl(struct MusicPlayerInfo *mplayInfo, u16 trackBits, s8 pan); #define DEFAULT_SOUND_MODE (SOUND_MODE_DA_BIT_8 | SOUND_MODE_FREQ_10512 | (15 << SOUND_MODE_MASVOL_SHIFT) | (5 << SOUND_MODE_MAXCHN_SHIFT)) #endif // GUARD_M4A_H #ifndef GUARD_SIO32_MULTI_LOAD_H #define GUARD_SIO32_MULTI_LOAD_H // Optimize the following settings based on the software // specifications #define SIO32ML_BLOCK_SIZE 0x8000 // Communication Data Block Size // Update if maximum delay for communication interrupt is larger than // following. #define SIO32ML_INTR_DELAY_MAX 1000 // Communication Interrupt Allowed Delay Clocks #define SIO32ML_INTR_CLOCK_MAX 256 // Communication Interrupt Processing Maximum Clocks #define SIO32ML_SYNC_DATA \ 0xfefefefe // Synchronized Data (0x00000000and 0xffffffff // prohibited) #define SIO32ML_SYSTEM_CLOCK (16 * 1024 * 1024) // System Clock #define SIO32ML_SHIFT_CLOCK (256 * 1024) // Shift Clock #define SIO32ML_LINE_CLOCKS 1232 // Line Clocks // Comment out if no space in CPU internal Work RAM #ifdef MULTI_SIO_DI_FUNC_FAST // #define SIO32ML_DI_FUNC_FAST // SIO Interrupt // Prohibit Function High Speed Flag (CPU Internal RAM Execution) #endif #define SIO32ML_TIMER_NO 3 // Timer No. #define SIO32ML_TIMER_INTR_FLAG (INTR_FLAG_TIMER0 << SIO32ML_TIMER_NO) // Timer Interrupt Flag #define REG_SIO32ML_TIMER (*(vu32 *)(REG_ADDR_TMCNT + (SIO32ML_TIMER_NO * 4))) #define REG_SIO32ML_TIMER_L (*(vu16 *)(REG_ADDR_TMCNT_L + (SIO32ML_TIMER_NO * 4))) #define REG_SIO32ML_TIMER_H (*(vu16 *)(REG_ADDR_TMCNT_H + (SIO32ML_TIMER_NO * 4))) // Timer Register // Timer count temporary value is calculated from communication data // block size. #define SIO32ML_TIMER_COUNT_TMP (SIO32ML_SYSTEM_CLOCK / SIO32ML_SHIFT_CLOCK * 32 + SIO32ML_INTR_DELAY_MAX + SIO32ML_INTR_CLOCK_MAX) // Timer Count Temporary Value #define SIO32ML_TIMER_COUNT_MAX 0x10000 // Timer Count Maximum Value #define SIO32ML_TIMER_COUNT \ ((SIO32ML_TIMER_COUNT_TMP > SIO32ML_TIMER_COUNT_MAX) ? SIO32ML_TIMER_COUNT_MAX - SIO32ML_TIMER_COUNT_MAX \ : SIO32ML_TIMER_COUNT_MAX - SIO32ML_TIMER_COUNT_TMP) // Timer Count // Load timeout frames is calculated from above values. #define SIO32ML_MODE_WAIT_FRAMES 6 // SIO Mode Switch Wait Frames #define SIO32ML_LD_TIMEOUT_FRAMES \ (((SIO32ML_TIMER_COUNT_MAX - SIO32ML_TIMER_COUNT + SIO32ML_INTR_DELAY_MAX + SIO32ML_INTR_CLOCK_MAX) * (SIO32ML_BLOCK_SIZE / 4)) \ / (SIO32ML_LINE_CLOCKS * 228) \ + SIO32ML_MODE_WAIT_FRAMES + 2) // Load timeout frames // 32bit Serial Communication Multi-load Work Area Structure struct Sio32MultiLoadArea { u8 type; // Connection (Master/Slave) u8 state; // Communication Function State u8 frameCounter; // Frame Counter u8 downloadSuccessFlag; // Download Success Flag u32 *datap; // Data Pointer s32 dataCounter; // Data Counter u32 checkSum; // Checksum u32 checkSumTmp; s32 checkSumCounter; // Checksum Counter }; extern struct Sio32MultiLoadArea gSio32MultiLoadArea; // 32bit Serial Communication // Multi-load Work Area /*------------------------------------------------------------------*/ /* 32bit Serial Communication Multi-load Intialization */ /*------------------------------------------------------------------*/ extern void Sio32MultiLoadInit(u32 type, void *datap); //* Initialize register and buffer. //* To avoid problem with shift clock synchronization set master to // 256Kbps // 32 bit serial communication mode first. // //* 2Mbps communication with a cable is not guaranteed so do not set // up. //* Set already connection already determined with multi-play // communication // to Type. //* Do not pass VRAM address to Datap during display. // May fail with checksum of stored data. // Copy to VRAM after storing to work RAM once. // After this, possible overwrite program data to work RAM. // //* Arguments: // u32 type Connection (Master = Not 0/ Slave = 0) // void *datap Data Pointer (Master = Send Data/ Slave= Receive // Buffer) /*------------------------------------------------------------------*/ /* 32bit Serial Communication Multi-load Main */ /*------------------------------------------------------------------*/ extern u32 Sio32MultiLoadMain(u32 *progressCounterp); //* After 1 frame wait, set the slave to 256Kbps 32bit serial // communication // mode. Also, until the slave's SIO mode is determined the waits and // then communication is started. //* Slave successively calculates receive data checksum, and checks // when // receive complete. //* If receive is not completed at time when should be, end receive // forcibly. //* After communication ends prohibit communication interrupts, and // return // to multi-play communication mode. // //* Arguments: // u32 *progressCounterp Progress Counter Pointer // (Disabled when 0 specified) //* Return Value: // During communication = 0/ End = Not 0 /*------------------------------------------------------------------*/ /* 32bit Serial Communication Multi-load Interrupt Routine */ /*------------------------------------------------------------------*/ extern void Sio32MultiLoadIntr(void); //* Master does only send and slave only receive. //* Master resets timer during send. //* Slave stores receive data in order to receive buffer during // communication interrupt. // Lastly it stores checksum to work area. // //* Program so slave is called with communication interrupt and master // is called with timer interrupt. //* Data is passed with pipeline operation so delayed with slave with // large ID and then received. Therefore at a minimum need to send // two (8 Bytes) extra times. // //* Example: // ID 0 1 2 3 // Data 0 -> 0 -> 0 -> 0 // 1 -> 0 -> 0 -> 0 // 2 -> 1 -> 0 -> 0 // 3 -> 2 -> 1 -> 0 // 4 -> 3 -> 2 -> 1 #endif // GUARD_SIO32_MULTI_LOAD_H #ifndef GUARD_SPRITE_H #define GUARD_SPRITE_H // Version: March 25th, 2024 typedef u16 AnimId; struct GraphicsData { /* 0x00 */ const void *src; /* 0x04 */ void *dest; /* 0x08 */ u16 size; /* 0x0A */ AnimId anim; }; // TODO: Put this somewhere else! (or is this already somewhere?) #define TileMask_Index (0x3FF) #define TileMask_FlipX (1 << 10) #define TileMask_FlipY (1 << 11) #define TileMask_FlipXY (TileMask_FlipX | TileMask_FlipY) #define TileMask_Palette (TileMask_FlipX | TileMask_FlipY) #define BACKGROUND_FLAGS_BG_ID(id) (id) #define BACKGROUND_FLAGS_MASK_BG_ID 0x3 #define BACKGROUND_FLAG_4 0x4 #define BACKGROUND_UPDATE_GRAPHICS 0x8 #define BACKGROUND_UPDATE_PALETTE 0x10 #define BACKGROUND_FLAG_20 0x20 #define BACKGROUND_FLAG_IS_LEVEL_MAP 0x40 #define BACKGROUND_FLAG_80 0x80 #define BACKGROUND_FLAG_100 0x100 #define BACKGROUND_UPDATE_ANIMATIONS 0x200 #define BACKGROUND_FLAG_400 0x400 #define BACKGROUND_FLAG_800 0x800 typedef struct { /* 0x00 */ struct GraphicsData graphics; // 'tilesVram' points to tile-index array in VRAM, telling the GBA which tiles // to draw on this BG // // (!!! Data likely different depending on type of Background (Affine vs. // Text). !!!) // // Data-Structure (16 bits): MSB > PPPPYXTTTTTTTTTT < LSB // P = Palette Index // Y = Y-Flip // X = X-Flip // T = Tile-Index // // NOTE: It does NOT point to the tileset! /* 0x0C */ u16 *layoutVram; // Stage-Map: Metatiles // Common Tilemaps: Tilemap-Tiles /* 0x10 */ const u16 *layout; // Tile-count on each axis // - Stage maps: should be 12 (# per metatile) // - Common Tilemaps: should be .targetTilesX/Y /* 0x14 */ u16 xTiles; /* 0x16 */ u16 yTiles; /* 0x18 */ u16 unk18; /* 0x1A */ u16 unk1A; /* 0x1C */ u16 tilemapId; /* 0x1E */ u16 unk1E; /* 0x20 */ u16 unk20; /* 0x22 */ u16 unk22; /* 0x24 */ u16 unk24; /* Tile-Dimensions for the rendering target */ /* - Stage maps: DISPLAY_WIDTH/_HEIGHT + 1*TILE_WIDTH */ /* - Common Tilemaps: full image dimensions */ /* 0x26 */ u16 targetTilesX; /* 0x28 */ u16 targetTilesY; /* 0x2A */ u8 paletteOffset; /* 0x2B */ u8 animFrameCounter; /* 0x2C */ u8 animDelayCounter; /* 0x2E */ u16 flags; // apparently NOT signed? /* 0x30 */ u16 scrollX; /* 0x32 */ u16 scrollY; /* 0x34 */ u16 prevScrollX; /* 0x36 */ u16 prevScrollY; /* Only used by stage maps (they are encoded as Tilemaps) */ /* 0x38 */ const u16 *metatileMap; /* 0x3C */ u16 mapWidth; /* 0x3E */ u16 mapHeight; } Background; /* size = 0x40 */ typedef struct { /* 0x00 */ u8 flip; // every animation has an associated oamData pointer, oamIndex starts at // 0 for every new animation and ends at variantCount-1 /* 0x01 */ u8 oamIndex; // some sprite frames consist of multiple images (of the same size // as GBA's Object Attribute Memory, e.g. 8x8, 8x32, 32x64, ...) /* 0x02 */ u16 numSubframes; // In pixels /* 0x04 */ u16 width; // In pixels /* 0x06 */ u16 height; /* 0x08 */ s16 offsetX; /* 0x0A */ s16 offsetY; } SpriteOffset; // TODO: Verify "(in)active" name #define HITBOX_STATE_INACTIVE -1 #define HITBOX_IS_ACTIVE(hb) ((hb).index != HITBOX_STATE_INACTIVE) typedef struct { // index: -1 on init; lower 4 bits = index (in anim-cmds) /* 0x00 */ s32 index; /* 0x04 */ s8 left; /* 0x05 */ s8 top; /* 0x06 */ s8 right; /* 0x07 */ s8 bottom; } HitboxOld; typedef struct { // index: -1 on init; lower 4 bits = index (in anim-cmds) /* 0x00 */ s32 index; /* 0x04 */ Rect8 b; } Hitbox; #define SPRITE_ANIM_SPEED(speed) ((int)((float)(speed)*0x10)) #define SPRITE_OAM_ORDER(index) ((index) << 6) #define GET_SPRITE_OAM_ORDER(s) ((((s)->unk1A) & 0x7C0) >> 6) // NOTE(Jace): The layout of this struct is different // to SA1 and SA2, with missing GraphicsData // and some layout changes, // but overall they are mostly similar. typedef struct { /* 0x00 */ u8 *tiles; // in VRAM /* 0x04 */ u32 frameNum; // Bitfield description from KATAM decomp /* 0x08 */ u32 frameFlags; // bit 0-4: affine-index / rotscale param selection // bit 5: rotscale enable // bit 6: rotscale double-size // bit 7-8: obj mode -- different (1 bit) in SA3? // bit 9 // bit 10 X-Flip // bit 11 Y-Flip // bit 12-13: priority // bit 14: Animation finished // bit 15-16: Background ID // bit 17 // bit 18 // bit 19-25(?) // bit 26 // bit 27-29(?) // bit 30 // bit 31 /* 0x0C */ u16 anim; /* 0x0E */ u16 animCursor; /* 0x10 */ s16 x; /* 0x12 */ s16 y; /* 0x14 */ s16 oamFlags; // bit 6-10: OAM order index /* 0x16 */ s16 qAnimDelay; // Q_8_8, in frames /* 0x18 */ u16 prevAnim; /* 0x1A */ u8 variant; /* 0x1B */ u8 prevVariant; // 0x08 = 0.5x, 0x10 = 1.0x, 0x20 = 2.0x ... /* 0x1C */ u8 animSpeed; /* 0x1D */ u8 oamBaseIndex; /* 0x1E */ u8 numSubFrames; /* 0x1F */ u8 palId; // (0 - 15) /* 0x20 */ Hitbox hitboxes[1]; } Sprite; /* size: 0x28 (more with multiple Hitboxes) */ typedef struct { /* 0x00 */ u16 rotation; // TODO: // Does "scaleX" and "scaleY" fit as names? // It's 0x100 or Q_8_8(1.0) for 1x, Q_8_8(2.0) for 2x, etc. /* 0x02 */ s16 scaleX; /* 0x04 */ s16 scaleY; /* 0x06 */ s16 x; /* 0x08 */ s16 y; } SpriteTransform; /* size 0xA */ typedef struct { /* 0x00 */ u32 numTiles; /* 0x04 */ AnimId anim; /* 0x06 */ u8 variant; } TileInfo; // TileInfo, but ordered differently typedef struct { /* 0x00 */ AnimId anim; /* 0x02 */ u8 variant; /* 0x04 */ u32 numTiles; } TileInfo2; typedef struct PACKED { /* 0x00 */ u16 numTiles; /* 0x02 */ AnimId anim; /* 0x04 */ u16 variant; } TileInfo16; extern const u8 gOamShapesSizes[12][2]; typedef enum { ACMD_RESULT__ANIM_CHANGED = -1, ACMD_RESULT__ENDED = 0, ACMD_RESULT__RUNNING = +1, } AnimCmdResult; AnimCmdResult UpdateSpriteAnimation(Sprite *); void DisplaySprite(Sprite *); void DrawBackground(Background *); u32 sub_8004010(void); u32 sub_80039E4(void); bool32 sub_8002B20(void); void CopyOamBufferToOam(void); OamData *OamMalloc(u8 order); // SA2: sub_8004418 s16 sub_80BF30C(s16 x, s16 y); // SA2 // // TransformSprite void TransformSprite(Sprite *sprite, SpriteTransform *transform); void UnusedTransform(Sprite *, SpriteTransform *); // void sub_8004860(Sprite *, SpriteTransform *); // void sub_8004ABC(Sprite *, SpriteTransform *); // void sub_8004E14(Sprite *, SpriteTransform *); // // // void sub_8003EE4(u16 p0, s16 p1, s16 p2, s16 p3, s16 p4, s16 p5, s16 p6, // BgAffineReg *affine); // void sub_8006228(u8 p0, u8 p1, u8 p2, u8 p3, u8 p4, u8 p5); // void sub_80064A8(u8 p0, u8 p1, u8 p2, u8 p3, u8 p4, u8 p5); // // s32 sub_80036E0(Sprite *); // void sub_8003914(Sprite *); // void sub_80047A0(u16, s16, s16, u16); // // s16 sub_8004418(s16 x, s16 y); #define SpriteShouldUpdate(sprite) (((sprite)->prevVariant != (sprite)->variant) || ((sprite)->prevAnim != (sprite)->graphics.anim)) // TODO: Maybe rename this and move if out? #define SPRITE_MAYBE_SWITCH_ANIM(_sprite) \ if (SpriteShouldUpdate(_sprite)) { \ (_sprite)->graphics.size = 0; \ (_sprite)->prevVariant = (_sprite)->variant; \ (_sprite)->prevAnim = (_sprite)->graphics.anim; \ (_sprite)->animCursor = 0; \ (_sprite)->timeUntilNextFrame = 0; \ SPRITE_FLAG_CLEAR(_sprite, ANIM_OVER); \ } #define SPRITE_INIT_ANIM(_sprite, _anim, _variant, _order) \ _sprite->graphics.anim = _anim; \ _sprite->variant = _variant; \ _sprite->unk1A = SPRITE_OAM_ORDER(_order); \ _sprite->graphics.size = 0; #define SPRITE_INIT_SCRIPT(_sprite, _speed) \ _sprite->animCursor = 0; \ _sprite->timeUntilNextFrame = 0; \ _sprite->prevVariant = -1; \ _sprite->animSpeed = SPRITE_ANIM_SPEED(_speed); \ _sprite->palId = 0; \ _sprite->hitboxes[0].index = -1; #define SPRITE_INIT_ANIM_AND_SCRIPT(_sprite, _anim, _variant, _order) \ SPRITE_INIT_ANIM(_sprite, _anim, _variant, _order); \ SPRITE_INIT_SCRIPT(_sprite, 1.0); #define SPRITE_INIT_WITH_POS(_sprite, _numTiles, _anim, _variant, _order, _priority) \ _sprite->graphics.dest = VramMalloc(_numTiles); \ SPRITE_INIT_ANIM(_sprite, _anim, _variant, _order); \ _sprite->x = 0; \ _sprite->y = 0; \ SPRITE_INIT_SCRIPT(_sprite, 1.0) \ _sprite->frameFlags = SPRITE_FLAG(PRIORITY, _priority); #define SPRITE_INIT_WITHOUT_VRAM(_sprite, _anim, _variant, _order, _priority, _flags) \ SPRITE_INIT_ANIM_AND_SCRIPT(_sprite, _anim, _variant, _order); \ _sprite->frameFlags = (SPRITE_FLAG(PRIORITY, _priority) | (_flags)); #define SPRITE_INIT_WITHOUT_ANIM_OR_VRAM(_sprite, _order, _priority, _flags) \ _sprite->unk1A = SPRITE_OAM_ORDER(_order); \ _sprite->graphics.size = 0; \ SPRITE_INIT_SCRIPT(_sprite, 1.0); \ _sprite->frameFlags = (SPRITE_FLAG(PRIORITY, _priority) | (_flags)); #define SPRITE_INIT(_sprite, _numTiles, _anim, _variant, _order, _priority) \ _sprite->graphics.dest = VramMalloc(_numTiles); \ SPRITE_INIT_WITHOUT_VRAM(_sprite, _anim, _variant, _order, _priority, 0); #define SF_SHIFT(name) (SPRITE_FLAG_SHIFT_##name) #define SPRITE_FLAG(flagName, value) ((value) << SF_SHIFT(flagName)) #define SPRITE_FLAG_GET(sprite, flagName) (((sprite)->frameFlags & (SPRITE_FLAG_MASK_##flagName)) >> (SF_SHIFT(flagName))) #define SPRITE_FLAG_CLEAR(sprite, flagName) (sprite)->frameFlags &= ~(SPRITE_FLAG_MASK_##flagName) #define SPRITE_FLAG_SET(sprite, flagName) (sprite)->frameFlags |= (SPRITE_FLAG_MASK_##flagName) #define SPRITE_FLAG_FLIP(sprite, flagName) (sprite)->frameFlags ^= (SPRITE_FLAG_MASK_##flagName) #define SPRITE_FLAG_SET_VALUE(sprite, flagName, value) (sprite)->unk10 |= SPRITE_FLAG(flagName, value) #define SPRITE_FLAG_SHIFT_ROT_SCALE 0 #define SPRITE_FLAG_SHIFT_ROT_SCALE_ENABLE 5 #define SPRITE_FLAG_SHIFT_ROT_SCALE_DOUBLE_SIZE 6 #define SPRITE_FLAG_SHIFT_OBJ_MODE 7 #define SPRITE_FLAG_SHIFT_MOSAIC 9 #define SPRITE_FLAG_SHIFT_X_FLIP 10 #define SPRITE_FLAG_SHIFT_Y_FLIP 11 #define SPRITE_FLAG_SHIFT_PRIORITY 12 #define SPRITE_FLAG_SHIFT_ANIM_OVER 14 #define SPRITE_FLAG_SHIFT_BG_ID 15 #define SPRITE_FLAG_SHIFT_17 17 #define SPRITE_FLAG_SHIFT_18 18 #define SPRITE_FLAG_SHIFT_19 19 #define SPRITE_FLAG_SHIFT_26 26 #define SPRITE_FLAG_SHIFT_30 30 #define SPRITE_FLAG_SHIFT_31 31 #define SPRITE_FLAG_MASK_ROT_SCALE SPRITE_FLAG(ROT_SCALE, 0x1F) #define SPRITE_FLAG_MASK_ROT_SCALE_ENABLE SPRITE_FLAG(ROT_SCALE_ENABLE, 1) #define SPRITE_FLAG_MASK_ROT_SCALE_DOUBLE_SIZE SPRITE_FLAG(ROT_SCALE_DOUBLE_SIZE, 1) #define SPRITE_FLAG_MASK_OBJ_MODE SPRITE_FLAG(OBJ_MODE, 3) #define SPRITE_FLAG_MASK_MOSAIC SPRITE_FLAG(MOSAIC, 1) #define SPRITE_FLAG_MASK_X_FLIP SPRITE_FLAG(X_FLIP, 1) // 0x400 #define SPRITE_FLAG_MASK_Y_FLIP SPRITE_FLAG(Y_FLIP, 1) // 0x800 #define SPRITE_FLAG_MASK_PRIORITY SPRITE_FLAG(PRIORITY, 3) // 0x3000 #define SPRITE_FLAG_MASK_ANIM_OVER SPRITE_FLAG(ANIM_OVER, 1) #define SPRITE_FLAG_MASK_BG_ID SPRITE_FLAG(BG_ID, 3) #define SPRITE_FLAG_MASK_17 SPRITE_FLAG(17, 1) #define SPRITE_FLAG_MASK_18 SPRITE_FLAG(18, 1) #define SPRITE_FLAG_MASK_19 SPRITE_FLAG(19, 1) #define SPRITE_FLAG_MASK_26 SPRITE_FLAG(26, 1) #define SPRITE_FLAG_MASK_30 SPRITE_FLAG(30, 1) #define SPRITE_FLAG_MASK_31 SPRITE_FLAG(31, 1) #endif #ifndef GUARD_CORE_H #define GUARD_CORE_H //#include "tilemap.h" //#include "input_recorder.h" // TODO: Have we defined this somewhere else already? #define MAP_LAYER_COUNT 2 // Thanks @MainMemory_ for figuring out how collision works! typedef struct { /* 0x00 */ const s8 *height_map; /* 0x04 */ const u8 *tile_rotation; /* 0x08 */ const u16 *metatiles; /* 0x0C */ const u16 *map[MAP_LAYER_COUNT]; /* 0x14 */ const u16 *flags; /* 0x18 */ u16 levelX, levelY; /* 0x1C */ u32 pxWidth; // u16 in SA1! /* 0x20 */ u32 pxHeight; // u16 in SA1! } Collision; struct Unk_03003674_1_Sub { u16 unk0, unk2, unk4, unk6; s16 unk8, unkA; }; /* size = 0xC */ struct Unk_03003674_1_Full { struct Unk_03003674_1_Sub sub; u32 unkC; }; /* size = 0x10 */ union Unk_03003674_1 { const struct Unk_03003674_1_Sub *sub; const struct Unk_03003674_1_Full *full; }; struct Unk_03003674 { const union Unk_03003674_0 *const *unk0; const union Unk_03003674_1 *unk4; const u16 *const *unk8; const void *unkC; const void *unk10; const void *unk14; const s32 *unk18; }; /* size = 0x1C */ // No idea why this exists when there is a // better random number generator in the math // module #define PseudoRandom32() \ ({ \ gPseudoRandom = (gPseudoRandom * 0x196225) + 0x3C6EF35F; \ gPseudoRandom; \ }) #define MultiplayerPseudoRandom32() \ ({ \ gMultiplayerPseudoRandom = (gMultiplayerPseudoRandom * 0x196225) + 0x3C6EF35F; \ gMultiplayerPseudoRandom; \ }) #define PseudoRandBetween(min, max) ((PseudoRandom32() & ((-min) + (max))) + (min)) extern u32 gFlags; extern u32 gFlagsPreVBlank; extern u32 gFrameCount; #define INTR_INDEX_SIO 0 #define INTR_INDEX_VBLANK 1 #define INTR_INDEX_HBLANK 2 #define INTR_INDEX_VCOUNT 3 #define INTR_INDEX_TIMER0 4 #define INTR_INDEX_TIMER1 5 #define INTR_INDEX_TIMER2 6 #define INTR_INDEX_DMA0 7 #define INTR_INDEX_DMA1 8 #define INTR_INDEX_DMA2 9 #define INTR_INDEX_DMA3 10 #define INTR_INDEX_KEYPAD 11 #define INTR_INDEX_GAMEPAK 12 extern IntrFunc gIntrTable[16]; extern IntrFunc const gIntrTableTemplate[14]; extern u32 gIntrMainBuf[0x80]; extern struct Task *gCurTask; extern struct Task gTasks[MAX_TASK_NUM]; extern struct Task *gTaskPtrs[MAX_TASK_NUM]; extern struct Task *gNextTask; extern struct Task gEmptyTask; extern s32 gNumTasks; extern u16 gInput; extern u16 gPrevInput; extern u16 gPhysicalInput; extern u16 gReleasedKeys; extern u16 gRepeatedKeys; extern u16 gPressedKeys; extern u8 gKeysFirstRepeatIntervals[10]; extern u8 gRepeatedKeysTestCounter[10]; extern u8 gKeysContinuedRepeatIntervals[10]; extern const u8 *gInputPlaybackData; extern struct InputRecorder gInputRecorder; extern u16 *gInputRecorderTapeBuffer; extern union MultiSioData gMultiSioSend; extern union MultiSioData gMultiSioRecv[4]; extern u32 gMultiSioStatusFlags; extern bool8 gMultiSioEnabled; extern HBlankFunc gHBlankIntrs[4]; extern HBlankFunc gHBlankCallbacks[4]; extern u8 gNumHBlankCallbacks; extern u8 gNumHBlankIntrs; extern u8 gIwramHeap[0x2204]; extern u8 gEwramHeap[0x20080]; extern u32 gVramHeapStartAddr; extern u16 gVramHeapMaxTileSlots; extern u16 gVramHeapState[256]; extern bool8 gExecSoundMain; extern u16 gDispCnt; // NOTE(Jace): Use WIN_RANGE with WINxH / WINxV ! #define WINREG_WIN0H 0 #define WINREG_WIN1H 1 #define WINREG_WIN0V 2 #define WINREG_WIN1V 3 #define WINREG_WININ 4 #define WINREG_WINOUT 5 extern u16 gWinRegs[6]; extern struct BlendRegs gBldRegs; extern BgAffineReg gBgAffineRegs[NUM_AFFINE_BACKGROUNDS]; extern u16 gObjPalette[OBJ_PLTT_SIZE / sizeof(u16)]; extern u16 gBgPalette[BG_PLTT_SIZE / sizeof(u16)]; extern u16 gBgCntRegs[4]; // extern s16 gUnknown_03000408; // TODO: Turn this into a struct-array: // [4]{s16 x, s16 y} // Should we introduce a // "#define NUM_BACKGROUNDS 4" in gba/defines.h? extern s16 gBgScrollRegs[4][2]; // extern OamData gUnknown_030022C8; extern OamData gOamBuffer2[OAM_ENTRY_COUNT]; extern OamData gOamBuffer[OAM_ENTRY_COUNT]; // NOTE(Jace): This could be u16[2][DISPLAY_HEIGHT][2] (or unsigned Vec2_16?) extern u32 gBgOffsetsBuffer[2][DISPLAY_HEIGHT]; // extern Background *gUnknown_03001800[16]; // This is used to buffer the xy-shift for each background scanline extern void *gBgOffsetsHBlank; // extern u16 gUnknown_030017F0; // extern s16 gUnknown_030017F4[2]; // extern u8 gUnknown_03001850[32]; // extern FuncType_030053A0 gUnknown_03001870[4]; extern u8 gOamFreeIndex; // extern u16 gUnknown_03001944; // extern u8 gUnknown_03001948; // extern u16 gUnknown_0300194C; struct MapHeader **gTilemapsRef; // TODO: make this an array and add size // extern u8 gUnknown_03002280[4][4]; // extern u8 gUnknown_03004D80[16]; // extern u16 *gUnknown_030022AC; // extern void *gUnknown_030022C0; extern s16 gMosaicReg; // extern u8 gUnknown_030026F4; extern struct GraphicsData *gVramGraphicsCopyQueue[32]; // extern u16 gUnknown_03002820; // extern u8 gUnknown_03002874; // extern void *gUnknown_03002878; // extern u8 gUnknown_0300287C; // extern u8 gUnknown_03002A80; extern u8 gVramGraphicsCopyQueueIndex; // extern u16 gUnknown_03002A8C; // When paused, the previously-active OAM elements get moved to the end // of the OAM. This is the index of the first currently-inactive element extern u8 gOamFirstPausedIndex; // extern u8 gUnknown_03002AE4; // extern Sprite *gUnknown_03004D10[16]; // extern u8 gUnknown_03004D50; // extern void *gUnknown_03004D54; // extern u16 gUnknown_03004D58; extern u8 gVramGraphicsCopyCursor; // extern u8 gUnknown_03004D60[0x20]; // extern u8 gUnknown_03005390; // extern u16 gUnknown_03005394; // extern u16 gUnknown_03005398; // extern FuncType_030053A0 gUnknown_030053A0[4]; extern s32 gPseudoRandom; // extern u8 gUnknown_03002710[128]; extern struct MultiBootParam gMultiBootParam; void GameInit(void); void GameLoop(void); #endif #ifndef GUARD_GAME_H #define GUARD_GAME_H // #include "sakit/globals.h" // #include "sakit/player.h" #define GAME_MODE_SINGLE_PLAYER 0 #define GAME_MODE_DEMO 1 #define GAME_MODE_2 2 #define GAME_MODE_TIME_ATTACK 3 #define GAME_MODE_BOSS_TIME_ATTACK 4 #define GAME_MODE_5 5 #define GAME_MODE_MP_MULTI_PACK 6 #define GAME_MODE_MP_SINGLE_PACK 7 #define GAME_SA1 1 #define GAME_SA2 2 #define GAME_SA3 3 #define GAME_KATAM 4 #define CURRENT_GAME GAME_SA3 void GameStart(void); // rodata extern const AnimId gPlayerCharacterIdleAnims[NUM_CHARACTERS]; // NOTE: Proc type should be the same as SetStageSpawnPosInternal! // extern void SetStageSpawnPos(u32 character, u32 level, u32 p2, Player *player); #define GAME_MODE_IS_SINGLE_PLAYER(mode) \ ((mode == GAME_MODE_SINGLE_PLAYER) || (mode == GAME_MODE_DEMO) || (mode == GAME_MODE_2) || (mode == GAME_MODE_TIME_ATTACK) \ || (mode == GAME_MODE_BOSS_TIME_ATTACK)) #define GAME_MODE_IS_MULTI_PLAYER(mode) !GAME_MODE_IS_SINGLE_PLAYER(mode) #define INCREMENT_SCORE_A(incVal) \ { \ s32 divResA, divResB; \ s32 oldScore = gLevelScore; \ gLevelScore += incVal; \ \ divResA = Div(gLevelScore, 50000); \ divResB = Div(oldScore, 50000); \ \ if ((divResA != divResB) && (gGameMode == GAME_MODE_SINGLE_PLAYER)) { \ u16 lives = divResA - divResB; \ lives += gNumLives; \ \ gNumLives = ({ \ if (lives > 255) \ lives = 255; \ lives; \ }); \ } \ } #define INCREMENT_SCORE(incVal) \ { \ s32 divResA, divResB; \ s32 oldScore = gLevelScore; \ gLevelScore += incVal; \ \ divResA = Div(gLevelScore, 50000); \ divResB = Div(oldScore, 50000); \ \ if ((divResA != divResB) && (gGameMode == GAME_MODE_SINGLE_PLAYER)) { \ u16 lives = divResA - divResB; \ lives += gNumLives; \ \ gNumLives = ({ \ if (lives > 255) \ lives = 255; \ lives; \ }); \ \ gUnknown_030054A8.unk3 = 16; \ } \ } #define INCREMENT_RINGS(incVal) \ { \ s32 prevLives, newLives; \ s32 oldRings = gRingCount; \ gRingCount += incVal; \ \ if (!IS_EXTRA_STAGE(gCurrentLevel)) { \ newLives = Div(gRingCount, 100); \ prevLives = Div(oldRings, 100); \ \ if ((newLives != prevLives) && (gGameMode == GAME_MODE_SINGLE_PLAYER)) { \ u16 lives = gNumLives + 1; \ \ gNumLives = ({ \ if (lives > 255) \ lives = 255; \ lives; \ }); \ \ gUnknown_030054A8.unk3 = 16; \ } \ } \ } #define INCREMENT_RINGS2(incVal) \ { \ s32 prevLives, newLives; \ s32 oldRings = gRingCount; \ gRingCount += incVal; \ \ if (!IS_EXTRA_STAGE(gCurrentLevel)) { \ newLives = Div(gRingCount, 100); \ prevLives = Div(oldRings, 100); \ \ /* RingsScatterSingleplayer_NormalGravity turns the if around */ \ if ((newLives != prevLives) && (gGameMode == GAME_MODE_SINGLE_PLAYER)) { \ u16 lives = gNumLives + 1; \ \ gNumLives = ({ \ if (lives > 255) \ lives = 255; \ lives; \ }); \ \ gUnknown_030054A8.unk3 = 16; \ } \ } \ } #endif // GUARD_GAME_H #ifndef GUARD_SA3_PLAYER_H #define GUARD_SA3_PLAYER_H #define NUM_SINGLE_PLAYER_CHARS 2 #define MAX_PLAYER_NAME_LENGTH 6 #define PLAYER_LAYER_FRONT 0 #define PLAYER_LAYER_BACK 1 // Declared beforehand because it's used inside Player struct struct Player; typedef struct Player Player; typedef void (*PlayerCallback)(Player *); #define PLAYER_1 0 #define PLAYER_2 1 #define PLAYER_3 2 #define PLAYER_4 3 #define GET_SP_PLAYER_V0(index) ((index == PLAYER_1) ? &gPlayers[gStageData.playerIndex] : &gPlayers[p->charFlags.partnerIndex]) #define GET_SP_PLAYER_V1(index) ((index != PLAYER_1) ? &gPlayers[p->charFlags.partnerIndex] : &gPlayers[gStageData.playerIndex]) typedef union PACKED { u16 raw; // TODO: This is from old documentation. // Double-check these! struct { u8 subCount : 4; u8 other : 3; // TODO: name u8 subHighBit : 1; s8 highValue : 8; } split; } StateNum; struct Player { // Code (Character Movement) to be executed PlayerCallback callback; // 0x00 /* v4-values: 0x00000001: Facing left 0x00000004: In Air 0x00000006: Jumping (-> 0x7 = Jumping & face left) */ u32 moveState; // 0x04 u32 unk8; // 0x08 | bitfield? u32 unkC; // Bitfield /* 0x10 */ s32 qWorldX; /* 0x14 */ s32 qWorldY; // Speed values. // Horizontal Speed has 2 values [Air/Ground] // (used for speeding up after hitting the ground) // Vertical speed only has one // (Since no acceleration happens after touching the ground or a platform) s16 qSpeedAirX; // 0x18 s16 qSpeedAirY; // 0x1A s16 qSpeedGround; // 0x1C u16 keyInput; // 0x1E u16 keyInput2; // 0x20 u8 Padding2[0x02]; u8 unk24; s8 unk25; u8 unk26; // maybe a bitfield (upper 2 bits is 1 value) u8 unk27; // SA2: Player.unk38 (layer?) struct { u16 padding0; // 0x28 u8 charId : 4; // 0x2A /* Index of the player character (I think?) */ u8 padding1 : 4; // 0x2A u8 partnerIndex : 2; // Defines at which of the 0-3 "Player" the partner is // located | 0x2B u8 someIndex : 3; u8 someFlag0 : 1; u8 someFlag1 : 1; u8 boostIsActive : 1; u8 unk2C_01 : 1; // 0x2C u8 unk2C_02 : 1; // 0x2C u8 unk2C_04 : 1; u8 unk2C_padding_08 : 3; u8 unk2C_40 : 1; // 0x2C u8 unk2C_80 : 1; // 0x2C u8 unk2D_0 : 4; // 0x2D u8 unk2D_padding : 4; // 0x2D // StateNum state0; // 0x2E-0x2F u8 state0_subCount : 4; u8 state0_other : 3; // TODO: name u8 state0_subHighBit : 1; s8 state0_highValue : 8; s16 anim0; // 0x30 s16 anim1; // 0x32 s16 anim2; // 0x34 // TODO: May also be type StateNum ? u16 state1; // 0x36-0x37 } charFlags; u8 Padding4[0x0D]; u16 Spindash_Velocity; // 0x46 u8 Padding5[0x2]; s16 framesInvulnerable; // 0x4A s16 framesInvincible; // 0x4C /* Not sure whether this is of type charFlags or not, but between @ _80006AE and _8000718 sub_8000538() takes the lower nybble of the v4E, containing the partner's charId --- UPDATE: This seems to be a frame counter of some sort? If it's > 0 input is ignored if the character is on the ground and tries to move left or right. */ s16 unk4E; u16 boostEffectCounter; // 0x50 u16 idleAndCamCounter; // 0x52 | counter until idle-animation // or camera-movement when looking up/down (starts at 0x28) u8 filler54[0x2]; s8 unk56; u8 unk57; u8 filler58[0x2]; u8 unk5A; u8 unk5B; u8 unk5C; u8 unk5D; u16 unk5E; u16 unk60; u8 filler62[0x8 + 2]; Sprite *spr6C; // set when interacting with some interactables s32 qUnk70; s32 qUnk74; u8 filler78[0x14]; // x8C and v90 are speed-related s32 unk8C; // max speed? s32 unk90; // acceleration? s32 unk94; u8 unk98; // is this a union? u8 unk99; // is this a union? u8 unk9A; // is this a union? u8 unk9B; // is this a union? /* 0x9C */ s16 qCamOffsetX; /* 0x9E */ s16 qCamOffsetY; u8 PaddingA0[0x4]; u8 unkA4; u8 PaddingA5[0x3]; // Maybe vA8 -> vC2 are signed? u32 unkA8; u32 unkAC; u32 unkB0; u32 unkB4; u32 unkB8; u32 unkBC; u16 unkC0; u16 unkC2; struct Task *unkC4[0x03]; struct Task *unkD0; // Points to something while the "Tag-Action" is toggled (not // anymore once released) u32 unkD4; u32 unkD8; u32 unkDC; u8 fillerE0[0x4]; // spriteInfo* spriteInfo; // 0xE0 | the information is 0x3C bytes long u32 unkE4; u8 Padding7[0x54]; u8 unk13C; u8 unk13D; u8 Padding72[0x2]; u16 *demoplayInput_Start; u16 *demoplayInput_Current; u8 Padding8[0x8]; }; extern Player gPlayers[4]; bool32 sub_802C080(Player *p); bool32 sub_802C0D4(Player *p); #endif // GUARD_SA3_PLAYER_H #ifndef GUARD_SA3_ENTITY_H #define GUARD_SA3_ENTITY_H //#include "game/stage/player.h" //#include "game/stage/camera.h" #define ENTITY_DATA_SIZE_SA1 4 #define ENTITY_DATA_SIZE_SA2 4 #define ENTITY_DATA_SIZE_SA3 5 #define ENTITY_DATA_SIZE ENTITY_DATA_SIZE_SA3 typedef struct PACKED { /* 0x00 */ u8 x; // While an enemy is active, x gets repurposed as a "state" // (e.g. indicating that it's active) /* 0x01 */ u8 y; /* 0x02 */ u8 index; union { /* 0x03 */ s8 sData[ENTITY_DATA_SIZE]; u8 uData[ENTITY_DATA_SIZE]; } d; } MapEntity; typedef struct PACKED { /* 0x00 */ u8 x; // While an enemy is active, x gets repurposed as a "state" // (e.g. indicating that it's active) /* 0x01 */ u8 y; /* 0x02 */ u8 index; } MapEntity_Itembox; typedef struct PACKED { /* 0x00 */ u8 x; // While an enemy is active, x gets repurposed as a "state" // (e.g. indicating that it's active) /* 0x01 */ u8 y; } MapEntity_Ring; // TODO: Maybe this struct is bigger than 0xC in SA3? (0xA in SA1/SA2) typedef struct { /* 0x00 */ MapEntity *me; /* 0x04 */ u16 regionX; /* 0x06 */ u16 regionY; /* 0x08 */ u8 unk8; // only in SA3 /* 0x09 */ u8 unk9; // only in SA3 /* 0x0A */ u8 spriteX; /* 0x0B */ u8 id; } SpriteBase; // SpriteBase2 merges unk8 and unk9 into 1 value, as used in // src/game/interactables/warp.c typedef struct { /* 0x00 */ MapEntity *me; /* 0x04 */ u16 regionX; /* 0x06 */ u16 regionY; /* 0x08 */ u16 unk8; // only in SA3 /* 0x0A */ u8 spriteX; /* 0x0B */ u8 id; } SpriteBase2; // TODO maybe(?): Integrate this with every enemy typedef struct { SpriteBase base; Sprite s; } EnemyBase; // After a MapEntity is initialized, its x-value in the layout-data gets set to -2. // TODO: // Find out whether casting these to u8 can work while still matching! #define MAP_ENTITY_STATE_ARRAY_END (-1) #define MAP_ENTITY_STATE_INITIALIZED (-2) #define MAP_ENTITY_STATE_MINUS_THREE (-3) // TODO: Find a way to simplify/remove this macro! #define SET_MAP_ENTITY_INITIALIZED(mapEnt) \ { \ s32 negativeTwo; \ s16 forMatching; \ negativeTwo = MAP_ENTITY_STATE_INITIALIZED; \ forMatching = negativeTwo; \ mapEnt->x = forMatching; \ } #define SET_MAP_ENTITY_NOT_INITIALIZED(mapEnt, initialX) \ { \ mapEnt->x = initialX; \ } // Used by Enemies that do not appear in EASY-mode #define DIFFICULTY_LEVEL_IS_NOT_EASY (gGameMode == GAME_MODE_TIME_ATTACK || gDifficultyLevel != DIFFICULTY_EASY) // Used for bosses #define DIFFICULTY_BOSS_IS_NOT_NORMAL (gDifficultyLevel != DIFFICULTY_NORMAL && gGameMode != GAME_MODE_BOSS_TIME_ATTACK) #define DIFFICULTY_LEVEL_IS_NOT_EASY_AND_ZONE_IS_NOT_1 \ (gGameMode == GAME_MODE_TIME_ATTACK || gCurrentLevel > 3 || gDifficultyLevel != DIFFICULTY_EASY) #define ENEMY_SET_SPAWN_POS_STATIC(_enemy, _mapEntity) \ _enemy->spawnX = Q_24_8(TO_WORLD_POS(_mapEntity->x, spriteRegionX)); \ _enemy->spawnY = Q_24_8(TO_WORLD_POS(_mapEntity->y, spriteRegionY)); #define ENEMY_SET_SPAWN_POS_FLYING(_enemy, _mapEntity) \ ENEMY_SET_SPAWN_POS_STATIC(_enemy, _mapEntity); \ _enemy->offsetX = 0; \ _enemy->offsetY = 0; #define ENEMY_SET_SPAWN_POS_GROUND(_enemy, _mapEntity) \ ENEMY_SET_SPAWN_POS_STATIC(_enemy, _mapEntity); \ _enemy->offsetX = 0; \ _enemy->offsetY \ = Q_24_8(sub_801F07C(Q_24_8_TO_INT(_enemy->spawnY), Q_24_8_TO_INT(_enemy->spawnX), _enemy->clampParam, 8, NULL, sub_801EE64)); #define ENEMY_UPDATE_EX_RAW(_s, _posX, _posY, code_insert) \ sub_80122DC(_posX, _posY); \ { code_insert }; \ UpdateSpriteAnimation(_s); \ DisplaySprite(_s); #define ENEMY_UPDATE_EX(_s, _posX, _posY, code_insert) ENEMY_UPDATE_EX_RAW(_s, Q_24_8_NEW(_posX), Q_24_8_NEW(_posY), code_insert); #define ENEMY_UPDATE(_s, _posX, _posY) ENEMY_UPDATE_EX(_s, _posX, _posY, {}); #define ENEMY_UPDATE_POSITION_RAW(_enemy, _sprite, _posX, _posY, _offsetX, _offsetY) \ _posX = Q_24_8_TO_INT(_enemy->spawnX + _offsetX); \ _posY = Q_24_8_TO_INT(_enemy->spawnY + _offsetY); \ _sprite->x = _posX - gCamera.x; \ _sprite->y = _posY - gCamera.y; #define ENEMY_UPDATE_POSITION(_enemy, _sprite, _posX, _posY) \ ENEMY_UPDATE_POSITION_RAW(_enemy, _sprite, _posX, _posY, _enemy->offsetX, _enemy->offsetY) #define ENEMY_UPDATE_POSITION_STATIC(_enemy, _sprite, _posX, _posY) ENEMY_UPDATE_POSITION_RAW(_enemy, _sprite, _posX, _posY, 0, 0) #define ENEMY_TURN_TO_PLAYER(_posX, s) \ if (gPlayer.x < _posX) { \ SPRITE_FLAG_CLEAR(s, X_FLIP); \ } else { \ SPRITE_FLAG_SET(s, X_FLIP); \ } #define ENEMY_TURN_AROUND(_s) \ if (_s->unk10 & SPRITE_FLAG_MASK_X_FLIP) { \ SPRITE_FLAG_CLEAR(_s, X_FLIP); \ } else { \ SPRITE_FLAG_SET(_s, X_FLIP); \ } #define ENEMY_CROSSED_LEFT_BORDER(_enemy, _mapEntity) ((Q_24_8_TO_INT(_enemy->offsetX) <= _mapEntity->d.sData[0] * TILE_WIDTH)) #define ENEMY_CROSSED_RIGHT_BORDER(_enemy, _mapEntity) \ ((Q_24_8_TO_INT(_enemy->offsetX) >= (_mapEntity->d.sData[0] * TILE_WIDTH + _mapEntity->d.uData[2] * TILE_WIDTH))) #define ENEMY_CROSSED_TOP_BORDER_RAW(_enemy, _mapEntity, _offsetY) ((_offsetY <= _mapEntity->d.sData[1] * TILE_WIDTH)) #define ENEMY_CROSSED_TOP_BORDER(_enemy, _mapEntity) ENEMY_CROSSED_TOP_BORDER_RAW(_enemy, _mapEntity, Q_24_8_TO_INT(_enemy->offsetY)) #define ENEMY_CROSSED_BOTTOM_BORDER_RAW(_enemy, _mapEntity, _offsetY) \ ((_offsetY >= (_mapEntity->d.sData[1] * TILE_WIDTH + _mapEntity->d.uData[3] * TILE_WIDTH))) #define ENEMY_CROSSED_BOTTOM_BORDER(_enemy, _mapEntity) ENEMY_CROSSED_BOTTOM_BORDER_RAW(_enemy, _mapEntity, Q_24_8_TO_INT(_enemy->offsetY)) #define ENEMY_CLAMP_TO_GROUND_INNER(_enemy, _unknownBool, _task) \ sub_801F100(Q_24_8_TO_INT(_enemy->spawnY + _enemy->offsetY), Q_24_8_TO_INT(_enemy->spawnX + _enemy->offsetX), _unknownBool, 8, _task); #define ENEMY_CLAMP_TO_GROUND_INNER_X_FIRST(_enemy, _unknownBool) \ sub_801F100(Q_24_8_TO_INT(_enemy->spawnX + _enemy->offsetX), Q_24_8_TO_INT(_enemy->spawnY + _enemy->offsetY), _unknownBool, 8, \ sub_801EC3C); #define ENEMY_CLAMP_TO_GROUND_RAW(_enemy, _unknownBool, _p) \ { \ s32 delta = sub_801F07C(Q_24_8_TO_INT(_enemy->spawnY + _enemy->offsetY), Q_24_8_TO_INT(_enemy->spawnX + _enemy->offsetX), \ _unknownBool, 8, _p, sub_801EE64); \ \ if (delta < 0) { \ _enemy->offsetY += Q_24_8(delta); \ delta = ENEMY_CLAMP_TO_GROUND_INNER(_enemy, _unknownBool, sub_801EC3C); \ } \ \ if (delta > 0) { \ _enemy->offsetY += Q_24_8(delta); \ } \ } #define ENEMY_CLAMP_TO_GROUND(_enemy, _unknownBool) ENEMY_CLAMP_TO_GROUND_RAW(_enemy, _unknownBool, NULL) #define ENEMY_CLAMP_TO_GROUND_2(_enemy, _unknownBool) \ { \ s32 delta = sub_801F07C(Q_24_8_TO_INT(_enemy->spawnY + _enemy->offsetY), Q_24_8_TO_INT(_enemy->spawnX + _enemy->offsetX), \ _unknownBool, -8, NULL, sub_801EE64); \ \ if (delta < 0) { \ _enemy->offsetY -= Q_24_8(delta); \ delta = ENEMY_CLAMP_TO_GROUND_INNER(_enemy, _unknownBool, sub_801EC3C); \ } \ \ if (delta > 0) { \ _enemy->offsetY -= Q_24_8(delta); \ } \ } #define ENEMY_DESTROY_IF_PLAYER_HIT(_s, _pos) \ if (sub_800C4FC(_s, _pos.x, _pos.y, 0) == TRUE) { \ TaskDestroy(gCurTask); \ return; \ } #define ENEMY_DESTROY_IF_PLAYER_HIT_2(_s, _pos) \ if (sub_800C4FC(_s, _pos.x, _pos.y, 0)) { \ TaskDestroy(gCurTask); \ return; \ } #define ENEMY_DESTROY_IF_OUT_OF_CAM_RANGE(_enemy, _mapEntity, _sprite) \ if (IS_OUT_OF_CAM_RANGE(_sprite->x, _sprite->y)) { \ SET_MAP_ENTITY_NOT_INITIALIZED(_mapEntity, _enemy->base.spriteX); \ TaskDestroy(gCurTask); \ return; \ } #define ENEMY_DESTROY_IF_OFFSCREEN_RAW(_enemy, _mapEntity, _sprite, _posX, _posY) \ if (IS_OUT_OF_DISPLAY_RANGE(_posX, _posY)) { \ ENEMY_DESTROY_IF_OUT_OF_CAM_RANGE(_enemy, _mapEntity, _sprite); \ } #define ENEMY_DESTROY_IF_OFFSCREEN(_enemy, _mapEntity, _sprite) \ ENEMY_DESTROY_IF_OFFSCREEN_RAW(_enemy, _mapEntity, _sprite, Q_24_8_TO_INT(_enemy->spawnX), Q_24_8_TO_INT(_enemy->spawnY)) #endif // GUARD_SA3_ENTITY_H #ifndef GUARD_SA3_PLAYER_CALLBACKS_H #define GUARD_SA3_PLAYER_CALLBACKS_H extern void Player_800522C(Player *p); extern void Player_80052C8(Player *p); extern void Player_8005380(Player *p); extern void Player_8005528(Player *p); extern void Player_8005BD4(Player *p); extern void Player_8005E80(Player *p); extern void Player_8006CF0(Player *p); extern void Player_8006DB8(Player *p); extern void Player_80077CC(Player *p); extern void Player_8007898(Player *p); extern void Player_800891C(Player *p); extern void Player_8008A8C(Player *p); extern void Player_8008CD0(Player *p); extern void Player_8009B4C(Player *p); extern void Player_800A218(Player *p); extern void Player_800A3C0(Player *p); extern void Player_800A438(Player *p); extern void Player_800A4C8(Player *p); extern void Player_800A5B0(Player *p); extern void Player_800A690(Player *p); extern void Player_800A724(Player *p); extern void Player_800A7CC(Player *p); extern void Player_800A860(Player *p); extern void Player_800A90C(Player *p); extern void Player_800A98C(Player *p); extern void Player_800AAC0(Player *p); extern void Player_800AB48(Player *p); extern void Player_UseSpecialSpringWithKey(Player *p); extern void Player_800AD24(Player *p); extern void Player_800AE14(Player *p); extern void Player_800AEF4(Player *p); extern void Player_800B1B8(Player *p); extern void Player_800B240(Player *p); extern void Player_800B374(Player *p); extern void Player_800B3FC(Player *p); extern void Player_IceLauncherLaunch(Player *p); extern void Player_800B920(Player *p); extern void Player_800B81C(Player *p); extern void Player_CollideGroundAfterIceLauncher(Player *p); extern void Player_800BC38(Player *p); extern void Player_800BCE0(Player *p); extern void Player_800BD88(Player *p); extern void Player_800BEE8(Player *p); extern void SetPlayerCallback(Player *p, PlayerCallback callback); extern void Player_800DAF4(Player *p); extern void Player_800DE64(Player *p); extern void Player_800DEC4(Player *p); extern void Player_800E1E4(Player *p); extern void Player_800E5D0(Player *p); extern void Player_800E5EC(Player *p); extern void Player_800E604(Player *p); extern void Player_800E9A4(Player *p); extern void Player_800EA74(Player *p); extern void Player_800DDD0(Player *p); extern void Player_800E67C(Player *p); extern void Player_800E6CC(Player *p); extern void Player_800EA0C(Player *p); extern void Player_800EAA8(Player *p); extern void Player_800EB4C(Player *p); extern void Player_800EB5C(Player *p); extern void Player_800ED80(Player *p); #endif // GUARD_SA3_PLAYER_CALLBACKS_H #ifndef GUARD_SA3_MODULE_UNCLEAR_H #define GUARD_SA3_MODULE_UNCLEAR_H /* The variable and function declarations in here do not yet have a corresponding module * yet */ // Appears to be multiplayer-only? extern u8 gUnknown_03003F94; extern u8 gUnknown_03003D20; extern u8 gUnknown_03006840; extern u8 gUnknown_03003F34; extern u8 gUnknown_03006208; typedef struct { /* 0x00 */ u8 filler0[0x4C]; /* 0x4C */ u8 unk4C; /* 0x4D */ u8 unk4D; /* 0x4E */ u8 filler4E[0x8]; /* 0x56 */ u8 unk56; } Struct_03001060; /* size: ??? */ extern Struct_03001060 gUnknown_03001060; bool32 sub_8001E58(void); void sub_8002210(s16 level, u16); void Task_800303C(void); // Player-related (Player.unk90.main gets set to this in goal_ring IA) void sub_8003D2C(void); void sub_8003DF0(u16 song); void sub_8003E0C(u16 song); void sub_8003E28(u16 song); // StopSong? void sub_8004D30(void); void sub_8004DD8(s32 qWorldX, s32 qWorldY); // TODO: param2 type u16 sub_8004E20(s16, s16, u16 *param2); bool32 sub_8004E98(Player *p, u16 song); void sub_8004F10(Player *, u16 song); void sub_8006824(Player *p); void sub_8008E38(Player *p); // Some collision function s32 sub_80110E8(u16, Player *, u8 *, u32 *); s32 sub_801226C(Player *); s32 sub_8012368(Player *); s32 sub_801246C(Player *); s32 sub_8012550(Player *); void sub_8012FE0(Player *); void Player_80149E4(Player *p); void sub_8016F28(Player *p); void sub_8019A58(Player *p); void sub_8019A64(Player *p); extern bool32 sub_8020700(Sprite *s, s32 worldX, s32 worldY, s16 p3, Player *p, s16 p5); // Collision extern u32 sub_8020874(Sprite *s, s32 worldX, s32 worldY, s16 p3, Player *p, s16 p5, u8 p6); u32 sub_8020950(Sprite *s, s32 worldX, s32 worldY, Player *p, u8 param4); bool32 sub_8020CE0(Sprite *s, s32 worldX, s32 worldY, u16 param3, Player *p); void sub_80213B0(Sprite *s, Player *p); void sub_80236C8(void *, u8 p1, void *); bool32 sub_8023734(void *chaoEwramData); void sub_80239A8(void *chaoEwramData); // NOTE: x and y have different signedness, but it's correct void sub_80274F4(u8, u16 x, s16 y); // The implementation of sub_80275B8 makes it seem that 'level' is a u8, // but that way the calling site in some instances will be wrong // (src/game/interactables/warp.c -> Task_802E6F8) void sub_80275B8(u32 level, u8, u8); void sub_80276A8(u8 charId); void sub_802954C(Player *p, s16 worldX, s16 worldY); void sub_80299FC(void); void sub_8029A18(u16 songId); bool32 sub_802C140(s32 worldX, s32 worldY, s32 screenX, s32 screenY); bool32 sub_802C1D0(s32, s32); bool32 sub_802C1F8(s32, s32); void sub_804DD68(void *); bool32 sub_805C510(Sprite *s); void sub_8097C54(u16); void sub_80C0CA8(Sprite *s, Vec2_16 *positions, u16 count); void sub_80C07E0(Sprite *s); #endif // GUARD_SA3_MODULE_UNCLEAR_H #ifndef GUARD_SA3_ENEMY_UNKNOWN_CODE_H #define GUARD_SA3_ENEMY_UNKNOWN_CODE_H typedef struct { /* 0x00 */ MapEntity *me; /* 0x04 */ bool32 unk4; /* 0x08 */ s8 spriteX; /* 0x20 */ u8 filler9[0x3]; // TODO: Make this Vec2_u16 /* 0x0C */ u16 regionX; /* 0x0E */ u16 regionY; // TODO: Make this Vec2_32 /* 0x10 */ s32 posX; /* 0x14 */ s32 posY; /* 0x18 */ s32 unk18; /* 0x1C */ Sprite *spr; /* 0x20 */ u8 filler20[0x8]; } EnemyUnknownStruc0; /* size: 0x28 */ bool32 sub_805C280(EnemyUnknownStruc0 *); bool32 sub_805C63C(EnemyUnknownStruc0 *); bool32 sub_805C890(EnemyUnknownStruc0 *param0, s8 param1); Player *sub_805CD20(u8); void sub_805CD70(Vec2_32 *qVal, Vec2_32 *param1, u16 region[2], s8 *param3); #endif // GUARD_SA3_ENEMY_UNKNOWN_CODE_H #ifndef GUARD_PLAYER_CONTROLS_H #define GUARD_PLAYER_CONTROLS_H typedef struct { u16 jump; u16 attack; u16 trick; } ButtonConfig; extern ButtonConfig gPlayerControls; void SetPlayerControls(u16 jump, u16 attack, u16 trick); #endif // GUARD_PLAYER_CONTROLS_H #ifndef GUARD_SA3_IA125_AND_126_H #define GUARD_SA3_IA125_AND_126_H void CreateEntity_Interactable125(MapEntity *me, u16 regionX, u16 regionY, u8 id); void CreateEntity_Interactable126(MapEntity *me, u16 regionX, u16 regionY, u8 id); #endif // GUARD_SA3_IA125_AND_126_H #ifndef GUARD_SA3_PLATFORM_SHARED_H #define GUARD_SA3_PLATFORM_SHARED_H extern u16 sub_804DC38(u8 kind, s32 worldX, s32 worldY, MapEntity *me); extern void sub_804DD68(void *platform); extern void sub_804DDD4(void *platform, Sprite *); #endif // GUARD_SA3_PLATFORM_SHARED_H #ifndef GUARD_SAVE_H #define GUARD_SAVE_H //#include "sakit/globals.h" #define PLAYER_NAME_END_CHAR 0xFFFF #define CHAO_COLLECTED_BIT(num) (1 << (num)) #define CHAO_COLLECTED_ALL 0x3FF #define NUM_MULTIPLAYER_SCORES 10 #define MAX_MULTIPLAYER_SCORE 99 #define TIME_RECORDS_PER_COURSE 3 #define ACT_COMPLETE_BIT__ACT_1 0x1 #define ACT_COMPLETE_BIT__ACT_2 0x2 #define ACT_COMPLETE_BIT__ACT_3 0x4 #define ACT_COMPLETE_BIT__BOSS 0x8 #define ACT_COMPLETE_BIT__BONUS_CAPSULE 0x10 #define ACT_COMPLETE_BIT__BONUS_ENEMIES 0x20 #define ARE_STAGE_ACTS_COMPLETE(zone) \ ((gSaveGame.unlockedStages[zone] & (ACT_COMPLETE_BIT__ACT_1 | ACT_COMPLETE_BIT__ACT_2 | ACT_COMPLETE_BIT__ACT_3)) == 0x7) #define IS_ACT_COMPLETE(zone, act) (gSaveGame.unlockedStages[zone] & ACT_COMPLETE_BIT__##act) // TODO: Does using the bitmap match? typedef struct { u8 Act1 : 1; u8 Act2 : 1; u8 Act3 : 1; u8 Boss : 1; u8 BonusCapsule : 1; u8 BonusEnemies : 1; u8 Bit7 : 1; } ZoneCompletion; // TODO: Does using these match? typedef struct { u8 Bronze : 1; u8 Silver : 1; u8 Gold : 1; } MedalCollection; // Used in struc_30008A0 typedef struct { u32 playerId; u16 playerName[MAX_PLAYER_NAME_LENGTH]; bool8 slotFilled; u8 wins; u8 losses; u8 draws; } VsRecords; // Used in struc_3000CF0 typedef struct { u8 unk0; u8 wins; u8 draws; u8 losses; u32 unk4; u16 playerName[MAX_PLAYER_NAME_LENGTH]; } VsRecords2; typedef struct { u16 table[NUM_COURSE_ZONES][ACTS_PER_ZONE][TIME_RECORDS_PER_COURSE]; } TimeRecords; #define NUM_TIME_RECORD_ROWS (NUM_COURSE_ZONES * ACTS_PER_ZONE * NUM_CHARACTERS * TIME_RECORDS_PER_COURSE) // TODO: There are multiple kinds of SaveGame structs, figure out their use cases // Maybe struc_3000CF0 is the equivalent of struct SaveSectorData ? // 0x03000530 typedef struct { /* 0x00 */ u32 id; /* 0x04 */ u16 playerName[MAX_PLAYER_NAME_LENGTH]; /* 0x10 */ u8 unlockedCharacters; // 0x10 | Bitfield determining access to playable characters /* 0x11 */ u8 unlockedZones; // 0x11 | Up to the index of this value all Zones are // accessible (1 to 9) /* 0x12 */ u8 continueZone; // 0x12 | Zone the player continues at on startup after // character select (0 to 6) /* 0x13 */ u8 unk13; /* 0x14 */ u16 chaoCount[NUM_COURSE_ZONES]; // 0x14 - 0x21 | /* 0x22 */ u8 specialKeys[NUM_COURSE_ZONES]; // 0x22 - 0x28 | Each counter counts for one Zone /* 0x29 */ u8 unlockedStages[9]; // 0x29-0x31 | (struct ZoneCompletion) /* 0x32 */ u8 collectedEmeralds; // 0x32 | Stored bitwise: x7654321b /* 0x33 */ u8 unk33; /* 0x34 */ u16 unk34; /* 0x36 */ u8 unk36; /* Live count? */ /* 0x37 */ u8 collectedMedals[9][ACTS_PER_ZONE]; // 0x37 | (struct MedalCollection) // xxxxxGSBb Medals collected for // completion time in each [Zone][Act] /* 0x5B */ u8 unk5B; /* 0x5C */ u8 unk5C; /* 0x5D */ u8 unk5D; /* 0x5E */ u16 unk5E; // Unsure about type /* 0x60 */ u8 vsWins; /* 0x61 */ u8 vsLosses; /* 0x62 */ u8 vsDraws; /* 0x63 */ u8 unk63; // Vs??? /* 0x64 */ VsRecords vsRecords[10]; // 0x64 | Records in Multiplayer Matches /* 0x12C */ TimeRecords timeRecords; /* 0x35C */ ButtonConfig buttonConfig; /* 0x364 */ u8 unk364; /* 0x365 */ u8 unk365; /* 0x366 */ u8 language; /* 0x367 */ u8 unk367; } SaveGame; extern SaveGame gSaveGame; // TODO: From SA2. Find out whether the pointer exists in SA3 extern SaveGame *gLoadedSaveGame; /* 0x03000CF0 | Check out types and sizes for accuracy */ // It seems like this is like STRUCT_3000530, but prepared to be stored in savefile. // They might've done it for security reasons, but strangely it's not excrypted, even in // .sav file... typedef struct { u32 magicNumber; // default: 0x47544E4C ("LNTG") u32 v4; // @NOTE This contains mostly the same information as struc_3000530, but // some values are missing or in a different order. u32 id; // | 0x08 u16 playerName[MAX_PLAYER_NAME_LENGTH]; u8 v18; // Don't know why this byte is here, but it's correct u8 unlockedCharacters; // 0x19 | u8 unlockedZones; // 0x1A | u8 continueZone; // 0x1B | Zone the player continues at on startup after character // select (0 to 6) u8 v1C; u16 chaoCount[7]; // | v1D - 0x2B u8 specialKeys[7]; // Each counter counts for 1 Act | 0x2C - 0x32 u8 unlockedStages[9]; // | 0x33-0x3B u8 collectedEmeralds; // Stored bitwise: x7654321b | 0x3C // NOTE: These are different from // struct struc_3000530, why? u8 v3D; // v33: struc_3000530 u8 collectedMedals[9][4]; // 0x3E | v37: struc_3000530 u16 v62; // v34?: struc_3000530 u8 vsWins; // v60?: struc_3000530 u8 vsLosses; u8 vsDraws; u8 v67; VsRecords2 vsRecords[10]; // 0x68 TimeRecords timeRecords[7][4][5]; // 0x130 u8 buttonConfig[3]; u8 v363; u8 v364; u8 v365; u8 language; u8 v367; // INVESTIGATE: v367 might be unused. u32 v368; // v368 | Checksum? In sub_800212C() this value is calculated and show that // it HAS to be the last member of the struct } SaveSectorData; extern SaveSectorData gSaveSectorData; #define MULTIPLAYER_RESULT_WIN 0 #define MULTIPLAYER_RESULT_LOSS 1 #define MULTIPLAYER_RESULT_DRAW 2 // extern struct SaveGame *gLoadedSaveGame; void InsertMultiplayerProfile(u32 playerId, u16 *name); void RecordOwnMultiplayerResult(s16 result); void RecordMultiplayerResult(u32 id, u16 *name, s16 result); void SaveInit(void); bool16 SaveGameExists(void); s16 NewSaveGame(void); s16 LoadSaveGame(void); void LoadCompletedSaveGame(void); bool32 WriteSaveGame(void); #endif #ifndef GUARD_SA3_GAME_STAGE_H #define GUARD_SA3_GAME_STAGE_H typedef struct { u8 filler0[0x16]; u16 unk16; // bitfield u8 filler18[0x38]; Player *unk50; } StageDataTask98; /* size: ??? */ #define TIMER_ID_COUNT 8 /* 0x030008A0 */ typedef struct { /* 0x00 */ u8 unk0; // @NOTE: unk0 and unk1 referenced as single u16 before; union? /* 0x01 */ u8 unk1; /* 0x02 */ u8 unk2; /* 0x03 */ u8 gameMode; // (0x0: normal, 0x1: Demo, 0x2: ???, 0x3: Time Attack, // x7: multiplayer?) /* 0x04 */ u8 unk4; /* 0x05 */ u8 unk5; // This appears to be flag with layout 0b01010101 (see IA goal_ring) /* 0x06 */ u8 playerIndex; // Index of the controlled Player in gPlayers[] | 0x2B /* 0x07 */ u8 unk7; /* 0x08 */ u8 unk8; /* 0x09 */ u8 zone; // Currently visited Zone /* 0x0A */ u8 act; // Currently visited Act /* 0x0B */ u8 entryIndex; // Map entrance number index /* 0x0C */ u8 unkC; /* 0x0D */ u8 unkD; /* 0x0E */ u16 currMapIndex; // Map player's currently on /* 0x10 */ u16 unk10; // some kind of flag register /* 0x12 */ u16 nextMapIndex; // Map targeted by teleport (apparently only works with // level warps?) /* 0x14 */ ButtonConfig buttonConfig; /* 0x1C */ u32 timer; /* 0x20 */ u8 unk20; /* 0x21 */ u8 unk21; /* 0x22 */ u8 filler22[2]; /* 0x24 */ u32 unk24; // Coordinates for start-position and // respawn after losing a life /* 0x28 */ u16 respawnX; /* 0x2A */ u16 respawnY; /* Timers The indices for the arrays (which are the bit number for each EnableBits value) are retrieved by finding the first bit set in me->d.uData[4]. */ /* 0x2C */ u8 platformTimerEnableBits; /* 0x2D */ u8 springTimerEnableBits; /* 0x2E */ u16 platformTimers[TIMER_ID_COUNT]; /* 0x3E */ u16 springTimers[TIMER_ID_COUNT]; // TODO: Check name accuracy /* 0x4E */ u16 unk4E[TIMER_ID_COUNT]; /* 0x5E */ s16 unk5E[TIMER_ID_COUNT]; /* 0x6E */ u16 unk6E[TIMER_ID_COUNT]; /* 0x7E */ u8 filler7E[0x2]; /* 0x80 */ u16 *unk80; // (type not checked, used in sub_8002838) | 0x80 /* 0x84 */ u8 unk84; // | 0x84 /* 0x85 */ u8 unk85; // | 0x85 /* 0x86 */ u8 unk86; // | 0x86 /* 0x87 */ u8 flagSpKey; // SP-key-flag of current act | 0x87 /* 0x88 */ u8 PADDING42[0x04]; /* 0x8C */ u16 unk8C; /* 0x8E */ u8 unk8E; // PlayerIndex for Multiplayer? /* 0x8F */ u8 unk8F; /* 0x90 */ struct Task *task90; /* 0x94 */ u32 unk94; /* 0x98 */ struct Task *task98; // -> StageDataTask98 * /* 0x9C */ u32 unk9C; /* 0xA0 */ u32 unkA0; /* 0xA4 */ u32 unkA4; /* 0xA8 */ u32 unkA8; /* 0xAC */ u16 rings; /* 0xAE */ u16 levelTimer; // Timer that constantly increases in a level /* 0xB0 */ u16 unkB0; /* 0xB2 */ u16 unkB2; /* 0xB4 */ u8 lives; /* 0xB5 */ u8 unkB5; /* 0xB6 */ u8 unkB6; /* 0xB7 */ u8 unkB7; /* 0xB8 */ u8 unkB8; /* 0xB9 */ u8 unkB9; /* 0xBA */ u8 fillerBA[2]; /* 0xBC */ u8 unkBC; // bitfield /* 0xBD */ u8 unkBD; /* 0xBE */ u8 unkBE[7]; } StageData; extern StageData gStageData; #endif // GUARD_SA3_GAME_STAGE_H