bodyprog: sound system recognition

Author: IWILLCRAFT-M0d

configs/USA/sym.bodyprog.txt

@@ -463,12 +463,15 @@ Sd_PlaySfx                                  = 0x80046048; // type:func
 Sd_LastVoiceKeyOff                          = 0x800468EC; // type:func
 Sd_AllVoicesKeyOff                          = 0x800469AC; // type:func
 Sd_AllVoicesKeyOffVWithRROff                = 0x800469E8; // type:func
+Sd_XaAudioPlay                              = 0x80046D3C;
+Sd_XaAudioLengthGet                         = 0x80046DCC;
 Sd_SetVolume                                = 0x80047798; // type:func
 Sd_SetVolBgm                                = 0x80047808; // type:func
 Sd_SetVolXa                                 = 0x80047860; // type:func
 Sd_GetVolSe                                 = 0x800478B8; // type:func
 Sd_SetReverbDepth                           = 0x80047AD0; // type:func
 Sd_SetReverbEnable                          = 0x80047AFC; // type:func
+func_80047D1C                               = 0x80047D1C;
 
 //-----------------------------------------------------------------------------
 //--- PA: 0x0231F0   VA: 0x80047D50   subsegment: c, libsd/bodyprog_CD_80047D50
@@ -2106,7 +2109,8 @@ Y_ARRAY.295                                 = 0x800A9FB4;
 //------------------------------------------------------------------------------
 //--- PA: 0x085A80   VA: 0x800AA5E0   subsegment: .data, libsd/bodyprog_80045A7C
 //------------------------------------------------------------------------------
-REVERB_DEPTHS                               = 0x800AA5E0;
+g_Sd_ReverbDepthsList                       = 0x800AA5E0;
+g_XaItemData                                = 0x800AA894;
 
 //-------------------------------------------------------------------
 //--- PA: 0x088920   VA: 0x800AD480   subsegment: .data, view/vw_calc
@@ -2523,7 +2527,8 @@ vcRefPosSt                                  = 0x800BCDF8; // type:VECTOR3 size:0
 g_WorldGfx                                  = 0x800BCE18; // type:u8 size:0x2DBC
 g_Map                                       = 0x800C1020; // type:u8 size:0x58C - size from bzero call
 g_Sound_ActiveSfxIdx                        = 0x800C15BE; // type:s16
-g_Sound_ReverbDepth                         = 0x800C1687;
+g_Sd_AudioLoadState                         = 0x800C1670;
+g_Sd_ReverbDepth                            = 0x800C1687;
 g_Game_VSyncTimeSinceBoot                   = 0x800C1690;
 D_800C16A8                                  = 0x800C16A8; // type:u8 size:0x20
 vwViewPointInfo                             = 0x800C37E0; // type:VW_VIEW_WORK size:0x84

include/bodyprog/bodyprog.h

@@ -970,19 +970,6 @@ typedef struct
 } s_800A992C;
 STATIC_ASSERT_SIZEOF(s_800A992C, 24);
 
-typedef struct
-{
-    u8  field_0;
-    u8  unk_1; // } Padding?
-    u8  unk_2; // }
-    u8  unk_3; // }
-    u32 field_4    : 24;
-    u8  field_4_24 : 8;
-    u32 field_8    : 24;
-    u8  field_8_24 : 8;
-} s_800AA894;
-STATIC_ASSERT_SIZEOF(s_800AA894, 12);
-
 /** Related to weapon attacks. */
 typedef struct
 {
@@ -1187,36 +1174,6 @@ typedef struct
     u8 field_1;
 } s_800C15F0;
 
-typedef struct
-{
-    s32 field_0;
-    s32 field_4;
-    s32 field_8;
-} s_800C1688;
-
-/** Sound struct for currently used SFX? */
-typedef struct
-{
-    u8  field_0;
-    u8  field_1;
-    s16 field_2;
-    s16 field_4;
-    s16 field_6;
-    s16 field_8;
-    s16 field_A; // Pitch?
-    s16 volumeLeft_C;
-    s16 volumeRight_E;
-} s_800C1698;
-
-typedef struct
-{
-    s8  field_0;
-    s8  unk_1;
-    u16 field_2;
-    u32 field_4;
-    s32 field_8;
-} s_800C37D4;
-
 // Used in string parsing.
 typedef struct
 {
@@ -2085,8 +2042,6 @@ extern u16 D_800A9774[];
 
 extern u16 g_UnknownEngineCmdTable1[];
 
-extern s_800C37D4 D_800A986C[];
-
 extern s32 D_800A9A20;
 
 /** X. */
@@ -2288,12 +2243,8 @@ extern u32 D_800A9FB0;
 
 extern s32 D_800A9FB4[];
 
-extern u8 REVERB_DEPTHS[];
-
 extern u8 D_800AA604[][16];
 
-extern s_800AA894 D_800AA894[];
-
 extern u8 D_800AE185;
 
 extern u8 D_800AE186;
@@ -2520,10 +2471,6 @@ extern u16 D_800C15F8[];
 /** Voices? */
 extern s16 D_800C1628[];
 
-extern s_800C1688 D_800C1688;
-
-extern s_800C1698 D_800C1698;
-
 extern s16 D_800C16A4;
 
 extern s32 D_800C16C8; // Type assumed.
@@ -2553,25 +2500,15 @@ extern s32 D_800C3994;
 
 extern u8 D_800C37D0;
 
-extern s_800C37D4* D_800C37D8;
-
 extern s_800C38B0 D_800C38B0;
 
 extern s_800C38B4 D_800C38B4;
 
 /** Times? */
 extern q19_12 D_800C4710[];
 
-extern u8 D_800C37C8;
-
-extern u32 D_800C37CC;
-
-extern s_800C37D4* D_800C37D4;
-
 extern u8 D_800C37DC;
 
-extern u8 D_800C37DD;
-
 /** String position. */
 extern DVECTOR g_StringPosition; // 0x800C38A8
 
@@ -3179,11 +3116,6 @@ u8 func_80046BB4(u8 arg0);
 
 void func_80046C54(u8 arg0, u8 vol);
 
-/** Sound command func. Unknown category. */
-void func_80046D3C(u16 cmd);
-
-s32 func_80046DCC(s32 idx);
-
 void func_80046E00(void);
 
 void func_8004729C(u16 sfxId);
@@ -3194,35 +3126,6 @@ void func_80047308(void);
 
 void func_8004760C(void);
 
-/** Sound func. */
-void func_800478DC(u8 cmd);
-
-void func_80047A70(void);
-
-void Sd_SetVolBgm(s16 volLeft, s16 volRight);
-
-void Sd_SetVolXa(s16 volLeft, s16 volRight);
-
-s16 Sd_GetVolSe(s16 arg0);
-
-void Sd_SetReverbDepth(u8 depth);
-
-void Sd_SetReverbEnable(s32 mode);
-
-void func_80047B24(s32 arg0);
-
-void func_80047B80(void);
-
-void func_80047D1C(void);
-
-void func_80047D50(void);
-
-void func_80047DB0(void);
-
-void func_80047E3C(void);
-
-void func_80047F18(void);
-
 void func_80048000(void);
 
 void func_8004807C(void);
@@ -3254,8 +3157,6 @@ void func_800485B8(s32 arg0, u8 arg1, u32 arg2);
 
 void func_800485C0(s32 idx);
 
-void func_800485D8(void);
-
 /** @brief Executes a new primitive command and checks the status against the previous.
  * If the previous primitive commands haven't completed, it starts
  * adding to `D_800C1658.timer_0` each time the process fails. When it

include/bodyprog/sound_system.h

@@ -22,11 +22,24 @@
 // STRUCTS
 // ========
 
+typedef struct
+{
+    u8  xaFileIdx_0;
+    u8  unk_1; // } Padding?
+    u8  unk_2; // }
+    u8  unk_3; // }
+    u32 sector_4      : 24;
+    u8  field_4_24    : 8; // Index. This indicate the element of the group idx defined at `field_8_24`.
+    u32 audioLength_8 : 24;
+    u8  field_8_24    : 8; // Index. This indicate some sort of group.
+} s_XaItemData;
+STATIC_ASSERT_SIZEOF(s_XaItemData, 12);
+
 typedef struct
 {
     u16 timer_0; // A timer related to audio command processes.
-    u16 field_2;
-    u16 field_4;
+    u16 xaAudioIdxCheck_2; // XA Audio index. Used for check if the file exist.
+    u16 xaAudioIdx_4;      // XA Audio index. Used for playing the audio.
     u16 field_6;
     u16 field_8[1]; // Unknown size.
     s16 field_A;
@@ -36,19 +49,20 @@ typedef struct
     u8  isStereoEnabled_12; // `bool`
     s8  field_13;
     u8  bgmFadeSpeed_14; /** Value to get rested in order to speed the music fade. Range: [0, 2], default: 0. */
-    u8  field_15;
-    u8  field_16;    // `bool` | XA streaming related. If a voiceline audio is playing, this is set to `false`, otherwise `true`.
-    u8  muteGame_17; // `bool` | Mutes the game. If the value is `true`, the whole game audio will progressively lower
-	                 // in volume until mute. The sounds will keep playing, but muted.
+    u8  isVabLoading_15; /** `bool` | Loading: `true`, Nothing loading: `false`, default: Nothing loading. */
+    u8  field_16;        /** `bool` | XA streaming related. If a voiceline audio is playing, this is set to `false`, otherwise `true`. */
+    u8  muteGame_17;     /** `bool` | Mutes the game. If the value is `true`, the whole game audio will progressively lower
+	                      * in volume until mute. The sounds will keep playing, but muted.
+						  */
 } s_800C1658;
 
 typedef struct
 {
-    u8 field_0;
-    u8 field_1;
-    u8 field_2;
+    u8 vabLoadState_0; // States related to audio streaming. VAB Audio.
+    u8 field_1;        // States related to audio streaming.
+    u8 field_2;        // States related to audio streaming.
     u8 field_3;
-} s_800C1670;
+} s_Sd_AudioLoadStates;
 
 // Game current volume configuration struct?
 typedef struct
@@ -68,10 +82,46 @@ typedef struct
     u8  globalVolumeXa_E;  // Global Voice volume channel (not configurable).
 } s_800C1678;
 
+typedef struct
+{
+    s32 field_0;
+    s32 field_4;
+    s32 field_8;
+} s_800C1688;
+
+/** Sound struct for currently used SFX? */
+typedef struct
+{
+    u8  field_0;
+    u8  field_1;
+    s16 field_2;
+    s16 field_4;
+    s16 field_6;
+    s16 field_8;
+    s16 field_A; // Pitch?
+    s16 volumeLeft_C;
+    s16 volumeRight_E;
+} s_800C1698;
+
+typedef struct
+{
+    s8  field_0;
+    s8  unk_1;
+    u16 field_2;
+    u32 field_4; // VA Sound Sector count?
+    s32 field_8;
+} s_800C37D4;
+
 // ========
 // GLOBALS
 // ========
 
+extern u8 g_Sd_ReverbDepthsList[]; // 0x800AA5E0
+
+extern s_800C37D4 D_800A986C[];
+
+extern s_XaItemData g_XaItemData[]; // 0x800AA894
+
 // Only used in `sd_work_init` as iterator variable.
 extern s32 D_800C15B8;
 
@@ -84,18 +134,34 @@ extern s32 D_800C15DC;
 // Only used in `func_80047A70` as iterator variable.
 extern s32 D_800C15E0;
 
-// Very likely to be related to music.
 extern s_800C1658 D_800C1658;
 
-extern s_800C1670 D_800C1670;
+extern s_Sd_AudioLoadStates g_Sd_AudioLoadState; // 0x800C1670
 
 extern s_800C1678 D_800C1678;
 
-extern u8 g_Sound_ReverbDepth;
+extern u8 g_Sd_ReverbDepth; // 0x800C1687;
 
-// Command pool related to audio and streaming.
+extern s_800C1688 D_800C1688;
+
+extern s_800C1698 D_800C1698;
+
+extern u8 D_800C37C8;
+
+extern u32 D_800C37CC;
+
+/** Command pool related to audio and streaming.
+ * Seems like `func_800485D8` is the main function on charge of executing commands,
+ * as this function is part of the mainloop function.
+ */
 extern u8 D_800C16A8[32];
 
+extern s_800C37D4* D_800C37D4;
+
+extern s_800C37D4* D_800C37D8;
+
+extern u8 D_800C37DD;
+
 // ==========
 // FUNCTIONS
 // ==========
@@ -119,7 +185,46 @@ void Sd_AllVoicesKeyOff(void);
 /** @brief Executes `SdUtKeyOffVWithRROff` and runs through all elements of `smf_port`. */
 void Sd_AllVoicesKeyOffVWithRROff(void);
 
+/** @brief Plays XA audios defined at `g_XaItemData`. */
+void Sd_XaAudioPlay(u16 sfx); // 0x80046D3C
+
+/** @unused Gets the length of XA audios defined at `g_XaItemData`. */
+s32 Sd_XaAudioLengthGet(s32 idx); // 0x80046DCC
+
 /** @brief Sets the volume for the global channels of the music, sound effects, and voices. */
 void Sd_SetVolume(u8 xaVol, s16 bgmVol, u8 seVol);
 
+void Sd_SetVolBgm(s16 volLeft, s16 volRight); // 0x80047808
+
+void Sd_SetVolXa(s16 volLeft, s16 volRight); // 0x80047860
+
+s16 Sd_GetVolSe(s16 arg0); // 0x800478B8
+
+/** Updates and add commands to a command pool. */
+void func_800478DC(u8 cmd); // 0x800478DC
+
+/** Updates a command pool by shifting a field. */
+void func_80047A70(void); // 0x80047A70
+
+void func_80047B80(void); // 0x80047B80
+
+void Sd_SetReverbDepth(u8 depth); // 0x80047AD0
+
+void Sd_SetReverbEnable(s32 mode); // 0x80047AFC
+
+void func_80047B24(s32 arg0); // 0x80047B24
+
+void func_80047D1C(void); // 0x80047D1C
+
+void func_80047D50(void); // 0x80047D50
+
+void func_80047DB0(void); // 0x80047DB0
+
+void func_80047E3C(void); // 0x80047E3C
+
+void func_80047F18(void); // 0x80047F18
+
+void func_800485D8(void); // 0x800485D8
+
+
 #endif