Merge 'Fix custom song name display enabled when it should not be' (#2264)

Author: fenhl

ASM/build/asm_symbols.txt

@@ -9,6 +9,8 @@ bool child_safe = false;
 
 bool missing_dlist = false;
 
+extern uint8_t CFG_SONG_NAME_STATE;
+
 const int text_width = 5;
 const int text_height = 10;
 
@@ -20,7 +22,7 @@ void draw_illegal_model_text(z64_disp_buf_t* db) {
     }
 
     // If custom music songs are displayed, only show the text in the inventory screen.
-    if (are_song_displayed() && z64_game.pause_ctxt.screen_idx != 0) {
+    if (CFG_SONG_NAME_STATE > SONG_NAME_NONE && z64_game.pause_ctxt.screen_idx != 0) {
         return;
     }
 

ASM/build/bundle.o

@@ -3,7 +3,7 @@
 extern uint8_t CFG_SPEEDUP_MUSIC_FOR_LAST_TRIFORCE_PIECE;
 extern uint8_t CFG_SLOWDOWN_MUSIC_WHEN_LOWHP;
 extern char CFG_SONG_NAMES[];
-extern uint8_t CFG_SONG_NAME_POSITION;
+extern uint8_t CFG_SONG_NAME_STATE;
 
 static uint16_t previousSeqIndexChange = 0;
 static uint8_t isSlowedDown = 0;
@@ -62,21 +62,17 @@ int bgm_sequence_ids[47] = {
     0x55, 0x56, 0x58, 0x5A, 0x5B, 0x5C, 0x5F, 0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x6B, 0x6C,
 };
 
-#define TEXT_WIDTH 6
-#define TEXT_HEIGHT 11
-#define SONG_NAME_FRAMES_VISIBLE 100
-#define SONG_NAME_FRAMES_FADE_AWAY 80
-#define SONG_NAME_FRAMES_FADE_INTO 5
+static const uint8_t TEXT_WIDTH = 6;
+static const uint8_t TEXT_HEIGHT = 11;
+static const uint8_t SONG_NAME_FRAMES_VISIBLE = 100;
+static const uint8_t SONG_NAME_FRAMES_FADE_AWAY = 80;
+static const uint8_t SONG_NAME_FRAMES_FADE_INTO = 5;
 static uint32_t frames = 0;
 static uint32_t display_song_name_flag = 0;
 static uint16_t previousSeqIndexName = 0;
 
-uint8_t are_song_displayed() {
-    return *CFG_SONG_NAMES ? 1 : 0;
-}
-
 void display_song_name(z64_disp_buf_t* db) {
-    if (are_song_displayed() &&
+    if (CFG_SONG_NAME_STATE > SONG_NAME_NONE &&
         !dungeon_info_is_drawn() && // Don't display if the custom rando pause screen if displayed.
         !(z64_link.state_flags_2 & 0x8000000)) { // Don't display if Link is playing the Ocarina.
 
@@ -100,7 +96,7 @@ void display_song_name(z64_disp_buf_t* db) {
             alpha = 255;
             frames = 0;
         }
-        else if (CFG_SONG_NAME_POSITION == SONG_NAME_PAUSE) {
+        else if (CFG_SONG_NAME_STATE == SONG_NAME_PAUSE) {
             return;
         }
         else {
@@ -152,7 +148,7 @@ void display_song_name(z64_disp_buf_t* db) {
 }
 
 void display_song_name_on_file_select(z64_disp_buf_t* db) {
-    if (!dungeon_info_is_drawn() && are_song_displayed()) {
+    if (CFG_SONG_NAME_STATE > SONG_NAME_NONE) {
         uint8_t top = 7;
         uint8_t left = 7;
         uint8_t alpha = 255;

ASM/build/c_symbols.txt

@@ -1,3 +1,6 @@
+#ifndef MUSIC_H
+#define MUSIC_H
+
 #include <stdbool.h>
 #include "z64.h"
 #include "triforce.h"
@@ -8,11 +11,12 @@ void manage_music_changes();
 _Bool Health_IsCritical();
 void display_song_name(z64_disp_buf_t* db);
 void display_song_name_on_file_select(z64_disp_buf_t* db);
-uint8_t are_song_displayed();
 
 typedef enum {
-    /* 0 */ SONG_NAME_TOP, // Top of the screen.
-    /* 1 */ SONG_NAME_PAUSE, // Pause screen only.
+    /* 0 */ SONG_NAME_NONE, // Never displayed.
+    /* 1 */ SONG_NAME_TOP, // Top of the screen.
+    /* 2 */ SONG_NAME_PAUSE, // Pause screen only.
 } SongNamePosition;
 
-#define CAN_DISPLAY_SONG_NAME ()
+
+#endif

ASM/c/model_text.c

@@ -90,7 +90,7 @@ CFG_DPAD_ON_THE_LEFT:
 CFG_INPUT_VIEWER:
 .byte 0x00
 
-CFG_SONG_NAME_POSITION:
+CFG_SONG_NAME_STATE:
 .byte 0x00
 
 .area 0xA5A, 0

ASM/c/music.c

@@ -978,11 +978,12 @@ def patch_input_viewer(rom: Rom, settings: Settings, log: CosmeticsLog, symbols:
 
 def patch_song_names(rom: Rom, settings: Settings, log: CosmeticsLog, symbols: dict[str, int]) -> None:
     bytes_to_write = []
+    rom.write_byte(symbols['CFG_SONG_NAME_STATE'], 0x00)
     if settings.display_custom_song_names != 'off':
         if settings.display_custom_song_names == 'top':
-            rom.write_byte(symbols['CFG_SONG_NAME_POSITION'], 0x00)
+            rom.write_byte(symbols['CFG_SONG_NAME_STATE'], 0x01)
         if settings.display_custom_song_names == 'pause':
-            rom.write_byte(symbols['CFG_SONG_NAME_POSITION'], 0x01)
+            rom.write_byte(symbols['CFG_SONG_NAME_STATE'], 0x02)
 
     for index, song_name in enumerate(log.bgm.values()):
         if index >= 47:
@@ -1209,7 +1210,7 @@ def patch_song_names(rom: Rom, settings: Settings, log: CosmeticsLog, symbols: d
     ],
     "symbols": {
         **patch_sets[0x1F073FE1]["symbols"],
-        "CFG_SONG_NAME_POSITION": 0x006C,
+        "CFG_SONG_NAME_STATE": 0x006C,
         "CFG_SONG_NAMES": 0x006D,
     }
 }