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 "debugging/debugging.h"
  23
  24 #include "ifilesystem.h"
  25 #include "iimage.h"
  26
  27 #include "imagelib.h"
  28
  29 // ====== PNG loader functionality ======
  30
  31 #include "png.h"
  32 #include <stdlib.h>
  33
  34 void user_warning_fn(png_structp png_ptr, png_const_charp warning_msg)
  35 {
  36     globalErrorStream() << "libpng warning: " << warning_msg << "\n";
  37 }
  38
  39 void user_error_fn(png_structp png_ptr, png_const_charp error_msg)
  40 {
  41     globalErrorStream() << "libpng error: " << error_msg << "\n";
  42     longjmp(png_jmpbuf(png_ptr), 0);
  43 }
  44
  45 void user_read_data(png_structp png_ptr, png_bytep data, png_uint_32 length)
  46 {
  47     png_bytep *p_p_fbuffer = (png_bytep *) png_get_io_ptr(png_ptr);
  48     memcpy(data, *p_p_fbuffer, length);
  49     *p_p_fbuffer += length;
  50 }
  51
  52 Image *LoadPNGBuff(unsigned char *fbuffer)
  53 {
  54     png_byte **row_pointers;
  55     png_bytep p_fbuffer;
  56
  57     p_fbuffer = fbuffer;
  58
  59     // the reading glue
  60     // http://www.libpng.org/pub/png/libpng-manual.html
  61
  62     png_structp png_ptr = png_create_read_struct
  63             (PNG_LIBPNG_VER_STRING, (png_voidp) NULL,
  64              user_error_fn, user_warning_fn);
  65     if (!png_ptr) {
  66         globalErrorStream() << "libpng error: png_create_read_struct\n";
  67         return 0;
  68     }
  69
  70     png_infop info_ptr = png_create_info_struct(png_ptr);
  71     if (!info_ptr) {
  72         png_destroy_read_struct(&png_ptr,
  73                                 (png_infopp) NULL, (png_infopp) NULL);
  74         globalErrorStream() << "libpng error: png_create_info_struct (info_ptr)\n";
  75         return 0;
  76     }
  77
  78     png_infop end_info = png_create_info_struct(png_ptr);
  79     if (!end_info) {
  80         png_destroy_read_struct(&png_ptr, &info_ptr,
  81                                 (png_infopp) NULL);
  82         globalErrorStream() << "libpng error: png_create_info_struct (end_info)\n";
  83         return 0;
  84     }
  85
  86     // configure the read function
  87     png_set_read_fn(png_ptr, (png_voidp) &p_fbuffer, (png_rw_ptr) &user_read_data);
  88
  89     if (setjmp(png_jmpbuf(png_ptr))) {
  90         png_destroy_read_struct(&png_ptr, &info_ptr,
  91                                 &end_info);
  92         return 0;
  93     }
  94
  95     png_read_info(png_ptr, info_ptr);
  96
  97     int bit_depth = png_get_bit_depth(png_ptr, info_ptr);
  98     int color_type = png_get_color_type(png_ptr, info_ptr);
  99
 100     // we want to treat all images the same way
 101     //   The following code transforms grayscale images of less than 8 to 8 bits,
 102     //   changes paletted images to RGB, and adds a full alpha channel if there is
 103     //   transparency information in a tRNS chunk.
 104
 105     if (color_type == PNG_COLOR_TYPE_GRAY || color_type == PNG_COLOR_TYPE_GRAY_ALPHA) {
 106         png_set_gray_to_rgb(png_ptr);
 107     } else if (color_type == PNG_COLOR_TYPE_PALETTE) {
 108         png_set_palette_to_rgb(png_ptr);
 109     }
 110
 111     if (color_type == PNG_COLOR_TYPE_GRAY && bit_depth < 8) {
 112         png_set_expand_gray_1_2_4_to_8(png_ptr);
 113     }
 114
 115     if (png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS)) {
 116         png_set_tRNS_to_alpha(png_ptr);
 117     } else if (!(color_type & PNG_COLOR_MASK_ALPHA)) {
 118         // Set the background color to draw transparent and alpha images over.
 119         png_color_16 my_background, *image_background;
 120
 121         if (png_get_bKGD(png_ptr, info_ptr, &image_background)) {
 122             png_set_background(png_ptr, image_background,
 123                                PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
 124         } else {
 125             png_set_background(png_ptr, &my_background,
 126                                PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
 127         }
 128
 129         // Add alpha byte after each RGB triplet
 130         png_set_filler(png_ptr, 0xff, PNG_FILLER_AFTER);
 131     }
 132
 133     // read the sucker in one chunk
 134     png_read_update_info(png_ptr, info_ptr);
 135
 136     color_type = png_get_color_type(png_ptr, info_ptr);
 137     bit_depth = png_get_bit_depth(png_ptr, info_ptr);
 138
 139     int width = png_get_image_width(png_ptr, info_ptr);
 140     int height = png_get_image_height(png_ptr, info_ptr);
 141
 142     // allocate the pixel buffer, and the row pointers
 143     RGBAImage *image = new RGBAImage(width, height);
 144
 145     row_pointers = (png_byte **) malloc((height) * sizeof(png_byte *));
 146
 147     int i;
 148     for (i = 0; i < (height); i++) {
 149         row_pointers[i] = (png_byte *) (image->getRGBAPixels()) + i * 4 * (width);
 150     }
 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 class ImagePNGAPI {
 180     _QERPlugImageTable m_imagepng;
 181 public:
 182     typedef _QERPlugImageTable Type;
 183
 184     STRING_CONSTANT(Name, "png");
 185
 186     ImagePNGAPI()
 187     {
 188         m_imagepng.loadImage = LoadPNG;
 189     }
 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 }