ScummVM API documentation
loader.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22#ifndef AGI_LOADER_H
23#define AGI_LOADER_H
24
25namespace Agi {
26
27class AgiLoader {
28public:
29 AgiLoader(AgiEngine *vm) : _vm(vm) {}
30 virtual ~AgiLoader() {}
31
36 virtual void init() {}
37
42 virtual int loadDirs() = 0;
43
47 virtual uint8 *loadVolumeResource(AgiDir *agid) = 0;
48
52 virtual int loadObjects() = 0;
53
57 virtual int loadWords() = 0;
58
59protected:
60 AgiEngine *_vm;
61
63 static void getPotentialDiskImages(
64 const char * const *imageExtensions,
65 size_t imageExtensionCount,
67 FileMap &fileMap);
68};
69
71 uint32 disk;
72 uint32 offset;
73
74 AgiDiskVolume() : disk(_EMPTY), offset(0) {}
75 AgiDiskVolume(uint32 d, uint32 o) : disk(d), offset(o) {}
76};
77
83 A2DirVersionOld, // 4 bits for volume, 8 for track
84 A2DirVersionNew, // 5 bits for volume, 7 for track
85};
86
87class AgiLoader_A2 : public AgiLoader {
88public:
89 AgiLoader_A2(AgiEngine *vm) : AgiLoader(vm) {}
90 ~AgiLoader_A2() override;
91
92 void init() override;
93 int loadDirs() override;
94 uint8 *loadVolumeResource(AgiDir *agid) override;
95 int loadObjects() override;
96 int loadWords() override;
97
98private:
101 AgiDir _logDir;
102 AgiDir _picDir;
103 AgiDir _viewDir;
104 AgiDir _soundDir;
105 AgiDir _objects;
106 AgiDir _words;
107
108 int readDiskOne(Common::SeekableReadStream &stream, Common::Array<uint32> &volumeMap);
109 static bool readInitDir(Common::SeekableReadStream &stream, byte index, AgiDir &agid);
110 static bool readDir(Common::SeekableReadStream &stream, int position, AgiDir &agid);
111 static bool readVolumeMap(Common::SeekableReadStream &stream, uint32 position, uint32 bufferLength, Common::Array<uint32> &volumeMap);
112
113 A2DirVersion detectDirVersion(Common::SeekableReadStream &stream) const;
114 static bool loadDir(AgiDir *dir, Common::SeekableReadStream &disk, uint32 dirOffset, uint32 dirLength, A2DirVersion dirVersion);
115};
116
117class AgiLoader_v1 : public AgiLoader {
118public:
119 AgiLoader_v1(AgiEngine *vm) : AgiLoader(vm) {}
120
121 void init() override;
122 int loadDirs() override;
123 uint8 *loadVolumeResource(AgiDir *agid) override;
124 int loadObjects() override;
125 int loadWords() override;
126
127private:
130 AgiDir _logDir;
131 AgiDir _picDir;
132 AgiDir _viewDir;
133 AgiDir _soundDir;
134 AgiDir _objects;
135 AgiDir _words;
136
137 bool readDiskOneV1(Common::SeekableReadStream &stream);
138 bool readDiskOneV2001(Common::SeekableReadStream &stream, int &vol0Offset);
139 static bool readInitDirV1(Common::SeekableReadStream &stream, byte index, AgiDir &agid);
140 static bool readInitDirV2001(Common::SeekableReadStream &stream, byte index, AgiDir &agid);
141
142 bool loadDir(AgiDir *dir, Common::File &disk, uint32 dirOffset, uint32 dirLength);
143};
144
145class AgiLoader_v2 : public AgiLoader {
146private:
147 bool _hasV3VolumeFormat;
148
149 int loadDir(AgiDir *agid, const char *fname);
150 bool detectV3VolumeFormat();
151
152public:
153 AgiLoader_v2(AgiEngine *vm) : _hasV3VolumeFormat(false), AgiLoader(vm) {}
154
155 int loadDirs() override;
156 uint8 *loadVolumeResource(AgiDir *agid) override;
157 int loadObjects() override;
158 int loadWords() override;
159};
160
161class AgiLoader_v3 : public AgiLoader {
162private:
163 Common::String _name;
165 int loadDir(AgiDir *agid, Common::File *fp, uint32 offs, uint32 len);
166
167public:
168 AgiLoader_v3(AgiEngine *vm) : AgiLoader(vm) {}
169
170 void init() override;
171 int loadDirs() override;
172 uint8 *loadVolumeResource(AgiDir *agid) override;
173 int loadObjects() override;
174 int loadWords() override;
175};
176
177class GalLoader : public AgiLoader {
178public:
179 GalLoader(AgiEngine *vm) : _dirOffset(0), AgiLoader(vm) {}
180
181 void init() override;
182 int loadDirs() override;
183 uint8 *loadVolumeResource(AgiDir *agid) override;
184 int loadObjects() override;
185 int loadWords() override;
186
187private:
188 Common::String _imageFile;
189 int _dirOffset;
190
191 static bool isDirectory(Common::SeekableReadStream &stream, uint32 dirOffset);
192 static uint32 readDirectoryEntry(Common::SeekableReadStream &stream, uint32 *sectorCount);
193};
194
195class GalLoader_A2 : public AgiLoader {
196public:
197 GalLoader_A2(AgiEngine *vm) : AgiLoader(vm) {}
199
200 void init() override;
201 int loadDirs() override;
202 uint8 *loadVolumeResource(AgiDir *agid) override;
203 int loadObjects() override;
204 int loadWords() override;
205
206private:
208
209 static bool readDiskOne(Common::SeekableReadStream &disk, AgiDir *logicDir);
210 static bool readDirectoryEntry(Common::SeekableReadStream &stream, AgiDir &dirEntry);
211 static bool validateDisk(Common::SeekableReadStream &disk, byte diskIndex, AgiDir *logicDir);
212
213 static bool loadDir(AgiDir *dir, Common::SeekableReadStream &disk, uint32 dirOffset, uint32 dirCount);
214};
215
216} // End of namespace Agi
217
218#endif /* AGI_LOADER_H */
Definition: agi.h:699
Definition: loader.h:87
uint8 * loadVolumeResource(AgiDir *agid) override
int loadObjects() override
void init() override
int loadDirs() override
int loadWords() override
Definition: loader.h:117
void init() override
uint8 * loadVolumeResource(AgiDir *agid) override
int loadObjects() override
int loadWords() override
int loadDirs() override
Definition: loader.h:145
uint8 * loadVolumeResource(AgiDir *agid) override
int loadWords() override
int loadDirs() override
int loadObjects() override
Definition: loader.h:161
int loadDirs() override
int loadWords() override
int loadObjects() override
void init() override
uint8 * loadVolumeResource(AgiDir *agid) override
Definition: loader.h:27
virtual uint8 * loadVolumeResource(AgiDir *agid)=0
virtual int loadWords()=0
virtual int loadObjects()=0
virtual void init()
Definition: loader.h:36
virtual int loadDirs()=0
Definition: loader.h:195
int loadObjects() override
uint8 * loadVolumeResource(AgiDir *agid) override
int loadWords() override
int loadDirs() override
void init() override
Definition: loader.h:177
int loadDirs() override
int loadObjects() override
uint8 * loadVolumeResource(AgiDir *agid) override
int loadWords() override
void init() override
Definition: file.h:47
Definition: hashmap.h:85
Definition: stream.h:745
Definition: str.h:59
Definition: agi.h:64
A2DirVersion
Definition: loader.h:82
Definition: agi.h:313
Definition: loader.h:70