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
|
/* 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/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/state.h"
#include "sci/engine/message.h"
#include "sci/engine/savegame.h"
#include "sci/engine/vm_types.h"
#include "sci/engine/script.h" // for SCI_OBJ_EXPORTS and SCI_OBJ_SYNONYMS
#include "sci/graphics/gui.h"
#include "sci/graphics/ports.h"
#include "sci/sound/audio.h"
#ifdef USE_OLD_MUSIC_FUNCTIONS
#include "sci/sound/iterator/core.h"
#include "sci/sound/iterator/iterator.h"
#else
#include "sci/sound/music.h"
#endif
#ifdef ENABLE_SCI32
#include "sci/graphics/gui32.h"
#endif
namespace Sci {
#define VER(x) Common::Serializer::Version(x)
// OBSOLETE: This const is used for backward compatibility only.
const uint32 INTMAPPER_MAGIC_KEY = 0xDEADBEEF;
#ifdef USE_OLD_MUSIC_FUNCTIONS
// from ksound.cpp:
SongIterator *build_iterator(ResourceManager *resMan, int song_nr, SongIteratorType type, songit_id_t id);
#endif
#pragma mark -
// TODO: Many of the following sync_*() methods should be turned into member funcs
// of the classes they are syncing.
#ifdef USE_OLD_MUSIC_FUNCTIONS
static void sync_songlib(Common::Serializer &s, SongLibrary &obj);
#endif
static void sync_reg_t(Common::Serializer &s, reg_t &obj) {
s.syncAsUint16LE(obj.segment);
s.syncAsUint16LE(obj.offset);
}
#ifdef USE_OLD_MUSIC_FUNCTIONS
static void syncSong(Common::Serializer &s, Song &obj) {
s.syncAsSint32LE(obj._handle);
s.syncAsSint32LE(obj._resourceNum);
s.syncAsSint32LE(obj._priority);
s.syncAsSint32LE(obj._status);
s.syncAsSint32LE(obj._restoreBehavior);
s.syncAsSint32LE(obj._restoreTime);
s.syncAsSint32LE(obj._loops);
s.syncAsSint32LE(obj._hold);
if (s.isLoading()) {
obj._it = 0;
obj._delay = 0;
obj._next = 0;
obj._nextPlaying = 0;
obj._nextStopping = 0;
}
}
#else
#define DEFROBNICATE_HANDLE(handle) (make_reg((handle >> 16) & 0xffff, handle & 0xffff))
void MusicEntry::saveLoadWithSerializer(Common::Serializer &s) {
if (s.getVersion() < 14) {
// Old sound system data. This data is only loaded, never saved (as we're never
// saving in the older version format)
uint32 handle = 0;
s.syncAsSint32LE(handle);
soundObj = DEFROBNICATE_HANDLE(handle);
s.syncAsSint32LE(resnum);
s.syncAsSint32LE(prio);
s.syncAsSint32LE(status);
s.skip(4); // restoreBehavior
uint32 restoreTime = 0;
s.syncAsSint32LE(restoreTime);
ticker = restoreTime * 60 / 1000;
s.syncAsSint32LE(loop);
s.syncAsSint32LE(hold);
// volume and dataInc will be synced from the sound objects
// when the sound list is reconstructed in gamestate_restore()
volume = MUSIC_VOLUME_MAX;
dataInc = 0;
// No fading info
fadeTo = 0;
fadeStep = 0;
fadeTicker = 0;
fadeTickerStep = 0;
} else {
// A bit more optimized saving
sync_reg_t(s, soundObj);
s.syncAsSint16LE(resnum);
s.syncAsSint16LE(dataInc);
s.syncAsSint16LE(ticker);
s.syncAsSint16LE(signal, VER(17));
s.syncAsByte(prio);
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);
}
// pMidiParser and pStreamAud will be initialized when the
// sound list is reconstructed in gamestate_restore()
if (s.isLoading()) {
soundRes = 0;
pMidiParser = 0;
pStreamAud = 0;
}
}
#endif
// 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) {
sync_reg_t(s, obj);
}
void SegManager::saveLoadWithSerializer(Common::Serializer &s) {
s.skip(4, VER(9), VER(9)); // OBSOLETE: Used to be reserved_id
s.syncAsSint32LE(_exportsAreWide);
s.skip(4, VER(9), VER(9)); // OBSOLETE: Used to be gc_mark_bits
if (s.isLoading()) {
// Reset _scriptSegMap, to be restored below
_scriptSegMap.clear();
if (s.getVersion() <= 9) {
// OBSOLETE: Skip over the old id_seg_map when loading (we now
// regenerate the equivalent data, in _scriptSegMap, from scratch).
s.skip(4); // base_value
while (true) {
uint32 key = 0;
s.syncAsSint32LE(key);
if (key == INTMAPPER_MAGIC_KEY)
break;
s.skip(4); // idx
}
}
}
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 we were saving and mobj == 0, or if we are loading and this is an
// entry marked as empty -> skip to next
if (type == SEG_TYPE_INVALID) {
continue;
}
s.skip(4, VER(9), VER(9)); // OBSOLETE: Used to be _segManagerId
// Don't save or load HunkTable segments
if (type == SEG_TYPE_HUNK) {
continue;
}
// Handle the OBSOLETE type SEG_TYPE_STRING_FRAG -- just ignore it
if (s.isLoading() && type == SEG_TYPE_STRING_FRAG) {
continue;
}
if (s.isLoading()) {
mobj = SegmentObj::createSegmentObj(type);
}
assert(mobj);
// Let the object sync custom data
mobj->saveLoadWithSerializer(s);
// If we are loading a script, hook it up in the script->segment map.
if (s.isLoading() && type == SEG_TYPE_SCRIPT) {
_scriptSegMap[((Script *)mobj)->_nr] = i;
}
}
s.syncAsSint32LE(Clones_seg_id);
s.syncAsSint32LE(Lists_seg_id);
s.syncAsSint32LE(Nodes_seg_id);
}
static void sync_SegManagerPtr(Common::Serializer &s, SegManager *&obj) {
s.skip(1, VER(9), VER(9)); // obsolete: used to be a flag indicating if we got sci11 or not
if (s.isLoading())
obj->resetSegMan();
obj->saveLoadWithSerializer(s);
}
template <>
void syncWithSerializer(Common::Serializer &s, Class &obj) {
s.syncAsSint32LE(obj.script);
sync_reg_t(s, obj.reg);
}
static void sync_SavegameMetadata(Common::Serializer &s, SavegameMetadata &obj) {
// TODO: It would be a good idea to store a magic number & a header size here,
// so that we can implement backward compatibility if the savegame format changes.
s.syncString(obj.savegame_name);
s.syncVersion(CURRENT_SAVEGAME_VERSION);
obj.savegame_version = s.getVersion();
s.syncString(obj.game_version);
s.skip(4, VER(9), VER(9)); // obsolete: used to be game version
s.syncAsSint32LE(obj.savegame_date);
s.syncAsSint32LE(obj.savegame_time);
}
void EngineState::saveLoadWithSerializer(Common::Serializer &s) {
s.skip(4, VER(9), VER(9)); // OBSOLETE: Used to be savegame_version
Common::String tmp;
s.syncString(tmp); // OBSOLETE: Used to be game_version
s.skip(4, VER(9), VER(9)); // OBSOLETE: Used to be version
// OBSOLETE: Saved menus. Skip all of the saved data
if (s.getVersion() < 14) {
int totalMenus = 0;
s.syncAsUint32LE(totalMenus);
// Now iterate through the obsolete saved menu data
for (int i = 0; i < totalMenus; i++) {
s.syncString(tmp); // OBSOLETE: Used to be _title
s.skip(4, VER(12), VER(12)); // OBSOLETE: Used to be _titleWidth
s.skip(4, VER(12), VER(12)); // OBSOLETE: Used to be _width
int menuLength = 0;
s.syncAsUint32LE(menuLength);
for (int j = 0; j < menuLength; j++) {
s.skip(4, VER(12), VER(12)); // OBSOLETE: Used to be _type
s.syncString(tmp); // OBSOLETE: Used to be _keytext
s.skip(4, VER(9), VER(9)); // OBSOLETE: Used to be keytext_size
s.skip(4, VER(12), VER(12)); // OBSOLETE: Used to be _flags
s.skip(64, VER(12), VER(12)); // OBSOLETE: Used to be MENU_SAID_SPEC_SIZE
s.skip(4, VER(12), VER(12)); // OBSOLETE: Used to be _saidPos
s.syncString(tmp); // OBSOLETE: Used to be _text
s.skip(4, VER(12), VER(12)); // OBSOLETE: Used to be _textPos
s.skip(4 * 4, VER(12), VER(12)); // OBSOLETE: Used to be _modifiers, _key, _enabled and _tag
}
}
}
s.skip(4, VER(12), VER(12)); // obsolete: used to be status_bar_foreground
s.skip(4, VER(12), VER(12)); // obsolete: used to be status_bar_background
if (s.getVersion() >= 13 && g_sci->_gui) {
// Save/Load picPort as well (cause sierra sci also does this)
int16 picPortTop, picPortLeft;
Common::Rect picPortRect;
if (s.isSaving()) {
// FIXME: _gfxPorts is 0 when using SCI32 code
assert(g_sci->_gfxPorts);
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);
}
sync_SegManagerPtr(s, _segMan);
syncArray<Class>(s, _segMan->_classtable);
#ifdef USE_OLD_MUSIC_FUNCTIONS
sync_songlib(s, _sound._songlib);
#else
_soundCmd->syncPlayList(s);
#endif
}
void LocalVariables::saveLoadWithSerializer(Common::Serializer &s) {
s.syncAsSint32LE(script_id);
syncArray<reg_t>(s, _locals);
}
void Object::saveLoadWithSerializer(Common::Serializer &s) {
s.syncAsSint32LE(_flags);
sync_reg_t(s, _pos);
s.skip(4, VER(9), VER(12)); // OBSOLETE: Used to be variable_names_nr
s.syncAsSint32LE(_methodCount); // that's actually a uint16
syncArray<reg_t>(s, _variables);
}
template <>
void syncWithSerializer(Common::Serializer &s, Table<Clone>::Entry &obj) {
s.syncAsSint32LE(obj.next_free);
syncWithSerializer<Object>(s, obj);
}
template <>
void syncWithSerializer(Common::Serializer &s, Table<List>::Entry &obj) {
s.syncAsSint32LE(obj.next_free);
sync_reg_t(s, obj.first);
sync_reg_t(s, obj.last);
}
template <>
void syncWithSerializer(Common::Serializer &s, Table<Node>::Entry &obj) {
s.syncAsSint32LE(obj.next_free);
sync_reg_t(s, obj.pred);
sync_reg_t(s, obj.succ);
sync_reg_t(s, obj.key);
sync_reg_t(s, obj.value);
}
#ifdef ENABLE_SCI32
template <>
void syncWithSerializer(Common::Serializer &s, Table<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);
} else {
s.syncAsByte(type);
s.syncAsUint32LE(size);
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);
sync_reg_t(s, value);
if (s.isLoading())
obj.setValue(i, value);
}
}
template <>
void syncWithSerializer(Common::Serializer &s, Table<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;
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::saveLoadWithSerializer(Common::Serializer &s) {
s.syncAsSint32LE(_nr);
s.syncAsUint32LE(_bufSize);
s.syncAsUint32LE(_scriptSize);
s.syncAsUint32LE(_heapSize);
if (s.getVersion() <= 10) {
assert((s.isLoading()));
// OBSOLETE: Skip over the old _objIndices data when loading
s.skip(4); // base_value
while (true) {
uint32 key = 0;
s.syncAsSint32LE(key);
if (key == INTMAPPER_MAGIC_KEY)
break;
s.skip(4); // idx
}
}
s.syncAsSint32LE(_numExports);
s.syncAsSint32LE(_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<Object>(s, tmp);
_objects[tmp.getPos().offset] = tmp;
}
} else {
ObjMap::iterator it;
const ObjMap::iterator end = _objects.end();
for (it = _objects.begin(); it != end; ++it) {
syncWithSerializer<Object>(s, it->_value);
}
}
s.syncAsSint32LE(_localsOffset);
s.syncAsSint32LE(_localsSegment);
s.syncAsSint32LE(_markedAsDeleted);
}
static void sync_SystemString(Common::Serializer &s, SystemString &obj) {
s.syncString(obj._name);
s.syncAsSint32LE(obj._maxSize);
// Sync obj._value. We cannot use syncCStr as we must make sure that
// the allocated buffer has the correct size, i.e., obj._maxSize
Common::String tmp;
if (s.isSaving() && obj._value)
tmp = obj._value;
s.syncString(tmp);
if (s.isLoading()) {
//free(*str);
obj._value = (char *)calloc(obj._maxSize, sizeof(char));
strncpy(obj._value, tmp.c_str(), obj._maxSize);
}
}
void SystemStrings::saveLoadWithSerializer(Common::Serializer &s) {
for (int i = 0; i < SYS_STRINGS_MAX; ++i)
sync_SystemString(s, _strings[i]);
}
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 -
#ifdef USE_OLD_MUSIC_FUNCTIONS
static void sync_songlib(Common::Serializer &s, SongLibrary &obj) {
int songcount = 0;
if (s.isSaving())
songcount = obj.countSongs();
s.syncAsUint32LE(songcount);
if (s.isLoading()) {
obj._lib = 0;
while (songcount--) {
Song *newsong = new Song;
syncSong(s, *newsong);
obj.addSong(newsong);
}
} else {
Song *seeker = obj._lib;
while (seeker) {
seeker->_restoreTime = seeker->_it->getTimepos();
syncSong(s, *seeker);
seeker = seeker->_next;
}
}
}
#else
void SciMusic::saveLoadWithSerializer(Common::Serializer &s) {
// Sync song lib data. When loading, the actual song lib will be initialized
// afterwards in gamestate_restore()
Common::StackLock lock(_mutex);
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);
setReverb(reverb);
}
if (s.isSaving())
songcount = _playList.size();
s.syncAsUint32LE(songcount);
if (s.isLoading()) {
clearPlayList();
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);
}
}
}
#endif
#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
#pragma mark -
int gamestate_save(EngineState *s, Common::WriteStream *fh, const char* savename, const char *version) {
TimeDate curTime;
g_system->getTimeAndDate(curTime);
SavegameMetadata meta;
meta.savegame_version = CURRENT_SAVEGAME_VERSION;
meta.savegame_name = savename;
meta.game_version = version;
meta.savegame_date = ((curTime.tm_mday & 0xFF) << 24) | (((curTime.tm_mon + 1) & 0xFF) << 16) | ((curTime.tm_year + 1900) & 0xFFFF);
meta.savegame_time = ((curTime.tm_hour & 0xFF) << 16) | (((curTime.tm_min) & 0xFF) << 8) | ((curTime.tm_sec) & 0xFF);
if (s->execution_stack_base) {
warning("Cannot save from below kernel function");
return 1;
}
/*
if (s->sound_server) {
if ((s->sound_server->save)(s, dirname)) {
warning("Saving failed for the sound subsystem");
//chdir("..");
return 1;
}
}
*/
Common::Serializer ser(0, fh);
sync_SavegameMetadata(ser, meta);
Graphics::saveThumbnail(*fh);
s->saveLoadWithSerializer(ser); // FIXME: Error handling?
return 0;
}
static byte *find_unique_script_block(EngineState *s, byte *buf, int type) {
bool oldScriptHeader = (getSciVersion() == SCI_VERSION_0_EARLY);
if (oldScriptHeader)
buf += 2;
do {
int seeker_type = READ_LE_UINT16(buf);
if (seeker_type == 0) break;
if (seeker_type == type) return buf;
int seeker_size = READ_LE_UINT16(buf + 2);
assert(seeker_size > 0);
buf += seeker_size;
} while (1);
return NULL;
}
// TODO: This should probably be turned into an EngineState or DataStack method.
static void reconstruct_stack(EngineState *retval) {
SegmentId stack_seg = retval->_segMan->findSegmentByType(SEG_TYPE_STACK);
DataStack *stack = (DataStack *)(retval->_segMan->_heap[stack_seg]);
retval->stack_base = stack->_entries;
retval->stack_top = stack->_entries + stack->_capacity;
}
static void load_script(EngineState *s, Script *scr) {
scr->_buf = (byte *)malloc(scr->_bufSize);
assert(scr->_buf);
Resource *script = g_sci->getResMan()->findResource(ResourceId(kResourceTypeScript, scr->_nr), 0);
assert(script != 0);
assert(scr->_bufSize >= script->size);
memcpy(scr->_buf, script->data, script->size);
if (getSciVersion() >= SCI_VERSION_1_1) {
Resource *heap = g_sci->getResMan()->findResource(ResourceId(kResourceTypeHeap, scr->_nr), 0);
assert(heap != 0);
scr->_heapStart = scr->_buf + scr->_scriptSize;
assert(scr->_bufSize - scr->_scriptSize <= heap->size);
memcpy(scr->_heapStart, heap->data, heap->size);
}
}
// TODO: Move thie function to a more appropriate place, such as vm.cpp or script.cpp
void SegManager::reconstructScripts(EngineState *s) {
uint i;
SegmentObj *mobj;
for (i = 0; i < _heap.size(); i++) {
mobj = _heap[i];
if (!mobj || mobj->getType() != SEG_TYPE_SCRIPT)
continue;
Script *scr = (Script *)mobj;
// FIXME: Unify this code with script_instantiate_* ?
load_script(s, scr);
scr->_localsBlock = (scr->_localsSegment == 0) ? NULL : (LocalVariables *)(_heap[scr->_localsSegment]);
if (getSciVersion() >= SCI_VERSION_1_1) {
scr->_exportTable = 0;
scr->_synonyms = 0;
if (READ_LE_UINT16(scr->_buf + 6) > 0) {
scr->setExportTableOffset(6);
s->_segMan->scriptRelocateExportsSci11(i);
}
} else {
scr->_exportTable = (uint16 *) find_unique_script_block(s, scr->_buf, SCI_OBJ_EXPORTS);
scr->_synonyms = find_unique_script_block(s, scr->_buf, SCI_OBJ_SYNONYMS);
scr->_exportTable += 3;
}
scr->_codeBlocks.clear();
ObjMap::iterator it;
const ObjMap::iterator end = scr->_objects.end();
for (it = scr->_objects.begin(); it != end; ++it) {
byte *data = scr->_buf + it->_value.getPos().offset;
it->_value._baseObj = data;
}
}
for (i = 0; i < _heap.size(); i++) {
mobj = _heap[i];
if (!mobj || mobj->getType() != SEG_TYPE_SCRIPT)
continue;
Script *scr = (Script *)mobj;
// FIXME: Unify this code with Script::scriptObjInit ?
ObjMap::iterator it;
const ObjMap::iterator end = scr->_objects.end();
for (it = scr->_objects.begin(); it != end; ++it) {
byte *data = scr->_buf + it->_value.getPos().offset;
if (getSciVersion() >= SCI_VERSION_1_1) {
uint16 *funct_area = (uint16 *)(scr->_buf + READ_LE_UINT16( data + 6 ));
uint16 *prop_area = (uint16 *)(scr->_buf + READ_LE_UINT16( data + 4 ));
it->_value._baseMethod = funct_area;
it->_value._baseVars = prop_area;
} else {
int funct_area = READ_LE_UINT16(data + SCRIPT_FUNCTAREAPTR_OFFSET);
Object *_baseObj;
_baseObj = s->_segMan->getObject(it->_value.getSpeciesSelector());
if (!_baseObj) {
warning("Object without a base class: Script %d, index %d (reg address %04x:%04x",
scr->_nr, i, PRINT_REG(it->_value.getSpeciesSelector()));
continue;
}
it->_value.setVarCount(_baseObj->getVarCount());
it->_value._baseObj = _baseObj->_baseObj;
it->_value._baseMethod = (uint16 *)(data + funct_area);
it->_value._baseVars = (uint16 *)(data + it->_value.getVarCount() * 2 + SCRIPT_SELECTOR_OFFSET);
}
}
}
}
#ifdef USE_OLD_MUSIC_FUNCTIONS
static void reconstruct_sounds(EngineState *s) {
Song *seeker;
SongIteratorType it_type;
if (getSciVersion() > SCI_VERSION_01)
it_type = SCI_SONG_ITERATOR_TYPE_SCI1;
else
it_type = SCI_SONG_ITERATOR_TYPE_SCI0;
seeker = s->_sound._songlib._lib;
while (seeker) {
SongIterator *base, *ff = 0;
int oldstatus;
SongIterator::Message msg;
base = ff = build_iterator(g_sci->getResMan(), seeker->_resourceNum, it_type, seeker->_handle);
if (seeker->_restoreBehavior == RESTORE_BEHAVIOR_CONTINUE)
ff = new_fast_forward_iterator(base, seeker->_restoreTime);
ff->init();
msg = SongIterator::Message(seeker->_handle, SIMSG_SET_LOOPS(seeker->_loops));
songit_handle_message(&ff, msg);
msg = SongIterator::Message(seeker->_handle, SIMSG_SET_HOLD(seeker->_hold));
songit_handle_message(&ff, msg);
oldstatus = seeker->_status;
seeker->_status = SOUND_STATUS_STOPPED;
seeker->_it = ff;
s->_sound.sfx_song_set_status(seeker->_handle, oldstatus);
seeker = seeker->_next;
}
}
#endif
void gamestate_restore(EngineState *s, Common::SeekableReadStream *fh) {
EngineState *retval;
#ifdef USE_OLD_MUSIC_FUNCTIONS
SongLibrary temp;
#endif
SavegameMetadata meta;
Common::Serializer ser(fh, 0);
sync_SavegameMetadata(ser, meta);
if (fh->eos()) {
s->r_acc = make_reg(0, 1); // signal failure
return;
}
if ((meta.savegame_version < MINIMUM_SAVEGAME_VERSION) ||
(meta.savegame_version > CURRENT_SAVEGAME_VERSION)) {
if (meta.savegame_version < MINIMUM_SAVEGAME_VERSION)
warning("Old savegame version detected- can't load");
else
warning("Savegame version is %d- maximum supported is %0d", meta.savegame_version, CURRENT_SAVEGAME_VERSION);
s->r_acc = make_reg(0, 1); // signal failure
return;
}
if (meta.savegame_version >= 12) {
// We don't need the thumbnail here, so just read it and discard it
Graphics::Surface *thumbnail = new Graphics::Surface();
assert(thumbnail);
Graphics::loadThumbnail(*fh, *thumbnail);
delete thumbnail;
thumbnail = 0;
}
// Create a new EngineState object
retval = new EngineState(s->_voc, s->_segMan, s->_audio);
retval->_event = new SciEvent();
// Copy some old data
retval->_soundCmd = s->_soundCmd;
// Copy memory segment
retval->_memorySegmentSize = s->_memorySegmentSize;
memcpy(retval->_memorySegment, s->_memorySegment, s->_memorySegmentSize);
retval->saveLoadWithSerializer(ser); // FIXME: Error handling?
#ifdef USE_OLD_MUSIC_FUNCTIONS
s->_sound.sfx_exit();
#endif
// Set exec stack base to zero
retval->execution_stack_base = 0;
// Now copy all current state information
#ifdef USE_OLD_MUSIC_FUNCTIONS
temp = retval->_sound._songlib;
retval->_sound.sfx_init(g_sci->getResMan(), s->sfx_init_flags, g_sci->_features->detectDoSoundType());
retval->sfx_init_flags = s->sfx_init_flags;
retval->_sound._songlib.freeSounds();
retval->_sound._songlib = temp;
retval->_soundCmd->updateSfxState(&retval->_sound);
#endif
reconstruct_stack(retval);
retval->_segMan->reconstructScripts(retval);
retval->_segMan->reconstructClones();
retval->_gameObj = s->_gameObj;
retval->script_000 = retval->_segMan->getScript(retval->_segMan->getScriptSegment(0, SCRIPT_GET_DONT_LOAD));
retval->gc_countdown = GC_INTERVAL - 1;
retval->sys_strings_segment = retval->_segMan->findSegmentByType(SEG_TYPE_SYS_STRINGS);
retval->sys_strings = (SystemStrings *)(retval->_segMan->_heap[retval->sys_strings_segment]);
// Time state:
retval->last_wait_time = g_system->getMillis();
retval->game_start_time = g_system->getMillis();
// static parser information:
if (retval->_voc)
retval->_voc->parser_base = make_reg(s->sys_strings_segment, SYS_STRING_PARSER_BASE);
// Copy breakpoint information from current game instance
retval->_breakpoints = s->_breakpoints;
retval->_activeBreakpointTypes = s->_activeBreakpointTypes;
retval->successor = NULL;
retval->_gameId = s->_gameId;
#ifdef USE_OLD_MUSIC_FUNCTIONS
retval->_sound._it = NULL;
retval->_sound._flags = s->_sound._flags;
retval->_sound._song = NULL;
retval->_sound._suspended = s->_sound._suspended;
reconstruct_sounds(retval);
#else
retval->_soundCmd->reconstructPlayList(meta.savegame_version);
#endif
// Message state:
retval->_msgState = new MessageState(retval->_segMan);
#ifdef ENABLE_SCI32
if (g_sci->_gui32) {
g_sci->_gui32->resetEngineState(retval);
g_sci->_gui32->init();
} else {
#endif
g_sci->_gui->resetEngineState(retval);
g_sci->_gui->init(g_sci->_features->usesOldGfxFunctions());
#ifdef ENABLE_SCI32
}
#endif
s->successor = retval; // Set successor
script_abort_flag = 2; // Abort current game with replay
shrink_execution_stack(s, s->execution_stack_base + 1);
}
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->savegame_version < MINIMUM_SAVEGAME_VERSION) ||
(meta->savegame_version > CURRENT_SAVEGAME_VERSION)) {
if (meta->savegame_version < MINIMUM_SAVEGAME_VERSION)
warning("Old savegame version detected- can't load");
else
warning("Savegame version is %d- maximum supported is %0d", meta->savegame_version, CURRENT_SAVEGAME_VERSION);
return false;
}
return true;
}
} // End of namespace Sci
|