image.cpp

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2019 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE 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 library 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 library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

// Standard C++ library includes
#include <cassert>
#include <iostream>
#include <sstream>

// 3rd party library includes
#include <SDL.h>

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "util/resource/resource.h"
#include "loaders/native/video/imageloader.h"

#include "image.h"

namespace FIFE {

    Image::Image(IResourceLoader* loader):
        IResource(createUniqueImageName(), loader),
        m_surface(NULL),
        m_xshift(0),
        m_yshift(0),
        m_shared(false){
    }

    Image::Image(const std::string& name, IResourceLoader* loader):
        IResource(name, loader),
        m_surface(NULL),
        m_xshift(0),
        m_yshift(0),
        m_shared(false){
    }

    Image::Image(SDL_Surface* surface):
        IResource(createUniqueImageName()),
        m_surface(NULL),
        m_xshift(0),
        m_yshift(0),
        m_shared(false){
        reset(surface);
    }

    Image::Image(const std::string& name, SDL_Surface* surface):
        IResource(name),
        m_surface(NULL),
        m_xshift(0),
        m_yshift(0),
        m_shared(false){
        reset(surface);
    }

    //@todo make a private function to handle this
    Image::Image(const uint8_t* data, uint32_t width, uint32_t height):
        IResource(createUniqueImageName()),
        m_surface(NULL),
        m_xshift(0),
        m_yshift(0),
        m_shared(false){
        SDL_Surface* surface = SDL_CreateRGBSurface(0, width,height, 32,
                                                    RMASK, GMASK, BMASK ,AMASK);
        SDL_LockSurface(surface);

        uint32_t size = width * height * 4;
        uint8_t* pixeldata = static_cast<uint8_t*>(surface->pixels);
        std::copy(data, data + size, pixeldata);
        SDL_UnlockSurface(surface);
        reset(surface);
    }

    Image::Image(const std::string& name, const uint8_t* data, uint32_t width, uint32_t height):
        IResource(name),
        m_surface(NULL),
        m_xshift(0),
        m_yshift(0),
        m_shared(false) {
        SDL_Surface* surface = SDL_CreateRGBSurface(0, width,height, 32,
                                                    RMASK, GMASK, BMASK ,AMASK);
        SDL_LockSurface(surface);

        uint32_t size = width * height * 4;
        uint8_t* pixeldata = static_cast<uint8_t*>(surface->pixels);
        std::copy(data, data + size, pixeldata);
        SDL_UnlockSurface(surface);
        reset(surface);
    }

    void Image::reset(SDL_Surface* surface) {
        if( m_surface && !m_shared) {
            SDL_FreeSurface(m_surface);
        }

        m_xshift = 0;
        m_yshift = 0;
        m_surface = surface;
    }

    Image::~Image() {
        reset(NULL);
    }

    void Image::load() {
        if (m_loader){
            m_loader->load(this);
        }
        else {
            ImageLoader loader;
            loader.load(this);
        }
        m_state = IResource::RES_LOADED;
    }

    void Image::free() {
        // save the image offsets
        int32_t xshift = m_xshift;
        int32_t yshift = m_yshift;
        reset(NULL);
        m_xshift = xshift;
        m_yshift = yshift;
        m_state = IResource::RES_NOT_LOADED;
    }

    SDL_Surface* Image::detachSurface() {
        SDL_Surface* srf = m_surface;
        m_surface = NULL;
        return srf;
    }

    uint32_t Image::getWidth() const {
        if (m_shared) {
            return m_subimagerect.w;
        } else if (!m_surface) {
            return 0;
        }
        return m_surface->w;
    }

    uint32_t Image::getHeight() const {
        if (m_shared) {
            return m_subimagerect.h;
        } else if (!m_surface) {
            return 0;
        }
        return m_surface->h;
    }

    size_t Image::getSize() {
        if (!m_surface || m_shared) {
            return 0;
        }
        return m_surface->h * m_surface->pitch;
    }

    Rect Image::getArea() const {
        Rect r(0, 0, getWidth(), getHeight());
        return r;
    }

    void Image::getPixelRGBA(int32_t x, int32_t y, uint8_t* r, uint8_t* g, uint8_t* b, uint8_t* a) {
        Uint8 *p;

        assert(m_surface);

        int32_t bpp = m_surface->format->BytesPerPixel;

        if(!isSharedImage()) {
            if ((x < 0) || (x >= m_surface->w) || (y < 0) || (y >= m_surface->h)) {
                r = g = b = a = 0;
                return;
            }
            p = (Uint8*)m_surface->pixels + y * m_surface->pitch + x * bpp;
        } else {
            if ((x < 0) || ((x + m_subimagerect.x) >= m_surface->w) || (y < 0) || ((y + m_subimagerect.y) >= m_surface->h)) {
                r = g = b = a = 0;
                return;
            }
            p = (Uint8*)m_surface->pixels + (y + m_subimagerect.y) * m_surface->pitch + (x + m_subimagerect.x) * bpp;
        }

        uint32_t pixel = 0;
        switch(bpp) {
        case 1:
            pixel = *p;
            break;

        case 2:
            pixel = *(Uint16 *)p;
            break;

        case 3:
            if (SDL_BYTEORDER == SDL_BIG_ENDIAN) {
                pixel = p[0] << 16 | p[1] << 8 | p[2];
            } else {
                pixel = p[0] | p[1] << 8 | p[2] << 16;
            }
            break;

        case 4:
            pixel = *(Uint32 *)p;
            break;
        }
        SDL_GetRGBA(pixel, m_surface->format, r, g, b, a);
    }

    void Image::saveImage(const std::string& filename) {
        saveAsPng(filename, *m_surface);
    }

    void Image::saveAsPng(const std::string& filename, const SDL_Surface& surface) {
        FILE *fp;
        png_structp pngptr;
        png_infop infoptr;
        int32_t colortype;
        png_bytep *rowpointers = NULL;

        fp = fopen(filename.c_str(), "wb");

        if (fp == NULL) {
            return;
        }

        //create the png file
        pngptr = png_create_write_struct(PNG_LIBPNG_VER_STRING,
        NULL, NULL, NULL);
        if (pngptr == NULL) {
            fclose(fp);
            return;
        }

        //create information struct
        infoptr = png_create_info_struct(pngptr);
        if (infoptr == NULL) {
            fclose(fp);
            png_destroy_write_struct(&pngptr, (png_infopp)NULL);
            return;
        }

        if (setjmp(png_jmpbuf(pngptr))) {
            png_destroy_write_struct(&pngptr, &infoptr);
            fclose(fp);
            return;
        }

        //initialize io
        png_init_io(pngptr, fp);

        // lock the surface for access (we strip it off of const but we promise not to modify it, just read)
        SDL_LockSurface(const_cast<SDL_Surface*>(&surface));

        colortype = PNG_COLOR_TYPE_RGB;
        if(surface.format->palette){
            colortype |= PNG_COLOR_TYPE_PALETTE;
        }
        else if (surface.format->Amask){
            colortype |= PNG_COLOR_TYPE_RGB_ALPHA;
        }
        else{}

        png_set_IHDR(pngptr, infoptr, surface.w, surface.h, 8, colortype,
            PNG_INTERLACE_NONE, PNG_COMPRESSION_TYPE_DEFAULT, PNG_FILTER_TYPE_DEFAULT);

        png_write_info(pngptr, infoptr);
        png_set_packing(pngptr);

        rowpointers = new png_bytep[surface.h];
        for (int32_t i = 0; i < surface.h; i++) {
            rowpointers[i] = (png_bytep)(Uint8 *)surface.pixels + i*surface.pitch;
        }
        //write the image
        png_write_image(pngptr, rowpointers);
        png_write_end(pngptr, infoptr);

        SDL_UnlockSurface(const_cast<SDL_Surface*>(&surface));
        delete [] rowpointers;
        png_destroy_write_struct(&pngptr, &infoptr);
        fclose(fp);
    }

    std::string Image::createUniqueImageName() {
        // automated counting for name generation, in case the user doesn't provide a name
        static uint32_t uniqueNumber = 0;
        static std::string baseName = "image";

        std::ostringstream oss;
        oss << uniqueNumber << "_" << baseName;

        const std::string name = oss.str();
        ++uniqueNumber;

        return name;
    }

    void Image::copySubimage(uint32_t xoffset, uint32_t yoffset, const ImagePtr& srcimg){
        if (!srcimg->m_surface) {
            return;
        } else if (!m_surface) {
            m_surface = SDL_CreateRGBSurface(0, srcimg->getWidth(),
                srcimg->getHeight(), 32, RMASK, GMASK, BMASK ,AMASK);
        }
        // disable blending
        SDL_SetSurfaceBlendMode(srcimg->m_surface, SDL_BLENDMODE_NONE);
        if(this->isSharedImage()) {
            Rect const& rect = this->getSubImageRect();
            SDL_Rect dstrect = {
                static_cast<Sint16>(rect.x + xoffset),
                static_cast<Sint16>(rect.y + yoffset),
                static_cast<Uint16>(srcimg->getWidth()),
                static_cast<Uint16>(srcimg->getHeight()) };
            if(srcimg->isSharedImage()) {
                Rect const& rect = srcimg->getSubImageRect();
                SDL_Rect srcrect = {
                    static_cast<Sint16>(rect.x),
                    static_cast<Sint16>(rect.y),
                    static_cast<Uint16>(rect.w),
                    static_cast<Uint16>(rect.h) };
                SDL_BlitSurface(srcimg->m_surface, &srcrect, m_surface, &dstrect);
            } else {
                SDL_BlitSurface(srcimg->m_surface, NULL, m_surface, &dstrect);
            }
        } else {
            SDL_Rect dstrect = {
                static_cast<Sint16>(xoffset),
                static_cast<Sint16>(yoffset),
                static_cast<Uint16>(srcimg->getWidth()),
                static_cast<Uint16>(srcimg->getHeight()) };
            if(srcimg->isSharedImage()) {
                Rect const& rect = srcimg->getSubImageRect();
                SDL_Rect srcrect = {
                    static_cast<Sint16>(rect.x),
                    static_cast<Sint16>(rect.y),
                    static_cast<Uint16>(rect.w),
                    static_cast<Uint16>(rect.h) };
                SDL_BlitSurface(srcimg->m_surface, &srcrect, m_surface, &dstrect);
            } else {
                SDL_BlitSurface(srcimg->m_surface, NULL, m_surface, &dstrect);
            }
        }
        // enable blending
        SDL_SetSurfaceBlendMode(srcimg->m_surface, SDL_BLENDMODE_BLEND);
    }

    bool Image::putPixel(SDL_Surface* surface, int32_t x, int32_t y, uint8_t r, uint8_t g, uint8_t b, uint8_t a) {
        if ((x < 0) || (x >= surface->w) || (y < 0) || (y >= surface->h)) {
            return false;
        }

        int32_t bpp = surface->format->BytesPerPixel;
        SDL_LockSurface(surface);
        Uint8* p = (Uint8*)surface->pixels + y * surface->pitch + x * bpp;
        Uint32 pixel = SDL_MapRGBA(surface->format, r, g, b, a);
        switch(bpp)
        {
        case 1:
            *p = pixel;
            break;

        case 2:
            *(Uint16 *)p = pixel;
            break;

        case 3:
            if(SDL_BYTEORDER == SDL_BIG_ENDIAN) {
                p[0] = (pixel >> 16) & 0xff;
                p[1] = (pixel >> 8) & 0xff;
                p[2] = pixel & 0xff;
            }
            else {
                p[0] = pixel & 0xff;
                p[1] = (pixel >> 8) & 0xff;
                p[2] = (pixel >> 16) & 0xff;
            }
            break;

        case 4:
            *(Uint32 *)p = pixel;
            break;
        }
        SDL_UnlockSurface(surface);
        return true;
    }
}