PrinceProtect/Audio.h at master · FrostTree-Games/PrinceProtect · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/*
 * Audio.h
 * --------
 * This header file contains definitions for methods that get in audio-related
 * functionality. This consists of:
 *  1) Background music management
 *  2) Sound effect push functionality
 */

#ifndef AUDIO_H
#define AUDIO_H

// enum used to specify specific sound for passing into Audio
typedef enum
{
	BGM_NONE = 0,
	BGM_ANGSTY,
	BGM_1,
	BGM_2,
	BGM_3,
	BGM_TITLE,
	BGM_KEYCONFIG
} BGMType;

typedef enum
{
	SFX_NONE = 0,
	SFX_EXPLOSION,
	SFX_CRASH,
	SFX_PLAYER_HURT,
	SFX_ICE_TINK,
	SFX_LASER_1,
	SFX_LASER_2,
	SFX_MENU,
	SFX_MUD,
	SFX_MUD2,
	SFX_SWORD,
	SFX_TELEPORT,
	SFX_PRINCESS_YELL,
	SFX_DECOY_YELL,
	SFX_PLAYER_DEATH,
	SFX_WIPE_OPEN,
	SFX_WIPE_CLOSE,
	SFX_ENEMY_DIE,
	SFX_ENEMY_HURT,
	SFX_GET_HAMMER,
	SFX_READY_JINGLE,
	SFX_LOSE_PRINCESS,
	SFX_LIFEUP
} SFXType;
/* setupAudio()
 * Purpose: Loads the necessary OGG BGM music and WAV SFX; do this on startup
 * Returns: 0 on success, 1 on failure
 */
int setupAudio();

/* clearAudio()
 * Purpose: Frees SFX and BGM from memory; do this when closing the game
 * Returns: n/a
 */
void clearAudio();

/* playSFX()
 * Purpose: Plays a sound effect depending on its SFXType
 * Returns: n/a
 */
void playSFX(SFXType fx);

/* stopAllSFX()
 * Purpose: Halts any sound effects currently playing
 * Returns: n/a
 */
void stopAllSFX();

/* playBGM()
 * Purpose: Stops any BGM playing and starts a new one depending on the specified BGMType
 * Returns: n/a
 */
void playBGM(BGMType bg);

/* stopBGM()
 * Purpose: Stops any BGM playing
 */
void stopBGM();

/* fadeBGM()
 * Purpose: Stops any BGM playing with a sexy quick fadeout
 */
void fadeBGM();

/* toggleBGM()
 * Purpose: Can disable new BGM from playing.
 * Returns: n/a
 */
void toggleBGM(int aud);

/* toggleSFX()
 * Purpose: Turns SFX on/off
 * Returns: n/a
 */
void toggleSFX(int aud);

#endif