Merge branch 'develop/2.1.0' of https://github.com/Arceveti/HackerSM64 into develop/2.1.0-four-controllers-base

.gitignore

@@ -38,6 +38,9 @@
 # datadump
 /tools/ddump/*
 
+# python cache in tools/
+/tools/__pycache__/*
+
 # Text editor remnants
 *.swp
 .vscode/*

Makefile

@@ -305,23 +305,23 @@ ifeq ($(filter clean distclean print-%,$(MAKECMDGOALS)),)
   # Make sure assets exist
   NOEXTRACT ?= 0
   ifeq ($(NOEXTRACT),0)
-    DUMMY != $(PYTHON) extract_assets.py $(VERSION) >&2 || echo FAIL
+    DUMMY != $(PYTHON) extract_assets.py us >&2 || echo FAIL
     ifeq ($(DUMMY),FAIL)
       $(error Failed to extract assets from US ROM)
     endif
-    ifneq (,$(wildcard baserom.jp.z64))
+    ifneq (,$(shell python3 tools/detect_baseroms.py jp))
       DUMMY != $(PYTHON) extract_assets.py jp >&2 || echo FAIL
       ifeq ($(DUMMY),FAIL)
         $(error Failed to extract assets from JP ROM)
       endif
     endif
-    ifneq (,$(wildcard baserom.eu.z64))
+    ifneq (,$(shell python3 tools/detect_baseroms.py eu))
       DUMMY != $(PYTHON) extract_assets.py eu >&2 || echo FAIL
       ifeq ($(DUMMY),FAIL)
         $(error Failed to extract assets from EU ROM)
       endif
     endif
-    ifneq (,$(wildcard baserom.sh.z64))
+    ifneq (,$(shell python3 tools/detect_baseroms.py sh))
       DUMMY != $(PYTHON) extract_assets.py sh >&2 || echo FAIL
       ifeq ($(DUMMY),FAIL)
         $(error Failed to extract assets from SH ROM)
@@ -557,6 +557,10 @@ all: $(ROM)
 clean:
 	$(RM) -r $(BUILD_DIR_BASE)
 
+rebuildtools:
+	$(MAKE) -C tools distclean
+	$(MAKE) -C tools
+
 distclean: clean
 	$(PYTHON) extract_assets.py --clean
 	$(MAKE) -C $(TOOLS_DIR) clean
@@ -584,7 +588,7 @@ unf: $(ROM) $(LOADER)
 libultra: $(BUILD_DIR)/libultra.a
 
 patch: $(ROM)
-	$(FLIPS) --create --bps ./baserom.$(VERSION).z64 $(ROM) $(BUILD_DIR)/$(TARGET_STRING).bps
+	$(FLIPS) --create --bps $(shell python3 tools/detect_baseroms.py $(VERSION)) $(ROM) $(BUILD_DIR)/$(TARGET_STRING).bps
 
 # Extra object file dependencies
 $(BUILD_DIR)/asm/ipl3.o:              $(IPL3_RAW_FILES)
@@ -894,7 +898,7 @@ endif
 $(BUILD_DIR)/$(TARGET).objdump: $(ELF)
 	$(OBJDUMP) -D $< > $@
 
-.PHONY: all clean distclean default test load
+.PHONY: all clean distclean default test load rebuildtools
 # with no prerequisites, .SECONDARY causes no intermediate target to be removed
 .SECONDARY:
 

extract_assets.py

@@ -4,55 +4,7 @@ import os
 import json
 import subprocess
 
-ROMS_DIR=os.path.expanduser("~/baseroms/")
-
-sha1_LUT = {
-    "eu": "4ac5721683d0e0b6bbb561b58a71740845dceea9",
-    "jp": "8a20a5c83d6ceb0f0506cfc9fa20d8f438cafe51",
-    "sh": "3f319ae697533a255a1003d09202379d78d5a2e0",
-    "us": "9bef1128717f958171a4afac3ed78ee2bb4e86ce",
-}
-
-sha1_swapLUT = {
-    "eu": "d80ee9eeb6454d53a96ceb6ed0aca3ffde045091",
-    "jp": "1d2579dd5fb1d8263a4bcc063a651a64acc88921",
-    "sh": "2a2b85e94581545ca3c05b8f864b488b141a8a1f",
-    "us": "1002dd7b56aa0a59a9103f1fb3d57d6b161f8da7",
-}
-
-def get_rom_candidates():
-    fileArray = [f for f in os.listdir(os.getcwd()) if os.path.isfile(f)]
-    if os.path.exists(ROMS_DIR):
-        fileArray += [os.path.join(ROMS_DIR, f) for f in os.listdir(ROMS_DIR) if os.path.isfile(os.path.join(ROMS_DIR, f))]
-
-    foundVersions = {}
-
-    for f in fileArray:
-        try:
-            p = subprocess.Popen(
-                ["sha1sum", f],
-                stdout=subprocess.PIPE
-            )
-            sha1sum = p.communicate()[0].decode('ascii').split()[0]
-            for k, v in sha1_LUT.items():
-                if v == sha1sum:
-                    foundVersions[k] = f
-
-            for k, v in sha1_swapLUT.items():
-                if v == sha1sum: # the ROM is swapped!
-                    subprocess.run(
-                        [
-                            "dd","conv=swab",
-                            "if=%s" % f,
-                            "of=/tmp/baserom.%s.swapped.z64" % k
-                        ],
-                        stderr=subprocess.PIPE,
-                    )
-                    foundVersions[k] = "/tmp/baserom.%s.swapped.z64" % k
-        except Exception as e:
-            continue
-    return foundVersions
-
+from tools.detect_baseroms import get_rom_candidates
 
 def read_asset_map():
     with open("assets.json") as f:

src/audio/data.c

@@ -83,10 +83,10 @@ u8 sReverbMultsArr[][NUM_ALLPASS / 3] = {
  * - gainIndex              (Advanced parameter; used to tune the outputs of every first two of three filters; overridden when using light settings)
  * - reverbIndex            (Advanced parameter; used to tune the incoming output of every third filter; overridden when using light settings)
  * 
- * - *delaysL               (Advanced parameter; array of variable audio buffer sizes / delays for each respective filter [left channel]; overridden when using light settings)
- * - *delaysR               (Advanced parameter; array of variable audio buffer sizes / delays for each respective filter [right channel]; overridden when using light settings)
- * - *reverbMultsL          (Advanced parameter; array of multipliers applied to the final output of each group of 3 filters [left channel])
- * - *reverbMultsR          (Advanced parameter; array of multipliers applied to the final output of each group of 3 filters [right channel])
+ * - *delaysL               (Advanced parameter; array of variable audio buffer sizes / delays for each respective filter [left channel])
+ * - *delaysR               (Advanced parameter; array of variable audio buffer sizes / delays for each respective filter [right channel])
+ * - *reverbMultsL          (Advanced parameter; array of multipliers applied to the final output of each group of 3 filters [left channel]; overridden when using light settings)
+ * - *reverbMultsR          (Advanced parameter; array of multipliers applied to the final output of each group of 3 filters [right channel]; overridden when using light settings)
  * 
  * NOTE: The first entry will always be used by default when not using the level commands to specify a preset.
  * Please reference the HackerSM64 Wiki for more descriptive documentation of these parameters and usage of BETTER_REVERB in general.

src/audio/external.h

@@ -13,9 +13,11 @@
 
 enum SoundModes {
     SOUND_MODE_STEREO,
-    SOUND_MODE_HEADSET,
-    SOUND_MODE_UNUSED,
     SOUND_MODE_MONO,
+#ifdef ENABLE_STEREO_HEADSET_EFFECTS
+    SOUND_MODE_HEADSET,
+#endif
+    SOUND_MODE_COUNT,
 };
 
 enum SequencePlayers {

src/game/mario_actions_cutscene.c

@@ -1471,6 +1471,7 @@ s32 act_teleport_fade_in(struct MarioState *m) {
         }
     }
 
+    m->pos[1] = m->floorHeight;
     stop_and_set_height_to_floor(m);
 
     return FALSE;

src/game/save_file.c

@@ -3,6 +3,7 @@
 #include "sm64.h"
 #include "game_init.h"
 #include "main.h"
+#include "audio/external.h"
 #include "engine/math_util.h"
 #include "area.h"
 #include "level_update.h"
@@ -717,6 +718,10 @@ void save_file_set_widescreen_mode(u8 mode) {
 #endif
 
 u32 save_file_get_sound_mode(void) {
+    if (gSaveBuffer.menuData.soundMode >= SOUND_MODE_COUNT) {
+        return 0;
+    }
+
     return gSaveBuffer.menuData.soundMode;
 }
 

src/game/sound_init.c

@@ -36,11 +36,6 @@ static u16 sCurrentCapMusic = MUSIC_NONE;
 #ifdef ENABLE_VANILLA_LEVEL_SPECIFIC_CHECKS
 static u8 sPlayingInfiniteStairs = FALSE;
 #endif
-#ifdef ENABLE_STEREO_HEADSET_EFFECTS
-static s16 sSoundMenuModeToSoundMode[3] = { SOUND_MODE_STEREO, SOUND_MODE_MONO, SOUND_MODE_HEADSET };
-#else
-static s16 sSoundMenuModeToSoundMode[2] = { SOUND_MODE_STEREO, SOUND_MODE_MONO };
-#endif
 // Only the 20th array element is used.
 static u32 sMenuSoundsExtra[] = {
     SOUND_MOVING_TERRAIN_SLIDE + (0 << 16),
@@ -147,8 +142,8 @@ void enable_background_sound(void) {
  * Called from threads: thread5_game_loop
  */
 void set_sound_mode(u16 soundMode) {
-    if (soundMode < ARRAY_COUNT(sSoundMenuModeToSoundMode)) {
-        gSoundMode = sSoundMenuModeToSoundMode[soundMode];
+    if (soundMode < SOUND_MODE_COUNT) {
+        gSoundMode = soundMode;
     }
 }
 

src/game/sound_init.h

@@ -17,12 +17,6 @@ enum SoundMenuFlags {
     SOUND_MENU_FLAG_EXTRA           = (1 << 8), // 0x100
 };
 
-enum SoundMenuMode {
-    SOUND_MENU_MODE_STEREO,
-    SOUND_MENU_MODE_MONO,
-    SOUND_MENU_MODE_HEADSET
-};
-
 void reset_volume(void);
 void raise_background_noise(s32 a);
 void lower_background_noise(s32 a);

src/menu/file_select.c

@@ -87,11 +87,10 @@ u8 sTextFadeAlpha = 0;
 // and when you click yes/no in the erase confirmation prompt.
 s16 sMainMenuTimer = 0;
 
-// Sound mode menu buttonID, has different values compared to gSoundMode in audio.
-// 0: gSoundMode = 0 (Stereo) | 1: gSoundMode = 3 (Mono) | 2: gSoundMode = 1 (Headset)
+// Sound mode menu buttonID
 s8 sSoundMode = 0;
 
-// Active language for EU arrays, values defined similar to sSoundMode
+// Active language for EU arrays
 // 0: English | 1: French | 2: German
 
 // Tracks which button will be pressed in the erase confirmation prompt (yes/no).
@@ -836,7 +835,7 @@ void render_sound_mode_menu_buttons(struct Object *soundModeButton) {
     sMainMenuButtons[MENU_BUTTON_LANGUAGE_RETURN]->oMenuButtonScale = MENU_BUTTON_SCALE;
 #else
     // Zoom in current selection
-    sMainMenuButtons[MENU_BUTTON_OPTION_MIN + sSoundMode]->oMenuButtonState = MENU_BUTTON_STATE_ZOOM_IN;
+    sMainMenuButtons[MENU_BUTTON_SOUND_OPTION_MIN + sSoundMode]->oMenuButtonState = MENU_BUTTON_STATE_ZOOM_IN;
 #endif
 }
 
@@ -856,12 +855,7 @@ void check_sound_mode_menu_clicked_buttons(struct Object *soundModeButton) {
             if (check_clicked_button(buttonX, buttonY, 22.0f) == TRUE) {
                 // If sound mode button clicked, select it and define sound mode
                 // The check will always be true because of the group configured above (In JP & US)
-#ifdef ENABLE_STEREO_HEADSET_EFFECTS
-                if (buttonID == MENU_BUTTON_STEREO || buttonID == MENU_BUTTON_MONO
-                    || buttonID == MENU_BUTTON_HEADSET) {
-#else
-                if (buttonID == MENU_BUTTON_STEREO || buttonID == MENU_BUTTON_MONO) {
-#endif
+                if (buttonID >= MENU_BUTTON_SOUND_OPTION_MIN && buttonID < MENU_BUTTON_SOUND_OPTION_MAX) {
                     if (soundModeButton->oMenuButtonActionPhase == SOUND_MODE_PHASE_MAIN) {
                         play_sound(SOUND_MENU_CLICK_FILE_SELECT, gGlobalSoundSource);
 #if ENABLE_RUMBLE
@@ -873,7 +867,7 @@ void check_sound_mode_menu_clicked_buttons(struct Object *soundModeButton) {
                         // because they don't have a case in bhv_menu_button_manager_loop
                         sSelectedButtonID = buttonID;
 #endif
-                        sSoundMode = buttonID - MENU_BUTTON_OPTION_MIN;
+                        sSoundMode = buttonID - MENU_BUTTON_SOUND_OPTION_MIN;
                         save_file_set_sound_mode(sSoundMode);
                     }
                 }
@@ -2062,3 +2056,5 @@ s32 lvl_update_obj_and_load_file_selected(UNUSED s32 arg, UNUSED s32 unused) {
     area_update_objects();
     return sSelectedFileNum;
 }
+
+STATIC_ASSERT(SOUND_MODE_COUNT == MENU_BUTTON_SOUND_OPTION_MAX - MENU_BUTTON_SOUND_OPTION_MIN, "Mismatch between number of sound modes in audio code and file select!");

src/menu/file_select.h

@@ -79,22 +79,26 @@ enum MenuButtonTypes {
     // This menu includes language settings on EU
     MENU_BUTTON_SOUND_MODE = MENU_BUTTON_ERASE_MAX,
     MENU_BUTTON_OPTION_MIN,
-    MENU_BUTTON_STEREO = MENU_BUTTON_OPTION_MIN,
+    MENU_BUTTON_SOUND_OPTION_MIN = MENU_BUTTON_OPTION_MIN,
+    MENU_BUTTON_STEREO = MENU_BUTTON_SOUND_OPTION_MIN,
     MENU_BUTTON_MONO,
 #ifdef ENABLE_STEREO_HEADSET_EFFECTS
     MENU_BUTTON_HEADSET,
 #endif
+    MENU_BUTTON_SOUND_OPTION_MAX,
 
 #if MULTILANG
     // Language Menu
-    MENU_BUTTON_LANGUAGE_MIN,
+    MENU_BUTTON_LANGUAGE_MIN = MENU_BUTTON_SOUND_OPTION_MAX,
     MENU_BUTTON_LANGUAGE_ENGLISH = MENU_BUTTON_LANGUAGE_MIN,
     MENU_BUTTON_LANGUAGE_FRENCH,
     MENU_BUTTON_LANGUAGE_GERMAN,
     MENU_BUTTON_LANGUAGE_RETURN,
-#endif
 
     MENU_BUTTON_OPTION_MAX
+#else
+    MENU_BUTTON_OPTION_MAX = MENU_BUTTON_SOUND_OPTION_MAX
+#endif
 };
 
 enum ScoreMenuMessageID {

tools/Flips/errors

@@ -1,24 +0,0 @@
-flips5.cpp:2771: warning: "error" redefined
- 2771 | #define error(which) do { err = which; goto error; } while(0)
-      | 
-flips5.cpp:2021: note: this is the location of the previous definition
- 2021 | #define error(why) do { ret.error=why; return ret; } while(0)
-      | 
-flips5.cpp:3454: warning: "error" redefined
- 3454 | #define error(which) do { error=which; goto exit; } while(0)
-      | 
-flips5.cpp:2771: note: this is the location of the previous definition
- 2771 | #define error(which) do { err = which; goto error; } while(0)
-      | 
-flips5.cpp:3455: warning: "assert_sum" redefined
- 3455 | #define assert_sum(a,b) do { if (SIZE_MAX-(a)<(b)) error(ups_too_big); } while(0)
-      | 
-flips5.cpp:1675: note: this is the location of the previous definition
- 1675 | #define assert_sum(a,b) do { if (SIZE_MAX-(a)<(b)) error(bps_too_big); } while(0)
-      | 
-flips5.cpp:3456: warning: "assert_shift" redefined
- 3456 | #define assert_shift(a,b) do { if (SIZE_MAX>>(b)<(a)) error(ups_too_big); } while(0)
-      | 
-flips5.cpp:1676: note: this is the location of the previous definition
- 1676 | #define assert_shift(a,b) do { if (SIZE_MAX>>(b)<(a)) error(bps_too_big); } while(0)
-      | 

tools/Makefile

@@ -80,6 +80,8 @@ clean:
 	$(RM) UNFLoader*
 	$(MAKE) -C audiofile clean
 
+distclean: clean
+
 define COMPILE
 $(1): $($1_SOURCES)
 	$$(CC) $(CFLAGS) $($1_CFLAGS) $$^ -o $$@ $($1_LDFLAGS) $(LDFLAGS)
@@ -90,4 +92,4 @@ $(foreach p,$(BUILD_PROGRAMS),$(eval $(call COMPILE,$(p))))
 $(LIBAUDIOFILE):
 	@$(MAKE) -C audiofile
 
-.PHONY: all all-except-recomp clean default
+.PHONY: all all-except-recomp clean distclean default

tools/detect_baseroms.py

@@ -0,0 +1,66 @@
+import subprocess
+import os
+import sys
+
+XDG_DATA_DIR=os.environ.get("XDG_DATA_HOME") or "~/.local/share"
+ROMS_DIR=os.path.expanduser(os.path.join(XDG_DATA_DIR, "HackerSM64"))
+
+sha1_LUT = {
+    "eu": "4ac5721683d0e0b6bbb561b58a71740845dceea9",
+    "jp": "8a20a5c83d6ceb0f0506cfc9fa20d8f438cafe51",
+    "sh": "3f319ae697533a255a1003d09202379d78d5a2e0",
+    "us": "9bef1128717f958171a4afac3ed78ee2bb4e86ce",
+}
+
+sha1_swapLUT = {
+    "eu": "d80ee9eeb6454d53a96ceb6ed0aca3ffde045091",
+    "jp": "1d2579dd5fb1d8263a4bcc063a651a64acc88921",
+    "sh": "2a2b85e94581545ca3c05b8f864b488b141a8a1f",
+    "us": "1002dd7b56aa0a59a9103f1fb3d57d6b161f8da7",
+}
+
+def get_rom_candidates():
+    fileArray = [f for f in os.listdir(os.getcwd()) if os.path.isfile(f)]
+    if os.path.exists(ROMS_DIR):
+        fileArray += [os.path.join(ROMS_DIR, f) for f in os.listdir(ROMS_DIR) if os.path.isfile(os.path.join(ROMS_DIR, f))]
+
+    foundVersions = {}
+
+    for f in fileArray:
+        try:
+            p = subprocess.Popen(
+                ["sha1sum", f],
+                stdout=subprocess.PIPE
+            )
+            sha1sum = p.communicate()[0].decode('ascii').split()[0]
+            for k, v in sha1_LUT.items():
+                if v == sha1sum:
+                    foundVersions[k] = f
+
+            for k, v in sha1_swapLUT.items():
+                if v == sha1sum: # the ROM is swapped!
+                    subprocess.run(
+                        [
+                            "dd","conv=swab",
+                            "if=%s" % f,
+                            "of=/tmp/baserom.%s.swapped.z64" % k
+                        ],
+                        stderr=subprocess.PIPE,
+                    )
+                    foundVersions[k] = "/tmp/baserom.%s.swapped.z64" % k
+        except Exception as e:
+            continue
+    return foundVersions
+
+
+if __name__ == "__main__":
+    if len(sys.argv) != 2:
+        print(f"Usage: {sys.argv[0]} version (us jp eu sh)")
+        sys.exit(1)
+    gamelist = get_rom_candidates();
+    version = sys.argv[1]
+
+    if version in gamelist:
+        print(gamelist[version])
+
+