/* 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.
 *
 */

/*
 * This code is based on Labyrinth of Time code with assistance of
 *
 * Copyright (c) 1993 Terra Nova Development
 * Copyright (c) 2004 The Wyrmkeep Entertainment Co.
 *
 */

#ifndef LAB_UTILS_H
#define LAB_UTILS_H

namespace Lab {

class Utils {
private:
	LabEngine *_vm;
	uint16 _dataBytesPerRow;

	/**
	 * Undiffs a piece of memory based on the header size.
	 */
	template<typename T>
	void unDiff(T *dest, Common::File *sourceFile);

	/**
	 * Undiffs a piece of memory when header size is a byte, and copy/skip size
	 * is a byte or a word or a double word.
	 */
	template<typename T>
	void verticalUnDiff(T *dest, Common::File *sourceFile, uint16 bytesPerRow);

public:
	Utils(LabEngine *vm);

	Common::RandomSource _rnd;

	/**
	 * Scales the x co-ordinates to that of the new display.  In the room parser
	 * file, co-ordinates are set up on a 360x336 display.
	 */
	uint16 scaleX(uint16 x);

	/**
	 * Scales the y co-ordinates to that of the new display.  In the room parser
	 * file, co-ordinates are set up on a 368x336 display.
	 */
	uint16 scaleY(uint16 y);
	Common::Rect rectScale(int16 x1, int16 y1, int16 x2, int16 y2);

	/**
	 * Scales the VGA x coords to SVGA if necessary; otherwise, returns VGA coords.
	 */
	int16 vgaScaleX(int16 x);

	/**
	 * Scales the VGA y coords to SVGA if necessary; otherwise, returns VGA coords.
	 */
	int16 vgaScaleY(int16 y);
	Common::Rect vgaRectScale(int16 x1, int16 y1, int16 x2, int16 y2);
	uint16 svgaCord(uint16 cord);
	uint16 mapScaleX(uint16 x);
	uint16 mapScaleY(uint16 y);
	Common::Rect mapRectScale(int16 x1, int16 y1, int16 x2, int16 y2);

	/**
	 * Converts SVGA coords to VGA if necessary, otherwise returns VGA coords.
	 */
	Common::Point vgaUnscale(Common::Point pos);

	/**
	 * Does the undiffing between the bitmaps.
	 */
	void unDiff(byte *newBuf, byte *oldBuf, Common::File *sourceFile, uint16 bytesPerRow, bool isVertical);
	void runLengthDecode(byte *dest, Common::File *sourceFile);
	void verticalRunLengthDecode(byte *dest, Common::File *sourceFile, uint16 bytesPerRow);
	void setBytesPerRow(int num);
	uint16 getRandom(uint16 max);
};


} // End of namespace Lab

#endif // LAB_UTILS_H