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
|
/* 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.
*/
#ifndef SCUMM_RESOURCE_H
#define SCUMM_RESOURCE_H
#include "common/array.h"
#include "scumm/scumm.h" // for ResType
namespace Scumm {
enum {
OF_OWNER_MASK = 0x0F,
OF_STATE_MASK = 0xF0,
OF_STATE_SHL = 4
};
class ResourceIterator {
uint32 _size;
uint32 _pos;
const byte *_ptr;
bool _smallHeader;
public:
ResourceIterator(const byte *searchin, bool smallHeader);
const byte *findNext(uint32 tag);
};
enum {
RES_INVALID_OFFSET = 0xFFFFFFFF
};
class ScummEngine;
/**
* The mode of a resource type indicates whether the resource can be restored
* from the game data files or not.
* This affects for example whether the resource is stored in savestates.
*
* Note that we treat sound resources somewhat differently: On the one hand,
* these behave mostly like a kStaticResTypeMode res type. However, when we
* create a savestate, we do save *some* information about them: Namely, which
* sound resources are loaded in memory at the time the save is made. And when
* loading, we invoke ensureResourceLoaded() for each sound resource that was
* marked in this way.
*/
enum ResTypeMode {
kDynamicResTypeMode = 0, ///< Resource is generated during runtime and may change
kStaticResTypeMode = 1, ///< Resource comes from data files, does not change
kSoundResTypeMode = 2 ///< Resource comes from data files, but may change
};
/**
* The 'resource manager' class. Currently doesn't really deserve to be called
* a 'class', at least until somebody gets around to OOfying this more.
*/
class ResourceManager {
//friend class ScummDebugger;
//friend class ScummEngine;
protected:
ScummEngine *_vm;
public:
class Resource {
public:
/**
* Pointer to the data contained in this resource
*/
byte *_address;
/**
* Size of this resource, i.e. of the data contained in it.
*/
uint32 _size;
protected:
/**
* The uppermost bit indicates whether the resources is locked.
* The lower 7 bits contain a counter. This counter measures roughly
* how old the resource is; it starts out with a count of 1 and can go
* as high as 127. When memory falls low resp. when the engine decides
* that it should throw out some unused stuff, then it begins by
* removing the resources with the highest counter (excluding locked
* resources and resources that are known to be in use).
*/
byte _flags;
/**
* The status of the resource. Currently only one bit is used, which
* indicates whether the resource is modified.
*/
byte _status;
public:
/**
* The id of the room (resp. the disk) the resource is contained in.
*/
byte _roomno;
/**
* The offset (in bytes) where the data for this resources can be found
* in the game data file(s), relative to the start of the room the
* resource is contained in.
*
* A value of RES_INVALID_OFFSET indicates a resources that is not contained
* in the game data files.
*/
uint32 _roomoffs;
public:
Resource();
~Resource();
void nuke();
inline void setResourceCounter(byte counter);
inline byte getResourceCounter() const;
void lock();
void unlock();
bool isLocked() const;
void setModified();
bool isModified() const;
};
/**
* This struct represents a resource type and all resource of that type.
*/
class ResTypeData : public Common::Array<Resource> {
friend class ResourceManager;
public:
/**
* The mode of this res type.
*/
ResTypeMode _mode;
/**
* The 4-byte tag or chunk type associated to this resource type, if any.
* Only applies to resources that are loaded from the game data files.
* This value is only used for debugging purposes.
*/
uint32 _tag;
public:
ResTypeData();
~ResTypeData();
};
ResTypeData _types[rtLast + 1];
protected:
uint32 _allocatedSize;
uint32 _maxHeapThreshold, _minHeapThreshold;
byte _expireCounter;
public:
ResourceManager(ScummEngine *vm);
~ResourceManager();
void setHeapThreshold(int min, int max);
void allocResTypeData(ResType type, uint32 tag, int num, ResTypeMode mode);
void freeResources();
byte *createResource(ResType type, ResId idx, uint32 size);
void nukeResource(ResType type, ResId idx);
// inline Resource &getRes(ResType type, ResId idx) { return _types[type][idx]; }
// inline const Resource &getRes(ResType type, ResId idx) const { return _types[type][idx]; }
bool isResourceLoaded(ResType type, ResId idx) const;
void lock(ResType type, ResId idx);
void unlock(ResType type, ResId idx);
bool isLocked(ResType type, ResId idx) const;
void setModified(ResType type, ResId idx);
bool isModified(ResType type, ResId idx) const;
/**
* This method increments the _expireCounter, and if it overflows (which happens
* after at most 256 calls), it calls increaseResourceCounter.
* It is invoked in the engine's main loop ScummEngine::scummLoop().
*/
void increaseExpireCounter();
/**
* Update the specified resource's counter.
*/
void setResourceCounter(ResType type, ResId idx, byte counter);
/**
* Increment the counter of all unlocked loaded resources.
* The maximal count is 255.
* This is called by increaseExpireCounter and expireResources,
* but also by ScummEngine::startScene.
*/
void increaseResourceCounters();
void resourceStats();
//protected:
bool validateResource(const char *str, ResType type, ResId idx) const;
protected:
void expireResources(uint32 size);
};
} // End of namespace Scumm
#endif
|
