music hook advancement

bpre.sym

@@ -87,7 +87,8 @@ task_exec = 0x08077579;
 objc_exec = 0x08006B5D;
 obj_sync = 0x08006BA9;
 
-flag_clear = 0x0806E6A9;
+flag_clear = 0x0806E6A8|1;
+flag_set = 0x0806E680|1;
 
 divide = 0x081E4018;
 
@@ -184,7 +185,13 @@ mplay_table = 0x084A329C;
 m4aSongNumStart = 0x081DD0F5;
 MPlayStart_rev01 = 0x081DD859;
 MPlayContinue = 0x081DCFF9;
+MPlayAllStop = 0x081DD228|1;
+
+current_map_music_set = 0x08071A74|1;
+current_map_music_set_to_zero = 0x08071A44|1;
+current_map_music_fadeout = 0x08071AB4|1;
+
 __aeabi_idiv = 0x081E4018|1;
 __aeabi_idivmod = 0x081E40F4|1;
 __aeabi_uidiv = 0x081E460C|1;
-__aeabi_uidivmod = 0x081E4684|1;
+__aeabi_uidivmod = 0x081E4684|1;

makefile

@@ -13,7 +13,7 @@ export PATH := $(realpath ../tools):$(PATH)
 
 DEFINES   := -DBPRE -DSOFTWARE_VERSION=0
 ASFLAGS   := -mthumb
-CFLAGS    := -mthumb -mthumb-interwork -g -mcpu=arm7tdmi -fno-inline -mlong-calls -march=armv4t -O3 -std=c99 -Wall -Isrc/include $(DEFINES)
+CFLAGS    := -mthumb -mthumb-interwork -g -mcpu=arm7tdmi -fno-inline -mlong-calls -march=armv4t -O3 -std=c99 -Wall -Wextra -Wunreachable-code -Isrc/include $(DEFINES)
 GRITFLAGS := -ftc -fa
 LDFLAGS   := -z muldefs
 BLDPATH   := object

patches/hooks.asm

@@ -28,20 +28,16 @@ _call_via_r1 equ 0x081E3BAC
     BX  LR
 
    // music overrides
-.org 0x081DD0F4
-    LDR R1, =music_override|1  // TODO wait for replacement by functions below, but can stay for now
-    BX  R1
-    .pool
 
-.org 0x0808064C // intro music (!) song hook
+.org 0x0808064C // encounter music ([!] Box) song hook
     LDR R1, =mhk_intro_music_id_to_song|1
     BL  _call_via_r1
     B   0x080806BA
     .pool
 
-.org 0x08043FD4 // batle music song hook
-    LDR R0, =mhk_song_id_for_battle|1
-    BX  R0
+.org 0x08044090
+    LDR R1, =mhk_current_map_music_set_default_for_battle|1
+    BX  R1
     .pool
 
 .org 0x080156FE // trainer victory music hook
@@ -51,17 +47,22 @@ _call_via_r1 equ 0x081E3BAC
     .pool
 
 .org 0x08021D46  // wild poke defeated
-    BL  _call_via_r0 // call via r0
+    BL  _call_via_r0
 .org 0x08021D94
     .word   mhk_wild_poke_def_music|1
 
 .org 0x0807F9F8
     LDR R1, =0x0807FA3E
-    BL  _call_via_r1 // call via r1
+    BL  _call_via_r1
     MOV R1, R0
     B   0x0807FA3E
     .pool
 
+.org 0x080159D0
+    LDR R0, =mhk_fadeout|1
+    BL  _call_via_r0
+    B   0x080159DC
+    .pool
 
 
 //End of sound stuff

src/battle_engine/custom_structs_malloc.c

@@ -67,6 +67,7 @@ void free_battle_structs()
     free(custom_battle_elements.ptr);
     custom_battle_elements.ptr=0;
     flag_clear(FLAG_DEOXYS_AURA);
+    flag_clear(FLAG_SKIP_BATTLE_MUSIC);
 }
 
 //hijack switch in command, clean up battle structs and carry over baton pass

src/include/config.h

@@ -48,11 +48,7 @@
 #define VAR_TO_3 0x51FF
 
 /*Flag to enable the music overrides*/
-#define FLAG_ENABLE_MUSIC_OVERRIDES 0x742
-
-/*Special music override values*/
-#define MUS_NO_OVERRIDE 0xFFFF
-#define MUS_SKIP_PLAY 0xFFFE
+#define FLAG_SKIP_BATTLE_MUSIC 0x742
 
 /*Flag to deactivate transparent textboxes*/
 #define FLAG_ACTIVATE		0x900

src/include/game_engine.h

@@ -76,6 +76,12 @@ extern u8 flag_check(u32 flag);
 extern void flag_clear(u16 flag);
 
 /**
+ * @brief sets a flag
+ * @param flag flag index to set
+ */
+extern void flag_set(u16 flag);
+
+/**
  * @brief gets attribute of pokémon
  * @param poke_address address to pokémon structure
  * @param request request from the attribute request table

src/include/pokemon.h

@@ -2,6 +2,7 @@
 #define POKE_INDICES_H
 
 #define POKE_PIKACHU    25
+#define POKE_ODDISH     43
 #define POKE_FARFETCHD  83
 #define POKE_CUBONE     104
 #define POKE_MAROWAK    105

src/include/sound.h

@@ -53,8 +53,14 @@ typedef struct {
 
 extern m_play_table mplay_table[];
 extern song_table _songtable[];
-extern void m4aSongNumStart(u16 songid);
-extern void MPlayStart_rev01(music_player_area *ma, song_header *so);
-extern void MPlayContinue(music_player_area *ma);
+void m4aSongNumStart(u16 songid);
+void MPlayStart_rev01(music_player_area *ma, song_header *so);
+void MPlayContinue(music_player_area *ma);
+void MPlayAllStop(void);
+
+// battle and map related stuff
+void current_map_music_set(u16);
+void current_map_music_set_to_zero(void);
+void current_map_music_fadeout(u8);
 
 #endif

src/music/battle_music_lookup.c

@@ -4,6 +4,13 @@
 #include <battle_structs.h>
 #include <battle_common.h>
 #include <pokemon.h>
+#include <agb_debug.h>
+#include <sound.h>
+#include <config.h>
+
+#define SONG_ID_SKIP_PLAY 0xFFFF
+
+#define skip_song flag_check(FLAG_SKIP_BATTLE_MUSIC)
 
 u16 mhk_intro_music_id_to_song(u8 introid) {
     u16 res = 0;
@@ -32,7 +39,6 @@ u16 mhk_intro_music_id_to_song(u8 introid) {
     return res;
 }
 
-// replaces sub_08043FD4
 u16 mhk_song_id_for_battle(void) {
     u16 res = 0;
 
@@ -60,7 +66,27 @@ u16 mhk_song_id_for_battle(void) {
     return res;
 }
 
+// replaces 0x08044090
+void mhk_current_map_music_set_default_for_battle(u16 songid) {
+    if (skip_song)
+        return;
+    if (songid == 0) {
+        songid = mhk_song_id_for_battle();
+        if (songid != SONG_ID_SKIP_PLAY) {
+            current_map_music_set_to_zero();
+            MPlayAllStop();
+            current_map_music_set(songid);
+        }
+    } else {
+        current_map_music_set_to_zero();
+        MPlayAllStop();
+        current_map_music_set(songid);
+    }
+}
+
 void mhk_trainer_battle_play_defeat(void) {
+    if (skip_song)
+        return;
     u16 song = 0;
 
     switch (trainer_data[trainerbattle_flag_id].trainer_class) {
@@ -77,9 +103,12 @@ void mhk_trainer_battle_play_defeat(void) {
 }
 
 void mhk_wild_poke_def_music(void) {
-    song_play_for_text(SEQ_BGM_VIC_POKE);
+    if (!skip_song) {
+        song_play_for_text(SEQ_BGM_VIC_POKE);
+    }
 }
 
+// this seems to work by special 0x138 only
 u16 mhk_species_to_song(u16 species) {
     u16 res = 0;
 
@@ -104,3 +133,12 @@ u16 mhk_species_to_song(u16 species) {
 
     return res;
 }
+
+// hook from loc_80159D0
+void mhk_fadeout(void) {
+    void (*sub_8070E44)(u8) = (void (*)(u8))(0x08070E44|1);
+    sub_8070E44(3); // no idea what these values do
+    if (!skip_song) {
+        current_map_music_fadeout(5); // same here
+    }
+}

src/music/music_override.c

@@ -1,78 +0,0 @@
-/****************************************************************************
- * Copyright (C) 2015-2016 by the SotS Team                                 *
- *                                                                          *
- * This file is part of Sovereign of the Skies.                             *
- *                                                                          *
- *   Sovereign of the Skies is free software: you can redistribute it       *
- *   and/or modify it                                                       *
- *   under the terms of the GNU Lesser General Public License as published  *
- *   by the Free Software Foundation, either version 3 of the License, or   *
- *   (at your option) any later version provided you include a copy of the  *
- *   licence and this header.                                               *
- *                                                                          *
- *   Sovereign of the Skies is distributed in the hope that it will be      *
- *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
- *   GNU Lesser General Public License for more details.                    *
- *                                                                          *
- *   You should have received a copy of the GNU Lesser General Public       *
- *   License along with Sovereign of the Skies.                             *
- *   If not, see <http://www.gnu.org/licenses/>.                            *
- ****************************************************************************/
-
-/**
- * @file music_override.c
- * @author ipatix
- * @date 15 dec 2016
- * @brief Play some custom music
- * 
- */
-
-/* === INCLUDES === */
-
-#include <sound.h>
-#include <game_engine.h>
-#include <config.h>
-
-/* === PROTTYPES === */
-/**
- * @brief overrides a music routine to load music ids from a custom variable
- * @param songid song_id to be overridden
- */
-void music_override(u16 songid);
-
-/* === IMPLEMENTATIONS === */
-void music_override(u16 songid) {
-    int skip = 0;
-    if (flag_check(FLAG_ENABLE_MUSIC_OVERRIDES)) {
-        u16 from1, from2, from3, to1, to2, to3;
-        if ((from1 = *var_access(VAR_FROM_1)) == songid) {
-            to1 = *var_access(VAR_TO_1);
-            if (to1 == MUS_SKIP_PLAY) {
-                skip = 1;
-            } else if (to1 != MUS_NO_OVERRIDE) {
-                songid = to1;
-            }
-        } else if ((from2 = *var_access(VAR_FROM_2)) == songid) {
-            to2 = *var_access(VAR_TO_2);
-            if (to2 == MUS_SKIP_PLAY) {
-                skip = 1;
-            } else if (to2 != MUS_NO_OVERRIDE) {
-                songid = to2;
-            }
-        } else if ((from3 = *var_access(VAR_FROM_3)) == songid) {
-            to3 = *var_access(VAR_TO_3);
-            if (to3 == MUS_SKIP_PLAY) {
-                skip = 1;
-            } else if (to3 != MUS_NO_OVERRIDE) {
-                songid = to3;
-            }
-        }
-    }
-
-    if (skip == 0) {
-        MPlayStart_rev01(mplay_table[_songtable[songid].ms].ma, _songtable[songid].so);
-    } else {
-        MPlayContinue(mplay_table[_songtable[songid].ms].ma);
-    }
-}

src/specials/trainer_battle.c

@@ -41,7 +41,6 @@ extern void battle_init();
 extern void battle_80801F0_something();
 
 extern volatile u8 trainerbattle_battle_type;
-extern volatile u16 trainerbattle_flag_id;
 extern volatile u16 trainerbattle_arg2;
 extern volatile char* trainerbattle_message_intro;
 extern volatile char* trainerbattle_message_defeat;
@@ -313,4 +312,4 @@ void* tb_configure_by_script(void* ptr_script)
     /* should never be reached */
     //assert(0);
    // return NULL;
-}
+}