Fix for images with invalid pixel formats
[supertux.git] / src / video / texture_manager.cpp
index 70b0e95..ae272b3 100644 (file)
@@ -1,12 +1,10 @@
-//  $Id$
-//
 //  SuperTux
 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
 //
-//  This program is free software; you can redistribute it and/or
-//  modify it under the terms of the GNU General Public License
-//  as published by the Free Software Foundation; either version 2
-//  of the License, or (at your option) any later version.
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 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
 //  GNU General Public License for more details.
 //
 //  You should have received a copy of the GNU General Public License
-//  along with this program; if not, write to the Free Software
-//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-
-#include <config.h>
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-#include "texture_manager.hpp"
+#include "video/texture_manager.hpp"
 
-#include <assert.h>
-#include <SDL.h>
 #include <SDL_image.h>
+#include <assert.h>
 #include <iostream>
 #include <sstream>
 #include <stdexcept>
+
+#include "math/rect.hpp"
 #include "physfs/physfs_sdl.hpp"
-#include "video_systems.hpp"
-#include "gl_texture.hpp"
-#include "glutil.hpp"
-#include "gameconfig.hpp"
-#include "file_system.hpp"
-#include "log.hpp"
-#include "texture.hpp"
+#include "util/file_system.hpp"
+#include "util/log.hpp"
+#include "video/sdl_surface_ptr.hpp"
+#include "video/texture.hpp"
+#include "video/video_system.hpp"
 
-TextureManager* texture_manager = NULL;
+#ifdef HAVE_OPENGL
+#include "video/gl/gl_texture.hpp"
+#endif
 
-TextureManager::TextureManager()
+TextureManager::TextureManager() :
+  m_image_textures()
+  ,m_surfaces()
+#ifdef HAVE_OPENGL
+  ,m_textures(),
+  m_saved_textures()
+#endif
 {
 }
 
 TextureManager::~TextureManager()
 {
-  for(ImageTextures::iterator i = image_textures.begin();
-      i != image_textures.end(); ++i) {
-    if(i->second == NULL)
-      continue;
-    log_warning << "Texture '" << i->first << "' not freed" << std::endl;
-    delete i->second;
+  for(ImageTextures::iterator i = m_image_textures.begin(); i != m_image_textures.end(); ++i)
+  {
+    if(!i->second.expired())
+    {
+      log_warning << "Texture '" << i->first << "' not freed" << std::endl;
+    }
   }
+  m_image_textures.clear();
+
+  for(auto& surface : m_surfaces)
+  {
+    SDL_FreeSurface(surface.second);
+  }
+  m_surfaces.clear();
 }
 
-Texture*
+TexturePtr
 TextureManager::get(const std::string& _filename)
 {
   std::string filename = FileSystem::normalize(_filename);
-  ImageTextures::iterator i = image_textures.find(filename);
+  ImageTextures::iterator i = m_image_textures.find(filename);
 
-  Texture* texture = NULL;
-  if(i != image_textures.end())
-    texture = i->second;
+  TexturePtr texture;
+  if(i != m_image_textures.end())
+    texture = i->second.lock();
 
-  if(texture == NULL) {
+  if(!texture) {
     texture = create_image_texture(filename);
-    image_textures[filename] = texture;
+    texture->cache_filename = filename;
+    m_image_textures[filename] = texture;
   }
 
   return texture;
 }
 
+TexturePtr
+TextureManager::get(const std::string& _filename, const Rect& rect)
+{
+  std::string filename = FileSystem::normalize(_filename);
+  // FIXME: implement caching
+  return create_image_texture(filename, rect);
+}
+
 void
-TextureManager::release(Texture* texture)
+TextureManager::reap_cache_entry(const std::string& filename)
 {
-  image_textures.erase(texture->get_filename());
-  delete texture;
+  ImageTextures::iterator i = m_image_textures.find(filename);
+  assert(i != m_image_textures.end());
+  assert(i->second.expired());
+  m_image_textures.erase(i);
 }
 
 #ifdef HAVE_OPENGL
 void
-TextureManager::register_texture(GL::Texture* texture)
+TextureManager::register_texture(GLTexture* texture)
 {
-  textures.insert(texture);
+  m_textures.insert(texture);
 }
 
 void
-TextureManager::remove_texture(GL::Texture* texture)
+TextureManager::remove_texture(GLTexture* texture)
 {
-  textures.erase(texture);
+  m_textures.erase(texture);
 }
 #endif
 
-Texture*
-TextureManager::create_image_texture(const std::string& filename)
+TexturePtr
+TextureManager::create_image_texture(const std::string& filename, const Rect& rect)
 {
-  try {
+  try
+  {
+    return create_image_texture_raw(filename, rect);
+  }
+  catch(const std::exception& err)
+  {
+    log_warning << "Couldn't load texture '" << filename << "' (now using dummy texture): " << err.what() << std::endl;
+    return create_dummy_texture();
+  }
+}
 
-    SDL_Surface* image = IMG_Load_RW(get_physfs_SDLRWops(filename), 1);
-    if(image == 0) {
+TexturePtr
+TextureManager::create_image_texture_raw(const std::string& filename, const Rect& rect)
+{
+  SDL_Surface *image = nullptr;
+
+  Surfaces::iterator i = m_surfaces.find(filename);
+  if (i != m_surfaces.end())
+  {
+    image = i->second;
+  }
+  else
+  {
+    image = IMG_Load_RW(get_physfs_SDLRWops(filename), 1);
+    if (!image)
+    {
       std::ostringstream msg;
       msg << "Couldn't load image '" << filename << "' :" << SDL_GetError();
       throw std::runtime_error(msg.str());
     }
 
-    Texture* result = 0;
-    try {
-      result = new_texture(image);
-      result->set_filename(filename);
-    } catch(...) {
-      delete result;
-      SDL_FreeSurface(image);
-      throw;
-    }
-
-    SDL_FreeSurface(image);
-    return result;
+    SDL_PixelFormat* format = image->format;
+    if(format->Rmask == 0 && format->Gmask == 0 && format->Bmask == 0 && format->Amask == 0) {
+      log_warning << "Wrong surface format for image " << filename << ". Compensating." << std::endl;
 
-  } catch (const std::runtime_error& err) {
-    const std::string dummy_texture_fname = "images/engine/missing.png";
-    if (filename == dummy_texture_fname) throw err;
-
-    // on error, try loading placeholder file
-    try {
+      SDL_Surface* converted_surf = SDL_ConvertSurfaceFormat(image, SDL_PIXELFORMAT_RGBA8888, 0);
+      m_surfaces[filename] = converted_surf;
+    }
+    else
+    {
+      m_surfaces[filename] = image;
+    }
+  }
 
-      Texture* tex = create_image_texture(dummy_texture_fname);
-      log_warning << "Couldn't load texture '" << filename << "' (now using dummy texture): " << err.what() << std::endl;
-      return tex;
+  SDLSurfacePtr subimage(SDL_CreateRGBSurfaceFrom(static_cast<uint8_t*>(image->pixels) +
+                                                  rect.top * image->pitch +
+                                                  rect.left * image->format->BytesPerPixel,
+                                                  rect.get_width(), rect.get_height(),
+                                                  image->format->BitsPerPixel,
+                                                  image->pitch,
+                                                  image->format->Rmask,
+                                                  image->format->Gmask,
+                                                  image->format->Bmask,
+                                                  image->format->Amask));
+  if (!subimage)
+  {
+    throw std::runtime_error("SDL_CreateRGBSurfaceFrom() call failed");
+  }
 
-    } catch (...) {
+#ifdef OLD_SDL
+  if (image->format->palette)
+  { // copy the image palette to subimage if present
+    SDL_SetSurfacePalette(subimage.get(), image->format->palette->colors);
+  }
+#endif
 
-      // on error (when loading placeholder), try using empty surface
-      try {
+  return VideoSystem::current()->new_texture(subimage.get());
+}
 
-       SDL_Surface* image = SDL_CreateRGBSurface(0, 1024, 1024, 8, 0, 0, 0, 0);
-       if(image == 0) {
-         throw err;
-       }
+TexturePtr
+TextureManager::create_image_texture(const std::string& filename)
+{
+  try
+  {
+    return create_image_texture_raw(filename);
+  }
+  catch (const std::exception& err)
+  {
+    log_warning << "Couldn't load texture '" << filename << "' (now using dummy texture): " << err.what() << std::endl;
+    return create_dummy_texture();
+  }
+}
 
-       Texture* result = 0;
-       try {
-         result = new_texture(image);
-         result->set_filename("-dummy-texture-.png");
-       } catch(...) {
-         delete result;
-         SDL_FreeSurface(image);
-         throw err;
-       }
+TexturePtr
+TextureManager::create_image_texture_raw(const std::string& filename)
+{
+  SDLSurfacePtr image(IMG_Load_RW(get_physfs_SDLRWops(filename), 1));
+  if (!image)
+  {
+    std::ostringstream msg;
+    msg << "Couldn't load image '" << filename << "' :" << SDL_GetError();
+    throw std::runtime_error(msg.str());
+  }
+  else
+  {
+    TexturePtr texture = VideoSystem::current()->new_texture(image.get());
+    image.reset(NULL);
+    return texture;
+  }
+}
 
-       SDL_FreeSurface(image);
-        log_warning << "Couldn't load texture '" << filename << "' (now using empty one): " << err.what() << std::endl;
-       return result;
+TexturePtr
+TextureManager::create_dummy_texture()
+{
+  const std::string dummy_texture_fname = "images/engine/missing.png";
 
-      // on error (when trying to use empty surface), give up
-      } catch (const std::runtime_error& err) {
-       throw err;
-      }
+  // on error, try loading placeholder file
+  try
+  {
+    TexturePtr tex = create_image_texture_raw(dummy_texture_fname);
+    return tex;
+  }
+  catch (const std::exception& err)
+  {
+    // on error (when loading placeholder), try using empty surface,
+    // when that fails to, just give up
+    SDLSurfacePtr image(SDL_CreateRGBSurface(0, 1024, 1024, 8, 0, 0, 0, 0));
+    if (!image)
+    {
+      throw;
+    }
+    else
+    {
+      log_warning << "Couldn't load texture '" << dummy_texture_fname << "' (now using empty one): " << err.what() << std::endl;
+      TexturePtr texture = VideoSystem::current()->new_texture(image.get());
+      image.reset(NULL);
+      return texture;
     }
   }
 }
@@ -164,7 +250,7 @@ TextureManager::create_image_texture(const std::string& filename)
 void
 TextureManager::save_textures()
 {
-#ifdef GL_PACK_ROW_LENGTH
+#if defined(GL_PACK_ROW_LENGTH) || defined(USE_GLBINDING)
   /* all this stuff is not support by OpenGL ES */
   glPixelStorei(GL_PACK_ROW_LENGTH, 0);
   glPixelStorei(GL_PACK_IMAGE_HEIGHT, 0);
@@ -174,17 +260,25 @@ TextureManager::save_textures()
 #endif
 
   glPixelStorei(GL_PACK_ALIGNMENT, 1);
-  for(Textures::iterator i = textures.begin(); i != textures.end(); ++i) {
+
+  for(Textures::iterator i = m_textures.begin(); i != m_textures.end(); ++i)
+  {
     save_texture(*i);
   }
-  for(ImageTextures::iterator i = image_textures.begin();
-      i != image_textures.end(); ++i) {
-    save_texture(dynamic_cast<GL::Texture *>(i->second));
+
+  for(ImageTextures::iterator i = m_image_textures.begin();
+      i != m_image_textures.end(); ++i)
+  {
+    GLTexture* texture = dynamic_cast<GLTexture*>(i->second.lock().get());
+    if(texture == NULL)
+      continue;
+
+    save_texture(texture);
   }
 }
 
 void
-TextureManager::save_texture(GL::Texture* texture)
+TextureManager::save_texture(GLTexture* texture)
 {
   SavedTexture saved_texture;
   saved_texture.texture = texture;
@@ -214,7 +308,7 @@ TextureManager::save_texture(GL::Texture* texture)
                 saved_texture.pixels);
 #endif
 
-  saved_textures.push_back(saved_texture);
+  m_saved_textures.push_back(saved_texture);
 
   glDeleteTextures(1, &(texture->get_handle()));
   texture->set_handle(0);
@@ -225,7 +319,7 @@ TextureManager::save_texture(GL::Texture* texture)
 void
 TextureManager::reload_textures()
 {
-#ifdef GL_UNPACK_ROW_LENGTH
+#if defined(GL_UNPACK_ROW_LENGTH) || defined(USE_GLBINDING)
   /* OpenGL ES doesn't support these */
   glPixelStorei(GL_UNPACK_ROW_LENGTH, 0);
   glPixelStorei(GL_UNPACK_IMAGE_HEIGHT, 0);
@@ -235,8 +329,8 @@ TextureManager::reload_textures()
 #endif
   glPixelStorei(GL_UNPACK_ALIGNMENT, 1);
 
-  for(std::vector<SavedTexture>::iterator i = saved_textures.begin();
-      i != saved_textures.end(); ++i) {
+  for(std::vector<SavedTexture>::iterator i = m_saved_textures.begin();
+      i != m_saved_textures.end(); ++i) {
     SavedTexture& saved_texture = *i;
 
     GLuint handle;
@@ -244,7 +338,7 @@ TextureManager::reload_textures()
     assert_gl("creating texture handle");
 
     glBindTexture(GL_TEXTURE_2D, handle);
-    glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA,
+    glTexImage2D(GL_TEXTURE_2D, 0, static_cast<GLint>(GL_RGBA),
                  saved_texture.width, saved_texture.height,
                  saved_texture.border, GL_RGBA,
                  GL_UNSIGNED_BYTE, saved_texture.pixels);
@@ -264,6 +358,8 @@ TextureManager::reload_textures()
     saved_texture.texture->set_handle(handle);
   }
 
-  saved_textures.clear();
+  m_saved_textures.clear();
 }
 #endif
+
+/* EOF */