gamesnd.h

Go to the documentation of this file.

/*
 * Copyright (C) Volition, Inc. 1999.  All rights reserved.
 *
 * All source code herein is the property of Volition, Inc. You may not sell 
 * or otherwise commercially exploit the source or things you created based on the 
 * source.
 *
*/ 



#ifndef __GAMESND_H__
#define __GAMESND_H__

#include "mission/missionparse.h"
#include "sound/sound.h"


void gamesnd_parse_soundstbl(); // Loads in general game sounds from sounds.tbl
void gamesnd_close();   // close out gamesnd... only call from game_shutdown()!
void gamesnd_load_gameplay_sounds();
void gamesnd_unload_gameplay_sounds();
void gamesnd_load_interface_sounds();
void gamesnd_unload_interface_sounds();
void gamesnd_preload_common_sounds();
void gamesnd_load_gameplay_sounds();
void gamesnd_unload_gameplay_sounds();
void gamesnd_play_iface(int n);
void gamesnd_play_error_beep();
int gamesnd_get_by_name(const char* name);
int gamesnd_get_by_iface_name(const char* name);
int gamesnd_get_by_tbl_index(int index);
int gamesnd_get_by_iface_tbl_index(int index);

//flags for parse_sound and parse_sound_list
enum parse_sound_flags
{
        PARSE_SOUND_GENERAL_SOUND = 0,                          
        PARSE_SOUND_INTERFACE_SOUND = (1 << 0),         
        PARSE_SOUND_SCP_SOUND_LIST = (1 << 1),          
        PARSE_SOUND_MAX
};

//This should handle NO_SOUND just fine since it doesn't directly access lowlevel code
//Does all parsing for a sound
void parse_sound(const char* tag, int* idx_dest, const char* object_name, parse_sound_flags = PARSE_SOUND_GENERAL_SOUND);
void parse_sound_list(const char* tag, SCP_vector<int>& destination, const char* object_name, parse_sound_flags = PARSE_SOUND_GENERAL_SOUND);

// this is a callback, so it needs to be a real function
void common_play_highlight_sound();

extern SCP_vector<game_snd> Snds;
extern SCP_vector<game_snd> Snds_iface;

enum GameSoundsIndex {
        SND_MISSILE_TRACKING           = 0,  
        SND_MISSILE_LOCK               = 1,  
        SND_PRIMARY_CYCLE              = 2,  
        SND_SECONDARY_CYCLE            = 3,  
        SND_ENGINE                     = 4,  
        SND_CARGO_REVEAL               = 5,  
        SND_DEATH_ROLL                 = 6,  
        SND_SHIP_EXPLODE_1             = 7,  
        SND_TARGET_ACQUIRE             = 8,  
        SND_ENERGY_ADJUST              = 9,  
        SND_ENERGY_ADJUST_FAIL         = 10, 
        SND_ENERGY_TRANS               = 11, 
        SND_ENERGY_TRANS_FAIL          = 12, 
        SND_FULL_THROTTLE              = 13, 
        SND_ZERO_THROTTLE              = 14, 
        SND_THROTTLE_UP                = 15, 
        SND_THROTTLE_DOWN              = 16, 
        SND_DOCK_APPROACH              = 17, 
        SND_DOCK_ATTACH                = 18, 
        SND_DOCK_DETACH                = 19, 
        SND_DOCK_DEPART                = 20, 
        SND_ABURN_ENGAGE               = 21, 
        SND_ABURN_LOOP                 = 22, 
        SND_VAPORIZED                  = 23, 
        SND_ABURN_FAIL                 = 24, 
        SND_HEATLOCK_WARN              = 25, 
        SND_OUT_OF_MISSLES             = 26, 
        SND_OUT_OF_WEAPON_ENERGY       = 27, 
        SND_TARGET_FAIL                = 28, 
        SND_SQUADMSGING_ON             = 29, 
        SND_SQUADMSGING_OFF            = 30, 
        SND_DEBRIS                     = 31, 
        SND_SUBSYS_DIE_1               = 32, 
        SND_MISSILE_START_LOAD         = 33, 
        SND_MISSILE_LOAD               = 34, 
        SND_SHIP_REPAIR                = 35, 
        SND_PLAYER_HIT_LASER           = 36, 
        SND_PLAYER_HIT_MISSILE         = 37, 
        SND_CMEASURE_CYCLE             = 38, 
        SND_SHIELD_HIT                 = 39, 
        SND_SHIELD_HIT_YOU             = 40, 
        SND_GAME_MOUSE_CLICK           = 41, 
        SND_ASPECTLOCK_WARN            = 42, 
        SND_SHIELD_XFER_OK             = 43, 
        SND_ENGINE_WASH                = 44, 
        SND_WARP_IN                    = 45, 
        SND_WARP_OUT                   = 46, 
        SND_PLAYER_WARP_FAIL           = 47, 
        SND_STATIC                     = 48, 
        SND_SHIP_EXPLODE_2             = 49, 
        SND_PLAYER_WARP_OUT            = 50, 
        SND_SHIP_SHIP_HEAVY            = 51, 
        SND_SHIP_SHIP_LIGHT            = 52, 
        SND_SHIP_SHIP_SHIELD           = 53, 
        SND_THREAT_FLASH               = 54, 
        SND_PROXIMITY_WARNING          = 55, 
        SND_PROXIMITY_ASPECT_WARNING   = 56, 
        SND_DIRECTIVE_COMPLETE         = 57, 
        SND_SUBSYS_EXPLODE             = 58, 
        SND_CAPSHIP_EXPLODE            = 59, 
        SND_CAPSHIP_SUBSYS_EXPLODE     = 60, 
        SND_LARGESHIP_WARPOUT          = 61, 
        SND_ASTEROID_EXPLODE_LARGE     = 62, 
        SND_ASTEROID_EXPLODE_SMALL     = 63, 
        SND_CUE_VOICE                  = 64, 
        SND_END_VOICE                  = 65, 
        SND_CARGO_SCAN                 = 66, 
        SND_WEAPON_FLYBY               = 67, 
        SND_ASTEROID                   = 68, 
        SND_CAPITAL_WARP_IN            = 69, 
        SND_CAPITAL_WARP_OUT           = 70, 
        SND_ENGINE_LOOP_LARGE          = 71, 
        SND_SUBSPACE_LEFT_CHANNEL      = 72, 
        SND_SUBSPACE_RIGHT_CHANNEL     = 73, 
        SND_MISSILE_EVADED_POPUP       = 74, 
        SND_ENGINE_LOOP_HUGE           = 75, 
        //Weapons section
        SND_LIGHT_LASER_FIRE           = 76, 
        SND_LIGHT_LASER_IMPACT         = 77, 
        SND_HVY_LASER_FIRE             = 78, 
        SND_HVY_LASER_IMPACT           = 79, 
        SND_MASSDRV_FIRED              = 80, 
        SND_MASSDRV_IMPACT             = 81, 
        SND_FLAIL_FIRED                = 82, 
        SND_FLAIL_IMPACT               = 83, 
        SND_NEUTRON_FLUX_FIRED         = 84, 
        SND_NEUTRON_FLUX_IMPACT        = 85, 
        SND_DEBUG_LASER_FIRED          = 86, 
        SND_ROCKEYE_FIRED              = 87, 
        SND_MISSILE_IMPACT1            = 88, 
        SND_MAG_MISSILE_LAUNCH         = 89, 
        SND_FURY_MISSILE_LAUNCH        = 90, 
        SND_SHRIKE_MISSILE_LAUNCH      = 91, 
        SND_ANGEL_MISSILE_LAUNCH       = 92, 
        SND_CLUSTER_MISSILE_LAUNCH     = 93, 
        SND_CLUSTERB_MISSILE_LAUNCH    = 94, 
        SND_STILETTO_MISSILE_LAUNCH    = 95, 
        SND_TSUNAMI_MISSILE_LAUNCH     = 96, 
        SND_HARBINGER_MISSILE_LAUNCH   = 97, 
        SND_MEGAWOKKA_MISSILE_LAUNCH   = 98, 
        SND_CMEASURE1_LAUNCH           = 99, 
        SND_SHIVAN_LIGHT_LASER_FIRE    = 100,
        SND_SHOCKWAVE_EXPLODE          = 101,
        SND_SWARM_MISSILE_LAUNCH       = 102,
        SND_UNDEFINED_103              = 103,
        SND_UNDEFINED_104              = 104,
        SND_UNDEFINED_105              = 105,
        SND_UNDEFINED_106              = 106,
        SND_UNDEFINED_107              = 107,
        SND_UNDEFINED_108              = 108,
        SND_SHOCKWAVE_IMPACT           = 109,
        SND_UNDEFINED_110              = 110,
        SND_UNDEFINED_111              = 111,
        SND_UNDEFINED_112              = 112,
        SND_UNDEFINED_113              = 113,
        SND_UNDEFINED_114              = 114,
        SND_TARG_LASER_LOOP            = 115,
        SND_FLAK_FIRE                  = 116,
        SND_SHIELD_BREAKER             = 117,
        SND_EMP_MISSILE                = 118,
        SND_AUTOCANNON_LOOP            = 119,
        SND_AUTOCANNON_SHOT            = 120,
        SND_BEAM_LOOP                  = 121,
        SND_BEAM_UP                    = 122,
        SND_BEAM_DOWN                  = 123,
        SND_BEAM_SHOT                  = 124,
        SND_BEAM_VAPORIZE              = 125,
        //Ship Engine Sounds section
        SND_TERRAN_FIGHTER_ENG         = 126,
        SND_TERRAN_BOMBER_ENG          = 127,
        SND_TERRAN_CAPITAL_ENG         = 128,
        SND_SPECIESB_FIGHTER_ENG       = 129,
        SND_SPECIESB_BOMBER_ENG        = 130,
        SND_SPECIESB_CAPITAL_ENG       = 131,
        SND_SHIVAN_FIGHTER_ENG         = 132,
        SND_SHIVAN_BOMBER_ENG          = 133,
        SND_SHIVAN_CAPITAL_ENG         = 134,
        SND_REPAIR_SHIP_ENG            = 135,
        SND_UNDEFINED_136              = 136,
        SND_UNDEFINED_137              = 137,
        SND_UNDEFINED_138              = 138,
        // Electrical arc sound fx on the debris pieces
        SND_DEBRIS_ARC_01              = 139,
        SND_DEBRIS_ARC_02              = 140,
        SND_DEBRIS_ARC_03              = 141,
        SND_DEBRIS_ARC_04              = 142,
        SND_DEBRIS_ARC_05              = 143,
        // Beam Sounds
        SND_UNDEFINED_144              = 144,
        SND_UNDEFINED_145              = 145,
        SND_UNDEFINED_146              = 146,
        SND_UNDEFINED_147              = 147,
        SND_UNDEFINED_148              = 148,
        SND_UNDEFINED_149              = 149,
        SND_UNDEFINED_150              = 150,
        SND_UNDEFINED_151              = 151,
        SND_UNDEFINED_152              = 152,
        SND_UNDEFINED_153              = 153,
        SND_UNDEFINED_154              = 154,
        SND_UNDEFINED_155              = 155,
        SND_UNDEFINED_156              = 156,
        SND_UNDEFINED_157              = 157,
        SND_UNDEFINED_158              = 158,
        SND_UNDEFINED_159              = 159,
        SND_UNDEFINED_160              = 160,
        SND_UNDEFINED_161              = 161,

        SND_COPILOT                    = 162,
        SND_UNDEFINED_163              = 163,
        SND_UNDEFINED_164              = 164,
        SND_UNDEFINED_165              = 165,
        SND_UNDEFINED_166              = 166,
        SND_UNDEFINED_167              = 167,
        SND_UNDEFINED_168              = 168,
        SND_UNDEFINED_169              = 169,
        SND_UNDEFINED_170              = 170,
        SND_UNDEFINED_171              = 171,
        SND_UNDEFINED_172              = 172,
        SND_SUPERNOVA_1                = 173,
        SND_SUPERNOVA_2                = 174,
        SND_UNDEFINED_175              = 175,
        SND_UNDEFINED_176              = 176,
        SND_UNDEFINED_177              = 177,
        SND_UNDEFINED_178              = 178,
        SND_UNDEFINED_179              = 179,
        SND_LIGHTNING_1                = 180,
        SND_LIGHTNING_2                = 181,
        SND_UNDEFINED_182              = 182,
        SND_UNDEFINED_183              = 183,
        SND_UNDEFINED_184              = 184,
        SND_UNDEFINED_185              = 185,
        SND_UNDEFINED_186              = 186,
        SND_UNDEFINED_187              = 187,
        SND_UNDEFINED_188              = 188,
        SND_UNDEFINED_189              = 189,
        SND_UNDEFINED_190              = 190,
        SND_UNDEFINED_191              = 191,
        SND_UNDEFINED_192              = 192,
        SND_UNDEFINED_193              = 193,
        SND_UNDEFINED_194              = 194,
        SND_UNDEFINED_195              = 195,
        SND_UNDEFINED_196              = 196,
        SND_UNDEFINED_197              = 197,
        SND_UNDEFINED_198              = 198,
        SND_UNDEFINED_199              = 199,

        SND_BALLISTIC_START_LOAD       = 200,
        SND_BALLISTIC_LOAD             = 201,

        MIN_GAME_SOUNDS = 202
};

enum InterfaceSoundsIndex {
        SND_IFACE_MOUSE_CLICK       =0, 
        SND_ICON_PICKUP             =1, 
        SND_ICON_DROP_ON_WING       =2, 
        SND_ICON_DROP               =3, 
        SND_SCREEN_MODE_PRESSED     =4, 
        SND_SWITCH_SCREENS          =5, 
        SND_HELP_PRESSED            =6, 
        SND_COMMIT_PRESSED          =7, 
        SND_PREV_NEXT_PRESSED       =8, 
        SND_SCROLL                  =9, 
        SND_GENERAL_FAIL            =10,
        SND_SHIP_ICON_CHANGE        =11,
        SND_MAIN_HALL_AMBIENT       =12,
        SND_BTN_SLIDE               =13,
        SND_BRIEF_STAGE_CHG         =14,
        SND_BRIEF_STAGE_CHG_FAIL    =15,
        SND_BRIEF_ICON_SELECT       =16,
        SND_USER_OVER               =17,
        SND_USER_SELECT             =18,
        SND_RESET_PRESSED           =19,
        SND_BRIEF_TEXT_WIPE         =20,
        SND_VASUDAN_PA_1            =21,
        SND_WEAPON_ANIM_START       =22,
        SND_MAIN_HALL_DOOR_OPEN     =23,
        SND_MAIN_HALL_DOOR_CLOSE    =24,
        SND_GLOW_OPEN               =25,
        SND_VASUDAN_PA_2            =26,
        SND_AMBIENT_MENU            =27,
        SND_POPUP_APPEAR            =28,
        SND_POPUP_DISAPPEAR         =29,
        SND_VOICE_SLIDER_CLIP       =30,
        SND_VASUDAN_PA_3            =31,
        SND_MAIN_HALL_GET_PEPSI     =32,
        SND_MAIN_HALL_LIFT_UP       =33,
        SND_MAIN_HALL_WELD1         =34,
        SND_MAIN_HALL_WELD2         =35,
        SND_MAIN_HALL_WELD3         =36,
        SND_MAIN_HALL_WELD4         =37,
        SND_MAIN_HALL_INT1          =38,
        SND_MAIN_HALL_INT2          =39,
        SND_MAIN_HALL_INT3          =40,
        SND_ICON_HIGHLIGHT          =41,
        SND_BRIEFING_STATIC         =42,
        SND_MAIN_HALL2_CRANE1_1     =43,
        SND_MAIN_HALL2_CRANE1_2     =44,
        SND_MAIN_HALL2_CRANE2_1     =45,
        SND_MAIN_HALL2_CRANE2_2     =46,
        SND_MAIN_HALL2_CAR1         =47,
        SND_MAIN_HALL2_CAR2         =48,
        SND_MAIN_HALL2_INT1         =49,
        SND_MAIN_HALL2_INT2         =50,
        SND_MAIN_HALL2_INT3         =51,
        SND_INTERFACE_UNDEFINED_52  =52,
        SND_INTERFACE_UNDEFINED_53  =53,
        SND_INTERFACE_UNDEFINED_54  =54,
        SND_INTERFACE_UNDEFINED_55  =55,
        SND_INTERFACE_UNDEFINED_56  =56,
        SND_INTERFACE_UNDEFINED_57  =57,
        SND_INTERFACE_UNDEFINED_58  =58,
        SND_INTERFACE_UNDEFINED_59  =59,
        SND_INTERFACE_UNDEFINED_60  =60,
        SND_VASUDAN_BUP             =61,
        SND_INTERFACE_UNDEFINED_62  =62,
        SND_INTERFACE_UNDEFINED_63  =62,
        SND_INTERFACE_UNDEFINED_64  =62,

        MIN_INTERFACE_SOUNDS        =70 
};

#endif