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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
|
/* 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 "common/md5.h"
#include "common/file.h"
#include "common/memstream.h"
#include "common/savefile.h"
#include "common/config-manager.h"
#include "common/debug-channels.h"
#include "common/random.h"
#include "common/textconsole.h"
#include "engines/util.h"
#include "base/plugins.h"
#include "base/version.h"
#include "graphics/cursorman.h"
#include "audio/mididrv.h"
#include "audio/mixer.h"
#include "agi/agi.h"
#include "agi/font.h"
#include "agi/graphics.h"
#include "agi/inv.h"
#include "agi/sprite.h"
#include "agi/text.h"
#include "agi/keyboard.h"
#include "agi/menu.h"
#include "agi/systemui.h"
#include "agi/words.h"
#include "gui/predictivedialog.h"
namespace Agi {
void AgiEngine::allowSynthetic(bool allow) {
_allowSynthetic = allow;
}
void AgiEngine::pollTimer() {
_lastTick += 50;
while (_system->getMillis() < _lastTick) {
processEvents();
_console->onFrame();
_system->delayMillis(10);
_system->updateScreen();
}
_lastTick = _system->getMillis();
}
void AgiEngine::pause(uint32 msec) {
uint32 endTime = _system->getMillis() + msec;
_gfx->setMouseCursor(true); // Busy mouse cursor
while (_system->getMillis() < endTime) {
processEvents();
_system->updateScreen();
_system->delayMillis(10);
}
_gfx->setMouseCursor(); // regular mouse cursor
}
int AgiEngine::agiInit() {
int ec, i;
debug(2, "initializing");
debug(2, "game version = 0x%x", getVersion());
// initialize with adj.ego.move.to.x.y(0, 0) so to speak
_game.adjMouseX = _game.adjMouseY = 0;
// reset all flags to false and all variables to 0
for (i = 0; i < MAX_FLAGS; i++)
_game.flags[i] = 0;
for (i = 0; i < MAX_VARS; i++)
_game.vars[i] = 0;
// clear all resources and events
for (i = 0; i < MAX_DIRECTORY_ENTRIES; i++) {
memset(&_game.views[i], 0, sizeof(struct AgiView));
memset(&_game.pictures[i], 0, sizeof(struct AgiPicture));
memset(&_game.logics[i], 0, sizeof(struct AgiLogic));
memset(&_game.sounds[i], 0, sizeof(class AgiSound *)); // _game.sounds contains pointers now
memset(&_game.dirView[i], 0, sizeof(struct AgiDir));
memset(&_game.dirPic[i], 0, sizeof(struct AgiDir));
memset(&_game.dirLogic[i], 0, sizeof(struct AgiDir));
memset(&_game.dirSound[i], 0, sizeof(struct AgiDir));
}
// clear view table
for (i = 0; i < SCREENOBJECTS_MAX; i++)
memset(&_game.screenObjTable[i], 0, sizeof(struct ScreenObjEntry));
memset(&_game.addToPicView, 0, sizeof(struct ScreenObjEntry));
_words->clearEgoWords();
if (!_menu)
_menu = new GfxMenu(this, _gfx, _picture, _text);
_gfx->initPriorityTable();
// Clear the string buffer on startup, but not when the game restarts, as
// some scripts expect that the game strings remain unaffected after a
// restart. An example is script 98 in SQ2, which is not invoked on restart
// to ask Ego's name again. The name is supposed to be maintained in string 1.
// Fixes bug #3292784.
if (!_restartGame) {
for (i = 0; i < MAX_STRINGS; i++)
_game.strings[i][0] = 0;
}
// setup emulation
switch (getVersion() >> 12) {
case 2:
debug("Emulating Sierra AGI v%x.%03x",
(int)(getVersion() >> 12) & 0xF,
(int)(getVersion()) & 0xFFF);
break;
case 3:
debug("Emulating Sierra AGI v%x.002.%03x",
(int)(getVersion() >> 12) & 0xF,
(int)(getVersion()) & 0xFFF);
break;
}
if (getPlatform() == Common::kPlatformAmiga)
_game.gameFlags |= ID_AMIGA;
if (getFeatures() & GF_AGDS)
_game.gameFlags |= ID_AGDS;
if (_game.gameFlags & ID_AMIGA)
debug(1, "Amiga padded game detected.");
if (_game.gameFlags & ID_AGDS)
debug(1, "AGDS mode enabled.");
ec = _loader->init(); // load vol files, etc
if (ec == errOK)
ec = _loader->loadObjects(OBJECTS);
// note: demogs has no words.tok
if (ec == errOK)
ec = _loader->loadWords(WORDS);
// Load logic 0 into memory
if (ec == errOK)
ec = _loader->loadResource(RESOURCETYPE_LOGIC, 0);
#ifdef __DS__
// Normally, the engine loads the predictive text dictionary when the predictive dialog
// is shown. On the DS version, the word completion feature needs the dictionary too.
// FIXME - loadDict() no long exists in AGI as this has been moved to within the
// GUI Predictive Dialog, but DS Word Completion is probably broken due to this...
#endif
_egoHoldKey = false;
_game.mouseFence.setWidth(0); // Reset
return ec;
}
/*
* Public functions
*/
void AgiEngine::agiUnloadResources() {
int i;
// Make sure logic 0 is always loaded
for (i = 1; i < MAX_DIRECTORY_ENTRIES; i++) {
_loader->unloadResource(RESOURCETYPE_LOGIC, i);
}
for (i = 0; i < MAX_DIRECTORY_ENTRIES; i++) {
_loader->unloadResource(RESOURCETYPE_VIEW, i);
_loader->unloadResource(RESOURCETYPE_PICTURE, i);
_loader->unloadResource(RESOURCETYPE_SOUND, i);
}
}
int AgiEngine::agiDeinit() {
int ec;
_words->clearEgoWords(); // remove all words from memory
agiUnloadResources(); // unload resources in memory
_loader->unloadResource(RESOURCETYPE_LOGIC, 0);
ec = _loader->deinit();
unloadObjects();
_words->unloadDictionary();
clearImageStack();
return ec;
}
int AgiEngine::agiLoadResource(int16 resourceType, int16 resourceNr) {
int i;
i = _loader->loadResource(resourceType, resourceNr);
// WORKAROUND: Patches broken picture 147 in a corrupted Amiga version of Gold Rush! (v2.05 1989-03-09).
// The picture can be seen in room 147 after dropping through the outhouse's hole in room 146.
if (i == errOK && getGameID() == GID_GOLDRUSH && resourceType == RESOURCETYPE_PICTURE && resourceNr == 147 && _game.dirPic[resourceNr].len == 1982) {
uint8 *pic = _game.pictures[resourceNr].rdata;
Common::MemoryReadStream picStream(pic, _game.dirPic[resourceNr].len);
Common::String md5str = Common::computeStreamMD5AsString(picStream, _game.dirPic[resourceNr].len);
if (md5str == "1c685eb048656cedcee4eb6eca2cecea") {
pic[0x042] = 0x4B; // 0x49 -> 0x4B
pic[0x043] = 0x66; // 0x26 -> 0x66
pic[0x204] = 0x68; // 0x28 -> 0x68
pic[0x6C0] = 0x2D; // 0x25 -> 0x2D
pic[0x6F0] = 0xF0; // 0x70 -> 0xF0
pic[0x734] = 0x6F; // 0x2F -> 0x6F
}
}
return i;
}
int AgiEngine::agiUnloadResource(int16 resourceType, int16 resourceNr) {
return _loader->unloadResource(resourceType, resourceNr);
}
struct GameSettings {
const char *gameid;
const char *description;
byte id;
uint32 features;
const char *detectname;
};
AgiBase::AgiBase(OSystem *syst, const AGIGameDescription *gameDesc) : Engine(syst), _gameDescription(gameDesc) {
_noSaveLoadAllowed = false;
_rnd = new Common::RandomSource("agi");
_sound = 0;
initFeatures();
initVersion();
}
AgiBase::~AgiBase() {
delete _rnd;
delete _sound;
}
void AgiBase::initRenderMode() {
Common::Platform platform = Common::parsePlatform(ConfMan.get("platform"));
Common::RenderMode configRenderMode = Common::parseRenderMode(ConfMan.get("render_mode").c_str());
// Default to EGA PC rendering
_renderMode = Common::kRenderEGA;
switch (platform) {
case Common::kPlatformDOS:
switch (configRenderMode) {
case Common::kRenderCGA:
_renderMode = Common::kRenderCGA;
break;
// Hercules is not supported atm
//case Common::kRenderHercA:
//case Common::kRenderHercG:
// _renderMode = Common::kRenderHercG;
// break;
default:
break;
}
break;
case Common::kPlatformAmiga:
_renderMode = Common::kRenderAmiga;
break;
case Common::kPlatformApple2GS:
_renderMode = Common::kRenderApple2GS;
break;
case Common::kPlatformAtariST:
_renderMode = Common::kRenderAtariST;
break;
default:
break;
}
// If render mode is explicitly set, force rendermode
switch (configRenderMode) {
case Common::kRenderAmiga:
_renderMode = Common::kRenderAmiga;
break;
case Common::kRenderApple2GS:
_renderMode = Common::kRenderApple2GS;
break;
case Common::kRenderAtariST:
_renderMode = Common::kRenderAtariST;
break;
default:
break;
}
if (getFeatures() & (GF_AGI256 | GF_AGI256_2)) {
// If current game is AGI256, switch (force) to VGA render mode
_renderMode = Common::kRenderVGA;
}
}
const byte *AgiBase::getFontData() {
return _font->getFontData();
}
AgiEngine::AgiEngine(OSystem *syst, const AGIGameDescription *gameDesc) : AgiBase(syst, gameDesc) {
// Setup mixer
syncSoundSettings();
DebugMan.addDebugChannel(kDebugLevelMain, "Main", "Generic debug level");
DebugMan.addDebugChannel(kDebugLevelResources, "Resources", "Resources debugging");
DebugMan.addDebugChannel(kDebugLevelSprites, "Sprites", "Sprites debugging");
DebugMan.addDebugChannel(kDebugLevelInventory, "Inventory", "Inventory debugging");
DebugMan.addDebugChannel(kDebugLevelInput, "Input", "Input events debugging");
DebugMan.addDebugChannel(kDebugLevelMenu, "Menu", "Menu debugging");
DebugMan.addDebugChannel(kDebugLevelScripts, "Scripts", "Scripts debugging");
DebugMan.addDebugChannel(kDebugLevelSound, "Sound", "Sound debugging");
DebugMan.addDebugChannel(kDebugLevelText, "Text", "Text output debugging");
DebugMan.addDebugChannel(kDebugLevelSavegame, "Savegame", "Saving & restoring game debugging");
memset(&_game, 0, sizeof(struct AgiGame));
memset(&_debug, 0, sizeof(struct AgiDebug));
memset(&_mouse, 0, sizeof(struct Mouse));
_game.mouseEnabled = true;
_game.mouseHidden = false;
// don't check for Amiga, Amiga doesn't allow disabling mouse support. It's mandatory.
if (!ConfMan.getBool("mousesupport")) {
// we effectively disable the mouse for games, that explicitly do not want mouse support to be enabled
_game.mouseEnabled = false;
_game.mouseHidden = true;
}
_game._vm = this;
_game.gfxMode = true;
_game.clockEnabled = false;
_game.state = STATE_INIT;
_keyQueueStart = 0;
_keyQueueEnd = 0;
_allowSynthetic = false;
_intobj = NULL;
memset(&_stringdata, 0, sizeof(struct StringData));
_objects = NULL;
_restartGame = false;
_oldMode = INPUTMODE_NONE;
_firstSlot = 0;
resetControllers();
setupOpcodes();
_game._curLogic = NULL;
_timerHack = 0;
_lastSaveTime = 0;
_lastTick = 0;
memset(_keyQueue, 0, sizeof(_keyQueue));
_text = NULL;
_sprites = NULL;
_picture = NULL;
_loader = NULL;
_console = NULL;
_menu = NULL;
_gfx = NULL;
_systemUI = NULL;
_egoHoldKey = false;
}
void AgiEngine::initialize() {
// TODO: Some sound emulation modes do not fit our current music
// drivers, and I'm not sure what they are. For now, they might
// as well be called "PC Speaker" and "Not PC Speaker".
// If used platform is Apple IIGS then we must use Apple IIGS sound emulation
// because Apple IIGS AGI games use only Apple IIGS specific sound resources.
if (getPlatform() == Common::kPlatformApple2GS) {
_soundemu = SOUND_EMU_APPLE2GS;
} else if (getPlatform() == Common::kPlatformCoCo3) {
_soundemu = SOUND_EMU_COCO3;
} else if (ConfMan.get("music_driver") == "auto") {
// Default sound is the proper PCJr emulation
_soundemu = SOUND_EMU_PCJR;
} else {
switch (MidiDriver::getMusicType(MidiDriver::detectDevice(MDT_PCSPK|MDT_AMIGA|MDT_ADLIB|MDT_PCJR|MDT_MIDI))) {
case MT_PCSPK:
_soundemu = SOUND_EMU_PC;
break;
case MT_ADLIB:
_soundemu = SOUND_EMU_NONE;
break;
case MT_PCJR:
_soundemu = SOUND_EMU_PCJR;
break;
case MT_AMIGA:
_soundemu = SOUND_EMU_AMIGA;
break;
default:
debug(0, "DEF");
_soundemu = SOUND_EMU_MIDI;
break;
}
}
initRenderMode();
_console = new Console(this);
_words = new Words(this);
_font = new GfxFont(this);
_gfx = new GfxMgr(this);
_sound = new SoundMgr(this, _mixer);
_picture = new PictureMgr(this, _gfx);
_sprites = new SpritesMgr(this, _gfx);
_text = new TextMgr(this, _words, _gfx);
_systemUI = new SystemUI(this, _gfx, _text);
_inventory = new InventoryMgr(this, _gfx, _text, _systemUI);
_font->init();
_text->init(_systemUI);
_gfx->initMachine();
_game.gameFlags = 0;
_text->charAttrib_Set(15, 0);
_game.name[0] = '\0';
_gfx->initVideo();
_lastSaveTime = 0;
_lastTick = _system->getMillis();
debugC(2, kDebugLevelMain, "Detect game");
if (agiDetectGame() == errOK) {
_game.state = STATE_LOADED;
debugC(2, kDebugLevelMain, "game loaded");
} else {
warning("Could not open AGI game");
}
debugC(2, kDebugLevelMain, "Init sound");
}
bool AgiEngine::promptIsEnabled() {
return _text->promptIsEnabled();
}
void AgiEngine::redrawScreen() {
_game.gfxMode = true; // enable graphics mode
_gfx->setPalette(true); // set graphics mode palette
_text->charAttrib_Set(_text->_textAttrib.foreground, _text->_textAttrib.background);
_gfx->clearDisplay(0);
_picture->showPic();
_text->statusDraw();
_text->promptRedraw();
}
// Adjust a given coordinate to the local game screen
// Used on mouse cursor coordinates before passing them to scripts
void AgiEngine::adjustPosToGameScreen(int16 &x, int16 &y) {
x = x / 2; // 320 -> 160
y = y - _gfx->getRenderStartOffsetY(); // remove status bar line
if (y < 0) {
y = 0;
}
if (y >= SCRIPT_HEIGHT) {
y = SCRIPT_HEIGHT + 1; // 1 beyond
}
}
AgiEngine::~AgiEngine() {
// If the engine hasn't been initialized yet via
// AgiEngine::initialize(), don't attempt to free any resources, as
// they haven't been allocated. Fixes bug #1742432 - AGI: Engine
// crashes if no game is detected
if (_game.state == STATE_INIT) {
return;
}
agiDeinit();
delete _loader;
_gfx->deinitVideo();
delete _inventory;
delete _systemUI;
delete _text;
delete _sprites;
delete _picture;
_gfx->deinitMachine();
delete _gfx;
delete _font;
delete _words;
delete _console;
}
Common::Error AgiBase::init() {
initialize();
_gfx->setPalette(true);
return Common::kNoError;
}
Common::Error AgiEngine::go() {
if (_game.mouseEnabled) {
CursorMan.showMouse(true);
}
setTotalPlayTime(0);
if (_game.state < STATE_LOADED) {
do {
mainCycle();
} while (_game.state < STATE_RUNNING);
}
runGame();
return Common::kNoError;
}
// Scenes that need this:
//
// Manhunter 1:
// - intro text screen (DrawPic)
// - MAD "zooming in..." during intro and other scenes, for example room 124 (NewRoom)
// The NewRoom call is not done during the same cycle as the "zooming in..." print call.
// Space Quest 1:
// - right at the start of the game (NewRoom)
// Space Quest 2
// - right at the start of the game (NewRoom)
// - after exiting the very first room, a message pops up, that isn't readable without it (NewRoom)
// Games, that must not be triggered:
//
// Fanmade Voodoo Girl:
// - waterfall (DrawPic, room 17)
// - inside shop (NewRoom, changes to same room every new button, room 4)
void AgiEngine::nonBlockingText_IsShown() {
_game.nonBlockingTextShown = true;
_game.nonBlockingTextCyclesLeft = 2; // 1 additional script cycle is counted too
}
void AgiEngine::nonBlockingText_Forget() {
_game.nonBlockingTextShown = false;
_game.nonBlockingTextCyclesLeft = 0;
}
void AgiEngine::nonBlockingText_CycleDone() {
if (_game.nonBlockingTextCyclesLeft) {
_game.nonBlockingTextCyclesLeft--;
if (!_game.nonBlockingTextCyclesLeft) {
// cycle count expired, we assume that non-blocking text won't be a problem for room / pic change
_game.nonBlockingTextShown = false;
}
}
}
void AgiEngine::loadingTrigger_NewRoom(int16 newRoomNr) {
if (_game.nonBlockingTextShown) {
_game.nonBlockingTextShown = false;
int16 curRoomNr = _game.vars[VM_VAR_CURRENT_ROOM];
if (newRoomNr != curRoomNr) {
if (!_game.automaticRestoreGame) {
// wait a bit, we detected non-blocking text
pause(2000); // 2 seconds
}
}
}
}
void AgiEngine::loadingTrigger_DrawPicture() {
if (_game.nonBlockingTextShown) {
_game.nonBlockingTextShown = false;
if (!_game.automaticRestoreGame) {
// wait a bit, we detected non-blocking text
pause(2000); // 2 seconds
}
}
}
} // End of namespace Agi
|