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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
/*
* The Mana World
* Copyright 2004 The Mana World Development Team
*
* This file is part of The Mana World.
*
* The Mana World is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* any later version.
*
* The Mana World is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with The Mana World; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* $Id$
*/
#ifndef _TMW_SOUND_H
#define _TMW_SOUND_H
#include <guichan.hpp>
#include <SDL.h>
#include <SDL_mixer.h>
#include <map>
#include "resources/resourcemanager.h"
typedef short SOUND_ID;
/** Sound engine
*
* \ingroup CORE
*/
class Sound {
public:
/**
* Constructor.
*/
Sound();
/**
* Destructor.
*/
~Sound();
/**
* Installs the sound engine.
*/
void init();
/**
* Logs various info about sound device.
*/
void info();
/**
* Removes all sound functionalities.
*/
void close();
/**
* Starts background music.
*
* \param in Full path to file
* \param loop The number of times the song is played (-1 = infinite)
*/
void playMusic(const char *path, int loop = -1);
/**
* Stops currently running background music track.
*/
void stopMusic();
/**
* Fades in background music.
*
* \param in Full path to file
* \param loop The number of times the song is played (-1 = infinite)
* \param ms Duration of fade-in effect (ms)
*/
void fadeInMusic(const char *path, int loop = -1, int ms = 2000);
/**
* Fades out currently running background music track.
*
* \param ms Duration of fade-out effect (ms)
*/
void fadeOutMusic(int ms);
/**
* Sets music volume.
*
* \param volume Volume value
*/
void setMusicVolume(int volume);
/**
* Sets sfx volume.
*
* \param volume Volume value
*/
void setSfxVolume(int volume);
/**
* Preloads a sound-item into buffer.
*
* \param path Full path to file
*/
SOUND_ID loadSfx(const char *path);
/**
* Plays an item in soundpool.
*
* \param id Id returned to the item in the soundpool
*/
void playSfx(SOUND_ID id);
/**
* Plays an item.
*
* \param path Full path to file
*/
void playSfx(const char *path);
/**
* Wipe all items off the cache
*/
void clearCache();
private:
bool installed;
int musicVolume, sfxVolume;
Mix_Music *music;
/** list of preloaded sound data / items */
std::map<int, SoundEffect*> soundPool;
SOUND_ID items;
};
#endif
|
