image_png.c

   1 /*
   2         Copyright (C) 2006  Serge "(515)" Ziryukin, Forest "LordHavoc" Hale
   3
   4         This program is free software; you can redistribute it and/or
   5         modify it under the terms of the GNU General Public License
   6         as published by the Free Software Foundation; either version 2
   7         of the License, or (at your option) any later version.
   8
   9         This program is distributed in the hope that it will be useful,
  10         but WITHOUT ANY WARRANTY; without even the implied warranty of
  11         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  12
  13         See the GNU General Public License for more details.
  14
  15         You should have received a copy of the GNU General Public License
  16         along with this program; if not, write to:
  17
  18                 Free Software Foundation, Inc.
  19                 59 Temple Place - Suite 330
  20                 Boston, MA  02111-1307, USA
  21
  22 */
  23
  24 //[515]: png implemented into DP ONLY FOR TESTING 2d stuff with csqc
  25 // so delete this bullshit :D
  26 //
  27 //LordHavoc: rewrote most of this.
  28
  29 #include "quakedef.h"
  30 #include "image.h"
  31 #include "image_png.h"
  32
  33 static void                             (*qpng_set_sig_bytes)           (void*, int);
  34 static int                              (*qpng_sig_cmp)                         (const unsigned char*, size_t, size_t);
  35 static void*                    (*qpng_create_read_struct)      (const char*, void*, void*, void*);
  36 static void*                    (*qpng_create_info_struct)      (void*);
  37 static void                             (*qpng_read_info)                       (void*, void*);
  38 static void                             (*qpng_set_expand)                      (void*);
  39 static void                             (*qpng_set_gray_1_2_4_to_8)     (void*);
  40 static void                             (*qpng_set_palette_to_rgb)      (void*);
  41 static void                             (*qpng_set_tRNS_to_alpha)       (void*);
  42 static void                             (*qpng_set_gray_to_rgb)         (void*);
  43 static void                             (*qpng_set_filler)                      (void*, unsigned int, int);
  44 static void                             (*qpng_read_update_info)        (void*, void*);
  45 static void                             (*qpng_read_image)                      (void*, unsigned char**);
  46 static void                             (*qpng_read_end)                        (void*, void*);
  47 static void                             (*qpng_destroy_read_struct)     (void**, void**, void**);
  48 static void                             (*qpng_set_read_fn)                     (void*, void*, void*);
  49 static unsigned int             (*qpng_get_valid)                       (void*, void*, unsigned int);
  50 static unsigned int             (*qpng_get_rowbytes)            (void*, void*);
  51 static unsigned char    (*qpng_get_channels)            (void*, void*);
  52 static unsigned char    (*qpng_get_bit_depth)           (void*, void*);
  53 static unsigned int             (*qpng_get_IHDR)                        (void*, void*, unsigned long*, unsigned long*, int *, int *, int *, int *, int *);
  54 static char*                    (*qpng_get_libpng_ver)          (void*);
  55
  56 static dllfunction_t pngfuncs[] =
  57 {
  58         {"png_set_sig_bytes",           (void **) &qpng_set_sig_bytes},
  59         {"png_sig_cmp",                         (void **) &qpng_sig_cmp},
  60         {"png_create_read_struct",      (void **) &qpng_create_read_struct},
  61         {"png_create_info_struct",      (void **) &qpng_create_info_struct},
  62         {"png_read_info",                       (void **) &qpng_read_info},
  63         {"png_set_expand",                      (void **) &qpng_set_expand},
  64         {"png_set_gray_1_2_4_to_8",     (void **) &qpng_set_gray_1_2_4_to_8},
  65         {"png_set_palette_to_rgb",      (void **) &qpng_set_palette_to_rgb},
  66         {"png_set_tRNS_to_alpha",       (void **) &qpng_set_tRNS_to_alpha},
  67         {"png_set_gray_to_rgb",         (void **) &qpng_set_gray_to_rgb},
  68         {"png_set_filler",                      (void **) &qpng_set_filler},
  69         {"png_read_update_info",        (void **) &qpng_read_update_info},
  70         {"png_read_image",                      (void **) &qpng_read_image},
  71         {"png_read_end",                        (void **) &qpng_read_end},
  72         {"png_destroy_read_struct",     (void **) &qpng_destroy_read_struct},
  73         {"png_set_read_fn",                     (void **) &qpng_set_read_fn},
  74         {"png_get_valid",                       (void **) &qpng_get_valid},
  75         {"png_get_rowbytes",            (void **) &qpng_get_rowbytes},
  76         {"png_get_channels",            (void **) &qpng_get_channels},
  77         {"png_get_bit_depth",           (void **) &qpng_get_bit_depth},
  78         {"png_get_IHDR",                        (void **) &qpng_get_IHDR},
  79         {"png_get_libpng_ver",          (void **) &qpng_get_libpng_ver},
  80         {NULL, NULL}
  81 };
  82
  83 // Handle for PNG DLL
  84 dllhandle_t png_dll = NULL;
  85
  86
  87 /*
  88 =================================================================
  89
  90   DLL load & unload
  91
  92 =================================================================
  93 */
  94
  95 /*
  96 ====================
  97 PNG_OpenLibrary
  98
  99 Try to load the PNG DLL
 100 ====================
 101 */
 102 qboolean PNG_OpenLibrary (void)
 103 {
 104         const char* dllnames [] =
 105         {
 106 #ifdef WIN64
 107                 "libpng12_64.dll",
 108 #elif WIN32
 109                 "libpng12.dll",
 110 #elif defined(MACOSX)
 111                 "libpng12.0.dylib",
 112 #else
 113                 "libpng12.so.0",
 114                 "libpng.so", // FreeBSD
 115 #endif
 116                 NULL
 117         };
 118
 119         // Already loaded?
 120         if (png_dll)
 121                 return true;
 122
 123         // Load the DLL
 124         if (! Sys_LoadLibrary (dllnames, &png_dll, pngfuncs))
 125         {
 126                 Con_Printf ("PNG support disabled\n");
 127                 return false;
 128         }
 129
 130         Con_Printf ("PNG support enabled\n");
 131         return true;
 132 }
 133
 134
 135 /*
 136 ====================
 137 PNG_CloseLibrary
 138
 139 Unload the PNG DLL
 140 ====================
 141 */
 142 void PNG_CloseLibrary (void)
 143 {
 144         Sys_UnloadLibrary (&png_dll);
 145 }
 146
 147
 148 /*
 149 =================================================================
 150
 151         PNG decompression
 152
 153 =================================================================
 154 */
 155
 156 #define PNG_LIBPNG_VER_STRING "1.2.4"
 157
 158 #define PNG_COLOR_MASK_PALETTE    1
 159 #define PNG_COLOR_MASK_COLOR      2
 160 #define PNG_COLOR_MASK_ALPHA      4
 161
 162 #define PNG_COLOR_TYPE_GRAY 0
 163 #define PNG_COLOR_TYPE_PALETTE  (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_PALETTE)
 164 #define PNG_COLOR_TYPE_RGB        (PNG_COLOR_MASK_COLOR)
 165 #define PNG_COLOR_TYPE_RGB_ALPHA  (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_ALPHA)
 166 #define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
 167
 168 #define PNG_COLOR_TYPE_RGBA  PNG_COLOR_TYPE_RGB_ALPHA
 169 #define PNG_COLOR_TYPE_GA  PNG_COLOR_TYPE_GRAY_ALPHA
 170
 171 #define PNG_INFO_tRNS 0x0010
 172
 173 // this struct is only used for status information during loading
 174 static struct
 175 {
 176         const unsigned char     *tmpBuf;
 177         int             tmpBuflength;
 178         int             tmpi;
 179         //int           FBgColor;
 180         //int           FTransparent;
 181         unsigned int    FRowBytes;
 182         //double        FGamma;
 183         //double        FScreenGamma;
 184         unsigned char   **FRowPtrs;
 185         unsigned char   *Data;
 186         //char  *Title;
 187         //char  *Author;
 188         //char  *Description;
 189         int             BitDepth;
 190         int             BytesPerPixel;
 191         int             ColorType;
 192         unsigned long   Height; // retarded libpng 1.2 pngconf.h uses long (64bit/32bit depending on arch)
 193         unsigned long   Width; // retarded libpng 1.2 pngconf.h uses long (64bit/32bit depending on arch)
 194         int             Interlace;
 195         int             Compression;
 196         int             Filter;
 197         //double        LastModified;
 198         //int           Transparent;
 199 } my_png;
 200
 201 //LordHavoc: removed __cdecl prefix, added overrun protection, and rewrote this to be more efficient
 202 void PNG_fReadData(void *png, unsigned char *data, size_t length)
 203 {
 204         size_t l;
 205         l = my_png.tmpBuflength - my_png.tmpi;
 206         if (l < length)
 207         {
 208                 Con_Printf("PNG_fReadData: overrun by %i bytes\n", (int)(length - l));
 209                 // a read going past the end of the file, fill in the remaining bytes
 210                 // with 0 just to be consistent
 211                 memset(data + l, 0, length - l);
 212                 length = l;
 213         }
 214         memcpy(data, my_png.tmpBuf + my_png.tmpi, length);
 215         my_png.tmpi += (int)length;
 216         //Com_HexDumpToConsole(data, (int)length);
 217 }
 218
 219 void PNG_error_fn(void *png, const char *message)
 220 {
 221         Con_Printf("PNG_LoadImage: error: %s\n", message);
 222 }
 223
 224 void PNG_warning_fn(void *png, const char *message)
 225 {
 226         Con_Printf("PNG_LoadImage: warning: %s\n", message);
 227 }
 228
 229 extern int      image_width;
 230 extern int      image_height;
 231
 232 unsigned char *PNG_LoadImage (const unsigned char *raw, int filesize, int matchwidth, int matchheight)
 233 {
 234         unsigned int    y;
 235         void *png, *pnginfo;
 236         unsigned char *imagedata = NULL;
 237         unsigned char ioBuffer[8192];
 238
 239         // FIXME: register an error handler so that abort() won't be called on error
 240
 241         // No DLL = no PNGs
 242         if (!png_dll)
 243                 return NULL;
 244
 245         if(qpng_sig_cmp(raw, 0, filesize))
 246                 return NULL;
 247         png = (void *)qpng_create_read_struct(PNG_LIBPNG_VER_STRING, 0, (void *)PNG_error_fn, (void *)PNG_warning_fn);
 248         if(!png)
 249                 return NULL;
 250
 251         // this must be memset before the setjmp error handler, because it relies
 252         // on the fields in this struct for cleanup
 253         memset(&my_png, 0, sizeof(my_png));
 254
 255         // NOTE: this relies on jmp_buf being the first thing in the png structure
 256         // created by libpng! (this is correct for libpng 1.2.x)
 257 #ifdef __cplusplus
 258 #ifdef MACOSX
 259         if (setjmp((int *)png))
 260 #else
 261         if (setjmp((__jmp_buf_tag *)png))
 262 #endif
 263 #else
 264         if (setjmp(png))
 265 #endif
 266         {
 267                 if (my_png.Data)
 268                         Mem_Free(my_png.Data);
 269                 my_png.Data = NULL;
 270                 if (my_png.FRowPtrs)
 271                         Mem_Free(my_png.FRowPtrs);
 272                 my_png.FRowPtrs = NULL;
 273                 qpng_destroy_read_struct(&png, &pnginfo, 0);
 274                 return NULL;
 275         }
 276         //
 277
 278         pnginfo = qpng_create_info_struct(png);
 279         if(!pnginfo)
 280         {
 281                 qpng_destroy_read_struct(&png, &pnginfo, 0);
 282                 return NULL;
 283         }
 284         qpng_set_sig_bytes(png, 0);
 285
 286         my_png.tmpBuf = raw;
 287         my_png.tmpBuflength = filesize;
 288         my_png.tmpi = 0;
 289         //my_png.Data           = NULL;
 290         //my_png.FRowPtrs       = NULL;
 291         //my_png.Height         = 0;
 292         //my_png.Width          = 0;
 293         my_png.ColorType        = PNG_COLOR_TYPE_RGB;
 294         //my_png.Interlace      = 0;
 295         //my_png.Compression    = 0;
 296         //my_png.Filter         = 0;
 297         qpng_set_read_fn(png, ioBuffer, (void *)PNG_fReadData);
 298         qpng_read_info(png, pnginfo);
 299         qpng_get_IHDR(png, pnginfo, &my_png.Width, &my_png.Height,&my_png.BitDepth, &my_png.ColorType, &my_png.Interlace, &my_png.Compression, &my_png.Filter);
 300
 301         // this check guards against pngconf.h with unsigned int *width/height parameters on big endian systems by detecting the strange values and shifting them down 32bits
 302         // (if it's little endian the unwritten bytes are the most significant
 303         //  ones and we don't worry about that)
 304         //
 305         // this is only necessary because of retarded 64bit png_uint_32 types in libpng 1.2, which can (conceivably) vary by platform
 306 #if LONG_MAX > 4000000000
 307         if (my_png.Width > LONG_MAX || my_png.Height > LONG_MAX)
 308         {
 309                 my_png.Width >>= 32;
 310                 my_png.Height >>= 32;
 311         }
 312 #endif
 313
 314         if ((matchwidth && my_png.Width != (unsigned long)matchwidth) || (matchheight && my_png.Height != (unsigned long)matchheight))
 315         {
 316                 qpng_destroy_read_struct(&png, &pnginfo, 0);
 317                 return NULL;
 318         }
 319         if (my_png.ColorType == PNG_COLOR_TYPE_PALETTE)
 320                 qpng_set_palette_to_rgb(png);
 321         if (my_png.ColorType == PNG_COLOR_TYPE_GRAY || my_png.ColorType == PNG_COLOR_TYPE_GRAY_ALPHA)
 322         {
 323                 qpng_set_gray_to_rgb(png);
 324                 if (my_png.BitDepth < 8)
 325                         qpng_set_gray_1_2_4_to_8(png);
 326         }
 327
 328         if (qpng_get_valid(png, pnginfo, PNG_INFO_tRNS))
 329                 qpng_set_tRNS_to_alpha(png);
 330         if (my_png.BitDepth == 8 && !(my_png.ColorType  & PNG_COLOR_MASK_ALPHA))
 331                 qpng_set_filler(png, 255, 1);
 332         if (( my_png.ColorType == PNG_COLOR_TYPE_GRAY) || (my_png.ColorType == PNG_COLOR_TYPE_GRAY_ALPHA ))
 333                 qpng_set_gray_to_rgb(png);
 334         if (my_png.BitDepth < 8)
 335                 qpng_set_expand(png);
 336
 337         qpng_read_update_info(png, pnginfo);
 338
 339         my_png.FRowBytes = qpng_get_rowbytes(png, pnginfo);
 340         my_png.BytesPerPixel = qpng_get_channels(png, pnginfo);
 341
 342         my_png.FRowPtrs = (unsigned char **)Mem_Alloc(tempmempool, my_png.Height * sizeof(*my_png.FRowPtrs));
 343         if (my_png.FRowPtrs)
 344         {
 345                 imagedata = (unsigned char *)Mem_Alloc(tempmempool, my_png.Height * my_png.FRowBytes);
 346                 if(imagedata)
 347                 {
 348                         my_png.Data = imagedata;
 349                         for(y = 0;y < my_png.Height;y++)
 350                                 my_png.FRowPtrs[y] = my_png.Data + y * my_png.FRowBytes;
 351                         qpng_read_image(png, my_png.FRowPtrs);
 352                 }
 353                 else
 354                         Con_DPrintf("PNG_LoadImage : not enough memory\n");
 355                 Mem_Free(my_png.FRowPtrs);
 356                 my_png.FRowPtrs = NULL;
 357         }
 358         else
 359                 Con_DPrintf("PNG_LoadImage : not enough memory\n");
 360
 361         qpng_read_end(png, pnginfo);
 362         qpng_destroy_read_struct(&png, &pnginfo, 0);
 363
 364         image_width = (int)my_png.Width;
 365         image_height = (int)my_png.Height;
 366
 367         if (my_png.BitDepth != 8)
 368         {
 369                 Con_Printf ("PNG_LoadImage : bad color depth\n");
 370                 Mem_Free(imagedata);
 371                 imagedata = NULL;
 372         }
 373
 374         return imagedata;
 375 }
 376