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
|
/* 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 SCI_RESOURCE_INTERN_H
#define SCI_RESOURCE_INTERN_H
#include "sci/resource.h"
namespace Common {
class MacResManager;
}
namespace Sci {
enum ResSourceType {
kSourceDirectory = 0, ///< Directories containing game resources/patches
kSourcePatch, ///< External resource patches
kSourceVolume, ///< Game resources (resource.* or ressci.*)
kSourceExtMap, ///< Non-audio resource maps
kSourceIntMap, ///< SCI1.1 and later audio resource maps
kSourceAudioVolume, ///< Audio resources - resource.sfx / resource.aud
kSourceExtAudioMap, ///< SCI1 audio resource maps
kSourceWave, ///< External WAVE files, patched in as sound resources
kSourceMacResourceFork, ///< Mac SCI1.1 and later resource forks
kSourceChunk ///< Script chunk resources (*.chk)
};
class ResourceSource {
protected:
const ResSourceType _sourceType;
const Common::String _name;
public:
bool _scanned;
const Common::FSNode * const _resourceFile;
const int _volumeNumber;
protected:
ResourceSource(ResSourceType type, const Common::String &name, int volNum = 0, const Common::FSNode *resFile = 0);
public:
virtual ~ResourceSource();
ResSourceType getSourceType() const { return _sourceType; }
const Common::String &getLocationName() const { return _name; }
// Auxiliary method, used by loadResource implementations.
Common::SeekableReadStream *getVolumeFile(ResourceManager *resMan, Resource *res);
/**
* TODO: Document this
*/
virtual ResourceSource *findVolume(ResourceSource *map, int volNum) {
return NULL;
}
/**
* Scan this source for TODO.
*/
virtual void scanSource(ResourceManager *resMan) {}
/**
* Load a resource.
*/
virtual void loadResource(ResourceManager *resMan, Resource *res);
// FIXME: This audio specific method is a hack. After all, why should a
// ResourceSource or a Resource (which uses this method) have audio
// specific methods? But for now we keep this, as it eases transition.
virtual uint32 getAudioCompressionType() const { return 0; }
};
class DirectoryResourceSource : public ResourceSource {
public:
DirectoryResourceSource(const Common::String &name) : ResourceSource(kSourceDirectory, name) {}
virtual void scanSource(ResourceManager *resMan);
};
class PatchResourceSource : public ResourceSource {
public:
PatchResourceSource(const Common::String &name) : ResourceSource(kSourcePatch, name) {}
virtual void loadResource(ResourceManager *resMan, Resource *res);
};
class VolumeResourceSource : public ResourceSource {
protected:
ResourceSource * const _associatedMap;
public:
VolumeResourceSource(const Common::String &name, ResourceSource *map, int volNum, ResSourceType type = kSourceVolume)
: ResourceSource(type, name, volNum), _associatedMap(map) {
}
VolumeResourceSource(const Common::String &name, ResourceSource *map, int volNum, const Common::FSNode *resFile)
: ResourceSource(kSourceVolume, name, volNum, resFile), _associatedMap(map) {
}
virtual ResourceSource *findVolume(ResourceSource *map, int volNum) {
if (_associatedMap == map && _volumeNumber == volNum)
return this;
return NULL;
}
};
class ExtMapResourceSource : public ResourceSource {
public:
ExtMapResourceSource(const Common::String &name, int volNum, const Common::FSNode *resFile = 0)
: ResourceSource(kSourceExtMap, name, volNum, resFile) {
}
virtual void scanSource(ResourceManager *resMan);
};
class IntMapResourceSource : public ResourceSource {
public:
IntMapResourceSource(const Common::String &name, int volNum)
: ResourceSource(kSourceIntMap, name, volNum) {
}
virtual void scanSource(ResourceManager *resMan);
};
class AudioVolumeResourceSource : public VolumeResourceSource {
protected:
uint32 _audioCompressionType;
int32 *_audioCompressionOffsetMapping;
public:
AudioVolumeResourceSource(ResourceManager *resMan, const Common::String &name, ResourceSource *map, int volNum);
virtual void loadResource(ResourceManager *resMan, Resource *res);
virtual uint32 getAudioCompressionType() const;
};
class ExtAudioMapResourceSource : public ResourceSource {
public:
ExtAudioMapResourceSource(const Common::String &name, int volNum)
: ResourceSource(kSourceExtAudioMap, name, volNum) {
}
virtual void scanSource(ResourceManager *resMan);
};
class WaveResourceSource : public ResourceSource {
public:
WaveResourceSource(const Common::String &name) : ResourceSource(kSourceWave, name) {}
virtual void loadResource(ResourceManager *resMan, Resource *res);
};
/**
* Reads SCI1.1+ resources from a Mac resource fork.
*/
class MacResourceForkResourceSource : public ResourceSource {
public:
MacResourceForkResourceSource(const Common::String &name, int volNum);
~MacResourceForkResourceSource();
virtual void scanSource(ResourceManager *resMan);
virtual void loadResource(ResourceManager *resMan, Resource *res);
protected:
Common::MacResManager *_macResMan;
bool isCompressableResource(ResourceType type) const;
void decompressResource(Common::SeekableReadStream *stream, Resource *resource) const;
};
#ifdef ENABLE_SCI32
/**
* Reads resources from SCI2.1+ chunk resources
*/
class ChunkResourceSource : public ResourceSource {
public:
ChunkResourceSource(const Common::String &name, uint16 number);
virtual void scanSource(ResourceManager *resMan);
virtual void loadResource(ResourceManager *resMan, Resource *res);
protected:
uint16 _number;
struct ResourceEntry {
uint32 offset;
uint32 length;
};
Common::HashMap<ResourceId, ResourceEntry, ResourceIdHash> _resMap;
};
#endif
} // End of namespace Sci
#endif // SCI_RESOURCE_INTERN_H
|
