Merge remote-tracking branch 'upstream/master' into zvision

Conflicts:
	engines/zvision/animation/rlf_animation.cpp
	engines/zvision/animation_control.h
	engines/zvision/core/console.cpp
	engines/zvision/core/events.cpp
	engines/zvision/cursors/cursor.cpp
	engines/zvision/cursors/cursor_manager.cpp
	engines/zvision/cursors/cursor_manager.h
	engines/zvision/fonts/truetype_font.cpp
	engines/zvision/graphics/render_manager.cpp
	engines/zvision/graphics/render_manager.h
	engines/zvision/inventory/inventory_manager.h
	engines/zvision/inventory_manager.h
	engines/zvision/meta_animation.h
	engines/zvision/module.mk
	engines/zvision/scripting/actions.cpp
	engines/zvision/scripting/control.h
	engines/zvision/scripting/controls/animation_control.cpp
	engines/zvision/scripting/controls/animation_control.h
	engines/zvision/scripting/controls/input_control.cpp
	engines/zvision/scripting/controls/lever_control.cpp
	engines/zvision/scripting/controls/timer_node.cpp
	engines/zvision/scripting/controls/timer_node.h
	engines/zvision/scripting/puzzle.h
	engines/zvision/scripting/scr_file_handling.cpp
	engines/zvision/scripting/script_manager.cpp
	engines/zvision/scripting/script_manager.h
	engines/zvision/sidefx.cpp
	engines/zvision/sound/zork_raw.cpp
	engines/zvision/sound/zork_raw.h
	engines/zvision/video/video.cpp
	engines/zvision/video/zork_avi_decoder.h
	engines/zvision/zvision.cpp
	engines/zvision/zvision.h

1 files changed, 309 insertions, 0 deletions

diff --git a/image/codecs/cinepak.cpp b/image/codecs/cinepak.cpp
new file mode 100644
index 0000000000..8d5dbceb4a
--- /dev/null
+++ b/image/codecs/cinepak.cpp
@@ -0,0 +1,309 @@
+/* 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 "image/codecs/cinepak.h"
+
+#include "common/debug.h"
+#include "common/stream.h"
+#include "common/system.h"
+#include "common/textconsole.h"
+#include "common/util.h"
+
+#include "graphics/surface.h"
+
+// Code here partially based off of ffmpeg ;)
+
+namespace Image {
+
+#define PUT_PIXEL(offset, lum, u, v) \
+	if (_pixelFormat.bytesPerPixel != 1) { \
+		byte r = _clipTable[lum + (v << 1)]; \
+		byte g = _clipTable[lum - (u >> 1) - v]; \
+		byte b = _clipTable[lum + (u << 1)]; \
+		\
+		if (_pixelFormat.bytesPerPixel == 2) \
+			*((uint16 *)_curFrame.surface->getPixels() + offset) = _pixelFormat.RGBToColor(r, g, b); \
+		else \
+			*((uint32 *)_curFrame.surface->getPixels() + offset) = _pixelFormat.RGBToColor(r, g, b); \
+	} else \
+		*((byte *)_curFrame.surface->getPixels() + offset) = lum
+
+CinepakDecoder::CinepakDecoder(int bitsPerPixel) : Codec() {
+	_curFrame.surface = NULL;
+	_curFrame.strips = NULL;
+	_y = 0;
+
+	if (bitsPerPixel == 8)
+		_pixelFormat = Graphics::PixelFormat::createFormatCLUT8();
+	else
+		_pixelFormat = g_system->getScreenFormat();
+
+	// Create a lookup for the clip function
+	// This dramatically improves the performance of the color conversion
+	_clipTableBuf = new byte[1024];
+
+	for (uint i = 0; i < 1024; i++) {
+		if (i <= 512)
+			_clipTableBuf[i] = 0;
+		else if (i >= 768)
+			_clipTableBuf[i] = 255;
+		else
+			_clipTableBuf[i] = i - 512;
+	}
+
+	_clipTable = _clipTableBuf + 512;
+}
+
+CinepakDecoder::~CinepakDecoder() {
+	if (_curFrame.surface) {
+		_curFrame.surface->free();
+		delete _curFrame.surface;
+	}
+
+	delete[] _curFrame.strips;
+	delete[] _clipTableBuf;
+}
+
+const Graphics::Surface *CinepakDecoder::decodeFrame(Common::SeekableReadStream &stream) {
+	_curFrame.flags = stream.readByte();
+	_curFrame.length = (stream.readByte() << 16);
+	_curFrame.length |= stream.readUint16BE();
+	_curFrame.width = stream.readUint16BE();
+	_curFrame.height = stream.readUint16BE();
+	_curFrame.stripCount = stream.readUint16BE();
+
+	if (_curFrame.strips == NULL)
+		_curFrame.strips = new CinepakStrip[_curFrame.stripCount];
+
+	debug(4, "Cinepak Frame: Width = %d, Height = %d, Strip Count = %d", _curFrame.width, _curFrame.height, _curFrame.stripCount);
+
+	// Borrowed from FFMPEG. This should cut out the extra data Cinepak for Sega has (which is useless).
+	// The theory behind this is that this is here to confuse standard Cinepak decoders. But, we won't let that happen! ;)
+	if (_curFrame.length != (uint32)stream.size()) {
+		if (stream.readUint16BE() == 0xFE00)
+			stream.readUint32BE();
+		else if ((stream.size() % _curFrame.length) == 0)
+			stream.seek(-2, SEEK_CUR);
+	}
+
+	if (!_curFrame.surface) {
+		_curFrame.surface = new Graphics::Surface();
+		_curFrame.surface->create(_curFrame.width, _curFrame.height, _pixelFormat);
+	}
+
+	// Reset the y variable.
+	_y = 0;
+
+	for (uint16 i = 0; i < _curFrame.stripCount; i++) {
+		if (i > 0 && !(_curFrame.flags & 1)) { // Use codebooks from last strip
+			for (uint16 j = 0; j < 256; j++) {
+				_curFrame.strips[i].v1_codebook[j] = _curFrame.strips[i - 1].v1_codebook[j];
+				_curFrame.strips[i].v4_codebook[j] = _curFrame.strips[i - 1].v4_codebook[j];
+			}
+		}
+
+		_curFrame.strips[i].id = stream.readUint16BE();
+		_curFrame.strips[i].length = stream.readUint16BE() - 12; // Subtract the 12 byte header
+		_curFrame.strips[i].rect.top = _y; stream.readUint16BE(); // Ignore, substitute with our own.
+		_curFrame.strips[i].rect.left = 0; stream.readUint16BE(); // Ignore, substitute with our own
+		_curFrame.strips[i].rect.bottom = _y + stream.readUint16BE();
+		_curFrame.strips[i].rect.right = _curFrame.width; stream.readUint16BE(); // Ignore, substitute with our own
+
+		// Sanity check. Because Cinepak is based on 4x4 blocks, the width and height of each strip needs to be divisible by 4.
+		assert(!(_curFrame.strips[i].rect.width() % 4) && !(_curFrame.strips[i].rect.height() % 4));
+
+		uint32 pos = stream.pos();
+
+		while ((uint32)stream.pos() < (pos + _curFrame.strips[i].length) && !stream.eos()) {
+			byte chunkID = stream.readByte();
+
+			if (stream.eos())
+				break;
+
+			// Chunk Size is 24-bit, ignore the first 4 bytes
+			uint32 chunkSize = stream.readByte() << 16;
+			chunkSize += stream.readUint16BE() - 4;
+
+			int32 startPos = stream.pos();
+
+			switch (chunkID) {
+			case 0x20:
+			case 0x21:
+			case 0x24:
+			case 0x25:
+				loadCodebook(stream, i, 4, chunkID, chunkSize);
+				break;
+			case 0x22:
+			case 0x23:
+			case 0x26:
+			case 0x27:
+				loadCodebook(stream, i, 1, chunkID, chunkSize);
+				break;
+			case 0x30:
+			case 0x31:
+			case 0x32:
+				decodeVectors(stream, i, chunkID, chunkSize);
+				break;
+			default:
+				warning("Unknown Cinepak chunk ID %02x", chunkID);
+				return _curFrame.surface;
+			}
+
+			if (stream.pos() != startPos + (int32)chunkSize)
+				stream.seek(startPos + chunkSize);
+		}
+
+		_y = _curFrame.strips[i].rect.bottom;
+	}
+
+	return _curFrame.surface;
+}
+
+void CinepakDecoder::loadCodebook(Common::SeekableReadStream &stream, uint16 strip, byte codebookType, byte chunkID, uint32 chunkSize) {
+	CinepakCodebook *codebook = (codebookType == 1) ? _curFrame.strips[strip].v1_codebook : _curFrame.strips[strip].v4_codebook;
+
+	int32 startPos = stream.pos();
+	uint32 flag = 0, mask = 0;
+
+	for (uint16 i = 0; i < 256; i++) {
+		if ((chunkID & 0x01) && !(mask >>= 1)) {
+			if ((stream.pos() - startPos + 4) > (int32)chunkSize)
+				break;
+
+			flag  = stream.readUint32BE();
+			mask  = 0x80000000;
+		}
+
+		if (!(chunkID & 0x01) || (flag & mask)) {
+			byte n = (chunkID & 0x04) ? 4 : 6;
+			if ((stream.pos() - startPos + n) > (int32)chunkSize)
+				break;
+
+			for (byte j = 0; j < 4; j++)
+				codebook[i].y[j] = stream.readByte();
+
+			if (n == 6) {
+				codebook[i].u = stream.readSByte();
+				codebook[i].v = stream.readSByte();
+			} else {
+				// This codebook type indicates either greyscale or
+				// palettized video. For greyscale, default us to
+				// 0 for both u and v.
+				codebook[i].u = 0;
+				codebook[i].v = 0;
+			}
+		}
+	}
+}
+
+void CinepakDecoder::decodeVectors(Common::SeekableReadStream &stream, uint16 strip, byte chunkID, uint32 chunkSize) {
+	uint32 flag = 0, mask = 0;
+	uint32 iy[4];
+	int32 startPos = stream.pos();
+
+	for (uint16 y = _curFrame.strips[strip].rect.top; y < _curFrame.strips[strip].rect.bottom; y += 4) {
+		iy[0] = _curFrame.strips[strip].rect.left + y * _curFrame.width;
+		iy[1] = iy[0] + _curFrame.width;
+		iy[2] = iy[1] + _curFrame.width;
+		iy[3] = iy[2] + _curFrame.width;
+
+		for (uint16 x = _curFrame.strips[strip].rect.left; x < _curFrame.strips[strip].rect.right; x += 4) {
+			if ((chunkID & 0x01) && !(mask >>= 1)) {
+				if ((stream.pos() - startPos + 4) > (int32)chunkSize)
+					return;
+
+				flag  = stream.readUint32BE();
+				mask  = 0x80000000;
+			}
+
+			if (!(chunkID & 0x01) || (flag & mask)) {
+				if (!(chunkID & 0x02) && !(mask >>= 1)) {
+					if ((stream.pos() - startPos + 4) > (int32)chunkSize)
+						return;
+
+					flag  = stream.readUint32BE();
+					mask  = 0x80000000;
+				}
+
+				if ((chunkID & 0x02) || (~flag & mask)) {
+					if ((stream.pos() - startPos + 1) > (int32)chunkSize)
+						return;
+
+					// Get the codebook
+					CinepakCodebook codebook = _curFrame.strips[strip].v1_codebook[stream.readByte()];
+
+					PUT_PIXEL(iy[0] + 0, codebook.y[0], codebook.u, codebook.v);
+					PUT_PIXEL(iy[0] + 1, codebook.y[0], codebook.u, codebook.v);
+					PUT_PIXEL(iy[1] + 0, codebook.y[0], codebook.u, codebook.v);
+					PUT_PIXEL(iy[1] + 1, codebook.y[0], codebook.u, codebook.v);
+
+					PUT_PIXEL(iy[0] + 2, codebook.y[1], codebook.u, codebook.v);
+					PUT_PIXEL(iy[0] + 3, codebook.y[1], codebook.u, codebook.v);
+					PUT_PIXEL(iy[1] + 2, codebook.y[1], codebook.u, codebook.v);
+					PUT_PIXEL(iy[1] + 3, codebook.y[1], codebook.u, codebook.v);
+
+					PUT_PIXEL(iy[2] + 0, codebook.y[2], codebook.u, codebook.v);
+					PUT_PIXEL(iy[2] + 1, codebook.y[2], codebook.u, codebook.v);
+					PUT_PIXEL(iy[3] + 0, codebook.y[2], codebook.u, codebook.v);
+					PUT_PIXEL(iy[3] + 1, codebook.y[2], codebook.u, codebook.v);
+
+					PUT_PIXEL(iy[2] + 2, codebook.y[3], codebook.u, codebook.v);
+					PUT_PIXEL(iy[2] + 3, codebook.y[3], codebook.u, codebook.v);
+					PUT_PIXEL(iy[3] + 2, codebook.y[3], codebook.u, codebook.v);
+					PUT_PIXEL(iy[3] + 3, codebook.y[3], codebook.u, codebook.v);
+				} else if (flag & mask) {
+					if ((stream.pos() - startPos + 4) > (int32)chunkSize)
+						return;
+
+					CinepakCodebook codebook = _curFrame.strips[strip].v4_codebook[stream.readByte()];
+					PUT_PIXEL(iy[0] + 0, codebook.y[0], codebook.u, codebook.v);
+					PUT_PIXEL(iy[0] + 1, codebook.y[1], codebook.u, codebook.v);
+					PUT_PIXEL(iy[1] + 0, codebook.y[2], codebook.u, codebook.v);
+					PUT_PIXEL(iy[1] + 1, codebook.y[3], codebook.u, codebook.v);
+
+					codebook = _curFrame.strips[strip].v4_codebook[stream.readByte()];
+					PUT_PIXEL(iy[0] + 2, codebook.y[0], codebook.u, codebook.v);
+					PUT_PIXEL(iy[0] + 3, codebook.y[1], codebook.u, codebook.v);
+					PUT_PIXEL(iy[1] + 2, codebook.y[2], codebook.u, codebook.v);
+					PUT_PIXEL(iy[1] + 3, codebook.y[3], codebook.u, codebook.v);
+
+					codebook = _curFrame.strips[strip].v4_codebook[stream.readByte()];
+					PUT_PIXEL(iy[2] + 0, codebook.y[0], codebook.u, codebook.v);
+					PUT_PIXEL(iy[2] + 1, codebook.y[1], codebook.u, codebook.v);
+					PUT_PIXEL(iy[3] + 0, codebook.y[2], codebook.u, codebook.v);
+					PUT_PIXEL(iy[3] + 1, codebook.y[3], codebook.u, codebook.v);
+
+					codebook = _curFrame.strips[strip].v4_codebook[stream.readByte()];
+					PUT_PIXEL(iy[2] + 2, codebook.y[0], codebook.u, codebook.v);
+					PUT_PIXEL(iy[2] + 3, codebook.y[1], codebook.u, codebook.v);
+					PUT_PIXEL(iy[3] + 2, codebook.y[2], codebook.u, codebook.v);
+					PUT_PIXEL(iy[3] + 3, codebook.y[3], codebook.u, codebook.v);
+				}
+			}
+
+			for (byte i = 0; i < 4; i++)
+				iy[i] += 4;
+		}
+	}
+}
+
+} // End of namespace Image