← Back to branch summary

~ubuntu-branches/ubuntu/raring/scummvm/raring

« back to all changes in this revision

Viewing changes to engines/tsage/resources.cpp

  • Committer: Bazaar Package Importer
  • Author(s): Moritz Muehlenhoff
  • Date: 2011-05-25 19:02:23 UTC
  • mto: (21.1.2 sid)
  • mto: This revision was merged to the branch mainline in revision 24.
  • Revision ID: james.westby@ubuntu.com-20110525190223-fiqm0oaec714xk31
Tags: upstream-1.3.0
Import upstream version 1.3.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
engines/tsage/resources.cpp
 
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
 
8
 * modify it under the terms of the GNU General Public License
 
9
 * as published by the Free Software Foundation; either version 2
 
10
 * of the License, or (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, write to the Free Software
 
19
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
20
 *
 
21
 * $URL$
 
22
 * $Id$
 
23
 *
 
24
 */
 
25
 
 
26
#include "common/scummsys.h"
 
27
#include "common/endian.h"
 
28
#include "common/file.h"
 
29
#include "common/stack.h"
 
30
#include "common/util.h"
 
31
#include "tsage/resources.h"
 
32
#include "tsage/tsage.h"
 
33
 
 
34
namespace tSage {
 
35
 
 
36
 
 
37
MemoryManager::MemoryManager() {
 
38
        _memoryPool = new MemoryHeader*[MEMORY_POOL_SIZE];
 
39
        Common::set_to(&_memoryPool[0], &_memoryPool[MEMORY_POOL_SIZE], (MemoryHeader *)NULL);
 
40
}
 
41
 
 
42
MemoryManager::~MemoryManager() {
 
43
        for (int i = 0; i < MEMORY_POOL_SIZE; ++i) {
 
44
                if (_memoryPool[i] != NULL)
 
45
                        free(_memoryPool[i]);
 
46
        }
 
47
        delete[] _memoryPool;
 
48
}
 
49
 
 
50
uint16 MemoryManager::allocate(uint32 size) {
 
51
        int idx = 0;
 
52
        while ((idx < MEMORY_POOL_SIZE) && (_memoryPool[idx] != NULL))
 
53
                ++idx;
 
54
        if (idx == MEMORY_POOL_SIZE)
 
55
                error("Out of memory handles");
 
56
 
 
57
        // Create the new entry
 
58
        _memoryPool[idx] = (MemoryHeader *)malloc(sizeof(MemoryHeader) + size);
 
59
        _memoryPool[idx]->id = MEMORY_ENTRY_ID;
 
60
        _memoryPool[idx]->index = idx;
 
61
        _memoryPool[idx]->lockCtr = 0;
 
62
        _memoryPool[idx]->criticalCtr = 0;
 
63
        _memoryPool[idx]->tag = 0;
 
64
        _memoryPool[idx]->size = size;
 
65
 
 
66
        // Return it's index
 
67
        return idx;
 
68
}
 
69
 
 
70
byte *MemoryManager::allocate2(uint32 size) {
 
71
        uint32 idx = allocate(size);
 
72
        return lock(idx);
 
73
}
 
74
 
 
75
byte *MemoryManager::lock(uint32 handle) {
 
76
        assert((int)handle < MEMORY_POOL_SIZE);
 
77
        return (byte *)_memoryPool[handle] + sizeof(MemoryHeader);
 
78
}
 
79
 
 
80
int MemoryManager::indexOf(const byte *p) {
 
81
        for (int idx = 0; idx < MEMORY_POOL_SIZE; ++idx) {
 
82
                if (((byte *)_memoryPool[idx] + sizeof(MemoryHeader)) == p)
 
83
                        return idx;
 
84
        }
 
85
 
 
86
        return -1;
 
87
}
 
88
 
 
89
void MemoryManager::deallocate(const byte *p) {
 
90
        if (!p)
 
91
                return;
 
92
 
 
93
        int idx = indexOf(p);
 
94
        assert(idx != -1);
 
95
        if (_memoryPool[idx]->lockCtr-- == 0) {
 
96
                free(_memoryPool[idx]);
 
97
                _memoryPool[idx] = NULL;
 
98
        }
 
99
}
 
100
 
 
101
uint32 MemoryManager::getSize(const byte *p) {
 
102
        int idx = indexOf(p);
 
103
        assert(idx >= 0);
 
104
        return _memoryPool[idx]->size;
 
105
}
 
106
 
 
107
void MemoryManager::incLocks(const byte *p) {
 
108
        int idx = indexOf(p);
 
109
        assert(idx >= 0);
 
110
        _memoryPool[idx]->lockCtr++;
 
111
}
 
112
 
 
113
/*-------------------------------------------------------------------------*/
 
114
 
 
115
static uint16 bitMasks[4] = {0x1ff, 0x3ff, 0x7ff, 0xfff};
 
116
 
 
117
uint16 BitReader::readToken() {
 
118
        assert((numBits >= 9) && (numBits <= 12));
 
119
        uint16 result = _remainder;
 
120
        int bitsLeft = numBits - _bitsLeft;
 
121
        int bitOffset = _bitsLeft;
 
122
        _bitsLeft = 0;
 
123
 
 
124
        while (bitsLeft >= 0) {
 
125
                _remainder = readByte();
 
126
                result |= _remainder << bitOffset;
 
127
                bitsLeft -= 8;
 
128
                bitOffset += 8;
 
129
        }
 
130
 
 
131
        _bitsLeft = -bitsLeft;
 
132
        _remainder >>= 8 - _bitsLeft;
 
133
        return result & bitMasks[numBits - 9];
 
134
}
 
135
 
 
136
/*-------------------------------------------------------------------------*/
 
137
 
 
138
TLib::TLib(MemoryManager &memManager, const Common::String &filename) :
 
139
                _memoryManager(memManager) {
 
140
 
 
141
        // If the resource strings list isn't yet loaded, load them
 
142
        if (_resStrings.size() == 0) {
 
143
                Common::File f;
 
144
                if (f.open("tsage.cfg")) {
 
145
                        while (!f.eos()) {
 
146
                                _resStrings.push_back(f.readLine());
 
147
                        }
 
148
                        f.close();
 
149
                }
 
150
        }
 
151
 
 
152
        if (!_file.open(filename))
 
153
                error("Missing file %s", filename.c_str());
 
154
 
 
155
        loadIndex();
 
156
}
 
157
 
 
158
TLib::~TLib() {
 
159
        _resStrings.clear();
 
160
}
 
161
 
 
162
void TLib::loadSection(uint32 fileOffset) {
 
163
        _resources.clear();
 
164
        _file.seek(fileOffset);
 
165
        _sections.fileOffset = fileOffset;
 
166
 
 
167
        if (_file.readUint32BE() != 0x544D492D)
 
168
                error("Data block is not valid Rlb data");
 
169
 
 
170
        /*uint8 unknown1 = */_file.readByte();
 
171
        uint16 numEntries = _file.readByte();
 
172
 
 
173
        for (uint i = 0; i < numEntries; ++i) {
 
174
                uint16 id = _file.readUint16LE();
 
175
                uint16 size = _file.readUint16LE();
 
176
                uint16 uncSize = _file.readUint16LE();
 
177
                uint8 sizeHi = _file.readByte();
 
178
                uint8 type = _file.readByte() >> 5;
 
179
                assert(type <= 1);
 
180
                uint32 offset = _file.readUint32LE();
 
181
 
 
182
                ResourceEntry re;
 
183
                re.id = id;
 
184
                re.fileOffset = offset;
 
185
                re.isCompressed = type != 0;
 
186
                re.size = ((sizeHi & 0xF) << 16) | size;
 
187
                re.uncompressedSize = ((sizeHi & 0xF0) << 12) | uncSize;
 
188
 
 
189
                _resources.push_back(re);
 
190
        }
 
191
}
 
192
 
 
193
struct DecodeReference {
 
194
        uint16 vWord;
 
195
        uint8 vByte;
 
196
};
 
197
 
 
198
/**
 
199
 * Gets a resource from the currently loaded section
 
200
 */
 
201
byte *TLib::getResource(uint16 id, bool suppressErrors) {
 
202
        // Scan for an entry for the given Id
 
203
        ResourceEntry *re= NULL;
 
204
        ResourceList::iterator i;
 
205
        for (i = _resources.begin(); i != _resources.end(); ++i) {
 
206
                if ((*i).id == id) {
 
207
                        re = &(*i);
 
208
                        break;
 
209
                }
 
210
        }
 
211
        if (!re) {
 
212
                if (suppressErrors)
 
213
                        return NULL;
 
214
                error("Could not find resource Id #%d", id);
 
215
        }
 
216
 
 
217
        if (!re->isCompressed) {
 
218
                // Read in the resource data and return it
 
219
                byte *dataP = _memoryManager.allocate2(re->size);
 
220
                _file.seek(_sections.fileOffset + re->fileOffset);
 
221
                _file.read(dataP, re->size);
 
222
 
 
223
                return dataP;
 
224
        }
 
225
 
 
226
        /*
 
227
         * Decompress the data block
 
228
         */
 
229
 
 
230
        _file.seek(_sections.fileOffset + re->fileOffset);
 
231
        Common::ReadStream *compStream = _file.readStream(re->size);
 
232
        BitReader bitReader(*compStream);
 
233
 
 
234
        byte *dataOut = _memoryManager.allocate2(re->uncompressedSize);
 
235
        byte *destP = dataOut;
 
236
        uint bytesWritten = 0;
 
237
 
 
238
        uint16 ctrCurrent = 0x102, ctrMax = 0x200;
 
239
        uint16 word_48050 = 0, currentToken = 0, word_48054 =0;
 
240
        byte byte_49068 = 0, byte_49069 = 0;
 
241
        DecodeReference table[0x1000];
 
242
        for (int i = 0; i < 0x1000; ++i) {
 
243
                table[i].vByte = table[i].vWord = 0;
 
244
        }
 
245
        Common::Stack<uint16> tokenList;
 
246
 
 
247
        for (;;) {
 
248
                // Get the next decode token
 
249
                uint16 token = bitReader.readToken();
 
250
 
 
251
                // Handle the token
 
252
                if (token == 0x101) {
 
253
                        // End of compressed stream
 
254
                        break;
 
255
                } else if (token == 0x100) {
 
256
                        // Reset bit-rate
 
257
                        bitReader.numBits = 9;
 
258
                        ctrMax = 0x200;
 
259
                        ctrCurrent = 0x102;
 
260
 
 
261
                        // Set variables with next token
 
262
                        currentToken = word_48050 = bitReader.readToken();
 
263
                        byte_49069 = byte_49068 = (byte)currentToken;
 
264
 
 
265
                        ++bytesWritten;
 
266
                        assert(bytesWritten <= re->uncompressedSize);
 
267
                        *destP++ = byte_49069;
 
268
                } else {
 
269
                        word_48054 = word_48050 = token;
 
270
 
 
271
                        if (token >= ctrCurrent) {
 
272
                                word_48050 = currentToken;
 
273
                                tokenList.push(byte_49068);
 
274
                        }
 
275
 
 
276
                        while (word_48050 >= 0x100) {
 
277
                                assert(word_48050 < 0x1000);
 
278
                                tokenList.push(table[word_48050].vByte);
 
279
                                word_48050 = table[word_48050].vWord;
 
280
                        }
 
281
 
 
282
                        byte_49069 = byte_49068 = (byte)word_48050;
 
283
                        tokenList.push(word_48050);
 
284
 
 
285
                        // Write out any cached tokens
 
286
                        while (!tokenList.empty()) {
 
287
                                ++bytesWritten;
 
288
                                assert(bytesWritten <= re->uncompressedSize);
 
289
                                *destP++ = tokenList.pop();
 
290
                        }
 
291
 
 
292
                        assert(ctrCurrent < 0x1000);
 
293
                        table[ctrCurrent].vByte = byte_49069;
 
294
                        table[ctrCurrent].vWord = currentToken;
 
295
                        ++ctrCurrent;
 
296
 
 
297
                        currentToken = word_48054;
 
298
                        if ((ctrCurrent >= ctrMax) && (bitReader.numBits != 12)) {
 
299
                                // Move to the next higher bit-rate
 
300
                                ++bitReader.numBits;
 
301
                                ctrMax <<= 1;
 
302
                        }
 
303
                }
 
304
        }
 
305
 
 
306
        assert(bytesWritten == re->uncompressedSize);
 
307
        delete compStream;
 
308
        return dataOut;
 
309
}
 
310
 
 
311
/**
 
312
 * Finds the correct section and loads the specified resource within it
 
313
 */
 
314
byte *TLib::getResource(ResourceType resType, uint16 resNum, uint16 rlbNum, bool suppressErrors) {
 
315
        SectionList::iterator i = _sections.begin();
 
316
        while ((i != _sections.end()) && ((*i).resType != resType || (*i).resNum != resNum))
 
317
                ++i;
 
318
        if (i == _sections.end()) {
 
319
                if (suppressErrors)
 
320
                        return NULL;
 
321
                error("Unknown resource type %d num %d", resType, resNum);
 
322
        }
 
323
 
 
324
        loadSection((*i).fileOffset);
 
325
 
 
326
        return getResource(rlbNum, suppressErrors);
 
327
}
 
328
 
 
329
void TLib::loadIndex() {
 
330
        uint16 resNum, configId, fileOffset;
 
331
 
 
332
        // Load the root resources section
 
333
        loadSection(0);
 
334
 
 
335
        // Get the single resource from it
 
336
        const byte *pData = getResource(0);
 
337
        const byte *p = pData;
 
338
 
 
339
        _sections.clear();
 
340
 
 
341
        // Loop through reading the entries
 
342
        while ((resNum = READ_LE_UINT16(p)) != 0xffff) {
 
343
                configId = READ_LE_UINT16(p + 2);
 
344
                fileOffset = READ_LE_UINT16(p + 4);
 
345
                p += 6;
 
346
 
 
347
                SectionEntry se;
 
348
                se.resNum = resNum;
 
349
                se.resType = (ResourceType)(configId & 0x1f);
 
350
                se.fileOffset = (((configId >> 5) & 0x7ff) << 16) | fileOffset;
 
351
 
 
352
                _sections.push_back(se);
 
353
        }
 
354
 
 
355
        _memoryManager.deallocate(pData);
 
356
}
 
357
 
 
358
/**
 
359
 * Retrieves the specified palette resource and returns it's data
 
360
 *
 
361
 * @paletteNum Specefies the palette number
 
362
 */
 
363
bool TLib::getPalette(int paletteNum, byte *palData, uint *startNum, uint *numEntries) {
 
364
        // Get the specified palette
 
365
        byte *dataIn = getResource(RES_PALETTE, 0, paletteNum, true);
 
366
        if (!dataIn)
 
367
                return false;
 
368
 
 
369
        *startNum = READ_LE_UINT16(dataIn);
 
370
        *numEntries = READ_LE_UINT16(dataIn + 2);
 
371
        assert((*startNum < 256) && ((*startNum + *numEntries) <= 256));
 
372
 
 
373
        // Copy over the data
 
374
        Common::copy(&dataIn[6], &dataIn[6 + *numEntries * 3], palData);
 
375
 
 
376
        _memoryManager.deallocate(dataIn);
 
377
        return true;
 
378
}
 
379
 
 
380
byte *TLib::getSubResource(int resNum, int rlbNum, int index, uint *size, bool suppressErrors) {
 
381
        // Get the specified image set
 
382
        byte *dataIn = getResource(RES_VISAGE, resNum, rlbNum);
 
383
        if (!dataIn) {
 
384
                if (suppressErrors)
 
385
                        return NULL;
 
386
 
 
387
                error("Unknown sub resource %d/%d index %d", resNum, rlbNum, index);
 
388
        }
 
389
 
 
390
        int numEntries = READ_LE_UINT16(dataIn);
 
391
        uint32 entryOffset = READ_LE_UINT32(dataIn + 2 + (index - 1) * 4);
 
392
        uint32 nextOffset = (index == numEntries) ?
 
393
                        _memoryManager.getSize(dataIn) : READ_LE_UINT32(dataIn + 2 + index * 4);
 
394
        *size = nextOffset - entryOffset;
 
395
        assert(*size < (1024 * 1024));
 
396
 
 
397
        byte *entry = _memoryManager.allocate2(*size);
 
398
        Common::copy(&dataIn[entryOffset], &dataIn[nextOffset], entry);
 
399
 
 
400
        _memoryManager.deallocate(dataIn);
 
401
        return entry;
 
402
}
 
403
 
 
404
/**
 
405
 * Retrieves a given message resource, and returns the specified message number
 
406
 */
 
407
Common::String TLib::getMessage(int resNum, int lineNum, bool suppressErrors) {
 
408
        byte *msgData = getResource(RES_MESSAGE, resNum, 0);
 
409
        if (!msgData) {
 
410
                if (suppressErrors)
 
411
                        return Common::String();
 
412
 
 
413
                error("Unknown message %d line %d", resNum, lineNum);
 
414
        }
 
415
 
 
416
        const char *srcP = (const char *)msgData;
 
417
        while (lineNum-- > 0)
 
418
                srcP += strlen(srcP) + 1;
 
419
 
 
420
        Common::String result(srcP);
 
421
        _memoryManager.deallocate(msgData);
 
422
        return result;
 
423
}
 
424
 
 
425
/*--------------------------------------------------------------------------*/
 
426
 
 
427
ResourceManager::~ResourceManager() {
 
428
        for (uint idx = 0; idx < _libList.size(); ++idx)
 
429
                delete _libList[idx];
 
430
}
 
431
 
 
432
void ResourceManager::addLib(const Common::String &libName) {
 
433
        assert(_libList.size() < 5);
 
434
 
 
435
        _libList.push_back(new TLib(_vm->_memoryManager, libName));
 
436
}
 
437
 
 
438
byte *ResourceManager::getResource(uint16 id, bool suppressErrors) {
 
439
        byte *result = NULL;
 
440
        for (uint idx = 0; idx < _libList.size(); ++idx) {
 
441
                result = _libList[idx]->getResource(id, true);
 
442
                if (result)
 
443
                        return result;
 
444
        }
 
445
 
 
446
        if (!result && !suppressErrors)
 
447
                error("Could not find resource Id #%d", id);
 
448
        return NULL;
 
449
}
 
450
 
 
451
byte *ResourceManager::getResource(ResourceType resType, uint16 resNum, uint16 rlbNum, bool suppressErrors) {
 
452
        byte *result = NULL;
 
453
        for (uint idx = 0; idx < _libList.size(); ++idx) {
 
454
                result = _libList[idx]->getResource(resType, resNum, rlbNum, true);
 
455
                if (result)
 
456
                        return result;
 
457
        }
 
458
 
 
459
        if (!result && !suppressErrors)
 
460
                error("Unknown resource type %d num %d", resType, resNum);
 
461
        return NULL;
 
462
}
 
463
 
 
464
void ResourceManager::getPalette(int paletteNum, byte *palData, uint *startNum, uint *numEntries, bool suppressErrors) {
 
465
        for (uint idx = 0; idx < _libList.size(); ++idx) {
 
466
                if (_libList[idx]->getPalette(paletteNum, palData, startNum, numEntries))
 
467
                        return;
 
468
        }
 
469
 
 
470
        if (!suppressErrors)
 
471
                error("Unknown palette resource %d", paletteNum);
 
472
        *numEntries = 0;
 
473
}
 
474
 
 
475
byte *ResourceManager::getSubResource(int resNum, int rlbNum, int index, uint *size, bool suppressErrors) {
 
476
        byte *result = NULL;
 
477
        for (uint idx = 0; idx < _libList.size(); ++idx) {
 
478
                result = _libList[idx]->getSubResource(resNum, rlbNum, index, size, true);
 
479
                if (result)
 
480
                        return result;
 
481
        }
 
482
 
 
483
        if (!result && !suppressErrors)
 
484
                error("Unknown resource %d/%d index %d", resNum, rlbNum, index);
 
485
        return NULL;
 
486
}
 
487
 
 
488
Common::String ResourceManager::getMessage(int resNum, int lineNum, bool suppressErrors) {
 
489
        Common::String result;
 
490
 
 
491
        for (uint idx = 0; idx < _libList.size(); ++idx) {
 
492
                result = _libList[idx]->getMessage(resNum, lineNum, true);
 
493
                if (!result.empty())
 
494
                        return result;
 
495
        }
 
496
 
 
497
        if (!suppressErrors)
 
498
                error("Unknown message %d line %d", resNum, lineNum);
 
499
        return result;
 
500
}
 
501
 
 
502
} // end of namespace tSage