tools/quake3/q3map2/image.c

   1 /* -------------------------------------------------------------------------------
   2
   3    Copyright (C) 1999-2007 id Software, Inc. and contributors.
   4    For a list of contributors, see the accompanying CONTRIBUTORS file.
   5
   6    This file is part of GtkRadiant.
   7
   8    GtkRadiant is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2 of the License, or
  11    (at your option) any later version.
  12
  13    GtkRadiant is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with GtkRadiant; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  21
  22    ----------------------------------------------------------------------------------
  23
  24    This code has been altered significantly from its original form, to support
  25    several games based on the Quake III Arena engine, in the form of "Q3Map2."
  26
  27    ------------------------------------------------------------------------------- */
  28
  29
  30
  31 /* marker */
  32 #define IMAGE_C
  33
  34
  35
  36 /* dependencies */
  37 #include "q3map2.h"
  38
  39 #include "webp/decode.h"
  40
  41 /* -------------------------------------------------------------------------------
  42
  43    this file contains image pool management with reference counting. note: it isn't
  44    reentrant, so only call it from init/shutdown code or wrap calls in a mutex
  45
  46    ------------------------------------------------------------------------------- */
  47
  48 /*
  49    LoadDDSBuffer()
  50    loads a dxtc (1, 3, 5) dds buffer into a valid rgba image
  51  */
  52
  53 static void LoadDDSBuffer( byte *buffer, int size, byte **pixels, int *width, int *height ){
  54         int w, h;
  55         ddsPF_t pf;
  56
  57
  58         /* dummy check */
  59         if ( buffer == NULL || size <= 0 || pixels == NULL || width == NULL || height == NULL ) {
  60                 return;
  61         }
  62
  63         /* null out */
  64         *pixels = 0;
  65         *width = 0;
  66         *height = 0;
  67
  68         /* get dds info */
  69         if ( DDSGetInfo( (ddsBuffer_t*) buffer, &w, &h, &pf ) ) {
  70                 Sys_FPrintf( SYS_WRN, "WARNING: Invalid DDS texture\n" );
  71                 return;
  72         }
  73
  74         /* only certain types of dds textures are supported */
  75         if ( pf != DDS_PF_ARGB8888 && pf != DDS_PF_DXT1 && pf != DDS_PF_DXT3 && pf != DDS_PF_DXT5 ) {
  76                 Sys_FPrintf( SYS_WRN, "WARNING: Only DDS texture formats ARGB8888, DXT1, DXT3, and DXT5 are supported (%d)\n", pf );
  77                 return;
  78         }
  79
  80         /* create image pixel buffer */
  81         *width = w;
  82         *height = h;
  83         *pixels = safe_malloc( w * h * 4 );
  84
  85         /* decompress the dds texture */
  86         DDSDecompress( (ddsBuffer_t*) buffer, *pixels );
  87 }
  88
  89 #ifdef BUILD_CRUNCH
  90 /*
  91     LoadCRNBuffer
  92     loads a crn image into a valid rgba image
  93 */
  94 void LoadCRNBuffer( byte *buffer, int size, byte **pixels, int *width, int *height) {
  95         /* dummy check */
  96         if ( buffer == NULL || size <= 0 || pixels == NULL || width == NULL || height == NULL ) {
  97                 return;
  98         }
  99         if ( !GetCRNImageSize( buffer, size, width, height ) ) {
 100                 Sys_FPrintf( SYS_WRN, "WARNING: Error getting crn imag dimensions.\n");;
 101                 return;
 102         }
 103         int outBufSize = *width * *height * 4;
 104         *pixels = safe_malloc( outBufSize );
 105         if ( !ConvertCRNtoRGBA( buffer, size, outBufSize, *pixels) ) {
 106                 Sys_FPrintf( SYS_WRN, "WARNING: Error decoding crn image.\n", 0 );
 107                 return;
 108         }
 109 }
 110 #endif // BUILD_CRUNCH
 111
 112
 113 /*
 114    PNGReadData()
 115    callback function for libpng to read from a memory buffer
 116    note: this function is a total hack, as it reads/writes the png struct directly!
 117  */
 118
 119 typedef struct pngBuffer_s
 120 {
 121         byte    *buffer;
 122         png_size_t size, offset;
 123 } pngBuffer_t;
 124
 125 void PNGReadData( png_struct *png, png_byte *buffer, png_size_t size ){
 126         pngBuffer_t     *pb = (pngBuffer_t*) png_get_io_ptr( png );
 127
 128
 129         if ( ( pb->offset + size ) > pb->size ) {
 130                 size = ( pb->size - pb->offset );
 131         }
 132         memcpy( buffer, &pb->buffer[ pb->offset ], size );
 133         pb->offset += size;
 134         //%     Sys_Printf( "Copying %d bytes from 0x%08X to 0x%08X (offset: %d of %d)\n", size, &pb->buffer[ pb->offset ], buffer, pb->offset, pb->size );
 135 }
 136
 137
 138
 139 /*
 140    LoadPNGBuffer()
 141    loads a png file buffer into a valid rgba image
 142  */
 143
 144 static void LoadPNGBuffer( byte *buffer, int size, byte **pixels, int *width, int *height ){
 145         png_struct  *png;
 146         png_info    *info, *end;
 147         pngBuffer_t pb;
 148         int bitDepth, colorType;
 149         png_uint_32 w, h, i;
 150         byte        **rowPointers;
 151
 152         /* dummy check */
 153         if ( buffer == NULL || size <= 0 || pixels == NULL || width == NULL || height == NULL ) {
 154                 return;
 155         }
 156
 157         /* null out */
 158         *pixels = 0;
 159         *width = 0;
 160         *height = 0;
 161
 162         /* determine if this is a png file */
 163         if ( png_sig_cmp( buffer, 0, 8 ) != 0 ) {
 164                 Sys_FPrintf( SYS_WRN, "WARNING: Invalid PNG file\n" );
 165                 return;
 166         }
 167
 168         /* create png structs */
 169         png = png_create_read_struct( PNG_LIBPNG_VER_STRING, NULL, NULL, NULL );
 170         if ( png == NULL ) {
 171                 Sys_FPrintf( SYS_WRN, "WARNING: Unable to create PNG read struct\n" );
 172                 return;
 173         }
 174
 175         info = png_create_info_struct( png );
 176         if ( info == NULL ) {
 177                 Sys_FPrintf( SYS_WRN, "WARNING: Unable to create PNG info struct\n" );
 178                 png_destroy_read_struct( &png, NULL, NULL );
 179                 return;
 180         }
 181
 182         end = png_create_info_struct( png );
 183         if ( end == NULL ) {
 184                 Sys_FPrintf( SYS_WRN, "WARNING: Unable to create PNG end info struct\n" );
 185                 png_destroy_read_struct( &png, &info, NULL );
 186                 return;
 187         }
 188
 189         /* set read callback */
 190         pb.buffer = buffer;
 191         pb.size = size;
 192         pb.offset = 0;
 193         png_set_read_fn( png, &pb, PNGReadData );
 194
 195         /* set error longjmp */
 196         if ( setjmp( png_jmpbuf(png) ) ) {
 197                 Sys_FPrintf( SYS_WRN, "WARNING: An error occurred reading PNG image\n" );
 198                 png_destroy_read_struct( &png, &info, &end );
 199                 return;
 200         }
 201
 202         /* fixme: add proper i/o stuff here */
 203
 204         /* read png info */
 205         png_read_info( png, info );
 206
 207         /* read image header chunk */
 208         png_get_IHDR( png, info,
 209                                   &w, &h, &bitDepth, &colorType, NULL, NULL, NULL );
 210
 211         /* the following will probably bork on certain types of png images, but hey... */
 212
 213         /* force indexed/gray/trans chunk to rgb */
 214         if ( ( colorType == PNG_COLOR_TYPE_PALETTE && bitDepth <= 8 ) ||
 215                  ( colorType == PNG_COLOR_TYPE_GRAY && bitDepth <= 8 ) ||
 216                  png_get_valid( png, info, PNG_INFO_tRNS ) ) {
 217                 png_set_expand( png );
 218         }
 219
 220         /* strip 16bpc -> 8bpc */
 221         if ( bitDepth == 16 ) {
 222                 png_set_strip_16( png );
 223         }
 224
 225         /* pad rgb to rgba */
 226         if ( bitDepth == 8 && colorType == PNG_COLOR_TYPE_RGB ) {
 227                 png_set_filler( png, 255, PNG_FILLER_AFTER );
 228         }
 229
 230         /* create image pixel buffer */
 231         *width = w;
 232         *height = h;
 233         *pixels = safe_malloc( w * h * 4 );
 234
 235         /* create row pointers */
 236         rowPointers = safe_malloc( h * sizeof( byte* ) );
 237         for ( i = 0; i < h; i++ )
 238                 rowPointers[ i ] = *pixels + ( i * w * 4 );
 239
 240         /* read the png */
 241         png_read_image( png, rowPointers );
 242
 243         /* clean up */
 244         free( rowPointers );
 245         png_destroy_read_struct( &png, &info, &end );
 246
 247 }
 248
 249
 250
 251 static void LoadWEBPBuffer( byte *buffer, int size, byte **pixels, int *width, int *height ){
 252
 253         int image_width;
 254         int image_height;
 255
 256         if ( !WebPGetInfo( buffer, ( size_t) size, &image_width, &image_height ) )
 257         {
 258                 Sys_FPrintf( SYS_WRN, "WARNING: An error occurred reading WEBP image info\n" );
 259                 return;
 260         }
 261
 262         /* create image pixel buffer */
 263         *pixels = safe_malloc( image_width * image_height * 4 );
 264         *width = image_width;
 265         *height = image_height;
 266
 267         int out_stride = image_width  * 4;
 268         int out_size =  image_height * out_stride;
 269
 270                 if ( !WebPDecodeRGBAInto( buffer, (size_t) size, *pixels, out_size, out_stride ) )
 271                 {
 272                 Sys_FPrintf( SYS_WRN, "WARNING: An error occurred reading WEBP image\n" );
 273                         return;
 274                 }
 275 }
 276
 277
 278
 279 /*
 280    ImageInit()
 281    implicitly called by every function to set up image list
 282  */
 283
 284 static void ImageInit( void ){
 285         int i;
 286
 287
 288         if ( numImages <= 0 ) {
 289                 /* clear images (fixme: this could theoretically leak) */
 290                 memset( images, 0, sizeof( images ) );
 291
 292                 /* generate *bogus image */
 293                 images[ 0 ].name = safe_malloc( strlen( DEFAULT_IMAGE ) + 1 );
 294                 strcpy( images[ 0 ].name, DEFAULT_IMAGE );
 295                 images[ 0 ].filename = safe_malloc( strlen( DEFAULT_IMAGE ) + 1 );
 296                 strcpy( images[ 0 ].filename, DEFAULT_IMAGE );
 297                 images[ 0 ].width = 64;
 298                 images[ 0 ].height = 64;
 299                 images[ 0 ].refCount = 1;
 300                 images[ 0 ].pixels = safe_malloc( 64 * 64 * 4 );
 301                 for ( i = 0; i < ( 64 * 64 * 4 ); i++ )
 302                         images[ 0 ].pixels[ i ] = 255;
 303         }
 304 }
 305
 306
 307
 308 /*
 309    ImageFree()
 310    frees an rgba image
 311  */
 312
 313 void ImageFree( image_t *image ){
 314         /* dummy check */
 315         if ( image == NULL ) {
 316                 return;
 317         }
 318
 319         /* decrement refcount */
 320         image->refCount--;
 321
 322         /* free? */
 323         if ( image->refCount <= 0 ) {
 324                 if ( image->name != NULL ) {
 325                         free( image->name );
 326                 }
 327                 image->name = NULL;
 328                 if ( image->filename != NULL ) {
 329                         free( image->filename );
 330                 }
 331                 image->filename = NULL;
 332                 free( image->pixels );
 333                 image->width = 0;
 334                 image->height = 0;
 335                 numImages--;
 336         }
 337 }
 338
 339
 340
 341 /*
 342    ImageFind()
 343    finds an existing rgba image and returns a pointer to the image_t struct or NULL if not found
 344  */
 345
 346 image_t *ImageFind( const char *filename ){
 347         int i;
 348         char name[ 1024 ];
 349
 350
 351         /* init */
 352         ImageInit();
 353
 354         /* dummy check */
 355         if ( filename == NULL || filename[ 0 ] == '\0' ) {
 356                 return NULL;
 357         }
 358
 359         /* strip file extension off name */
 360         strcpy( name, filename );
 361         StripExtension( name );
 362
 363         /* search list */
 364         for ( i = 0; i < MAX_IMAGES; i++ )
 365         {
 366                 if ( images[ i ].name != NULL && !strcmp( name, images[ i ].name ) ) {
 367                         return &images[ i ];
 368                 }
 369         }
 370
 371         /* no matching image found */
 372         return NULL;
 373 }
 374
 375
 376
 377 /*
 378    ImageLoad()
 379    loads an rgba image and returns a pointer to the image_t struct or NULL if not found
 380  */
 381
 382 image_t *ImageLoad( const char *filename ){
 383         int i;
 384         image_t     *image;
 385         char name[ 1024 ];
 386         int size;
 387         byte        *buffer = NULL;
 388         qboolean alphaHack = qfalse;
 389
 390
 391         /* init */
 392         ImageInit();
 393
 394         /* dummy check */
 395         if ( filename == NULL || filename[ 0 ] == '\0' ) {
 396                 return NULL;
 397         }
 398
 399         /* strip file extension off name */
 400         strcpy( name, filename );
 401         StripExtension( name );
 402
 403         /* try to find existing image */
 404         image = ImageFind( name );
 405         if ( image != NULL ) {
 406                 image->refCount++;
 407                 return image;
 408         }
 409
 410         /* none found, so find first non-null image */
 411         image = NULL;
 412         for ( i = 0; i < MAX_IMAGES; i++ )
 413         {
 414                 if ( images[ i ].name == NULL ) {
 415                         image = &images[ i ];
 416                         break;
 417                 }
 418         }
 419
 420         /* too many images? */
 421         if ( image == NULL ) {
 422                 Error( "MAX_IMAGES (%d) exceeded, there are too many image files referenced by the map.", MAX_IMAGES );
 423         }
 424
 425         /* set it up */
 426         image->name = safe_malloc( strlen( name ) + 1 );
 427         strcpy( image->name, name );
 428
 429         /* attempt to load tga */
 430         StripExtension( name );
 431         strcat( name, ".tga" );
 432         size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
 433         if ( size > 0 ) {
 434                 LoadTGABuffer( buffer, buffer + size, &image->pixels, &image->width, &image->height );
 435                 goto image_load_success;
 436         }
 437
 438         /* attempt to load png */
 439         StripExtension( name );
 440         strcat( name, ".png" );
 441         size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
 442         if ( size > 0 ) {
 443                 LoadPNGBuffer( buffer, size, &image->pixels, &image->width, &image->height );
 444                 goto image_load_success;
 445         }
 446
 447         /* attempt to load jpg */
 448         StripExtension( name );
 449         strcat( name, ".jpg" );
 450         size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
 451         if ( size > 0 ) {
 452                 if ( LoadJPGBuff( buffer, size, &image->pixels, &image->width, &image->height ) == -1 && image->pixels != NULL ) {
 453                         // On error, LoadJPGBuff might store a pointer to the error message in image->pixels
 454                         Sys_FPrintf( SYS_WRN, "WARNING: LoadJPGBuff: %s\n", (unsigned char*) image->pixels );
 455                 }
 456                 alphaHack = qtrue;
 457                 goto image_load_success;
 458         }
 459
 460         /* attempt to load dds */
 461         StripExtension( name );
 462         strcat( name, ".dds" );
 463         size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
 464         if ( size > 0 ) {
 465                 LoadDDSBuffer( buffer, size, &image->pixels, &image->width, &image->height );
 466                 goto image_load_success;
 467         }
 468
 469         /* attempt to load ktx */
 470         StripExtension( name );
 471         strcat( name, ".ktx" );
 472         size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
 473         if ( size > 0 ) {
 474                 LoadKTXBufferFirstImage( buffer, size, &image->pixels, &image->width, &image->height );
 475                 goto image_load_success;
 476         }
 477
 478         #ifdef BUILD_CRUNCH
 479         /* attempt to load crn */
 480         StripExtension( name );
 481         strcat( name, ".crn" );
 482         size = vfsLoadFile( ( const char* ) name, ( void** ) &buffer, 0 );
 483         if ( size > 0 ) {
 484                 LoadCRNBuffer( buffer, size, &image->pixels, &image->width, &image->height );
 485                 goto image_load_success;
 486         }
 487         #endif // BUILD_CRUNCH
 488
 489         /* attempt to load webp */
 490         StripExtension( name );
 491         strcat( name, ".webp" );
 492         size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
 493         if ( size > 0 ) {
 494                 LoadWEBPBuffer( buffer, size, &image->pixels, &image->width, &image->height );
 495                 goto image_load_success;
 496         }
 497
 498         image_load_success:
 499
 500         /* free file buffer */
 501         free( buffer );
 502
 503         /* make sure everything's kosher */
 504         if ( size <= 0 || image->width <= 0 || image->height <= 0 || image->pixels == NULL ) {
 505                 //%     Sys_Printf( "size = %d  width = %d  height = %d  pixels = 0x%08x (%s)\n",
 506                 //%             size, image->width, image->height, image->pixels, name );
 507                 free( image->name );
 508                 image->name = NULL;
 509                 return NULL;
 510         }
 511
 512         /* set filename */
 513         image->filename = safe_malloc( strlen( name ) + 1 );
 514         strcpy( image->filename, name );
 515
 516         /* set count */
 517         image->refCount = 1;
 518         numImages++;
 519
 520         if ( alphaHack ) {
 521                 StripExtension( name );
 522                 strcat( name, "_alpha.jpg" );
 523                 size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
 524                 if ( size > 0 ) {
 525                         unsigned char *pixels;
 526                         int width, height;
 527                         if ( LoadJPGBuff( buffer, size, &pixels, &width, &height ) == -1 ) {
 528                                 if (pixels) {
 529                                         // On error, LoadJPGBuff might store a pointer to the error message in pixels
 530                                         Sys_FPrintf( SYS_WRN, "WARNING: LoadJPGBuff %s %s\n", name, (unsigned char*) pixels );
 531                                 }
 532                         } else {
 533                                 if ( width == image->width && height == image->height ) {
 534                                         int i;
 535                                         for ( i = 0; i < width * height; ++i )
 536                                                 image->pixels[4 * i + 3] = pixels[4 * i + 2];  // copy alpha from blue channel
 537                                 }
 538                                 free( pixels );
 539                         }
 540                         free( buffer );
 541                 }
 542         }
 543
 544         /* return the image */
 545         return image;
 546 }