Initial commit

engines/sci/video/seq_decoder.cpp

@@ -0,0 +1,236 @@
+/* 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 3 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, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include "common/endian.h"
+#include "common/stream.h"
+#include "common/system.h"
+#include "common/textconsole.h"
+
+#include "graphics/surface.h"
+
+#include "sci/video/seq_decoder.h"
+
+namespace Sci {
+
+enum seqPalTypes {
+	kSeqPalVariable = 0,
+	kSeqPalConstant = 1
+};
+
+enum seqFrameTypes {
+	kSeqFrameFull = 0,
+	kSeqFrameDiff = 1
+};
+
+SEQDecoder::SEQDecoder(uint frameDelay) : _frameDelay(frameDelay) {
+}
+
+SEQDecoder::~SEQDecoder() {
+	close();
+}
+
+bool SEQDecoder::loadStream(Common::SeekableReadStream *stream) {
+	close();
+
+	addTrack(new SEQVideoTrack(stream, _frameDelay));
+
+	return true;
+}
+
+SEQDecoder::SEQVideoTrack::SEQVideoTrack(Common::SeekableReadStream *stream, uint frameDelay) {
+	assert(stream);
+	assert(frameDelay != 0);
+	_fileStream = stream;
+	_frameDelay = frameDelay;
+	_curFrame = -1;
+
+	_surface = new Graphics::Surface();
+	_surface->create(SEQ_SCREEN_WIDTH, SEQ_SCREEN_HEIGHT, Graphics::PixelFormat::createFormatCLUT8());
+
+	_frameCount = _fileStream->readUint16LE();
+
+	// Set initial palette
+	readPaletteChunk(_fileStream->readUint32LE());
+}
+
+SEQDecoder::SEQVideoTrack::~SEQVideoTrack() {
+	delete _fileStream;
+	_surface->free();
+	delete _surface;
+}
+
+void SEQDecoder::SEQVideoTrack::readPaletteChunk(uint16 chunkSize) {
+	byte *paletteData = new byte[chunkSize];
+	_fileStream->read(paletteData, chunkSize);
+
+	// SCI1.1 palette
+	byte palFormat = paletteData[32];
+	uint16 palColorStart = READ_LE_UINT16(paletteData + 25);
+	uint16 palColorCount = READ_LE_UINT16(paletteData + 29);
+
+	int palOffset = 37;
+	memset(_palette, 0, 256 * 3);
+
+	for (uint16 colorNo = palColorStart; colorNo < palColorStart + palColorCount; colorNo++) {
+		if (palFormat == kSeqPalVariable)
+			palOffset++;
+		_palette[colorNo * 3 + 0] = paletteData[palOffset++];
+		_palette[colorNo * 3 + 1] = paletteData[palOffset++];
+		_palette[colorNo * 3 + 2] = paletteData[palOffset++];
+	}
+
+	_dirtyPalette = true;
+	delete[] paletteData;
+}
+
+const Graphics::Surface *SEQDecoder::SEQVideoTrack::decodeNextFrame() {
+	int16 frameWidth = _fileStream->readUint16LE();
+	int16 frameHeight = _fileStream->readUint16LE();
+	int16 frameLeft = _fileStream->readUint16LE();
+	int16 frameTop = _fileStream->readUint16LE();
+	byte colorKey = _fileStream->readByte();
+	byte frameType = _fileStream->readByte();
+	_fileStream->skip(2);
+	uint16 frameSize = _fileStream->readUint16LE();
+	_fileStream->skip(2);
+	uint16 rleSize = _fileStream->readUint16LE();
+	_fileStream->skip(6);
+	uint32 offset = _fileStream->readUint32LE();
+
+	_fileStream->seek(offset);
+
+	if (frameType == kSeqFrameFull) {
+		byte *dst = (byte *)_surface->getBasePtr(frameLeft, frameTop);
+
+		byte *linebuf = new byte[frameWidth];
+
+		do {
+			_fileStream->read(linebuf, frameWidth);
+			memcpy(dst, linebuf, frameWidth);
+			dst += SEQ_SCREEN_WIDTH;
+		} while (--frameHeight);
+
+		delete[] linebuf;
+	} else {
+		byte *buf = new byte[frameSize];
+		_fileStream->read(buf, frameSize);
+		decodeFrame(buf, rleSize, buf + rleSize, frameSize - rleSize, (byte *)_surface->getBasePtr(0, frameTop), frameLeft, frameWidth, frameHeight, colorKey);
+		delete[] buf;
+	}
+
+	_curFrame++;
+	return _surface;
+}
+
+#define WRITE_TO_BUFFER(n) \
+	if (writeRow * SEQ_SCREEN_WIDTH + writeCol + (n) > SEQ_SCREEN_WIDTH * height) { \
+		warning("SEQ player: writing out of bounds, aborting"); \
+		return false; \
+	} \
+	if (litPos + (n) > litSize) { \
+		warning("SEQ player: reading out of bounds, aborting"); \
+	} \
+	memcpy(dest + writeRow * SEQ_SCREEN_WIDTH + writeCol, litData + litPos, n);
+
+bool SEQDecoder::SEQVideoTrack::decodeFrame(byte *rleData, int rleSize, byte *litData, int litSize, byte *dest, int left, int width, int height, int colorKey) {
+	int writeRow = 0;
+	int writeCol = left;
+	int litPos = 0;
+	int rlePos = 0;
+
+	while (rlePos < rleSize) {
+		int op = rleData[rlePos++];
+
+		if ((op & 0xc0) == 0xc0) {
+			op &= 0x3f;
+			if (op == 0) {
+				// Go to next line in target buffer
+				writeRow++;
+				writeCol = left;
+			} else {
+				// Skip bytes on current line
+				writeCol += op;
+			}
+		} else if (op & 0x80) {
+			op &= 0x3f;
+			if (op == 0) {
+				// Copy remainder of current line
+				int rem = width - (writeCol - left);
+
+				WRITE_TO_BUFFER(rem);
+				writeRow++;
+				writeCol = left;
+				litPos += rem;
+			} else {
+				// Copy bytes
+				WRITE_TO_BUFFER(op);
+				writeCol += op;
+				litPos += op;
+			}
+		} else {
+			uint16 count = ((op & 7) << 8) | rleData[rlePos++];
+
+			switch (op >> 3) {
+			case 2:
+				// Skip bytes
+				writeCol += count;
+				break;
+			case 3:
+				// Copy bytes
+				WRITE_TO_BUFFER(count);
+				writeCol += count;
+				litPos += count;
+				break;
+			case 6: {
+				// Copy rows
+				if (count == 0)
+					count = height - writeRow;
+
+				for (int i = 0; i < count; i++) {
+					WRITE_TO_BUFFER(width);
+					litPos += width;
+					writeRow++;
+				}
+				break;
+			}
+			case 7:
+				// Skip rows
+				if (count == 0)
+					count = height - writeRow;
+
+				writeRow += count;
+				break;
+			default:
+				warning("Unsupported operation %i encountered", op >> 3);
+				return false;
+			}
+		}
+	}
+
+	return true;
+}
+
+const byte *SEQDecoder::SEQVideoTrack::getPalette() const {
+	_dirtyPalette = false;
+	return _palette;
+}
+
+} // End of namespace Sci

engines/sci/video/seq_decoder.h

@@ -0,0 +1,89 @@
+/* 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 3 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, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef SCI_VIDEO_SEQ_DECODER_H
+#define SCI_VIDEO_SEQ_DECODER_H
+
+#include "common/rational.h"
+#include "graphics/pixelformat.h"
+#include "video/video_decoder.h"
+
+namespace Common {
+class SeekableReadStream;
+}
+
+namespace Graphics {
+struct Surface;
+}
+
+namespace Sci {
+
+/**
+ * Implementation of the Sierra SEQ decoder, used in KQ6 DOS floppy/CD and GK1 DOS
+ */
+class SEQDecoder : public Video::VideoDecoder {
+public:
+	SEQDecoder(uint frameDelay);
+	~SEQDecoder() override;
+
+	bool loadStream(Common::SeekableReadStream *stream) override;
+
+private:
+	class SEQVideoTrack : public FixedRateVideoTrack {
+	public:
+		SEQVideoTrack(Common::SeekableReadStream *stream, uint frameDelay);
+		~SEQVideoTrack() override;
+
+		uint16 getWidth() const override { return SEQ_SCREEN_WIDTH; }
+		uint16 getHeight() const override { return SEQ_SCREEN_HEIGHT; }
+		Graphics::PixelFormat getPixelFormat() const override { return Graphics::PixelFormat::createFormatCLUT8(); }
+		int getCurFrame() const override { return _curFrame; }
+		int getFrameCount() const override { return _frameCount; }
+		const Graphics::Surface *decodeNextFrame() override;
+		const byte *getPalette() const override;
+		bool hasDirtyPalette() const override { return _dirtyPalette; }
+
+	protected:
+		Common::Rational getFrameRate() const override { return Common::Rational(60, _frameDelay); }
+
+	private:
+		enum {
+			SEQ_SCREEN_WIDTH = 320,
+			SEQ_SCREEN_HEIGHT = 200
+		};
+
+		void readPaletteChunk(uint16 chunkSize);
+		bool decodeFrame(byte *rleData, int rleSize, byte *litData, int litSize, byte *dest, int left, int width, int height, int colorKey);
+
+		Common::SeekableReadStream *_fileStream;
+		int _curFrame, _frameCount;
+		byte _palette[256 * 3];
+		mutable bool _dirtyPalette;
+		Graphics::Surface *_surface;
+		uint _frameDelay;
+	};
+
+	uint _frameDelay;
+};
+
+} // End of namespace Sci
+
+#endif // SCI_VIDEO_SEQ_DECODER_H