refactor(sound): Use symbolic constants for sound IDs

Author: cerwym

src/bflib_guibtns.c

@@ -28,6 +28,7 @@
 #include "bflib_string.h"
 #include "bflib_sound.h"
 #include "bflib_keybrd.h"
+#include "config_sounds.h"
 #include "post_inc.h"
 
 #ifdef __cplusplus
@@ -68,9 +69,9 @@ void do_sound_menu_click(void)
 void do_sound_button_click(struct GuiButton *gbtn)
 {
     if (gbtn->gbtype == LbBtnT_RadioBtn)
-        play_non_3d_sample(60);
+        play_non_3d_sample(snd_button_click);
     else
-        play_non_3d_sample(61);
+        play_non_3d_sample(snd_button_click2);
 }
 
 void setup_input_field(struct GuiButton *gbtn, const char * empty_text)

src/console_cmd.c

@@ -24,7 +24,7 @@
 #include "bflib_datetm.h"
 #include "bflib_sound.h"
 #include "bflib_sndlib.h"
-#include "config.h"
+#include "config_sounds.h"
 #include "config_keeperfx.h"
 #include "config_campaigns.h"
 #include "config_effects.h"
@@ -1837,7 +1837,7 @@ TbBool cmd_freeze_creature(PlayerNumber plyr_idx, char * args)
         targeted_message_add(MsgType_Player, plyr_idx, plyr_idx, GUI_MESSAGES_DELAY, "no thing selected or not creature");
         return false;
     }
-    thing_play_sample(thing, 50, NORMAL_PITCH, 0, 3, 0, 4, FULL_LOUDNESS);
+    thing_play_sample(thing, snd_spell_frozen, NORMAL_PITCH, 0, 3, 0, 4, FULL_LOUDNESS);
     // Not sure how to handle this yet, for now simply hardcode the intended spell kind with a number.
     apply_spell_effect_to_thing(thing, 3, 8, plyr_idx); // 3 was 'SplK_Freeze' in the enum.
     return true;
@@ -1855,7 +1855,7 @@ TbBool cmd_slow_creature(PlayerNumber plyr_idx, char * args)
         targeted_message_add(MsgType_Player, plyr_idx, plyr_idx, GUI_MESSAGES_DELAY, "no thing selected or not creature");
         return false;
     }
-    thing_play_sample(thing, 50, NORMAL_PITCH, 0, 3, 0, 4, FULL_LOUDNESS);
+    thing_play_sample(thing, snd_spell_frozen, NORMAL_PITCH, 0, 3, 0, 4, FULL_LOUDNESS);
     // Not sure how to handle this yet, for now simply hardcode the intended spell kind with a number.
     apply_spell_effect_to_thing(thing, 12, 8, plyr_idx); // 12 was 'SplK_Slow' in the enum.
     return true;

src/creature_control.c

@@ -264,7 +264,7 @@ TbBool playing_creature_sound(struct Thing *thing, long snd_idx)
     struct CreatureSound* crsound = get_creature_sound(thing, snd_idx);
     for (long i = 0; i < crsound->count; i++)
     {
-        if (S3DEmitterIsPlayingSample(thing->snd_emitter_id, crsound->index+i, 0))
+        if (S3DEmitterIsPlayingSample(thing->snd_emitter_id, crsound->index+i))
           return true;
     }
     return false;
@@ -280,9 +280,9 @@ void stop_creature_sound(struct Thing *thing, long snd_idx)
 
     for (int i = 0; i < crsound->count; i++)
     {
-        if (S3DEmitterIsPlayingSample(thing->snd_emitter_id, crsound->index+i, 0))
+        if (S3DEmitterIsPlayingSample(thing->snd_emitter_id, crsound->index+i))
         {
-            S3DDeleteSampleFromEmitter(thing->snd_emitter_id, crsound->index+i, 0);
+            S3DDeleteSampleFromEmitter(thing->snd_emitter_id, crsound->index+i);
         }
     }
 }

src/creature_instances.c

@@ -22,6 +22,7 @@
 #include "globals.h"
 #include "bflib_basics.h"
 #include "bflib_sound.h"
+#include "config_sounds.h"
 
 #include "bflib_math.h"
 #include "thing_list.h"
@@ -676,7 +677,7 @@ long instf_dig(struct Thing *creatng, int32_t *param)
         }
     }
     check_map_explored(creatng, stl_x, stl_y);
-    thing_play_sample(creatng, 72 + SOUND_RANDOM(3), NORMAL_PITCH, 0, 3, 0, 4, FULL_LOUDNESS);
+    thing_play_sample(creatng, snd_dig_impact + SOUND_RANDOM(snd_dig_impact_count), NORMAL_PITCH, 0, 3, 0, 4, FULL_LOUDNESS);
     return 1;
 }
 
@@ -702,7 +703,7 @@ long instf_destroy(struct Thing *creatng, int32_t *param)
             {
                 volume = FULL_LOUDNESS;
             }
-            thing_play_sample(creatng, 5 + SOUND_RANDOM(2), 200, 0, 3, 0, 2, volume);
+            thing_play_sample(creatng, snd_foot_spur + SOUND_RANDOM(2), 200, 0, 3, 0, 2, volume);
             return 0;
         }
         clear_dig_on_room_slabs(room, creatng->owner);
@@ -717,7 +718,7 @@ long instf_destroy(struct Thing *creatng, int32_t *param)
             event_create_event_or_update_nearby_existing_event(ccor_x, ccor_y, EvKind_RoomLost, room->owner, room->kind);
             claim_enemy_room(room, creatng);
         }
-        thing_play_sample(creatng, 76, NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
+        thing_play_sample(creatng, snd_spell_stars, NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
         create_effects_on_room_slabs(room, imp_spangle_effects[get_player_color_idx(creatng->owner)], 0, creatng->owner);
         return 0;
     }
@@ -728,7 +729,7 @@ long instf_destroy(struct Thing *creatng, int32_t *param)
         {
             volume = FULL_LOUDNESS;
         }
-        thing_play_sample(creatng, 128 + SOUND_RANDOM(3), 200, 0, 3, 0, 2, volume);
+        thing_play_sample(creatng, snd_strike_wall + SOUND_RANDOM(snd_strike_wall_count), 200, 0, 3, 0, 2, volume);
         return 0;
     }
     if (prev_owner != game.neutral_player_num) {
@@ -768,7 +769,7 @@ long instf_attack_room_slab(struct Thing *creatng, int32_t *param)
     {
         //TODO CONFIG damage made to room slabs is constant - doesn't look good
         slb->health -= 2;
-        thing_play_sample(creatng, 128 + SOUND_RANDOM(3), NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
+        thing_play_sample(creatng, snd_strike_wall + SOUND_RANDOM(snd_strike_wall_count), NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
         return 1;
     }
     if (room->owner != game.neutral_player_num)
@@ -787,7 +788,7 @@ long instf_attack_room_slab(struct Thing *creatng, int32_t *param)
         return 0;
     }
     create_effect(&creatng->mappos, TngEff_Explosion3, creatng->owner);
-    thing_play_sample(creatng, 47, NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
+    thing_play_sample(creatng, snd_explode, NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
     if (z > 0)
     {
         for (long k = 0; k < AROUND_TILES_COUNT; k++)
@@ -822,9 +823,9 @@ long instf_damage_wall(struct Thing *creatng, int32_t *param)
         place_slab_type_on_map(SlbT_EARTH, stl_x, stl_y, creatng->owner, 0);
         do_slab_efficiency_alteration(slb_x, slb_y);
         create_dirt_rubble_for_dug_slab(slb_x, slb_y);
-        thing_play_sample(creatng, 73, NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
+        thing_play_sample(creatng, snd_dig_dirt, NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
     }
-    thing_play_sample(creatng, 63+SOUND_RANDOM(6), NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
+    thing_play_sample(creatng, snd_dig_spell + SOUND_RANDOM(snd_dig_spell_count), NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
     return 1;
 }
 
@@ -1015,7 +1016,7 @@ long instf_pretty_path(struct Thing *creatng, int32_t *param)
     MapSlabCoord slb_x = subtile_slab(creatng->mappos.x.stl.num);
     MapSlabCoord slb_y = subtile_slab(creatng->mappos.y.stl.num);
     create_effect(&creatng->mappos, imp_spangle_effects[get_player_color_idx(creatng->owner)], creatng->owner);
-    thing_play_sample(creatng, 76, NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
+    thing_play_sample(creatng, snd_spell_stars, NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
     place_slab_type_on_map(SlbT_CLAIMED, slab_subtile_center(slb_x), slab_subtile_center(slb_y), creatng->owner, 1);
     do_unprettying(creatng->owner, slb_x, slb_y);
     do_slab_efficiency_alteration(slb_x, slb_y);
@@ -1039,7 +1040,7 @@ long instf_reinforce(struct Thing *creatng, int32_t *param)
     if (cctrl->digger.consecutive_reinforcements <= 25)
     {
         cctrl->digger.consecutive_reinforcements++;
-        if (!S3DEmitterIsPlayingSample(creatng->snd_emitter_id, 63, 0))
+        if (!S3DEmitterIsPlayingSample(creatng->snd_emitter_id, 63))
         {
             struct PlayerInfo* player;
             player = get_my_player();
@@ -1048,7 +1049,7 @@ long instf_reinforce(struct Thing *creatng, int32_t *param)
             {
                 volume = FULL_LOUDNESS;
             }
-            thing_play_sample(creatng, 1005 + SOUND_RANDOM(7), NORMAL_PITCH, 0, 3, 0, 2, volume);
+            thing_play_sample(creatng, snd_reinforce_hit + SOUND_RANDOM(snd_reinforce_hit_count), NORMAL_PITCH, 0, 3, 0, 2, volume);
         }
         return 0;
     }
@@ -1066,7 +1067,7 @@ long instf_reinforce(struct Thing *creatng, int32_t *param)
             create_effect(&pos, imp_spangle_effects[get_player_color_idx(creatng->owner)], creatng->owner);
         }
     }
-    thing_play_sample(creatng, 41, NORMAL_PITCH, 0, 3, 0, 3, FULL_LOUDNESS);
+    thing_play_sample(creatng, snd_spell_wall, NORMAL_PITCH, 0, 3, 0, 3, FULL_LOUDNESS);
     return 0;
 }
 
@@ -1087,7 +1088,7 @@ long instf_tunnel(struct Thing *creatng, int32_t *param)
     if (slabmap_block_invalid(slb)) {
         return 0;
     }
-    thing_play_sample(creatng, 69+SOUND_RANDOM(3), NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
+    thing_play_sample(creatng, snd_tunnel_dig + SOUND_RANDOM(snd_tunnel_dig_count), NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
         if (slb->health > 1) {
         slb->health--;
         } else {

src/creature_states.c

@@ -62,6 +62,7 @@
 #include "thing_traps.h"
 #include "magic_powers.h"
 #include "sounds.h"
+#include "config_sounds.h"
 #include "game_legacy.h"
 #include "sprites.h"
 #include "lua_cfg_funcs.h"
@@ -2812,7 +2813,7 @@ short creature_present_to_dungeon_heart(struct Thing *creatng)
 {
     TRACE_THING(creatng);
     create_effect(&creatng->mappos, imp_spangle_effects[get_player_color_idx(creatng->owner)], creatng->owner);
-    thing_play_sample(creatng, 76, NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
+    thing_play_sample(creatng, snd_spell_stars, NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
     if ( !external_set_thing_state(creatng, CrSt_CreatureDoingNothing) )
       set_start_state(creatng);
     return 1;
@@ -3164,7 +3165,7 @@ short creature_take_salary(struct Thing *creatng)
     {
         anger_apply_anger_to_creature_all_types(creatng, crconf->annoy_got_wage);
     }
-    thing_play_sample(efftng, 32, NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
+    thing_play_sample(efftng, snd_gold_pickup, NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
     dungeon->lvstats.salary_cost += salary;
     return 1;
 }

src/creature_states_gardn.c

@@ -22,7 +22,7 @@
 
 #include "bflib_math.h"
 #include "bflib_planar.h"
-#include "creature_states.h"
+#include "config_sounds.h"
 #include "creature_instances.h"
 #include "thing_list.h"
 #include "creature_control.h"
@@ -75,7 +75,7 @@ TbBool hunger_is_creature_hungry(const struct Thing *creatng)
 
 void person_eat_food(struct Thing *creatng, struct Thing *foodtng, struct Room *room)
 {
-    thing_play_sample(creatng, 112+SOUND_RANDOM(3), NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
+    thing_play_sample(creatng, snd_chicken_cluck + SOUND_RANDOM(snd_chicken_cluck_count), NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
     internal_set_thing_state(creatng, CrSt_CreatureEat);
     set_creature_instance(creatng, CrInst_EAT, 0, 0);
     creatng->continue_state = CrSt_CreatureToGarden;

src/creature_states_mood.c

@@ -126,7 +126,7 @@ short creature_piss(struct Thing *thing)
     struct CreatureControl* cctrl = creature_control_get_from_thing(thing);
     struct CreatureSound* crsound = get_creature_sound(thing, CrSnd_Piss);
     unsigned short sound_idx = crsound->index + THING_RANDOM(thing, crsound->count);
-    if (!S3DEmitterIsPlayingSample(thing->snd_emitter_id, sound_idx, 0)) {
+    if (!S3DEmitterIsPlayingSample(thing->snd_emitter_id, sound_idx)) {
         thing_play_sample(thing, sound_idx, NORMAL_PITCH, 0, 3, 1, 6, FULL_LOUDNESS);
     }
     long i = cctrl->countdown;

src/creature_states_scavn.c

@@ -22,8 +22,7 @@
 
 #include "bflib_math.h"
 #include "bflib_sound.h"
-
-#include "creature_states.h"
+#include "config_sounds.h"
 #include "thing_list.h"
 #include "creature_control.h"
 #include "creature_states_prisn.h"
@@ -162,8 +161,8 @@ short creature_being_scavenged(struct Thing *creatng)
         return 0;
     }
     creatng->continue_state = CrSt_CreatureBeingScavenged;
-    if (!S3DEmitterIsPlayingSample(creatng->snd_emitter_id, 156, 0))
-        thing_play_sample(creatng, 156, NORMAL_PITCH, 0, 3, 1, 2, FULL_LOUDNESS);
+    if (!S3DEmitterIsPlayingSample(creatng->snd_emitter_id, snd_scavenge))
+        thing_play_sample(creatng, snd_scavenge, NORMAL_PITCH, 0, 3, 1, 2, FULL_LOUDNESS);
     SYNCDBG(19,"Finished");
     return 1;
 }

src/creature_states_spdig.c

@@ -21,6 +21,7 @@
 #include "globals.h"
 
 #include "bflib_sound.h"
+#include "config_sounds.h"
 #include "bflib_math.h"
 #include "bflib_planar.h"
 #include "creature_states.h"
@@ -1247,7 +1248,7 @@ short imp_drops_gold(struct Thing *spdigtng)
     }
     if ( (gold_added > 0) || (gold_created) )
     {
-        thing_play_sample(spdigtng, SOUND_RANDOM(3) + 32, NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
+        thing_play_sample(spdigtng, snd_gold_pickup + SOUND_RANDOM(snd_gold_pickup_count), NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
         if (game.conf.rules[spdigtng->owner].workers.digger_work_experience != 0)
         {
             struct CreatureControl* cctrl = creature_control_get_from_thing(spdigtng);
@@ -1259,7 +1260,7 @@ short imp_drops_gold(struct Thing *spdigtng)
     {
         if (is_thing_directly_controlled_by_player(spdigtng, my_player_number))
         {
-            play_non_3d_sample(119);
+            play_non_3d_sample(snd_refusal);
             internal_set_thing_state(spdigtng, state);
             return 1;
         }
@@ -1390,7 +1391,7 @@ short imp_picks_up_gold_pile(struct Thing *spdigtng)
         spdigtng->creature.gold_carried += gold_taken;
         if (gold_taken > 0)
         {
-            thing_play_sample(spdigtng, 32, NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
+            thing_play_sample(spdigtng, snd_gold_pickup, NORMAL_PITCH, 0, 3, 0, 2, FULL_LOUDNESS);
         }
     }
     internal_set_thing_state(spdigtng, state);

src/dungeon_stats.c

@@ -35,6 +35,7 @@
 #include "config_powerhands.h"
 #include "config_spritecolors.h"
 #include "config_players.h"
+#include "config_sounds.h"
 #include "room_library.h"
 #include "game_legacy.h"
 #include "post_inc.h"