plugins/imagepng/plugin.cpp

   1 /*
   2 Copyright (C) 1999-2007 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 // =============================================================================
  23 // global tables
  24
  25 #include "plugin.h"
  26
  27 _QERFuncTable_1 g_FuncTable;
  28 _QERFileSystemTable g_FileSystemTable;
  29
  30 // =============================================================================
  31 // SYNAPSE
  32
  33 #include "synapse.h"
  34
  35 class CSynapseClientImage : public CSynapseClient
  36 {
  37 public:
  38   // CSynapseClient API
  39   bool RequestAPI(APIDescriptor_t *pAPI);
  40   const char* GetInfo();
  41
  42   CSynapseClientImage() { }
  43   virtual ~CSynapseClientImage() { }
  44 };
  45
  46 CSynapseServer* g_pSynapseServer = NULL;
  47 CSynapseClientImage g_SynapseClient;
  48
  49 #if __GNUC__ >= 4
  50 #pragma GCC visibility push(default)
  51 #endif
  52 extern "C" CSynapseClient* SYNAPSE_DLL_EXPORT Synapse_EnumerateInterfaces( const char *version, CSynapseServer *pServer ) {
  53 #if __GNUC__ >= 4
  54 #pragma GCC visibility pop
  55 #endif
  56   if (strcmp(version, SYNAPSE_VERSION))
  57   {
  58     Syn_Printf("ERROR: synapse API version mismatch: should be '" SYNAPSE_VERSION "', got '%s'\n", version);
  59     return NULL;
  60   }
  61   g_pSynapseServer = pServer;
  62   g_pSynapseServer->IncRef();
  63   Set_Syn_Printf(g_pSynapseServer->Get_Syn_Printf());
  64
  65   g_SynapseClient.AddAPI(IMAGE_MAJOR, "png", sizeof(_QERPlugImageTable));
  66   g_SynapseClient.AddAPI(RADIANT_MAJOR, NULL, sizeof(_QERFuncTable_1), SYN_REQUIRE, &g_FuncTable);
  67   // NOTE: if imagepng starts being used for non "VFS" "pk3" config, need to add a dynamic config chunk
  68   // see:
  69   // http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=794
  70   // http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=800
  71   g_SynapseClient.AddAPI(VFS_MAJOR, "pk3", sizeof(_QERFileSystemTable), SYN_REQUIRE, &g_FileSystemTable);
  72
  73   return &g_SynapseClient;
  74 }
  75
  76 bool CSynapseClientImage::RequestAPI(APIDescriptor_t *pAPI)
  77 {
  78   if (!strcmp(pAPI->major_name, IMAGE_MAJOR))
  79   {
  80     _QERPlugImageTable* pTable= static_cast<_QERPlugImageTable*>(pAPI->mpTable);
  81     if (!strcmp(pAPI->minor_name, "png"))
  82     {
  83       pTable->m_pfnLoadImage = &LoadImage;
  84       return true;
  85     }
  86   }
  87
  88   Syn_Printf("ERROR: RequestAPI( '%s' ) not found in '%s'\n", pAPI->major_name, GetInfo());
  89   return false;
  90 }
  91
  92 #include "version.h"
  93
  94 const char* CSynapseClientImage::GetInfo()
  95 {
  96   return "PNG loader module built " __DATE__ " " RADIANT_VERSION;
  97 }
  98
  99
 100
 101 // ====== PNG loader functionality ======
 102
 103 #include "png.h"
 104
 105 #ifdef __APPLE__        //tigital
 106 #include <stdlib.h>
 107 #endif
 108
 109 void user_warning_fn(png_structp png_ptr, png_const_charp warning_msg)
 110 {
 111   g_FuncTable.m_pfnSysPrintf ("libpng warning: %s\n", warning_msg);
 112 }
 113
 114 void user_error_fn(png_structp png_ptr, png_const_charp error_msg)
 115 {
 116   g_FuncTable.m_pfnSysPrintf ("libpng error: %s\n", error_msg);
 117   longjmp(png_ptr->jmpbuf, 0);
 118 }
 119
 120 void user_read_data(png_structp png_ptr, png_bytep data, png_uint_32 length)
 121 {
 122   png_bytep *p_p_fbuffer = (png_bytep*)png_get_io_ptr(png_ptr);
 123   memcpy(data, *p_p_fbuffer, length);
 124   *p_p_fbuffer += length;
 125 }
 126
 127 void LoadImage (const char *filename, unsigned char **pic, int *width, int *height)
 128 {
 129   png_byte** row_pointers;
 130   unsigned char *fbuffer = NULL;
 131   png_bytep p_fbuffer;
 132
 133   int nLen = g_FileSystemTable.m_pfnLoadFile( (char *)filename, (void **)&fbuffer, 0 );
 134   if (nLen == -1)
 135     return;
 136
 137   p_fbuffer = fbuffer;
 138
 139   // the reading glue
 140   // http://www.libpng.org/pub/png/libpng-manual.html
 141
 142   png_structp png_ptr = png_create_read_struct
 143     (PNG_LIBPNG_VER_STRING, png_voidp_NULL,
 144     user_error_fn, user_warning_fn);
 145   if (!png_ptr)
 146   {
 147     g_FuncTable.m_pfnSysPrintf ("libpng error: png_create_read_struct\n");
 148     return;
 149   }
 150
 151   png_infop info_ptr = png_create_info_struct(png_ptr);
 152   if (!info_ptr) {
 153     png_destroy_read_struct(&png_ptr,
 154       png_infopp_NULL, png_infopp_NULL);
 155     g_FuncTable.m_pfnSysPrintf ("libpng error: png_create_info_struct (info_ptr)\n");
 156     return;
 157   }
 158
 159   png_infop end_info = png_create_info_struct(png_ptr);
 160   if (!end_info) {
 161     png_destroy_read_struct(&png_ptr, &info_ptr,
 162       png_infopp_NULL);
 163     g_FuncTable.m_pfnSysPrintf ("libpng error: png_create_info_struct (end_info)\n");
 164     return;
 165   }
 166
 167   // configure the read function
 168   png_set_read_fn(png_ptr, (voidp)&p_fbuffer, (png_rw_ptr)&user_read_data);
 169
 170   if (setjmp(png_ptr->jmpbuf)) {
 171     png_destroy_read_struct(&png_ptr, &info_ptr,
 172       &end_info);
 173     if (*pic)
 174     {
 175       g_free(*pic);
 176       free(row_pointers);
 177     }
 178     return;
 179   }
 180
 181   png_read_info(png_ptr, info_ptr);
 182
 183   int bit_depth = png_get_bit_depth(png_ptr, info_ptr);
 184   int color_type = png_get_color_type(png_ptr, info_ptr);
 185
 186   // we want to treat all images the same way
 187   //   The following code transforms grayscale images of less than 8 to 8 bits,
 188   //   changes paletted images to RGB, and adds a full alpha channel if there is
 189   //   transparency information in a tRNS chunk.
 190   if (color_type == PNG_COLOR_TYPE_PALETTE)
 191    png_set_palette_to_rgb(png_ptr);
 192
 193   if (color_type == PNG_COLOR_TYPE_GRAY && bit_depth < 8)
 194     png_set_gray_1_2_4_to_8(png_ptr);
 195
 196   if (png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS))
 197     png_set_tRNS_to_alpha(png_ptr);
 198
 199   if ( ! ( color_type & PNG_COLOR_MASK_ALPHA ) ) {
 200     // Set the background color to draw transparent and alpha images over.
 201     png_color_16 my_background, *image_background;
 202
 203     if (png_get_bKGD(png_ptr, info_ptr, &image_background))
 204       png_set_background(png_ptr, image_background,
 205       PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
 206     else
 207       png_set_background(png_ptr, &my_background,
 208       PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
 209
 210     // Add alpha byte after each RGB triplet
 211     png_set_filler(png_ptr, 0xff, PNG_FILLER_AFTER);
 212   }
 213
 214   // read the sucker in one chunk
 215   png_read_update_info(png_ptr, info_ptr);
 216
 217   color_type = png_get_color_type(png_ptr, info_ptr);
 218   bit_depth = png_get_bit_depth(png_ptr, info_ptr);
 219
 220   *width = png_get_image_width(png_ptr, info_ptr);
 221   *height = png_get_image_height(png_ptr, info_ptr);
 222
 223   // allocate the pixel buffer, and the row pointers
 224   int size = (*width)*(*height)*4;
 225   // still have to use that g_malloc heresy
 226   // http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=491
 227   *pic = (unsigned char *)g_malloc(size);
 228   row_pointers = (png_byte**) malloc((*height) * sizeof(png_byte*));
 229
 230   int i;
 231   for(i = 0; i < (*height); i++)
 232     row_pointers[i] = (png_byte*)(*pic) + i * 4 * (*width);
 233
 234   // actual read
 235   png_read_image(png_ptr, row_pointers);
 236
 237   /* read rest of file, and get additional chunks in info_ptr - REQUIRED */
 238   png_read_end(png_ptr, info_ptr);
 239
 240   /* free up the memory structure */
 241   png_destroy_read_struct(&png_ptr, &info_ptr, png_infopp_NULL);
 242
 243   free(row_pointers);
 244   g_FileSystemTable.m_pfnFreeFile (fbuffer);
 245 }