From a2a0b13de2cd6fb28787b2821466f3ef7c2210ea Mon Sep 17 00:00:00 2001 From: Matthew Hoops Date: Tue, 22 Feb 2011 20:01:19 -0500 Subject: COMMON: Begin to merge some NE/PE code The ID classes are now common to both. The files have been renamed to better illustrate their purpose. --- common/module.mk | 5 +- common/ne_exe.cpp | 612 ----------------------------------------- common/ne_exe.h | 211 -------------- common/pe_exe.cpp | 308 --------------------- common/pe_exe.h | 159 ----------- common/winexe.cpp | 84 ++++++ common/winexe.h | 74 +++++ common/winexe_ne.cpp | 559 +++++++++++++++++++++++++++++++++++++ common/winexe_ne.h | 183 ++++++++++++ common/winexe_pe.cpp | 255 +++++++++++++++++ common/winexe_pe.h | 122 ++++++++ engines/mohawk/cursors.cpp | 2 +- engines/scumm/he/resource_he.h | 2 +- graphics/fonts/winfont.cpp | 2 +- 14 files changed, 1283 insertions(+), 1295 deletions(-) delete mode 100644 common/ne_exe.cpp delete mode 100644 common/ne_exe.h delete mode 100644 common/pe_exe.cpp delete mode 100644 common/pe_exe.h create mode 100644 common/winexe.cpp create mode 100644 common/winexe.h create mode 100644 common/winexe_ne.cpp create mode 100644 common/winexe_ne.h create mode 100644 common/winexe_pe.cpp create mode 100644 common/winexe_pe.h diff --git a/common/module.mk b/common/module.mk index 6cbb40e282..a57de6a4b8 100644 --- a/common/module.mk +++ b/common/module.mk @@ -17,8 +17,6 @@ MODULE_OBJS := \ memorypool.o \ md5.o \ mutex.o \ - ne_exe.o \ - pe_exe.o \ random.o \ rational.o \ str.o \ @@ -30,6 +28,9 @@ MODULE_OBJS := \ unarj.o \ unzip.o \ util.o \ + winexe.o \ + winexe_ne.o \ + winexe_pe.o \ xmlparser.o \ zlib.o diff --git a/common/ne_exe.cpp b/common/ne_exe.cpp deleted file mode 100644 index 34bb551b06..0000000000 --- a/common/ne_exe.cpp +++ /dev/null @@ -1,612 +0,0 @@ -/* 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$ - * - */ - -#include "common/debug.h" -#include "common/file.h" -#include "common/memstream.h" -#include "common/ne_exe.h" -#include "common/str.h" -#include "common/stream.h" - -namespace Common { - -NECursor::NECursor() { - _width = 0; - _height = 0; - _hotspotX = 0; - _hotspotY = 0; - _surface = 0; - memset(_palette, 0, 256 * 3); -} - -NECursor::~NECursor() { - clear(); -} - -uint16 NECursor::getWidth() const { - return _width; -} - -uint16 NECursor::getHeight() const { - return _height; -} - -uint16 NECursor::getHotspotX() const { - return _hotspotX; -} - -uint16 NECursor::getHotspotY() const { - return _hotspotY; -} - -void NECursor::setDimensions(uint16 width, uint16 height) { - _width = width; - _height = height; -} - -void NECursor::setHotspot(uint16 x, uint16 y) { - _hotspotX = x; - _hotspotY = y; -} - -bool NECursor::readCursor(SeekableReadStream &stream, uint32 count) { - clear(); - - SeekableReadStream *bitmap = stream.readStream(count); - _surface = new byte[_width * _height]; - - uint32 width = _width; - uint32 height = _height * 2; - - // Sanity checks - assert((width > 0) && (height > 0)); - - // Check header size - if (bitmap->readUint32LE() != 40) - return false; - - // Check dimensions - if (bitmap->readUint32LE() != width) - return false; - if (bitmap->readUint32LE() != height) - return false; - - // Color planes - if (bitmap->readUint16LE() != 1) - return false; - // Bits per pixel - if (bitmap->readUint16LE() != 1) - return false; - // Compression - if (bitmap->readUint32LE() != 0) - return false; - - // Image size + X resolution + Y resolution - bitmap->skip(12); - - uint32 numColors = bitmap->readUint32LE(); - - if (numColors == 0) - numColors = 2; - else if (numColors > 2) - return false; - - // Assert that enough data is there for the whole cursor - if ((uint32)bitmap->size() < 40 + numColors * 4 + width * height / 8) - return false; - - // Height includes AND-mask and XOR-mask - height /= 2; - - // Standard palette: transparent, black, white - _palette[6] = 0xff; - _palette[7] = 0xff; - _palette[8] = 0xff; - - // Reading the palette - bitmap->seek(40); - for (uint32 i = 0 ; i < numColors; i++) { - _palette[(i + 1) * 3 + 2] = bitmap->readByte(); - _palette[(i + 1) * 3 + 1] = bitmap->readByte(); - _palette[(i + 1) * 3 + 0] = bitmap->readByte(); - bitmap->readByte(); - } - - // Reading the bitmap data - uint32 dataSize = bitmap->size() - 40 - numColors * 4; - byte *initialSource = new byte[dataSize]; - bitmap->read(initialSource, dataSize); - const byte *srcP = initialSource; - const byte *srcM = srcP + ((width * height) / 8); - byte *dest = _surface + width * (height - 1); - - for (uint32 i = 0; i < height; i++) { - byte *rowDest = dest; - - for (uint32 j = 0; j < (width / 8); j++) { - byte p = srcP[j]; - byte m = srcM[j]; - - for (int k = 0; k < 8; k++, rowDest++, p <<= 1, m <<= 1) { - if ((m & 0x80) != 0x80) { - if ((p & 0x80) == 0x80) - *rowDest = 2; - else - *rowDest = 1; - } else - *rowDest = 0; - } - } - - dest -= width; - srcP += width / 8; - srcM += width / 8; - } - - delete bitmap; - delete[] initialSource; - return true; -} - -void NECursor::clear() { - delete[] _surface; _surface = 0; -} - -NEResourceID &NEResourceID::operator=(String string) { - _name = string; - _idType = kIDTypeString; - return *this; -} - -NEResourceID &NEResourceID::operator=(uint16 x) { - _id = x; - _idType = kIDTypeNumerical; - return *this; -} - -bool NEResourceID::operator==(const String &x) const { - return _idType == kIDTypeString && _name.equalsIgnoreCase(x); -} - -bool NEResourceID::operator==(const uint16 &x) const { - return _idType == kIDTypeNumerical && _id == x; -} - -bool NEResourceID::operator==(const NEResourceID &x) const { - if (_idType != x._idType) - return false; - if (_idType == kIDTypeString) - return _name.equalsIgnoreCase(x._name); - if (_idType == kIDTypeNumerical) - return _id == x._id; - return true; -} - -String NEResourceID::getString() const { - if (_idType != kIDTypeString) - return ""; - - return _name; -} - -uint16 NEResourceID::getID() const { - if (_idType != kIDTypeNumerical) - return 0xffff; - - return _idType; -} - -String NEResourceID::toString() const { - if (_idType == kIDTypeString) - return _name; - else if (_idType == kIDTypeNumerical) - return String::format("%04x", _id); - - return ""; -} - -NEResources::NEResources() { - _exe = 0; -} - -NEResources::~NEResources() { - clear(); -} - -void NEResources::clear() { - if (_exe) { - delete _exe; - _exe = 0; - } - - _resources.clear(); - - for (uint32 i = 0; i < _cursors.size(); i++) - for (uint32 j = 0; j < _cursors[i].cursors.size(); j++) - delete _cursors[i].cursors[j]; - - _cursors.clear(); -} - -const Array &NEResources::getCursors() const { - return _cursors; -} - -bool NEResources::loadFromEXE(const String &fileName) { - if (fileName.empty()) - return false; - - File *file = new File(); - - if (!file->open(fileName)) { - delete file; - return false; - } - - return loadFromEXE(file); -} - -bool NEResources::loadFromEXE(SeekableReadStream *stream) { - clear(); - - if (!stream) - return false; - - _exe = stream; - - uint32 offsetResourceTable = getResourceTableOffset(); - if (offsetResourceTable == 0xFFFFFFFF) - return false; - if (offsetResourceTable == 0) - return true; - - if (!readResourceTable(offsetResourceTable)) - return false; - - if (!readCursors()) - return false; - - return true; -} - -bool NEResources::loadFromCompressedEXE(const String &fileName) { - // Based on http://www.cabextract.org.uk/libmspack/doc/szdd_kwaj_format.html - - File file; - - if (!file.open(fileName)) - return false; - - // First part of the signature - if (file.readUint32BE() != MKID_BE('SZDD')) - return false; - - // Second part of the signature - if (file.readUint32BE() != 0x88F02733) - return false; - - // Compression mode must be 'A' - if (file.readByte() != 'A') - return false; - - file.readByte(); // file name character change - uint32 unpackedLength = file.readUint32LE(); - - byte *window = new byte[0x1000]; - int pos = 0x1000 - 16; - memset(window, 0x20, 0x1000); // Initialize to all spaces - - byte *unpackedData = (byte *)malloc(unpackedLength); - byte *dataPos = unpackedData; - - // Apply simple LZSS decompression - for (;;) { - byte controlByte = file.readByte(); - - if (file.eos()) - break; - - for (byte i = 0; i < 8; i++) { - if (controlByte & (1 << i)) { - *dataPos++ = window[pos++] = file.readByte(); - pos &= 0xFFF; - } else { - int matchPos = file.readByte(); - int matchLen = file.readByte(); - matchPos |= (matchLen & 0xF0) << 4; - matchLen = (matchLen & 0xF) + 3; - while (matchLen--) { - *dataPos++ = window[pos++] = window[matchPos++]; - pos &= 0xFFF; - matchPos &= 0xFFF; - } - } - - } - } - - delete[] window; - SeekableReadStream *stream = new MemoryReadStream(unpackedData, unpackedLength); - - return loadFromEXE(stream); -} - -uint32 NEResources::getResourceTableOffset() { - if (!_exe) - return 0xFFFFFFFF; - - if (!_exe->seek(0)) - return 0xFFFFFFFF; - - // 'MZ' - if (_exe->readUint16BE() != 0x4D5A) - return 0xFFFFFFFF; - - if (!_exe->seek(60)) - return 0xFFFFFFFF; - - uint32 offsetSegmentEXE = _exe->readUint16LE(); - if (!_exe->seek(offsetSegmentEXE)) - return 0xFFFFFFFF; - - // 'NE' - if (_exe->readUint16BE() != 0x4E45) - return 0xFFFFFFFF; - - if (!_exe->seek(offsetSegmentEXE + 36)) - return 0xFFFFFFFF; - - uint32 offsetResourceTable = _exe->readUint16LE(); - if (offsetResourceTable == 0) - // No resource table - return 0; - - // Offset relative to the segment _exe header - offsetResourceTable += offsetSegmentEXE; - if (!_exe->seek(offsetResourceTable)) - return 0xFFFFFFFF; - - return offsetResourceTable; -} - -static const char *s_resTypeNames[] = { - "", "cursor", "bitmap", "icon", "menu", "dialog", "string", - "font_dir", "font", "accelerator", "rc_data", "msg_table", - "group_cursor", "group_icon", "version", "dlg_include", - "plug_play", "vxd", "ani_cursor", "ani_icon", "html", - "manifest" -}; - -bool NEResources::readResourceTable(uint32 offset) { - if (!_exe) - return false; - - if (!_exe->seek(offset)) - return false; - - uint32 align = 1 << _exe->readUint16LE(); - - uint16 typeID = _exe->readUint16LE(); - while (typeID != 0) { - uint16 resCount = _exe->readUint16LE(); - - _exe->skip(4); // reserved - - for (int i = 0; i < resCount; i++) { - Resource res; - - // Resource properties - res.offset = _exe->readUint16LE() * align; - res.size = _exe->readUint16LE() * align; - res.flags = _exe->readUint16LE(); - uint16 id = _exe->readUint16LE(); - res.handle = _exe->readUint16LE(); - res.usage = _exe->readUint16LE(); - - res.type = typeID; - - if ((id & 0x8000) == 0) - res.id = getResourceString(*_exe, offset + id); - else - res.id = id & 0x7FFF; - - if (typeID & 0x8000 && ((typeID & 0x7FFF) < ARRAYSIZE(s_resTypeNames))) - debug(2, "Found resource %s %s", s_resTypeNames[typeID & 0x7FFF], res.id.toString().c_str()); - else - debug(2, "Found resource %04x %s", typeID, res.id.toString().c_str()); - - _resources.push_back(res); - } - - typeID = _exe->readUint16LE(); - } - - return true; -} - -String NEResources::getResourceString(SeekableReadStream &exe, uint32 offset) { - uint32 curPos = exe.pos(); - - if (!exe.seek(offset)) { - exe.seek(curPos); - return ""; - } - - uint8 length = exe.readByte(); - - String string; - for (uint16 i = 0; i < length; i++) - string += (char)exe.readByte(); - - exe.seek(curPos); - return string; -} - -const NEResources::Resource *NEResources::findResource(uint16 type, NEResourceID id) const { - for (List::const_iterator it = _resources.begin(); it != _resources.end(); ++it) - if (it->type == type && it->id == id) - return &*it; - - return 0; -} - -SeekableReadStream *NEResources::getResource(uint16 type, NEResourceID id) { - const Resource *res = findResource(type, id); - - if (!res) - return 0; - - _exe->seek(res->offset); - return _exe->readStream(res->size); -} - -const Array NEResources::getIDList(uint16 type) const { - Array idArray; - - for (List::const_iterator it = _resources.begin(); it != _resources.end(); ++it) - if (it->type == type) - idArray.push_back(it->id); - - return idArray; -} - -bool NEResources::readCursors() { - uint32 cursorCount = 0; - - for (List::const_iterator it = _resources.begin(); it != _resources.end(); ++it) - if (it->type == kNEGroupCursor) - cursorCount++; - - if (cursorCount == 0) { - _cursors.clear(); - return true; - } - - _cursors.resize(cursorCount); - - Array::iterator cursorGroup = _cursors.begin(); - for (List::const_iterator it = _resources.begin(); it != _resources.end(); ++it) { - if (it->type == kNEGroupCursor) { - if (!readCursorGroup(*cursorGroup, *it)) - return false; - - ++cursorGroup; - } - } - - return true; -} - -bool NEResources::readCursorGroup(NECursorGroup &group, const Resource &resource) { - if (!_exe) - return false; - - if (resource.size <= 6) - return false; - - if (!_exe->seek(resource.offset)) - return false; - - byte *data = new byte[resource.size]; - - if (!_exe->read(data, resource.size)) { - delete[] data; - return false; - } - - uint32 cursorCount = READ_LE_UINT16(data + 4); - if (resource.size < (6 + cursorCount * 16)) { - delete[] data; - return false; - } - - group.cursors.resize(cursorCount); - - uint32 offset = 6; - for (uint32 i = 0; i < cursorCount; i++) { - group.cursors[i] = new NECursor(); - NECursor *cursor = group.cursors[i]; - - // Plane count - if (READ_LE_UINT16(data + offset + 4) != 1) { - delete[] data; - return false; - } - - // Bit count - if (READ_LE_UINT16(data + offset + 6) != 1) { - delete[] data; - return false; - } - - uint32 id = READ_LE_UINT32(data + offset + 12); - const Resource *cursorResource = findResource(kNECursor, id); - if (!cursorResource) { - delete[] data; - return false; - } - - cursor->setDimensions(READ_LE_UINT16(data + offset), READ_LE_UINT16(data + offset + 2) / 2); - - uint32 dataSize = READ_LE_UINT32(data + offset + 8); - if (!readCursor(*cursor, *cursorResource, dataSize)) { - delete[] data; - return false; - } - - offset += 16; - } - - group.id = resource.id; - - delete[] data; - return true; -} - -bool NEResources::readCursor(NECursor &cursor, const Resource &resource, uint32 size) { - if (!_exe) - return false; - - if (size <= 4) - return false; - if (resource.size < size) - return false; - - if (!_exe->seek(resource.offset)) - return false; - - uint32 hotspotX = _exe->readUint16LE(); - uint32 hotspotY = _exe->readUint16LE(); - cursor.setHotspot(hotspotX, hotspotY); - - size -= 4; - - if (!cursor.readCursor(*_exe, size)) - return false; - - return true; -} - -} // End of namespace Common diff --git a/common/ne_exe.h b/common/ne_exe.h deleted file mode 100644 index 545c8e5eff..0000000000 --- a/common/ne_exe.h +++ /dev/null @@ -1,211 +0,0 @@ -/* 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 COMMON_NE_EXE_H -#define COMMON_NE_EXE_H - -#include "common/array.h" -#include "common/list.h" - -namespace Common { - -class MemoryReadStream; -class SeekableReadStream; -class String; - -/** A New Executable cursor. */ -class NECursor { -public: - NECursor(); - ~NECursor(); - - /** Return the cursor's width. */ - uint16 getWidth() const; - /** Return the cursor's height. */ - uint16 getHeight() const; - /** Return the cursor's hotspot's x coordinate. */ - uint16 getHotspotX() const; - /** Return the cursor's hotspot's y coordinate. */ - uint16 getHotspotY() const; - - const byte *getSurface() const { return _surface; } - const byte *getPalette() const { return _palette; } - - /** Set the cursor's dimensions. */ - void setDimensions(uint16 width, uint16 height); - /** Set the cursor's hotspot. */ - void setHotspot(uint16 x, uint16 y); - - /** Read the cursor's data out of a stream. */ - bool readCursor(SeekableReadStream &stream, uint32 count); - -private: - byte *_surface; - byte _palette[256 * 3]; - - uint16 _width; ///< The cursor's width. - uint16 _height; ///< The cursor's height. - uint16 _hotspotX; ///< The cursor's hotspot's x coordinate. - uint16 _hotspotY; ///< The cursor's hotspot's y coordinate. - - /** Clear the cursor. */ - void clear(); -}; - -class NEResourceID { -public: - NEResourceID() { _idType = kIDTypeNull; } - NEResourceID(String x) { _idType = kIDTypeString; _name = x; } - NEResourceID(uint16 x) { _idType = kIDTypeNumerical; _id = x; } - - NEResourceID &operator=(String string); - NEResourceID &operator=(uint16 x); - - bool operator==(const String &x) const; - bool operator==(const uint16 &x) const; - bool operator==(const NEResourceID &x) const; - - String getString() const; - uint16 getID() const; - String toString() const; - -private: - /** An ID Type. */ - enum IDType { - kIDTypeNull, ///< No type set - kIDTypeNumerical, ///< A numerical ID. - kIDTypeString ///< A string ID. - } _idType; - - String _name; ///< The resource's string ID. - uint16 _id; ///< The resource's numerical ID. -}; - -/** A New Executable cursor group. */ -struct NECursorGroup { - NEResourceID id; - Array cursors; ///< The cursors. -}; - -/** The default Windows resources. */ -enum NEResourceType { - kNECursor = 0x8001, - kNEBitmap = 0x8002, - kNEIcon = 0x8003, - kNEMenu = 0x8004, - kNEDialog = 0x8005, - kNEString = 0x8006, - kNEFontDir = 0x8007, - kNEFont = 0x8008, - kNEAccelerator = 0x8009, - kNERCData = 0x800A, - kNEMessageTable = 0x800B, - kNEGroupCursor = 0x800C, - kNEGroupIcon = 0x800D, - kNEVersion = 0x8010, - kNEDlgInclude = 0x8011, - kNEPlugPlay = 0x8013, - kNEVXD = 0x8014, - kNEAniCursor = 0x8015, - kNEAniIcon = 0x8016, - kNEHTML = 0x8017, - kNEManifest = 0x8018 -}; - -/** - * A class able to load resources from a Windows New Executable, such - * as cursors, bitmaps, and sounds. - * - * See http://en.wikipedia.org/wiki/New_Executable for more info. - */ -class NEResources { -public: - NEResources(); - ~NEResources(); - - /** Clear all information. */ - void clear(); - - /** Load from an EXE file. */ - bool loadFromEXE(const String &fileName); - - /** Load from a Windows compressed EXE file. */ - bool loadFromCompressedEXE(const String &fileName); - - /** Load from a stream. */ - bool loadFromEXE(SeekableReadStream *stream); - - /** Get all cursor's read from the New Executable. */ - const Array &getCursors() const; - - /** Return a list of resources for a given type. */ - const Array getIDList(uint16 type) const; - - /** Return a stream to the specified resource (or 0 if non-existent). */ - SeekableReadStream *getResource(uint16 type, NEResourceID id); - -private: - /** A resource. */ - struct Resource { - NEResourceID id; - - uint16 type; ///< Type of the resource. - - uint32 offset; ///< Offset within the EXE. - uint32 size; ///< Size of the data. - - uint16 flags; - uint16 handle; - uint16 usage; - }; - - SeekableReadStream *_exe; ///< Current file. - - /** All resources. */ - List _resources; - - /** All cursor resources. */ - Array _cursors; - - /** Read the offset to the resource table. */ - uint32 getResourceTableOffset(); - /** Read the resource table. */ - bool readResourceTable(uint32 offset); - - // Cursor reading helpers - bool readCursors(); - bool readCursorGroup(NECursorGroup &group, const Resource &resource); - bool readCursor(NECursor &cursor, const Resource &resource, uint32 size); - - /** Find a specific resource. */ - const Resource *findResource(uint16 type, NEResourceID id) const; - - /** Read a resource string. */ - static String getResourceString(SeekableReadStream &exe, uint32 offset); -}; - -} // End of namespace Common - -#endif // COMMON_NE_EXE_H diff --git a/common/pe_exe.cpp b/common/pe_exe.cpp deleted file mode 100644 index fc35c0fcb2..0000000000 --- a/common/pe_exe.cpp +++ /dev/null @@ -1,308 +0,0 @@ -/* 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$ - * - */ - -#include "common/debug.h" -#include "common/file.h" -#include "common/memstream.h" -#include "common/pe_exe.h" -#include "common/str.h" -#include "common/stream.h" - -namespace Common { - -PEResourceID &PEResourceID::operator=(String string) { - _name = string; - _idType = kIDTypeString; - return *this; -} - -PEResourceID &PEResourceID::operator=(uint32 x) { - _id = x; - _idType = kIDTypeNumerical; - return *this; -} - -bool PEResourceID::operator==(const String &x) const { - return _idType == kIDTypeString && _name.equalsIgnoreCase(x); -} - -bool PEResourceID::operator==(const uint32 &x) const { - return _idType == kIDTypeNumerical && _id == x; -} - -bool PEResourceID::operator==(const PEResourceID &x) const { - if (_idType != x._idType) - return false; - if (_idType == kIDTypeString) - return _name.equalsIgnoreCase(x._name); - if (_idType == kIDTypeNumerical) - return _id == x._id; - return true; -} - -String PEResourceID::getString() const { - if (_idType != kIDTypeString) - return ""; - - return _name; -} - -uint32 PEResourceID::getID() const { - if (_idType != kIDTypeNumerical) - return 0xffffffff; - - return _idType; -} - -String PEResourceID::toString() const { - if (_idType == kIDTypeString) - return _name; - else if (_idType == kIDTypeNumerical) - return String::format("%08x", _id); - - return ""; -} - -PEResources::PEResources() { - _exe = 0; -} - -PEResources::~PEResources() { - clear(); -} - -void PEResources::clear() { - _sections.clear(); - _resources.clear(); - delete _exe; _exe = 0; -} - -bool PEResources::loadFromEXE(const String &fileName) { - if (fileName.empty()) - return false; - - File *file = new File(); - - if (!file->open(fileName)) { - delete file; - return false; - } - - return loadFromEXE(file); -} - -bool PEResources::loadFromEXE(SeekableReadStream *stream) { - clear(); - - if (!stream) - return false; - - if (stream->readUint16BE() != 'MZ') - return false; - - stream->skip(58); - - uint32 peOffset = stream->readUint32LE(); - - if (!peOffset || peOffset >= (uint32)stream->size()) - return false; - - stream->seek(peOffset); - - if (stream->readUint32BE() != MKID_BE('PE\0\0')) - return false; - - stream->skip(2); - uint16 sectionCount = stream->readUint16LE(); - stream->skip(12); - uint16 optionalHeaderSize = stream->readUint16LE(); - stream->skip(optionalHeaderSize + 2); - - // Read in all the sections - for (uint16 i = 0; i < sectionCount; i++) { - char sectionName[9]; - stream->read(sectionName, 8); - sectionName[8] = 0; - - Section section; - stream->skip(4); - section.virtualAddress = stream->readUint32LE(); - section.size = stream->readUint32LE(); - section.offset = stream->readUint32LE(); - stream->skip(16); - - _sections[sectionName] = section; - } - - // Currently, we require loading a resource section - if (!_sections.contains(".rsrc")) { - clear(); - return false; - } - - _exe = stream; - - Section &resSection = _sections[".rsrc"]; - parseResourceLevel(resSection, resSection.offset, 0); - - return true; -} - -void PEResources::parseResourceLevel(Section §ion, uint32 offset, int level) { - _exe->seek(offset + 12); - - uint16 namedEntryCount = _exe->readUint16LE(); - uint16 intEntryCount = _exe->readUint16LE(); - - for (uint32 i = 0; i < namedEntryCount + intEntryCount; i++) { - uint32 value = _exe->readUint32LE(); - - PEResourceID id; - - if (value & 0x80000000) { - value &= 0x7fffffff; - - uint32 startPos = _exe->pos(); - _exe->seek(section.offset + (value & 0x7fffffff)); - - // Read in the name, truncating from unicode to ascii - Common::String name; - uint16 nameLength = _exe->readUint16LE(); - while (nameLength--) - name += (char)(_exe->readUint16LE() & 0xff); - - _exe->seek(startPos); - - id = name; - } else { - id = value; - } - - uint32 nextOffset = _exe->readUint32LE(); - uint32 lastOffset = _exe->pos(); - - if (level == 0) - _curType = id; - else if (level == 1) - _curName = id; - else if (level == 2) - _curLang = id; - - if (level < 2) { - // Time to dive down further - parseResourceLevel(section, section.offset + (nextOffset & 0x7fffffff), level + 1); - } else { - _exe->seek(section.offset + nextOffset); - - Resource resource; - resource.offset = _exe->readUint32LE() + section.offset - section.virtualAddress; - resource.size = _exe->readUint32LE(); - - debug(4, "Found resource '%s' '%s' '%s' at %d of size %d", _curType.toString().c_str(), - _curName.toString().c_str(), _curLang.toString().c_str(), resource.offset, resource.size); - - _resources[_curType][_curName][_curLang] = resource; - } - - _exe->seek(lastOffset); - } -} - -const Array PEResources::getTypeList() const { - Array array; - - if (!_exe) - return array; - - for (TypeMap::const_iterator it = _resources.begin(); it != _resources.end(); it++) - array.push_back(it->_key); - - return array; -} - -const Array PEResources::getNameList(const PEResourceID &type) const { - Array array; - - if (!_exe || !_resources.contains(type)) - return array; - - const NameMap &nameMap = _resources[type]; - - for (NameMap::const_iterator it = nameMap.begin(); it != nameMap.end(); it++) - array.push_back(it->_key); - - return array; -} - -const Array PEResources::getLangList(const PEResourceID &type, const PEResourceID &name) const { - Array array; - - if (!_exe || !_resources.contains(type)) - return array; - - const NameMap &nameMap = _resources[type]; - - if (!nameMap.contains(name)) - return array; - - const LangMap &langMap = nameMap[name]; - - for (LangMap::const_iterator it = langMap.begin(); it != langMap.end(); it++) - array.push_back(it->_key); - - return array; -} - -SeekableReadStream *PEResources::getResource(const PEResourceID &type, const PEResourceID &name) { - Array langList = getLangList(type, name); - - if (langList.empty()) - return 0; - - const Resource &resource = _resources[type][name][langList[0]]; - _exe->seek(resource.offset); - return _exe->readStream(resource.size); -} - -SeekableReadStream *PEResources::getResource(const PEResourceID &type, const PEResourceID &name, const PEResourceID &lang) { - if (!_exe || !_resources.contains(type)) - return 0; - - const NameMap &nameMap = _resources[type]; - - if (!nameMap.contains(name)) - return 0; - - const LangMap &langMap = nameMap[name]; - - if (!langMap.contains(lang)) - return 0; - - const Resource &resource = langMap[lang]; - _exe->seek(resource.offset); - return _exe->readStream(resource.size); -} - -} // End of namespace Common diff --git a/common/pe_exe.h b/common/pe_exe.h deleted file mode 100644 index c86058fb4f..0000000000 --- a/common/pe_exe.h +++ /dev/null @@ -1,159 +0,0 @@ -/* 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 COMMON_PE_EXE_H -#define COMMON_PE_EXE_H - -#include "common/array.h" -#include "common/hashmap.h" -#include "common/hash-str.h" - -namespace Common { - -class SeekableReadStream; -class String; - -class PEResourceID { -public: - PEResourceID() { _idType = kIDTypeNull; } - PEResourceID(String x) { _idType = kIDTypeString; _name = x; } - PEResourceID(uint32 x) { _idType = kIDTypeNumerical; _id = x; } - - PEResourceID &operator=(String string); - PEResourceID &operator=(uint32 x); - - bool operator==(const String &x) const; - bool operator==(const uint32 &x) const; - bool operator==(const PEResourceID &x) const; - - String getString() const; - uint32 getID() const; - String toString() const; - -private: - /** An ID Type. */ - enum IDType { - kIDTypeNull, ///< No type set - kIDTypeNumerical, ///< A numerical ID. - kIDTypeString ///< A string ID. - } _idType; - - String _name; ///< The resource's string ID. - uint32 _id; ///< The resource's numerical ID. -}; - -struct PEResourceID_Hash { - uint operator()(const PEResourceID &id) const { return hashit(id.toString()); } -}; - -struct PEResourceID_EqualTo { - bool operator()(const PEResourceID &id1, const PEResourceID &id2) const { return id1 == id2; } -}; - -/** The default Windows PE resources. */ -enum PEResourceType { - kPECursor = 0x01, - kPEBitmap = 0x02, - kPEIcon = 0x03, - kPEMenu = 0x04, - kPEDialog = 0x05, - kPEString = 0x06, - kPEFontDir = 0x07, - kPEFont = 0x08, - kPEAccelerator = 0x09, - kPERCData = 0x0A, - kPEMessageTable = 0x0B, - kPEGroupCursor = 0x0C, - kPEGroupIcon = 0x0E, - kPEVersion = 0x10, - kPEDlgInclude = 0x11, - kPEPlugPlay = 0x13, - kPEVXD = 0x14, - kPEAniCursor = 0x15, - kPEAniIcon = 0x16 -}; - -/** - * A class able to load resources from a Windows Portable Executable, such - * as cursors, bitmaps, and sounds. - */ -class PEResources { -public: - PEResources(); - ~PEResources(); - - /** Clear all information. */ - void clear(); - - /** Load from an EXE file. */ - bool loadFromEXE(const String &fileName); - - /** Load from a stream. */ - bool loadFromEXE(SeekableReadStream *stream); - - /** Return a list of resource types. */ - const Array getTypeList() const; - - /** Return a list of names for a given type. */ - const Array getNameList(const PEResourceID &type) const; - - /** Return a list of languages for a given type and name. */ - const Array getLangList(const PEResourceID &type, const PEResourceID &name) const; - - /** Return a stream to the specified resource, taking the first language found (or 0 if non-existent). */ - SeekableReadStream *getResource(const PEResourceID &type, const PEResourceID &name); - - /** Return a stream to the specified resource (or 0 if non-existent). */ - SeekableReadStream *getResource(const PEResourceID &type, const PEResourceID &name, const PEResourceID &lang); - -private: - struct Section { - uint32 virtualAddress; - uint32 size; - uint32 offset; - }; - - HashMap _sections; - - SeekableReadStream *_exe; - - void parseResourceLevel(Section §ion, uint32 offset, int level); - PEResourceID _curType, _curName, _curLang; - - struct Resource { - uint32 offset; - uint32 size; - }; - - typedef HashMap LangMap; - typedef HashMap NameMap; - typedef HashMap TypeMap; - - TypeMap _resources; -}; - -} // End of namespace Common - -#endif diff --git a/common/winexe.cpp b/common/winexe.cpp new file mode 100644 index 0000000000..de53ae6490 --- /dev/null +++ b/common/winexe.cpp @@ -0,0 +1,84 @@ +/* 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$ + * + */ + +#include "common/str.h" +#include "common/winexe.h" + +namespace Common { + +WinResourceID &WinResourceID::operator=(String string) { + _name = string; + _idType = kIDTypeString; + return *this; +} + +WinResourceID &WinResourceID::operator=(uint32 x) { + _id = x; + _idType = kIDTypeNumerical; + return *this; +} + +bool WinResourceID::operator==(const String &x) const { + return _idType == kIDTypeString && _name.equalsIgnoreCase(x); +} + +bool WinResourceID::operator==(const uint32 &x) const { + return _idType == kIDTypeNumerical && _id == x; +} + +bool WinResourceID::operator==(const WinResourceID &x) const { + if (_idType != x._idType) + return false; + if (_idType == kIDTypeString) + return _name.equalsIgnoreCase(x._name); + if (_idType == kIDTypeNumerical) + return _id == x._id; + return true; +} + +String WinResourceID::getString() const { + if (_idType != kIDTypeString) + return ""; + + return _name; +} + +uint32 WinResourceID::getID() const { + if (_idType != kIDTypeNumerical) + return 0xffffffff; + + return _idType; +} + +String WinResourceID::toString() const { + if (_idType == kIDTypeString) + return _name; + else if (_idType == kIDTypeNumerical) + return String::format("%08x", _id); + + return ""; +} + +} // End of namespace Common diff --git a/common/winexe.h b/common/winexe.h new file mode 100644 index 0000000000..3567a037e1 --- /dev/null +++ b/common/winexe.h @@ -0,0 +1,74 @@ +/* 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 COMMON_WINEXE_H +#define COMMON_WINEXE_H + +#include "common/hash-str.h" + +namespace Common { + +class String; + +class WinResourceID { +public: + WinResourceID() { _idType = kIDTypeNull; } + WinResourceID(String x) { _idType = kIDTypeString; _name = x; } + WinResourceID(uint32 x) { _idType = kIDTypeNumerical; _id = x; } + + WinResourceID &operator=(String string); + WinResourceID &operator=(uint32 x); + + bool operator==(const String &x) const; + bool operator==(const uint32 &x) const; + bool operator==(const WinResourceID &x) const; + + String getString() const; + uint32 getID() const; + String toString() const; + +private: + /** An ID Type. */ + enum IDType { + kIDTypeNull, ///< No type set + kIDTypeNumerical, ///< A numerical ID. + kIDTypeString ///< A string ID. + } _idType; + + String _name; ///< The resource's string ID. + uint32 _id; ///< The resource's numerical ID. +}; + +struct WinResourceID_Hash { + uint operator()(const WinResourceID &id) const { return hashit(id.toString()); } +}; + +struct WinResourceID_EqualTo { + bool operator()(const WinResourceID &id1, const WinResourceID &id2) const { return id1 == id2; } +}; + +} // End of namespace Common + +#endif diff --git a/common/winexe_ne.cpp b/common/winexe_ne.cpp new file mode 100644 index 0000000000..8a2b07b4d0 --- /dev/null +++ b/common/winexe_ne.cpp @@ -0,0 +1,559 @@ +/* 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$ + * + */ + +#include "common/debug.h" +#include "common/file.h" +#include "common/memstream.h" +#include "common/str.h" +#include "common/stream.h" +#include "common/winexe_ne.h" + +namespace Common { + +NECursor::NECursor() { + _width = 0; + _height = 0; + _hotspotX = 0; + _hotspotY = 0; + _surface = 0; + memset(_palette, 0, 256 * 3); +} + +NECursor::~NECursor() { + clear(); +} + +uint16 NECursor::getWidth() const { + return _width; +} + +uint16 NECursor::getHeight() const { + return _height; +} + +uint16 NECursor::getHotspotX() const { + return _hotspotX; +} + +uint16 NECursor::getHotspotY() const { + return _hotspotY; +} + +void NECursor::setDimensions(uint16 width, uint16 height) { + _width = width; + _height = height; +} + +void NECursor::setHotspot(uint16 x, uint16 y) { + _hotspotX = x; + _hotspotY = y; +} + +bool NECursor::readCursor(SeekableReadStream &stream, uint32 count) { + clear(); + + SeekableReadStream *bitmap = stream.readStream(count); + _surface = new byte[_width * _height]; + + uint32 width = _width; + uint32 height = _height * 2; + + // Sanity checks + assert((width > 0) && (height > 0)); + + // Check header size + if (bitmap->readUint32LE() != 40) + return false; + + // Check dimensions + if (bitmap->readUint32LE() != width) + return false; + if (bitmap->readUint32LE() != height) + return false; + + // Color planes + if (bitmap->readUint16LE() != 1) + return false; + // Bits per pixel + if (bitmap->readUint16LE() != 1) + return false; + // Compression + if (bitmap->readUint32LE() != 0) + return false; + + // Image size + X resolution + Y resolution + bitmap->skip(12); + + uint32 numColors = bitmap->readUint32LE(); + + if (numColors == 0) + numColors = 2; + else if (numColors > 2) + return false; + + // Assert that enough data is there for the whole cursor + if ((uint32)bitmap->size() < 40 + numColors * 4 + width * height / 8) + return false; + + // Height includes AND-mask and XOR-mask + height /= 2; + + // Standard palette: transparent, black, white + _palette[6] = 0xff; + _palette[7] = 0xff; + _palette[8] = 0xff; + + // Reading the palette + bitmap->seek(40); + for (uint32 i = 0 ; i < numColors; i++) { + _palette[(i + 1) * 3 + 2] = bitmap->readByte(); + _palette[(i + 1) * 3 + 1] = bitmap->readByte(); + _palette[(i + 1) * 3 + 0] = bitmap->readByte(); + bitmap->readByte(); + } + + // Reading the bitmap data + uint32 dataSize = bitmap->size() - 40 - numColors * 4; + byte *initialSource = new byte[dataSize]; + bitmap->read(initialSource, dataSize); + const byte *srcP = initialSource; + const byte *srcM = srcP + ((width * height) / 8); + byte *dest = _surface + width * (height - 1); + + for (uint32 i = 0; i < height; i++) { + byte *rowDest = dest; + + for (uint32 j = 0; j < (width / 8); j++) { + byte p = srcP[j]; + byte m = srcM[j]; + + for (int k = 0; k < 8; k++, rowDest++, p <<= 1, m <<= 1) { + if ((m & 0x80) != 0x80) { + if ((p & 0x80) == 0x80) + *rowDest = 2; + else + *rowDest = 1; + } else + *rowDest = 0; + } + } + + dest -= width; + srcP += width / 8; + srcM += width / 8; + } + + delete bitmap; + delete[] initialSource; + return true; +} + +void NECursor::clear() { + delete[] _surface; _surface = 0; +} + +NEResources::NEResources() { + _exe = 0; +} + +NEResources::~NEResources() { + clear(); +} + +void NEResources::clear() { + if (_exe) { + delete _exe; + _exe = 0; + } + + _resources.clear(); + + for (uint32 i = 0; i < _cursors.size(); i++) + for (uint32 j = 0; j < _cursors[i].cursors.size(); j++) + delete _cursors[i].cursors[j]; + + _cursors.clear(); +} + +const Array &NEResources::getCursors() const { + return _cursors; +} + +bool NEResources::loadFromEXE(const String &fileName) { + if (fileName.empty()) + return false; + + File *file = new File(); + + if (!file->open(fileName)) { + delete file; + return false; + } + + return loadFromEXE(file); +} + +bool NEResources::loadFromEXE(SeekableReadStream *stream) { + clear(); + + if (!stream) + return false; + + _exe = stream; + + uint32 offsetResourceTable = getResourceTableOffset(); + if (offsetResourceTable == 0xFFFFFFFF) + return false; + if (offsetResourceTable == 0) + return true; + + if (!readResourceTable(offsetResourceTable)) + return false; + + if (!readCursors()) + return false; + + return true; +} + +bool NEResources::loadFromCompressedEXE(const String &fileName) { + // Based on http://www.cabextract.org.uk/libmspack/doc/szdd_kwaj_format.html + + File file; + + if (!file.open(fileName)) + return false; + + // First part of the signature + if (file.readUint32BE() != MKID_BE('SZDD')) + return false; + + // Second part of the signature + if (file.readUint32BE() != 0x88F02733) + return false; + + // Compression mode must be 'A' + if (file.readByte() != 'A') + return false; + + file.readByte(); // file name character change + uint32 unpackedLength = file.readUint32LE(); + + byte *window = new byte[0x1000]; + int pos = 0x1000 - 16; + memset(window, 0x20, 0x1000); // Initialize to all spaces + + byte *unpackedData = (byte *)malloc(unpackedLength); + byte *dataPos = unpackedData; + + // Apply simple LZSS decompression + for (;;) { + byte controlByte = file.readByte(); + + if (file.eos()) + break; + + for (byte i = 0; i < 8; i++) { + if (controlByte & (1 << i)) { + *dataPos++ = window[pos++] = file.readByte(); + pos &= 0xFFF; + } else { + int matchPos = file.readByte(); + int matchLen = file.readByte(); + matchPos |= (matchLen & 0xF0) << 4; + matchLen = (matchLen & 0xF) + 3; + while (matchLen--) { + *dataPos++ = window[pos++] = window[matchPos++]; + pos &= 0xFFF; + matchPos &= 0xFFF; + } + } + + } + } + + delete[] window; + SeekableReadStream *stream = new MemoryReadStream(unpackedData, unpackedLength); + + return loadFromEXE(stream); +} + +uint32 NEResources::getResourceTableOffset() { + if (!_exe) + return 0xFFFFFFFF; + + if (!_exe->seek(0)) + return 0xFFFFFFFF; + + // 'MZ' + if (_exe->readUint16BE() != 0x4D5A) + return 0xFFFFFFFF; + + if (!_exe->seek(60)) + return 0xFFFFFFFF; + + uint32 offsetSegmentEXE = _exe->readUint16LE(); + if (!_exe->seek(offsetSegmentEXE)) + return 0xFFFFFFFF; + + // 'NE' + if (_exe->readUint16BE() != 0x4E45) + return 0xFFFFFFFF; + + if (!_exe->seek(offsetSegmentEXE + 36)) + return 0xFFFFFFFF; + + uint32 offsetResourceTable = _exe->readUint16LE(); + if (offsetResourceTable == 0) + // No resource table + return 0; + + // Offset relative to the segment _exe header + offsetResourceTable += offsetSegmentEXE; + if (!_exe->seek(offsetResourceTable)) + return 0xFFFFFFFF; + + return offsetResourceTable; +} + +static const char *s_resTypeNames[] = { + "", "cursor", "bitmap", "icon", "menu", "dialog", "string", + "font_dir", "font", "accelerator", "rc_data", "msg_table", + "group_cursor", "group_icon", "version", "dlg_include", + "plug_play", "vxd", "ani_cursor", "ani_icon", "html", + "manifest" +}; + +bool NEResources::readResourceTable(uint32 offset) { + if (!_exe) + return false; + + if (!_exe->seek(offset)) + return false; + + uint32 align = 1 << _exe->readUint16LE(); + + uint16 typeID = _exe->readUint16LE(); + while (typeID != 0) { + uint16 resCount = _exe->readUint16LE(); + + _exe->skip(4); // reserved + + for (int i = 0; i < resCount; i++) { + Resource res; + + // Resource properties + res.offset = _exe->readUint16LE() * align; + res.size = _exe->readUint16LE() * align; + res.flags = _exe->readUint16LE(); + uint16 id = _exe->readUint16LE(); + res.handle = _exe->readUint16LE(); + res.usage = _exe->readUint16LE(); + + res.type = typeID; + + if ((id & 0x8000) == 0) + res.id = getResourceString(*_exe, offset + id); + else + res.id = id & 0x7FFF; + + if (typeID & 0x8000 && ((typeID & 0x7FFF) < ARRAYSIZE(s_resTypeNames))) + debug(2, "Found resource %s %s", s_resTypeNames[typeID & 0x7FFF], res.id.toString().c_str()); + else + debug(2, "Found resource %04x %s", typeID, res.id.toString().c_str()); + + _resources.push_back(res); + } + + typeID = _exe->readUint16LE(); + } + + return true; +} + +String NEResources::getResourceString(SeekableReadStream &exe, uint32 offset) { + uint32 curPos = exe.pos(); + + if (!exe.seek(offset)) { + exe.seek(curPos); + return ""; + } + + uint8 length = exe.readByte(); + + String string; + for (uint16 i = 0; i < length; i++) + string += (char)exe.readByte(); + + exe.seek(curPos); + return string; +} + +const NEResources::Resource *NEResources::findResource(uint16 type, WinResourceID id) const { + for (List::const_iterator it = _resources.begin(); it != _resources.end(); ++it) + if (it->type == type && it->id == id) + return &*it; + + return 0; +} + +SeekableReadStream *NEResources::getResource(uint16 type, WinResourceID id) { + const Resource *res = findResource(type, id); + + if (!res) + return 0; + + _exe->seek(res->offset); + return _exe->readStream(res->size); +} + +const Array NEResources::getIDList(uint16 type) const { + Array idArray; + + for (List::const_iterator it = _resources.begin(); it != _resources.end(); ++it) + if (it->type == type) + idArray.push_back(it->id); + + return idArray; +} + +bool NEResources::readCursors() { + uint32 cursorCount = 0; + + for (List::const_iterator it = _resources.begin(); it != _resources.end(); ++it) + if (it->type == kNEGroupCursor) + cursorCount++; + + if (cursorCount == 0) { + _cursors.clear(); + return true; + } + + _cursors.resize(cursorCount); + + Array::iterator cursorGroup = _cursors.begin(); + for (List::const_iterator it = _resources.begin(); it != _resources.end(); ++it) { + if (it->type == kNEGroupCursor) { + if (!readCursorGroup(*cursorGroup, *it)) + return false; + + ++cursorGroup; + } + } + + return true; +} + +bool NEResources::readCursorGroup(NECursorGroup &group, const Resource &resource) { + if (!_exe) + return false; + + if (resource.size <= 6) + return false; + + if (!_exe->seek(resource.offset)) + return false; + + byte *data = new byte[resource.size]; + + if (!_exe->read(data, resource.size)) { + delete[] data; + return false; + } + + uint32 cursorCount = READ_LE_UINT16(data + 4); + if (resource.size < (6 + cursorCount * 16)) { + delete[] data; + return false; + } + + group.cursors.resize(cursorCount); + + uint32 offset = 6; + for (uint32 i = 0; i < cursorCount; i++) { + group.cursors[i] = new NECursor(); + NECursor *cursor = group.cursors[i]; + + // Plane count + if (READ_LE_UINT16(data + offset + 4) != 1) { + delete[] data; + return false; + } + + // Bit count + if (READ_LE_UINT16(data + offset + 6) != 1) { + delete[] data; + return false; + } + + uint32 id = READ_LE_UINT32(data + offset + 12); + const Resource *cursorResource = findResource(kNECursor, id); + if (!cursorResource) { + delete[] data; + return false; + } + + cursor->setDimensions(READ_LE_UINT16(data + offset), READ_LE_UINT16(data + offset + 2) / 2); + + uint32 dataSize = READ_LE_UINT32(data + offset + 8); + if (!readCursor(*cursor, *cursorResource, dataSize)) { + delete[] data; + return false; + } + + offset += 16; + } + + group.id = resource.id; + + delete[] data; + return true; +} + +bool NEResources::readCursor(NECursor &cursor, const Resource &resource, uint32 size) { + if (!_exe) + return false; + + if (size <= 4) + return false; + if (resource.size < size) + return false; + + if (!_exe->seek(resource.offset)) + return false; + + uint32 hotspotX = _exe->readUint16LE(); + uint32 hotspotY = _exe->readUint16LE(); + cursor.setHotspot(hotspotX, hotspotY); + + size -= 4; + + if (!cursor.readCursor(*_exe, size)) + return false; + + return true; +} + +} // End of namespace Common diff --git a/common/winexe_ne.h b/common/winexe_ne.h new file mode 100644 index 0000000000..0c3d5293ab --- /dev/null +++ b/common/winexe_ne.h @@ -0,0 +1,183 @@ +/* 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 COMMON_WINEXE_NE_H +#define COMMON_WINEXE_NE_H + +#include "common/array.h" +#include "common/list.h" +#include "common/winexe.h" + +namespace Common { + +class MemoryReadStream; +class SeekableReadStream; +class String; + +/** A New Executable cursor. */ +class NECursor { +public: + NECursor(); + ~NECursor(); + + /** Return the cursor's width. */ + uint16 getWidth() const; + /** Return the cursor's height. */ + uint16 getHeight() const; + /** Return the cursor's hotspot's x coordinate. */ + uint16 getHotspotX() const; + /** Return the cursor's hotspot's y coordinate. */ + uint16 getHotspotY() const; + + const byte *getSurface() const { return _surface; } + const byte *getPalette() const { return _palette; } + + /** Set the cursor's dimensions. */ + void setDimensions(uint16 width, uint16 height); + /** Set the cursor's hotspot. */ + void setHotspot(uint16 x, uint16 y); + + /** Read the cursor's data out of a stream. */ + bool readCursor(SeekableReadStream &stream, uint32 count); + +private: + byte *_surface; + byte _palette[256 * 3]; + + uint16 _width; ///< The cursor's width. + uint16 _height; ///< The cursor's height. + uint16 _hotspotX; ///< The cursor's hotspot's x coordinate. + uint16 _hotspotY; ///< The cursor's hotspot's y coordinate. + + /** Clear the cursor. */ + void clear(); +}; + +/** A New Executable cursor group. */ +struct NECursorGroup { + WinResourceID id; + Array cursors; ///< The cursors. +}; + +/** The default Windows resources. */ +enum NEResourceType { + kNECursor = 0x8001, + kNEBitmap = 0x8002, + kNEIcon = 0x8003, + kNEMenu = 0x8004, + kNEDialog = 0x8005, + kNEString = 0x8006, + kNEFontDir = 0x8007, + kNEFont = 0x8008, + kNEAccelerator = 0x8009, + kNERCData = 0x800A, + kNEMessageTable = 0x800B, + kNEGroupCursor = 0x800C, + kNEGroupIcon = 0x800D, + kNEVersion = 0x8010, + kNEDlgInclude = 0x8011, + kNEPlugPlay = 0x8013, + kNEVXD = 0x8014, + kNEAniCursor = 0x8015, + kNEAniIcon = 0x8016, + kNEHTML = 0x8017, + kNEManifest = 0x8018 +}; + +/** + * A class able to load resources from a Windows New Executable, such + * as cursors, bitmaps, and sounds. + * + * See http://en.wikipedia.org/wiki/New_Executable for more info. + */ +class NEResources { +public: + NEResources(); + ~NEResources(); + + /** Clear all information. */ + void clear(); + + /** Load from an EXE file. */ + bool loadFromEXE(const String &fileName); + + /** Load from a Windows compressed EXE file. */ + bool loadFromCompressedEXE(const String &fileName); + + /** Load from a stream. */ + bool loadFromEXE(SeekableReadStream *stream); + + /** Get all cursor's read from the New Executable. */ + const Array &getCursors() const; + + /** Return a list of resources for a given type. */ + const Array getIDList(uint16 type) const; + + /** Return a stream to the specified resource (or 0 if non-existent). */ + SeekableReadStream *getResource(uint16 type, WinResourceID id); + +private: + /** A resource. */ + struct Resource { + WinResourceID id; + + uint16 type; ///< Type of the resource. + + uint32 offset; ///< Offset within the EXE. + uint32 size; ///< Size of the data. + + uint16 flags; + uint16 handle; + uint16 usage; + }; + + SeekableReadStream *_exe; ///< Current file. + + /** All resources. */ + List _resources; + + /** All cursor resources. */ + Array _cursors; + + /** Read the offset to the resource table. */ + uint32 getResourceTableOffset(); + /** Read the resource table. */ + bool readResourceTable(uint32 offset); + + // Cursor reading helpers + bool readCursors(); + bool readCursorGroup(NECursorGroup &group, const Resource &resource); + bool readCursor(NECursor &cursor, const Resource &resource, uint32 size); + + /** Find a specific resource. */ + const Resource *findResource(uint16 type, WinResourceID id) const; + + /** Read a resource string. */ + static String getResourceString(SeekableReadStream &exe, uint32 offset); +}; + +} // End of namespace Common + +#endif diff --git a/common/winexe_pe.cpp b/common/winexe_pe.cpp new file mode 100644 index 0000000000..456093f5b4 --- /dev/null +++ b/common/winexe_pe.cpp @@ -0,0 +1,255 @@ +/* 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$ + * + */ + +#include "common/debug.h" +#include "common/file.h" +#include "common/memstream.h" +#include "common/str.h" +#include "common/stream.h" +#include "common/winexe_pe.h" + +namespace Common { + +PEResources::PEResources() { + _exe = 0; +} + +PEResources::~PEResources() { + clear(); +} + +void PEResources::clear() { + _sections.clear(); + _resources.clear(); + delete _exe; _exe = 0; +} + +bool PEResources::loadFromEXE(const String &fileName) { + if (fileName.empty()) + return false; + + File *file = new File(); + + if (!file->open(fileName)) { + delete file; + return false; + } + + return loadFromEXE(file); +} + +bool PEResources::loadFromEXE(SeekableReadStream *stream) { + clear(); + + if (!stream) + return false; + + if (stream->readUint16BE() != 'MZ') + return false; + + stream->skip(58); + + uint32 peOffset = stream->readUint32LE(); + + if (!peOffset || peOffset >= (uint32)stream->size()) + return false; + + stream->seek(peOffset); + + if (stream->readUint32BE() != MKID_BE('PE\0\0')) + return false; + + stream->skip(2); + uint16 sectionCount = stream->readUint16LE(); + stream->skip(12); + uint16 optionalHeaderSize = stream->readUint16LE(); + stream->skip(optionalHeaderSize + 2); + + // Read in all the sections + for (uint16 i = 0; i < sectionCount; i++) { + char sectionName[9]; + stream->read(sectionName, 8); + sectionName[8] = 0; + + Section section; + stream->skip(4); + section.virtualAddress = stream->readUint32LE(); + section.size = stream->readUint32LE(); + section.offset = stream->readUint32LE(); + stream->skip(16); + + _sections[sectionName] = section; + } + + // Currently, we require loading a resource section + if (!_sections.contains(".rsrc")) { + clear(); + return false; + } + + _exe = stream; + + Section &resSection = _sections[".rsrc"]; + parseResourceLevel(resSection, resSection.offset, 0); + + return true; +} + +void PEResources::parseResourceLevel(Section §ion, uint32 offset, int level) { + _exe->seek(offset + 12); + + uint16 namedEntryCount = _exe->readUint16LE(); + uint16 intEntryCount = _exe->readUint16LE(); + + for (uint32 i = 0; i < namedEntryCount + intEntryCount; i++) { + uint32 value = _exe->readUint32LE(); + + WinResourceID id; + + if (value & 0x80000000) { + value &= 0x7fffffff; + + uint32 startPos = _exe->pos(); + _exe->seek(section.offset + (value & 0x7fffffff)); + + // Read in the name, truncating from unicode to ascii + Common::String name; + uint16 nameLength = _exe->readUint16LE(); + while (nameLength--) + name += (char)(_exe->readUint16LE() & 0xff); + + _exe->seek(startPos); + + id = name; + } else { + id = value; + } + + uint32 nextOffset = _exe->readUint32LE(); + uint32 lastOffset = _exe->pos(); + + if (level == 0) + _curType = id; + else if (level == 1) + _curName = id; + else if (level == 2) + _curLang = id; + + if (level < 2) { + // Time to dive down further + parseResourceLevel(section, section.offset + (nextOffset & 0x7fffffff), level + 1); + } else { + _exe->seek(section.offset + nextOffset); + + Resource resource; + resource.offset = _exe->readUint32LE() + section.offset - section.virtualAddress; + resource.size = _exe->readUint32LE(); + + debug(4, "Found resource '%s' '%s' '%s' at %d of size %d", _curType.toString().c_str(), + _curName.toString().c_str(), _curLang.toString().c_str(), resource.offset, resource.size); + + _resources[_curType][_curName][_curLang] = resource; + } + + _exe->seek(lastOffset); + } +} + +const Array PEResources::getTypeList() const { + Array array; + + if (!_exe) + return array; + + for (TypeMap::const_iterator it = _resources.begin(); it != _resources.end(); it++) + array.push_back(it->_key); + + return array; +} + +const Array PEResources::getNameList(const WinResourceID &type) const { + Array array; + + if (!_exe || !_resources.contains(type)) + return array; + + const NameMap &nameMap = _resources[type]; + + for (NameMap::const_iterator it = nameMap.begin(); it != nameMap.end(); it++) + array.push_back(it->_key); + + return array; +} + +const Array PEResources::getLangList(const WinResourceID &type, const WinResourceID &name) const { + Array array; + + if (!_exe || !_resources.contains(type)) + return array; + + const NameMap &nameMap = _resources[type]; + + if (!nameMap.contains(name)) + return array; + + const LangMap &langMap = nameMap[name]; + + for (LangMap::const_iterator it = langMap.begin(); it != langMap.end(); it++) + array.push_back(it->_key); + + return array; +} + +SeekableReadStream *PEResources::getResource(const WinResourceID &type, const WinResourceID &name) { + Array langList = getLangList(type, name); + + if (langList.empty()) + return 0; + + const Resource &resource = _resources[type][name][langList[0]]; + _exe->seek(resource.offset); + return _exe->readStream(resource.size); +} + +SeekableReadStream *PEResources::getResource(const WinResourceID &type, const WinResourceID &name, const WinResourceID &lang) { + if (!_exe || !_resources.contains(type)) + return 0; + + const NameMap &nameMap = _resources[type]; + + if (!nameMap.contains(name)) + return 0; + + const LangMap &langMap = nameMap[name]; + + if (!langMap.contains(lang)) + return 0; + + const Resource &resource = langMap[lang]; + _exe->seek(resource.offset); + return _exe->readStream(resource.size); +} + +} // End of namespace Common diff --git a/common/winexe_pe.h b/common/winexe_pe.h new file mode 100644 index 0000000000..5298e993ad --- /dev/null +++ b/common/winexe_pe.h @@ -0,0 +1,122 @@ +/* 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 COMMON_WINEXE_PE_H +#define COMMON_WINEXE_PE_H + +#include "common/array.h" +#include "common/hashmap.h" +#include "common/winexe.h" + +namespace Common { + +class SeekableReadStream; +class String; + +/** The default Windows PE resources. */ +enum PEResourceType { + kPECursor = 0x01, + kPEBitmap = 0x02, + kPEIcon = 0x03, + kPEMenu = 0x04, + kPEDialog = 0x05, + kPEString = 0x06, + kPEFontDir = 0x07, + kPEFont = 0x08, + kPEAccelerator = 0x09, + kPERCData = 0x0A, + kPEMessageTable = 0x0B, + kPEGroupCursor = 0x0C, + kPEGroupIcon = 0x0E, + kPEVersion = 0x10, + kPEDlgInclude = 0x11, + kPEPlugPlay = 0x13, + kPEVXD = 0x14, + kPEAniCursor = 0x15, + kPEAniIcon = 0x16 +}; + +/** + * A class able to load resources from a Windows Portable Executable, such + * as cursors, bitmaps, and sounds. + */ +class PEResources { +public: + PEResources(); + ~PEResources(); + + /** Clear all information. */ + void clear(); + + /** Load from an EXE file. */ + bool loadFromEXE(const String &fileName); + + /** Load from a stream. */ + bool loadFromEXE(SeekableReadStream *stream); + + /** Return a list of resource types. */ + const Array getTypeList() const; + + /** Return a list of names for a given type. */ + const Array getNameList(const WinResourceID &type) const; + + /** Return a list of languages for a given type and name. */ + const Array getLangList(const WinResourceID &type, const WinResourceID &name) const; + + /** Return a stream to the specified resource, taking the first language found (or 0 if non-existent). */ + SeekableReadStream *getResource(const WinResourceID &type, const WinResourceID &name); + + /** Return a stream to the specified resource (or 0 if non-existent). */ + SeekableReadStream *getResource(const WinResourceID &type, const WinResourceID &name, const WinResourceID &lang); + +private: + struct Section { + uint32 virtualAddress; + uint32 size; + uint32 offset; + }; + + HashMap _sections; + + SeekableReadStream *_exe; + + void parseResourceLevel(Section §ion, uint32 offset, int level); + WinResourceID _curType, _curName, _curLang; + + struct Resource { + uint32 offset; + uint32 size; + }; + + typedef HashMap LangMap; + typedef HashMap NameMap; + typedef HashMap TypeMap; + + TypeMap _resources; +}; + +} // End of namespace Common + +#endif diff --git a/engines/mohawk/cursors.cpp b/engines/mohawk/cursors.cpp index eb11eb175e..ebc8d1ea8a 100644 --- a/engines/mohawk/cursors.cpp +++ b/engines/mohawk/cursors.cpp @@ -31,8 +31,8 @@ #include "mohawk/riven_cursors.h" #include "common/macresman.h" -#include "common/ne_exe.h" #include "common/system.h" +#include "common/winexe_ne.h" #include "graphics/cursorman.h" namespace Mohawk { diff --git a/engines/scumm/he/resource_he.h b/engines/scumm/he/resource_he.h index 9dddc96f23..f81dd713f1 100644 --- a/engines/scumm/he/resource_he.h +++ b/engines/scumm/he/resource_he.h @@ -31,7 +31,7 @@ #define SCUMM_HE_RESOURCE_HE_H #include "common/macresman.h" -#include "common/pe_exe.h" +#include "common/winexe_pe.h" namespace Scumm { diff --git a/graphics/fonts/winfont.cpp b/graphics/fonts/winfont.cpp index fb37c8ddef..449a1de83e 100644 --- a/graphics/fonts/winfont.cpp +++ b/graphics/fonts/winfont.cpp @@ -23,8 +23,8 @@ */ #include "common/file.h" -#include "common/ne_exe.h" #include "common/str.h" +#include "common/winexe_ne.h" #include "graphics/fonts/winfont.h" namespace Graphics { -- cgit v1.2.3