Remove unused ITextSceneNode header (#11476)

[dragonfireclient.git] / src / client / tile.cpp

/*
Minetest
Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser 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.
*/

#include "tile.h"

#include <algorithm>
#include <ICameraSceneNode.h>
#include <IrrCompileConfig.h>
#include "util/string.h"
#include "util/container.h"
#include "util/thread.h"
#include "filesys.h"
#include "settings.h"
#include "mesh.h"
#include "gamedef.h"
#include "util/strfnd.h"
#include "imagefilters.h"
#include "guiscalingfilter.h"
#include "renderingengine.h"

/*
        A cache from texture name to texture path
*/
MutexedMap<std::string, std::string> g_texturename_to_path_cache;

/*
        Replaces the filename extension.
        eg:
                std::string image = "a/image.png"
                replace_ext(image, "jpg")
                -> image = "a/image.jpg"
        Returns true on success.
*/
static bool replace_ext(std::string &path, const char *ext)
{
        if (ext == NULL)
                return false;
        // Find place of last dot, fail if \ or / found.
        s32 last_dot_i = -1;
        for (s32 i=path.size()-1; i>=0; i--)
        {
                if (path[i] == '.')
                {
                        last_dot_i = i;
                        break;
                }

                if (path[i] == '\\' || path[i] == '/')
                        break;
        }
        // If not found, return an empty string
        if (last_dot_i == -1)
                return false;
        // Else make the new path
        path = path.substr(0, last_dot_i+1) + ext;
        return true;
}

/*
        Find out the full path of an image by trying different filename
        extensions.

        If failed, return "".
*/
std::string getImagePath(std::string path)
{
        // A NULL-ended list of possible image extensions
        const char *extensions[] = {
                "png", "jpg", "bmp", "tga",
                "pcx", "ppm", "psd", "wal", "rgb",
                NULL
        };
        // If there is no extension, add one
        if (removeStringEnd(path, extensions).empty())
                path = path + ".png";
        // Check paths until something is found to exist
        const char **ext = extensions;
        do{
                bool r = replace_ext(path, *ext);
                if (!r)
                        return "";
                if (fs::PathExists(path))
                        return path;
        }
        while((++ext) != NULL);

        return "";
}

/*
        Gets the path to a texture by first checking if the texture exists
        in texture_path and if not, using the data path.

        Checks all supported extensions by replacing the original extension.

        If not found, returns "".

        Utilizes a thread-safe cache.
*/
std::string getTexturePath(const std::string &filename, bool *is_base_pack)
{
        std::string fullpath;

        // This can set a wrong value on cached textures, but is irrelevant because
        // is_base_pack is only passed when initializing the textures the first time
        if (is_base_pack)
                *is_base_pack = false;
        /*
                Check from cache
        */
        bool incache = g_texturename_to_path_cache.get(filename, &fullpath);
        if (incache)
                return fullpath;

        /*
                Check from texture_path
        */
        for (const auto &path : getTextureDirs()) {
                std::string testpath = path + DIR_DELIM;
                testpath.append(filename);
                // Check all filename extensions. Returns "" if not found.
                fullpath = getImagePath(testpath);
                if (!fullpath.empty())
                        break;
        }

        /*
                Check from default data directory
        */
        if (fullpath.empty())
        {
                std::string base_path = porting::path_share + DIR_DELIM + "textures"
                                + DIR_DELIM + "base" + DIR_DELIM + "pack";
                std::string testpath = base_path + DIR_DELIM + filename;
                // Check all filename extensions. Returns "" if not found.
                fullpath = getImagePath(testpath);
                if (is_base_pack && !fullpath.empty())
                        *is_base_pack = true;
        }

        // Add to cache (also an empty result is cached)
        g_texturename_to_path_cache.set(filename, fullpath);

        // Finally return it
        return fullpath;
}

void clearTextureNameCache()
{
        g_texturename_to_path_cache.clear();
}

/*
        Stores internal information about a texture.
*/

struct TextureInfo
{
        std::string name;
        video::ITexture *texture;

        TextureInfo(
                        const std::string &name_,
                        video::ITexture *texture_=NULL
                ):
                name(name_),
                texture(texture_)
        {
        }
};

/*
        SourceImageCache: A cache used for storing source images.
*/

class SourceImageCache
{
public:
        ~SourceImageCache() {
                for (auto &m_image : m_images) {
                        m_image.second->drop();
                }
                m_images.clear();
        }
        void insert(const std::string &name, video::IImage *img, bool prefer_local)
        {
                assert(img); // Pre-condition
                // Remove old image
                std::map<std::string, video::IImage*>::iterator n;
                n = m_images.find(name);
                if (n != m_images.end()){
                        if (n->second)
                                n->second->drop();
                }

                video::IImage* toadd = img;
                bool need_to_grab = true;

                // Try to use local texture instead if asked to
                if (prefer_local) {
                        bool is_base_pack;
                        std::string path = getTexturePath(name, &is_base_pack);
                        // Ignore base pack
                        if (!path.empty() && !is_base_pack) {
                                video::IImage *img2 = RenderingEngine::get_video_driver()->
                                        createImageFromFile(path.c_str());
                                if (img2){
                                        toadd = img2;
                                        need_to_grab = false;
                                }
                        }
                }

                if (need_to_grab)
                        toadd->grab();
                m_images[name] = toadd;
        }
        video::IImage* get(const std::string &name)
        {
                std::map<std::string, video::IImage*>::iterator n;
                n = m_images.find(name);
                if (n != m_images.end())
                        return n->second;
                return NULL;
        }
        // Primarily fetches from cache, secondarily tries to read from filesystem
        video::IImage *getOrLoad(const std::string &name)
        {
                std::map<std::string, video::IImage*>::iterator n;
                n = m_images.find(name);
                if (n != m_images.end()){
                        n->second->grab(); // Grab for caller
                        return n->second;
                }
                video::IVideoDriver *driver = RenderingEngine::get_video_driver();
                std::string path = getTexturePath(name);
                if (path.empty()) {
                        infostream<<"SourceImageCache::getOrLoad(): No path found for \""
                                        <<name<<"\""<<std::endl;
                        return NULL;
                }
                infostream<<"SourceImageCache::getOrLoad(): Loading path \""<<path
                                <<"\""<<std::endl;
                video::IImage *img = driver->createImageFromFile(path.c_str());

                if (img){
                        m_images[name] = img;
                        img->grab(); // Grab for caller
                }
                return img;
        }
private:
        std::map<std::string, video::IImage*> m_images;
};

/*
        TextureSource
*/

class TextureSource : public IWritableTextureSource
{
public:
        TextureSource();
        virtual ~TextureSource();

        /*
                Example case:
                Now, assume a texture with the id 1 exists, and has the name
                "stone.png^mineral1".
                Then a random thread calls getTextureId for a texture called
                "stone.png^mineral1^crack0".
                ...Now, WTF should happen? Well:
                - getTextureId strips off stuff recursively from the end until
                  the remaining part is found, or nothing is left when
                  something is stripped out

                But it is slow to search for textures by names and modify them
                like that?
                - ContentFeatures is made to contain ids for the basic plain
                  textures
                - Crack textures can be slow by themselves, but the framework
                  must be fast.

                Example case #2:
                - Assume a texture with the id 1 exists, and has the name
                  "stone.png^mineral_coal.png".
                - Now getNodeTile() stumbles upon a node which uses
                  texture id 1, and determines that MATERIAL_FLAG_CRACK
                  must be applied to the tile
                - MapBlockMesh::animate() finds the MATERIAL_FLAG_CRACK and
                  has received the current crack level 0 from the client. It
                  finds out the name of the texture with getTextureName(1),
                  appends "^crack0" to it and gets a new texture id with
                  getTextureId("stone.png^mineral_coal.png^crack0").

        */

        /*
                Gets a texture id from cache or
                - if main thread, generates the texture, adds to cache and returns id.
                - if other thread, adds to request queue and waits for main thread.

                The id 0 points to a NULL texture. It is returned in case of error.
        */
        u32 getTextureId(const std::string &name);

        // Finds out the name of a cached texture.
        std::string getTextureName(u32 id);

        /*
                If texture specified by the name pointed by the id doesn't
                exist, create it, then return the cached texture.

                Can be called from any thread. If called from some other thread
                and not found in cache, the call is queued to the main thread
                for processing.
        */
        video::ITexture* getTexture(u32 id);

        video::ITexture* getTexture(const std::string &name, u32 *id = NULL);

        /*
                Get a texture specifically intended for mesh
                application, i.e. not HUD, compositing, or other 2D
                use.  This texture may be a different size and may
                have had additional filters applied.
        */
        video::ITexture* getTextureForMesh(const std::string &name, u32 *id);

        virtual Palette* getPalette(const std::string &name);

        bool isKnownSourceImage(const std::string &name)
        {
                bool is_known = false;
                bool cache_found = m_source_image_existence.get(name, &is_known);
                if (cache_found)
                        return is_known;
                // Not found in cache; find out if a local file exists
                is_known = (!getTexturePath(name).empty());
                m_source_image_existence.set(name, is_known);
                return is_known;
        }

        // Processes queued texture requests from other threads.
        // Shall be called from the main thread.
        void processQueue();

        // Insert an image into the cache without touching the filesystem.
        // Shall be called from the main thread.
        void insertSourceImage(const std::string &name, video::IImage *img);

        // Rebuild images and textures from the current set of source images
        // Shall be called from the main thread.
        void rebuildImagesAndTextures();

        video::ITexture* getNormalTexture(const std::string &name);
        video::SColor getTextureAverageColor(const std::string &name);
        video::ITexture *getShaderFlagsTexture(bool normamap_present);

private:

        // The id of the thread that is allowed to use irrlicht directly
        std::thread::id m_main_thread;

        // Cache of source images
        // This should be only accessed from the main thread
        SourceImageCache m_sourcecache;

        // Generate a texture
        u32 generateTexture(const std::string &name);

        // Generate image based on a string like "stone.png" or "[crack:1:0".
        // if baseimg is NULL, it is created. Otherwise stuff is made on it.
        bool generateImagePart(std::string part_of_name, video::IImage *& baseimg);

        /*! Generates an image from a full string like
         * "stone.png^mineral_coal.png^[crack:1:0".
         * Shall be called from the main thread.
         * The returned Image should be dropped.
         */
        video::IImage* generateImage(const std::string &name);

        // Thread-safe cache of what source images are known (true = known)
        MutexedMap<std::string, bool> m_source_image_existence;

        // A texture id is index in this array.
        // The first position contains a NULL texture.
        std::vector<TextureInfo> m_textureinfo_cache;
        // Maps a texture name to an index in the former.
        std::map<std::string, u32> m_name_to_id;
        // The two former containers are behind this mutex
        std::mutex m_textureinfo_cache_mutex;

        // Queued texture fetches (to be processed by the main thread)
        RequestQueue<std::string, u32, u8, u8> m_get_texture_queue;

        // Textures that have been overwritten with other ones
        // but can't be deleted because the ITexture* might still be used
        std::vector<video::ITexture*> m_texture_trash;

        // Maps image file names to loaded palettes.
        std::unordered_map<std::string, Palette> m_palettes;

        // Cached settings needed for making textures from meshes
        bool m_setting_mipmap;
        bool m_setting_trilinear_filter;
        bool m_setting_bilinear_filter;
};

IWritableTextureSource *createTextureSource()
{
        return new TextureSource();
}

TextureSource::TextureSource()
{
        m_main_thread = std::this_thread::get_id();

        // Add a NULL TextureInfo as the first index, named ""
        m_textureinfo_cache.emplace_back("");
        m_name_to_id[""] = 0;

        // Cache some settings
        // Note: Since this is only done once, the game must be restarted
        // for these settings to take effect
        m_setting_mipmap = g_settings->getBool("mip_map");
        m_setting_trilinear_filter = g_settings->getBool("trilinear_filter");
        m_setting_bilinear_filter = g_settings->getBool("bilinear_filter");
}

TextureSource::~TextureSource()
{
        video::IVideoDriver *driver = RenderingEngine::get_video_driver();

        unsigned int textures_before = driver->getTextureCount();

        for (const auto &iter : m_textureinfo_cache) {
                //cleanup texture
                if (iter.texture)
                        driver->removeTexture(iter.texture);
        }
        m_textureinfo_cache.clear();

        for (auto t : m_texture_trash) {
                //cleanup trashed texture
                driver->removeTexture(t);
        }

        infostream << "~TextureSource() before cleanup: "<< textures_before
                        << " after: " << driver->getTextureCount() << std::endl;
}

u32 TextureSource::getTextureId(const std::string &name)
{
        //infostream<<"getTextureId(): \""<<name<<"\""<<std::endl;

        {
                /*
                        See if texture already exists
                */
                MutexAutoLock lock(m_textureinfo_cache_mutex);
                std::map<std::string, u32>::iterator n;
                n = m_name_to_id.find(name);
                if (n != m_name_to_id.end())
                {
                        return n->second;
                }
        }

        /*
                Get texture
        */
        if (std::this_thread::get_id() == m_main_thread) {
                return generateTexture(name);
        }


        infostream<<"getTextureId(): Queued: name=\""<<name<<"\""<<std::endl;

        // We're gonna ask the result to be put into here
        static ResultQueue<std::string, u32, u8, u8> result_queue;

        // Throw a request in
        m_get_texture_queue.add(name, 0, 0, &result_queue);

        try {
                while(true) {
                        // Wait result for a second
                        GetResult<std::string, u32, u8, u8>
                                result = result_queue.pop_front(1000);

                        if (result.key == name) {
                                return result.item;
                        }
                }
        } catch(ItemNotFoundException &e) {
                errorstream << "Waiting for texture " << name << " timed out." << std::endl;
                return 0;
        }

        infostream << "getTextureId(): Failed" << std::endl;

        return 0;
}

// Draw an image on top of an another one, using the alpha channel of the
// source image
static void blit_with_alpha(video::IImage *src, video::IImage *dst,
                v2s32 src_pos, v2s32 dst_pos, v2u32 size);

// Like blit_with_alpha, but only modifies destination pixels that
// are fully opaque
static void blit_with_alpha_overlay(video::IImage *src, video::IImage *dst,
                v2s32 src_pos, v2s32 dst_pos, v2u32 size);

// Apply a color to an image.  Uses an int (0-255) to calculate the ratio.
// If the ratio is 255 or -1 and keep_alpha is true, then it multiples the
// color alpha with the destination alpha.
// Otherwise, any pixels that are not fully transparent get the color alpha.
static void apply_colorize(video::IImage *dst, v2u32 dst_pos, v2u32 size,
                const video::SColor &color, int ratio, bool keep_alpha);

// paint a texture using the given color
static void apply_multiplication(video::IImage *dst, v2u32 dst_pos, v2u32 size,
                const video::SColor &color);

// Apply a mask to an image
static void apply_mask(video::IImage *mask, video::IImage *dst,
                v2s32 mask_pos, v2s32 dst_pos, v2u32 size);

// Draw or overlay a crack
static void draw_crack(video::IImage *crack, video::IImage *dst,
                bool use_overlay, s32 frame_count, s32 progression,
                video::IVideoDriver *driver, u8 tiles = 1);

// Brighten image
void brighten(video::IImage *image);
// Parse a transform name
u32 parseImageTransform(const std::string& s);
// Apply transform to image dimension
core::dimension2d<u32> imageTransformDimension(u32 transform, core::dimension2d<u32> dim);
// Apply transform to image data
void imageTransform(u32 transform, video::IImage *src, video::IImage *dst);

/*
        This method generates all the textures
*/
u32 TextureSource::generateTexture(const std::string &name)
{
        //infostream << "generateTexture(): name=\"" << name << "\"" << std::endl;

        // Empty name means texture 0
        if (name.empty()) {
                infostream<<"generateTexture(): name is empty"<<std::endl;
                return 0;
        }

        {
                /*
                        See if texture already exists
                */
                MutexAutoLock lock(m_textureinfo_cache_mutex);
                std::map<std::string, u32>::iterator n;
                n = m_name_to_id.find(name);
                if (n != m_name_to_id.end()) {
                        return n->second;
                }
        }

        /*
                Calling only allowed from main thread
        */
        if (std::this_thread::get_id() != m_main_thread) {
                errorstream<<"TextureSource::generateTexture() "
                                "called not from main thread"<<std::endl;
                return 0;
        }

        video::IVideoDriver *driver = RenderingEngine::get_video_driver();
        sanity_check(driver);

        video::IImage *img = generateImage(name);

        video::ITexture *tex = NULL;

        if (img != NULL) {
#if ENABLE_GLES
                img = Align2Npot2(img, driver);
#endif
                // Create texture from resulting image
                tex = driver->addTexture(name.c_str(), img);
                guiScalingCache(io::path(name.c_str()), driver, img);
                img->drop();
        }

        /*
                Add texture to caches (add NULL textures too)
        */

        MutexAutoLock lock(m_textureinfo_cache_mutex);

        u32 id = m_textureinfo_cache.size();
        TextureInfo ti(name, tex);
        m_textureinfo_cache.push_back(ti);
        m_name_to_id[name] = id;

        return id;
}

std::string TextureSource::getTextureName(u32 id)
{
        MutexAutoLock lock(m_textureinfo_cache_mutex);

        if (id >= m_textureinfo_cache.size())
        {
                errorstream<<"TextureSource::getTextureName(): id="<<id
                                <<" >= m_textureinfo_cache.size()="
                                <<m_textureinfo_cache.size()<<std::endl;
                return "";
        }

        return m_textureinfo_cache[id].name;
}

video::ITexture* TextureSource::getTexture(u32 id)
{
        MutexAutoLock lock(m_textureinfo_cache_mutex);

        if (id >= m_textureinfo_cache.size())
                return NULL;

        return m_textureinfo_cache[id].texture;
}

video::ITexture* TextureSource::getTexture(const std::string &name, u32 *id)
{
        u32 actual_id = getTextureId(name);
        if (id){
                *id = actual_id;
        }
        return getTexture(actual_id);
}

video::ITexture* TextureSource::getTextureForMesh(const std::string &name, u32 *id)
{
        static thread_local bool filter_needed =
                g_settings->getBool("texture_clean_transparent") || m_setting_mipmap ||
                ((m_setting_trilinear_filter || m_setting_bilinear_filter) &&
                g_settings->getS32("texture_min_size") > 1);
        // Avoid duplicating texture if it won't actually change
        if (filter_needed)
                return getTexture(name + "^[applyfiltersformesh", id);
        return getTexture(name, id);
}

Palette* TextureSource::getPalette(const std::string &name)
{
        // Only the main thread may load images
        sanity_check(std::this_thread::get_id() == m_main_thread);

        if (name.empty())
                return NULL;

        auto it = m_palettes.find(name);
        if (it == m_palettes.end()) {
                // Create palette
                video::IImage *img = generateImage(name);
                if (!img) {
                        warningstream << "TextureSource::getPalette(): palette \"" << name
                                << "\" could not be loaded." << std::endl;
                        return NULL;
                }
                Palette new_palette;
                u32 w = img->getDimension().Width;
                u32 h = img->getDimension().Height;
                // Real area of the image
                u32 area = h * w;
                if (area == 0)
                        return NULL;
                if (area > 256) {
                        warningstream << "TextureSource::getPalette(): the specified"
                                << " palette image \"" << name << "\" is larger than 256"
                                << " pixels, using the first 256." << std::endl;
                        area = 256;
                } else if (256 % area != 0)
                        warningstream << "TextureSource::getPalette(): the "
                                << "specified palette image \"" << name << "\" does not "
                                << "contain power of two pixels." << std::endl;
                // We stretch the palette so it will fit 256 values
                // This many param2 values will have the same color
                u32 step = 256 / area;
                // For each pixel in the image
                for (u32 i = 0; i < area; i++) {
                        video::SColor c = img->getPixel(i % w, i / w);
                        // Fill in palette with 'step' colors
                        for (u32 j = 0; j < step; j++)
                                new_palette.push_back(c);
                }
                img->drop();
                // Fill in remaining elements
                while (new_palette.size() < 256)
                        new_palette.emplace_back(0xFFFFFFFF);
                m_palettes[name] = new_palette;
                it = m_palettes.find(name);
        }
        if (it != m_palettes.end())
                return &((*it).second);
        return NULL;
}

void TextureSource::processQueue()
{
        /*
                Fetch textures
        */
        //NOTE this is only thread safe for ONE consumer thread!
        if (!m_get_texture_queue.empty())
        {
                GetRequest<std::string, u32, u8, u8>
                                request = m_get_texture_queue.pop();

                /*infostream<<"TextureSource::processQueue(): "
                                <<"got texture request with "
                                <<"name=\""<<request.key<<"\""
                                <<std::endl;*/

                m_get_texture_queue.pushResult(request, generateTexture(request.key));
        }
}

void TextureSource::insertSourceImage(const std::string &name, video::IImage *img)
{
        //infostream<<"TextureSource::insertSourceImage(): name="<<name<<std::endl;

        sanity_check(std::this_thread::get_id() == m_main_thread);

        m_sourcecache.insert(name, img, true);
        m_source_image_existence.set(name, true);
}

void TextureSource::rebuildImagesAndTextures()
{
        MutexAutoLock lock(m_textureinfo_cache_mutex);

        video::IVideoDriver *driver = RenderingEngine::get_video_driver();
        sanity_check(driver);

        infostream << "TextureSource: recreating " << m_textureinfo_cache.size()
                << " textures" << std::endl;

        // Recreate textures
        for (TextureInfo &ti : m_textureinfo_cache) {
                video::IImage *img = generateImage(ti.name);
#if ENABLE_GLES
                img = Align2Npot2(img, driver);
#endif
                // Create texture from resulting image
                video::ITexture *t = NULL;
                if (img) {
                        t = driver->addTexture(ti.name.c_str(), img);
                        guiScalingCache(io::path(ti.name.c_str()), driver, img);
                        img->drop();
                }
                video::ITexture *t_old = ti.texture;
                // Replace texture
                ti.texture = t;

                if (t_old)
                        m_texture_trash.push_back(t_old);
        }
}

inline static void applyShadeFactor(video::SColor &color, u32 factor)
{
        u32 f = core::clamp<u32>(factor, 0, 256);
        color.setRed(color.getRed() * f / 256);
        color.setGreen(color.getGreen() * f / 256);
        color.setBlue(color.getBlue() * f / 256);
}

static video::IImage *createInventoryCubeImage(
        video::IImage *top, video::IImage *left, video::IImage *right)
{
        core::dimension2du size_top = top->getDimension();
        core::dimension2du size_left = left->getDimension();
        core::dimension2du size_right = right->getDimension();

        u32 size = npot2(std::max({
                        size_top.Width, size_top.Height,
                        size_left.Width, size_left.Height,
                        size_right.Width, size_right.Height,
        }));

        // It must be divisible by 4, to let everything work correctly.
        // But it is a power of 2, so being at least 4 is the same.
        // And the resulting texture should't be too large as well.
        size = core::clamp<u32>(size, 4, 64);

        // With such parameters, the cube fits exactly, touching each image line
        // from `0` to `cube_size - 1`. (Note that division is exact here).
        u32 cube_size = 9 * size;
        u32 offset = size / 2;

        video::IVideoDriver *driver = RenderingEngine::get_video_driver();

        auto lock_image = [size, driver] (video::IImage *&image) -> const u32 * {
                image->grab();
                core::dimension2du dim = image->getDimension();
                video::ECOLOR_FORMAT format = image->getColorFormat();
                if (dim.Width != size || dim.Height != size || format != video::ECF_A8R8G8B8) {
                        video::IImage *scaled = driver->createImage(video::ECF_A8R8G8B8, {size, size});
                        image->copyToScaling(scaled);
                        image->drop();
                        image = scaled;
                }
                sanity_check(image->getPitch() == 4 * size);
                return reinterpret_cast<u32 *>(image->getData());
        };
        auto free_image = [] (video::IImage *image) -> void {
                image->drop();
        };

        video::IImage *result = driver->createImage(video::ECF_A8R8G8B8, {cube_size, cube_size});
        sanity_check(result->getPitch() == 4 * cube_size);
        result->fill(video::SColor(0x00000000u));
        u32 *target = reinterpret_cast<u32 *>(result->getData());

        // Draws single cube face
        // `shade_factor` is face brightness, in range [0.0, 1.0]
        // (xu, xv, x1; yu, yv, y1) form coordinate transformation matrix
        // `offsets` list pixels to be drawn for single source pixel
        auto draw_image = [=] (video::IImage *image, float shade_factor,
                        s16 xu, s16 xv, s16 x1,
                        s16 yu, s16 yv, s16 y1,
                        std::initializer_list<v2s16> offsets) -> void {
                u32 brightness = core::clamp<u32>(256 * shade_factor, 0, 256);
                const u32 *source = lock_image(image);
                for (u16 v = 0; v < size; v++) {
                        for (u16 u = 0; u < size; u++) {
                                video::SColor pixel(*source);
                                applyShadeFactor(pixel, brightness);
                                s16 x = xu * u + xv * v + x1;
                                s16 y = yu * u + yv * v + y1;
                                for (const auto &off : offsets)
                                        target[(y + off.Y) * cube_size + (x + off.X) + offset] = pixel.color;
                                source++;
                        }
                }
                free_image(image);
        };

        draw_image(top, 1.000000f,
                        4, -4, 4 * (size - 1),
                        2, 2, 0,
                        {
                                                {2, 0}, {3, 0}, {4, 0}, {5, 0},
                                {0, 1}, {1, 1}, {2, 1}, {3, 1}, {4, 1}, {5, 1}, {6, 1}, {7, 1},
                                                {2, 2}, {3, 2}, {4, 2}, {5, 2},
                        });

        draw_image(left, 0.836660f,
                        4, 0, 0,
                        2, 5, 2 * size,
                        {
                                {0, 0}, {1, 0},
                                {0, 1}, {1, 1}, {2, 1}, {3, 1},
                                {0, 2}, {1, 2}, {2, 2}, {3, 2},
                                {0, 3}, {1, 3}, {2, 3}, {3, 3},
                                {0, 4}, {1, 4}, {2, 4}, {3, 4},
                                                {2, 5}, {3, 5},
                        });

        draw_image(right, 0.670820f,
                        4, 0, 4 * size,
                        -2, 5, 4 * size - 2,
                        {
                                                {2, 0}, {3, 0},
                                {0, 1}, {1, 1}, {2, 1}, {3, 1},
                                {0, 2}, {1, 2}, {2, 2}, {3, 2},
                                {0, 3}, {1, 3}, {2, 3}, {3, 3},
                                {0, 4}, {1, 4}, {2, 4}, {3, 4},
                                {0, 5}, {1, 5},
                        });

        return result;
}

video::IImage* TextureSource::generateImage(const std::string &name)
{
        // Get the base image

        const char separator = '^';
        const char escape = '\\';
        const char paren_open = '(';
        const char paren_close = ')';

        // Find last separator in the name
        s32 last_separator_pos = -1;
        u8 paren_bal = 0;
        for (s32 i = name.size() - 1; i >= 0; i--) {
                if (i > 0 && name[i-1] == escape)
                        continue;
                switch (name[i]) {
                case separator:
                        if (paren_bal == 0) {
                                last_separator_pos = i;
                                i = -1; // break out of loop
                        }
                        break;
                case paren_open:
                        if (paren_bal == 0) {
                                errorstream << "generateImage(): unbalanced parentheses"
                                                << "(extranous '(') while generating texture \""
                                                << name << "\"" << std::endl;
                                return NULL;
                        }
                        paren_bal--;
                        break;
                case paren_close:
                        paren_bal++;
                        break;
                default:
                        break;
                }
        }
        if (paren_bal > 0) {
                errorstream << "generateImage(): unbalanced parentheses"
                                << "(missing matching '(') while generating texture \""
                                << name << "\"" << std::endl;
                return NULL;
        }


        video::IImage *baseimg = NULL;

        /*
                If separator was found, make the base image
                using a recursive call.
        */
        if (last_separator_pos != -1) {
                baseimg = generateImage(name.substr(0, last_separator_pos));
        }

        /*
                Parse out the last part of the name of the image and act
                according to it
        */

        std::string last_part_of_name = name.substr(last_separator_pos + 1);

        /*
                If this name is enclosed in parentheses, generate it
                and blit it onto the base image
        */
        if (last_part_of_name[0] == paren_open
                        && last_part_of_name[last_part_of_name.size() - 1] == paren_close) {
                std::string name2 = last_part_of_name.substr(1,
                                last_part_of_name.size() - 2);
                video::IImage *tmp = generateImage(name2);
                if (!tmp) {
                        errorstream << "generateImage(): "
                                "Failed to generate \"" << name2 << "\""
                                << std::endl;
                        return NULL;
                }
                core::dimension2d<u32> dim = tmp->getDimension();
                if (baseimg) {
                        blit_with_alpha(tmp, baseimg, v2s32(0, 0), v2s32(0, 0), dim);
                        tmp->drop();
                } else {
                        baseimg = tmp;
                }
        } else if (!generateImagePart(last_part_of_name, baseimg)) {
                // Generate image according to part of name
                errorstream << "generateImage(): "
                                "Failed to generate \"" << last_part_of_name << "\""
                                << std::endl;
        }

        // If no resulting image, print a warning
        if (baseimg == NULL) {
                errorstream << "generateImage(): baseimg is NULL (attempted to"
                                " create texture \"" << name << "\")" << std::endl;
        }

        return baseimg;
}

#if ENABLE_GLES

/**
 * Check and align image to npot2 if required by hardware
 * @param image image to check for npot2 alignment
 * @param driver driver to use for image operations
 * @return image or copy of image aligned to npot2
 */
video::IImage *Align2Npot2(video::IImage *image,
                video::IVideoDriver *driver)
{
        if (image == NULL)
                return image;

        if (driver->queryFeature(video::EVDF_TEXTURE_NPOT))
                return image;

        core::dimension2d<u32> dim = image->getDimension();
        unsigned int height = npot2(dim.Height);
        unsigned int width  = npot2(dim.Width);

        if (dim.Height == height && dim.Width == width)
                return image;

        if (dim.Height > height)
                height *= 2;
        if (dim.Width > width)
                width *= 2;

        video::IImage *targetimage =
                        driver->createImage(video::ECF_A8R8G8B8,
                                        core::dimension2d<u32>(width, height));

        if (targetimage != NULL)
                image->copyToScaling(targetimage);
        image->drop();
        return targetimage;
}

#endif

static std::string unescape_string(const std::string &str, const char esc = '\\')
{
        std::string out;
        size_t pos = 0, cpos;
        out.reserve(str.size());
        while (1) {
                cpos = str.find_first_of(esc, pos);
                if (cpos == std::string::npos) {
                        out += str.substr(pos);
                        break;
                }
                out += str.substr(pos, cpos - pos) + str[cpos + 1];
                pos = cpos + 2;
        }
        return out;
}

bool TextureSource::generateImagePart(std::string part_of_name,
                video::IImage *& baseimg)
{
        const char escape = '\\'; // same as in generateImage()
        video::IVideoDriver *driver = RenderingEngine::get_video_driver();
        sanity_check(driver);

        // Stuff starting with [ are special commands
        if (part_of_name.empty() || part_of_name[0] != '[') {
                video::IImage *image = m_sourcecache.getOrLoad(part_of_name);
#if ENABLE_GLES
                image = Align2Npot2(image, driver);
#endif
                if (image == NULL) {
                        if (!part_of_name.empty()) {

                                // Do not create normalmap dummies
                                if (part_of_name.find("_normal.png") != std::string::npos) {
                                        warningstream << "generateImage(): Could not load normal map \""
                                                << part_of_name << "\"" << std::endl;
                                        return true;
                                }

                                errorstream << "generateImage(): Could not load image \""
                                        << part_of_name << "\" while building texture; "
                                        "Creating a dummy image" << std::endl;
                        }

                        // Just create a dummy image
                        //core::dimension2d<u32> dim(2,2);
                        core::dimension2d<u32> dim(1,1);
                        image = driver->createImage(video::ECF_A8R8G8B8, dim);
                        sanity_check(image != NULL);
                        /*image->setPixel(0,0, video::SColor(255,255,0,0));
                        image->setPixel(1,0, video::SColor(255,0,255,0));
                        image->setPixel(0,1, video::SColor(255,0,0,255));
                        image->setPixel(1,1, video::SColor(255,255,0,255));*/
                        image->setPixel(0,0, video::SColor(255,myrand()%256,
                                        myrand()%256,myrand()%256));
                        /*image->setPixel(1,0, video::SColor(255,myrand()%256,
                                        myrand()%256,myrand()%256));
                        image->setPixel(0,1, video::SColor(255,myrand()%256,
                                        myrand()%256,myrand()%256));
                        image->setPixel(1,1, video::SColor(255,myrand()%256,
                                        myrand()%256,myrand()%256));*/
                }

                // If base image is NULL, load as base.
                if (baseimg == NULL)
                {
                        //infostream<<"Setting "<<part_of_name<<" as base"<<std::endl;
                        /*
                                Copy it this way to get an alpha channel.
                                Otherwise images with alpha cannot be blitted on
                                images that don't have alpha in the original file.
                        */
                        core::dimension2d<u32> dim = image->getDimension();
                        baseimg = driver->createImage(video::ECF_A8R8G8B8, dim);
                        image->copyTo(baseimg);
                }
                // Else blit on base.
                else
                {
                        //infostream<<"Blitting "<<part_of_name<<" on base"<<std::endl;
                        // Size of the copied area
                        core::dimension2d<u32> dim = image->getDimension();
                        //core::dimension2d<u32> dim(16,16);
                        // Position to copy the blitted to in the base image
                        core::position2d<s32> pos_to(0,0);
                        // Position to copy the blitted from in the blitted image
                        core::position2d<s32> pos_from(0,0);
                        // Blit
                        /*image->copyToWithAlpha(baseimg, pos_to,
                                        core::rect<s32>(pos_from, dim),
                                        video::SColor(255,255,255,255),
                                        NULL);*/

                        core::dimension2d<u32> dim_dst = baseimg->getDimension();
                        if (dim == dim_dst) {
                                blit_with_alpha(image, baseimg, pos_from, pos_to, dim);
                        } else if (dim.Width * dim.Height < dim_dst.Width * dim_dst.Height) {
                                // Upscale overlying image
                                video::IImage *scaled_image = RenderingEngine::get_video_driver()->
                                        createImage(video::ECF_A8R8G8B8, dim_dst);
                                image->copyToScaling(scaled_image);

                                blit_with_alpha(scaled_image, baseimg, pos_from, pos_to, dim_dst);
                                scaled_image->drop();
                        } else {
                                // Upscale base image
                                video::IImage *scaled_base = RenderingEngine::get_video_driver()->
                                        createImage(video::ECF_A8R8G8B8, dim);
                                baseimg->copyToScaling(scaled_base);
                                baseimg->drop();
                                baseimg = scaled_base;

                                blit_with_alpha(image, baseimg, pos_from, pos_to, dim);
                        }
                }
                //cleanup
                image->drop();
        }
        else
        {
                // A special texture modification

                /*infostream<<"generateImage(): generating special "
                                <<"modification \""<<part_of_name<<"\""
                                <<std::endl;*/

                /*
                        [crack:N:P
                        [cracko:N:P
                        Adds a cracking texture
                        N = animation frame count, P = crack progression
                */
                if (str_starts_with(part_of_name, "[crack"))
                {
                        if (baseimg == NULL) {
                                errorstream<<"generateImagePart(): baseimg == NULL "
                                                <<"for part_of_name=\""<<part_of_name
                                                <<"\", cancelling."<<std::endl;
                                return false;
                        }

                        // Crack image number and overlay option
                        // Format: crack[o][:<tiles>]:<frame_count>:<frame>
                        bool use_overlay = (part_of_name[6] == 'o');
                        Strfnd sf(part_of_name);
                        sf.next(":");
                        s32 frame_count = stoi(sf.next(":"));
                        s32 progression = stoi(sf.next(":"));
                        s32 tiles = 1;
                        // Check whether there is the <tiles> argument, that is,
                        // whether there are 3 arguments. If so, shift values
                        // as the first and not the last argument is optional.
                        auto s = sf.next(":");
                        if (!s.empty()) {
                                tiles = frame_count;
                                frame_count = progression;
                                progression = stoi(s);
                        }

                        if (progression >= 0) {
                                /*
                                        Load crack image.

                                        It is an image with a number of cracking stages
                                        horizontally tiled.
                                */
                                video::IImage *img_crack = m_sourcecache.getOrLoad(
                                        "crack_anylength.png");

                                if (img_crack) {
                                        draw_crack(img_crack, baseimg,
                                                use_overlay, frame_count,
                                                progression, driver, tiles);
                                        img_crack->drop();
                                }
                        }
                }
                /*
                        [combine:WxH:X,Y=filename:X,Y=filename2
                        Creates a bigger texture from any amount of smaller ones
                */
                else if (str_starts_with(part_of_name, "[combine"))
                {
                        Strfnd sf(part_of_name);
                        sf.next(":");
                        u32 w0 = stoi(sf.next("x"));
                        u32 h0 = stoi(sf.next(":"));
                        core::dimension2d<u32> dim(w0,h0);
                        if (baseimg == NULL) {
                                baseimg = driver->createImage(video::ECF_A8R8G8B8, dim);
                                baseimg->fill(video::SColor(0,0,0,0));
                        }
                        while (!sf.at_end()) {
                                u32 x = stoi(sf.next(","));
                                u32 y = stoi(sf.next("="));
                                std::string filename = unescape_string(sf.next_esc(":", escape), escape);
                                infostream<<"Adding \""<<filename
                                                <<"\" to combined ("<<x<<","<<y<<")"
                                                <<std::endl;
                                video::IImage *img = generateImage(filename);
                                if (img) {
                                        core::dimension2d<u32> dim = img->getDimension();
                                        core::position2d<s32> pos_base(x, y);
                                        video::IImage *img2 =
                                                        driver->createImage(video::ECF_A8R8G8B8, dim);
                                        img->copyTo(img2);
                                        img->drop();
                                        /*img2->copyToWithAlpha(baseimg, pos_base,
                                                        core::rect<s32>(v2s32(0,0), dim),
                                                        video::SColor(255,255,255,255),
                                                        NULL);*/
                                        blit_with_alpha(img2, baseimg, v2s32(0,0), pos_base, dim);
                                        img2->drop();
                                } else {
                                        errorstream << "generateImagePart(): Failed to load image \""
                                                << filename << "\" for [combine" << std::endl;
                                }
                        }
                }
                /*
                        [brighten
                */
                else if (str_starts_with(part_of_name, "[brighten"))
                {
                        if (baseimg == NULL) {
                                errorstream<<"generateImagePart(): baseimg==NULL "
                                                <<"for part_of_name=\""<<part_of_name
                                                <<"\", cancelling."<<std::endl;
                                return false;
                        }

                        brighten(baseimg);
                }
                /*
                        [noalpha
                        Make image completely opaque.
                        Used for the leaves texture when in old leaves mode, so
                        that the transparent parts don't look completely black
                        when simple alpha channel is used for rendering.
                */
                else if (str_starts_with(part_of_name, "[noalpha"))
                {
                        if (baseimg == NULL){
                                errorstream<<"generateImagePart(): baseimg==NULL "
                                                <<"for part_of_name=\""<<part_of_name
                                                <<"\", cancelling."<<std::endl;
                                return false;
                        }

                        core::dimension2d<u32> dim = baseimg->getDimension();

                        // Set alpha to full
                        for (u32 y=0; y<dim.Height; y++)
                        for (u32 x=0; x<dim.Width; x++)
                        {
                                video::SColor c = baseimg->getPixel(x,y);
                                c.setAlpha(255);
                                baseimg->setPixel(x,y,c);
                        }
                }
                /*
                        [makealpha:R,G,B
                        Convert one color to transparent.
                */
                else if (str_starts_with(part_of_name, "[makealpha:"))
                {
                        if (baseimg == NULL) {
                                errorstream<<"generateImagePart(): baseimg == NULL "
                                                <<"for part_of_name=\""<<part_of_name
                                                <<"\", cancelling."<<std::endl;
                                return false;
                        }

                        Strfnd sf(part_of_name.substr(11));
                        u32 r1 = stoi(sf.next(","));
                        u32 g1 = stoi(sf.next(","));
                        u32 b1 = stoi(sf.next(""));

                        core::dimension2d<u32> dim = baseimg->getDimension();

                        /*video::IImage *oldbaseimg = baseimg;
                        baseimg = driver->createImage(video::ECF_A8R8G8B8, dim);
                        oldbaseimg->copyTo(baseimg);
                        oldbaseimg->drop();*/

                        // Set alpha to full
                        for (u32 y=0; y<dim.Height; y++)
                        for (u32 x=0; x<dim.Width; x++)
                        {
                                video::SColor c = baseimg->getPixel(x,y);
                                u32 r = c.getRed();
                                u32 g = c.getGreen();
                                u32 b = c.getBlue();
                                if (!(r == r1 && g == g1 && b == b1))
                                        continue;
                                c.setAlpha(0);
                                baseimg->setPixel(x,y,c);
                        }
                }
                /*
                        [transformN
                        Rotates and/or flips the image.

                        N can be a number (between 0 and 7) or a transform name.
                        Rotations are counter-clockwise.
                        0  I      identity
                        1  R90    rotate by 90 degrees
                        2  R180   rotate by 180 degrees
                        3  R270   rotate by 270 degrees
                        4  FX     flip X
                        5  FXR90  flip X then rotate by 90 degrees
                        6  FY     flip Y
                        7  FYR90  flip Y then rotate by 90 degrees

                        Note: Transform names can be concatenated to produce
                        their product (applies the first then the second).
                        The resulting transform will be equivalent to one of the
                        eight existing ones, though (see: dihedral group).
                */
                else if (str_starts_with(part_of_name, "[transform"))
                {
                        if (baseimg == NULL) {
                                errorstream<<"generateImagePart(): baseimg == NULL "
                                                <<"for part_of_name=\""<<part_of_name
                                                <<"\", cancelling."<<std::endl;
                                return false;
                        }

                        u32 transform = parseImageTransform(part_of_name.substr(10));
                        core::dimension2d<u32> dim = imageTransformDimension(
                                        transform, baseimg->getDimension());
                        video::IImage *image = driver->createImage(
                                        baseimg->getColorFormat(), dim);
                        sanity_check(image != NULL);
                        imageTransform(transform, baseimg, image);
                        baseimg->drop();
                        baseimg = image;
                }
                /*
                        [inventorycube{topimage{leftimage{rightimage
                        In every subimage, replace ^ with &.
                        Create an "inventory cube".
                        NOTE: This should be used only on its own.
                        Example (a grass block (not actually used in game):
                        "[inventorycube{grass.png{mud.png&grass_side.png{mud.png&grass_side.png"
                */
                else if (str_starts_with(part_of_name, "[inventorycube"))
                {
                        if (baseimg != NULL){
                                errorstream<<"generateImagePart(): baseimg != NULL "
                                                <<"for part_of_name=\""<<part_of_name
                                                <<"\", cancelling."<<std::endl;
                                return false;
                        }

                        str_replace(part_of_name, '&', '^');
                        Strfnd sf(part_of_name);
                        sf.next("{");
                        std::string imagename_top = sf.next("{");
                        std::string imagename_left = sf.next("{");
                        std::string imagename_right = sf.next("{");

                        // Generate images for the faces of the cube
                        video::IImage *img_top = generateImage(imagename_top);
                        video::IImage *img_left = generateImage(imagename_left);
                        video::IImage *img_right = generateImage(imagename_right);

                        if (img_top == NULL || img_left == NULL || img_right == NULL) {
                                errorstream << "generateImagePart(): Failed to create textures"
                                                << " for inventorycube \"" << part_of_name << "\""
                                                << std::endl;
                                baseimg = generateImage(imagename_top);
                                return true;
                        }

                        baseimg = createInventoryCubeImage(img_top, img_left, img_right);

                        // Face images are not needed anymore
                        img_top->drop();
                        img_left->drop();
                        img_right->drop();

                        return true;
                }
                /*
                        [lowpart:percent:filename
                        Adds the lower part of a texture
                */
                else if (str_starts_with(part_of_name, "[lowpart:"))
                {
                        Strfnd sf(part_of_name);
                        sf.next(":");
                        u32 percent = stoi(sf.next(":"));
                        std::string filename = unescape_string(sf.next_esc(":", escape), escape);

                        if (baseimg == NULL)
                                baseimg = driver->createImage(video::ECF_A8R8G8B8, v2u32(16,16));
                        video::IImage *img = generateImage(filename);
                        if (img)
                        {
                                core::dimension2d<u32> dim = img->getDimension();
                                core::position2d<s32> pos_base(0, 0);
                                video::IImage *img2 =
                                                driver->createImage(video::ECF_A8R8G8B8, dim);
                                img->copyTo(img2);
                                img->drop();
                                core::position2d<s32> clippos(0, 0);
                                clippos.Y = dim.Height * (100-percent) / 100;
                                core::dimension2d<u32> clipdim = dim;
                                clipdim.Height = clipdim.Height * percent / 100 + 1;
                                core::rect<s32> cliprect(clippos, clipdim);
                                img2->copyToWithAlpha(baseimg, pos_base,
                                                core::rect<s32>(v2s32(0,0), dim),
                                                video::SColor(255,255,255,255),
                                                &cliprect);
                                img2->drop();
                        }
                }
                /*
                        [verticalframe:N:I
                        Crops a frame of a vertical animation.
                        N = frame count, I = frame index
                */
                else if (str_starts_with(part_of_name, "[verticalframe:"))
                {
                        Strfnd sf(part_of_name);
                        sf.next(":");
                        u32 frame_count = stoi(sf.next(":"));
                        u32 frame_index = stoi(sf.next(":"));

                        if (baseimg == NULL){
                                errorstream<<"generateImagePart(): baseimg != NULL "
                                                <<"for part_of_name=\""<<part_of_name
                                                <<"\", cancelling."<<std::endl;
                                return false;
                        }

                        v2u32 frame_size = baseimg->getDimension();
                        frame_size.Y /= frame_count;

                        video::IImage *img = driver->createImage(video::ECF_A8R8G8B8,
                                        frame_size);
                        if (!img){
                                errorstream<<"generateImagePart(): Could not create image "
                                                <<"for part_of_name=\""<<part_of_name
                                                <<"\", cancelling."<<std::endl;
                                return false;
                        }

                        // Fill target image with transparency
                        img->fill(video::SColor(0,0,0,0));

                        core::dimension2d<u32> dim = frame_size;
                        core::position2d<s32> pos_dst(0, 0);
                        core::position2d<s32> pos_src(0, frame_index * frame_size.Y);
                        baseimg->copyToWithAlpha(img, pos_dst,
                                        core::rect<s32>(pos_src, dim),
                                        video::SColor(255,255,255,255),
                                        NULL);
                        // Replace baseimg
                        baseimg->drop();
                        baseimg = img;
                }
                /*
                        [mask:filename
                        Applies a mask to an image
                */
                else if (str_starts_with(part_of_name, "[mask:"))
                {
                        if (baseimg == NULL) {
                                errorstream << "generateImage(): baseimg == NULL "
                                                << "for part_of_name=\"" << part_of_name
                                                << "\", cancelling." << std::endl;
                                return false;
                        }
                        Strfnd sf(part_of_name);
                        sf.next(":");
                        std::string filename = unescape_string(sf.next_esc(":", escape), escape);

                        video::IImage *img = generateImage(filename);
                        if (img) {
                                apply_mask(img, baseimg, v2s32(0, 0), v2s32(0, 0),
                                                img->getDimension());
                                img->drop();
                        } else {
                                errorstream << "generateImage(): Failed to load \""
                                                << filename << "\".";
                        }
                }
                /*
                [multiply:color
                        multiplys a given color to any pixel of an image
                        color = color as ColorString
                */
                else if (str_starts_with(part_of_name, "[multiply:")) {
                        Strfnd sf(part_of_name);
                        sf.next(":");
                        std::string color_str = sf.next(":");

                        if (baseimg == NULL) {
                                errorstream << "generateImagePart(): baseimg != NULL "
                                                << "for part_of_name=\"" << part_of_name
                                                << "\", cancelling." << std::endl;
                                return false;
                        }

                        video::SColor color;

                        if (!parseColorString(color_str, color, false))
                                return false;

                        apply_multiplication(baseimg, v2u32(0, 0), baseimg->getDimension(), color);
                }
                /*
                        [colorize:color
                        Overlays image with given color
                        color = color as ColorString
                */
                else if (str_starts_with(part_of_name, "[colorize:"))
                {
                        Strfnd sf(part_of_name);
                        sf.next(":");
                        std::string color_str = sf.next(":");
                        std::string ratio_str = sf.next(":");

                        if (baseimg == NULL) {
                                errorstream << "generateImagePart(): baseimg != NULL "
                                                << "for part_of_name=\"" << part_of_name
                                                << "\", cancelling." << std::endl;
                                return false;
                        }

                        video::SColor color;
                        int ratio = -1;
                        bool keep_alpha = false;

                        if (!parseColorString(color_str, color, false))
                                return false;

                        if (is_number(ratio_str))
                                ratio = mystoi(ratio_str, 0, 255);
                        else if (ratio_str == "alpha")
                                keep_alpha = true;

                        apply_colorize(baseimg, v2u32(0, 0), baseimg->getDimension(), color, ratio, keep_alpha);
                }
                /*
                        [applyfiltersformesh
                        Internal modifier
                */
                else if (str_starts_with(part_of_name, "[applyfiltersformesh"))
                {
                        /* IMPORTANT: When changing this, getTextureForMesh() needs to be
                         * updated too. */

                        if (!baseimg) {
                                errorstream << "generateImagePart(): baseimg == NULL "
                                                << "for part_of_name=\"" << part_of_name
                                                << "\", cancelling." << std::endl;
                                return false;
                        }

                        // Apply the "clean transparent" filter, if needed
                        if (m_setting_mipmap || g_settings->getBool("texture_clean_transparent"))
                                imageCleanTransparent(baseimg, 127);

                        /* Upscale textures to user's requested minimum size.  This is a trick to make
                         * filters look as good on low-res textures as on high-res ones, by making
                         * low-res textures BECOME high-res ones.  This is helpful for worlds that
                         * mix high- and low-res textures, or for mods with least-common-denominator
                         * textures that don't have the resources to offer high-res alternatives.
                         */
                        const bool filter = m_setting_trilinear_filter || m_setting_bilinear_filter;
                        const s32 scaleto = filter ? g_settings->getS32("texture_min_size") : 1;
                        if (scaleto > 1) {
                                const core::dimension2d<u32> dim = baseimg->getDimension();

                                /* Calculate scaling needed to make the shortest texture dimension
                                 * equal to the target minimum.  If e.g. this is a vertical frames
                                 * animation, the short dimension will be the real size.
                                 */
                                if ((dim.Width == 0) || (dim.Height == 0)) {
                                        errorstream << "generateImagePart(): Illegal 0 dimension "
                                                << "for part_of_name=\""<< part_of_name
                                                << "\", cancelling." << std::endl;
                                        return false;
                                }
                                u32 xscale = scaleto / dim.Width;
                                u32 yscale = scaleto / dim.Height;
                                u32 scale = (xscale > yscale) ? xscale : yscale;

                                // Never downscale; only scale up by 2x or more.
                                if (scale > 1) {
                                        u32 w = scale * dim.Width;
                                        u32 h = scale * dim.Height;
                                        const core::dimension2d<u32> newdim = core::dimension2d<u32>(w, h);
                                        video::IImage *newimg = driver->createImage(
                                                        baseimg->getColorFormat(), newdim);
                                        baseimg->copyToScaling(newimg);
                                        baseimg->drop();
                                        baseimg = newimg;
                                }
                        }
                }
                /*
                        [resize:WxH
                        Resizes the base image to the given dimensions
                */
                else if (str_starts_with(part_of_name, "[resize"))
                {
                        if (baseimg == NULL) {
                                errorstream << "generateImagePart(): baseimg == NULL "
                                                << "for part_of_name=\""<< part_of_name
                                                << "\", cancelling." << std::endl;
                                return false;
                        }

                        Strfnd sf(part_of_name);
                        sf.next(":");
                        u32 width = stoi(sf.next("x"));
                        u32 height = stoi(sf.next(""));
                        core::dimension2d<u32> dim(width, height);

                        video::IImage *image = RenderingEngine::get_video_driver()->
                                createImage(video::ECF_A8R8G8B8, dim);
                        baseimg->copyToScaling(image);
                        baseimg->drop();
                        baseimg = image;
                }
                /*
                        [opacity:R
                        Makes the base image transparent according to the given ratio.
                        R must be between 0 and 255.
                        0 means totally transparent.
                        255 means totally opaque.
                */
                else if (str_starts_with(part_of_name, "[opacity:")) {
                        if (baseimg == NULL) {
                                errorstream << "generateImagePart(): baseimg == NULL "
                                                << "for part_of_name=\"" << part_of_name
                                                << "\", cancelling." << std::endl;
                                return false;
                        }

                        Strfnd sf(part_of_name);
                        sf.next(":");

                        u32 ratio = mystoi(sf.next(""), 0, 255);

                        core::dimension2d<u32> dim = baseimg->getDimension();

                        for (u32 y = 0; y < dim.Height; y++)
                        for (u32 x = 0; x < dim.Width; x++)
                        {
                                video::SColor c = baseimg->getPixel(x, y);
                                c.setAlpha(floor((c.getAlpha() * ratio) / 255 + 0.5));
                                baseimg->setPixel(x, y, c);
                        }
                }
                /*
                        [invert:mode
                        Inverts the given channels of the base image.
                        Mode may contain the characters "r", "g", "b", "a".
                        Only the channels that are mentioned in the mode string
                        will be inverted.
                */
                else if (str_starts_with(part_of_name, "[invert:")) {
                        if (baseimg == NULL) {
                                errorstream << "generateImagePart(): baseimg == NULL "
                                                << "for part_of_name=\"" << part_of_name
                                                << "\", cancelling." << std::endl;
                                return false;
                        }

                        Strfnd sf(part_of_name);
                        sf.next(":");

                        std::string mode = sf.next("");
                        u32 mask = 0;
                        if (mode.find('a') != std::string::npos)
                                mask |= 0xff000000UL;
                        if (mode.find('r') != std::string::npos)
                                mask |= 0x00ff0000UL;
                        if (mode.find('g') != std::string::npos)
                                mask |= 0x0000ff00UL;
                        if (mode.find('b') != std::string::npos)
                                mask |= 0x000000ffUL;

                        core::dimension2d<u32> dim = baseimg->getDimension();

                        for (u32 y = 0; y < dim.Height; y++)
                        for (u32 x = 0; x < dim.Width; x++)
                        {
                                video::SColor c = baseimg->getPixel(x, y);
                                c.color ^= mask;
                                baseimg->setPixel(x, y, c);
                        }
                }
                /*
                        [sheet:WxH:X,Y
                        Retrieves a tile at position X,Y (in tiles)
                        from the base image it assumes to be a
                        tilesheet with dimensions W,H (in tiles).
                */
                else if (part_of_name.substr(0,7) == "[sheet:") {
                        if (baseimg == NULL) {
                                errorstream << "generateImagePart(): baseimg != NULL "
                                                << "for part_of_name=\"" << part_of_name
                                                << "\", cancelling." << std::endl;
                                return false;
                        }

                        Strfnd sf(part_of_name);
                        sf.next(":");
                        u32 w0 = stoi(sf.next("x"));
                        u32 h0 = stoi(sf.next(":"));
                        u32 x0 = stoi(sf.next(","));
                        u32 y0 = stoi(sf.next(":"));

                        core::dimension2d<u32> img_dim = baseimg->getDimension();
                        core::dimension2d<u32> tile_dim(v2u32(img_dim) / v2u32(w0, h0));

                        video::IImage *img = driver->createImage(
                                        video::ECF_A8R8G8B8, tile_dim);
                        if (!img) {
                                errorstream << "generateImagePart(): Could not create image "
                                                << "for part_of_name=\"" << part_of_name
                                                << "\", cancelling." << std::endl;
                                return false;
                        }

                        img->fill(video::SColor(0,0,0,0));
                        v2u32 vdim(tile_dim);
                        core::rect<s32> rect(v2s32(x0 * vdim.X, y0 * vdim.Y), tile_dim);
                        baseimg->copyToWithAlpha(img, v2s32(0), rect,
                                        video::SColor(255,255,255,255), NULL);

                        // Replace baseimg
                        baseimg->drop();
                        baseimg = img;
                }
                else
                {
                        errorstream << "generateImagePart(): Invalid "
                                        " modification: \"" << part_of_name << "\"" << std::endl;
                }
        }

        return true;
}

/*
        Calculate the color of a single pixel drawn on top of another pixel.

        This is a little more complicated than just video::SColor::getInterpolated
        because getInterpolated does not handle alpha correctly.  For example, a
        pixel with alpha=64 drawn atop a pixel with alpha=128 should yield a
        pixel with alpha=160, while getInterpolated would yield alpha=96.
*/
static inline video::SColor blitPixel(const video::SColor &src_c, const video::SColor &dst_c, u32 ratio)
{
        if (dst_c.getAlpha() == 0)
                return src_c;
        video::SColor out_c = src_c.getInterpolated(dst_c, (float)ratio / 255.0f);
        out_c.setAlpha(dst_c.getAlpha() + (255 - dst_c.getAlpha()) *
                src_c.getAlpha() * ratio / (255 * 255));
        return out_c;
}

/*
        Draw an image on top of an another one, using the alpha channel of the
        source image

        This exists because IImage::copyToWithAlpha() doesn't seem to always
        work.
*/
static void blit_with_alpha(video::IImage *src, video::IImage *dst,
                v2s32 src_pos, v2s32 dst_pos, v2u32 size)
{
        for (u32 y0=0; y0<size.Y; y0++)
        for (u32 x0=0; x0<size.X; x0++)
        {
                s32 src_x = src_pos.X + x0;
                s32 src_y = src_pos.Y + y0;
                s32 dst_x = dst_pos.X + x0;
                s32 dst_y = dst_pos.Y + y0;
                video::SColor src_c = src->getPixel(src_x, src_y);
                video::SColor dst_c = dst->getPixel(dst_x, dst_y);
                dst_c = blitPixel(src_c, dst_c, src_c.getAlpha());
                dst->setPixel(dst_x, dst_y, dst_c);
        }
}

/*
        Draw an image on top of an another one, using the alpha channel of the
        source image; only modify fully opaque pixels in destinaion
*/
static void blit_with_alpha_overlay(video::IImage *src, video::IImage *dst,
                v2s32 src_pos, v2s32 dst_pos, v2u32 size)
{
        for (u32 y0=0; y0<size.Y; y0++)
        for (u32 x0=0; x0<size.X; x0++)
        {
                s32 src_x = src_pos.X + x0;
                s32 src_y = src_pos.Y + y0;
                s32 dst_x = dst_pos.X + x0;
                s32 dst_y = dst_pos.Y + y0;
                video::SColor src_c = src->getPixel(src_x, src_y);
                video::SColor dst_c = dst->getPixel(dst_x, dst_y);
                if (dst_c.getAlpha() == 255 && src_c.getAlpha() != 0)
                {
                        dst_c = blitPixel(src_c, dst_c, src_c.getAlpha());
                        dst->setPixel(dst_x, dst_y, dst_c);
                }
        }
}

// This function has been disabled because it is currently unused.
// Feel free to re-enable if you find it handy.
#if 0
/*
        Draw an image on top of an another one, using the specified ratio
        modify all partially-opaque pixels in the destination.
*/
static void blit_with_interpolate_overlay(video::IImage *src, video::IImage *dst,
                v2s32 src_pos, v2s32 dst_pos, v2u32 size, int ratio)
{
        for (u32 y0 = 0; y0 < size.Y; y0++)
        for (u32 x0 = 0; x0 < size.X; x0++)
        {
                s32 src_x = src_pos.X + x0;
                s32 src_y = src_pos.Y + y0;
                s32 dst_x = dst_pos.X + x0;
                s32 dst_y = dst_pos.Y + y0;
                video::SColor src_c = src->getPixel(src_x, src_y);
                video::SColor dst_c = dst->getPixel(dst_x, dst_y);
                if (dst_c.getAlpha() > 0 && src_c.getAlpha() != 0)
                {
                        if (ratio == -1)
                                dst_c = src_c.getInterpolated(dst_c, (float)src_c.getAlpha()/255.0f);
                        else
                                dst_c = src_c.getInterpolated(dst_c, (float)ratio/255.0f);
                        dst->setPixel(dst_x, dst_y, dst_c);
                }
        }
}
#endif

/*
        Apply color to destination
*/
static void apply_colorize(video::IImage *dst, v2u32 dst_pos, v2u32 size,
                const video::SColor &color, int ratio, bool keep_alpha)
{
        u32 alpha = color.getAlpha();
        video::SColor dst_c;
        if ((ratio == -1 && alpha == 255) || ratio == 255) { // full replacement of color
                if (keep_alpha) { // replace the color with alpha = dest alpha * color alpha
                        dst_c = color;
                        for (u32 y = dst_pos.Y; y < dst_pos.Y + size.Y; y++)
                        for (u32 x = dst_pos.X; x < dst_pos.X + size.X; x++) {
                                u32 dst_alpha = dst->getPixel(x, y).getAlpha();
                                if (dst_alpha > 0) {
                                        dst_c.setAlpha(dst_alpha * alpha / 255);
                                        dst->setPixel(x, y, dst_c);
                                }
                        }
                } else { // replace the color including the alpha
                        for (u32 y = dst_pos.Y; y < dst_pos.Y + size.Y; y++)
                        for (u32 x = dst_pos.X; x < dst_pos.X + size.X; x++)
                                if (dst->getPixel(x, y).getAlpha() > 0)
                                        dst->setPixel(x, y, color);
                }
        } else {  // interpolate between the color and destination
                float interp = (ratio == -1 ? color.getAlpha() / 255.0f : ratio / 255.0f);
                for (u32 y = dst_pos.Y; y < dst_pos.Y + size.Y; y++)
                for (u32 x = dst_pos.X; x < dst_pos.X + size.X; x++) {
                        dst_c = dst->getPixel(x, y);
                        if (dst_c.getAlpha() > 0) {
                                dst_c = color.getInterpolated(dst_c, interp);
                                dst->setPixel(x, y, dst_c);
                        }
                }
        }
}

/*
        Apply color to destination
*/
static void apply_multiplication(video::IImage *dst, v2u32 dst_pos, v2u32 size,
                const video::SColor &color)
{
        video::SColor dst_c;

        for (u32 y = dst_pos.Y; y < dst_pos.Y + size.Y; y++)
        for (u32 x = dst_pos.X; x < dst_pos.X + size.X; x++) {
                dst_c = dst->getPixel(x, y);
                dst_c.set(
                                dst_c.getAlpha(),
                                (dst_c.getRed() * color.getRed()) / 255,
                                (dst_c.getGreen() * color.getGreen()) / 255,
                                (dst_c.getBlue() * color.getBlue()) / 255
                                );
                dst->setPixel(x, y, dst_c);
        }
}

/*
        Apply mask to destination
*/
static void apply_mask(video::IImage *mask, video::IImage *dst,
                v2s32 mask_pos, v2s32 dst_pos, v2u32 size)
{
        for (u32 y0 = 0; y0 < size.Y; y0++) {
                for (u32 x0 = 0; x0 < size.X; x0++) {
                        s32 mask_x = x0 + mask_pos.X;
                        s32 mask_y = y0 + mask_pos.Y;
                        s32 dst_x = x0 + dst_pos.X;
                        s32 dst_y = y0 + dst_pos.Y;
                        video::SColor mask_c = mask->getPixel(mask_x, mask_y);
                        video::SColor dst_c = dst->getPixel(dst_x, dst_y);
                        dst_c.color &= mask_c.color;
                        dst->setPixel(dst_x, dst_y, dst_c);
                }
        }
}

video::IImage *create_crack_image(video::IImage *crack, s32 frame_index,
                core::dimension2d<u32> size, u8 tiles, video::IVideoDriver *driver)
{
        core::dimension2d<u32> strip_size = crack->getDimension();
        core::dimension2d<u32> frame_size(strip_size.Width, strip_size.Width);
        core::dimension2d<u32> tile_size(size / tiles);
        s32 frame_count = strip_size.Height / strip_size.Width;
        if (frame_index >= frame_count)
                frame_index = frame_count - 1;
        core::rect<s32> frame(v2s32(0, frame_index * frame_size.Height), frame_size);
        video::IImage *result = nullptr;

// extract crack frame
        video::IImage *crack_tile = driver->createImage(video::ECF_A8R8G8B8, tile_size);
        if (!crack_tile)
                return nullptr;
        if (tile_size == frame_size) {
                crack->copyTo(crack_tile, v2s32(0, 0), frame);
        } else {
                video::IImage *crack_frame = driver->createImage(video::ECF_A8R8G8B8, frame_size);
                if (!crack_frame)
                        goto exit__has_tile;
                crack->copyTo(crack_frame, v2s32(0, 0), frame);
                crack_frame->copyToScaling(crack_tile);
                crack_frame->drop();
        }
        if (tiles == 1)
                return crack_tile;

// tile it
        result = driver->createImage(video::ECF_A8R8G8B8, size);
        if (!result)
                goto exit__has_tile;
        result->fill({});
        for (u8 i = 0; i < tiles; i++)
                for (u8 j = 0; j < tiles; j++)
                        crack_tile->copyTo(result, v2s32(i * tile_size.Width, j * tile_size.Height));

exit__has_tile:
        crack_tile->drop();
        return result;
}

static void draw_crack(video::IImage *crack, video::IImage *dst,
                bool use_overlay, s32 frame_count, s32 progression,
                video::IVideoDriver *driver, u8 tiles)
{
        // Dimension of destination image
        core::dimension2d<u32> dim_dst = dst->getDimension();
        // Limit frame_count
        if (frame_count > (s32) dim_dst.Height)
                frame_count = dim_dst.Height;
        if (frame_count < 1)
                frame_count = 1;
        // Dimension of the scaled crack stage,
        // which is the same as the dimension of a single destination frame
        core::dimension2d<u32> frame_size(
                dim_dst.Width,
                dim_dst.Height / frame_count
        );
        video::IImage *crack_scaled = create_crack_image(crack, progression,
                        frame_size, tiles, driver);
        if (!crack_scaled)
                return;

        auto blit = use_overlay ? blit_with_alpha_overlay : blit_with_alpha;
        for (s32 i = 0; i < frame_count; ++i) {
                v2s32 dst_pos(0, frame_size.Height * i);
                blit(crack_scaled, dst, v2s32(0,0), dst_pos, frame_size);
        }

        crack_scaled->drop();
}

void brighten(video::IImage *image)
{
        if (image == NULL)
                return;

        core::dimension2d<u32> dim = image->getDimension();

        for (u32 y=0; y<dim.Height; y++)
        for (u32 x=0; x<dim.Width; x++)
        {
                video::SColor c = image->getPixel(x,y);
                c.setRed(0.5 * 255 + 0.5 * (float)c.getRed());
                c.setGreen(0.5 * 255 + 0.5 * (float)c.getGreen());
                c.setBlue(0.5 * 255 + 0.5 * (float)c.getBlue());
                image->setPixel(x,y,c);
        }
}

u32 parseImageTransform(const std::string& s)
{
        int total_transform = 0;

        std::string transform_names[8];
        transform_names[0] = "i";
        transform_names[1] = "r90";
        transform_names[2] = "r180";
        transform_names[3] = "r270";
        transform_names[4] = "fx";
        transform_names[6] = "fy";

        std::size_t pos = 0;
        while(pos < s.size())
        {
                int transform = -1;
                for (int i = 0; i <= 7; ++i)
                {
                        const std::string &name_i = transform_names[i];

                        if (s[pos] == ('0' + i))
                        {
                                transform = i;
                                pos++;
                                break;
                        }

                        if (!(name_i.empty()) && lowercase(s.substr(pos, name_i.size())) == name_i) {
                                transform = i;
                                pos += name_i.size();
                                break;
                        }
                }
                if (transform < 0)
                        break;

                // Multiply total_transform and transform in the group D4
                int new_total = 0;
                if (transform < 4)
                        new_total = (transform + total_transform) % 4;
                else
                        new_total = (transform - total_transform + 8) % 4;
                if ((transform >= 4) ^ (total_transform >= 4))
                        new_total += 4;

                total_transform = new_total;
        }
        return total_transform;
}

core::dimension2d<u32> imageTransformDimension(u32 transform, core::dimension2d<u32> dim)
{
        if (transform % 2 == 0)
                return dim;

        return core::dimension2d<u32>(dim.Height, dim.Width);
}

void imageTransform(u32 transform, video::IImage *src, video::IImage *dst)
{
        if (src == NULL || dst == NULL)
                return;

        core::dimension2d<u32> dstdim = dst->getDimension();

        // Pre-conditions
        assert(dstdim == imageTransformDimension(transform, src->getDimension()));
        assert(transform <= 7);

        /*
                Compute the transformation from source coordinates (sx,sy)
                to destination coordinates (dx,dy).
        */
        int sxn = 0;
        int syn = 2;
        if (transform == 0)         // identity
                sxn = 0, syn = 2;  //   sx = dx, sy = dy
        else if (transform == 1)    // rotate by 90 degrees ccw
                sxn = 3, syn = 0;  //   sx = (H-1) - dy, sy = dx
        else if (transform == 2)    // rotate by 180 degrees
                sxn = 1, syn = 3;  //   sx = (W-1) - dx, sy = (H-1) - dy
        else if (transform == 3)    // rotate by 270 degrees ccw
                sxn = 2, syn = 1;  //   sx = dy, sy = (W-1) - dx
        else if (transform == 4)    // flip x
                sxn = 1, syn = 2;  //   sx = (W-1) - dx, sy = dy
        else if (transform == 5)    // flip x then rotate by 90 degrees ccw
                sxn = 2, syn = 0;  //   sx = dy, sy = dx
        else if (transform == 6)    // flip y
                sxn = 0, syn = 3;  //   sx = dx, sy = (H-1) - dy
        else if (transform == 7)    // flip y then rotate by 90 degrees ccw
                sxn = 3, syn = 1;  //   sx = (H-1) - dy, sy = (W-1) - dx

        for (u32 dy=0; dy<dstdim.Height; dy++)
        for (u32 dx=0; dx<dstdim.Width; dx++)
        {
                u32 entries[4] = {dx, dstdim.Width-1-dx, dy, dstdim.Height-1-dy};
                u32 sx = entries[sxn];
                u32 sy = entries[syn];
                video::SColor c = src->getPixel(sx,sy);
                dst->setPixel(dx,dy,c);
        }
}

video::ITexture* TextureSource::getNormalTexture(const std::string &name)
{
        if (isKnownSourceImage("override_normal.png"))
                return getTexture("override_normal.png");
        std::string fname_base = name;
        static const char *normal_ext = "_normal.png";
        static const u32 normal_ext_size = strlen(normal_ext);
        size_t pos = fname_base.find('.');
        std::string fname_normal = fname_base.substr(0, pos) + normal_ext;
        if (isKnownSourceImage(fname_normal)) {
                // look for image extension and replace it
                size_t i = 0;
                while ((i = fname_base.find('.', i)) != std::string::npos) {
                        fname_base.replace(i, 4, normal_ext);
                        i += normal_ext_size;
                }
                return getTexture(fname_base);
        }
        return NULL;
}

video::SColor TextureSource::getTextureAverageColor(const std::string &name)
{
        video::IVideoDriver *driver = RenderingEngine::get_video_driver();
        video::SColor c(0, 0, 0, 0);
        video::ITexture *texture = getTexture(name);
        if (!texture)
                return c;
        video::IImage *image = driver->createImage(texture,
                core::position2d<s32>(0, 0),
                texture->getOriginalSize());
        if (!image)
                return c;

        u32 total = 0;
        u32 tR = 0;
        u32 tG = 0;
        u32 tB = 0;
        core::dimension2d<u32> dim = image->getDimension();
        u16 step = 1;
        if (dim.Width > 16)
                step = dim.Width / 16;
        for (u16 x = 0; x < dim.Width; x += step) {
                for (u16 y = 0; y < dim.Width; y += step) {
                        c = image->getPixel(x,y);
                        if (c.getAlpha() > 0) {
                                total++;
                                tR += c.getRed();
                                tG += c.getGreen();
                                tB += c.getBlue();
                        }
                }
        }
        image->drop();
        if (total > 0) {
                c.setRed(tR / total);
                c.setGreen(tG / total);
                c.setBlue(tB / total);
        }
        c.setAlpha(255);
        return c;
}


video::ITexture *TextureSource::getShaderFlagsTexture(bool normalmap_present)
{
        std::string tname = "__shaderFlagsTexture";
        tname += normalmap_present ? "1" : "0";

        if (isKnownSourceImage(tname)) {
                return getTexture(tname);
        }

        video::IVideoDriver *driver = RenderingEngine::get_video_driver();
        video::IImage *flags_image = driver->createImage(
                video::ECF_A8R8G8B8, core::dimension2d<u32>(1, 1));
        sanity_check(flags_image != NULL);
        video::SColor c(255, normalmap_present ? 255 : 0, 0, 0);
        flags_image->setPixel(0, 0, c);
        insertSourceImage(tname, flags_image);
        flags_image->drop();
        return getTexture(tname);

}

std::vector<std::string> getTextureDirs()
{
        return fs::GetRecursiveDirs(g_settings->get("texture_path"));
}