plugins/imagepng/plugin.cpp

   1 /*
   2 Copyright (C) 1999-2006 Id Software, Inc. and contributors.
   3 For a list of contributors, see the accompanying CONTRIBUTORS file.
   4
   5 This file is part of GtkRadiant.
   6
   7 GtkRadiant is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 GtkRadiant is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GtkRadiant; if not, write to the Free Software
  19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20 */
  21
  22 #include "plugin.h"
  23
  24 #include "debugging/debugging.h"
  25
  26 #include "ifilesystem.h"
  27 #include "iimage.h"
  28
  29 #include "imagelib.h"
  30
  31 // ====== PNG loader functionality ======
  32
  33 #include "png.h"
  34 #include <stdlib.h>
  35
  36 void user_warning_fn(png_structp png_ptr, png_const_charp warning_msg)
  37 {
  38   globalErrorStream() << "libpng warning: " << warning_msg << "\n";
  39 }
  40
  41 void user_error_fn(png_structp png_ptr, png_const_charp error_msg)
  42 {
  43   globalErrorStream() << "libpng error: " << error_msg << "\n";
  44   longjmp(png_jmpbuf(png_ptr), 0);
  45 }
  46
  47 void user_read_data(png_structp png_ptr, png_bytep data, png_uint_32 length)
  48 {
  49   png_bytep *p_p_fbuffer = (png_bytep*)png_get_io_ptr(png_ptr);
  50   memcpy(data, *p_p_fbuffer, length);
  51   *p_p_fbuffer += length;
  52 }
  53
  54 Image* LoadPNGBuff (unsigned char* fbuffer)
  55 {
  56   png_byte** row_pointers;
  57   png_bytep p_fbuffer;
  58
  59   p_fbuffer = fbuffer;
  60
  61   // the reading glue
  62   // http://www.libpng.org/pub/png/libpng-manual.html
  63
  64   png_structp png_ptr = png_create_read_struct
  65     (PNG_LIBPNG_VER_STRING, (png_voidp)NULL,
  66     user_error_fn, user_warning_fn);
  67   if (!png_ptr)
  68   {
  69     globalErrorStream() << "libpng error: png_create_read_struct\n";
  70     return 0;
  71   }
  72
  73   png_infop info_ptr = png_create_info_struct(png_ptr);
  74   if (!info_ptr) {
  75     png_destroy_read_struct(&png_ptr,
  76       (png_infopp)NULL, (png_infopp)NULL);
  77     globalErrorStream() << "libpng error: png_create_info_struct (info_ptr)\n";
  78     return 0;
  79   }
  80
  81   png_infop end_info = png_create_info_struct(png_ptr);
  82   if (!end_info) {
  83     png_destroy_read_struct(&png_ptr, &info_ptr,
  84       (png_infopp)NULL);
  85     globalErrorStream() << "libpng error: png_create_info_struct (end_info)\n";
  86     return 0;
  87   }
  88
  89   // configure the read function
  90   png_set_read_fn(png_ptr, (png_voidp)&p_fbuffer, (png_rw_ptr)&user_read_data);
  91
  92   if (setjmp(png_jmpbuf(png_ptr))) {
  93     png_destroy_read_struct(&png_ptr, &info_ptr,
  94       &end_info);
  95     return 0;
  96   }
  97
  98   png_read_info(png_ptr, info_ptr);
  99
 100   int bit_depth = png_get_bit_depth(png_ptr, info_ptr);
 101   int color_type = png_get_color_type(png_ptr, info_ptr);
 102
 103   // we want to treat all images the same way
 104   //   The following code transforms grayscale images of less than 8 to 8 bits,
 105   //   changes paletted images to RGB, and adds a full alpha channel if there is
 106   //   transparency information in a tRNS chunk.
 107
 108   if (color_type == PNG_COLOR_TYPE_GRAY || color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
 109     png_set_gray_to_rgb(png_ptr);
 110   else if (color_type == PNG_COLOR_TYPE_PALETTE)
 111     png_set_palette_to_rgb(png_ptr);
 112
 113   if (color_type == PNG_COLOR_TYPE_GRAY && bit_depth < 8)
 114     png_set_expand_gray_1_2_4_to_8(png_ptr);
 115
 116   if (png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS))
 117     png_set_tRNS_to_alpha(png_ptr);
 118
 119   if ( ! ( color_type & PNG_COLOR_MASK_ALPHA ) ) {
 120     // Set the background color to draw transparent and alpha images over.
 121     png_color_16 my_background, *image_background;
 122
 123     if (png_get_bKGD(png_ptr, info_ptr, &image_background))
 124       png_set_background(png_ptr, image_background,
 125       PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
 126     else
 127       png_set_background(png_ptr, &my_background,
 128       PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
 129
 130     // Add alpha byte after each RGB triplet
 131     png_set_filler(png_ptr, 0xff, PNG_FILLER_AFTER);
 132   }
 133
 134   // read the sucker in one chunk
 135   png_read_update_info(png_ptr, info_ptr);
 136
 137   color_type = png_get_color_type(png_ptr, info_ptr);
 138   bit_depth = png_get_bit_depth(png_ptr, info_ptr);
 139
 140   int width = png_get_image_width(png_ptr, info_ptr);
 141   int height = png_get_image_height(png_ptr, info_ptr);
 142
 143   // allocate the pixel buffer, and the row pointers
 144   RGBAImage* image = new RGBAImage(width, height);
 145
 146   row_pointers = (png_byte**) malloc((height) * sizeof(png_byte*));
 147
 148   int i;
 149   for(i = 0; i < (height); i++)
 150     row_pointers[i] = (png_byte*)(image->getRGBAPixels()) + i * 4 * (width);
 151
 152   // actual read
 153   png_read_image(png_ptr, row_pointers);
 154
 155   /* read rest of file, and get additional chunks in info_ptr - REQUIRED */
 156   png_read_end(png_ptr, info_ptr);
 157
 158   /* free up the memory structure */
 159   png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
 160
 161   free(row_pointers);
 162
 163   return image;
 164 }
 165
 166 Image* LoadPNG(ArchiveFile& file)
 167 {
 168   ScopedArchiveBuffer buffer(file);
 169   return LoadPNGBuff( buffer.buffer );
 170 }
 171
 172
 173 #include "modulesystem/singletonmodule.h"
 174
 175
 176 class ImageDependencies : public GlobalFileSystemModuleRef
 177 {
 178 };
 179
 180 class ImagePNGAPI
 181 {
 182   _QERPlugImageTable m_imagepng;
 183 public:
 184   typedef _QERPlugImageTable Type;
 185   STRING_CONSTANT(Name, "png");
 186
 187   ImagePNGAPI()
 188   {
 189     m_imagepng.loadImage = LoadPNG;
 190   }
 191   _QERPlugImageTable* getTable()
 192   {
 193     return &m_imagepng;
 194   }
 195 };
 196
 197 typedef SingletonModule<ImagePNGAPI, ImageDependencies> ImagePNGModule;
 198
 199 ImagePNGModule g_ImagePNGModule;
 200
 201
 202 extern "C" void RADIANT_DLLEXPORT Radiant_RegisterModules(ModuleServer& server)
 203 {
 204   initialiseModule(server);
 205
 206   g_ImagePNGModule.selfRegister();
 207 }