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

13 files changed, 50 insertions, 46 deletions

diff --git a/backends/graphics/opengl/opengl-graphics.cpp b/backends/graphics/opengl/opengl-graphics.cpp
index 2fb02ba36c..b85cac809e 100644
--- a/backends/graphics/opengl/opengl-graphics.cpp
+++ b/backends/graphics/opengl/opengl-graphics.cpp
@@ -356,9 +356,9 @@ void OpenGLGraphicsManager::copyRectToScreen(const byte *buf, int pitch, int x,
 
 	// Copy buffer data to game screen internal buffer
 	const byte *src = buf;
-	byte *dst = (byte *)_screenData.pixels + y * _screenData.pitch + x * _screenData.bytesPerPixel;
+	byte *dst = (byte *)_screenData.pixels + y * _screenData.pitch + x * _screenData.format.bytesPerPixel;
 	for (int i = 0; i < h; i++) {
-		memcpy(dst, src, w * _screenData.bytesPerPixel);
+		memcpy(dst, src, w * _screenData.format.bytesPerPixel);
 		src += pitch;
 		dst += _screenData.pitch;
 	}
@@ -467,7 +467,7 @@ void OpenGLGraphicsManager::clearOverlay() {
 }
 
 void OpenGLGraphicsManager::grabOverlay(OverlayColor *buf, int pitch) {
-	assert(_overlayData.bytesPerPixel == sizeof(buf[0]));
+	assert(_overlayData.format.bytesPerPixel == sizeof(buf[0]));
 	const byte *src = (byte *)_overlayData.pixels;
 	for (int i = 0; i < _overlayData.h; i++) {
 		// Copy overlay data to buffer
@@ -520,7 +520,7 @@ void OpenGLGraphicsManager::copyRectToOverlay(const OverlayColor *buf, int pitch
 		const byte *src = (const byte *)buf;
 		byte *dst = (byte *)_overlayData.pixels + y * _overlayData.pitch;
 		for (int i = 0; i < h; i++) {
-			memcpy(dst + x * _overlayData.bytesPerPixel, src, w * _overlayData.bytesPerPixel);
+			memcpy(dst + x * _overlayData.format.bytesPerPixel, src, w * _overlayData.format.bytesPerPixel);
 			src += pitch * sizeof(buf[0]);
 			dst += _overlayData.pitch;
 		}
@@ -617,8 +617,8 @@ void OpenGLGraphicsManager::setMouseCursor(const byte *buf, uint w, uint h, int
 
 	// Allocate space for cursor data
 	if (_cursorData.w != w || _cursorData.h != h ||
-			_cursorData.bytesPerPixel != _cursorFormat.bytesPerPixel)
-		_cursorData.create(w, h, _cursorFormat.bytesPerPixel);
+			_cursorData.format.bytesPerPixel != _cursorFormat.bytesPerPixel)
+		_cursorData.create(w, h, _cursorFormat);
 
 	// Save cursor data
 	memcpy(_cursorData.pixels, buf, h * _cursorData.pitch);
@@ -700,13 +700,13 @@ void OpenGLGraphicsManager::refreshGameScreen() {
 	int w = _screenDirtyRect.width();
 	int h = _screenDirtyRect.height();
 
-	if (_screenData.bytesPerPixel == 1) {
+	if (_screenData.format.bytesPerPixel == 1) {
 		// Create a temporary RGB888 surface
 		byte *surface = new byte[w * h * 3];
 
 		// Convert the paletted buffer to RGB888
 		const byte *src = (byte *)_screenData.pixels + y * _screenData.pitch;
-		src += x * _screenData.bytesPerPixel;
+		src += x * _screenData.format.bytesPerPixel;
 		byte *dst = surface;
 		for (int i = 0; i < h; i++) {
 			for (int j = 0; j < w; j++) {
@@ -726,7 +726,7 @@ void OpenGLGraphicsManager::refreshGameScreen() {
 	} else {
 		// Update the texture
 		_gameTexture->updateBuffer((byte *)_screenData.pixels + y * _screenData.pitch +
-			x * _screenData.bytesPerPixel, _screenData.pitch, x, y, w, h);
+			x * _screenData.format.bytesPerPixel, _screenData.pitch, x, y, w, h);
 	}
 
 	_screenNeedsRedraw = false;
@@ -742,13 +742,13 @@ void OpenGLGraphicsManager::refreshOverlay() {
 	int w = _overlayDirtyRect.width();
 	int h = _overlayDirtyRect.height();
 
-	if (_overlayData.bytesPerPixel == 1) {
+	if (_overlayData.format.bytesPerPixel == 1) {
 		// Create a temporary RGB888 surface
 		byte *surface = new byte[w * h * 3];
 
 		// Convert the paletted buffer to RGB888
 		const byte *src = (byte *)_overlayData.pixels + y * _overlayData.pitch;
-		src += x * _overlayData.bytesPerPixel;
+		src += x * _overlayData.format.bytesPerPixel;
 		byte *dst = surface;
 		for (int i = 0; i < h; i++) {
 			for (int j = 0; j < w; j++) {
@@ -768,7 +768,7 @@ void OpenGLGraphicsManager::refreshOverlay() {
 	} else {
 		// Update the texture
 		_overlayTexture->updateBuffer((byte *)_overlayData.pixels + y * _overlayData.pitch +
-			x * _overlayData.bytesPerPixel, _overlayData.pitch, x, y, w, h);
+			x * _overlayData.format.bytesPerPixel, _overlayData.pitch, x, y, w, h);
 	}
 
 	_overlayNeedsRedraw = false;
@@ -1176,9 +1176,9 @@ void OpenGLGraphicsManager::loadTextures() {
 			_oldVideoMode.screenHeight != _videoMode.screenHeight)
 		_screenData.create(_videoMode.screenWidth, _videoMode.screenHeight,
 #ifdef USE_RGB_COLOR
-			_screenFormat.bytesPerPixel
+			_screenFormat
 #else
-			1
+			Graphics::PixelFormat::createFormatCLUT8()
 #endif
 			);
 
@@ -1186,7 +1186,7 @@ void OpenGLGraphicsManager::loadTextures() {
 	if (_oldVideoMode.overlayWidth != _videoMode.overlayWidth ||
 		_oldVideoMode.overlayHeight != _videoMode.overlayHeight)
 		_overlayData.create(_videoMode.overlayWidth, _videoMode.overlayHeight,
-			_overlayFormat.bytesPerPixel);
+			_overlayFormat);
 
 	_screenNeedsRedraw = true;
 	_overlayNeedsRedraw = true;
@@ -1388,7 +1388,7 @@ void OpenGLGraphicsManager::updateOSD() {
 	const Graphics::Font *font = FontMan.getFontByUsage(Graphics::FontManager::kOSDFont);
 
 	if (_osdSurface.w != _osdTexture->getWidth() || _osdSurface.h != _osdTexture->getHeight())
-		_osdSurface.create(_osdTexture->getWidth(), _osdTexture->getHeight(), 2);
+		_osdSurface.create(_osdTexture->getWidth(), _osdTexture->getHeight(), _overlayFormat);
 	else
 		// Clear everything
 		memset(_osdSurface.pixels, 0, _osdSurface.h * _osdSurface.pitch);
diff --git a/backends/graphics/sdl/sdl-graphics.cpp b/backends/graphics/sdl/sdl-graphics.cpp
index 41f5c2acbb..b3e1138e77 100644
--- a/backends/graphics/sdl/sdl-graphics.cpp
+++ b/backends/graphics/sdl/sdl-graphics.cpp
@@ -1288,9 +1288,9 @@ Graphics::Surface *SdlGraphicsManager::lockScreen() {
 	_framebuffer.h = _screen->h;
 	_framebuffer.pitch = _screen->pitch;
 #ifdef USE_RGB_COLOR
-	_framebuffer.bytesPerPixel = _screenFormat.bytesPerPixel;
+	_framebuffer.format = _screenFormat;
 #else
-	_framebuffer.bytesPerPixel = 1;
+	_framebuffer.format = Graphics::PixelFormat::createFormatCLUT8();
 #endif
 
 	return &_framebuffer;
@@ -2055,7 +2055,11 @@ void SdlGraphicsManager::displayMessageOnOSD(const char *msg) {
 	dst.w = _osdSurface->w;
 	dst.h = _osdSurface->h;
 	dst.pitch = _osdSurface->pitch;
-	dst.bytesPerPixel = _osdSurface->format->BytesPerPixel;
+	dst.format = Graphics::PixelFormat(_osdSurface->format->BytesPerPixel,
+	                                   8 - _osdSurface->format->Rloss, 8 - _osdSurface->format->Gloss,
+	                                   8 - _osdSurface->format->Bloss, 8 - _osdSurface->format->Aloss,
+	                                   _osdSurface->format->Rshift, _osdSurface->format->Gshift,
+	                                   _osdSurface->format->Bshift, _osdSurface->format->Ashift);
 
 	// The font we are going to use:
 	const Graphics::Font *font = FontMan.getFontByUsage(Graphics::FontManager::kOSDFont);
diff --git a/backends/platform/android/gfx.cpp b/backends/platform/android/gfx.cpp
index 86232030ff..fae428d29f 100644
--- a/backends/platform/android/gfx.cpp
+++ b/backends/platform/android/gfx.cpp
@@ -628,13 +628,13 @@ void OSystem_Android::grabOverlay(OverlayColor *buf, int pitch) {
 	GLTHREADCHECK;
 
 	const Graphics::Surface *surface = _overlay_texture->surface_const();
-	assert(surface->bytesPerPixel == sizeof(buf[0]));
+	assert(surface->format.bytesPerPixel == sizeof(buf[0]));
 
 	const byte *src = (const byte *)surface->pixels;
 	uint h = surface->h;
 
 	do {
-		memcpy(buf, src, surface->w * surface->bytesPerPixel);
+		memcpy(buf, src, surface->w * surface->format.bytesPerPixel);
 		src += surface->pitch;
 		// This 'pitch' is pixels not bytes
 		buf += pitch;
diff --git a/backends/platform/android/texture.cpp b/backends/platform/android/texture.cpp
index a6b28ca485..2d73783309 100644
--- a/backends/platform/android/texture.cpp
+++ b/backends/platform/android/texture.cpp
@@ -147,7 +147,7 @@ void GLESBaseTexture::setLinearFilter(bool value) {
 void GLESBaseTexture::allocBuffer(GLuint w, GLuint h) {
 	_surface.w = w;
 	_surface.h = h;
-	_surface.bytesPerPixel = _pixelFormat.bytesPerPixel;
+	_surface.format = _pixelFormat;
 
 	if (w == _texture_width && h == _texture_height)
 		return;
@@ -241,14 +241,14 @@ void GLESTexture::allocBuffer(GLuint w, GLuint h) {
 	delete[] _buf;
 	delete[] _pixels;
 
-	_pixels = new byte[w * h * _surface.bytesPerPixel];
+	_pixels = new byte[w * h * _surface.format.bytesPerPixel];
 	assert(_pixels);
 
 	_surface.pixels = _pixels;
 
 	fillBuffer(0);
 
-	_buf = new byte[w * h * _surface.bytesPerPixel];
+	_buf = new byte[w * h * _surface.format.bytesPerPixel];
 	assert(_buf);
 }
 
@@ -257,10 +257,10 @@ void GLESTexture::updateBuffer(GLuint x, GLuint y, GLuint w, GLuint h,
 	setDirtyRect(Common::Rect(x, y, x + w, y + h));
 
 	const byte *src = (const byte *)buf;
-	byte *dst = _pixels + y * _surface.pitch + x * _surface.bytesPerPixel;
+	byte *dst = _pixels + y * _surface.pitch + x * _surface.format.bytesPerPixel;
 
 	do {
-		memcpy(dst, src, w * _surface.bytesPerPixel);
+		memcpy(dst, src, w * _surface.format.bytesPerPixel);
 		dst += _surface.pitch;
 		src += pitch_buf;
 	} while (--h);
@@ -301,10 +301,10 @@ void GLESTexture::drawTexture(GLshort x, GLshort y, GLshort w, GLshort h) {
 			_tex = _buf;
 
 			byte *src = _pixels + _dirty_rect.top * _surface.pitch +
-						_dirty_rect.left * _surface.bytesPerPixel;
+						_dirty_rect.left * _surface.format.bytesPerPixel;
 			byte *dst = _buf;
 
-			uint16 l = dwidth * _surface.bytesPerPixel;
+			uint16 l = dwidth * _surface.format.bytesPerPixel;
 
 			for (uint16 i = 0; i < dheight; ++i) {
 				memcpy(dst, src, l);
@@ -373,7 +373,7 @@ void GLESFakePaletteTexture::allocBuffer(GLuint w, GLuint h) {
 
 	GLESBaseTexture::allocBuffer(w, h);
 
-	_surface.bytesPerPixel = 1;
+	_surface.format = Graphics::PixelFormat::createFormatCLUT8();
 	_surface.pitch = w;
 
 	if (_surface.w == oldw && _surface.h == oldh) {
diff --git a/backends/platform/dc/display.cpp b/backends/platform/dc/display.cpp
index b297022775..78fa2182dc 100644
--- a/backends/platform/dc/display.cpp
+++ b/backends/platform/dc/display.cpp
@@ -720,7 +720,7 @@ Graphics::Surface *OSystem_Dreamcast::lockScreen()
   _framebuffer.w = _screen_w;
   _framebuffer.h = _screen_h;
   _framebuffer.pitch = SCREEN_W*2;
-  _framebuffer.bytesPerPixel = (_screenFormat == 0? 1 : 2);
+  _framebuffer.format = screenFormats[_screenFormat];
 
   return &_framebuffer;
 }
diff --git a/backends/platform/ds/arm9/source/osystem_ds.cpp b/backends/platform/ds/arm9/source/osystem_ds.cpp
index 576b70dd2a..49818a0034 100644
--- a/backends/platform/ds/arm9/source/osystem_ds.cpp
+++ b/backends/platform/ds/arm9/source/osystem_ds.cpp
@@ -243,7 +243,7 @@ void OSystem_DS::setCursorPalette(const byte *colors, uint start, uint num) {
 }
 
 bool OSystem_DS::grabRawScreen(Graphics::Surface *surf) {
-	surf->create(DS::getGameWidth(), DS::getGameHeight(), 1);
+	surf->create(DS::getGameWidth(), DS::getGameHeight(), Graphics::PixelFormat::createFormatCLUT8());
 
 	// Ensure we copy using 16 bit quantities due to limitation of VRAM addressing
 
@@ -756,7 +756,7 @@ Graphics::Surface *OSystem_DS::createTempFrameBuffer() {
 		_framebuffer.w = DS::getGameWidth();
 		_framebuffer.h = DS::getGameHeight();
 		_framebuffer.pitch = DS::getGameWidth();
-		_framebuffer.bytesPerPixel = 1;
+		_framebuffer.format = Graphics::PixelFormat::createFormatCLUT8();
 
 	} else {
 
@@ -781,7 +781,7 @@ Graphics::Surface *OSystem_DS::createTempFrameBuffer() {
 		_framebuffer.w = width;
 		_framebuffer.h = height;
 		_framebuffer.pitch = width;
-		_framebuffer.bytesPerPixel = 1;
+		_framebuffer.format = Graphics::PixelFormat::createFormatCLUT8();
 
 	}
 
diff --git a/backends/platform/iphone/osys_video.cpp b/backends/platform/iphone/osys_video.cpp
index c5e7ab8413..a10efeff40 100644
--- a/backends/platform/iphone/osys_video.cpp
+++ b/backends/platform/iphone/osys_video.cpp
@@ -334,7 +334,7 @@ Graphics::Surface *OSystem_IPHONE::lockScreen() {
 	_framebuffer.w = _screenWidth;
 	_framebuffer.h = _screenHeight;
 	_framebuffer.pitch = _screenWidth;
-	_framebuffer.bytesPerPixel = 1;
+	_framebuffer.format = Graphics::PixelFormat::createFormatCLUT8();
 
 	return &_framebuffer;
 }
diff --git a/backends/platform/n64/osys_n64_base.cpp b/backends/platform/n64/osys_n64_base.cpp
index 54eab0fd52..232037899b 100644
--- a/backends/platform/n64/osys_n64_base.cpp
+++ b/backends/platform/n64/osys_n64_base.cpp
@@ -610,7 +610,7 @@ Graphics::Surface *OSystem_N64::lockScreen() {
 	_framebuffer.w = _gameWidth;
 	_framebuffer.h = _gameHeight;
 	_framebuffer.pitch = _screenWidth;
-	_framebuffer.bytesPerPixel = 1;
+	_framebuffer.format = Graphics::PixelFormat::createFormatCLUT8();
 
 	return &_framebuffer;
 }
diff --git a/backends/platform/ps2/Gs2dScreen.cpp b/backends/platform/ps2/Gs2dScreen.cpp
index a460b919fd..e43ea0f376 100644
--- a/backends/platform/ps2/Gs2dScreen.cpp
+++ b/backends/platform/ps2/Gs2dScreen.cpp
@@ -398,7 +398,7 @@ Graphics::Surface *Gs2dScreen::lockScreen() {
 	_framebuffer.w = _width;
 	_framebuffer.h = _height;
 	_framebuffer.pitch = _width; // -not- _pitch; ! It's EE mem, not Tex
-	_framebuffer.bytesPerPixel = 1;
+	_framebuffer.format = Graphics::PixelFormat::createFormatCLUT8();
 
 	return &_framebuffer;
 }
@@ -441,7 +441,7 @@ void Gs2dScreen::grabPalette(uint8 *pal, uint8 start, uint16 num) {
 void Gs2dScreen::grabScreen(Graphics::Surface *surf) {
 	assert(surf);
 	WaitSema(g_DmacSema);
-	surf->create(_width, _height, 1);
+	surf->create(_width, _height, Graphics::PixelFormat::createFormatCLUT8());
 	memcpy(surf->pixels, _screenBuf, _width * _height);
 	SignalSema(g_DmacSema);
 }
diff --git a/backends/platform/ps2/systemps2.cpp b/backends/platform/ps2/systemps2.cpp
index 77de74eb5b..e95a026d01 100644
--- a/backends/platform/ps2/systemps2.cpp
+++ b/backends/platform/ps2/systemps2.cpp
@@ -727,7 +727,7 @@ void OSystem_PS2::msgPrintf(int millis, const char *format, ...) {
 	int maxWidth = 0;
 
 	Graphics::Surface surf;
-	surf.create(300, 200, 1);
+	surf.create(300, 200, Graphics::PixelFormat::createFormatCLUT8());
 
 	char *lnSta = resStr;
 	while (*lnSta && (posY < 180)) {
diff --git a/backends/platform/psp/default_display_client.cpp b/backends/platform/psp/default_display_client.cpp
index bb42406c3e..34b1a70711 100644
--- a/backends/platform/psp/default_display_client.cpp
+++ b/backends/platform/psp/default_display_client.cpp
@@ -199,7 +199,7 @@ Graphics::Surface *Screen::lockAndGetForEditing() {
 	_frameBuffer.w = _buffer.getSourceWidth();
 	_frameBuffer.h = _buffer.getSourceHeight();
 	_frameBuffer.pitch = _buffer.getBytesPerPixel() * _buffer.getWidth();
-	_frameBuffer.bytesPerPixel = _buffer.getBytesPerPixel();
+	_frameBuffer.format = _pixelFormat;
 	// We'll set to dirty once we unlock the screen
 
 	return &_frameBuffer;
diff --git a/backends/platform/wii/osystem_gfx.cpp b/backends/platform/wii/osystem_gfx.cpp
index cb9a8c72e9..c2be608999 100644
--- a/backends/platform/wii/osystem_gfx.cpp
+++ b/backends/platform/wii/osystem_gfx.cpp
@@ -537,10 +537,10 @@ Graphics::Surface *OSystem_Wii::lockScreen() {
 	_surface.h = _gameHeight;
 #ifdef USE_RGB_COLOR
 	_surface.pitch = _gameWidth * _pfGame.bytesPerPixel;
-	_surface.bytesPerPixel = _pfGame.bytesPerPixel;
+	_surface.format = _pfGame;
 #else
 	_surface.pitch = _gameWidth;
-	_surface.bytesPerPixel = 1;
+	_surface.format = Graphics::PixelFormat::createFormatCLUT8();
 #endif
 
 	return &_surface;
diff --git a/backends/vkeybd/virtual-keyboard-gui.cpp b/backends/vkeybd/virtual-keyboard-gui.cpp
index 050ab5c5a2..9ffda6e3a7 100644
--- a/backends/vkeybd/virtual-keyboard-gui.cpp
+++ b/backends/vkeybd/virtual-keyboard-gui.cpp
@@ -36,7 +36,7 @@
 namespace Common {
 
 static void blit(Graphics::Surface *surf_dst, Graphics::Surface *surf_src, int16 x, int16 y, OverlayColor transparent) {
-	if (surf_dst->bytesPerPixel != sizeof(OverlayColor) || surf_src->bytesPerPixel != sizeof(OverlayColor))
+	if (surf_dst->format.bytesPerPixel != sizeof(OverlayColor) || surf_src->format.bytesPerPixel != sizeof(OverlayColor))
 		return;
 
 	const OverlayColor *src = (const OverlayColor *)surf_src->pixels;
@@ -133,7 +133,7 @@ void VirtualKeyboardGUI::setupDisplayArea(Rect& r, OverlayColor forecolor) {
 	_dispI = 0;
 	_dispForeColor = forecolor;
 	_dispBackColor = _dispForeColor + 0xFF;
-	_dispSurface.create(r.width(), _dispFont->getFontHeight(), sizeof(OverlayColor));
+	_dispSurface.create(r.width(), _dispFont->getFontHeight(), _system->getOverlayFormat());
 	_dispSurface.fillRect(Rect(_dispSurface.w, _dispSurface.h), _dispBackColor);
 	_displayEnabled = true;
 }
@@ -163,7 +163,7 @@ void VirtualKeyboardGUI::run() {
 		_system->showOverlay();
 		_system->clearOverlay();
 	}
-	_overlayBackup.create(_screenW, _screenH, sizeof(OverlayColor));
+	_overlayBackup.create(_screenW, _screenH, _system->getOverlayFormat());
 	_system->grabOverlay((OverlayColor*)_overlayBackup.pixels, _overlayBackup.w);
 
 	setupCursor();
@@ -265,7 +265,7 @@ void VirtualKeyboardGUI::screenChanged() {
 		_screenW = newScreenW;
 		_screenH = newScreenH;
 
-		_overlayBackup.create(_screenW, _screenH, sizeof(OverlayColor));
+		_overlayBackup.create(_screenW, _screenH, _system->getOverlayFormat());
 		_system->grabOverlay((OverlayColor*)_overlayBackup.pixels, _overlayBackup.w);
 
 		if (!_kbd->checkModeResolutions()) {
@@ -358,7 +358,7 @@ void VirtualKeyboardGUI::redraw() {
 	if (w <= 0 || h <= 0) return;
 
 	Graphics::Surface surf;
-	surf.create(w, h, sizeof(OverlayColor));
+	surf.create(w, h, _system->getOverlayFormat());
 
 	OverlayColor *dst = (OverlayColor *)surf.pixels;
 	const OverlayColor *src = (OverlayColor *) _overlayBackup.getBasePtr(_dirtyRect.left, _dirtyRect.top);