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
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
|
/* 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/savefile.h"
#include "common/stream.h"
#include "common/system.h"
#include "common/func.h"
#include "common/serializer.h"
#include "graphics/thumbnail.h"
#include "sci/sci.h"
#include "sci/event.h"
#include "sci/engine/features.h"
#include "sci/engine/kernel.h"
#include "sci/engine/state.h"
#include "sci/engine/message.h"
#include "sci/engine/savegame.h"
#include "sci/engine/selector.h"
#include "sci/engine/vm_types.h"
#include "sci/engine/script.h" // for SCI_OBJ_EXPORTS and SCI_OBJ_SYNONYMS
#include "sci/graphics/helpers.h"
#include "sci/graphics/menu.h"
#include "sci/graphics/palette.h"
#include "sci/graphics/ports.h"
#include "sci/graphics/screen.h"
#include "sci/parser/vocabulary.h"
#include "sci/sound/audio.h"
#include "sci/sound/music.h"
#ifdef ENABLE_SCI32
#include "sci/graphics/palette32.h"
#include "sci/graphics/frameout.h"
#endif
namespace Sci {
#define VER(x) Common::Serializer::Version(x)
#pragma mark -
// Experimental hack: Use syncWithSerializer to sync. By default, this assume
// the object to be synced is a subclass of Serializable and thus tries to invoke
// the saveLoadWithSerializer() method. But it is possible to specialize this
// template function to handle stuff that is not implementing that interface.
template<typename T>
void syncWithSerializer(Common::Serializer &s, T &obj) {
obj.saveLoadWithSerializer(s);
}
// By default, sync using syncWithSerializer, which in turn can easily be overloaded.
template<typename T>
struct DefaultSyncer : Common::BinaryFunction<Common::Serializer, T, void> {
void operator()(Common::Serializer &s, T &obj) const {
//obj.saveLoadWithSerializer(s);
syncWithSerializer(s, obj);
}
};
/**
* Sync a Common::Array using a Common::Serializer.
* When saving, this writes the length of the array, then syncs (writes) all entries.
* When loading, it loads the length of the array, then resizes it accordingly, before
* syncing all entries.
*
* Note: This shouldn't be in common/array.h nor in common/serializer.h, after
* all, not all code using arrays wants to use the serializer, and vice versa.
* But we could put this into a separate header file in common/ at some point.
* Something like common/serializer-extras.h or so.
*
* TODO: Add something like this for lists, queues....
*/
template<typename T, class Syncer = DefaultSyncer<T> >
struct ArraySyncer : Common::BinaryFunction<Common::Serializer, T, void> {
void operator()(Common::Serializer &s, Common::Array<T> &arr) const {
uint len = arr.size();
s.syncAsUint32LE(len);
Syncer sync;
// Resize the array if loading.
if (s.isLoading())
arr.resize(len);
typename Common::Array<T>::iterator i;
for (i = arr.begin(); i != arr.end(); ++i) {
sync(s, *i);
}
}
};
// Convenience wrapper
template<typename T>
void syncArray(Common::Serializer &s, Common::Array<T> &arr) {
ArraySyncer<T> sync;
sync(s, arr);
}
template<>
void syncWithSerializer(Common::Serializer &s, reg_t &obj) {
// Segment and offset are accessed directly here
s.syncAsUint16LE(obj._segment);
s.syncAsUint16LE(obj._offset);
}
template<>
void syncWithSerializer(Common::Serializer &s, synonym_t &obj) {
s.syncAsUint16LE(obj.replaceant);
s.syncAsUint16LE(obj.replacement);
}
void SegManager::saveLoadWithSerializer(Common::Serializer &s) {
if (s.isLoading()) {
resetSegMan();
// Reset _scriptSegMap, to be restored below
_scriptSegMap.clear();
}
s.skip(4, VER(14), VER(18)); // OBSOLETE: Used to be _exportsAreWide
uint sync_heap_size = _heap.size();
s.syncAsUint32LE(sync_heap_size);
_heap.resize(sync_heap_size);
for (uint i = 0; i < sync_heap_size; ++i) {
SegmentObj *&mobj = _heap[i];
// Sync the segment type
SegmentType type = (s.isSaving() && mobj) ? mobj->getType() : SEG_TYPE_INVALID;
s.syncAsUint32LE(type);
if (type == SEG_TYPE_HUNK) {
// Don't save or load HunkTable segments
continue;
} else if (type == SEG_TYPE_INVALID) {
// If we were saving and mobj == 0, or if we are loading and this is an
// entry marked as empty -> skip to next
continue;
} else if (type == 5) {
// Don't save or load the obsolete system string segments
if (s.isSaving()) {
continue;
} else {
// Old saved game. Skip the data.
Common::String tmp;
for (int j = 0; j < 4; j++) {
s.syncString(tmp); // OBSOLETE: name
s.skip(4); // OBSOLETE: maxSize
s.syncString(tmp); // OBSOLETE: value
}
_heap[i] = NULL; // set as freed
continue;
}
#ifdef ENABLE_SCI32
} else if (type == SEG_TYPE_ARRAY) {
// Set the correct segment for SCI32 arrays
_arraysSegId = i;
} else if (type == SEG_TYPE_STRING) {
// Set the correct segment for SCI32 strings
_stringSegId = i;
#endif
}
if (s.isLoading())
mobj = SegmentObj::createSegmentObj(type);
assert(mobj);
// Let the object sync custom data. Scripts are loaded at this point.
mobj->saveLoadWithSerializer(s);
if (type == SEG_TYPE_SCRIPT) {
Script *scr = (Script *)mobj;
// If we are loading a script, perform some extra steps
if (s.isLoading()) {
// Hook the script up in the script->segment map
_scriptSegMap[scr->getScriptNumber()] = i;
ObjMap objects = scr->getObjectMap();
for (ObjMap::iterator it = objects.begin(); it != objects.end(); ++it)
it->_value.syncBaseObject(scr->getBuf(it->_value.getPos().getOffset()));
}
// Sync the script's string heap
if (s.getVersion() >= 28)
scr->syncStringHeap(s);
}
}
s.syncAsSint32LE(_clonesSegId);
s.syncAsSint32LE(_listsSegId);
s.syncAsSint32LE(_nodesSegId);
syncArray<Class>(s, _classTable);
// Now that all scripts are loaded, init their objects.
// Just like in Script::initializeObjectsSci0, we do two passes
// in case an object is loaded before its base.
int passes = getSciVersion() < SCI_VERSION_1_1 ? 2 : 1;
for (int pass = 1; pass <= passes; ++pass) {
for (uint i = 0; i < _heap.size(); i++) {
if (!_heap[i] || _heap[i]->getType() != SEG_TYPE_SCRIPT)
continue;
Script *scr = (Script *)_heap[i];
scr->syncLocalsBlock(this);
ObjMap objects = scr->getObjectMap();
for (ObjMap::iterator it = objects.begin(); it != objects.end(); ++it) {
reg_t addr = it->_value.getPos();
Object *obj = scr->scriptObjInit(addr, false);
if (pass == 2) {
if (!obj->initBaseObject(this, addr, false)) {
// TODO/FIXME: This should not be happening at all. It might indicate a possible issue
// with the garbage collector. It happens for example in LSL5 (German, perhaps English too).
warning("Failed to locate base object for object at %04X:%04X; skipping", PRINT_REG(addr));
objects.erase(addr.toUint16());
}
}
}
}
}
}
template<>
void syncWithSerializer(Common::Serializer &s, Class &obj) {
s.syncAsSint32LE(obj.script);
syncWithSerializer(s, obj.reg);
}
static void sync_SavegameMetadata(Common::Serializer &s, SavegameMetadata &obj) {
s.syncString(obj.name);
s.syncVersion(CURRENT_SAVEGAME_VERSION);
obj.version = s.getVersion();
s.syncString(obj.gameVersion);
s.syncAsSint32LE(obj.saveDate);
s.syncAsSint32LE(obj.saveTime);
if (s.getVersion() < 22) {
obj.gameObjectOffset = 0;
obj.script0Size = 0;
} else {
s.syncAsUint16LE(obj.gameObjectOffset);
s.syncAsUint16LE(obj.script0Size);
}
// Playtime
obj.playTime = 0;
if (s.isLoading()) {
if (s.getVersion() >= 26)
s.syncAsUint32LE(obj.playTime);
} else {
if (s.getVersion() >= 34) {
obj.playTime = g_sci->getTickCount();
} else {
obj.playTime = g_engine->getTotalPlayTime() / 1000;
}
s.syncAsUint32LE(obj.playTime);
}
}
void EngineState::saveLoadWithSerializer(Common::Serializer &s) {
Common::String tmp;
s.syncString(tmp, VER(14), VER(23)); // OBSOLETE: Used to be gameVersion
if (getSciVersion() <= SCI_VERSION_1_1) {
// Save/Load picPort as well for SCI0-SCI1.1. Necessary for Castle of Dr. Brain,
// as the picPort has been changed when loading during the intro
int16 picPortTop, picPortLeft;
Common::Rect picPortRect;
if (s.isSaving())
picPortRect = g_sci->_gfxPorts->kernelGetPicWindow(picPortTop, picPortLeft);
s.syncAsSint16LE(picPortRect.top);
s.syncAsSint16LE(picPortRect.left);
s.syncAsSint16LE(picPortRect.bottom);
s.syncAsSint16LE(picPortRect.right);
s.syncAsSint16LE(picPortTop);
s.syncAsSint16LE(picPortLeft);
if (s.isLoading())
g_sci->_gfxPorts->kernelSetPicWindow(picPortRect, picPortTop, picPortLeft, false);
}
_segMan->saveLoadWithSerializer(s);
g_sci->_soundCmd->syncPlayList(s);
// NOTE: This will be GfxPalette32 for SCI32 engine games
g_sci->_gfxPalette16->saveLoadWithSerializer(s);
}
void Vocabulary::saveLoadWithSerializer(Common::Serializer &s) {
syncArray<synonym_t>(s, _synonyms);
}
void LocalVariables::saveLoadWithSerializer(Common::Serializer &s) {
s.syncAsSint32LE(script_id);
syncArray<reg_t>(s, _locals);
}
void Object::saveLoadWithSerializer(Common::Serializer &s) {
s.syncAsSint32LE(_flags);
syncWithSerializer(s, _pos);
s.syncAsSint32LE(_methodCount); // that's actually a uint16
syncArray<reg_t>(s, _variables);
}
template<>
void syncWithSerializer(Common::Serializer &s, SegmentObjTable<Clone>::Entry &obj) {
s.syncAsSint32LE(obj.next_free);
syncWithSerializer<Object>(s, obj);
}
template<>
void syncWithSerializer(Common::Serializer &s, SegmentObjTable<List>::Entry &obj) {
s.syncAsSint32LE(obj.next_free);
syncWithSerializer(s, obj.first);
syncWithSerializer(s, obj.last);
}
template<>
void syncWithSerializer(Common::Serializer &s, SegmentObjTable<Node>::Entry &obj) {
s.syncAsSint32LE(obj.next_free);
syncWithSerializer(s, obj.pred);
syncWithSerializer(s, obj.succ);
syncWithSerializer(s, obj.key);
syncWithSerializer(s, obj.value);
}
#ifdef ENABLE_SCI32
template<>
void syncWithSerializer(Common::Serializer &s, SegmentObjTable<SciArray<reg_t> >::Entry &obj) {
s.syncAsSint32LE(obj.next_free);
byte type = 0;
uint32 size = 0;
if (s.isSaving()) {
type = (byte)obj.getType();
size = obj.getSize();
}
s.syncAsByte(type);
s.syncAsUint32LE(size);
if (s.isLoading()) {
obj.setType((int8)type);
// HACK: Skip arrays that have a negative type
if ((int8)type < 0)
return;
obj.setSize(size);
}
for (uint32 i = 0; i < size; i++) {
reg_t value;
if (s.isSaving())
value = obj.getValue(i);
syncWithSerializer(s, value);
if (s.isLoading())
obj.setValue(i, value);
}
}
template<>
void syncWithSerializer(Common::Serializer &s, SegmentObjTable<SciString>::Entry &obj) {
s.syncAsSint32LE(obj.next_free);
uint32 size = 0;
if (s.isSaving()) {
size = obj.getSize();
s.syncAsUint32LE(size);
} else {
s.syncAsUint32LE(size);
obj.setSize(size);
}
for (uint32 i = 0; i < size; i++) {
char value = 0;
if (s.isSaving())
value = obj.getValue(i);
s.syncAsByte(value);
if (s.isLoading())
obj.setValue(i, value);
}
}
#endif
template<typename T>
void sync_Table(Common::Serializer &s, T &obj) {
s.syncAsSint32LE(obj.first_free);
s.syncAsSint32LE(obj.entries_used);
syncArray<typename T::Entry>(s, obj._table);
}
void CloneTable::saveLoadWithSerializer(Common::Serializer &s) {
sync_Table<CloneTable>(s, *this);
}
void NodeTable::saveLoadWithSerializer(Common::Serializer &s) {
sync_Table<NodeTable>(s, *this);
}
void ListTable::saveLoadWithSerializer(Common::Serializer &s) {
sync_Table<ListTable>(s, *this);
}
void HunkTable::saveLoadWithSerializer(Common::Serializer &s) {
// Do nothing, hunk tables are not actually saved nor loaded.
}
void Script::syncStringHeap(Common::Serializer &s) {
if (getSciVersion() < SCI_VERSION_1_1) {
// Sync all of the SCI_OBJ_STRINGS blocks
byte *buf = _buf;
bool oldScriptHeader = (getSciVersion() == SCI_VERSION_0_EARLY);
if (oldScriptHeader)
buf += 2;
do {
int blockType = READ_LE_UINT16(buf);
int blockSize;
if (blockType == 0)
break;
blockSize = READ_LE_UINT16(buf + 2);
assert(blockSize > 0);
if (blockType == SCI_OBJ_STRINGS)
s.syncBytes(buf, blockSize);
buf += blockSize;
if (_buf - buf == 0)
break;
} while (1);
} else if (getSciVersion() >= SCI_VERSION_1_1 && getSciVersion() <= SCI_VERSION_2_1_LATE){
// Strings in SCI1.1 come after the object instances
byte *buf = _heapStart + 4 + READ_SCI11ENDIAN_UINT16(_heapStart + 2) * 2;
// Skip all of the objects
while (READ_SCI11ENDIAN_UINT16(buf) == SCRIPT_OBJECT_MAGIC_NUMBER)
buf += READ_SCI11ENDIAN_UINT16(buf + 2) * 2;
// Now, sync everything till the end of the buffer
s.syncBytes(buf, _heapSize - (buf - _heapStart));
} else if (getSciVersion() == SCI_VERSION_3) {
warning("TODO: syncStringHeap(): Implement SCI3 variant");
}
}
void Script::saveLoadWithSerializer(Common::Serializer &s) {
s.syncAsSint32LE(_nr);
if (s.isLoading())
load(_nr, g_sci->getResMan(), g_sci->getScriptPatcher());
s.skip(4, VER(14), VER(22)); // OBSOLETE: Used to be _bufSize
s.skip(4, VER(14), VER(22)); // OBSOLETE: Used to be _scriptSize
s.skip(4, VER(14), VER(22)); // OBSOLETE: Used to be _heapSize
s.skip(4, VER(14), VER(19)); // OBSOLETE: Used to be _numExports
s.skip(4, VER(14), VER(19)); // OBSOLETE: Used to be _numSynonyms
s.syncAsSint32LE(_lockers);
// Sync _objects. This is a hashmap, and we use the following on disk format:
// First we store the number of items in the hashmap, then we store each
// object (which is an 'Object' instance). For loading, we take advantage
// of the fact that the key of each Object obj is just obj._pos.offset !
// By "chance" this format is identical to the format used to sync Common::Array<>,
// hence we can still old savegames with identical code :).
uint numObjs = _objects.size();
s.syncAsUint32LE(numObjs);
if (s.isLoading()) {
_objects.clear();
Object tmp;
for (uint i = 0; i < numObjs; ++i) {
syncWithSerializer(s, tmp);
_objects[tmp.getPos().getOffset()] = tmp;
}
} else {
ObjMap::iterator it;
const ObjMap::iterator end = _objects.end();
for (it = _objects.begin(); it != end; ++it) {
syncWithSerializer(s, it->_value);
}
}
s.skip(4, VER(14), VER(20)); // OBSOLETE: Used to be _localsOffset
s.syncAsSint32LE(_localsSegment);
s.syncAsSint32LE(_markedAsDeleted);
}
void DynMem::saveLoadWithSerializer(Common::Serializer &s) {
s.syncAsSint32LE(_size);
s.syncString(_description);
if (!_buf && _size) {
_buf = (byte *)calloc(_size, 1);
}
if (_size)
s.syncBytes(_buf, _size);
}
void DataStack::saveLoadWithSerializer(Common::Serializer &s) {
s.syncAsUint32LE(_capacity);
if (s.isLoading()) {
free(_entries);
_entries = (reg_t *)calloc(_capacity, sizeof(reg_t));
}
}
#pragma mark -
void SciMusic::saveLoadWithSerializer(Common::Serializer &s) {
// Sync song lib data. When loading, the actual song lib will be initialized
// afterwards in gamestate_restore()
int songcount = 0;
byte masterVolume = soundGetMasterVolume();
byte reverb = _pMidiDrv->getReverb();
if (s.isSaving()) {
s.syncAsByte(_soundOn);
s.syncAsByte(masterVolume);
s.syncAsByte(reverb, VER(17));
} else if (s.isLoading()) {
if (s.getVersion() >= 15) {
s.syncAsByte(_soundOn);
s.syncAsByte(masterVolume);
reverb = 0;
s.syncAsByte(reverb, VER(17));
} else {
_soundOn = true;
masterVolume = 15;
reverb = 0;
}
soundSetSoundOn(_soundOn);
soundSetMasterVolume(masterVolume);
setGlobalReverb(reverb);
}
if (s.isSaving())
songcount = _playList.size();
s.syncAsUint32LE(songcount);
if (s.isLoading())
clearPlayList();
Common::StackLock lock(_mutex);
if (s.isLoading()) {
for (int i = 0; i < songcount; i++) {
MusicEntry *curSong = new MusicEntry();
curSong->saveLoadWithSerializer(s);
_playList.push_back(curSong);
}
} else {
for (int i = 0; i < songcount; i++) {
_playList[i]->saveLoadWithSerializer(s);
}
}
}
void MusicEntry::saveLoadWithSerializer(Common::Serializer &s) {
syncWithSerializer(s, soundObj);
s.syncAsSint16LE(resourceId);
s.syncAsSint16LE(dataInc);
s.syncAsSint16LE(ticker);
s.syncAsSint16LE(signal, VER(17));
if (s.getVersion() >= 31) // FE sound/music.h -> priority
s.syncAsSint16LE(priority);
else
s.syncAsByte(priority);
s.syncAsSint16LE(loop, VER(17));
s.syncAsByte(volume);
s.syncAsByte(hold, VER(17));
s.syncAsByte(fadeTo);
s.syncAsSint16LE(fadeStep);
s.syncAsSint32LE(fadeTicker);
s.syncAsSint32LE(fadeTickerStep);
s.syncAsByte(status);
if (s.getVersion() >= 32)
s.syncAsByte(playBed);
else if (s.isLoading())
playBed = false;
if (s.getVersion() >= 33)
s.syncAsByte(overridePriority);
else if (s.isLoading())
overridePriority = false;
// pMidiParser and pStreamAud will be initialized when the
// sound list is reconstructed in gamestate_restore()
if (s.isLoading()) {
soundRes = 0;
pMidiParser = 0;
pStreamAud = 0;
reverb = -1; // invalid reverb, will be initialized in processInitSound()
}
}
void SoundCommandParser::syncPlayList(Common::Serializer &s) {
_music->saveLoadWithSerializer(s);
}
void SoundCommandParser::reconstructPlayList() {
Common::StackLock lock(_music->_mutex);
// We store all songs here because starting songs may re-shuffle their order
MusicList songs;
for (MusicList::iterator i = _music->getPlayListStart(); i != _music->getPlayListEnd(); ++i)
songs.push_back(*i);
for (MusicList::iterator i = songs.begin(); i != songs.end(); ++i) {
initSoundResource(*i);
if ((*i)->status == kSoundPlaying) {
// WORKAROUND: PQ3 (German?) scripts can set volume negative in the
// sound object directly without going through DoSound.
// Since we re-read this selector when re-playing the sound after loading,
// this will lead to unexpected behaviour. As a workaround we
// sync the sound object's selectors here. (See bug #5501)
writeSelectorValue(_segMan, (*i)->soundObj, SELECTOR(loop), (*i)->loop);
writeSelectorValue(_segMan, (*i)->soundObj, SELECTOR(priority), (*i)->priority);
if (_soundVersion >= SCI_VERSION_1_EARLY)
writeSelectorValue(_segMan, (*i)->soundObj, SELECTOR(vol), (*i)->volume);
processPlaySound((*i)->soundObj, (*i)->playBed);
}
}
}
#ifdef ENABLE_SCI32
void ArrayTable::saveLoadWithSerializer(Common::Serializer &ser) {
if (ser.getVersion() < 18)
return;
sync_Table<ArrayTable>(ser, *this);
}
void StringTable::saveLoadWithSerializer(Common::Serializer &ser) {
if (ser.getVersion() < 18)
return;
sync_Table<StringTable>(ser, *this);
}
#endif
void GfxPalette::palVarySaveLoadPalette(Common::Serializer &s, Palette *palette) {
s.syncBytes(palette->mapping, 256);
s.syncAsUint32LE(palette->timestamp);
for (int i = 0; i < 256; i++) {
s.syncAsByte(palette->colors[i].used);
s.syncAsByte(palette->colors[i].r);
s.syncAsByte(palette->colors[i].g);
s.syncAsByte(palette->colors[i].b);
}
s.syncBytes(palette->intensity, 256);
}
void GfxPalette::saveLoadWithSerializer(Common::Serializer &s) {
if (s.getVersion() >= 25) {
// We need to save intensity of the _sysPalette at least for kq6 when entering the dark cave (room 390)
// from room 340. scripts will set intensity to 60 for this room and restore them when leaving.
// Sierra SCI is also doing this (although obviously not for SCI0->SCI01 games, still it doesn't hurt
// to save it everywhere). Refer to bug #3072868
s.syncBytes(_sysPalette.intensity, 256);
}
if (s.getVersion() >= 24) {
if (s.isLoading() && _palVaryResourceId != -1)
palVaryRemoveTimer();
s.syncAsSint32LE(_palVaryResourceId);
if (_palVaryResourceId != -1) {
palVarySaveLoadPalette(s, &_palVaryOriginPalette);
palVarySaveLoadPalette(s, &_palVaryTargetPalette);
s.syncAsSint16LE(_palVaryStep);
s.syncAsSint16LE(_palVaryStepStop);
s.syncAsSint16LE(_palVaryDirection);
s.syncAsUint16LE(_palVaryTicks);
s.syncAsSint32LE(_palVaryPaused);
}
_palVarySignal = 0;
if (s.isLoading() && _palVaryResourceId != -1) {
palVaryInstallTimer();
}
}
}
#ifdef ENABLE_SCI32
void saveLoadPalette32(Common::Serializer &s, Palette *const palette) {
s.syncAsUint32LE(palette->timestamp);
for (int i = 0; i < ARRAYSIZE(palette->colors); ++i) {
s.syncAsByte(palette->colors[i].used);
s.syncAsByte(palette->colors[i].r);
s.syncAsByte(palette->colors[i].g);
s.syncAsByte(palette->colors[i].b);
}
}
void saveLoadOptionalPalette32(Common::Serializer &s, Palette **const palette) {
bool hasPalette;
if (s.isSaving()) {
hasPalette = (*palette != nullptr);
}
s.syncAsByte(hasPalette);
if (hasPalette) {
if (s.isLoading()) {
*palette = new Palette;
}
saveLoadPalette32(s, *palette);
}
}
void GfxPalette32::saveLoadWithSerializer(Common::Serializer &s) {
if (s.getVersion() < 34) {
return;
}
if (s.isLoading()) {
++_version;
}
s.syncAsSint16LE(_varyDirection);
s.syncAsSint16LE(_varyPercent);
s.syncAsSint16LE(_varyTargetPercent);
s.syncAsSint16LE(_varyFromColor);
s.syncAsSint16LE(_varyToColor);
s.syncAsUint16LE(_varyNumTimesPaused);
s.syncAsByte(_versionUpdated);
s.syncAsSint32LE(_varyTime);
s.syncAsUint32LE(_varyLastTick);
for (int i = 0; i < ARRAYSIZE(_fadeTable); ++i) {
s.syncAsByte(_fadeTable[i]);
}
for (int i = 0; i < ARRAYSIZE(_cycleMap); ++i) {
s.syncAsByte(_cycleMap[i]);
}
saveLoadOptionalPalette32(s, &_varyTargetPalette);
saveLoadOptionalPalette32(s, &_varyStartPalette);
// NOTE: _sourcePalette and _nextPalette are not saved
// by SCI engine
for (int i = 0; i < ARRAYSIZE(_cyclers); ++i) {
PalCycler *cycler = nullptr;
bool hasCycler;
if (s.isSaving()) {
cycler = _cyclers[i];
hasCycler = (cycler != nullptr);
}
s.syncAsByte(hasCycler);
if (hasCycler) {
if (s.isLoading()) {
_cyclers[i] = cycler = new PalCycler;
}
s.syncAsByte(cycler->fromColor);
s.syncAsUint16LE(cycler->numColorsToCycle);
s.syncAsByte(cycler->currentCycle);
s.syncAsByte(cycler->direction);
s.syncAsUint32LE(cycler->lastUpdateTick);
s.syncAsSint16LE(cycler->delay);
s.syncAsUint16LE(cycler->numTimesPaused);
}
}
// TODO: _clutTable
}
#endif
void GfxPorts::saveLoadWithSerializer(Common::Serializer &s) {
// reset() is called directly way earlier in gamestate_restore()
if (s.getVersion() >= 27) {
uint windowCount = 0;
uint id = PORTS_FIRSTSCRIPTWINDOWID;
if (s.isSaving()) {
while (id < _windowsById.size()) {
if (_windowsById[id])
windowCount++;
id++;
}
}
// Save/Restore window count
s.syncAsUint32LE(windowCount);
if (s.isSaving()) {
id = PORTS_FIRSTSCRIPTWINDOWID;
while (id < _windowsById.size()) {
if (_windowsById[id]) {
Window *window = (Window *)_windowsById[id];
window->saveLoadWithSerializer(s);
}
id++;
}
} else {
id = PORTS_FIRSTSCRIPTWINDOWID;
while (windowCount) {
Window *window = new Window(0);
window->saveLoadWithSerializer(s);
// add enough entries inside _windowsById as needed
while (id <= window->id) {
_windowsById.push_back(0);
id++;
}
_windowsById[window->id] = window;
// _windowList may not be 100% correct using that way of restoring
// saving/restoring ports won't work perfectly anyway, because the contents
// of the window can only get repainted by the scripts and they dont do that
// so we will get empty, transparent windows instead. So perfect window order
// shouldn't really matter
if (window->counterTillFree) {
_freeCounter++;
} else {
// we don't put the saved script windows into _windowList[], so that they aren't used
// by kernel functions. This is important and would cause issues otherwise.
// see Conquests of Camelot - bug #6744 - when saving on the map screen (room 103),
// restoring would result in a black window in place
// where the area name was displayed before
// In Sierra's SCI the behaviour is identical to us
// Sierra's SCI won't show those windows after restoring
// If this should cause issues in another game, we would have to add a flag to simply
// avoid any drawing operations for such windows
// We still have to restore script windows, because for example Conquests of Camelot
// will immediately delete windows, that were created before saving the game.
}
windowCount--;
}
}
}
}
void SegManager::reconstructStack(EngineState *s) {
DataStack *stack = (DataStack *)(_heap[findSegmentByType(SEG_TYPE_STACK)]);
s->stack_base = stack->_entries;
s->stack_top = s->stack_base + stack->_capacity;
}
void SegManager::reconstructClones() {
for (uint i = 0; i < _heap.size(); i++) {
SegmentObj *mobj = _heap[i];
if (mobj && mobj->getType() == SEG_TYPE_CLONES) {
CloneTable *ct = (CloneTable *)mobj;
for (uint j = 0; j < ct->_table.size(); j++) {
// Check if the clone entry is used
uint entryNum = (uint)ct->first_free;
bool isUsed = true;
while (entryNum != ((uint) CloneTable::HEAPENTRY_INVALID)) {
if (entryNum == j) {
isUsed = false;
break;
}
entryNum = ct->_table[entryNum].next_free;
}
if (!isUsed)
continue;
CloneTable::Entry &seeker = ct->_table[j];
const Object *baseObj = getObject(seeker.getSpeciesSelector());
seeker.cloneFromObject(baseObj);
if (!baseObj) {
// Can happen when loading some KQ6 savegames
warning("Clone entry without a base class: %d", j);
}
} // end for
} // end if
} // end for
}
#pragma mark -
bool gamestate_save(EngineState *s, Common::WriteStream *fh, const Common::String &savename, const Common::String &version) {
TimeDate curTime;
g_system->getTimeAndDate(curTime);
SavegameMetadata meta;
meta.version = CURRENT_SAVEGAME_VERSION;
meta.name = savename;
meta.gameVersion = version;
meta.saveDate = ((curTime.tm_mday & 0xFF) << 24) | (((curTime.tm_mon + 1) & 0xFF) << 16) | ((curTime.tm_year + 1900) & 0xFFFF);
meta.saveTime = ((curTime.tm_hour & 0xFF) << 16) | (((curTime.tm_min) & 0xFF) << 8) | ((curTime.tm_sec) & 0xFF);
Resource *script0 = g_sci->getResMan()->findResource(ResourceId(kResourceTypeScript, 0), false);
meta.script0Size = script0->size;
meta.gameObjectOffset = g_sci->getGameObject().getOffset();
// Checking here again
if (s->executionStackBase) {
warning("Cannot save from below kernel function");
return false;
}
Common::Serializer ser(0, fh);
sync_SavegameMetadata(ser, meta);
Graphics::saveThumbnail(*fh);
s->saveLoadWithSerializer(ser); // FIXME: Error handling?
if (g_sci->_gfxPorts)
g_sci->_gfxPorts->saveLoadWithSerializer(ser);
Vocabulary *voc = g_sci->getVocabulary();
if (voc)
voc->saveLoadWithSerializer(ser);
// TODO: SSCI (at least JonesCD, presumably more) also stores the Menu state
return true;
}
extern void showScummVMDialog(const Common::String &message);
void gamestate_delayedrestore(EngineState *s) {
int savegameId = s->_delayedRestoreGameId; // delayedRestoreGameId gets destroyed within gamestate_restore()!
Common::String fileName = g_sci->getSavegameName(savegameId);
Common::SeekableReadStream *in = g_sci->getSaveFileManager()->openForLoading(fileName);
if (in) {
// found a savegame file
gamestate_restore(s, in);
delete in;
if (s->r_acc != make_reg(0, 1)) {
gamestate_afterRestoreFixUp(s, savegameId);
return;
}
}
error("Restoring gamestate '%s' failed", fileName.c_str());
}
void gamestate_afterRestoreFixUp(EngineState *s, int savegameId) {
switch (g_sci->getGameId()) {
case GID_MOTHERGOOSE:
// WORKAROUND: Mother Goose SCI0
// Script 200 / rm200::newRoom will set global C5h directly right after creating a child to the
// current number of children plus 1.
// We can't trust that global, that's why we set the actual savedgame id right here directly after
// restoring a saved game.
// If we didn't, the game would always save to a new slot
s->variables[VAR_GLOBAL][0xC5].setOffset(SAVEGAMEID_OFFICIALRANGE_START + savegameId);
break;
case GID_MOTHERGOOSE256:
// WORKAROUND: Mother Goose SCI1/SCI1.1 does some weird things for
// saving a previously restored game.
// We set the current savedgame-id directly and remove the script
// code concerning this via script patch.
s->variables[VAR_GLOBAL][0xB3].setOffset(SAVEGAMEID_OFFICIALRANGE_START + savegameId);
break;
case GID_JONES:
// HACK: The code that enables certain menu items isn't called when a game is restored from the
// launcher, or the "Restore game" option in the game's main menu - bugs #6537 and #6723.
// These menu entries are disabled when the game is launched, and are enabled when a new game is
// started. The code for enabling these entries is is all in script 1, room1::init, but that code
// path is never followed in these two cases (restoring game from the menu, or restoring a game
// from the ScummVM launcher). Thus, we perform the calls to enable the menus ourselves here.
// These two are needed when restoring from the launcher
// FIXME: The original interpreter saves and restores the menu state, so these attributes
// are automatically reset there. We may want to do the same.
g_sci->_gfxMenu->kernelSetAttribute(257 >> 8, 257 & 0xFF, SCI_MENU_ATTRIBUTE_ENABLED, TRUE_REG); // Sierra -> About Jones
g_sci->_gfxMenu->kernelSetAttribute(258 >> 8, 258 & 0xFF, SCI_MENU_ATTRIBUTE_ENABLED, TRUE_REG); // Sierra -> Help
// The rest are normally enabled from room1::init
g_sci->_gfxMenu->kernelSetAttribute(769 >> 8, 769 & 0xFF, SCI_MENU_ATTRIBUTE_ENABLED, TRUE_REG); // Options -> Delete current player
g_sci->_gfxMenu->kernelSetAttribute(513 >> 8, 513 & 0xFF, SCI_MENU_ATTRIBUTE_ENABLED, TRUE_REG); // Game -> Save Game
g_sci->_gfxMenu->kernelSetAttribute(515 >> 8, 515 & 0xFF, SCI_MENU_ATTRIBUTE_ENABLED, TRUE_REG); // Game -> Restore Game
g_sci->_gfxMenu->kernelSetAttribute(1025 >> 8, 1025 & 0xFF, SCI_MENU_ATTRIBUTE_ENABLED, TRUE_REG); // Status -> Statistics
g_sci->_gfxMenu->kernelSetAttribute(1026 >> 8, 1026 & 0xFF, SCI_MENU_ATTRIBUTE_ENABLED, TRUE_REG); // Status -> Goals
break;
case GID_PQ2:
// HACK: Same as above - enable the save game menu option when loading in PQ2 (bug #6875).
// It gets disabled in the game's death screen.
g_sci->_gfxMenu->kernelSetAttribute(2, 1, SCI_MENU_ATTRIBUTE_ENABLED, TRUE_REG); // Game -> Save Game
break;
default:
break;
}
}
void gamestate_restore(EngineState *s, Common::SeekableReadStream *fh) {
SavegameMetadata meta;
Common::Serializer ser(fh, 0);
sync_SavegameMetadata(ser, meta);
if (fh->eos()) {
s->r_acc = TRUE_REG; // signal failure
return;
}
if ((meta.version < MINIMUM_SAVEGAME_VERSION) || (meta.version > CURRENT_SAVEGAME_VERSION)) {
if (meta.version < MINIMUM_SAVEGAME_VERSION) {
showScummVMDialog("The format of this saved game is obsolete, unable to load it");
} else {
Common::String msg = Common::String::format("Savegame version is %d, maximum supported is %0d", meta.version, CURRENT_SAVEGAME_VERSION);
showScummVMDialog(msg);
}
s->r_acc = TRUE_REG; // signal failure
return;
}
if (meta.gameObjectOffset > 0 && meta.script0Size > 0) {
Resource *script0 = g_sci->getResMan()->findResource(ResourceId(kResourceTypeScript, 0), false);
if (script0->size != meta.script0Size || g_sci->getGameObject().getOffset() != meta.gameObjectOffset) {
showScummVMDialog("This saved game was created with a different version of the game, unable to load it");
s->r_acc = TRUE_REG; // signal failure
return;
}
}
// We don't need the thumbnail here, so just read it and discard it
Graphics::skipThumbnail(*fh);
// reset ports is one of the first things we do, because that may free() some hunk memory
// and we don't want to do that after we read in the saved game hunk memory
if (g_sci->_gfxPorts)
g_sci->_gfxPorts->reset();
// clear screen
if (g_sci->_gfxScreen)
g_sci->_gfxScreen->clearForRestoreGame();
#ifdef ENABLE_SCI32
// Also clear any SCI32 planes/screen items currently showing so they
// don't show up after the load.
if (getSciVersion() >= SCI_VERSION_2)
g_sci->_gfxFrameout->clear();
#endif
s->reset(true);
s->saveLoadWithSerializer(ser); // FIXME: Error handling?
// Now copy all current state information
s->_segMan->reconstructStack(s);
s->_segMan->reconstructClones();
s->initGlobals();
s->gcCountDown = GC_INTERVAL - 1;
// Time state:
s->lastWaitTime = g_system->getMillis();
s->_screenUpdateTime = g_system->getMillis();
if (meta.version >= 34) {
g_sci->setTickCount(meta.playTime);
} else {
g_engine->setTotalPlayTime(meta.playTime * 1000);
}
if (g_sci->_gfxPorts)
g_sci->_gfxPorts->saveLoadWithSerializer(ser);
Vocabulary *voc = g_sci->getVocabulary();
if (ser.getVersion() >= 30 && voc)
voc->saveLoadWithSerializer(ser);
g_sci->_soundCmd->reconstructPlayList();
// Message state:
delete s->_msgState;
s->_msgState = new MessageState(s->_segMan);
// System strings:
s->_segMan->initSysStrings();
s->abortScriptProcessing = kAbortLoadGame;
// signal restored game to game scripts
s->gameIsRestarting = GAMEISRESTARTING_RESTORE;
}
bool get_savegame_metadata(Common::SeekableReadStream *stream, SavegameMetadata *meta) {
assert(stream);
assert(meta);
Common::Serializer ser(stream, 0);
sync_SavegameMetadata(ser, *meta);
if (stream->eos())
return false;
if ((meta->version < MINIMUM_SAVEGAME_VERSION) ||
(meta->version > CURRENT_SAVEGAME_VERSION)) {
if (meta->version < MINIMUM_SAVEGAME_VERSION)
warning("Old savegame version detected- can't load");
else
warning("Savegame version is %d- maximum supported is %0d", meta->version, CURRENT_SAVEGAME_VERSION);
return false;
}
return true;
}
} // End of namespace Sci
|