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 *png, const char *message), void(*)(void *png, const char *message));
  36 static void*                    (*qpng_create_write_struct)     (const char*, void*, void(*)(void *png, const char *message), void(*)(void *png, const char *message));
  37 static void*                    (*qpng_create_info_struct)      (void*);
  38 static void                             (*qpng_read_info)                       (void*, void*);
  39 static void                             (*qpng_set_compression_level)   (void*, int);
  40 static void                             (*qpng_set_filter)                      (void*, int, int);
  41 static void                             (*qpng_set_expand)                      (void*);
  42 static void                             (*qpng_set_palette_to_rgb)      (void*);
  43 static void                             (*qpng_set_tRNS_to_alpha)       (void*);
  44 static void                             (*qpng_set_gray_to_rgb)         (void*);
  45 static void                             (*qpng_set_filler)                      (void*, unsigned int, int);
  46 static void                             (*qpng_set_IHDR)                        (void*, void*, unsigned long, unsigned long, int, int, int, int, int);
  47 static void                             (*qpng_set_packing)                     (void*);
  48 static void                             (*qpng_set_bgr)                         (void*);
  49 static int                              (*qpng_set_interlace_handling)  (void*);
  50 static void                             (*qpng_read_update_info)        (void*, void*);
  51 static void                             (*qpng_read_image)                      (void*, unsigned char**);
  52 static void                             (*qpng_read_end)                        (void*, void*);
  53 static void                             (*qpng_destroy_read_struct)     (void**, void**, void**);
  54 static void                             (*qpng_destroy_write_struct)    (void**, void**);
  55 static void                             (*qpng_set_read_fn)                     (void*, void*, void(*)(void *png, unsigned char *data, size_t length));
  56 static void                             (*qpng_set_write_fn)            (void*, void*, void(*)(void *png, unsigned char *data, size_t length), void(*)(void *png));
  57 static unsigned int             (*qpng_get_valid)                       (void*, void*, unsigned int);
  58 static unsigned int             (*qpng_get_rowbytes)            (void*, void*);
  59 static unsigned char    (*qpng_get_channels)            (void*, void*);
  60 static unsigned char    (*qpng_get_bit_depth)           (void*, void*);
  61 static unsigned int             (*qpng_get_IHDR)                        (void*, void*, unsigned long*, unsigned long*, int *, int *, int *, int *, int *);
  62 static unsigned int                     (*qpng_access_version_number)           (void); // FIXME is this return type right? It is a png_uint_32 in libpng
  63 static void                             (*qpng_write_info)                      (void*, void*);
  64 static void                             (*qpng_write_row)                       (void*, unsigned char*);
  65 static void                             (*qpng_write_end)                       (void*, void*);
  66
  67 static dllfunction_t pngfuncs[] =
  68 {
  69         {"png_set_sig_bytes",           (void **) &qpng_set_sig_bytes},
  70         {"png_sig_cmp",                         (void **) &qpng_sig_cmp},
  71         {"png_create_read_struct",      (void **) &qpng_create_read_struct},
  72         {"png_create_write_struct",     (void **) &qpng_create_write_struct},
  73         {"png_create_info_struct",      (void **) &qpng_create_info_struct},
  74         {"png_read_info",                       (void **) &qpng_read_info},
  75         {"png_set_compression_level",   (void **) &qpng_set_compression_level},
  76         {"png_set_filter",                      (void **) &qpng_set_filter},
  77         {"png_set_expand",                      (void **) &qpng_set_expand},
  78         {"png_set_palette_to_rgb",      (void **) &qpng_set_palette_to_rgb},
  79         {"png_set_tRNS_to_alpha",       (void **) &qpng_set_tRNS_to_alpha},
  80         {"png_set_gray_to_rgb",         (void **) &qpng_set_gray_to_rgb},
  81         {"png_set_filler",                      (void **) &qpng_set_filler},
  82         {"png_set_IHDR",                        (void **) &qpng_set_IHDR},
  83         {"png_set_packing",                     (void **) &qpng_set_packing},
  84         {"png_set_bgr",                         (void **) &qpng_set_bgr},
  85         {"png_set_interlace_handling",  (void **) &qpng_set_interlace_handling},
  86         {"png_read_update_info",        (void **) &qpng_read_update_info},
  87         {"png_read_image",                      (void **) &qpng_read_image},
  88         {"png_read_end",                        (void **) &qpng_read_end},
  89         {"png_destroy_read_struct",     (void **) &qpng_destroy_read_struct},
  90         {"png_destroy_write_struct",    (void **) &qpng_destroy_write_struct},
  91         {"png_set_read_fn",                     (void **) &qpng_set_read_fn},
  92         {"png_set_write_fn",            (void **) &qpng_set_write_fn},
  93         {"png_get_valid",                       (void **) &qpng_get_valid},
  94         {"png_get_rowbytes",            (void **) &qpng_get_rowbytes},
  95         {"png_get_channels",            (void **) &qpng_get_channels},
  96         {"png_get_bit_depth",           (void **) &qpng_get_bit_depth},
  97         {"png_get_IHDR",                        (void **) &qpng_get_IHDR},
  98         {"png_access_version_number",           (void **) &qpng_access_version_number},
  99         {"png_write_info",                      (void **) &qpng_write_info},
 100         {"png_write_row",                       (void **) &qpng_write_row},
 101         {"png_write_end",                       (void **) &qpng_write_end},
 102         {NULL, NULL}
 103 };
 104
 105 // Handle for PNG DLL
 106 dllhandle_t png_dll = NULL;
 107
 108
 109 /*
 110 =================================================================
 111
 112   DLL load & unload
 113
 114 =================================================================
 115 */
 116
 117 /*
 118 ====================
 119 PNG_OpenLibrary
 120
 121 Try to load the PNG DLL
 122 ====================
 123 */
 124 qboolean PNG_OpenLibrary (void)
 125 {
 126         const char* dllnames [] =
 127         {
 128 #if WIN32
 129                 "libpng14.dll",
 130                 "libpng12.dll",
 131 #elif defined(MACOSX)
 132                 "libpng14.14.dylib",
 133                 "libpng12.0.dylib",
 134 #else
 135                 "libpng14.so.14", // WTF libtool guidelines anyone?
 136                 "libpng12.so.0",
 137                 "libpng.so", // FreeBSD
 138 #endif
 139                 NULL
 140         };
 141
 142         // Already loaded?
 143         if (png_dll)
 144                 return true;
 145
 146         // Load the DLL
 147         return Sys_LoadLibrary (dllnames, &png_dll, pngfuncs);
 148 }
 149
 150
 151 /*
 152 ====================
 153 PNG_CloseLibrary
 154
 155 Unload the PNG DLL
 156 ====================
 157 */
 158 void PNG_CloseLibrary (void)
 159 {
 160         Sys_UnloadLibrary (&png_dll);
 161 }
 162
 163 /*
 164 =================================================================
 165
 166         PNG decompression
 167
 168 =================================================================
 169 */
 170
 171 #define PNG_LIBPNG_VER_STRING_12 "1.2.4"
 172 #define PNG_LIBPNG_VER_STRING_14 "1.4.0"
 173
 174 #define PNG_COLOR_MASK_PALETTE    1
 175 #define PNG_COLOR_MASK_COLOR      2
 176 #define PNG_COLOR_MASK_ALPHA      4
 177
 178 #define PNG_COLOR_TYPE_GRAY 0
 179 #define PNG_COLOR_TYPE_PALETTE  (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_PALETTE)
 180 #define PNG_COLOR_TYPE_RGB        (PNG_COLOR_MASK_COLOR)
 181 #define PNG_COLOR_TYPE_RGB_ALPHA  (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_ALPHA)
 182 #define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
 183
 184 #define PNG_COLOR_TYPE_RGBA  PNG_COLOR_TYPE_RGB_ALPHA
 185 #define PNG_COLOR_TYPE_GA  PNG_COLOR_TYPE_GRAY_ALPHA
 186
 187 #define PNG_INFO_tRNS 0x0010
 188
 189 // this struct is only used for status information during loading
 190 static struct
 191 {
 192         const unsigned char     *tmpBuf;
 193         int             tmpBuflength;
 194         int             tmpi;
 195         //int           FBgColor;
 196         //int           FTransparent;
 197         unsigned int    FRowBytes;
 198         //double        FGamma;
 199         //double        FScreenGamma;
 200         unsigned char   **FRowPtrs;
 201         unsigned char   *Data;
 202         //char  *Title;
 203         //char  *Author;
 204         //char  *Description;
 205         int             BitDepth;
 206         int             BytesPerPixel;
 207         int             ColorType;
 208         unsigned long   Height; // retarded libpng 1.2 pngconf.h uses long (64bit/32bit depending on arch)
 209         unsigned long   Width; // retarded libpng 1.2 pngconf.h uses long (64bit/32bit depending on arch)
 210         int             Interlace;
 211         int             Compression;
 212         int             Filter;
 213         //double        LastModified;
 214         //int           Transparent;
 215         qfile_t *outfile;
 216 } my_png;
 217
 218 //LordHavoc: removed __cdecl prefix, added overrun protection, and rewrote this to be more efficient
 219 void PNG_fReadData(void *png, unsigned char *data, size_t length)
 220 {
 221         size_t l;
 222         l = my_png.tmpBuflength - my_png.tmpi;
 223         if (l < length)
 224         {
 225                 Con_Printf("PNG_fReadData: overrun by %i bytes\n", (int)(length - l));
 226                 // a read going past the end of the file, fill in the remaining bytes
 227                 // with 0 just to be consistent
 228                 memset(data + l, 0, length - l);
 229                 length = l;
 230         }
 231         memcpy(data, my_png.tmpBuf + my_png.tmpi, length);
 232         my_png.tmpi += (int)length;
 233         //Com_HexDumpToConsole(data, (int)length);
 234 }
 235
 236 void PNG_fWriteData(void *png, unsigned char *data, size_t length)
 237 {
 238         FS_Write(my_png.outfile, data, length);
 239 }
 240
 241 void PNG_fFlushData(void *png)
 242 {
 243 }
 244
 245 void PNG_error_fn(void *png, const char *message)
 246 {
 247         Con_Printf("PNG_LoadImage: error: %s\n", message);
 248 }
 249
 250 void PNG_warning_fn(void *png, const char *message)
 251 {
 252         Con_Printf("PNG_LoadImage: warning: %s\n", message);
 253 }
 254
 255 extern int      image_width;
 256 extern int      image_height;
 257
 258 unsigned char *PNG_LoadImage_BGRA (const unsigned char *raw, int filesize, int *miplevel)
 259 {
 260         unsigned int c;
 261         unsigned int    y;
 262         void *png, *pnginfo;
 263         unsigned char *imagedata = NULL;
 264         unsigned char ioBuffer[8192];
 265
 266         // FIXME: register an error handler so that abort() won't be called on error
 267
 268         // No DLL = no PNGs
 269         if (!png_dll)
 270                 return NULL;
 271
 272         if(qpng_sig_cmp(raw, 0, filesize))
 273                 return NULL;
 274         png = (void *)qpng_create_read_struct(
 275                 (qpng_access_version_number() / 100 == 102) ? PNG_LIBPNG_VER_STRING_12 : PNG_LIBPNG_VER_STRING_14, // nasty hack to support both libpng12 and libpng14
 276                 0, PNG_error_fn, PNG_warning_fn
 277         );
 278         if(!png)
 279                 return NULL;
 280
 281         // this must be memset before the setjmp error handler, because it relies
 282         // on the fields in this struct for cleanup
 283         memset(&my_png, 0, sizeof(my_png));
 284
 285         // NOTE: this relies on jmp_buf being the first thing in the png structure
 286         // created by libpng! (this is correct for libpng 1.2.x)
 287 #ifdef __cplusplus
 288 #if defined(MACOSX) || defined(WIN32)
 289         if (setjmp((int *)png))
 290 #else
 291         if (setjmp((__jmp_buf_tag *)png))
 292 #endif
 293 #else
 294         if (setjmp(png))
 295 #endif
 296         {
 297                 if (my_png.Data)
 298                         Mem_Free(my_png.Data);
 299                 my_png.Data = NULL;
 300                 if (my_png.FRowPtrs)
 301                         Mem_Free(my_png.FRowPtrs);
 302                 my_png.FRowPtrs = NULL;
 303                 qpng_destroy_read_struct(&png, &pnginfo, 0);
 304                 return NULL;
 305         }
 306         //
 307
 308         pnginfo = qpng_create_info_struct(png);
 309         if(!pnginfo)
 310         {
 311                 qpng_destroy_read_struct(&png, &pnginfo, 0);
 312                 return NULL;
 313         }
 314         qpng_set_sig_bytes(png, 0);
 315
 316         my_png.tmpBuf = raw;
 317         my_png.tmpBuflength = filesize;
 318         my_png.tmpi = 0;
 319         //my_png.Data           = NULL;
 320         //my_png.FRowPtrs       = NULL;
 321         //my_png.Height         = 0;
 322         //my_png.Width          = 0;
 323         my_png.ColorType        = PNG_COLOR_TYPE_RGB;
 324         //my_png.Interlace      = 0;
 325         //my_png.Compression    = 0;
 326         //my_png.Filter         = 0;
 327         qpng_set_read_fn(png, ioBuffer, PNG_fReadData);
 328         qpng_read_info(png, pnginfo);
 329         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);
 330
 331         // 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
 332         // (if it's little endian the unwritten bytes are the most significant
 333         //  ones and we don't worry about that)
 334         //
 335         // this is only necessary because of retarded 64bit png_uint_32 types in libpng 1.2, which can (conceivably) vary by platform
 336 #if LONG_MAX > 4000000000
 337         if (my_png.Width > LONG_MAX || my_png.Height > LONG_MAX)
 338         {
 339                 my_png.Width >>= 32;
 340                 my_png.Height >>= 32;
 341         }
 342 #endif
 343
 344         if (my_png.ColorType == PNG_COLOR_TYPE_PALETTE)
 345                 qpng_set_palette_to_rgb(png);
 346         if (my_png.ColorType == PNG_COLOR_TYPE_GRAY || my_png.ColorType == PNG_COLOR_TYPE_GRAY_ALPHA)
 347                 qpng_set_gray_to_rgb(png);
 348         if (qpng_get_valid(png, pnginfo, PNG_INFO_tRNS))
 349                 qpng_set_tRNS_to_alpha(png);
 350         if (my_png.BitDepth == 8 && !(my_png.ColorType  & PNG_COLOR_MASK_ALPHA))
 351                 qpng_set_filler(png, 255, 1);
 352         if (( my_png.ColorType == PNG_COLOR_TYPE_GRAY) || (my_png.ColorType == PNG_COLOR_TYPE_GRAY_ALPHA ))
 353                 qpng_set_gray_to_rgb(png);
 354         if (my_png.BitDepth < 8)
 355                 qpng_set_expand(png);
 356
 357         qpng_read_update_info(png, pnginfo);
 358
 359         my_png.FRowBytes = qpng_get_rowbytes(png, pnginfo);
 360         my_png.BytesPerPixel = qpng_get_channels(png, pnginfo);
 361
 362         my_png.FRowPtrs = (unsigned char **)Mem_Alloc(tempmempool, my_png.Height * sizeof(*my_png.FRowPtrs));
 363         if (my_png.FRowPtrs)
 364         {
 365                 imagedata = (unsigned char *)Mem_Alloc(tempmempool, my_png.Height * my_png.FRowBytes);
 366                 if(imagedata)
 367                 {
 368                         my_png.Data = imagedata;
 369                         for(y = 0;y < my_png.Height;y++)
 370                                 my_png.FRowPtrs[y] = my_png.Data + y * my_png.FRowBytes;
 371                         qpng_read_image(png, my_png.FRowPtrs);
 372                 }
 373                 else
 374                 {
 375                         Con_Printf("PNG_LoadImage : not enough memory\n");
 376                         qpng_destroy_read_struct(&png, &pnginfo, 0);
 377                         Mem_Free(my_png.FRowPtrs);
 378                         return NULL;
 379                 }
 380                 Mem_Free(my_png.FRowPtrs);
 381                 my_png.FRowPtrs = NULL;
 382         }
 383         else
 384         {
 385                 Con_Printf("PNG_LoadImage : not enough memory\n");
 386                 qpng_destroy_read_struct(&png, &pnginfo, 0);
 387                 return NULL;
 388         }
 389
 390         qpng_read_end(png, pnginfo);
 391         qpng_destroy_read_struct(&png, &pnginfo, 0);
 392
 393         image_width = (int)my_png.Width;
 394         image_height = (int)my_png.Height;
 395
 396         if (my_png.BitDepth != 8)
 397         {
 398                 Con_Printf ("PNG_LoadImage : bad color depth\n");
 399                 Mem_Free(imagedata);
 400                 return NULL;
 401         }
 402
 403         // swizzle RGBA to BGRA
 404         for (y = 0;y < (unsigned int)(image_width*image_height*4);y += 4)
 405         {
 406                 c = imagedata[y+0];
 407                 imagedata[y+0] = imagedata[y+2];
 408                 imagedata[y+2] = c;
 409         }
 410
 411         return imagedata;
 412 }
 413
 414 /*
 415 =================================================================
 416
 417         PNG compression
 418
 419 =================================================================
 420 */
 421
 422 #define Z_BEST_SPEED 1
 423 #define Z_BEST_COMPRESSION 9
 424 #define PNG_INTERLACE_NONE 0
 425 #define PNG_INTERLACE_ADAM7 1
 426 #define PNG_FILTER_TYPE_BASE 0
 427 #define PNG_FILTER_TYPE_DEFAULT PNG_FILTER_TYPE_BASE
 428 #define PNG_COMPRESSION_TYPE_BASE 0
 429 #define PNG_COMPRESSION_TYPE_DEFAULT PNG_COMPRESSION_TYPE_BASE
 430 #define PNG_NO_FILTERS     0x00
 431 #define PNG_FILTER_NONE    0x08
 432 #define PNG_FILTER_SUB     0x10
 433 #define PNG_FILTER_UP      0x20
 434 #define PNG_FILTER_AVG     0x40
 435 #define PNG_FILTER_PAETH   0x80
 436 #define PNG_ALL_FILTERS (PNG_FILTER_NONE | PNG_FILTER_SUB | PNG_FILTER_UP | \
 437                          PNG_FILTER_AVG | PNG_FILTER_PAETH)
 438
 439 /*
 440 ====================
 441 PNG_SaveImage_preflipped
 442
 443 Save a preflipped PNG image to a file
 444 ====================
 445 */
 446 qboolean PNG_SaveImage_preflipped (const char *filename, int width, int height, qboolean has_alpha, unsigned char *data)
 447 {
 448         unsigned int offset, linesize;
 449         qfile_t* file = NULL;
 450         void *png, *pnginfo;
 451         unsigned char ioBuffer[8192];
 452         int passes, i, j;
 453
 454         // No DLL = no JPEGs
 455         if (!png_dll)
 456         {
 457                 Con_Print("You need the libpng library to save PNG images\n");
 458                 return false;
 459         }
 460
 461         png = (void *)qpng_create_write_struct(
 462                 (qpng_access_version_number() / 100 == 102) ? PNG_LIBPNG_VER_STRING_12 : PNG_LIBPNG_VER_STRING_14, // nasty hack to support both libpng12 and libpng14
 463                 0, PNG_error_fn, PNG_warning_fn
 464         );
 465         if(!png)
 466                 return false;
 467         pnginfo = (void *)qpng_create_info_struct(png);
 468         if(!pnginfo)
 469         {
 470                  qpng_destroy_write_struct(&png, NULL);
 471                  return false;
 472         }
 473
 474         // this must be memset before the setjmp error handler, because it relies
 475         // on the fields in this struct for cleanup
 476         memset(&my_png, 0, sizeof(my_png));
 477
 478         // NOTE: this relies on jmp_buf being the first thing in the png structure
 479         // created by libpng! (this is correct for libpng 1.2.x)
 480 #ifdef __cplusplus
 481 #if defined(MACOSX) || defined(WIN32)
 482         if (setjmp((int *)png))
 483 #else
 484         if (setjmp((__jmp_buf_tag *)png))
 485 #endif
 486 #else
 487         if (setjmp(png))
 488 #endif
 489         {
 490                 qpng_destroy_write_struct(&png, &pnginfo);
 491                 return false;
 492         }
 493
 494         // Open the file
 495         file = FS_OpenRealFile(filename, "wb", true);
 496         if (!file)
 497                 return false;
 498         my_png.outfile = file;
 499         qpng_set_write_fn(png, ioBuffer, PNG_fWriteData, PNG_fFlushData);
 500
 501         //qpng_set_compression_level(png, Z_BEST_COMPRESSION);
 502         qpng_set_compression_level(png, Z_BEST_SPEED);
 503         qpng_set_IHDR(png, pnginfo, width, height, 8, has_alpha ? PNG_COLOR_TYPE_RGB_ALPHA : PNG_COLOR_TYPE_RGB, PNG_INTERLACE_ADAM7, PNG_COMPRESSION_TYPE_DEFAULT, PNG_FILTER_TYPE_DEFAULT);
 504         qpng_set_filter(png, 0, PNG_NO_FILTERS);
 505         qpng_write_info(png, pnginfo);
 506         qpng_set_packing(png);
 507         qpng_set_bgr(png);
 508
 509         passes = qpng_set_interlace_handling(png);
 510
 511         linesize = width * (has_alpha ? 4 : 3);
 512         offset = linesize * (height - 1);
 513         for(i = 0; i < passes; ++i)
 514                 for(j = 0; j < height; ++j)
 515                         qpng_write_row(png, &data[offset - j * linesize]);
 516
 517         qpng_write_end(png, NULL);
 518         qpng_destroy_write_struct(&png, &pnginfo);
 519
 520         FS_Close (file);
 521
 522         return true;
 523 }