decomp: clarify function, variable and state names (batch 36)

include/rnc/overlay/l18/drek_boss_states.h

@@ -0,0 +1,31 @@
+#ifndef LOMBYTE_RNC_OVERLAY_L18_DREK_BOSS_STATES_H
+#define LOMBYTE_RNC_OVERLAY_L18_DREK_BOSS_STATES_H
+
+/* Moby state IDs shared by the final boss update and its supporting handlers. */
+enum {
+    DREK_BOSS_INITIALIZE = 0,
+    DREK_BOSS_WAIT_FOR_ENCOUNTER_TRIGGER = 1,
+    DREK_BOSS_CIRCLE_AND_FIRE_AT_HERO = 2,
+    DREK_BOSS_WAIT_TO_RESTORE_SAVED_TRANSFORM = 3,
+    DREK_BOSS_WAIT_FOR_GROUNDED_HERO_TO_START_SCENE = 4,
+    DREK_BOSS_INITIALIZE_PAIRED_TRANSFORM_TRANSITION = 5,
+    DREK_BOSS_WAIT_FOR_SCENE = 7,
+    DREK_BOSS_WAIT_FOR_PAIRED_TRANSFORM_TRANSITION = 8,
+    DREK_BOSS_APPROACH_PATH_START = 9,
+    DREK_BOSS_FOLLOW_PATH_AND_FIRE_AT_MOBYS = 10,
+    DREK_BOSS_FINISH_PATH_AND_WAIT_FOR_HERO = 0xB,
+    DREK_BOSS_SELECT_NEXT_ACTION = 0xC,
+    DREK_BOSS_LAUNCH_FORWARD_WITH_LATERAL_OFFSET = 0xD,
+    DREK_BOSS_ACTION_REPOSITION_AND_AIM = 0xE,
+    DREK_BOSS_TARGET_GROUND_POINTS = 0xF,
+    DREK_BOSS_TARGET_RANDOM_ARENA_POINTS = 0x10,
+    DREK_BOSS_TARGET_SIDE_GROUND_POINTS = 0x11,
+    DREK_BOSS_APPROACH_AIM_NODE = 0x12,
+    DREK_BOSS_FOLLOW_HERO = 0x13,
+    DREK_BOSS_ACTIVATE_MISSILE_GROUP = 0x14,
+    DREK_BOSS_APPROACH_SELECTED_MOBY = 0x15,
+    DREK_BOSS_DEATH_EXPLOSIONS = 0x1A,
+    DREK_BOSS_RUN_ENDING_SEQUENCE = 0x1B
+};
+
+#endif /* LOMBYTE_RNC_OVERLAY_L18_DREK_BOSS_STATES_H */

include/rnc/overlay/shared/hero/set_hero_animation.h

@@ -12,8 +12,8 @@ void  show_health_hud(void) __asm__("FUN_L00_00234e00");
 
 s32  get_ammo(s32) __asm__("FUN_L00_00233e98");
 s32  get_hero_target_pose_status(void) __asm__("FUN_L00_00233f38");
-void FUN_L00_00232fe8(void);
-void FUN_L00_002330d0(void);
+void set_hero_item_moby_flag_bit0(void) __asm__("FUN_L00_00232fe8");
+void update_hero_item_moby_flags(void) __asm__("FUN_L00_002330d0");
 s32  use_ammo(s32, s32) __asm__("FUN_L00_00233db8");
 
 #endif /* LOMBYTE_RNC_OVERLAY_SHARED_HERO_SET_HERO_ANIMATION_H */

include/rnc/overlay/shared/math/interpolation/spring_turn.h

@@ -8,7 +8,8 @@ s32 get_first_moby_in_group(void *, s32, s32, s32) __asm__("FUN_L00_002591d0");
 s32 solve_quadratic_equation(f32 *, f32 *, f32, f32, f32) __asm__("FUN_L00_002595a0");
 s32 get_next_moby_in_group(void *, void *, s32, s32) __asm__("FUN_L00_002592b8");
 
-void  FUN_L00_00258490(void *, void *, void *, s32, f32, f32, f32, f32);
+void move_moby_xy_with_collision_constraints(
+    void *, void *, void *, s32, f32, f32, f32, f32) __asm__("FUN_L00_00258490");
 float calculate_triangular_corrected_scalar(float *,
                                             float *,
                                             int *,

include/rnc/overlay/shared/math/vu0_vector_ops.h

@@ -6,6 +6,6 @@
 s32  fast_subtract_rotations_cf(void *) __asm__("FUN_L00_001fefc8");
 void add_vectors(void *, void *, void *) __asm__("FUN_L00_001ff290");
 void reflect_vector(void *, void *, void *) __asm__("FUN_L00_001ff660");
-void rotation_2D5FA8(void *, s32, f32) __asm__("FUN_L00_001fff28");
+void build_axis_rotation_quaternion(void *, s32, f32) __asm__("FUN_L00_001fff28");
 
 #endif /* LOMBYTE_RNC_OVERLAY_SHARED_MATH_VU0_VECTOR_OPS_H */

include/rnc/overlay/shared/rendering/effects/particles.h

@@ -14,7 +14,8 @@ void *spawn_mode_controlled_rotating_alpha_fade_particle(void *,
 struct EmberParticle;
 struct EffectParticle;
 
-unsigned char *FUN_L00_00272f68(u128 *, int, unsigned char, int, int, int, int, float);
+unsigned char *spawn_timed_hero_relative_particle(
+    u128 *, int, unsigned char, int, int, int, int, float) __asm__("FUN_L00_00272f68");
 unsigned char *spawn_color_tween_emitter_particle(void *,
                                                   unsigned char,
                                                   unsigned char,

include/rnc/overlay/shared/weapons.h

@@ -26,7 +26,7 @@ void           linked_moby_states_update(unsigned char *) __asm__("FUN_L00_002b3
 void           metal_detector_update(struct Moby *) __asm__("FUN_L00_002d2ee8");
 void           mine_glove_update(struct Moby *) __asm__("FUN_L00_002c1ad0");
 void           morphoray_update() __asm__("FUN_L00_002bc7e8");
-s32            FUN_L00_002caf40(s32);
+s32            get_morphoray_chicken_slot_record(s32) __asm__("FUN_L00_002caf40");
 int  cancel_suck_cannon_suction_and_set_moby_state_5(struct Moby *) __asm__("FUN_L00_002caf10");
 int  launch_suck_cannon_projectile_and_update_moby_state(struct Moby *,
                                                          int,

src/audio/decoder/audio_dec_begin_put.c

@@ -10,9 +10,12 @@ void audio_dec_begin_put(struct AudioDec *dec,
                          void           **second_destination,
 
                          s32 *size2) {
+    enum {
+        AUDIO_DEC_STATE_HEADER_PENDING = 0
+    };
     s32 writable_byte_count;
 
-    if (dec->state == 0) {
+    if (dec->state == AUDIO_DEC_STATE_HEADER_PENDING) {
         if (dec->strType != 4) {
             *first_destination = ((u8 *)&dec->hdr + dec->hdrCount);
             *size1 = 0x28 - dec->hdrCount;

src/audio/decoder/audio_dec_create.c

@@ -15,6 +15,9 @@ s32 audio_dec_create(struct AudioDec *dec,
                      s32              buffer_size,
 
                      s32 globals_address) {
+    enum {
+        AUDIO_DEC_STATE_INITIAL = 0
+    };
     s32 movie_handle;
     s32 three;
     s32 four;
@@ -24,7 +27,7 @@ s32 audio_dec_create(struct AudioDec *dec,
     dec->size = buffer_size;
     three = 3;
     dec->strType = three;
-    dec->state = 0;
+    dec->state = AUDIO_DEC_STATE_INITIAL;
     dec->hdrCount = 0;
     dec->put = 0;
     dec->count = 0;

src/audio/decoder/audio_dec_end_put.c

@@ -4,20 +4,24 @@
 void audio_dec_end_put(struct AudioDec *ad, s32 n) __asm__("FUN_0023ae28");
 
 void audio_dec_end_put(struct AudioDec *ad, s32 byte_count) {
+    enum {
+        AUDIO_DEC_STATE_HEADER_PENDING = 0,
+        AUDIO_DEC_STATE_HEADER_HANDLED = 1
+    };
     s32 k;
     s32 room;
 
-    if (ad->state == 0) {
+    if (ad->state == AUDIO_DEC_STATE_HEADER_PENDING) {
         if (ad->strType != 4) {
             room = 40 - ad->hdrCount;
             k = room < byte_count ? room : byte_count;
             ad->hdrCount += k;
             if (ad->hdrCount >= 40) {
-                ad->state = 1;
+                ad->state = AUDIO_DEC_STATE_HEADER_HANDLED;
             }
             byte_count -= k;
         } else {
-            ad->state = 1;
+            ad->state = AUDIO_DEC_STATE_HEADER_HANDLED;
         }
     }
     ad->size = ad->size / 1024 * 1024;

src/audio/decoder/audio_dec_reset.c

@@ -5,8 +5,11 @@ extern s32 snd_reset_movie_sound() __asm__("func_0012F0A8");
 void       audio_dec_reset(struct AudioDec *dec) __asm__("FUN_0023ad10");
 
 void audio_dec_reset(struct AudioDec *dec) {
+    enum {
+        AUDIO_DEC_STATE_RESET = 0
+    };
     snd_reset_movie_sound();
-    dec->state = 0;
+    dec->state = AUDIO_DEC_STATE_RESET;
     dec->hdrCount = 0;
     dec->put = 0;
     dec->count = 0;

src/audio/decoder/audio_dec_send.c

@@ -5,7 +5,10 @@ extern s32 send_adpcm() __asm__("FUN_0023afc0");
 void       audio_dec_send(struct AudioDec *dec) __asm__("FUN_0023aef0");
 
 void audio_dec_send(struct AudioDec *dec) {
-    if (dec->state != 0) {
+    enum {
+        AUDIO_DEC_SEND_DISABLED = 0
+    };
+    if (dec->state != AUDIO_DEC_SEND_DISABLED) {
         send_adpcm();
     }
 }

src/audio/decoder/audio_dec_start.c

@@ -5,6 +5,9 @@ extern s32 snd_start_movie_sound() __asm__("func_0012F108");
 void       audio_dec_start(struct AudioDec *dec) __asm__("FUN_0023acb8");
 
 void audio_dec_start(struct AudioDec *dec) {
+    enum {
+        AUDIO_DEC_STATE_STARTED = 2
+    };
     s32 buff_size;
     s32 channel_count;
     s32 four;
@@ -18,7 +21,7 @@ void audio_dec_start(struct AudioDec *dec) {
                           dec->iopZero,
                           dec->hdr.rate,
                           channel_count);
-    dec->state = 2;
+    dec->state = AUDIO_DEC_STATE_STARTED;
     /* Fakematch: GCC removes both stores, but the read-modify-write
        sequence gives hdr.ch retail's register. */
     dec->hdr.ch++;

src/audio/music/music_stop.c

@@ -8,6 +8,9 @@ extern s32 snd_stream_safe_check_cd_idle() __asm__("func_0012ED30");
 void       music_stop(void) __asm__("FUN_00215ee8");
 
 void music_stop(void) {
+    enum {
+        MUSIC_CROSSFADE_IDLE = 0
+    };
     s32 requested_track;
 
     if (music_stream_state.primary.handle == 0xFFFFFFFF) {
@@ -42,7 +45,7 @@ void music_stop(void) {
     music_stream_state.transition.state = 0;
     music_stream_state.transition.flags = 0;
     music_stream_state.transition.handle = 0;
-    music_stream_state.crossfade_state = 0;
+    music_stream_state.crossfade_state = MUSIC_CROSSFADE_IDLE;
     music_stream_state.requested_track = -1;
     music_stream_state.requested_transition_track = -1;
 }

src/audio/music/music_update.c

@@ -28,6 +28,11 @@ void music_update(void) {
         CROSSFADE_WAIT_TO_CONTINUE_PRIMARY = 4,
         CROSSFADE_WAIT_TO_RESET = 5
     };
+    enum {
+        CROSSFADE_IDLE = 0,
+        CD_READ_STATE_IDLE = 0,
+        CD_READ_STATE_PENDING_RETRY = 2
+    };
     s8  requested_track;
     s32 fade_volume;
     s32 handle;
@@ -55,7 +60,7 @@ void music_update(void) {
     }
     if (fast_dec_timer(&music_stream_state.retry_timer) != 0) {
         requested_track = music_stream_state.requested_track;
-        if (requested_track != -1 && music_stream_state.crossfade_state == 0) {
+        if (requested_track != -1 && music_stream_state.crossfade_state == CROSSFADE_IDLE) {
             if (music_stream_state.primary.track != requested_track) {
                 if (music_stream_state.requested_transition_track == -1 ||
                     music_transition(requested_track,
@@ -97,7 +102,7 @@ void music_update(void) {
                   music_stream_state.transition.crossfade_enabled == 0) &&
                  music_stream_state.transition.handle == 0) ||
                 (handle = music_stream_state.primary.handle) == 0) {
-                music_stream_state.crossfade_state = 3;
+                music_stream_state.crossfade_state = CROSSFADE_WAIT_TO_PRESEEK_PRIMARY;
                 music_stream_state.primary.state = 5;
             } else if (music_stream_state.primary.state != 9) {
                 /* The callback receives the old handle; mark its slot pending before submission. */
@@ -120,7 +125,7 @@ void music_update(void) {
                                     music_stream_state.primary.flags,
                                     music_stream_state.primary.volume);
                 music_stream_state.requested_track = -1;
-                music_stream_state.crossfade_state = 4;
+                music_stream_state.crossfade_state = CROSSFADE_WAIT_TO_CONTINUE_PRIMARY;
             }
             break;
         case CROSSFADE_WAIT_TO_CONTINUE_PRIMARY:
@@ -132,14 +137,14 @@ void music_update(void) {
                      music_stream_state.transition.handle == 0)) {
                     snd_continue_vag_stream(music_stream_state.primary.handle);
                     music_stream_state.primary.state = 8;
-                    music_stream_state.crossfade_state = 5;
+                    music_stream_state.crossfade_state = CROSSFADE_WAIT_TO_RESET;
                 }
             }
             break;
         case CROSSFADE_WAIT_TO_RESET:
             if (music_stream_state.transition.state != 4 ||
                 music_stream_state.transition.crossfade_enabled == 0) {
-                music_stream_state.crossfade_state = 0;
+                music_stream_state.crossfade_state = CROSSFADE_IDLE;
             }
             break;
         }
@@ -149,17 +154,17 @@ void music_update(void) {
     music_update_stream(&music_stream_state.secondary.handle);
     if (music_stream_state.break_requested != 0) {
         if (snd_stream_safe_cd_sync(1) == 0) {
-            music_stream_state.read_state = 0;
+            music_stream_state.read_state = CD_READ_STATE_IDLE;
             music_stream_state.break_requested = 0;
         }
     } else {
         pending_state = music_stream_state.read_state;
-        if (pending_state == 2) {
-            music_stream_state.read_state = 0;
+        if (pending_state == CD_READ_STATE_PENDING_RETRY) {
+            music_stream_state.read_state = CD_READ_STATE_IDLE;
             start_audio_stream_read(music_stream_state.read_dst,
                                     music_stream_state.read_sector,
                                     music_stream_state.read_sector_count);
-            if (music_stream_state.read_state == 0) {
+            if (music_stream_state.read_state == CD_READ_STATE_IDLE) {
                 music_stream_state.read_state = pending_state;
             }
         }

src/audio/music/music_update_stream.c

@@ -36,20 +36,26 @@ extern void set_sound_handle_id(int, long) __asm__("func_00216B68");
 void music_update_stream(MusicPlaying *p) __asm__("FUN_002160a8");
 
 void music_update_stream(MusicPlaying *music_stream) {
+    enum {
+        MUSIC_STREAM_STATE_INACTIVE = 0,
+        MUSIC_STREAM_STATE_WAITING_FOR_BUFFER = 2,
+        MUSIC_STREAM_STATE_STOP_REQUESTED = 5,
+        MUSIC_STREAM_STATE_STOPPING = 6
+    };
     int sound_handle;
 
     if (music_stream->state != 9 && music_stream->handle != 0 &&
         music_stream->handle != 0xFFFFFFFF) {
-        if (music_stream->state == 5) {
+        if (music_stream->state == MUSIC_STREAM_STATE_STOP_REQUESTED) {
             if (music_stream->handle != 0) {
                 snd_stop_sound(music_stream->handle);
-                music_stream->state = 6;
+                music_stream->state = MUSIC_STREAM_STATE_STOPPING;
             } else {
-                music_stream->state = 0;
+                music_stream->state = MUSIC_STREAM_STATE_INACTIVE;
             }
-        } else if (music_stream->state == 6) {
+        } else if (music_stream->state == MUSIC_STREAM_STATE_STOPPING) {
             if (music_stream->handle == 0) {
-                music_stream->state = 0;
+                music_stream->state = MUSIC_STREAM_STATE_INACTIVE;
             }
         }
         if (music_stream->handle == 0) {
@@ -73,7 +79,8 @@ void music_update_stream(MusicPlaying *music_stream) {
         if (music_stream->state == 1 || music_stream->state == 8 || music_stream->state == 9) {
             return;
         }
-        if (music_stream->state != 2 && music_stream->state != 3) {
+        if (music_stream->state != MUSIC_STREAM_STATE_WAITING_FOR_BUFFER &&
+            music_stream->state != 3) {
             sound_handle = music_stream->handle;
             music_stream->handle = 0xFFFFFFFF;
             snd_get_vag_stream_time_remaining_cb(
@@ -82,13 +89,14 @@ void music_update_stream(MusicPlaying *music_stream) {
                 sound_handle, set_sound_handle_id, (long)(unsigned int)music_stream);
             return;
         }
-        if (music_stream->handle != 0xFFFFFFFF && music_stream->state == 2) {
+        if (music_stream->handle != 0xFFFFFFFF &&
+            music_stream->state == MUSIC_STREAM_STATE_WAITING_FOR_BUFFER) {
             snd_is_vag_stream_buffered_cb(music_stream->handle,
                                           music_channel_ready_callback,
                                           (long)(unsigned int)music_stream);
         }
     } else if (music_stream->state == 7 || music_stream->handle == 0) {
-        music_stream->state = 0;
+        music_stream->state = MUSIC_STREAM_STATE_INACTIVE;
     }
 }
 

src/audio/sound/voice_start_callback.c

@@ -14,7 +14,7 @@ void voice_start_callback(int handle, long voice_record_address) {
         } else {
             voice->owner = 0;
             voice->owner_context = 0;
-            voice->state = 0;
+            voice->state = VOICE_SLOT_FREE;
         }
     }
 }

src/audio/sound/voice_update_callback.c

@@ -10,7 +10,7 @@ void voice_update_callback(int handle, long voice_state_address) {
         if (handle == 0) {
             voice->owner = 0;
             voice->owner_context = 0;
-            voice->state = 0;
+            voice->state = VOICE_SLOT_FREE;
         }
     }
 }

src/audio/streaming/advance_audio_stream_state.c

@@ -34,10 +34,13 @@ s32 advance_audio_stream_state(struct AudioStream *stream) {
         AUDIO_STREAM_START_SECOND_READ = 2,
         AUDIO_STREAM_WAIT_SECOND_READ = 3
     };
+    enum {
+        CD_READ_STATE_IDLE = 0
+    };
 
     switch (stream->unk44) {
     case AUDIO_STREAM_START_FIRST_READ:
-        if (stream->unk48 == 0 || music_stream_state.read_state != 0) {
+        if (stream->unk48 == 0 || music_stream_state.read_state != CD_READ_STATE_IDLE) {
             break;
         }
         if (disc_table.unk2C8[game_language].size == 0) {
@@ -52,12 +55,12 @@ s32 advance_audio_stream_state(struct AudioStream *stream) {
         }
         break;
     case AUDIO_STREAM_WAIT_FIRST_READ:
-        if (music_stream_state.read_state == 0) {
+        if (music_stream_state.read_state == CD_READ_STATE_IDLE) {
             stream->unk44 = 2;
         }
         break;
     case AUDIO_STREAM_START_SECOND_READ:
-        if (stream->unk4C == 0 || music_stream_state.read_state != 0) {
+        if (stream->unk4C == 0 || music_stream_state.read_state != CD_READ_STATE_IDLE) {
             break;
         }
         if (disc_table.unk2F8[game_language].size == 0) {
@@ -72,7 +75,7 @@ s32 advance_audio_stream_state(struct AudioStream *stream) {
         }
         break;
     case AUDIO_STREAM_WAIT_SECOND_READ:
-        if (music_stream_state.read_state == 0) {
+        if (music_stream_state.read_state == CD_READ_STATE_IDLE) {
             stream->unk44 = 4;
         }
         break;