Merge Rewrite scarecrow hacks in C (OoTRandomizer#2508) and [S9] Re-add some sometimes hints that were unintentionally excluded (OoTRandomizer#2509)

Author: TreZc0

ASM/build/asm_symbols.txt

@@ -1,8 +1,53 @@
 #include <stdint.h>
 
-void store_scarecrow_fix(uint16_t* from, uint16_t* song) {
-    for (int i = 0; i < 0x40; i+=2) {
-        if (song[i] == 0x5700 || song[i] == 0) continue;
-        if (song[i + 1] < 4) song[i + 1] = 4;
+typedef struct OcarinaNote {
+    /* 0x0 */ uint8_t pitch; // number of semitones above middle C
+    /* 0x2 */ uint16_t length; // number of frames the note is sustained
+    /* 0x4 */ uint8_t volume;
+    /* 0x5 */ uint8_t vibrato;
+    /* 0x6 */ int8_t bend; // frequency multiplicative offset from the pitch
+    /* 0x7 */ uint8_t bFlat4Flag; // Flag for resolving whether (pitch = OCARINA_PITCH_BFLAT4) gets mapped to either C_RIGHT and C_LEFT
+} OcarinaNote;  // size = 0x8
+
+void* save_scarecrow_song(uint8_t* dest, uint8_t* src, int32_t len) {
+
+    // Check if the first note is a rest, and shift the song to start to the next note if so.
+    if (src[0] == 0xFF) {
+        src += 8;
+        len -= 8;
+    }
+
+    // Fix the length of each note to a minimum.
+    OcarinaNote* scarecrow_song = (OcarinaNote*)src;
+    uint8_t song_notes = 0;
+    for (uint8_t i = 0; i < 20; i++) {
+        if (scarecrow_song[i].length < 4 && scarecrow_song[i].pitch > 0) {
+            scarecrow_song[i].length = 4;
+        }
+
+        // Determine position of eighth non-rest note
+        if (scarecrow_song[i].pitch > 0 && scarecrow_song[i].pitch != 0xFF) {
+            song_notes++;
+        }
+        // Ignore rests and notes after the eighth input
+        if (song_notes > 8) {
+            scarecrow_song[i].pitch = 0;
+            scarecrow_song[i].length = 0;
+            scarecrow_song[i].volume = 0;
+            scarecrow_song[i].vibrato = 0;
+            scarecrow_song[i].bend = 0;
+            scarecrow_song[i].bFlat4Flag = 0;
+        }
     }
+
+    // Displaced Memcpy
+    uint8_t* d = dest;
+    const uint8_t* s = src;
+
+    while (len > 0) {
+        *d++ = *s++;
+        len--;
+    }
+
+    return dest;
 }

ASM/build/bundle.o

@@ -17,33 +17,3 @@ adapt_scarecrow:
     nop
 ; Now we can continue with our comparison between t0 and at
 ; If at != t0, following code will branch to ignore
-
-
-save_scarecrow_song:
-; 80057030
-; A0 = Scarecrow Song save address (copy to)
-; A1 = Scarecrow Song live location (copy from)
-; A2 = 0x80
-    addiu   sp, sp, -0x18
-    sw      a1, 0x0(sp)
-    sw      a2, 0x4(sp)
-    sw      a3, 0x8(sp)
-    sw      ra, 0x10(sp)
-    lb      t0, 0x0000(a1)
-    addiu   t1, t0, 1
-    bne     t1, zero, @@copy_song ; if scarecrow song doesn't begin with a rest, copy it to the save data
-    nop
-    or      a0, zero, a1
-    addiu   a1, a1, 8
-    jal     0x57030             ; shift scarecrow song over by 1 note
-    addiu   a2, a2, -8
-
-@@copy_song:
-    jal     store_scarecrow_fix
-    nop
-    lw      ra, 0x10(sp)
-    lw      a3, 0x8(sp)
-    lw      a2, 0x4(sp)
-    lw      a1, 0x0(sp)
-    j       0x57030
-    addiu   sp,sp,0x18

ASM/build/c_symbols.txt

@@ -14,14 +14,6 @@
         { "location": "Sheik in Ice Cavern", "types": ["sometimes"] },
         { "location": "Sheik at Colossus", "types": ["sometimes"] },
         { "location": "GF HBA 1500 Points", "types": ["sometimes"] },
-        { "location": "GC Maze Left Chest", "types": ["sometimes"] },
-        { "location": "GV Chest", "types": ["sometimes"] },
-        { "location": "HC Great Fairy Reward", "types": ["sometimes"] },
-        { "location": "OGC Great Fairy Reward", "types": ["sometimes"] },
-        { "location": "Water Temple River Chest", "types": ["sometimes"] },
-        { "location": "Gerudo Training Ground Maze Path Final Chest", "types": ["sometimes"] },
-        { "location": "Spirit Temple Silver Gauntlets Chest", "types": ["sometimes"] },
-        { "location": "Spirit Temple Mirror Shield Chest", "types": ["sometimes"] },
         { "location": "Graveyard Dampe Race Rewards", "types": ["dual"] },
         { "location": "Graveyard Royal Family Tomb Contents", "types": ["dual"] },
         { "location": "Ice Cavern Final Room", "types": ["dual"] }