Merge pull request #16 "Add a PixelFormat to Graphics::Surface.".

For further discussion check here:
https://github.com/scummvm/scummvm/pull/16

Conflicts:
	graphics/png.cpp

15 files changed, 50 insertions, 48 deletions

diff --git a/video/codecs/cdtoons.cpp b/video/codecs/cdtoons.cpp
index f26cc35a2b..51e3c23eaa 100644
--- a/video/codecs/cdtoons.cpp
+++ b/video/codecs/cdtoons.cpp
@@ -54,7 +54,7 @@ CDToonsDecoder::CDToonsDecoder(uint16 width, uint16 height) {
 	debugN(5, "CDToons: width %d, height %d\n", width, height);
 
 	_surface = new Graphics::Surface();
-	_surface->create(width, height, 1);
+	_surface->create(width, height, Graphics::PixelFormat::createFormatCLUT8());
 
 	_currentPaletteId = 0;
 	memset(_palette, 0, 256 * 3);
diff --git a/video/codecs/cinepak.cpp b/video/codecs/cinepak.cpp
index bc73b831fe..2a782dbafe 100644
--- a/video/codecs/cinepak.cpp
+++ b/video/codecs/cinepak.cpp
@@ -95,7 +95,7 @@ const Graphics::Surface *CinepakDecoder::decodeImage(Common::SeekableReadStream
 
 	if (!_curFrame.surface) {
 		_curFrame.surface = new Graphics::Surface();
-		_curFrame.surface->create(_curFrame.width, _curFrame.height, _pixelFormat.bytesPerPixel);
+		_curFrame.surface->create(_curFrame.width, _curFrame.height, _pixelFormat);
 	}
 
 	// Reset the y variable.
diff --git a/video/codecs/indeo3.cpp b/video/codecs/indeo3.cpp
index c8f62d2452..b4f6c6ffe3 100644
--- a/video/codecs/indeo3.cpp
+++ b/video/codecs/indeo3.cpp
@@ -51,7 +51,7 @@ Indeo3Decoder::Indeo3Decoder(uint16 width, uint16 height) : _ModPred(0), _correc
 	_pixelFormat = g_system->getScreenFormat();
 
 	_surface = new Graphics::Surface;
-	_surface->create(width, height, _pixelFormat.bytesPerPixel);
+	_surface->create(width, height, _pixelFormat);
 
 	buildModPred();
 	allocFrames();
@@ -322,10 +322,10 @@ const Graphics::Surface *Indeo3Decoder::decodeImage(Common::SeekableReadStream *
 
 				const uint32 color = _pixelFormat.RGBToColor(r, g, b);
 
-				for (uint32 sW = 0; sW < scaleWidth; sW++, rowDest += _surface->bytesPerPixel) {
-					if      (_surface->bytesPerPixel == 1)
+				for (uint32 sW = 0; sW < scaleWidth; sW++, rowDest += _surface->format.bytesPerPixel) {
+					if      (_surface->format.bytesPerPixel == 1)
 						*((uint8 *)rowDest) = (uint8)color;
-					else if (_surface->bytesPerPixel == 2)
+					else if (_surface->format.bytesPerPixel == 2)
 						*((uint16 *)rowDest) = (uint16)color;
 				}
 			}
diff --git a/video/codecs/mjpeg.cpp b/video/codecs/mjpeg.cpp
index 2cef2b582b..2ef854039b 100644
--- a/video/codecs/mjpeg.cpp
+++ b/video/codecs/mjpeg.cpp
@@ -59,7 +59,7 @@ const Graphics::Surface *JPEGDecoder::decodeImage(Common::SeekableReadStream* st
 
 	if (!_surface) {
 		_surface = new Graphics::Surface();
-		_surface->create(_jpeg->getWidth(), _jpeg->getHeight(), _pixelFormat.bytesPerPixel);
+		_surface->create(_jpeg->getWidth(), _jpeg->getHeight(), _pixelFormat);
 	}
 
 	Graphics::Surface *frame = _jpeg->getSurface(_pixelFormat);
diff --git a/video/codecs/msrle.cpp b/video/codecs/msrle.cpp
index 48a17d2ac3..19309bc7aa 100644
--- a/video/codecs/msrle.cpp
+++ b/video/codecs/msrle.cpp
@@ -33,7 +33,7 @@ namespace Video {
 
 MSRLEDecoder::MSRLEDecoder(uint16 width, uint16 height, byte bitsPerPixel) {
 	_surface = new Graphics::Surface();
-	_surface->create(width, height, 1);
+	_surface->create(width, height, Graphics::PixelFormat::createFormatCLUT8());
 	_bitsPerPixel = bitsPerPixel;
 }
 
diff --git a/video/codecs/msvideo1.cpp b/video/codecs/msvideo1.cpp
index e173f45239..93e9aaae64 100644
--- a/video/codecs/msvideo1.cpp
+++ b/video/codecs/msvideo1.cpp
@@ -39,7 +39,8 @@ namespace Video {
 
 MSVideo1Decoder::MSVideo1Decoder(uint16 width, uint16 height, byte bitsPerPixel) : Codec() {
 	_surface = new Graphics::Surface();
-	_surface->create(width, height, (bitsPerPixel == 8) ? 1 : 2);
+	// TODO: Specify the correct pixel format for 2Bpp mode.
+	_surface->create(width, height, (bitsPerPixel == 8) ? Graphics::PixelFormat::createFormatCLUT8() : Graphics::PixelFormat(2, 0, 0, 0, 0, 0, 0, 0, 0));
 	_bitsPerPixel = bitsPerPixel;
 }
 
diff --git a/video/codecs/qtrle.cpp b/video/codecs/qtrle.cpp
index 19835aed78..0ae27f6284 100644
--- a/video/codecs/qtrle.cpp
+++ b/video/codecs/qtrle.cpp
@@ -50,7 +50,7 @@ QTRLEDecoder::QTRLEDecoder(uint16 width, uint16 height, byte bitsPerPixel) : Cod
 	debug(2, "QTRLE corrected width: %d", width);
 
 	_surface = new Graphics::Surface();
-	_surface->create(width, height, _bitsPerPixel <= 8 ? 1 : _pixelFormat.bytesPerPixel);
+	_surface->create(width, height, _bitsPerPixel <= 8 ? Graphics::PixelFormat::createFormatCLUT8() : _pixelFormat);
 }
 
 #define CHECK_STREAM_PTR(n) \
diff --git a/video/codecs/rpza.cpp b/video/codecs/rpza.cpp
index bfea88b26f..0c06661c50 100644
--- a/video/codecs/rpza.cpp
+++ b/video/codecs/rpza.cpp
@@ -46,7 +46,7 @@ RPZADecoder::RPZADecoder(uint16 width, uint16 height) : Codec() {
 	debug(2, "RPZA corrected width: %d", width);
 
 	_surface = new Graphics::Surface();
-	_surface->create(width, height, _pixelFormat.bytesPerPixel);
+	_surface->create(width, height, _pixelFormat);
 }
 
 RPZADecoder::~RPZADecoder() {
diff --git a/video/codecs/smc.cpp b/video/codecs/smc.cpp
index 745fdc0260..bbd6073497 100644
--- a/video/codecs/smc.cpp
+++ b/video/codecs/smc.cpp
@@ -50,7 +50,7 @@ namespace Video {
 
 SMCDecoder::SMCDecoder(uint16 width, uint16 height) {
 	_surface = new Graphics::Surface();
-	_surface->create(width, height, 1);
+	_surface->create(width, height, Graphics::PixelFormat::createFormatCLUT8());
 }
 
 SMCDecoder::~SMCDecoder() {
diff --git a/video/codecs/truemotion1.cpp b/video/codecs/truemotion1.cpp
index 577c72c133..70c456d4a8 100644
--- a/video/codecs/truemotion1.cpp
+++ b/video/codecs/truemotion1.cpp
@@ -94,7 +94,7 @@ TrueMotion1Decoder::TrueMotion1Decoder(uint16 width, uint16 height) {
 	_width = width;
 	_height = height;
 
-	_surface->create(width, height, 2);
+	_surface->create(width, height, getPixelFormat());
 
 	// there is a vertical predictor for each pixel in a line; each vertical
 	// predictor is 0 to start with
diff --git a/video/coktel_decoder.cpp b/video/coktel_decoder.cpp
index 609c8d118b..4448c9162e 100644
--- a/video/coktel_decoder.cpp
+++ b/video/coktel_decoder.cpp
@@ -99,11 +99,12 @@ void CoktelDecoder::setSurfaceMemory(void *mem, uint16 width, uint16 height, uin
 	assert(bpp == getPixelFormat().bytesPerPixel);
 
 	// Create a surface over this memory
-	_surface.w             = width;
-	_surface.h             = height;
-	_surface.pitch         = width * bpp;
-	_surface.pixels        = mem;
-	_surface.bytesPerPixel = bpp;
+	_surface.w      = width;
+	_surface.h      = height;
+	_surface.pitch  = width * bpp;
+	_surface.pixels = mem;
+	// TODO: Check whether it is fine to assume we want the setup PixelFormat.
+	_surface.format = getPixelFormat();
 
 	_ownSurface = false;
 }
@@ -134,18 +135,18 @@ void CoktelDecoder::createSurface() {
 		return;
 
 	if ((_width > 0) && (_height > 0))
-		_surface.create(_width, _height, getPixelFormat().bytesPerPixel);
+		_surface.create(_width, _height, getPixelFormat());
 
 	_ownSurface = true;
 }
 
 void CoktelDecoder::freeSurface() {
 	if (!_ownSurface) {
-		_surface.w             = 0;
-		_surface.h             = 0;
-		_surface.pitch         = 0;
-		_surface.pixels        = 0;
-		_surface.bytesPerPixel = 0;
+		_surface.w      = 0;
+		_surface.h      = 0;
+		_surface.pitch  = 0;
+		_surface.pixels = 0;
+		_surface.format = Graphics::PixelFormat();
 	} else
 		_surface.free();
 
@@ -456,11 +457,11 @@ void CoktelDecoder::renderBlockWhole(Graphics::Surface &dstSurf, const byte *src
 
 	rect.clip(dstSurf.w, dstSurf.h);
 
-	byte *dst = (byte *)dstSurf.pixels + (rect.top * dstSurf.pitch) + rect.left * dstSurf.bytesPerPixel;
+	byte *dst = (byte *)dstSurf.pixels + (rect.top * dstSurf.pitch) + rect.left * dstSurf.format.bytesPerPixel;
 	for (int i = 0; i < rect.height(); i++) {
-		memcpy(dst, src, rect.width() * dstSurf.bytesPerPixel);
+		memcpy(dst, src, rect.width() * dstSurf.format.bytesPerPixel);
 
-		src += srcRect.width() * dstSurf.bytesPerPixel;
+		src += srcRect.width() * dstSurf.format.bytesPerPixel;
 		dst += dstSurf.pitch;
 	}
 }
@@ -1382,12 +1383,12 @@ bool IMDDecoder::renderFrame(Common::Rect &rect) {
 
 		if ((type == 2) && (rect.width() == _surface.w) && (_x == 0)) {
 			// Directly uncompress onto the video surface
-			const int offsetX = rect.left * _surface.bytesPerPixel;
+			const int offsetX = rect.left * _surface.format.bytesPerPixel;
 			const int offsetY = (_y + rect.top) * _surface.pitch;
 			const int offset  = offsetX + offsetY;
 
 			if (deLZ77((byte *)_surface.pixels + offset, dataPtr, dataSize,
-			           _surface.w * _surface.h * _surface.bytesPerPixel - offset))
+			           _surface.w * _surface.h * _surface.format.bytesPerPixel - offset))
 				return true;
 		}
 
@@ -1813,11 +1814,11 @@ bool VMDDecoder::assessVideoProperties() {
 			_videoBuffer[i] = new byte[_videoBufferSize];
 			memset(_videoBuffer[i], 0, _videoBufferSize);
 
-			_8bppSurface[i].w             = _width * _bytesPerPixel;
-			_8bppSurface[i].h             = _height;
-			_8bppSurface[i].pitch         = _width * _bytesPerPixel;
-			_8bppSurface[i].pixels        = _videoBuffer[i];
-			_8bppSurface[i].bytesPerPixel = 1;
+			_8bppSurface[i].w      = _width * _bytesPerPixel;
+			_8bppSurface[i].h      = _height;
+			_8bppSurface[i].pitch  = _width * _bytesPerPixel;
+			_8bppSurface[i].pixels = _videoBuffer[i];
+			_8bppSurface[i].format = Graphics::PixelFormat::createFormatCLUT8();
 		}
 	}
 
@@ -2230,12 +2231,12 @@ bool VMDDecoder::renderFrame(Common::Rect &rect) {
 
 		if ((type == 2) && (rect.width() == _surface.w) && (_x == 0) && (_blitMode == 0)) {
 			// Directly uncompress onto the video surface
-			const int offsetX = rect.left * _surface.bytesPerPixel;
+			const int offsetX = rect.left * _surface.format.bytesPerPixel;
 			const int offsetY = (_y + rect.top) * _surface.pitch;
 			const int offset  = offsetX - offsetY;
 
 			if (deLZ77((byte *)_surface.pixels + offset, dataPtr, dataSize,
-			           _surface.w * _surface.h * _surface.bytesPerPixel - offset))
+			           _surface.w * _surface.h * _surface.format.bytesPerPixel - offset))
 				return true;
 		}
 
@@ -2345,13 +2346,13 @@ void VMDDecoder::blit16(const Graphics::Surface &srcSurf, Common::Rect &rect) {
 	const byte *src = (byte *)srcSurf.pixels +
 		(srcRect.top * srcSurf.pitch) + srcRect.left * _bytesPerPixel;
 	byte *dst = (byte *)_surface.pixels +
-		((_y + rect.top) * _surface.pitch) + (_x + rect.left) * _surface.bytesPerPixel;
+		((_y + rect.top) * _surface.pitch) + (_x + rect.left) * _surface.format.bytesPerPixel;
 
 	for (int i = 0; i < rect.height(); i++) {
 		const byte *srcRow = src;
 		      byte *dstRow = dst;
 
-		for (int j = 0; j < rect.width(); j++, srcRow += 2, dstRow += _surface.bytesPerPixel) {
+		for (int j = 0; j < rect.width(); j++, srcRow += 2, dstRow += _surface.format.bytesPerPixel) {
 			uint16 data = READ_LE_UINT16(srcRow);
 
 			byte r = ((data & 0x7C00) >> 10) << 3;
@@ -2362,7 +2363,7 @@ void VMDDecoder::blit16(const Graphics::Surface &srcSurf, Common::Rect &rect) {
 			if ((r == 0) && (g == 0) && (b == 0))
 				c = 0;
 
-			if (_surface.bytesPerPixel == 2)
+			if (_surface.format.bytesPerPixel == 2)
 				*((uint16 *)dstRow) = (uint16) c;
 		}
 
@@ -2383,13 +2384,13 @@ void VMDDecoder::blit24(const Graphics::Surface &srcSurf, Common::Rect &rect) {
 	const byte *src = (byte *)srcSurf.pixels +
 		(srcRect.top * srcSurf.pitch) + srcRect.left * _bytesPerPixel;
 	byte *dst = (byte *)_surface.pixels +
-		((_y + rect.top) * _surface.pitch) + (_x + rect.left) * _surface.bytesPerPixel;
+		((_y + rect.top) * _surface.pitch) + (_x + rect.left) * _surface.format.bytesPerPixel;
 
 	for (int i = 0; i < rect.height(); i++) {
 		const byte *srcRow = src;
 		      byte *dstRow = dst;
 
-		for (int j = 0; j < rect.width(); j++, srcRow += 3, dstRow += _surface.bytesPerPixel) {
+		for (int j = 0; j < rect.width(); j++, srcRow += 3, dstRow += _surface.format.bytesPerPixel) {
 			byte r = srcRow[2];
 			byte g = srcRow[1];
 			byte b = srcRow[0];
@@ -2398,7 +2399,7 @@ void VMDDecoder::blit24(const Graphics::Surface &srcSurf, Common::Rect &rect) {
 			if ((r == 0) && (g == 0) && (b == 0))
 				c = 0;
 
-			if (_surface.bytesPerPixel == 2)
+			if (_surface.format.bytesPerPixel == 2)
 				*((uint16 *)dstRow) = (uint16) c;
 		}
 
diff --git a/video/dxa_decoder.cpp b/video/dxa_decoder.cpp
index 3fb0a81acb..9e3f59705c 100644
--- a/video/dxa_decoder.cpp
+++ b/video/dxa_decoder.cpp
@@ -102,7 +102,7 @@ bool DXADecoder::loadStream(Common::SeekableReadStream *stream) {
 	}
 
 	_surface = new Graphics::Surface();
-	_surface->bytesPerPixel = 1;
+	_surface->format = Graphics::PixelFormat::createFormatCLUT8();
 
 	debug(2, "flags 0x0%x framesCount %d width %d height %d rate %d", flags, getFrameCount(), getWidth(), getHeight(), getFrameRate().toInt());
 
diff --git a/video/flic_decoder.cpp b/video/flic_decoder.cpp
index adceb4565f..47a9244a13 100644
--- a/video/flic_decoder.cpp
+++ b/video/flic_decoder.cpp
@@ -80,7 +80,7 @@ bool FlicDecoder::loadStream(Common::SeekableReadStream *stream) {
 	_offsetFrame2 = _fileStream->readUint32LE();
 
 	_surface = new Graphics::Surface();
-	_surface->create(width, height, 1);
+	_surface->create(width, height, Graphics::PixelFormat::createFormatCLUT8());
 	_palette = (byte *)malloc(3 * 256);
 	memset(_palette, 0, 3 * 256);
 	_paletteChanged = false;
@@ -227,7 +227,7 @@ const Graphics::Surface *FlicDecoder::decodeNextFrame() {
 				_surface->free();
 				delete _surface;
 				_surface = new Graphics::Surface();
-				_surface->create(newWidth, newHeight, 1);
+				_surface->create(newWidth, newHeight, Graphics::PixelFormat::createFormatCLUT8());
 			}
 		}
 		break;
diff --git a/video/qt_decoder.cpp b/video/qt_decoder.cpp
index 9e125fe99b..d455b13b64 100644
--- a/video/qt_decoder.cpp
+++ b/video/qt_decoder.cpp
@@ -393,7 +393,7 @@ const Graphics::Surface *QuickTimeDecoder::scaleSurface(const Graphics::Surface
 
 	for (int32 j = 0; j < _scaledSurface->h; j++)
 		for (int32 k = 0; k < _scaledSurface->w; k++)
-			memcpy(_scaledSurface->getBasePtr(k, j), frame->getBasePtr((k * getScaleFactorX()).toInt() , (j * getScaleFactorY()).toInt()), frame->bytesPerPixel);
+			memcpy(_scaledSurface->getBasePtr(k, j), frame->getBasePtr((k * getScaleFactorX()).toInt() , (j * getScaleFactorY()).toInt()), frame->format.bytesPerPixel);
 
 	return _scaledSurface;
 }
@@ -538,7 +538,7 @@ void QuickTimeDecoder::init() {
 		if (getScaleFactorX() != 1 || getScaleFactorY() != 1) {
 			// We have to initialize the scaled surface
 			_scaledSurface = new Graphics::Surface();
-			_scaledSurface->create(getWidth(), getHeight(), getPixelFormat().bytesPerPixel);
+			_scaledSurface->create(getWidth(), getHeight(), getPixelFormat());
 		}
 	}
 }
diff --git a/video/smk_decoder.cpp b/video/smk_decoder.cpp
index d25e055235..7a95eedf6a 100644
--- a/video/smk_decoder.cpp
+++ b/video/smk_decoder.cpp
@@ -483,7 +483,7 @@ bool SmackerDecoder::loadStream(Common::SeekableReadStream *stream) {
 	_surface = new Graphics::Surface();
 
 	// Height needs to be doubled if we have flags (Y-interlaced or Y-doubled)
-	_surface->create(width, height * (_header.flags ? 2 : 1), 1);
+	_surface->create(width, height * (_header.flags ? 2 : 1), Graphics::PixelFormat::createFormatCLUT8());
 
 	memset(_palette, 0, 3 * 256);
 	return true;