SHERLOCK: Beginnings of Scalpel logo display

This commit is contained in:
Paul Gilbert 2015-05-30 17:55:22 -04:00
parent 52ca97fe63
commit fd33a100a1
7 changed files with 736 additions and 3 deletions

View file

@ -4,6 +4,8 @@ MODULE_OBJS = \
scalpel/darts.o \
scalpel/scalpel.o \
scalpel/drivers/adlib.o \
scalpel/tsage/logo.o \
scalpel/tsage/resources.o \
scalpel/scalpel_scene.o \
scalpel/scalpel_user_interface.o \
scalpel/settings.o \

View file

@ -255,7 +255,7 @@ Common::SeekableReadStream *Resources::decompress(Common::SeekableReadStream &so
}
Common::SeekableReadStream *Resources::decompress(Common::SeekableReadStream &source, uint32 outSize) {
int inSize = (_vm->getGameID() == GType_RoseTattoo) ? source.readUint32LE() : -1;
int inSize = (_vm->getGameID() == GType_RoseTattoo) ? source.readSint32LE() : -1;
byte *outBuffer = (byte *)malloc(outSize);
Common::MemoryReadStream *outStream = new Common::MemoryReadStream(outBuffer, outSize, DisposeAfterUse::YES);
@ -265,7 +265,7 @@ Common::SeekableReadStream *Resources::decompress(Common::SeekableReadStream &so
}
void Resources::decompress(Common::SeekableReadStream &source, byte *buffer, uint32 outSize) {
int inputSize = (_vm->getGameID() == GType_RoseTattoo) ? source.readUint32LE() : -1;
int inputSize = (_vm->getGameID() == GType_RoseTattoo) ? source.readSint32LE() : -1;
decompressLZ(source, buffer, outSize, inputSize);
}

View file

@ -20,11 +20,12 @@
*
*/
#include "engines/util.h"
#include "sherlock/scalpel/scalpel.h"
#include "sherlock/scalpel/tsage/logo.h"
#include "sherlock/sherlock.h"
#include "sherlock/music.h"
#include "sherlock/animation.h"
#include "engines/util.h"
namespace Sherlock {
@ -423,6 +424,8 @@ void ScalpelEngine::showOpening() {
if (isDemo() && _interactiveFl)
return;
if (!TsAGE::Logo::show(this))
return;
if (!showCityCutscene())
return;
if (!showAlleyCutscene())

View file

@ -0,0 +1,139 @@
/* 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 "sherlock/scalpel/tsage/logo.h"
#include "sherlock/scalpel/scalpel.h"
namespace Sherlock {
namespace Scalpel {
namespace TsAGE {
bool Logo::show(ScalpelEngine *vm) {
Events &events = *vm->_events;
Logo *logo = new Logo(vm);
bool interrupted = false;
while (!logo->finished()) {
logo->nextFrame();
events.wait(2);
events.setButtonState();
interrupted = vm->shouldQuit() || events.kbHit() || events._pressed;
if (interrupted) {
events.clearEvents();
break;
}
}
delete logo;
return !interrupted;
}
Logo::Logo(ScalpelEngine *vm) : _vm(vm), _lib("sf3.rlb"), _surface(vm->_screen->w(), vm->_screen->h()) {
// Initialize frame counter
_counter = 0;
// Set up the palettes
Common::fill(&_palette1[0], &_palette1[PALETTE_SIZE], 0);
Common::fill(&_palette1[0], &_palette2[PALETTE_SIZE], 0);
Common::fill(&_palette1[0], &_palette3[PALETTE_SIZE], 0);
_lib.getPalette(_palette1, 1111);
_lib.getPalette(_palette1, 10);
_lib.getPalette(_palette2, 1111);
_lib.getPalette(_palette2, 1);
_lib.getPalette(_palette3, 1111);
_lib.getPalette(_palette3, 14);
}
bool Logo::finished() const {
return false;
}
void Logo::nextFrame() {
switch (_counter++) {
case 0:
loadBackground();
fade(_palette1);
break;
default:
break;
}
}
void Logo::loadBackground() {
Screen &screen = *_vm->_screen;
for (int idx = 0; idx < 4; ++idx) {
// Get the portion of the screen
Common::SeekableReadStream *stream = _lib.getResource(RES_BITMAP, 10, idx);
// Load it onto the surface
Common::Point pt((idx / 2) * (_surface.w() / 2), (idx % 2) * (_surface.h() / 2));
for (int y = 0; y < (_surface.h() / 2); ++y, ++pt.y) {
byte *pDest = (byte *)_surface.getBasePtr(pt.x, pt.y);
stream->read(pDest, _surface.w() / 2);
}
// _backgroundBounds = Rect(0, 0, READ_LE_UINT16(data), READ_LE_UINT16(data + 2));
delete stream;
}
// Default to a blank palette
byte palette[PALETTE_SIZE];
Common::fill(&palette[0], &palette[PALETTE_SIZE], 0);
screen.setPalette(palette);
// Copy the surface to the screen
screen.blitFrom(_surface);
}
void Logo::fade(const byte palette[PALETTE_SIZE]) {
Events &events = *_vm->_events;
Screen &screen = *_vm->_screen;
byte tempPalette[PALETTE_SIZE];
for (int percent = 0; percent < 100; percent += 6) {
for (int palIndex = 0; palIndex < 256; ++palIndex) {
const byte *palP = (const byte *)&palette[palIndex * 3];
byte *destP = &tempPalette[palIndex * 3];
for (int rgbIndex = 0; rgbIndex < 3; ++rgbIndex, ++palP, ++destP) {
*destP = (int)*palP * percent / 100;
}
}
screen.setPalette(tempPalette);
events.wait(1);
}
// Set final palette
screen.setPalette(palette);
}
} // end of namespace TsAGE
} // end of namespace Scalpel
} // end of namespace Sherlock

View file

@ -0,0 +1,77 @@
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef SHERLOCK_SCALPEL_TSAGE_LOGO_H
#define SHERLOCK_SCALPEL_TSAGE_LOGO_H
#include "common/scummsys.h"
#include "common/array.h"
#include "common/file.h"
#include "common/list.h"
#include "common/str.h"
#include "common/str-array.h"
#include "common/util.h"
#include "graphics/surface.h"
#include "sherlock/scalpel/tsage/resources.h"
#include "sherlock/screen.h"
namespace Sherlock {
namespace Scalpel {
class ScalpelEngine;
namespace TsAGE {
class Logo {
private:
ScalpelEngine *_vm;
TLib _lib;
Surface _surface;
int _counter;
byte _palette1[PALETTE_SIZE];
byte _palette2[PALETTE_SIZE];
byte _palette3[PALETTE_SIZE];
Logo(ScalpelEngine *vm);
void nextFrame();
bool finished() const;
/**
* Load the background for the scene
*/
void loadBackground();
/**
* Fade from the current palette to a new one
*/
void fade(const byte palette[PALETTE_SIZE]);
public:
static bool show(ScalpelEngine *vm);
};
} // end of namespace TsAGE
} // end of namespace Scalpel
} // end of namespace Sherlock
#endif

View file

@ -0,0 +1,373 @@
/* 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/memstream.h"
#include "common/stack.h"
#include "sherlock/scalpel/tsage/resources.h"
namespace Sherlock {
namespace Scalpel {
namespace TsAGE {
static uint16 bitMasks[4] = {0x1ff, 0x3ff, 0x7ff, 0xfff};
uint16 BitReader::readToken() {
assert((numBits >= 9) && (numBits <= 12));
uint16 result = _remainder;
int bitsLeft = numBits - _bitsLeft;
int bitOffset = _bitsLeft;
_bitsLeft = 0;
while (bitsLeft >= 0) {
_remainder = readByte();
result |= _remainder << bitOffset;
bitsLeft -= 8;
bitOffset += 8;
}
_bitsLeft = -bitsLeft;
_remainder >>= 8 - _bitsLeft;
return result & bitMasks[numBits - 9];
}
/*-------------------------------------------------------------------------*/
TLib::TLib(const Common::String &filename) : _filename(filename) {
// If the resource strings list isn't yet loaded, load them
if (_resStrings.size() == 0) {
Common::File f;
if (f.open("tsage.cfg")) {
while (!f.eos()) {
_resStrings.push_back(f.readLine());
}
f.close();
}
}
if (!_file.open(filename))
error("Missing file %s", filename.c_str());
loadIndex();
}
TLib::~TLib() {
_resStrings.clear();
}
/**
* Load a section index from the given position in the file
*/
void TLib::loadSection(uint32 fileOffset) {
_resources.clear();
_file.seek(fileOffset);
_sections.fileOffset = fileOffset;
loadSection(_file, _resources);
}
struct DecodeReference {
uint16 vWord;
uint8 vByte;
};
/**
* Gets a resource from the currently loaded section
*/
Common::SeekableReadStream *TLib::getResource(uint16 id, bool suppressErrors) {
// Scan for an entry for the given Id
ResourceEntry *re = nullptr;
ResourceList::iterator iter;
for (iter = _resources.begin(); iter != _resources.end(); ++iter) {
if ((*iter).id == id) {
re = &(*iter);
break;
}
}
if (!re) {
if (suppressErrors)
return nullptr;
error("Could not find resource Id #%d", id);
}
if (!re->isCompressed) {
// Read in the resource data and return it
byte *dataP = (byte *)malloc(re->size);
_file.seek(_sections.fileOffset + re->fileOffset);
_file.read(dataP, re->size);
return new Common::MemoryReadStream(dataP, re->size, DisposeAfterUse::YES);
}
/*
* Decompress the data block
*/
_file.seek(_sections.fileOffset + re->fileOffset);
Common::ReadStream *compStream = _file.readStream(re->size);
BitReader bitReader(*compStream);
byte *dataOut = (byte *)malloc(re->uncompressedSize);
byte *destP = dataOut;
uint bytesWritten = 0;
uint16 ctrCurrent = 0x102, ctrMax = 0x200;
uint16 word_48050 = 0, currentToken = 0, word_48054 =0;
byte byte_49068 = 0, byte_49069 = 0;
const uint tableSize = 0x1000;
DecodeReference *table = (DecodeReference *)malloc(tableSize * sizeof(DecodeReference));
if (!table)
error("[TLib::getResource] Cannot allocate table buffer");
for (uint i = 0; i < tableSize; ++i) {
table[i].vByte = table[i].vWord = 0;
}
Common::Stack<uint16> tokenList;
for (;;) {
// Get the next decode token
uint16 token = bitReader.readToken();
// Handle the token
if (token == 0x101) {
// End of compressed stream
break;
} else if (token == 0x100) {
// Reset bit-rate
bitReader.numBits = 9;
ctrMax = 0x200;
ctrCurrent = 0x102;
// Set variables with next token
currentToken = word_48050 = bitReader.readToken();
byte_49069 = byte_49068 = (byte)currentToken;
++bytesWritten;
assert(bytesWritten <= re->uncompressedSize);
*destP++ = byte_49069;
} else {
word_48054 = word_48050 = token;
if (token >= ctrCurrent) {
word_48050 = currentToken;
tokenList.push(byte_49068);
}
while (word_48050 >= 0x100) {
assert(word_48050 < 0x1000);
tokenList.push(table[word_48050].vByte);
word_48050 = table[word_48050].vWord;
}
byte_49069 = byte_49068 = (byte)word_48050;
tokenList.push(word_48050);
// Write out any cached tokens
while (!tokenList.empty()) {
++bytesWritten;
assert(bytesWritten <= re->uncompressedSize);
*destP++ = tokenList.pop();
}
assert(ctrCurrent < 0x1000);
table[ctrCurrent].vByte = byte_49069;
table[ctrCurrent].vWord = currentToken;
++ctrCurrent;
currentToken = word_48054;
if ((ctrCurrent >= ctrMax) && (bitReader.numBits != 12)) {
// Move to the next higher bit-rate
++bitReader.numBits;
ctrMax <<= 1;
}
}
}
free(table);
assert(bytesWritten == re->uncompressedSize);
delete compStream;
return new Common::MemoryReadStream(dataOut, re->uncompressedSize, DisposeAfterUse::YES);
}
/**
* Finds the correct section and loads the specified resource within it
*/
Common::SeekableReadStream *TLib::getResource(ResourceType resType, uint16 resNum, uint16 rlbNum, bool suppressErrors) {
SectionList::iterator i = _sections.begin();
while ((i != _sections.end()) && ((*i).resType != resType || (*i).resNum != resNum))
++i;
if (i == _sections.end()) {
if (suppressErrors)
return nullptr;
error("Unknown resource type %d num %d", resType, resNum);
}
loadSection((*i).fileOffset);
return getResource(rlbNum, suppressErrors);
}
/**
* Gets the offset of the start of a resource in the resource file
*/
uint32 TLib::getResourceStart(ResourceType resType, uint16 resNum, uint16 rlbNum, ResourceEntry &entry) {
// Find the correct section
SectionList::iterator i = _sections.begin();
while ((i != _sections.end()) && ((*i).resType != resType || (*i).resNum != resNum))
++i;
if (i == _sections.end()) {
error("Unknown resource type %d num %d", resType, resNum);
}
// Load in the section index
loadSection((*i).fileOffset);
// Scan for an entry for the given Id
ResourceEntry *re = nullptr;
ResourceList::iterator iter;
for (iter = _resources.begin(); iter != _resources.end(); ++iter) {
if ((*iter).id == rlbNum) {
re = &(*iter);
break;
}
}
// Throw an error if no resource was found, or the resource is compressed
if (!re || re->isCompressed)
error("Invalid resource Id #%d", rlbNum);
// Return the resource entry as well as the file offset
entry = *re;
return _sections.fileOffset + entry.fileOffset;
}
void TLib::loadIndex() {
uint16 resNum, configId, fileOffset;
// Load the root resources section
loadSection(0);
// Get the single resource from it
Common::SeekableReadStream *stream = getResource(0);
_sections.clear();
// Loop through reading the entries
while ((resNum = stream->readUint16LE()) != 0xffff) {
configId = stream->readUint16LE();
fileOffset = stream->readUint16LE();
SectionEntry se;
se.resNum = resNum;
se.resType = (ResourceType)(configId & 0x1f);
se.fileOffset = (((configId >> 5) & 0x7ff) << 16) | fileOffset;
_sections.push_back(se);
}
delete stream;
}
/**
* Retrieves the specified palette resource and returns it's data
*
* @paletteNum Specefies the palette number
*/
void TLib::getPalette(byte palette[PALETTE_SIZE], int paletteNum) {
// Get the specified palette
Common::SeekableReadStream *stream = getResource(RES_PALETTE, paletteNum, 0, true);
if (!stream)
return;
int startNum = stream->readUint16LE();
int numEntries = stream->readUint16LE();
assert((startNum < 256) && ((startNum + numEntries) <= 256));
stream->skip(2);
// Copy over the data
stream->read(&palette[startNum * 3], numEntries * 3);
delete stream;
}
/**
* Open up the given resource file using a passed file object. If the desired entry is found
* in the index, return the index entry for it, and move the file to the start of the resource
*/
bool TLib::scanIndex(Common::File &f, ResourceType resType, int rlbNum, int resNum,
ResourceEntry &resEntry) {
// Load the root section index
ResourceList resList;
loadSection(f, resList);
// Loop through the index for the desired entry
ResourceList::iterator iter;
for (iter = resList.begin(); iter != resList.end(); ++iter) {
ResourceEntry &re = *iter;
if (re.id == resNum) {
// Found it, so exit
resEntry = re;
f.seek(re.fileOffset);
return true;
}
}
// No matching entry found
return false;
}
/**
* Inner logic for decoding a section index into a passed resource list object
*/
void TLib::loadSection(Common::File &f, ResourceList &resources) {
if (f.readUint32BE() != 0x544D492D)
error("Data block is not valid Rlb data");
/*uint8 unknown1 = */f.readByte();
uint16 numEntries = f.readByte();
for (uint i = 0; i < numEntries; ++i) {
uint16 id = f.readUint16LE();
uint16 size = f.readUint16LE();
uint16 uncSize = f.readUint16LE();
uint8 sizeHi = f.readByte();
uint8 type = f.readByte() >> 5;
assert(type <= 1);
uint32 offset = f.readUint32LE();
ResourceEntry re;
re.id = id;
re.fileOffset = offset;
re.isCompressed = type != 0;
re.size = ((sizeHi & 0xF) << 16) | size;
re.uncompressedSize = ((sizeHi & 0xF0) << 12) | uncSize;
resources.push_back(re);
}
}
} // end of namespace TsAGE
} // end of namespace Scalpel
} // end of namespace Sherlock

View file

@ -0,0 +1,139 @@
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef SHERLOCK_SCALPEL_TSAGE_RESOURCES_H
#define SHERLOCK_SCALPEL_TSAGE_RESOURCES_H
#include "common/scummsys.h"
#include "common/array.h"
#include "common/file.h"
#include "common/list.h"
#include "common/str.h"
#include "common/str-array.h"
#include "common/util.h"
#include "graphics/surface.h"
#include "sherlock/screen.h"
namespace Sherlock {
namespace Scalpel {
namespace TsAGE {
// Magic number used by original game to identify valid memory blocks
const uint32 MEMORY_ENTRY_ID = 0xE11DA722;
const int MEMORY_POOL_SIZE = 1000;
enum ResourceType { RES_LIBRARY, RES_STRIP, RES_IMAGE, RES_PALETTE, RES_VISAGE, RES_SOUND, RES_MESSAGE,
RES_FONT, RES_POINTER, RES_BANK, RES_SND_DRIVER, RES_PRIORITY, RES_CONTROL, RES_WALKRGNS,
RES_BITMAP, RES_SAVE, RES_SEQUENCE,
// Return to Ringworld specific resource types
RT17, RT18, RT19, RT20, RT21, RT22, RT23, RT24, RT25, RT26, RT27, RT28, RT29, RT30, RT31
};
class SectionEntry {
public:
ResourceType resType;
uint16 resNum;
uint32 fileOffset;
SectionEntry() {
resType = RES_LIBRARY;
resNum = 0;
fileOffset = 0;
}
};
class ResourceEntry {
public:
uint16 id;
bool isCompressed;
uint32 fileOffset;
uint32 size;
uint32 uncompressedSize;
ResourceEntry() {
id = 0;
isCompressed = false;
fileOffset = 0;
size = 0;
uncompressedSize = 0;
}
};
typedef Common::List<ResourceEntry> ResourceList;
class SectionList : public Common::List<SectionEntry> {
public:
uint32 fileOffset;
SectionList() {
fileOffset = 0;
}
};
class BitReader {
private:
Common::ReadStream &_stream;
uint8 _remainder, _bitsLeft;
byte readByte() { return _stream.eos() ? 0 : _stream.readByte(); }
public:
BitReader(Common::ReadStream &s) : _stream(s) {
numBits = 9;
_remainder = 0;
_bitsLeft = 0;
}
uint16 readToken();
int numBits;
};
class TLib {
private:
Common::StringArray _resStrings;
private:
Common::File _file;
Common::String _filename;
ResourceList _resources;
SectionList _sections;
void loadSection(uint32 fileOffset);
void loadIndex();
static bool scanIndex(Common::File &f, ResourceType resType, int rlbNum, int resNum, ResourceEntry &resEntry);
static void loadSection(Common::File &f, ResourceList &resources);
public:
TLib(const Common::String &filename);
~TLib();
const Common::String &getFilename() { return _filename; }
const SectionList &getSections() { return _sections; }
Common::SeekableReadStream *getResource(uint16 id, bool suppressErrors = false);
Common::SeekableReadStream *getResource(ResourceType resType, uint16 resNum, uint16 rlbNum, bool suppressErrors = false);
uint32 getResourceStart(ResourceType resType, uint16 resNum, uint16 rlbNum, ResourceEntry &entry);
void getPalette(byte palette[PALETTE_SIZE], int paletteNum);
};
} // end of namespace TsAGE
} // end of namespace Scalpel
} // end of namespace Sherlock
#endif