src/guiscalingfilter.cpp

   1 /*
   2 Copyright (C) 2015 Aaron Suen <warr1024@gmail.com>
   3
   4 This program is free software; you can redistribute it and/or modify
   5 it under the terms of the GNU Lesser General Public License as published by
   6 the Free Software Foundation; either version 2.1 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU Lesser General Public License for more details.
  13
  14 You should have received a copy of the GNU Lesser General Public License along
  15 with this program; if not, write to the Free Software Foundation, Inc.,
  16 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17 */
  18
  19 #include "guiscalingfilter.h"
  20 #include "imagefilters.h"
  21 #include "settings.h"
  22 #include "util/numeric.h"
  23 #include <stdio.h>
  24 #include "client/renderingengine.h"
  25
  26 /* Maintain a static cache to store the images that correspond to textures
  27  * in a format that's manipulable by code.  Some platforms exhibit issues
  28  * converting textures back into images repeatedly, and some don't even
  29  * allow it at all.
  30  */
  31 std::map<io::path, video::IImage *> g_imgCache;
  32
  33 /* Maintain a static cache of all pre-scaled textures.  These need to be
  34  * cleared as well when the cached images.
  35  */
  36 std::map<io::path, video::ITexture *> g_txrCache;
  37
  38 /* Manually insert an image into the cache, useful to avoid texture-to-image
  39  * conversion whenever we can intercept it.
  40  */
  41 void guiScalingCache(io::path key, video::IVideoDriver *driver, video::IImage *value)
  42 {
  43         if (!g_settings->getBool("gui_scaling_filter"))
  44                 return;
  45         video::IImage *copied = driver->createImage(value->getColorFormat(),
  46                         value->getDimension());
  47         value->copyTo(copied);
  48         g_imgCache[key] = copied;
  49 }
  50
  51 // Manually clear the cache, e.g. when switching to different worlds.
  52 void guiScalingCacheClear()
  53 {
  54         for (std::map<io::path, video::IImage *>::iterator it = g_imgCache.begin();
  55                         it != g_imgCache.end(); ++it) {
  56                 if (it->second)
  57                         it->second->drop();
  58         }
  59         g_imgCache.clear();
  60         for (std::map<io::path, video::ITexture *>::iterator it = g_txrCache.begin();
  61                         it != g_txrCache.end(); ++it) {
  62                 if (it->second)
  63                         RenderingEngine::get_video_driver()->removeTexture(it->second);
  64         }
  65         g_txrCache.clear();
  66 }
  67
  68 /* Get a cached, high-quality pre-scaled texture for display purposes.  If the
  69  * texture is not already cached, attempt to create it.  Returns a pre-scaled texture,
  70  * or the original texture if unable to pre-scale it.
  71  */
  72 video::ITexture *guiScalingResizeCached(video::IVideoDriver *driver,
  73                 video::ITexture *src, const core::rect<s32> &srcrect,
  74                 const core::rect<s32> &destrect)
  75 {
  76         if (src == NULL)
  77                 return src;
  78         if (!g_settings->getBool("gui_scaling_filter"))
  79                 return src;
  80
  81         // Calculate scaled texture name.
  82         char rectstr[200];
  83         snprintf(rectstr, sizeof(rectstr), "%d:%d:%d:%d:%d:%d",
  84                 srcrect.UpperLeftCorner.X,
  85                 srcrect.UpperLeftCorner.Y,
  86                 srcrect.getWidth(),
  87                 srcrect.getHeight(),
  88                 destrect.getWidth(),
  89                 destrect.getHeight());
  90         io::path origname = src->getName().getPath();
  91         io::path scalename = origname + "@guiScalingFilter:" + rectstr;
  92
  93         // Search for existing scaled texture.
  94         video::ITexture *scaled = g_txrCache[scalename];
  95         if (scaled)
  96                 return scaled;
  97
  98         // Try to find the texture converted to an image in the cache.
  99         // If the image was not found, try to extract it from the texture.
 100         video::IImage* srcimg = g_imgCache[origname];
 101         if (srcimg == NULL) {
 102                 if (!g_settings->getBool("gui_scaling_filter_txr2img"))
 103                         return src;
 104                 srcimg = driver->createImageFromData(src->getColorFormat(),
 105                         src->getSize(), src->lock(), false);
 106                 src->unlock();
 107                 g_imgCache[origname] = srcimg;
 108         }
 109
 110         // Create a new destination image and scale the source into it.
 111         imageCleanTransparent(srcimg, 0);
 112         video::IImage *destimg = driver->createImage(src->getColorFormat(),
 113                         core::dimension2d<u32>((u32)destrect.getWidth(),
 114                         (u32)destrect.getHeight()));
 115         imageScaleNNAA(srcimg, srcrect, destimg);
 116
 117 #ifdef __ANDROID__
 118         // Android is very picky about textures being powers of 2, so expand
 119         // the image dimensions to the next power of 2, if necessary, for
 120         // that platform.
 121         video::IImage *po2img = driver->createImage(src->getColorFormat(),
 122                         core::dimension2d<u32>(npot2((u32)destrect.getWidth()),
 123                         npot2((u32)destrect.getHeight())));
 124         po2img->fill(video::SColor(0, 0, 0, 0));
 125         destimg->copyTo(po2img);
 126         destimg->drop();
 127         destimg = po2img;
 128 #endif
 129
 130         // Convert the scaled image back into a texture.
 131         scaled = driver->addTexture(scalename, destimg, NULL);
 132         destimg->drop();
 133         g_txrCache[scalename] = scaled;
 134
 135         return scaled;
 136 }
 137
 138 /* Convenience wrapper for guiScalingResizeCached that accepts parameters that
 139  * are available at GUI imagebutton creation time.
 140  */
 141 video::ITexture *guiScalingImageButton(video::IVideoDriver *driver,
 142                 video::ITexture *src, s32 width, s32 height)
 143 {
 144         if (src == NULL)
 145                 return src;
 146         return guiScalingResizeCached(driver, src,
 147                 core::rect<s32>(0, 0, src->getSize().Width, src->getSize().Height),
 148                 core::rect<s32>(0, 0, width, height));
 149 }
 150
 151 /* Replacement for driver->draw2DImage() that uses the high-quality pre-scaled
 152  * texture, if configured.
 153  */
 154 void draw2DImageFilterScaled(video::IVideoDriver *driver, video::ITexture *txr,
 155                 const core::rect<s32> &destrect, const core::rect<s32> &srcrect,
 156                 const core::rect<s32> *cliprect, const video::SColor *const colors,
 157                 bool usealpha)
 158 {
 159         // Attempt to pre-scale image in software in high quality.
 160         video::ITexture *scaled = guiScalingResizeCached(driver, txr, srcrect, destrect);
 161         if (scaled == NULL)
 162                 return;
 163
 164         // Correct source rect based on scaled image.
 165         const core::rect<s32> mysrcrect = (scaled != txr)
 166                 ? core::rect<s32>(0, 0, destrect.getWidth(), destrect.getHeight())
 167                 : srcrect;
 168
 169         driver->draw2DImage(scaled, destrect, mysrcrect, cliprect, colors, usealpha);
 170 }