From b0217dd7786f5ba1d362489ed6440edac4758ae3 Mon Sep 17 00:00:00 2001
From: Seth Barberee <seth.barberee@gmail.com>
Date: Sun, 12 Jun 2022 07:46:47 -0700
Subject: [PATCH] document Fanfare/SoundEffect funcs

---
 include/music.h |  4 ++--
 src/music.c     |  8 ++++----
 src/music_pre.c | 20 ++++++++++----------
 3 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/include/music.h b/include/music.h
index a8710e19f..c086c8968 100644
--- a/include/music.h
+++ b/include/music.h
@@ -6,8 +6,8 @@ void StartBGMusicVSync(void);
 u8 sub_800CA38(u32 songIndex);
 void StartNewBGM(u16 songIndex);
 bool8 IsBGSong(u32 songIndex);
-bool8 sub_800CAAC(u32 songIndex);
-bool8 sub_800CACC(u32 songIndex);
+bool8 IsSoundEffect(u32 songIndex);
+bool8 IsFanfare(u32 songIndex);
 u16 GetMusicPlayerIndex(u16 songIndex);
 bool8 sub_800CAF0(u16 songIndex);
 void StartNewBGM(u16 songIndex);
diff --git a/src/music.c b/src/music.c
index 8d060254d..79502a965 100644
--- a/src/music.c
+++ b/src/music.c
@@ -107,14 +107,14 @@ u8 sub_800CA38(u32 songIndex)
             return 1;
         }
     }
-    if(sub_800CACC(songIndex))
+    if(IsFanfare(songIndex))
     {
         if(GetMusicPlayerIndex(songIndex) == 1)
         {
             return 1;
         }
     }
-    else if(sub_800CAAC(songIndex))
+    else if(IsSoundEffect(songIndex))
     {
         if(GetMusicPlayerIndex(songIndex) > 1)
         {
@@ -137,7 +137,7 @@ bool8 IsBGSong(u32 songIndex)
     return FALSE;
 }
 
-bool8 sub_800CAAC(u32 songIndex)
+bool8 IsSoundEffect(u32 songIndex)
 {
     if(songIndex - 300 <= 639)
     {
@@ -146,7 +146,7 @@ bool8 sub_800CAAC(u32 songIndex)
     return FALSE;
 }
 
-bool8 sub_800CACC(u32 songIndex)
+bool8 IsFanfare(u32 songIndex)
 {
     if(songIndex - 200 <= 19)
     {
diff --git a/src/music_pre.c b/src/music_pre.c
index d1ec4f523..b93ddbfa5 100644
--- a/src/music_pre.c
+++ b/src/music_pre.c
@@ -58,7 +58,7 @@ struct unkStruct_3000FD8
 };
 
 extern struct unkStruct_3000FD8 gUnknown_3000FD8[8];
-extern struct unkStruct_3000FD8 gUnknown_3000FE8[4];
+extern struct unkStruct_3000FD8 gUnknown_3000FE8[8];
 
 extern u8 gUnknown_202D7FE;
 extern u16 gBldCnt;
@@ -595,7 +595,7 @@ void sub_800C074(u16 SongIndex, u16 param_2)
   if (param_2 > 256)
     param_2 = 256;
 
-  if (sub_800CACC(SongIndex)) 
+  if (IsFanfare(SongIndex)) 
   {
     if (GetMusicPlayerIndex(SongIndex) == 1) {
       interrupt_flag = DisableInterrupts();
@@ -668,7 +668,7 @@ void sub_800C074(u16 SongIndex, u16 param_2)
   }
   else
   {
-    if (!sub_800CAAC(SongIndex))
+    if (!IsSoundEffect(SongIndex))
       return;
     msVar = GetMusicPlayerIndex(SongIndex);
     preload = &gUnknown_3000FD8[msVar]; // need to load this before comparison to match
@@ -706,7 +706,7 @@ void sub_800C214(u16 songIndex, u16 volume)
     volume = 256;
   }
 
-  if ((!sub_800CACC(songIndex)) && (sub_800CAAC(songIndex))) {
+  if ((!IsFanfare(songIndex)) && (IsSoundEffect(songIndex))) {
     msVar = GetMusicPlayerIndex(songIndex);
     info = gMPlayTable[msVar].info;
     preload = &gUnknown_3000FD8[msVar];
@@ -750,7 +750,7 @@ void sub_800C298(u16 songIndex)
             EnableInterrupts();
         }
     }
-    else if (sub_800CAAC(songIndex))
+    else if (IsSoundEffect(songIndex))
     {
         uVar2 = GetMusicPlayerIndex(songIndex);
         puVar6 = gMPlayTable[uVar2].info;
@@ -785,7 +785,7 @@ void sub_800C298(u16 songIndex)
             EnableInterrupts();
         }
     }
-    else if (sub_800CACC(songIndex))
+    else if (IsFanfare(songIndex))
     {
         cVar4 = DisableInterrupts();
         if (gUnknown_202D690 != 0) {
@@ -848,7 +848,7 @@ void sub_800C3F8(u16 songIndex, u16 speed)
         }
     }
     else {
-        if (sub_800CAAC(songIndex)) {
+        if (IsSoundEffect(songIndex)) {
             uVar8 = GetMusicPlayerIndex(songIndex);
             preload = &gUnknown_3000FD8[uVar8];
             puVar5 = gMPlayTable[uVar8].info;
@@ -884,7 +884,7 @@ void sub_800C3F8(u16 songIndex, u16 speed)
                 EnableInterrupts();
             }
         }
-        else if (sub_800CACC(songIndex)) {
+        else if (IsFanfare(songIndex)) {
             cVar4 = DisableInterrupts();
             if ((gUnknown_202D690 != 0) && (gUnknown_202D68E == songIndex)) {
                 if (sub_800CAF0(1) != '\0') {
@@ -913,14 +913,14 @@ bool8 sub_800C5D0(u16 songIndex)
   songIndex_u32_2 = songIndex_u32;
   
 
-  if (sub_800CACC(songIndex_u32)) {
+  if (IsFanfare(songIndex_u32)) {
     if ((gUnknown_202D690 != 0) && (gUnknown_202D68E == songIndex_u32)) {
       return TRUE;
     }
   }
   else
   {
-    if (sub_800CAAC(songIndex_u32)) {
+    if (IsSoundEffect(songIndex_u32)) {
       uVar3 = GetMusicPlayerIndex(songIndex_u32);
       preload = &gUnknown_3000FD8[uVar3];
       if ((1 < uVar3) && (preload->songIndex == songIndex_u32_2)) {