add SurfaceImageHelper for loading/processing surfaces for SDL2.

For SDL1.2 used SDLImageHelper.

14 files changed, 342 insertions, 33 deletions

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index cd4be5cd6..55b0eeca2 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -503,6 +503,8 @@ SET(SRCS
     resources/spritedef.cpp
     resources/subimage.cpp
     resources/subimage.h
+    resources/surfaceimagehelper.cpp
+    resources/surfaceimagehelper.h
     resources/wallpaper.cpp
     resources/wallpaper.h
     utils/translation/podict.cpp
diff --git a/src/Makefile.am b/src/Makefile.am
index 927d854f2..b211a8689 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -512,6 +512,8 @@ manaplus_SOURCES += gui/widgets/avatarlistbox.cpp \
 	      resources/spritedef.h \
 	      resources/subimage.cpp \
 	      resources/subimage.h \
+	      resources/surfaceimagehelper.cpp \
+	      resources/surfaceimagehelper.h \
 	      resources/wallpaper.cpp \
 	      resources/wallpaper.h \
 	      utils/translation/podict.cpp \
diff --git a/src/client.cpp b/src/client.cpp
index 02719debc..72da13128 100644
--- a/src/client.cpp
+++ b/src/client.cpp
@@ -88,7 +88,7 @@
 #include "resources/imagehelper.h"
 #include "resources/openglimagehelper.h"
 #include "resources/palettedb.h"
-#include "resources/sdlimagehelper.h"
+#include "resources/surfaceimagehelper.h"
 #include "resources/sounddb.h"
 #include "resources/itemdb.h"
 #include "resources/mapdb.h"
@@ -565,13 +565,14 @@ void Client::gameInit()
 #ifdef USE_OPENGL
     openGLMode = config.getIntValue("opengl");
     OpenGLImageHelper::setBlur(config.getBoolValue("blur"));
-    SDLImageHelper::SDLSetEnableAlphaCache(config.getBoolValue("alphaCache")
-        && !openGLMode);
+    SurfaceImageHelper::SDLSetEnableAlphaCache(
+        config.getBoolValue("alphaCache") && !openGLMode);
     ImageHelper::setEnableAlpha(config.getFloatValue("guialpha") != 1.0f
         || openGLMode);
 #else
     openGLMode = 0;
-    SDLImageHelper::SDLSetEnableAlphaCache(config.getBoolValue("alphaCache"));
+    SurfaceImageHelper::SDLSetEnableAlphaCache(
+        config.getBoolValue("alphaCache"));
     ImageHelper::setEnableAlpha(config.getFloatValue("guialpha") != 1.0f);
 #endif
     logVars();
@@ -802,9 +803,9 @@ void Client::gameClear()
     delete mainGraphics;
     mainGraphics = nullptr;
 
-    if (imageHelper != sdlImageHelper)
-        delete sdlImageHelper;
-    sdlImageHelper = nullptr;
+    if (imageHelper != surfaceImageHelper)
+        delete surfaceImageHelper;
+    surfaceImageHelper = nullptr;
     delete imageHelper;
     imageHelper = nullptr;
 
diff --git a/src/graphicsmanager.cpp b/src/graphicsmanager.cpp
index 0dcfbb377..fb1ce3a32 100644
--- a/src/graphicsmanager.cpp
+++ b/src/graphicsmanager.cpp
@@ -47,6 +47,7 @@
 #include "resources/imagehelper.h"
 #include "resources/openglimagehelper.h"
 #include "resources/sdlimagehelper.h"
+#include "resources/surfaceimagehelper.h"
 
 #include "utils/paths.h"
 #include "utils/sdlhelper.h"
@@ -229,7 +230,11 @@ void GraphicsManager::initGraphics(const bool noOpenGL)
     {
         case 0:
             imageHelper = new SDLImageHelper;
-            sdlImageHelper = imageHelper;
+#ifdef USE_SDL2
+            surfaceImageHelper = new SurfaceImageHelper;
+#else
+            surfaceImageHelper = imageHelper;
+#endif
             mainGraphics = new SDLGraphics;
             mUseTextureSampler = false;
             break;
@@ -237,20 +242,20 @@ void GraphicsManager::initGraphics(const bool noOpenGL)
         default:
 #ifndef ANDROID
             imageHelper = new OpenGLImageHelper;
-            sdlImageHelper = new SDLImageHelper;
+            surfaceImageHelper = new SurfaceImageHelper;
             mainGraphics = new NormalOpenGLGraphics;
             mUseTextureSampler = true;
             break;
         case 2:
             imageHelper = new OpenGLImageHelper;
-            sdlImageHelper = new SDLImageHelper;
+            surfaceImageHelper = new SurfaceImageHelper;
             mainGraphics = new SafeOpenGLGraphics;
             mUseTextureSampler = false;
             break;
 #endif
         case 3:
             imageHelper = new OpenGLImageHelper;
-            sdlImageHelper = new SDLImageHelper;
+            surfaceImageHelper = new SurfaceImageHelper;
             mainGraphics = new MobileOpenGLGraphics;
             mUseTextureSampler = false;
             break;
@@ -262,7 +267,11 @@ void GraphicsManager::initGraphics(const bool noOpenGL A_UNUSED)
 {
     // Create the graphics context
     imageHelper = new SDLImageHelper;
-    sdlImageHelper = imageHelper;
+#ifdef USE_SDL2
+    surfaceImageHelper = new SurfaceImageHelper;
+#else
+    surfaceImageHelper = imageHelper;
+#endif
     mainGraphics = new SDLGraphics;
 #endif
 }
diff --git a/src/gui/sdlfont.cpp b/src/gui/sdlfont.cpp
index 653e7f69f..b6e0b8986 100644
--- a/src/gui/sdlfont.cpp
+++ b/src/gui/sdlfont.cpp
@@ -32,7 +32,7 @@
 #include "resources/image.h"
 #include "resources/imagehelper.h"
 #include "resources/resourcemanager.h"
-#include "resources/sdlimagehelper.h"
+#include "resources/surfaceimagehelper.h"
 
 #include <guichan/exception.hpp>
 
@@ -196,17 +196,22 @@ void SDLTextChunk::generate(TTF_Font *const font, const float alpha)
             static_cast<Uint16>(surface->w),
             static_cast<Uint16>(surface->h)
         };
-        SDLImageHelper::combineSurface(surface2, nullptr, background, &rect);
+        SurfaceImageHelper::combineSurface(surface2, nullptr,
+            background, &rect);
         rect.x = -OUTLINE_SIZE;
-        SDLImageHelper::combineSurface(surface2, nullptr, background, &rect);
+        SurfaceImageHelper::combineSurface(surface2, nullptr,
+            background, &rect);
         rect.x = 0;
         rect.y = -OUTLINE_SIZE;
-        SDLImageHelper::combineSurface(surface2, nullptr, background, &rect);
+        SurfaceImageHelper::combineSurface(surface2, nullptr,
+            background, &rect);
         rect.y = OUTLINE_SIZE;
-        SDLImageHelper::combineSurface(surface2, nullptr, background, &rect);
+        SurfaceImageHelper::combineSurface(surface2, nullptr,
+            background, &rect);
         rect.x = 0;
         rect.y = 0;
-        SDLImageHelper::combineSurface(surface, nullptr, background, &rect);
+        SurfaceImageHelper::combineSurface(surface, nullptr,
+            background, &rect);
         SDL_FreeSurface(surface);
         SDL_FreeSurface(surface2);
         surface = background;
diff --git a/src/resources/atlasmanager.cpp b/src/resources/atlasmanager.cpp
index 4b3656ee6..a5d7c2ccc 100644
--- a/src/resources/atlasmanager.cpp
+++ b/src/resources/atlasmanager.cpp
@@ -117,8 +117,8 @@ void AtlasManager::loadImages(const StringVect &files,
         SDL_RWops *const rw = PHYSFSRWOPS_openRead(path.c_str());
         if (rw)
         {
-            Image *const image = d ? sdlImageHelper->load(rw, *d)
-                : sdlImageHelper->load(rw);
+            Image *const image = d ? surfaceImageHelper->load(rw, *d)
+                : surfaceImageHelper->load(rw);
 
             if (image)
             {
diff --git a/src/resources/image.h b/src/resources/image.h
index b31ecb29e..ed42991bb 100644
--- a/src/resources/image.h
+++ b/src/resources/image.h
@@ -58,6 +58,9 @@ class Image : public Resource
     friend class SDLGraphics;
     friend class SDLImageHelper;
     friend class SurfaceGraphics;
+#ifdef USE_SDL2
+    friend class SurfaceImageHelper;
+#endif
     friend class TestLauncher;
 #ifdef USE_OPENGL
     friend class AtlasManager;
diff --git a/src/resources/imagehelper.cpp b/src/resources/imagehelper.cpp
index 0dce5b40a..65af2755a 100644
--- a/src/resources/imagehelper.cpp
+++ b/src/resources/imagehelper.cpp
@@ -36,7 +36,7 @@
 #include "debug.h"
 
 ImageHelper *imageHelper = nullptr;
-ImageHelper *sdlImageHelper = nullptr;
+ImageHelper *surfaceImageHelper = nullptr;
 
 bool ImageHelper::mEnableAlpha = true;
 
diff --git a/src/resources/imagehelper.h b/src/resources/imagehelper.h
index cf01a3f1e..93c8784d5 100644
--- a/src/resources/imagehelper.h
+++ b/src/resources/imagehelper.h
@@ -105,5 +105,5 @@ class ImageHelper
 };
 
 extern ImageHelper *imageHelper;
-extern ImageHelper *sdlImageHelper;
+extern ImageHelper *surfaceImageHelper;
 #endif  // RESOURCES_IMAGEHELPER_H
diff --git a/src/resources/sdl2imagehelper.cpp b/src/resources/sdl2imagehelper.cpp
index c5a75d236..b131b4d69 100644
--- a/src/resources/sdl2imagehelper.cpp
+++ b/src/resources/sdl2imagehelper.cpp
@@ -22,7 +22,7 @@
 
 #ifdef USE_SDL2
 
-#include "resources/sdlimagehelper.h"
+#include "resources/sdl2imagehelper.h"
 
 #include "resources/dye.h"
 #include "resources/resourcemanager.h"
diff --git a/src/resources/surfaceimagehelper.cpp b/src/resources/surfaceimagehelper.cpp
new file mode 100644
index 000000000..1b5997ce0
--- /dev/null
+++ b/src/resources/surfaceimagehelper.cpp
@@ -0,0 +1,178 @@
+/*
+ *  The ManaPlus Client
+ *  Copyright (C) 2004-2009  The Mana World Development Team
+ *  Copyright (C) 2009-2010  The Mana Developers
+ *  Copyright (C) 2011-2013  The ManaPlus Developers
+ *
+ *  This file is part of The ManaPlus Client.
+ *
+ *  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
+ *  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/>.
+ */
+
+#ifdef USE_SDL2
+
+#include "resources/surfaceimagehelper.h"
+
+#include "resources/dye.h"
+#include "resources/resourcemanager.h"
+
+#include "client.h"
+#include "logger.h"
+#include "main.h"
+
+#include "resources/image.h"
+
+#include <SDL_image.h>
+
+#include "debug.h"
+
+bool SurfaceImageHelper::mEnableAlphaCache = false;
+
+Image *SurfaceImageHelper::load(SDL_RWops *const rw, Dye const &dye) const
+{
+    SDL_Surface *const tmpImage = loadPng(rw);
+    if (!tmpImage)
+    {
+        logger->log("Error, image load failed: %s", IMG_GetError());
+        return nullptr;
+    }
+
+    SDL_PixelFormat rgba;
+    rgba.palette = nullptr;
+    rgba.BitsPerPixel = 32;
+    rgba.BytesPerPixel = 4;
+
+#if SDL_BYTEORDER == SDL_BIG_ENDIAN
+    rgba.Rmask = 0x000000FF;
+    rgba.Gmask = 0x0000FF00;
+    rgba.Bmask = 0x00FF0000;
+    rgba.Amask = 0xFF000000;
+#else
+    rgba.Rmask = 0xFF000000;
+    rgba.Gmask = 0x00FF0000;
+    rgba.Bmask = 0x0000FF00;
+    rgba.Amask = 0x000000FF;
+#endif
+
+    SDL_Surface *const surf = SDL_ConvertSurface(
+        tmpImage, &rgba, SDL_SWSURFACE);
+    SDL_FreeSurface(tmpImage);
+
+    uint32_t *pixels = static_cast<uint32_t *>(surf->pixels);
+    const int type = dye.getType();
+
+    switch (type)
+    {
+        case 1:
+        {
+            const DyePalette *const pal = dye.getSPalete();
+            if (pal)
+                pal->replaceSColor(pixels, surf->w * surf->h);
+            break;
+        }
+        case 2:
+        {
+            const DyePalette *const pal = dye.getAPalete();
+            if (pal)
+                pal->replaceAColor(pixels, surf->w * surf->h);
+            break;
+        }
+        case 0:
+        default:
+        {
+            dye.normalDye(pixels, surf->w * surf->h);
+            break;
+        }
+    }
+
+    Image *const image = load(surf);
+    SDL_FreeSurface(surf);
+    return image;
+}
+
+Image *SurfaceImageHelper::load(SDL_Surface *const tmpImage) const
+{
+    return _SDLload(tmpImage);
+}
+
+Image *SurfaceImageHelper::createTextSurface(SDL_Surface *const tmpImage,
+                                             const int width A_UNUSED,
+                                             const int height A_UNUSED,
+                                             const float alpha) const
+{
+    if (!tmpImage)
+        return nullptr;
+
+    Image *img;
+    bool hasAlpha = false;
+    uint8_t *alphaChannel = nullptr;
+    SDL_Surface *image = SDLDuplicateSurface(tmpImage);
+
+    img = new Image(image, hasAlpha, alphaChannel);
+    img->mAlpha = alpha;
+    return img;
+}
+
+SDL_Surface* SurfaceImageHelper::SDLDuplicateSurface(SDL_Surface *const
+                                                     tmpImage)
+{
+    if (!tmpImage || !tmpImage->format)
+        return nullptr;
+
+    return SDL_ConvertSurface(tmpImage, tmpImage->format, SDL_SWSURFACE);
+}
+
+Image *SurfaceImageHelper::_SDLload(SDL_Surface *tmpImage) const
+{
+    if (!tmpImage)
+        return nullptr;
+
+    SDL_Surface *image = convertTo32Bit(tmpImage);
+    return new Image(image, false, nullptr);
+}
+
+int SurfaceImageHelper::useOpenGL() const
+{
+    return 0;
+}
+
+SDL_Surface *SurfaceImageHelper::create32BitSurface(int width, int height) const
+{
+#if SDL_BYTEORDER == SDL_BIG_ENDIAN
+    const int rmask = 0xff000000;
+    const int gmask = 0x00ff0000;
+    const int bmask = 0x0000ff00;
+    const int amask = 0x000000ff;
+#else
+    const int rmask = 0x000000ff;
+    const int gmask = 0x0000ff00;
+    const int bmask = 0x00ff0000;
+    const int amask = 0xff000000;
+#endif
+
+    return SDL_CreateRGBSurface(SDL_SWSURFACE,
+        width, height, 32, rmask, gmask, bmask, amask);
+}
+
+int SurfaceImageHelper::combineSurface(SDL_Surface *const src,
+                                       SDL_Rect *const srcrect,
+                                       SDL_Surface *const dst,
+                                       SDL_Rect *const dstrect)
+{
+    SDL_SetSurfaceBlendMode (src, SDL_BLENDMODE_BLEND);
+    SDL_BlitSurface(src, srcrect, dst, dstrect);
+    return 1;
+}
+
+#endif  // USE_SDL2
diff --git a/src/resources/surfaceimagehelper.h b/src/resources/surfaceimagehelper.h
new file mode 100644
index 000000000..afc80cbbb
--- /dev/null
+++ b/src/resources/surfaceimagehelper.h
@@ -0,0 +1,108 @@
+/*
+ *  The ManaPlus Client
+ *  Copyright (C) 2004-2009  The Mana World Development Team
+ *  Copyright (C) 2009-2010  The Mana Developers
+ *  Copyright (C) 2011-2013  The ManaPlus Developers
+ *
+ *  This file is part of The ManaPlus Client.
+ *
+ *  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
+ *  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 RESOURCES_SURFACEIMAGEHELPER_H
+#define RESOURCES_SURFACEIMAGEHELPER_H
+
+#ifndef USE_SDL2
+#include "resources/sdlimagehelper.h"
+
+#else
+
+#include "localconsts.h"
+
+#include "resources/imagehelper.h"
+
+#include <SDL.h>
+
+class Dye;
+class Image;
+
+/**
+ * Defines a class for loading and storing images.
+ */
+class SurfaceImageHelper final : public ImageHelper
+{
+    friend class Image;
+
+    public:
+        SurfaceImageHelper()
+        { }
+
+        A_DELETE_COPY(SurfaceImageHelper)
+
+        virtual ~SurfaceImageHelper()
+        { }
+
+        /**
+         * Loads an image from an SDL_RWops structure and recolors it.
+         *
+         * @param rw         The SDL_RWops to load the image from.
+         * @param dye        The dye used to recolor the image.
+         *
+         * @return <code>NULL</code> if an error occurred, a valid pointer
+         *         otherwise.
+         */
+        Image *load(SDL_RWops *const rw,
+                    Dye const &dye) const override A_WARN_UNUSED;
+
+        /**
+         * Loads an image from an SDL surface.
+         */
+        Image *load(SDL_Surface *const tmpImage) const override A_WARN_UNUSED;
+
+        Image *createTextSurface(SDL_Surface *const tmpImage,
+                                 const int width, const int height,
+                                 const float alpha)
+                                 const override A_WARN_UNUSED;
+
+        static void SDLSetEnableAlphaCache(const bool n)
+        { mEnableAlphaCache = n; }
+
+        static bool SDLGetEnableAlphaCache() A_WARN_UNUSED
+        { return mEnableAlphaCache; }
+
+         /**
+         * Tells if the image was loaded using OpenGL or SDL
+         * @return true if OpenGL, false if SDL.
+         */
+        int useOpenGL() const override A_WARN_UNUSED;
+
+        static SDL_Surface* SDLDuplicateSurface(SDL_Surface *const tmpImage)
+                                                A_WARN_UNUSED;
+
+        SDL_Surface *create32BitSurface(int width, int height) const override;
+
+        static int combineSurface(SDL_Surface *const src,
+                                  SDL_Rect *const srcrect,
+                                  SDL_Surface *const dst,
+                                  SDL_Rect *const dstrect);
+
+    protected:
+        /** SDL_Surface to SDL_Surface Image loader */
+        Image *_SDLload(SDL_Surface *tmpImage) const A_WARN_UNUSED;
+
+        static bool mEnableAlphaCache;
+};
+
+#endif  // USE_SDL2
+#endif  // RESOURCES_SURFACEIMAGEHELPER_H
diff --git a/src/sdlshared.h b/src/sdlshared.h
index 7683cb9f2..48e4ce25b 100644
--- a/src/sdlshared.h
+++ b/src/sdlshared.h
@@ -58,6 +58,7 @@
 
 #define SDL_Window SDL_Surface
 #define SDL_JoystickNameForIndex SDL_JoystickName
+#define SurfaceImageHelper SDLImageHelper
 
 #endif  // USE_SDL2
 
diff --git a/src/test/testlauncher.cpp b/src/test/testlauncher.cpp
index 09a505e85..0781c101b 100644
--- a/src/test/testlauncher.cpp
+++ b/src/test/testlauncher.cpp
@@ -38,7 +38,7 @@
 #include "resources/image.h"
 #include "resources/imagehelper.h"
 #include "resources/imagewriter.h"
-#include "resources/sdlimagehelper.h"
+#include "resources/surfaceimagehelper.h"
 #include "resources/wallpaper.h"
 
 #include <unistd.h>
@@ -241,16 +241,16 @@ int TestLauncher::testDye()
 
     if (rw)
     {
-        Image *image = d ? sdlImageHelper->load(rw, *d)
-            : sdlImageHelper->load(rw);
+        Image *image = d ? surfaceImageHelper->load(rw, *d)
+            : surfaceImageHelper->load(rw);
         if (image)
         {
             const SDL_Rect &rect = image->mBounds;
-            SDL_Surface *surface = sdlImageHelper->create32BitSurface(
+            SDL_Surface *surface = surfaceImageHelper->create32BitSurface(
                 rect.w, rect.h);
             if (surface)
             {
-                SDLImageHelper::combineSurface(image->mSDLSurface, nullptr,
+                SurfaceImageHelper::combineSurface(image->mSDLSurface, nullptr,
                     surface, nullptr);
                 ImageWriter::writePNG(image->mSDLSurface,
                     client->getTempDirectory() + "/testimage1.png");
@@ -261,16 +261,16 @@ int TestLauncher::testDye()
             rw = PHYSFSRWOPS_openRead(
                 "graphics/sprites/arrow_up.png");
             d = new Dye("S:#0000ff,00ff00,5c5cff,ff0000");
-            image = d ? sdlImageHelper->load(rw, *d)
-                : sdlImageHelper->load(rw);
+            image = d ? surfaceImageHelper->load(rw, *d)
+                : surfaceImageHelper->load(rw);
             if (image)
             {
-                surface = sdlImageHelper->create32BitSurface(
+                surface = surfaceImageHelper->create32BitSurface(
                     rect.w, rect.h);
                 if (surface)
                 {
-                    SDLImageHelper::combineSurface(image->mSDLSurface, nullptr,
-                        surface, nullptr);
+                    SurfaceImageHelper::combineSurface(image->mSDLSurface,
+                        nullptr, surface, nullptr);
                     ImageWriter::writePNG(image->mSDLSurface,
                         client->getTempDirectory() + "/testimage3.png");
                     ImageWriter::writePNG(surface,