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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program 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 (at your option) any later version.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#include "sherlock/sherlock.h"
#include "sherlock/sound.h"
#include "common/config-manager.h"
#include "audio/audiostream.h"
#include "common/algorithm.h"
#include "audio/mixer.h"
#include "audio/decoders/raw.h"
#include "audio/decoders/aiff.h"
#include "audio/decoders/wave.h"
namespace Sherlock {
static const int8 creativeADPCM_ScaleMap[64] = {
0, 1, 2, 3, 4, 5, 6, 7, 0, -1, -2, -3, -4, -5, -6, -7,
1, 3, 5, 7, 9, 11, 13, 15, -1, -3, -5, -7, -9, -11, -13, -15,
2, 6, 10, 14, 18, 22, 26, 30, -2, -6, -10, -14, -18, -22, -26, -30,
4, 12, 20, 28, 36, 44, 52, 60, -4, -12, -20, -28, -36, -44, -52, -60
};
static const uint8 creativeADPCM_AdjustMap[64] = {
0, 0, 0, 0, 0, 16, 16, 16,
0, 0, 0, 0, 0, 16, 16, 16,
240, 0, 0, 0, 0, 16, 16, 16,
240, 0, 0, 0, 0, 16, 16, 16,
240, 0, 0, 0, 0, 16, 16, 16,
240, 0, 0, 0, 0, 16, 16, 16,
240, 0, 0, 0, 0, 0, 0, 0,
240, 0, 0, 0, 0, 0, 0, 0
};
/*----------------------------------------------------------------*/
Sound::Sound(SherlockEngine *vm, Audio::Mixer *mixer) : _vm(vm), _mixer(mixer) {
_digitized = false;
_voices = 0;
_diskSoundPlaying = false;
_soundPlaying = false;
_speechPlaying = false;
_soundIsOn = &_soundPlaying;
_curPriority = 0;
_digiBuf = nullptr;
_soundVolume = 255;
_soundOn = true;
_speechOn = true;
if (IS_3DO) {
// 3DO: we don't need to prepare anything for sound
return;
}
_vm->_res->addToCache("MUSIC.LIB");
if (!_vm->_interactiveFl)
_vm->_res->addToCache("TITLE.SND");
else {
_vm->_res->addToCache("MUSIC.LIB");
if (IS_ROSE_TATTOO) {
_vm->_res->addToCache("SOUND.LIB");
} else {
_vm->_res->addToCache("SND.SND");
if (!_vm->isDemo()) {
_vm->_res->addToCache("TITLE.SND");
_vm->_res->addToCache("EPILOGUE.SND");
}
}
}
}
void Sound::syncSoundSettings() {
_digitized = !ConfMan.getBool("mute");
_voices = !ConfMan.getBool("mute") && !ConfMan.getBool("speech_mute") ? 1 : 0;
}
void Sound::loadSound(const Common::String &name, int priority) {
// No implementation required in ScummVM
//warning("loadSound");
}
byte Sound::decodeSample(byte sample, byte &reference, int16 &scale) {
int16 samp = sample + scale;
int16 ref = 0;
// clip bad ADPCM-4 sample
samp = CLIP<int16>(samp, 0, 63);
ref = reference + creativeADPCM_ScaleMap[samp];
if (ref > 0xff) {
reference = 0xff;
} else {
if (ref < 0x00) {
reference = 0;
} else {
reference = (uint8)(ref & 0xff);
}
}
scale = (scale + creativeADPCM_AdjustMap[samp]) & 0xff;
return reference;
}
bool Sound::playSound(const Common::String &name, WaitType waitType, int priority, const char *libraryFilename) {
Resources &res = *_vm->_res;
stopSound();
Common::String filename = name;
if (!filename.contains('.')) {
if (!IS_3DO) {
if (IS_SERRATED_SCALPEL) {
filename += ".SND";
} else {
filename += ".WAV";
}
} else {
// 3DO uses .aiff extension
filename += ".AIFF";
if (!filename.contains('/')) {
// if no directory was given, use the room sounds directory
filename = "rooms/sounds/" + filename;
}
}
}
Common::String libFilename(libraryFilename);
Common::SeekableReadStream *stream = libFilename.empty() ? res.load(filename) : res.load(filename, libFilename);
Audio::AudioStream *audioStream;
if (!IS_3DO) {
if (IS_SERRATED_SCALPEL) {
stream->skip(2);
int size = stream->readUint32BE();
int rate = stream->readUint16BE();
byte *data = (byte *)malloc(size);
byte *ptr = data;
stream->read(ptr, size);
delete stream;
assert(size > 2);
byte *decoded = (byte *)malloc((size - 1) * 2);
// Holmes uses Creative ADPCM 4-bit data
int counter = 0;
byte reference = ptr[0];
int16 scale = 0;
for(int i = 1; i < size; i++) {
decoded[counter++] = decodeSample((ptr[i]>>4)&0x0f, reference, scale);
decoded[counter++] = decodeSample((ptr[i]>>0)&0x0f, reference, scale);
}
free(data);
audioStream = Audio::makeRawStream(decoded, (size - 2) * 2, rate, Audio::FLAG_UNSIGNED, DisposeAfterUse::YES);
} else {
audioStream = Audio::makeWAVStream(stream, DisposeAfterUse::YES);
}
} else {
// 3DO: AIFF file
audioStream = Audio::makeAIFFStream(stream, DisposeAfterUse::YES);
}
Audio::SoundHandle effectsHandle = (IS_SERRATED_SCALPEL) ? _scalpelEffectsHandle : getFreeSoundHandle();
_mixer->playStream(Audio::Mixer::kPlainSoundType, &effectsHandle, audioStream, -1, Audio::Mixer::kMaxChannelVolume);
_soundPlaying = true;
_curPriority = priority;
if (waitType == WAIT_RETURN_IMMEDIATELY) {
_diskSoundPlaying = true;
return true;
}
bool retval = true;
do {
_vm->_events->pollEvents();
g_system->delayMillis(10);
if ((waitType == WAIT_KBD_OR_FINISH) && _vm->_events->kbHit()) {
retval = false;
break;
}
} while (!_vm->shouldQuit() && _mixer->isSoundHandleActive(effectsHandle));
_soundPlaying = false;
_mixer->stopHandle(effectsHandle);
return retval;
}
void Sound::playLoadedSound(int bufNum, WaitType waitType) {
if (IS_SERRATED_SCALPEL) {
if (_mixer->isSoundHandleActive(_scalpelEffectsHandle) && (_curPriority > _vm->_scene->_sounds[bufNum]._priority))
return;
stopSound();
}
playSound(_vm->_scene->_sounds[bufNum]._name, waitType, _vm->_scene->_sounds[bufNum]._priority);
}
void Sound::freeLoadedSounds() {
// As sounds are played with DisposeAfterUse::YES, stopping the sounds also
// frees them
stopSound();
}
void Sound::stopSound() {
if (IS_SERRATED_SCALPEL) {
_mixer->stopHandle(_scalpelEffectsHandle);
} else {
for (int i = 0; i < MAX_MIXER_CHANNELS; i++)
_mixer->stopHandle(_tattooEffectsHandle[i]);
}
}
void Sound::stopSndFuncPtr(int v1, int v2) {
// TODO
warning("TODO: Sound::stopSndFuncPtr");
}
void Sound::freeDigiSound() {
delete[] _digiBuf;
_digiBuf = nullptr;
_diskSoundPlaying = false;
_soundPlaying = false;
}
Audio::SoundHandle Sound::getFreeSoundHandle() {
for (int i = 0; i < MAX_MIXER_CHANNELS; i++) {
if (!_mixer->isSoundHandleActive(_tattooEffectsHandle[i]))
return _tattooEffectsHandle[i];
}
error("getFreeSoundHandle: No sound handle found");
}
void Sound::setVolume(int volume) {
warning("TODO: setVolume - %d", volume);
}
void Sound::playSpeech(const Common::String &name) {
Resources &res = *_vm->_res;
Scene &scene = *_vm->_scene;
stopSpeech();
// Figure out which speech library to use
Common::String libraryName = Common::String::format("speech%02d.lib", scene._currentScene);
if ((!scumm_strnicmp(name.c_str(), "SLVE12S", 7)) || (!scumm_strnicmp(name.c_str(), "WATS12X", 7))
|| (!scumm_strnicmp(name.c_str(), "HOLM12X", 7)))
libraryName = "SPEECH12.LIB";
// If the speech library file doesn't even exist, then we can't play anything
Common::File f;
if (!f.exists(libraryName))
return;
// Ensure the given library is in the cache
res.addToCache(libraryName);
Common::SeekableReadStream *stream = res.load(name, libraryName, true);
Audio::AudioStream *audioStream = !stream ? nullptr : Audio::makeRawStream(stream, 11025, Audio::FLAG_UNSIGNED);
if (audioStream) {
_mixer->playStream(Audio::Mixer::kSpeechSoundType, &_speechHandle, audioStream, -1, Audio::Mixer::kMaxChannelVolume);
_speechPlaying = true;
}
}
void Sound::stopSpeech() {
_mixer->stopHandle(_speechHandle);
_speechPlaying = false;
}
bool Sound::isSpeechPlaying() {
_speechPlaying = _mixer->isSoundHandleActive(_speechHandle);
return _speechPlaying;
}
} // End of namespace Sherlock
|