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
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
|
/* 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.
*
*/
// Disable symbol overrides so that we can use system headers.
#define FORBIDDEN_SYMBOL_ALLOW_ALL
// HACK to allow building with the SDL backend on MinGW
// see bug #1800764 "TOOLS: MinGW tools building broken"
#ifdef main
#undef main
#endif // main
#include "create_kyradat.h"
#include "search.h"
#include "pak.h"
#include "tables.h"
#include "extract.h"
#include "md5.h"
#include <string>
#include <map>
#include <algorithm>
#include <map>
enum {
kKyraDatVersion = 78
};
const ExtractFilename extractFilenames[] = {
// GENERIC ID MAP
{ kIdMap, -1, true },
// INTRO / OUTRO sequences
{ k1ForestSeq, kTypeForestSeqData, false },
{ k1KallakWritingSeq, kTypeRawData, false },
{ k1KyrandiaLogoSeq, kTypeRawData, false },
{ k1KallakMalcolmSeq, kTypeRawData, false },
{ k1MalcolmTreeSeq, kTypeRawData, false },
{ k1WestwoodLogoSeq, kTypeRawData, false },
{ k1Demo1Seq, kTypeRawData, false },
{ k1Demo2Seq, kTypeRawData, false },
{ k1Demo3Seq, kTypeRawData, false },
{ k1Demo4Seq, kTypeRawData, false },
{ k1OutroReunionSeq, kTypeRawData, false },
// INTRO / OUTRO strings
{ k1IntroCPSStrings, kTypeStringList, false },
{ k1IntroCOLStrings, kTypeStringList, false },
{ k1IntroWSAStrings, kTypeStringList, false },
{ k1IntroStrings, kTypeStringList, true },
{ k1OutroHomeString, kTypeStringList, true },
// INGAME strings
{ k1ItemNames, kTypeStringList, true },
{ k1TakenStrings, kTypeStringList, true },
{ k1PlacedStrings, kTypeStringList, true },
{ k1DroppedStrings, kTypeStringList, true },
{ k1NoDropStrings, kTypeStringList, true },
{ k1PutDownString, kTypeStringList, true },
{ k1WaitAmuletString, kTypeStringList, true },
{ k1BlackJewelString, kTypeStringList, true },
{ k1PoisonGoneString, kTypeStringList, true },
{ k1HealingTipString, kTypeStringList, true },
{ k1ThePoisonStrings, kTypeStringList, true },
{ k1FluteStrings, kTypeStringList, true },
{ k1WispJewelStrings, kTypeStringList, true },
{ k1MagicJewelStrings, kTypeStringList, true },
{ k1FlaskFullString, kTypeStringList, true },
{ k1FullFlaskString, kTypeStringList, true },
{ k1VeryCleverString, kTypeStringList, true },
{ k1NewGameString, kTypeStringList, true },
// GUI strings table
{ k1GUIStrings, kTypeStringList, true },
{ k1ConfigStrings, kTypeStringList, true },
// ROOM table/filenames
{ k1RoomList, kTypeRoomList, false },
{ k1RoomFilenames, kTypeStringList, false },
// SHAPE tables
{ k1DefaultShapes, kTypeShapeList, false },
{ k1Healing1Shapes, kTypeShapeList, false },
{ k1Healing2Shapes, kTypeShapeList, false },
{ k1PoisonDeathShapes, kTypeShapeList, false },
{ k1FluteShapes, kTypeShapeList, false },
{ k1Winter1Shapes, kTypeShapeList, false },
{ k1Winter2Shapes, kTypeShapeList, false },
{ k1Winter3Shapes, kTypeShapeList, false },
{ k1DrinkShapes, kTypeShapeList, false },
{ k1WispShapes, kTypeShapeList, false },
{ k1MagicAnimShapes, kTypeShapeList, false },
{ k1BranStoneShapes, kTypeShapeList, false },
// IMAGE filename table
{ k1CharacterImageFilenames, kTypeStringList, false },
// AUDIO filename table
{ k1AudioTracks, kTypeStringList, false },
{ k1AudioTracks2, kTypeStringList, false },
{ k1AudioTracksIntro, kTypeStringList, false },
// AMULET anim
{ k1AmuleteAnimSeq, kTypeRawData, false },
// PALETTE table
{ k1SpecialPalette1, kTypeRawData, false },
{ k1SpecialPalette2, kTypeRawData, false },
{ k1SpecialPalette3, kTypeRawData, false },
{ k1SpecialPalette4, kTypeRawData, false },
{ k1SpecialPalette5, kTypeRawData, false },
{ k1SpecialPalette6, kTypeRawData, false },
{ k1SpecialPalette7, kTypeRawData, false },
{ k1SpecialPalette8, kTypeRawData, false },
{ k1SpecialPalette9, kTypeRawData, false },
{ k1SpecialPalette10, kTypeRawData, false },
{ k1SpecialPalette11, kTypeRawData, false },
{ k1SpecialPalette12, kTypeRawData, false },
{ k1SpecialPalette13, kTypeRawData, false },
{ k1SpecialPalette14, kTypeRawData, false },
{ k1SpecialPalette15, kTypeRawData, false },
{ k1SpecialPalette16, kTypeRawData, false },
{ k1SpecialPalette17, kTypeRawData, false },
{ k1SpecialPalette18, kTypeRawData, false },
{ k1SpecialPalette19, kTypeRawData, false },
{ k1SpecialPalette20, kTypeRawData, false },
{ k1SpecialPalette21, kTypeRawData, false },
{ k1SpecialPalette22, kTypeRawData, false },
{ k1SpecialPalette23, kTypeRawData, false },
{ k1SpecialPalette24, kTypeRawData, false },
{ k1SpecialPalette25, kTypeRawData, false },
{ k1SpecialPalette26, kTypeRawData, false },
{ k1SpecialPalette27, kTypeRawData, false },
{ k1SpecialPalette28, kTypeRawData, false },
{ k1SpecialPalette29, kTypeRawData, false },
{ k1SpecialPalette30, kTypeRawData, false },
{ k1SpecialPalette31, kTypeRawData, false },
{ k1SpecialPalette32, kTypeRawData, false },
{ k1SpecialPalette33, kTypeRawData, false },
// CREDITS (used in FM-TOWNS and AMIGA)
{ k1CreditsStrings, kTypeRawData, true },
// FM-TOWNS specific
{ k1TownsMusicFadeTable, k3TypeRaw16to8, false },
{ k1TownsSFXwdTable, kTypeTownsWDSfxTable, false },
{ k1TownsSFXbtTable, kTypeRawData, false },
{ k1TownsCDATable, kTypeRawData, false },
// PC98 specific
{ k1PC98StoryStrings, kTypeStringList, true },
{ k1PC98IntroSfx, kTypeRawData, false },
// AMIGA specific
{ k1AmigaIntroSFXTable, kTypeAmigaSfxTable, false },
{ k1AmigaGameSFXTable, kTypeAmigaSfxTable, false },
// HAND OF FATE
// Sequence Player
{ k2SeqplayPakFiles, kTypeStringList, false },
{ k2SeqplayCredits, kTypeRawData, false },
{ k2SeqplayCreditsSpecial, kTypeStringList, false },
{ k2SeqplayStrings, kTypeStringList, true },
{ k2SeqplaySfxFiles, k2TypeSoundList, false },
{ k2SeqplayTlkFiles, k2TypeLangSoundList, true },
{ k2SeqplaySeqData, k2TypeSeqData, false },
{ k2SeqplayIntroTracks, kTypeStringList, false },
{ k2SeqplayFinaleTracks, kTypeStringList, false },
{ k2SeqplayIntroCDA, kTypeRawData, false },
{ k2SeqplayFinaleCDA, kTypeRawData, false },
{ k2SeqplayShapeAnimData, k2TypeShpDataV1, false },
// Ingame
{ k2IngamePakFiles, kTypeStringList, false },
{ k2IngameSfxFiles, k2TypeSize10StringList, false },
{ k2IngameSfxIndex, kTypeRawData, false },
{ k2IngameTracks, kTypeStringList, false },
{ k2IngameCDA, kTypeRawData, false },
{ k2IngameTalkObjIndex, kTypeRawData, false },
{ k2IngameTimJpStrings, kTypeStringList, false },
{ k2IngameShapeAnimData, k2TypeShpDataV2, false },
{ k2IngameTlkDemoStrings, kTypeStringList, true },
// MALCOLM'S REVENGE
{ k3MainMenuStrings, kTypeStringList, false },
{ k3MusicFiles, k2TypeSoundList, false },
{ k3ScoreTable, kTypeRawData, false },
{ k3SfxFiles, k2TypeSfxList, false },
{ k3SfxMap, k3TypeRaw16to8, false },
{ k3ItemAnimData, k3TypeShpData, false },
{ k3ItemMagicTable, k3TypeRaw16to8, false },
{ k3ItemStringMap, kTypeRawData, false },
// LANDS OF LORE
// Ingame
{ kLolIngamePakFiles, kTypeStringList, false },
{ kLolCharacterDefs, kLolTypeCharData, true },
{ kLolIngameSfxFiles, k2TypeSfxList, false },
{ kLolIngameSfxIndex, kTypeRawData, false },
{ kLolMusicTrackMap, kTypeRawData, false },
{ kLolIngameGMSfxIndex, kTypeRawData, false },
{ kLolIngameMT32SfxIndex, kTypeRawData, false },
{ kLolIngamePcSpkSfxIndex, kTypeRawData, false },
{ kLolSpellProperties, kLolTypeSpellData, false },
{ kLolGameShapeMap, kTypeRawData, false },
{ kLolSceneItemOffs, kTypeRawData, false },
{ kLolCharInvIndex, k3TypeRaw16to8, false },
{ kLolCharInvDefs, kTypeRawData, false },
{ kLolCharDefsMan, kLolTypeRaw16, false },
{ kLolCharDefsWoman, kLolTypeRaw16, false },
{ kLolCharDefsKieran, kLolTypeRaw16, false },
{ kLolCharDefsAkshel, kLolTypeRaw16, false },
{ kLolExpRequirements, kLolTypeRaw32, false },
{ kLolMonsterModifiers, kLolTypeRaw16, false },
{ kLolMonsterShiftOffsets, kTypeRawData, false },
{ kLolMonsterDirFlags, kTypeRawData, false },
{ kLolMonsterScaleY, kTypeRawData, false },
{ kLolMonsterScaleX, kTypeRawData, false },
{ kLolMonsterScaleWH, kLolTypeRaw16, false },
{ kLolFlyingObjectShp, kLolTypeFlightShpData, false },
{ kLolInventoryDesc, kLolTypeRaw16, false },
{ kLolLevelShpList, kTypeStringList, false },
{ kLolLevelDatList, kTypeStringList, false },
{ kLolCompassDefs, kLolTypeCompassData, false },
{ kLolItemPrices, kLolTypeRaw16, false },
{ kLolStashSetup, kTypeRawData, false },
{ kLolDscUnk1, kTypeRawData, false },
{ kLolDscShapeIndex, kTypeRawData, false },
{ kLolDscOvlMap, kTypeRawData, false },
{ kLolDscScaleWidthData, kLolTypeRaw16, false },
{ kLolDscScaleHeightData, kLolTypeRaw16, false },
{ kLolDscX, kLolTypeRaw16, false },
{ kLolDscY, kTypeRawData, false },
{ kLolDscTileIndex, kTypeRawData, false },
{ kLolDscUnk2, kTypeRawData, false },
{ kLolDscDoorShapeIndex, kTypeRawData, false },
{ kLolDscDimData1, kTypeRawData, false },
{ kLolDscDimData2, kTypeRawData, false },
{ kLolDscBlockMap, kTypeRawData, false },
{ kLolDscDimMap, kTypeRawData, false },
{ kLolDscDoorScale, kLolTypeRaw16, false },
{ kLolDscOvlIndex, k3TypeRaw16to8, false },
{ kLolDscBlockIndex, kTypeRawData, false },
{ kLolDscDoor4, kLolTypeRaw16, false },
{ kLolDscDoor1, kTypeRawData, false },
{ kLolDscDoorX, kLolTypeRaw16, false },
{ kLolDscDoorY, kLolTypeRaw16, false },
{ kLolScrollXTop, k3TypeRaw16to8, false },
{ kLolScrollYTop, k3TypeRaw16to8, false },
{ kLolScrollXBottom, k3TypeRaw16to8, false },
{ kLolScrollYBottom, k3TypeRaw16to8, false },
{ kLolButtonDefs, kLolTypeButtonDef, false },
{ kLolButtonList1, kLolTypeRaw16, false },
{ kLolButtonList2, kLolTypeRaw16, false },
{ kLolButtonList3, kLolTypeRaw16, false },
{ kLolButtonList4, kLolTypeRaw16, false },
{ kLolButtonList5, kLolTypeRaw16, false },
{ kLolButtonList6, kLolTypeRaw16, false },
{ kLolButtonList7, kLolTypeRaw16, false },
{ kLolButtonList8, kLolTypeRaw16, false },
{ kLolLegendData, kTypeRawData, false },
{ kLolMapCursorOvl, kTypeRawData, false },
{ kLolMapStringId, kLolTypeRaw16, false },
{ kLolSpellbookAnim, k3TypeRaw16to8, false },
{ kLolSpellbookCoords, k3TypeRaw16to8, false },
{ kLolHealShapeFrames, kTypeRawData, false },
{ kLolLightningDefs, kTypeRawData, false },
{ kLolFireballCoords, kLolTypeRaw16, false },
{ kLolCredits, kTypeRawData, false },
{ kLolHistory, kTypeRawData, false },
{ -1, 0, 0 }
};
const ExtractFilename *getFilenameDesc(const int id) {
for (const ExtractFilename *i = extractFilenames; i->id != -1; ++i) {
if (i->id == id)
return i;
}
return 0;
}
bool isLangSpecific(const int id) {
const ExtractFilename *desc = getFilenameDesc(id);
if (!desc)
return false;
return desc->langSpecific;
}
// misc tables
const TypeTable gameTable[] = {
{ kKyra1, 0 },
{ kKyra2, 1 },
{ kKyra3, 2 },
{ kLol, 3 },
{ -1, -1 }
};
byte getGameID(int game) {
return std::find(gameTable, ARRAYEND(gameTable) - 1, game)->value;
}
const TypeTable languageTable[] = {
{ UNK_LANG, 0 },
{ EN_ANY, 1 },
{ FR_FRA, 2 },
{ DE_DEU, 3 },
{ ES_ESP, 4 },
{ IT_ITA, 5 },
{ JA_JPN, 6 },
{ RU_RUS, 7 },
{ -1, -1 }
};
byte getLanguageID(int lang) {
return std::find(languageTable, ARRAYEND(languageTable) - 1, lang)->value;
}
const TypeTable platformTable[] = {
{ kPlatformPC, 0 },
{ kPlatformAmiga, 1 },
{ kPlatformFMTowns, 2 },
{ kPlatformPC98, 3 },
{ kPlatformMacintosh, 4 },
{ -1, -1 }
};
byte getPlatformID(int platform) {
return std::find(platformTable, ARRAYEND(platformTable) - 1, platform)->value;
}
const TypeTable specialTable[] = {
{ kNoSpecial, 0 },
{ kTalkieVersion, 1 },
{ kDemoVersion, 2 },
{ kTalkieDemoVersion, 3 },
{ kOldFloppy, 4 },
{ -1, -1 }
};
byte getSpecialID(int special) {
return std::find(specialTable, ARRAYEND(specialTable) - 1, special)->value;
}
// filename processing
uint32 getFilename(const ExtractInformation *info, const int id) {
const ExtractFilename *fDesc = getFilenameDesc(id);
if (!fDesc)
return 0;
// GAME, PLATFORM, SPECIAL, ID, LANG
return ((getGameID(info->game) & 0xF) << 24) |
((getPlatformID(info->platform) & 0xF) << 20) |
((getSpecialID(info->special) & 0xF) << 16) |
((id & 0xFFF) << 4) |
((getLanguageID(fDesc->langSpecific ? info->lang : UNK_LANG) & 0xF) << 0);
}
// TODO: Get rid of this
bool getFilename(char *dstFilename, const ExtractInformation *info, const int id) {
sprintf(dstFilename, "%08X", getFilename(info, id));
return true;
}
// index generation
typedef uint16 GameDef;
GameDef createGameDef(const ExtractInformation *eI) {
return ((getGameID(eI->game) & 0xF) << 12) |
((getPlatformID(eI->platform) & 0xF) << 8) |
((getSpecialID(eI->special) & 0xF) << 4) |
((getLanguageID(eI->lang) & 0xF) << 0);
}
struct Index {
Index() : version(0), includedGames(0), gameList() {}
uint32 version;
uint32 includedGames;
typedef std::list<GameDef> GameList;
GameList gameList;
};
Index parseIndex(const uint8 *data, uint32 size) {
Index result;
if (size < 8)
return result;
result.version = READ_BE_UINT32(data); data += 4;
result.includedGames = READ_BE_UINT32(data); data += 4;
if (result.includedGames * 2 + 8 != size) {
result.version = result.includedGames = 0;
return result;
}
for (uint32 i = 0; i < result.includedGames; ++i) {
GameDef game = READ_BE_UINT16(data); data += 2;
result.gameList.push_back(game);
}
return result;
}
bool updateIndex(PAKFile &out, const ExtractInformation *eI) {
uint32 size = 0;
const uint8 *data = out.getFileData("INDEX", &size);
Index index;
if (data)
index = parseIndex(data, size);
GameDef gameDef = createGameDef(eI);
if (index.version == kKyraDatVersion) {
if (std::find(index.gameList.begin(), index.gameList.end(), gameDef) == index.gameList.end()) {
++index.includedGames;
index.gameList.push_back(gameDef);
} else {
// Already included in the game list, thus we do not need any further processing here.
return true;
}
} else {
index.version = kKyraDatVersion;
index.includedGames = 1;
index.gameList.push_back(gameDef);
}
const uint32 indexBufferSize = 8 + index.includedGames * 2;
uint8 *indexBuffer = new uint8[indexBufferSize];
assert(indexBuffer);
uint8 *dst = indexBuffer;
WRITE_BE_UINT32(dst, index.version); dst += 4;
WRITE_BE_UINT32(dst, index.includedGames); dst += 4;
for (Index::GameList::const_iterator i = index.gameList.begin(); i != index.gameList.end(); ++i) {
WRITE_BE_UINT16(dst, *i); dst += 2;
}
out.removeFile("INDEX");
if (!out.addFile("INDEX", indexBuffer, indexBufferSize)) {
fprintf(stderr, "ERROR: couldn't update kyra.dat INDEX\n");
delete[] indexBuffer;
return false;
}
return true;
}
bool checkIndex(PAKFile &file) {
uint32 size = 0;
const uint8 *data = file.getFileData("INDEX", &size);
if (!data)
return false;
Index index = parseIndex(data, size);
if (index.version != kKyraDatVersion)
return false;
if (index.includedGames * 2 + 8 != size)
return false;
return true;
}
// main processing
void printHelp(const char *f) {
printf("Usage:\n");
printf("%s output inputfiles ...\n", f);
}
bool process(PAKFile &out, const Game *g, const byte *data, const uint32 size);
const Game *findGame(const byte *buffer, const uint32 size);
typedef std::map<std::string, std::string> MD5Map;
MD5Map createMD5Sums(int files, const char * const *filenames);
struct File {
File() : data(0), size(0) {}
File(uint8 *d, uint32 s) : data(d), size(s) {}
uint8 *data;
uint32 size;
};
typedef std::map<const Game *, File> GameMap;
GameMap createGameMap(const MD5Map &map);
int main(int argc, char *argv[]) {
if (argc < 3) {
printHelp(argv[0]);
return -1;
}
// Special case for developer mode of this tool:
// With "--create filename offset size" the tool will output
// a search entry for the specifed data in the specified file.
if (!strcmp(argv[1], "--create")) {
if (argc < 5) {
printf("Developer usage: %s --create input_file hex_offset hex_size\n", argv[0]);
return -1;
}
uint32 offset, size;
sscanf(argv[3], "%x", &offset);
sscanf(argv[4], "%x", &size);
FILE *input = fopen(argv[2], "rb");
if (!input)
error("Couldn't open file '%s'", argv[2]);
byte *buffer = new byte[size];
fseek(input, offset, SEEK_SET);
if (fread(buffer, 1, size, input) != size) {
delete[] buffer;
error("Couldn't read from file '%s'", argv[2]);
}
fclose(input);
SearchData d = SearchCreator::create(buffer, size);
delete[] buffer;
printf("{ 0x%.08X, 0x%.08X, { {", d.size, d.byteSum);
for (int j = 0; j < 16; ++j) {
printf(" 0x%.2X", d.hash.digest[j]);
if (j != 15)
printf(",");
else
printf(" } } }\n");
}
return 0;
}
PAKFile out;
out.loadFile(argv[1], false);
// When the output file is no valid kyra.dat file, we will delete
// all the output.
if (!checkIndex(out))
out.clearFile();
MD5Map inputFiles = createMD5Sums(argc - 2, &argv[2]);
GameMap games = createGameMap(inputFiles);
// Check for unused input files
MD5Map unusedFiles = inputFiles;
for (GameMap::const_iterator i = games.begin(); i != games.end(); ++i) {
unusedFiles.erase(i->first->md5[0]);
if (i->first->md5[1])
unusedFiles.erase(i->first->md5[1]);
}
for (MD5Map::const_iterator i = unusedFiles.begin(); i != unusedFiles.end(); ++i)
printf("Input file '%s' with md5 sum '%s' is not known.\n", i->second.c_str(), i->first.c_str());
unusedFiles.clear();
// Short circuit, in case no games are found.
if (games.empty()) {
printf("No games found. Exiting prematurely\n");
return -1;
}
// Process all games found
for (GameMap::const_iterator i = games.begin(); i != games.end(); ++i) {
MD5Map::const_iterator f1 = inputFiles.find(i->first->md5[0]);
MD5Map::const_iterator f2 = inputFiles.end();
if (i->first->md5[1])
f2 = inputFiles.find(i->first->md5[1]);
if (f2 != inputFiles.end())
printf("Processing files '%s' and '%s'...\n", f1->second.c_str(), f2->second.c_str());
else
printf("Processing file '%s'...\n", f1->second.c_str());
if (!process(out, i->first, i->second.data, i->second.size))
printf("FAILED\n");
else
printf("OK\n");
}
// Free up memory
for (GameMap::iterator i = games.begin(); i != games.end(); ++i)
delete[] i->second.data;
games.clear();
inputFiles.clear();
if (!out.saveFile(argv[1]))
error("couldn't save changes to '%s'", argv[1]);
uint8 digest[16];
if (!md5_file(argv[1], digest, 0))
error("couldn't calc. md5 for file '%s'", argv[1]);
FILE *f = fopen(argv[1], "ab");
if (!f)
error("couldn't open file '%s'", argv[1]);
if (fwrite(digest, 1, 16, f) != 16)
error("couldn't write md5sum to file '%s'", argv[1]);
fclose(f);
return 0;
}
MD5Map createMD5Sums(int files, const char * const *filenames) {
MD5Map result;
while (files--) {
const char *inputFile = *filenames++;
FILE *input = fopen(inputFile, "rb");
uint32 size = fileSize(input);
fseek(input, 0, SEEK_SET);
byte *buffer = new uint8[size];
assert(buffer);
if (fread(buffer, 1, size, input) != size) {
warning("couldn't read from file '%s', skipping it", inputFile);
delete[] buffer;
fclose(input);
continue;
}
fclose(input);
md5_context ctx;
uint8 digest[16];
char md5Str[33];
md5_starts(&ctx);
md5_update(&ctx, buffer, size);
md5_finish(&ctx, digest);
for (int j = 0; j < 16; ++j)
sprintf(md5Str + j*2, "%02x", (int)digest[j]);
delete[] buffer;
result[md5Str] = inputFile;
}
return result;
}
GameMap createGameMap(const MD5Map &map) {
GameMap result;
for (const Game * const *g = gameDescs; *g != 0; ++g) {
for (const Game *sub = *g; sub->game != -1; ++sub) {
MD5Map::const_iterator file1 = map.find(sub->md5[0]);
if (file1 == map.end())
continue;
MD5Map::const_iterator file2 = map.end();
if (sub->md5[1] != 0) {
file2 = map.find(sub->md5[1]);
if (file2 == map.end())
continue;
}
FILE *f1 = fopen(file1->second.c_str(), "rb");
FILE *f2 = 0;
if (file2 != map.end())
f2 = fopen(file2->second.c_str(), "rb");
uint32 file1Size = fileSize(f1);
uint32 file2Size = 0;
if (f2)
file2Size = fileSize(f2);
uint8 *buffer = new uint8[file1Size + file2Size];
assert(buffer);
fread(buffer, 1, file1Size, f1);
if (f2)
fread(buffer + file1Size, 1, file2Size, f2);
fclose(f1);
if (f2)
fclose(f2);
result[sub] = File(buffer, file1Size + file2Size);
}
}
return result;
}
const char *getIdString(const int id) {
switch (id) {
case k1ForestSeq:
return "k1ForestSeq";
case k1KallakWritingSeq:
return "k1KallakWritingSeq";
case k1KyrandiaLogoSeq:
return "k1KyrandiaLogoSeq";
case k1KallakMalcolmSeq:
return "k1KallakMalcolmSeq";
case k1MalcolmTreeSeq:
return "k1MalcolmTreeSeq";
case k1WestwoodLogoSeq:
return "k1WestwoodLogoSeq";
case k1Demo1Seq:
return "k1Demo1Seq";
case k1Demo2Seq:
return "k1Demo2Seq";
case k1Demo3Seq:
return "k1Demo3Seq";
case k1Demo4Seq:
return "k1Demo4Seq";
case k1AmuleteAnimSeq:
return "k1AmuleteAnimSeq";
case k1OutroReunionSeq:
return "k1OutroReunionSeq";
case k1IntroCPSStrings:
return "k1IntroCPSStrings";
case k1IntroCOLStrings:
return "k1IntroCOLStrings";
case k1IntroWSAStrings:
return "k1IntroWSAStrings";
case k1IntroStrings:
return "k1IntroStrings";
case k1OutroHomeString:
return "k1OutroHomeString";
case k1RoomFilenames:
return "k1RoomFilenames";
case k1RoomList:
return "k1RoomList";
case k1CharacterImageFilenames:
return "k1CharacterImageFilenames";
case k1AudioTracks:
return "k1AudioTracks";
case k1AudioTracks2:
return "k1AudioTracks2";
case k1AudioTracksIntro:
return "k1AudioTracksIntro";
case k1ItemNames:
return "k1ItemNames";
case k1TakenStrings:
return "k1TakenStrings";
case k1PlacedStrings:
return "k1PlacedStrings";
case k1DroppedStrings:
return "k1DroppedStrings";
case k1NoDropStrings:
return "k1NoDropStrings";
case k1PutDownString:
return "k1PutDownString";
case k1WaitAmuletString:
return "k1WaitAmuletString";
case k1BlackJewelString:
return "k1BlackJewelString";
case k1PoisonGoneString:
return "k1PoisonGoneString";
case k1HealingTipString:
return "k1HealingTipString";
case k1WispJewelStrings:
return "k1WispJewelStrings";
case k1MagicJewelStrings:
return "k1MagicJewelStrings";
case k1ThePoisonStrings:
return "k1ThePoisonStrings";
case k1FluteStrings:
return "k1FluteStrings";
case k1FlaskFullString:
return "k1FlaskFullString";
case k1FullFlaskString:
return "k1FullFlaskString";
case k1VeryCleverString:
return "k1VeryCleverString";
case k1NewGameString:
return "k1NewGameString";
case k1DefaultShapes:
return "k1DefaultShapes";
case k1Healing1Shapes:
return "k1Healing1Shapes";
case k1Healing2Shapes:
return "k1Healing2Shapes";
case k1PoisonDeathShapes:
return "k1PoisonDeathShapes";
case k1FluteShapes:
return "k1FluteShapes";
case k1Winter1Shapes:
return "k1Winter1Shapes";
case k1Winter2Shapes:
return "k1Winter2Shapes";
case k1Winter3Shapes:
return "k1Winter3Shapes";
case k1DrinkShapes:
return "k1DrinkShapes";
case k1WispShapes:
return "k1WispShapes";
case k1MagicAnimShapes:
return "k1MagicAnimShapes";
case k1BranStoneShapes:
return "k1BranStoneShapes";
case k1SpecialPalette1:
return "k1SpecialPalette1";
case k1SpecialPalette2:
return "k1SpecialPalette2";
case k1SpecialPalette3:
return "k1SpecialPalette3";
case k1SpecialPalette4:
return "k1SpecialPalette4";
case k1SpecialPalette5:
return "k1SpecialPalette5";
case k1SpecialPalette6:
return "k1SpecialPalette6";
case k1SpecialPalette7:
return "k1SpecialPalette7";
case k1SpecialPalette8:
return "k1SpecialPalette8";
case k1SpecialPalette9:
return "k1SpecialPalette9";
case k1SpecialPalette10:
return "k1SpecialPalette10";
case k1SpecialPalette11:
return "k1SpecialPalette11";
case k1SpecialPalette12:
return "k1SpecialPalette12";
case k1SpecialPalette13:
return "k1SpecialPalette13";
case k1SpecialPalette14:
return "k1SpecialPalette14";
case k1SpecialPalette15:
return "k1SpecialPalette15";
case k1SpecialPalette16:
return "k1SpecialPalette16";
case k1SpecialPalette17:
return "k1SpecialPalette17";
case k1SpecialPalette18:
return "k1SpecialPalette18";
case k1SpecialPalette19:
return "k1SpecialPalette19";
case k1SpecialPalette20:
return "k1SpecialPalette20";
case k1SpecialPalette21:
return "k1SpecialPalette21";
case k1SpecialPalette22:
return "k1SpecialPalette22";
case k1SpecialPalette23:
return "k1SpecialPalette23";
case k1SpecialPalette24:
return "k1SpecialPalette24";
case k1SpecialPalette25:
return "k1SpecialPalette25";
case k1SpecialPalette26:
return "k1SpecialPalette26";
case k1SpecialPalette27:
return "k1SpecialPalette27";
case k1SpecialPalette28:
return "k1SpecialPalette28";
case k1SpecialPalette29:
return "k1SpecialPalette29";
case k1SpecialPalette30:
return "k1SpecialPalette30";
case k1SpecialPalette31:
return "k1SpecialPalette31";
case k1SpecialPalette32:
return "k1SpecialPalette32";
case k1SpecialPalette33:
return "k1SpecialPalette33";
case k1GUIStrings:
return "k1GUIStrings";
case k1ConfigStrings:
return "k1ConfigStrings";
case k1TownsMusicFadeTable:
return "k1TownsMusicFadeTable";
case k1TownsSFXwdTable:
return "k1TownsSFXwdTable";
case k1TownsSFXbtTable:
return "k1TownsSFXbtTable";
case k1TownsCDATable:
return "k1TownsCDATable";
case k1PC98StoryStrings:
return "k1PC98StoryStrings";
case k1PC98IntroSfx:
return "k1PC98IntroSfx";
case k1CreditsStrings:
return "k1CreditsStrings";
case k1AmigaIntroSFXTable:
return "k1AmigaIntroSFXTable";
case k1AmigaGameSFXTable:
return "k1AmigaGameSFXTable";
case k2SeqplayPakFiles:
return "k2SeqplayPakFiles";
case k2SeqplayStrings:
return "k2SeqplayStrings";
case k2SeqplaySfxFiles:
return "k2SeqplaySfxFiles";
case k2SeqplayTlkFiles:
return "k2SeqplayTlkFiles";
case k2SeqplaySeqData:
return "k2SeqplaySeqData";
case k2SeqplayCredits:
return "k2SeqplayCredits";
case k2SeqplayCreditsSpecial:
return "k2SeqplayCreditsSpecial";
case k2SeqplayIntroTracks:
return "k2SeqplayIntroTracks";
case k2SeqplayFinaleTracks:
return "k2SeqplayFinaleTracks";
case k2SeqplayIntroCDA:
return "k2SeqplayIntroCDA";
case k2SeqplayFinaleCDA:
return "k2SeqplayFinaleCDA";
case k2SeqplayShapeAnimData:
return "k2SeqplayShapeAnimData";
case k2IngamePakFiles:
return "k2IngamePakFiles";
case k2IngameSfxFiles:
return "k2IngameSfxFiles";
case k2IngameSfxIndex:
return "k2IngameSfxIndex";
case k2IngameTracks:
return "k2IngameTracks";
case k2IngameCDA:
return "k2IngameCDA";
case k2IngameTalkObjIndex:
return "k2IngameTalkObjIndex";
case k2IngameTimJpStrings:
return "k2IngameTimJpStrings";
case k2IngameShapeAnimData:
return "k2IngameShapeAnimData";
case k2IngameTlkDemoStrings:
return "k2IngameTlkDemoStrings";
case k3MainMenuStrings:
return "k3MainMenuStrings";
case k3MusicFiles:
return "k3MusicFiles";
case k3ScoreTable:
return "k3ScoreTable";
case k3SfxFiles:
return "k3SfxFiles";
case k3SfxMap:
return "k3SfxMap";
case k3ItemAnimData:
return "k3ItemAnimData";
case k3ItemMagicTable:
return "k3ItemMagicTable";
case k3ItemStringMap:
return "k3ItemStringMap";
case kLolIngamePakFiles:
return "kLolIngamePakFiles";
case kLolCharacterDefs:
return "kLolCharacterDefs";
case kLolIngameSfxFiles:
return "kLolIngameSfxFiles";
case kLolIngameSfxIndex:
return "kLolIngameSfxIndex";
case kLolMusicTrackMap:
return "kLolMusicTrackMap";
case kLolIngameGMSfxIndex:
return "kLolIngameGMSfxIndex";
case kLolIngameMT32SfxIndex:
return "kLolIngameMT32SfxIndex";
case kLolIngamePcSpkSfxIndex:
return "kLolIngamePcSpkSfxIndex";
case kLolSpellProperties:
return "kLolSpellProperties";
case kLolGameShapeMap:
return "kLolGameShapeMap";
case kLolSceneItemOffs:
return "kLolSceneItemOffs";
case kLolCharInvIndex:
return "kLolCharInvIndex";
case kLolCharInvDefs:
return "kLolCharInvDefs";
case kLolCharDefsMan:
return "kLolCharDefsMan";
case kLolCharDefsWoman:
return "kLolCharDefsWoman";
case kLolCharDefsKieran:
return "kLolCharDefsKieran";
case kLolCharDefsAkshel:
return "kLolCharDefsAkshel";
case kLolExpRequirements:
return "kLolExpRequirements";
case kLolMonsterModifiers:
return "kLolMonsterModifiers";
case kLolMonsterShiftOffsets:
return "kLolMonsterShiftOffsets";
case kLolMonsterDirFlags:
return "kLolMonsterDirFlags";
case kLolMonsterScaleY:
return "kLolMonsterScaleY";
case kLolMonsterScaleX:
return "kLolMonsterScaleX";
case kLolMonsterScaleWH:
return "kLolMonsterScaleWH";
case kLolFlyingObjectShp:
return "kLolFlyingObjectShp";
case kLolInventoryDesc:
return "kLolInventoryDesc";
case kLolLevelShpList:
return "kLolLevelShpList";
case kLolLevelDatList:
return "kLolLevelDatList";
case kLolCompassDefs:
return "kLolCompassDefs";
case kLolItemPrices:
return "kLolItemPrices";
case kLolStashSetup:
return "kLolStashSetup";
case kLolDscUnk1:
return "kLolDscUnk1";
case kLolDscShapeIndex:
return "kLolDscShapeIndex";
case kLolDscOvlMap:
return "kLolDscOvlMap";
case kLolDscScaleWidthData:
return "kLolDscScaleWidthData";
case kLolDscScaleHeightData:
return "kLolDscScaleHeightData";
case kLolDscX:
return "kLolDscX";
case kLolDscY:
return "kLolDscY";
case kLolDscTileIndex:
return "kLolDscTileIndex";
case kLolDscUnk2:
return "kLolDscUnk2";
case kLolDscDoorShapeIndex:
return "kLolDscDoorShapeIndex";
case kLolDscDimData1:
return "kLolDscDimData1";
case kLolDscDimData2:
return "kLolDscDimData2";
case kLolDscBlockMap:
return "kLolDscBlockMap";
case kLolDscDimMap:
return "kLolDscDimMap";
case kLolDscOvlIndex:
return "kLolDscOvlIndex";
case kLolDscBlockIndex:
return "kLolDscBlockIndex";
case kLolDscDoor1:
return "kLolDscDoor1";
case kLolDscDoorScale:
return "kLolDscDoorScale";
case kLolDscDoor4:
return "kLolDscDoor4";
case kLolDscDoorX:
return "kLolDscDoorX";
case kLolDscDoorY:
return "kLolDscDoorY";
case kLolScrollXTop:
return "kLolScrollXTop";
case kLolScrollYTop:
return "kLolScrollYTop";
case kLolScrollXBottom:
return "kLolScrollXBottom";
case kLolScrollYBottom:
return "kLolScrollYBottom";
case kLolButtonDefs:
return "kLolButtonDefs";
case kLolButtonList1:
return "kLolButtonList1";
case kLolButtonList2:
return "kLolButtonList2";
case kLolButtonList3:
return "kLolButtonList3";
case kLolButtonList4:
return "kLolButtonList4";
case kLolButtonList5:
return "kLolButtonList5";
case kLolButtonList6:
return "kLolButtonList6";
case kLolButtonList7:
return "kLolButtonList7";
case kLolButtonList8:
return "kLolButtonList8";
case kLolLegendData:
return "kLolLegendData";
case kLolMapCursorOvl:
return "kLolMapCursorOvl";
case kLolMapStringId:
return "kLolMapStringId";
case kLolSpellbookAnim:
return "kLolSpellbookAnim";
case kLolSpellbookCoords:
return "kLolSpellbookCoords";
case kLolHealShapeFrames:
return "kLolHealShapeFrames";
case kLolLightningDefs:
return "kLolLightningDefs";
case kLolFireballCoords:
return "kLolFireballCoords";
case kLolHistory:
return "kLolHistory";
default:
return "Unknown";
}
}
struct ExtractData {
ExtractData() : desc(), offset() {}
ExtractData(ExtractEntrySearchData d, uint32 o) : desc(d), offset(o) {}
ExtractEntrySearchData desc;
uint32 offset;
};
typedef std::pair<int, ExtractEntrySearchData> SearchMapEntry;
typedef std::multimap<int, ExtractEntrySearchData> SearchMap;
typedef std::pair<int, ExtractData> ExtractMapEntry;
typedef std::multimap<int, ExtractData> ExtractMap;
bool getExtractionData(const Game *g, Search &search, ExtractMap &map);
bool createIDMap(PAKFile &out, const ExtractInformation *eI, const int *needList);
bool process(PAKFile &out, const Game *g, const byte *data, const uint32 size) {
char filename[128];
Search search(data, size);
ExtractMap ids;
if (!getExtractionData(g, search, ids))
return false;
const int *needList = getNeedList(g);
if (!needList) {
fprintf(stderr, "ERROR: No entry need list available\n");
return false;
}
ExtractInformation extractInfo;
extractInfo.game = g->game;
extractInfo.platform = g->platform;
extractInfo.special = g->special;
for (ExtractMap::const_iterator i = ids.begin(); i != ids.end(); ++i) {
const int id = i->first;
extractInfo.lang = i->second.desc.lang;
const ExtractFilename *fDesc = getFilenameDesc(id);
if (!fDesc) {
fprintf(stderr, "ERROR: couldn't find file description for id %d/%s\n", id, getIdString(id));
return false;
}
filename[0] = 0;
if (!getFilename(filename, &extractInfo, id)) {
fprintf(stderr, "ERROR: couldn't get filename for id %d/%s\n", id, getIdString(id));
return false;
}
const ExtractType *tDesc = findExtractType(fDesc->type);
if (!tDesc) {
fprintf(stderr, "ERROR: couldn't find type description for id %d/%s (%d)\n", id, getIdString(id), fDesc->type);
return false;
}
PAKFile::cFileList *list = out.getFileList();
if (list && list->findEntry(filename) != 0)
continue;
if (!tDesc->extract(out, &extractInfo, data + i->second.offset, i->second.desc.hint.size, filename, id)) {
fprintf(stderr, "ERROR: couldn't extract id %d/%s\n", id, getIdString(id));
return false;
}
}
for (int i = 0; i < 3; ++i) {
if (g->lang[i] == -1)
continue;
extractInfo.lang = g->lang[i];
if (!createIDMap(out, &extractInfo, needList))
return false;
if (!updateIndex(out, &extractInfo)) {
error("couldn't update INDEX file, stop processing of all files");
return false;
}
}
return true;
}
bool createIDMap(PAKFile &out, const ExtractInformation *eI, const int *needList) {
int dataEntries = 0;
// Count entries in the need list
for (const int *n = needList; *n != -1; ++n)
++dataEntries;
const int mapSize = 2 + dataEntries * (2 + 1 + 4);
uint8 *map = new uint8[mapSize];
uint8 *dst = map;
WRITE_BE_UINT16(dst, dataEntries); dst += 2;
for (const int *id = needList; *id != -1; ++id) {
WRITE_BE_UINT16(dst, *id); dst += 2;
const ExtractFilename *fDesc = getFilenameDesc(*id);
if (!fDesc)
return false;
*dst++ = getTypeID(fDesc->type);
WRITE_BE_UINT32(dst, getFilename(eI, *id)); dst += 4;
}
char filename[12];
if (!getFilename(filename, eI, 0)) {
fprintf(stderr, "ERROR: Could not create ID map for game\n");
return false;
}
out.removeFile(filename);
if (!out.addFile(filename, map, mapSize)) {
fprintf(stderr, "ERROR: Could not add ID map \"%s\" to kyra.dat\n", filename);
return false;
}
return true;
}
// Uncomment this to get various debug information about the detection table entries.
//#define DEBUG_EXTRACTION_TABLES
bool setupSearch(const Game *g, const int *needList, Search &search, SearchMap &searchData) {
for (const int *entry = needList; *entry != -1; ++entry) {
ExtractEntryList providers = getProvidersForId(*entry);
if (providers.empty()) {
fprintf(stderr, "ERROR: No provider for id %d/%s\n", *entry, getIdString(*entry));
return false;
} else {
for (ExtractEntryList::const_iterator i = providers.begin(); i != providers.end(); ++i) {
// Only add generic or partly matching providers here.
#ifndef DEBUG_EXTRACTION_TABLES
if ((i->lang == UNK_LANG || i->lang == g->lang[0] || i->lang == g->lang[1] || i->lang == g->lang[2]) &&
(i->platform == kPlatformUnknown || (i->platform == g->platform))) {
#endif
search.addData(i->hint);
searchData.insert(SearchMapEntry(*entry, *i));
#ifndef DEBUG_EXTRACTION_TABLES
}
#endif
}
}
}
return true;
}
typedef std::list<ExtractMap::const_iterator> MatchList;
MatchList filterPlatformMatches(const Game *g, std::pair<ExtractMap::const_iterator, ExtractMap::const_iterator> range) {
bool hasPlatformMatch = false;
for (ExtractMap::const_iterator i = range.first; i != range.second; ++i) {
if (i->second.desc.platform == g->platform) {
hasPlatformMatch = true;
break;
}
}
MatchList result;
if (hasPlatformMatch) {
for (ExtractMap::const_iterator i = range.first; i != range.second; ++i) {
if (i->second.desc.platform == g->platform)
result.push_back(i);
}
} else {
for (ExtractMap::const_iterator i = range.first; i != range.second; ++i)
result.push_back(i);
}
return result;
}
MatchList filterLanguageMatches(const int lang, const MatchList &input) {
std::list<ExtractMap::const_iterator> result;
for (MatchList::const_iterator i = input.begin(); i != input.end(); ++i) {
if ((*i)->second.desc.lang == lang)
result.push_back(*i);
}
return result;
}
MatchList::const_iterator filterOutBestMatch(const MatchList &input) {
MatchList::const_iterator result = input.begin();
if (input.size() > 1)
warning("Multiple entries found for id %d/%s", (*result)->first, getIdString((*result)->first));
for (MatchList::const_iterator i = input.begin(); i != input.end(); ++i) {
// Reduce all entries to one single entry.
//
// We use the following rules for this (in this order):
// - Prefer the entry with the higest size
// - Prefer the entry, which starts at the smallest offest
//
// TODO: These rules might not be safe for all games, but hopefully
// they will work fine. If there are any problems it should be rather
// easy to identify them, since we print out a warning for multiple
// entries found.
if ((*result)->second.desc.hint.size <= (*i)->second.desc.hint.size) {
if ((*result)->second.offset >= (*i)->second.offset)
result = i;
}
}
return result;
}
bool getExtractionData(const Game *g, Search &search, ExtractMap &map) {
SearchMap searchMap;
const int *needList = getNeedList(g);
if (!needList) {
fprintf(stderr, "ERROR: No entry need list available\n");
return false;
}
if (!setupSearch(g, needList, search, searchMap))
return false;
// Process the data search
Search::ResultList results;
search.search(results);
if (results.empty()) {
fprintf(stderr, "ERROR: Couldn't find any required data\n");
return false;
}
ExtractMap temporaryExtractMap;
for (const int *entry = needList; *entry != -1; ++entry) {
typedef std::pair<SearchMap::const_iterator, SearchMap::const_iterator> KeyRange;
KeyRange idRange = searchMap.equal_range(*entry);
for (Search::ResultList::const_iterator i = results.begin(); i != results.end(); ++i) {
for (SearchMap::const_iterator j = idRange.first; j != idRange.second; ++j) {
if (j->second.hint == i->data)
temporaryExtractMap.insert(ExtractMapEntry(*entry, ExtractData(j->second, i->offset)));
}
}
}
// Free up some memory
results.clear();
searchMap.clear();
bool result = true;
for (const int *entry = needList; *entry != -1; ++entry) {
MatchList possibleMatches = filterPlatformMatches(g, temporaryExtractMap.equal_range(*entry));
if (possibleMatches.empty()) {
fprintf(stderr, "ERROR: No entry found for id %d/%s\n", *entry, getIdString(*entry));
result = false;
continue;
}
if (isLangSpecific(*entry)) {
for (int i = 0; i < 3; ++i) {
if (g->lang[i] == -1)
continue;
MatchList langMatches = filterLanguageMatches(g->lang[i], possibleMatches);
MatchList::const_iterator bestMatch = filterOutBestMatch(langMatches);
if (bestMatch == langMatches.end()) {
// TODO: Add nice language name to output message.
fprintf(stderr, "ERROR: No entry found for id %d/%s for language %d\n", *entry, getIdString(*entry), g->lang[i]);
result = false;
continue;
}
#ifdef DEBUG_EXTRACTION_TABLES
if (((*bestMatch)->second.desc.platform != kPlatformUnknown && (*bestMatch)->second.desc.platform != g->platform))
printf("%s: %.8X %.8X %d %d\n", getIdString(*entry), (*bestMatch)->second.desc.hint.size, (*bestMatch)->second.desc.hint.byteSum, (*bestMatch)->second.desc.lang, (*bestMatch)->second.desc.platform);
#endif
map.insert(**bestMatch);
}
} else {
MatchList::const_iterator bestMatch = filterOutBestMatch(possibleMatches);
if (bestMatch == possibleMatches.end()) {
fprintf(stderr, "ERROR: No entry found for id %d/%s\n", *entry, getIdString(*entry));
result = false;
continue;
}
#ifdef DEBUG_EXTRACTION_TABLES
if (((*bestMatch)->second.desc.platform != kPlatformUnknown && (*bestMatch)->second.desc.platform != g->platform))
printf("%s: %.8X %.8X %d %d\n", getIdString(*entry), (*bestMatch)->second.desc.hint.size, (*bestMatch)->second.desc.hint.byteSum, (*bestMatch)->second.desc.lang, (*bestMatch)->second.desc.platform);
#endif
map.insert(**bestMatch);
}
}
return result;
}
|