Merge pull request #2242 from AlmostSeagull/music-display-fix-round2

music display fix, with less crashes this time!

Author: AlmostSeagull

base-hack/asm/symbols.asm

@@ -201,6 +201,8 @@
 .definelabel CBTurnedInArray, 0x807FC930
 .definelabel charspawnerflags, 0x80755DA8
 .definelabel songData, 0x80745658
+.definelabel trackStateArray, 0x80745924
+.definelabel SongInWriteSlot, 0x80770560
 .definelabel songVolumes, 0x807454F0
 .definelabel compactSequencePlayers, 0x8076BF20
 .definelabel MusicTrackChannels, 0x807458DC

base-hack/include/dk64.h

@@ -677,6 +677,8 @@ extern int FileGBCount;
 extern float FileScreenDLOffset;
 extern short CBTurnedInArray[8];
 extern short songData[SONG_COUNT];
+extern short trackStateArray[12];
+extern char songInWriteSlot[4];
 extern short songVolumes[SONG_COUNT];
 extern int* compactSequencePlayers[4];
 extern unsigned int DKTVData[5];

base-hack/include/global.h

@@ -194,6 +194,7 @@ extern void initDingSprite(void);
 extern void fastWarpShockwaveFix(void);
 extern void setPrevSaveMap(void);
 extern int filterSong(int* song_write);
+extern void detectSongChange();
 extern int getTotalCBCount(void);
 
 extern void swapKremlingModel(void);

base-hack/src/lib.c

@@ -1395,17 +1395,6 @@ int filterSong(int* song_write) {
 			}
 		}
 	}
-	initSongDisplay(song);
-	return getTrackChannel(song);
-}
-
-int filterSong_Cancelled(songs song) {
-	for (int i = 0; i < 12; i++) {
-		if ((MusicTrackChannels[i] != SONG_SILENCE) && (MusicTrackChannels[i] != song)) {
-			initSongDisplay(MusicTrackChannels[i]);
-			break;
-		}
-	}
 	return getTrackChannel(song);
 }
 

base-hack/src/main.c

@@ -141,6 +141,7 @@ void cFuncLoop(void) {
 		}
 	}
 	handleSFXCache();
+	detectSongChange();
 	handleDPadFunctionality();
 	if (Rando.helm_hurry_mode) {
 		checkTotalCache();

base-hack/src/misc/music_text.c

@@ -13,11 +13,44 @@
 
 static unsigned char display_timer = 0;
 static short displayed_text_offset = -1;
+static short storedMusicTrackChannel[12] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
+static char storedTrackState[12] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
 
 void resetDisplayedMusic(void) {
     DisplayedSongNamePointer = 0; // Uses a static address for autotrackers
 }
 
+
+void detectSongChange(){
+    char trackChannelsChanged = 0;
+    for(int i = 0; i < 12; i++){
+        if(storedMusicTrackChannel[i] != MusicTrackChannels[i]){
+            // Block song display from occurring in the pause menu
+            // Other instances of this occurring are fair game, maybe even desired
+            if(MusicTrackChannels[i] != 41){
+                // New song was requested to play on this channel
+                // Do record pause music playing, so we know when it stops playing
+                storedMusicTrackChannel[i] = MusicTrackChannels[i];
+                if(MusicTrackChannels[i] != 34){
+                    trackChannelsChanged = 1;
+                }
+            }
+        }
+    }
+    for(int i = 0; i < 12; i++){
+        if(trackStateArray[i] != storedTrackState[i]){
+            if(trackStateArray[i] == 2 && storedTrackState[i] == 1){
+                // New song has loaded in and has now started
+                initSongDisplay(MusicTrackChannels[i]);
+            }
+            storedTrackState[i] = trackStateArray[i];
+        } else if(trackStateArray[i] == 2 && trackChannelsChanged){
+            // Song that was newly requested was already loaded in and has now started
+            initSongDisplay(MusicTrackChannels[i]);
+        }
+    }
+}
+
 void initSongDisplay(int song) {
     if (song == 0) {
         return;
@@ -33,17 +66,6 @@ void initSongDisplay(int song) {
         // In K Rool gets launched cutscene
         return;
     }
-    int channel = getTrackChannel(song);
-    int writeSlot = getSongWriteSlot(song);
-    if ((MusicTrackChannels[channel] == song) && ((songData[song] & 0x200) == 0)) {
-        if(cspGetState(compactSequencePlayers[writeSlot]) == 1){
-            // If CompactSequence Player is already playing this song
-            // Not gonna bother looking through the event queue whether or not
-            // the CompactSequence Player is being stopped and started on the same audio frame
-            // because that's hard to trigger and very expensive, if even reliable.
-            return;
-        }
-    }
     if (DisplayedSongNamePointer) {
         complex_free(DisplayedSongNamePointer);
     }

randomizer/Patching/ASMPatcher.py

@@ -2329,7 +2329,6 @@ def patchAssembly(ROM_COPY, spoiler):
 
     writeFunction(ROM_COPY, 0x80602AB0, Overlay.Static, "filterSong", offset_dict)
     writeValue(ROM_COPY, 0x80602AAC, Overlay.Static, 0x27A40018, offset_dict, 4)  # addiu $a0, $sp, 0x18I
-    writeFunction(ROM_COPY, 0x80602B80, Overlay.Static, "filterSong_Cancelled", offset_dict)
     # Decompressed Overlays
     overlays_being_decompressed = [
         0x08,  # Cutscenes