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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
|
/* 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.
*
* $URL$
* $Id$
*
*/
#include "common/config-manager.h"
#include "sound/mididrv.h"
#include "sound/mixer.h"
#include "kyra/kyra.h"
#include "kyra/sound.h"
#include "kyra/resource.h"
#include "kyra/screen.h"
#include "kyra/text.h"
#include "kyra/timer.h"
#include "kyra/script.h"
#include "kyra/debugger.h"
namespace Kyra {
KyraEngine::KyraEngine(OSystem *system, const GameFlags &flags)
: Engine(system), _flags(flags) {
_res = 0;
_sound = 0;
_text = 0;
_staticres = 0;
_timer = 0;
_emc = 0;
_debugger = 0;
_gameSpeed = 60;
_tickLength = (uint8)(1000.0 / _gameSpeed);
_quitFlag = false;
_speechFile = "";
_trackMap = 0;
_trackMapSize = 0;
_lastMusicCommand = -1;
_curSfxFile = _curMusicTheme = -1;
_gameToLoad = -1;
memset(_flagsTable, 0, sizeof(_flagsTable));
// sets up all engine specific debug levels
Common::addSpecialDebugLevel(kDebugLevelScriptFuncs, "ScriptFuncs", "Script function debug level");
Common::addSpecialDebugLevel(kDebugLevelScript, "Script", "Script interpreter debug level");
Common::addSpecialDebugLevel(kDebugLevelSprites, "Sprites", "Sprite debug level");
Common::addSpecialDebugLevel(kDebugLevelScreen, "Screen", "Screen debug level");
Common::addSpecialDebugLevel(kDebugLevelSound, "Sound", "Sound debug level");
Common::addSpecialDebugLevel(kDebugLevelAnimator, "Animator", "Animator debug level");
Common::addSpecialDebugLevel(kDebugLevelMain, "Main", "Generic debug level");
Common::addSpecialDebugLevel(kDebugLevelGUI, "GUI", "GUI debug level");
Common::addSpecialDebugLevel(kDebugLevelSequence, "Sequence", "Sequence debug level");
Common::addSpecialDebugLevel(kDebugLevelMovie, "Movie", "Movie debug level");
Common::addSpecialDebugLevel(kDebugLevelTimer, "Timer", "Timer debug level");
system->getEventManager()->registerRandomSource(_rnd, "kyra");
}
::GUI::Debugger *KyraEngine::getDebugger() {
return _debugger;
}
int KyraEngine::init() {
registerDefaultSettings();
// Setup mixer
_mixer->setVolumeForSoundType(Audio::Mixer::kSFXSoundType, ConfMan.getInt("sfx_volume"));
_mixer->setVolumeForSoundType(Audio::Mixer::kMusicSoundType, ConfMan.getInt("music_volume"));
_mixer->setVolumeForSoundType(Audio::Mixer::kSpeechSoundType, ConfMan.getInt("speech_volume"));
if (!_flags.useDigSound) {
// We prefer AdLib over native MIDI, since our AdLib playback code is much
// more mature than our MIDI player. For example we are missing MT-32 support
// and it seems our MIDI playback code has threading issues (see bug #1506583
// "KYRA1: Crash on exceeded polyphony" for more information).
int midiDriver = MidiDriver::detectMusicDriver(MDT_MIDI | MDT_ADLIB/* | MDT_PREFER_MIDI*/);
if (_flags.platform == Common::kPlatformFMTowns || _flags.platform == Common::kPlatformPC98) {
// TODO: currently we don't support the PC98 sound data,
// but since it has the FM-Towns data files, we just use the
// FM-Towns driver
if (_flags.gameID == GI_KYRA1)
_sound = new SoundTowns(this, _mixer);
else
_sound = new SoundTowns_v2(this, _mixer);
} else if (midiDriver == MD_ADLIB) {
_sound = new SoundAdlibPC(this, _mixer);
assert(_sound);
} else {
bool native_mt32 = ((midiDriver == MD_MT32) || ConfMan.getBool("native_mt32"));
MidiDriver *driver = MidiDriver::createMidi(midiDriver);
assert(driver);
if (native_mt32)
driver->property(MidiDriver::PROP_CHANNEL_MASK, 0x03FE);
SoundMidiPC *soundMidiPc = new SoundMidiPC(this, _mixer, driver);
_sound = soundMidiPc;
assert(_sound);
soundMidiPc->hasNativeMT32(native_mt32);
// Unlike some SCUMM games, it's not that the MIDI sounds are
// missing. It's just that at least at the time of writing they
// are decidedly inferior to the Adlib ones.
if (ConfMan.getBool("multi_midi")) {
SoundAdlibPC *adlib = new SoundAdlibPC(this, _mixer);
assert(adlib);
_sound = new MixedSoundDriver(this, _mixer, soundMidiPc, adlib);
assert(_sound);
}
}
}
if (_sound)
_sound->updateVolumeSettings();
_res = new Resource(this);
assert(_res);
_res->reset();
_staticres = new StaticResource(this);
assert(_staticres);
if (!_staticres->init())
error("_staticres->init() failed");
if (!screen()->init())
error("screen()->init() failed");
_timer = new TimerManager(this, _system);
assert(_timer);
setupTimers();
_emc = new EMCInterpreter(this);
assert(_emc);
setupOpcodeTable();
readSettings();
if (ConfMan.hasKey("save_slot")) {
_gameToLoad = ConfMan.getInt("save_slot");
if (!saveFileLoadable(_gameToLoad))
_gameToLoad = -1;
}
_lang = 0;
Common::Language lang = Common::parseLanguage(ConfMan.get("language"));
if (_flags.gameID == GI_KYRA2 || _flags.gameID == GI_KYRA3) {
switch (lang) {
case Common::EN_ANY:
case Common::EN_USA:
case Common::EN_GRB:
_lang = 0;
break;
case Common::FR_FRA:
_lang = 1;
break;
case Common::DE_DEU:
_lang = 2;
break;
case Common::JA_JPN:
_lang = 3;
break;
default:
warning("unsupported language, switching back to English");
_lang = 0;
break;
}
}
return 0;
}
KyraEngine::~KyraEngine() {
for (Common::Array<const Opcode*>::iterator i = _opcodes.begin(); i != _opcodes.end(); ++i)
delete *i;
_opcodes.clear();
delete _res;
delete _staticres;
delete _sound;
delete _text;
delete _timer;
delete _emc;
delete _debugger;
}
void KyraEngine::quitGame() {
debugC(9, kDebugLevelMain, "KyraEngine::quitGame()");
_quitFlag = true;
// Nothing to do here
}
Common::Point KyraEngine::getMousePos() const {
Common::Point mouse = _eventMan->getMousePos();
if (_flags.useHiResOverlay) {
mouse.x >>= 1;
mouse.y >>= 1;
}
return mouse;
}
void KyraEngine::setMousePos(int x, int y) {
if (_flags.useHiResOverlay) {
x <<= 1;
y <<= 1;
}
_system->warpMouse(x, y);
}
int KyraEngine::setGameFlag(int flag) {
_flagsTable[flag >> 3] |= (1 << (flag & 7));
return 1;
}
int KyraEngine::queryGameFlag(int flag) const {
return ((_flagsTable[flag >> 3] >> (flag & 7)) & 1);
}
int KyraEngine::resetGameFlag(int flag) {
_flagsTable[flag >> 3] &= ~(1 << (flag & 7));
return 0;
}
void KyraEngine::delayUntil(uint32 timestamp, bool updateTimers, bool update, bool isMainLoop) {
while (_system->getMillis() < timestamp && !_quitFlag) {
if (timestamp - _system->getMillis() >= 10)
delay(10, update, isMainLoop);
}
}
void KyraEngine::delay(uint32 amount, bool update, bool isMainLoop) {
_system->delayMillis(amount);
}
void KyraEngine::delayWithTicks(int ticks) {
delay(ticks * _tickLength);
}
void KyraEngine::registerDefaultSettings() {
if (_flags.gameID != GI_KYRA3)
ConfMan.registerDefault("cdaudio", (_flags.platform == Common::kPlatformFMTowns || _flags.platform == Common::kPlatformPC98));
}
void KyraEngine::readSettings() {
_configWalkspeed = ConfMan.getInt("walkspeed");
_configMusic = 0;
if (!ConfMan.getBool("music_mute")) {
_configMusic = 1;
if (_flags.gameID != GI_KYRA3 && ConfMan.getBool("cdaudio") && (_flags.platform == Common::kPlatformFMTowns || _flags.platform == Common::kPlatformPC98))
_configMusic = 2;
}
_configSounds = ConfMan.getBool("sfx_mute") ? 0 : 1;
if (_sound) {
_sound->enableMusic(_configMusic);
_sound->enableSFX(_configSounds);
}
bool speechMute = ConfMan.getBool("speech_mute");
bool subtitles = ConfMan.getBool("subtitles");
if (!speechMute && subtitles)
_configVoice = 2; // Voice & Text
else if (!speechMute && !subtitles)
_configVoice = 1; // Voice only
else
_configVoice = 0; // Text only
setWalkspeed(_configWalkspeed);
}
void KyraEngine::writeSettings() {
bool speechMute, subtitles;
ConfMan.setInt("walkspeed", _configWalkspeed);
ConfMan.setBool("music_mute", _configMusic == 0);
if (_flags.gameID != GI_KYRA3)
ConfMan.setBool("cdaudio", _configMusic == 2);
ConfMan.setBool("sfx_mute", _configSounds == 0);
switch (_configVoice) {
case 0: // Text only
speechMute = true;
subtitles = true;
break;
case 1: // Voice only
speechMute = false;
subtitles = false;
break;
default: // Voice & Text
speechMute = false;
subtitles = true;
break;
}
if (_sound) {
if (!_configMusic)
_sound->beginFadeOut();
_sound->enableMusic(_configMusic);
_sound->enableSFX(_configSounds);
}
ConfMan.setBool("speech_mute", speechMute);
ConfMan.setBool("subtitles", subtitles);
ConfMan.flushToDisk();
}
bool KyraEngine::speechEnabled() {
return _flags.isTalkie && (_configVoice == 1 || _configVoice == 2);
}
bool KyraEngine::textEnabled() {
return !_flags.isTalkie || (_configVoice == 0 || _configVoice == 2);
}
inline int convertValueToMixer(int value) {
value -= 2;
return (value * Audio::Mixer::kMaxMixerVolume) / 95;
}
inline int convertValueFromMixer(int value) {
return (value * 95) / Audio::Mixer::kMaxMixerVolume + 2;
}
void KyraEngine::setVolume(kVolumeEntry vol, uint8 value) {
switch (vol) {
case kVolumeMusic:
ConfMan.setInt("music_volume", convertValueToMixer(value));
break;
case kVolumeSfx:
ConfMan.setInt("sfx_volume", convertValueToMixer(value));
break;
case kVolumeSpeech:
ConfMan.setInt("speech_volume", convertValueToMixer(value));
break;
}
// Resetup mixer
_mixer->setVolumeForSoundType(Audio::Mixer::kSFXSoundType, ConfMan.getInt("sfx_volume"));
_mixer->setVolumeForSoundType(Audio::Mixer::kMusicSoundType, ConfMan.getInt("music_volume"));
_mixer->setVolumeForSoundType(Audio::Mixer::kSpeechSoundType, ConfMan.getInt("speech_volume"));
if (_sound)
_sound->updateVolumeSettings();
}
uint8 KyraEngine::getVolume(kVolumeEntry vol) {
switch (vol) {
case kVolumeMusic:
return convertValueFromMixer(ConfMan.getInt("music_volume"));
break;
case kVolumeSfx:
return convertValueFromMixer(ConfMan.getInt("sfx_volume"));
break;
case kVolumeSpeech:
if (speechEnabled())
return convertValueFromMixer(ConfMan.getInt("speech_volume"));
else
return 2;
break;
}
return 2;
}
} // End of namespace Kyra
|