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
|
/* 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$
*
*/
#ifndef KYRA_RESOURCE_H
#define KYRA_RESOURCE_H
#include "common/scummsys.h"
#include "common/str.h"
#include "common/file.h"
#include "common/list.h"
#include "common/hash-str.h"
#include "common/hashmap.h"
#include "common/stream.h"
#include "common/ptr.h"
#include "kyra/kyra_v1.h"
#include "kyra/kyra_hof.h"
namespace Kyra {
struct ResFileEntry {
Common::String parent;
uint32 size;
bool preload;
bool mounted;
bool prot;
enum kType {
kRaw = 0,
kPak = 1,
kIns = 2,
kTlk = 3,
kAutoDetect
};
kType type;
uint32 offset;
};
typedef Common::HashMap<Common::String, ResFileEntry, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> ResFileMap;
class Resource;
class ResArchiveLoader {
public:
struct File {
File() : filename(), entry() {}
File(const Common::String &f, const ResFileEntry &e) : filename(f), entry(e) {}
Common::String filename;
ResFileEntry entry;
};
typedef Common::List<File> FileList;
virtual ~ResArchiveLoader() {}
virtual bool checkFilename(Common::String filename) const = 0;
virtual bool isLoadable(const Common::String &filename, Common::SeekableReadStream &stream) const = 0;
virtual bool loadFile(const Common::String &filename, Common::SeekableReadStream &stream, FileList &files) const = 0;
// parameter 'archive' can be deleted by this method and it may not be deleted from the caller
virtual Common::SeekableReadStream *loadFileFromArchive(const Common::String &file, Common::SeekableReadStream *archive, const ResFileEntry entry) const = 0;
virtual ResFileEntry::kType getType() const = 0;
protected:
};
class Resource {
public:
Resource(KyraEngine_v1 *vm);
~Resource();
bool reset();
bool loadPakFile(const Common::String &filename);
void unloadPakFile(const Common::String &filename);
bool isInPakList(const Common::String &filename);
bool loadFileList(const Common::String &filedata);
bool loadFileList(const char * const *filelist, uint32 numFiles);
// This unloads *all* pakfiles, even kyra.dat and protected ones
void unloadAllPakFiles();
bool exists(const char *file, bool errorOutOnFail=false);
uint32 getFileSize(const char *file);
uint8* fileData(const char *file, uint32 *size);
Common::SeekableReadStream *getFileStream(const Common::String &file);
bool loadFileToBuf(const char *file, void *buf, uint32 maxSize);
protected:
void checkFile(const Common::String &file);
bool isAccessable(const Common::String &file);
void detectFileTypes();
void initializeLoaders();
const ResArchiveLoader *getLoader(ResFileEntry::kType type) const;
typedef Common::List<Common::SharedPtr<ResArchiveLoader> > LoaderList;
typedef LoaderList::iterator LoaderIterator;
typedef LoaderList::const_iterator CLoaderIterator;
LoaderList _loaders;
ResFileMap _map;
KyraEngine_v1 *_vm;
};
// TODO?: maybe prefix all things here with 'kKyra1' instead of 'k'
enum kKyraResources {
kLoadAll = -1,
kForestSeq,
kKallakWritingSeq,
kKyrandiaLogoSeq,
kKallakMalcolmSeq,
kMalcolmTreeSeq,
kWestwoodLogoSeq,
kDemo1Seq,
kDemo2Seq,
kDemo3Seq,
kDemo4Seq,
kAmuleteAnimSeq,
kOutroReunionSeq,
kIntroCPSStrings,
kIntroCOLStrings,
kIntroWSAStrings,
kIntroStrings,
kOutroHomeString,
kRoomFilenames,
kRoomList,
kCharacterImageFilenames,
kItemNames,
kTakenStrings,
kPlacedStrings,
kDroppedStrings,
kNoDropStrings,
kPutDownString,
kWaitAmuletString,
kBlackJewelString,
kPoisonGoneString,
kHealingTipString,
kWispJewelStrings,
kMagicJewelStrings,
kThePoisonStrings,
kFluteStrings,
kFlaskFullString,
kFullFlaskString,
kVeryCleverString,
kNewGameString,
kDefaultShapes,
kHealing1Shapes,
kHealing2Shapes,
kPoisonDeathShapes,
kFluteShapes,
kWinter1Shapes,
kWinter2Shapes,
kWinter3Shapes,
kDrinkShapes,
kWispShapes,
kMagicAnimShapes,
kBranStoneShapes,
kPaletteList,
kGUIStrings,
kConfigStrings,
kAudioTracks,
kAudioTracksIntro,
kKyra1TownsSFXwdTable,
kKyra1TownsSFXbtTable,
kKyra1TownsCDATable,
kCreditsStrings,
k2SeqplayPakFiles,
k2SeqplayCredits,
k2SeqplayCreditsSpecial,
k2SeqplayStrings,
k2SeqplaySfxFiles,
k2SeqplayTlkFiles,
k2SeqplaySeqData,
k2SeqplayIntroTracks,
k2SeqplayFinaleTracks,
k2SeqplayIntroCDA,
k2SeqplayFinaleCDA,
k2SeqplayShapeAnimData,
k2IngamePakFiles,
k2IngameSfxFiles,
k2IngameSfxIndex,
k2IngameTracks,
k2IngameCDA,
k2IngameTalkObjIndex,
k2IngameTimJpStrings,
k2IngameShapeAnimData,
k2IngameTlkDemoStrings,
kMaxResIDs
};
struct Shape;
struct Room;
class StaticResource {
public:
static const Common::String staticDataFilename() { return "kyra.dat"; }
StaticResource(KyraEngine_v1 *vm) : _vm(vm), _resList(), _fileLoader(0), _builtIn(0), _filenameTable(0) {}
~StaticResource() { deinit(); }
static bool checkKyraDat();
bool init();
void deinit();
const char * const*loadStrings(int id, int &strings);
const uint8 *loadRawData(int id, int &size);
const Shape *loadShapeTable(int id, int &entries);
const Room *loadRoomTable(int id, int &entries);
const uint8 * const*loadPaletteTable(int id, int &entries);
const HofSeqData *loadHofSequenceData(int id, int &entries);
const ItemAnimData_v1 *loadHofShapeAnimDataV1(int id, int &entries);
const ItemAnimData_v2 *loadHofShapeAnimDataV2(int id, int &entries);
// use '-1' to prefetch/unload all ids
// prefetchId retruns false if only on of the resources
// can't be loaded and it breaks then the first res
// can't be loaded
bool prefetchId(int id);
void unloadId(int id);
private:
void outputError();
KyraEngine_v1 *_vm;
struct FilenameTable;
struct ResData;
struct FileType;
bool checkResList(int id, int &type, const void *&ptr, int &size);
const void *checkForBuiltin(int id, int &type, int &size);
const FilenameTable *searchFile(int id);
const FileType *getFiletype(int type);
const void *getData(int id, int requesttype, int &size);
bool loadLanguageTable(const char *filename, void *&ptr, int &size);
bool loadStringTable(const char *filename, void *&ptr, int &size);
bool loadRawData(const char *filename, void *&ptr, int &size);
bool loadShapeTable(const char *filename, void *&ptr, int &size);
bool loadRoomTable(const char *filename, void *&ptr, int &size);
bool loadPaletteTable(const char *filename, void *&ptr, int &size);
bool loadHofSequenceData(const char *filename, void *&ptr, int &size);
bool loadHofShapeAnimDataV1(const char *filename, void *&ptr, int &size);
bool loadHofShapeAnimDataV2(const char *filename, void *&ptr, int &size);
void freeRawData(void *&ptr, int &size);
void freeStringTable(void *&ptr, int &size);
void freeShapeTable(void *&ptr, int &size);
void freeRoomTable(void *&ptr, int &size);
void freePaletteTable(void *&ptr, int &size);
void freeHofSequenceData(void *&ptr, int &size);
void freeHofShapeAnimDataV1(void *&ptr, int &size);
void freeHofShapeAnimDataV2(void *&ptr, int &size);
const char *getFilename(const char *name);
uint8 *getFile(const char *name, int &size);
enum kResTypes {
kLanguageList,
kStringList,
kRoomList,
kShapeList,
kRawData,
kPaletteTable,
k2SeqData,
k2ShpAnimDataV1,
k2ShpAnimDataV2
};
struct BuiltinRes {
int id;
int type;
int size;
const void *data;
};
struct FilenameTable {
int id;
int type;
const char *filename;
};
struct FileType {
int type;
typedef bool (StaticResource::*LoadFunc)(const char *filename, void *&ptr, int &size);
typedef void (StaticResource::*FreeFunc)(void *&ptr, int &size);
LoadFunc load;
FreeFunc free;
};
struct ResData {
int id;
int type;
int size;
void *data;
};
Common::List<ResData> _resList;
const FileType *_fileLoader;
const BuiltinRes *_builtIn;
const FilenameTable *_filenameTable;
};
} // end of namespace Kyra
#endif
|