scummvm/graphics/pict.cpp
2011-12-19 15:21:35 -05:00

575 lines
19 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/debug.h"
#include "common/endian.h"
#include "common/stream.h"
#include "common/substream.h"
#include "common/textconsole.h"
#include "graphics/jpeg.h"
#include "graphics/pict.h"
#include "graphics/surface.h"
namespace Graphics {
// The PICT code is based off of the QuickDraw specs:
// http://developer.apple.com/legacy/mac/library/documentation/mac/QuickDraw/QuickDraw-461.html
// http://developer.apple.com/legacy/mac/library/documentation/mac/QuickDraw/QuickDraw-269.html
PictDecoder::PictDecoder(PixelFormat pixelFormat) {
_jpeg = new JPEG();
_pixelFormat = pixelFormat;
}
PictDecoder::~PictDecoder() {
delete _jpeg;
}
#define OPCODE(a, b, c) _opcodes.push_back(PICTOpcode(a, &PictDecoder::b, c))
void PictDecoder::setupOpcodesCommon() {
OPCODE(0x0000, o_nop, "NOP");
OPCODE(0x0001, o_clip, "Clip");
OPCODE(0x0003, o_txFont, "TxFont");
OPCODE(0x0004, o_txFace, "TxFace");
OPCODE(0x0007, o_pnSize, "PnSize");
OPCODE(0x000D, o_txSize, "TxSize");
OPCODE(0x0010, o_txRatio, "TxRatio");
OPCODE(0x0011, o_versionOp, "VersionOp");
OPCODE(0x001E, o_nop, "DefHilite");
OPCODE(0x0028, o_longText, "LongText");
OPCODE(0x00A1, o_longComment, "LongComment");
OPCODE(0x00FF, o_opEndPic, "OpEndPic");
OPCODE(0x0C00, o_headerOp, "HeaderOp");
}
void PictDecoder::setupOpcodesNormal() {
setupOpcodesCommon();
OPCODE(0x0098, on_packBitsRect, "PackBitsRect");
OPCODE(0x009A, on_directBitsRect, "DirectBitsRect");
OPCODE(0x8200, on_compressedQuickTime, "CompressedQuickTime");
}
void PictDecoder::setupOpcodesQuickTime() {
setupOpcodesCommon();
OPCODE(0x0098, oq_packBitsRect, "PackBitsRect");
OPCODE(0x009A, oq_directBitsRect, "DirectBitsRect");
OPCODE(0x8200, oq_compressedQuickTime, "CompressedQuickTime");
}
#undef OPCODE
void PictDecoder::o_nop(Common::SeekableReadStream *) {
// Nothing to do
}
void PictDecoder::o_clip(Common::SeekableReadStream *stream) {
// Ignore
stream->skip(stream->readUint16BE() - 2);
}
void PictDecoder::o_txFont(Common::SeekableReadStream *stream) {
// Ignore
stream->readUint16BE();
}
void PictDecoder::o_txFace(Common::SeekableReadStream *stream) {
// Ignore
stream->readByte();
}
void PictDecoder::o_pnSize(Common::SeekableReadStream *stream) {
// Ignore
stream->readUint16BE();
stream->readUint16BE();
}
void PictDecoder::o_txSize(Common::SeekableReadStream *stream) {
// Ignore
stream->readUint16BE();
}
void PictDecoder::o_txRatio(Common::SeekableReadStream *stream) {
// Ignore
stream->readUint16BE();
stream->readUint16BE();
stream->readUint16BE();
stream->readUint16BE();
}
void PictDecoder::o_versionOp(Common::SeekableReadStream *stream) {
// We only support v2 extended
if (stream->readUint16BE() != 0x02FF)
error("Unknown PICT version");
}
void PictDecoder::o_longText(Common::SeekableReadStream *stream) {
// Ignore
stream->readUint16BE();
stream->readUint16BE();
stream->skip(stream->readByte());
}
void PictDecoder::o_longComment(Common::SeekableReadStream *stream) {
// Ignore
stream->readUint16BE();
stream->skip(stream->readUint16BE());
}
void PictDecoder::o_opEndPic(Common::SeekableReadStream *stream) {
// We've reached the end of the picture
_continueParsing = false;
}
void PictDecoder::o_headerOp(Common::SeekableReadStream *stream) {
// Read the basic header, but we don't really have to do anything with it
/* uint16 version = */ stream->readUint16BE();
stream->readUint16BE(); // Reserved
/* uint32 hRes = */ stream->readUint32BE();
/* uint32 vRes = */ stream->readUint32BE();
Common::Rect origResRect;
origResRect.top = stream->readUint16BE();
origResRect.left = stream->readUint16BE();
origResRect.bottom = stream->readUint16BE();
origResRect.right = stream->readUint16BE();
stream->readUint32BE(); // Reserved
}
void PictDecoder::on_packBitsRect(Common::SeekableReadStream *stream) {
// Unpack data (8bpp or lower)
unpackBitsRect(stream, true);
}
void PictDecoder::on_directBitsRect(Common::SeekableReadStream *stream) {
// Unpack data (16bpp or higher)
unpackBitsRect(stream, false);
}
void PictDecoder::on_compressedQuickTime(Common::SeekableReadStream *stream) {
// OK, here's the fun. We get to completely change how QuickDraw draws
// the data in PICT files.
// Swap out the opcodes to the new ones
_opcodes.clear();
setupOpcodesQuickTime();
// We set up the surface for JPEG here too
if (!_outputSurface)
_outputSurface = new Graphics::Surface();
_outputSurface->create(_imageRect.width(), _imageRect.height(), _pixelFormat);
// We'll decode the first QuickTime data from here, but the QuickTime-specific
// opcodes will take over from here on out. Normal opcodes, signing off.
decodeCompressedQuickTime(stream);
}
void PictDecoder::oq_packBitsRect(Common::SeekableReadStream *stream) {
// Skip any data here (8bpp or lower)
skipBitsRect(stream, true);
}
void PictDecoder::oq_directBitsRect(Common::SeekableReadStream *stream) {
// Skip any data here (16bpp or higher)
skipBitsRect(stream, false);
}
void PictDecoder::oq_compressedQuickTime(Common::SeekableReadStream *stream) {
// Just pass the data along
decodeCompressedQuickTime(stream);
}
Surface *PictDecoder::decodeImage(Common::SeekableReadStream *stream, byte *palette) {
assert(stream);
// Initialize opcodes to their normal state
_opcodes.clear();
setupOpcodesNormal();
_outputSurface = 0;
_continueParsing = true;
memset(_palette, 0, sizeof(_palette));
uint16 fileSize = stream->readUint16BE();
// If we have no file size here, we probably have a PICT from a file
// and not a resource. The other two bytes are the fileSize which we
// don't actually need (and already read if from a resource).
if (!fileSize)
stream->seek(512 + 2);
_imageRect.top = stream->readUint16BE();
_imageRect.left = stream->readUint16BE();
_imageRect.bottom = stream->readUint16BE();
_imageRect.right = stream->readUint16BE();
_imageRect.debugPrint(0, "PICT Rect:");
// NOTE: This is only a subset of the full PICT format.
// - Only V2 (Extended) Images Supported
// - CompressedQuickTime (JPEG) compressed data is supported
// - DirectBitsRect/PackBitsRect compressed data is supported
for (uint32 opNum = 0; !stream->eos() && !stream->err() && stream->pos() < stream->size() && _continueParsing; opNum++) {
// PICT v2 opcodes are two bytes
uint16 opcode = stream->readUint16BE();
if (opNum == 0 && opcode != 0x0011)
error("Cannot find PICT version opcode");
else if (opNum == 1 && opcode != 0x0C00)
error("Cannot find PICT header opcode");
// Since opcodes are word-aligned, we need to mark our starting
// position here.
uint32 startPos = stream->pos();
for (uint32 i = 0; i < _opcodes.size(); i++) {
if (_opcodes[i].op == opcode) {
debug(4, "Running PICT opcode %04x '%s'", opcode, _opcodes[i].desc);
(this->*(_opcodes[i].proc))(stream);
break;
} else if (i == _opcodes.size() - 1) {
// Unknown opcode; attempt to continue forward
warning("Unknown PICT opcode %04x", opcode);
}
}
// Align
stream->skip((stream->pos() - startPos) & 1);
}
// If we got a palette throughout this nonsense, go and grab it
if (palette)
memcpy(palette, _palette, 256 * 3);
return _outputSurface;
}
PictDecoder::PixMap PictDecoder::readPixMap(Common::SeekableReadStream *stream, bool hasBaseAddr) {
PixMap pixMap;
pixMap.baseAddr = hasBaseAddr ? stream->readUint32BE() : 0;
pixMap.rowBytes = stream->readUint16BE() & 0x3fff;
pixMap.bounds.top = stream->readUint16BE();
pixMap.bounds.left = stream->readUint16BE();
pixMap.bounds.bottom = stream->readUint16BE();
pixMap.bounds.right = stream->readUint16BE();
pixMap.pmVersion = stream->readUint16BE();
pixMap.packType = stream->readUint16BE();
pixMap.packSize = stream->readUint32BE();
pixMap.hRes = stream->readUint32BE();
pixMap.vRes = stream->readUint32BE();
pixMap.pixelType = stream->readUint16BE();
pixMap.pixelSize = stream->readUint16BE();
pixMap.cmpCount = stream->readUint16BE();
pixMap.cmpSize = stream->readUint16BE();
pixMap.planeBytes = stream->readUint32BE();
pixMap.pmTable = stream->readUint32BE();
pixMap.pmReserved = stream->readUint32BE();
return pixMap;
}
struct PackBitsRectData {
PictDecoder::PixMap pixMap;
Common::Rect srcRect;
Common::Rect dstRect;
uint16 mode;
};
void PictDecoder::unpackBitsRect(Common::SeekableReadStream *stream, bool hasPalette) {
static const PixelFormat directBitsFormat16 = PixelFormat(2, 5, 5, 5, 0, 10, 5, 0, 0);
PackBitsRectData packBitsData;
packBitsData.pixMap = readPixMap(stream, !hasPalette);
// Read in the palette if there is one present
if (hasPalette) {
// See http://developer.apple.com/legacy/mac/library/documentation/mac/QuickDraw/QuickDraw-267.html
stream->readUint32BE(); // seed
stream->readUint16BE(); // flags
uint16 colorCount = stream->readUint16BE() + 1;
for (uint32 i = 0; i < colorCount; i++) {
stream->readUint16BE();
_palette[i * 3] = stream->readUint16BE() >> 8;
_palette[i * 3 + 1] = stream->readUint16BE() >> 8;
_palette[i * 3 + 2] = stream->readUint16BE() >> 8;
}
}
packBitsData.srcRect.top = stream->readUint16BE();
packBitsData.srcRect.left = stream->readUint16BE();
packBitsData.srcRect.bottom = stream->readUint16BE();
packBitsData.srcRect.right = stream->readUint16BE();
packBitsData.dstRect.top = stream->readUint16BE();
packBitsData.dstRect.left = stream->readUint16BE();
packBitsData.dstRect.bottom = stream->readUint16BE();
packBitsData.dstRect.right = stream->readUint16BE();
packBitsData.mode = stream->readUint16BE();
uint16 width = packBitsData.srcRect.width();
uint16 height = packBitsData.srcRect.height();
byte bytesPerPixel = 0;
if (packBitsData.pixMap.pixelSize <= 8)
bytesPerPixel = 1;
else if (packBitsData.pixMap.pixelSize == 32)
bytesPerPixel = packBitsData.pixMap.cmpCount;
else
bytesPerPixel = packBitsData.pixMap.pixelSize / 8;
_outputSurface = new Graphics::Surface();
_outputSurface->create(width, height, (bytesPerPixel == 1) ? PixelFormat::createFormatCLUT8() : _pixelFormat);
// Ensure we have enough space in the buffer to hold an entire line's worth of pixels
uint32 lineSize = MAX<int>(width * bytesPerPixel + (8 * 2 / packBitsData.pixMap.pixelSize), packBitsData.pixMap.rowBytes);
byte *buffer = new byte[lineSize * height];
// Read in amount of data per row
for (uint16 i = 0; i < packBitsData.pixMap.bounds.height(); i++) {
// NOTE: Compression 0 is "default". The format in SCI games is packed when 0.
// In the future, we may need to have something to set the "default" packing
// format, but this is good for now.
if (packBitsData.pixMap.packType == 1 || packBitsData.pixMap.rowBytes < 8) { // Unpacked, Pad-Byte (on 24-bit)
// TODO: Finish this. Hasn't been needed (yet).
error("Unpacked DirectBitsRect data (padded)");
} else if (packBitsData.pixMap.packType == 2) { // Unpacked, No Pad-Byte (on 24-bit)
// TODO: Finish this. Hasn't been needed (yet).
error("Unpacked DirectBitsRect data (not padded)");
} else if (packBitsData.pixMap.packType == 0 || packBitsData.pixMap.packType > 2) { // Packed
uint16 byteCount = (packBitsData.pixMap.rowBytes > 250) ? stream->readUint16BE() : stream->readByte();
unpackBitsLine(buffer + i * _outputSurface->w * bytesPerPixel, packBitsData.pixMap.rowBytes, stream->readStream(byteCount), packBitsData.pixMap.pixelSize, bytesPerPixel);
}
}
switch (bytesPerPixel) {
case 1:
// Just copy to the image
memcpy(_outputSurface->pixels, buffer, _outputSurface->w * _outputSurface->h);
break;
case 2:
// Convert from 16-bit to whatever surface we need
for (uint16 y = 0; y < _outputSurface->h; y++) {
for (uint16 x = 0; x < _outputSurface->w; x++) {
byte r = 0, g = 0, b = 0;
uint32 color = READ_BE_UINT16(buffer + (y * _outputSurface->w + x) * bytesPerPixel);
directBitsFormat16.colorToRGB(color, r, g, b);
if (_pixelFormat.bytesPerPixel == 2)
*((uint16 *)_outputSurface->getBasePtr(x, y)) = _pixelFormat.RGBToColor(r, g, b);
else
*((uint32 *)_outputSurface->getBasePtr(x, y)) = _pixelFormat.RGBToColor(r, g, b);
}
}
break;
case 3:
// Convert from 24-bit (planar!) to whatever surface we need
for (uint16 y = 0; y < _outputSurface->h; y++) {
for (uint16 x = 0; x < _outputSurface->w; x++) {
byte r = *(buffer + y * _outputSurface->w * 3 + x);
byte g = *(buffer + y * _outputSurface->w * 3 + _outputSurface->w + x);
byte b = *(buffer + y * _outputSurface->w * 3 + _outputSurface->w * 2 + x);
if (_pixelFormat.bytesPerPixel == 2)
*((uint16 *)_outputSurface->getBasePtr(x, y)) = _pixelFormat.RGBToColor(r, g, b);
else
*((uint32 *)_outputSurface->getBasePtr(x, y)) = _pixelFormat.RGBToColor(r, g, b);
}
}
break;
case 4:
// Convert from 32-bit (planar!) to whatever surface we need
for (uint16 y = 0; y < _outputSurface->h; y++) {
for (uint16 x = 0; x < _outputSurface->w; x++) {
byte r = *(buffer + y * _outputSurface->w * 4 + x);
byte g = *(buffer + y * _outputSurface->w * 4 + _outputSurface->w + x);
byte b = *(buffer + y * _outputSurface->w * 4 + _outputSurface->w * 2 + x);
byte a = *(buffer + y * _outputSurface->w * 4 + _outputSurface->w * 3 + x);
if (_pixelFormat.bytesPerPixel == 2)
*((uint16 *)_outputSurface->getBasePtr(x, y)) = _pixelFormat.ARGBToColor(r, g, b, a);
else
*((uint32 *)_outputSurface->getBasePtr(x, y)) = _pixelFormat.ARGBToColor(r, g, b, a);
}
}
break;
}
delete[] buffer;
}
void PictDecoder::unpackBitsLine(byte *out, uint32 length, Common::SeekableReadStream *data, byte bitsPerPixel, byte bytesPerPixel) {
uint32 dataDecoded = 0;
byte bytesPerDecode = (bytesPerPixel == 2) ? 2 : 1;
while (data->pos() < data->size() && dataDecoded < length) {
byte op = data->readByte();
if (op & 0x80) {
uint32 runSize = (op ^ 255) + 2;
uint16 value = (bytesPerDecode == 2) ? data->readUint16BE() : data->readByte();
for (uint32 i = 0; i < runSize; i++) {
if (bytesPerDecode == 2) {
WRITE_BE_UINT16(out, value);
out += 2;
} else {
outputPixelBuffer(out, value, bitsPerPixel);
}
}
dataDecoded += runSize * bytesPerDecode;
} else {
uint32 runSize = (op + 1) * bytesPerDecode;
for (uint32 i = 0; i < runSize; i++)
outputPixelBuffer(out, data->readByte(), bitsPerPixel);
dataDecoded += runSize;
}
}
// HACK: Even if the data is 24-bit, rowBytes is still 32-bit
if (bytesPerPixel == 3)
dataDecoded += length / 4;
if (length != dataDecoded)
warning("Mismatched PackBits read (%d/%d)", dataDecoded, length);
delete data;
}
void PictDecoder::skipBitsRect(Common::SeekableReadStream *stream, bool hasPalette) {
// Step through a PackBitsRect/DirectBitsRect function
if (!hasPalette)
stream->readUint32BE();
uint16 rowBytes = stream->readUint16BE();
uint16 height = stream->readUint16BE();
stream->readUint16BE();
height = stream->readUint16BE() - height;
stream->readUint16BE();
uint16 packType;
uint16 pixelSize; // FIXME: unused
// Top two bits signify PixMap vs BitMap
if (rowBytes & 0xC000) {
// PixMap
stream->readUint16BE();
packType = stream->readUint16BE();
stream->skip(14);
pixelSize = stream->readUint16BE();
stream->skip(16);
if (hasPalette) {
stream->readUint32BE();
stream->readUint16BE();
stream->skip((stream->readUint16BE() + 1) * 8);
}
rowBytes &= 0x3FFF;
} else {
// BitMap
packType = 0;
pixelSize = 1;
}
stream->skip(18);
for (uint16 i = 0; i < height; i++) {
if (packType == 1 || packType == 2 || rowBytes < 8)
error("Unpacked PackBitsRect data");
else if (packType == 0 || packType > 2)
stream->skip((rowBytes > 250) ? stream->readUint16BE() : stream->readByte());
}
}
void PictDecoder::outputPixelBuffer(byte *&out, byte value, byte bitsPerPixel) {
switch (bitsPerPixel) {
case 1:
for (int i = 7; i >= 0; i--)
*out++ = (value >> i) & 1;
break;
case 2:
for (int i = 6; i >= 0; i -= 2)
*out++ = (value >> i) & 3;
break;
case 4:
*out++ = (value >> 4) & 0xf;
*out++ = value & 0xf;
break;
default:
*out++ = value;
}
}
// Compressed QuickTime details can be found here:
// http://developer.apple.com/legacy/mac/library/#documentation/QuickTime/Rm/CompressDecompress/ImageComprMgr/B-Chapter/2TheImageCompression.html
// http://developer.apple.com/legacy/mac/library/#documentation/QuickTime/Rm/CompressDecompress/ImageComprMgr/F-Chapter/6WorkingwiththeImage.html
void PictDecoder::decodeCompressedQuickTime(Common::SeekableReadStream *stream) {
// First, read all the fields from the opcode
uint32 dataSize = stream->readUint32BE();
uint32 startPos = stream->pos();
/* uint16 version = */ stream->readUint16BE();
// Read in the display matrix
uint32 matrix[3][3];
for (uint32 i = 0; i < 3; i++)
for (uint32 j = 0; j < 3; j++)
matrix[i][j] = stream->readUint32BE();
// We currently only support offseting images vertically from the matrix
uint16 xOffset = 0;
uint16 yOffset = matrix[2][1] >> 16;
uint32 matteSize = stream->readUint32BE();
stream->skip(8); // matte rect
/* uint16 transferMode = */ stream->readUint16BE();
stream->skip(8); // src rect
/* uint32 accuracy = */ stream->readUint32BE();
uint32 maskSize = stream->readUint32BE();
// Skip the matte and mask
stream->skip(matteSize + maskSize);
// Now we've reached the image descriptor, so read the relevant data from that
uint32 idStart = stream->pos();
uint32 idSize = stream->readUint32BE();
stream->skip(40); // miscellaneous stuff
uint32 jpegSize = stream->readUint32BE();
stream->skip(idSize - (stream->pos() - idStart)); // more useless stuff
Common::SeekableReadStream *jpegStream = new Common::SeekableSubReadStream(stream, stream->pos(), stream->pos() + jpegSize);
if (!_jpeg->read(jpegStream))
error("PictDecoder::decodeCompressedQuickTime(): Could not decode JPEG data");
Graphics::Surface *jpegSurface = _jpeg->getSurface(_pixelFormat);
for (uint16 y = 0; y < jpegSurface->h; y++)
memcpy(_outputSurface->getBasePtr(0 + xOffset, y + yOffset), jpegSurface->getBasePtr(0, y), jpegSurface->w * _pixelFormat.bytesPerPixel);
stream->seek(startPos + dataSize);
delete jpegStream;
}
} // End of namespace Graphics