scummvm/engines/xeen/resources.cpp

372 lines
9.9 KiB
C++

/* 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.
*
*/
#include "common/scummsys.h"
#include "common/archive.h"
#include "common/memstream.h"
#include "common/textconsole.h"
#include "xeen/xeen.h"
#include "xeen/resources.h"
namespace Xeen {
/**
* Xeen CC file implementation
*/
class CCArchive : public Common::Archive {
private:
/**
* Details of a single entry in a CC file index
*/
struct CCEntry {
uint16 _id;
uint32 _offset;
uint16 _size;
CCEntry() : _id(0), _offset(0), _size(0) {}
CCEntry(uint16 id, uint32 offset, uint32 size)
: _id(id), _offset(offset), _size(size) {
}
};
Common::Array<CCEntry> _index;
Common::String _filename;
uint16 convertNameToId(const Common::String &resourceName) const;
void loadIndex(Common::SeekableReadStream *stream);
bool getHeaderEntry(const Common::String &resourceName, CCEntry &ccEntry) const;
public:
CCArchive(const Common::String &filename);
virtual ~CCArchive();
// Archive implementation
virtual bool hasFile(const Common::String &name) const;
virtual int listMembers(Common::ArchiveMemberList &list) const;
virtual const Common::ArchiveMemberPtr getMember(const Common::String &name) const;
virtual Common::SeekableReadStream *createReadStreamForMember(const Common::String &name) const;
};
CCArchive::CCArchive(const Common::String &filename): _filename(filename) {
File f(filename);
loadIndex(&f);
}
CCArchive::~CCArchive() {
}
// Archive implementation
bool CCArchive::hasFile(const Common::String &name) const {
CCEntry ccEntry;
return getHeaderEntry(name, ccEntry);
}
int CCArchive::listMembers(Common::ArchiveMemberList &list) const {
// CC files don't maintain the original filenames, so we can't list it
return 0;
}
const Common::ArchiveMemberPtr CCArchive::getMember(const Common::String &name) const {
if (!hasFile(name))
return Common::ArchiveMemberPtr();
return Common::ArchiveMemberPtr(new Common::GenericArchiveMember(name, this));
}
Common::SeekableReadStream *CCArchive::createReadStreamForMember(const Common::String &name) const {
CCEntry ccEntry;
if (getHeaderEntry(name, ccEntry)) {
// Open the correct CC file
Common::File f;
if (!f.open(_filename))
error("Could not open CC file");
// Read in the data for the specific resource
f.seek(ccEntry._offset);
byte *data = new byte[ccEntry._size];
f.read(data, ccEntry._size);
// Decrypt the data
for (int i = 0; i < ccEntry._size; ++i)
data[i] ^= 0x35;
// Return the data as a stream
return new Common::MemoryReadStream(data, ccEntry._size, DisposeAfterUse::YES);
}
return nullptr;
}
/**
* Hash a given filename to produce the Id that represents it
*/
uint16 CCArchive::convertNameToId(const Common::String &resourceName) const {
if (resourceName.empty())
return 0xffff;
Common::String name = resourceName;
name.toUppercase();
const byte *msgP = (const byte *)name.c_str();
int total = *msgP++;
for (; *msgP; total += *msgP++) {
// Rotate the bits in 'total' right 7 places
total = (total & 0x007F) << 9 | (total & 0xFF80) >> 7;
}
return total;
}
/**
* Load the index of a given CC file
*/
void CCArchive::loadIndex(Common::SeekableReadStream *stream) {
int count = stream->readUint16LE();
// Read in the data for the archive's index
byte *rawIndex = new byte[count * 8];
stream->read(rawIndex, count * 8);
// Decrypt the index
int ah = 0xac;
for (int i = 0; i < count * 8; ++i) {
rawIndex[i] = (byte)(((rawIndex[i] << 2 | rawIndex[i] >> 6) + ah) & 0xff);
ah += 0x67;
}
// Extract the index data into entry structures
_index.reserve(count);
const byte *entryP = &rawIndex[0];
for (int i = 0; i < count; ++i, entryP += 8) {
CCEntry entry;
entry._id = READ_LE_UINT16(entryP);
entry._offset = READ_LE_UINT32(entryP + 2) & 0xffffff;
entry._size = READ_LE_UINT16(entryP + 5);
assert(!entryP[7]);
_index.push_back(entry);
}
delete[] rawIndex;
}
/**
* Given a resource name, returns whether an entry exists, and returns
* the header index data for that entry
*/
bool CCArchive::getHeaderEntry(const Common::String &resourceName, CCEntry &ccEntry) const {
uint16 id = convertNameToId(resourceName);
// Loop through the index
for (uint i = 0; i < _index.size(); ++i) {
if (_index[i]._id == id) {
ccEntry = _index[i];
return true;
}
}
// Could not find an entry
return false;
}
/*------------------------------------------------------------------------*/
void Resources::init(XeenEngine *vm) {
Common::File f;
const char *ARCHIVES[3] = { "xeen", "dark", "intro" };
for (int i = 0; i < 3; ++i) {
Common::String filename = Common::String::format("%s.cc", ARCHIVES[i]);
if (f.exists(filename)) {
SearchMan.add(ARCHIVES[i], new CCArchive(filename));
}
}
}
/*------------------------------------------------------------------------*/
/**
* Opens the given file, throwing an error if it can't be opened
*/
void File::openFile(const Common::String &filename) {
if (!Common::File::open(filename))
error("Could not open file - %s", filename.c_str());
}
/*------------------------------------------------------------------------*/
SpriteResource::SpriteResource(const Common::String &filename) {
File f(filename);
// Read in the index
int count = f.readUint16LE();
Common::Array<uint32> index;
index.resize(count);
for (int i = 0; i < count; ++i)
index[i] = f.readUint32LE();
// Process each shape
_frames.resize(count);
for (int i = 0; i < count; ++i) {
uint16 cell1 = index[i] & 0xffff, cell2 = index[i] >> 16;
assert(cell1);
setFrameSize(f, cell1, cell2, _frames[i]);
decodeFrame(f, cell1, _frames[i]);
decodeFrame(f, cell2, _frames[i]);
}
}
int SpriteResource::size() const {
return _frames.size();
}
const XSurface &SpriteResource::getFrame(int frame) {
return _frames[frame];
}
void SpriteResource::setFrameSize(File &f, uint16 offset1, uint16 offset2, XSurface &s) {
int maxWidth = 0, maxHeight = 0;
// Check each of the two cells for the frame for their sizes
for (int i = 0; i < 2; ++i) {
uint16 offset = (i == 0) ? offset1 : offset2;
if (!offset)
break;
// Get the cell dimensions
f.seek(offset);
int x = f.readUint16LE();
int w = f.readUint16LE();
int y = f.readUint16LE();
int h = f.readUint16LE();
// Check for total size of the frame
if ((x + w) > maxWidth)
maxWidth = x + w;
if ((y + h) > maxHeight)
maxHeight = x + h;
}
// Create the surface
s.create(maxWidth, maxHeight);
// Empty the surface
s.fillRect(Common::Rect(0, 0, maxWidth, maxHeight), 0);
}
void SpriteResource::decodeFrame(File &f, uint16 offset, XSurface &s) {
// Get cell header
f.seek(offset);
int xOffset = f.readUint16LE();
f.skip(2);
int yOffset = f.readUint16LE();
int height = f.readUint16LE();
// The pattern steps used in the pattern command
const int patternSteps[] = { 0, 1, 1, 1, 2, 2, 3, 3, 0, -1, -1, -1, -2, -2, -3, -3 };
// Main loop
int opr1, opr2;
int32 pos;
for (int yPos = yOffset, byteCount = 0; yPos < height + yOffset; yPos++, byteCount = 0) {
// The number of bytes in this scan line
int lineLength = f.readByte();
if (lineLength == 0) {
// Skip the specified number of scan lines
yPos += f.readByte();
} else {
// Skip the transparent pixels at the beginning of the scan line
int xPos = f.readByte() + xOffset; ++byteCount;
byte *destP = (byte *)s.getBasePtr(xPos, yPos);
while (byteCount < lineLength) {
// The next byte is an opcode that determines what
// operators are to follow and how to interpret them.
int opcode = f.readByte(); ++byteCount;
// Decode the opcode
int len = opcode & 0x1F;
int cmd = (opcode & 0xE0) >> 5;
switch (cmd) {
case 0: // The following len + 1 bytes are stored as indexes into the color table.
case 1: // The following len + 33 bytes are stored as indexes into the color table.
for (int i = 0; i < opcode + 1; ++i, ++xPos)
*destP++ = f.readByte(); ++byteCount;
break;
case 2: // The following byte is an index into the color table, draw it len + 3 times.
opr1 = f.readByte(); ++byteCount;
for (int i = 0; i < len + 3; ++i, ++xPos)
*destP++ = opr1;
break;
case 3: // Stream copy command.
opr1 = f.readUint16LE(); byteCount += 2;
pos = f.pos();
f.seek(-opr1, SEEK_CUR);
for (int i = 0; i < len + 4; ++i, ++xPos)
*destP++ = f.readByte();
f.seek(pos, SEEK_SET);
break;
case 4: // The following two bytes are indexes into the color table, draw the pair len + 2 times.
opr1 = f.readByte(); ++byteCount;
opr2 = f.readByte(); ++byteCount;
for (int i = 0; i < len + 2; ++i, xPos += 2) {
*destP++ = opr1;
*destP++ = opr2;
}
break;
case 5: // Skip len + 1 pixels filling them with the transparent color.
xPos += len + 1;
break;
case 6: // Pattern command.
case 7:
// The pattern command has a different opcode format
len = opcode & 0x07;
cmd = (opcode >> 2) & 0x0E;
opr1 = f.readByte(); ++byteCount;
for (int i = 0; i < len + 3; ++i, ++xPos) {
*destP++ = opr1;
opr1 += patternSteps[cmd + (i % 2)];
}
break;
default:
break;
}
}
}
}
}
} // End of namespace Xeen