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
  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_Printf( "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_Printf( "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
  90
  91 /*
  92    PNGReadData()
  93    callback function for libpng to read from a memory buffer
  94    note: this function is a total hack, as it reads/writes the png struct directly!
  95  */
  96
  97 typedef struct pngBuffer_s
  98 {
  99         byte    *buffer;
 100         png_size_t size, offset;
 101 }
 102 pngBuffer_t;
 103
 104 void PNGReadData( png_struct *png, png_byte *buffer, png_size_t size ){
 105         pngBuffer_t     *pb = (pngBuffer_t*) png_get_io_ptr( png );
 106
 107
 108         if ( ( pb->offset + size ) > pb->size ) {
 109                 size = ( pb->size - pb->offset );
 110         }
 111         memcpy( buffer, &pb->buffer[ pb->offset ], size );
 112         pb->offset += size;
 113         //%     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 );
 114 }
 115
 116
 117
 118 /*
 119    LoadPNGBuffer()
 120    loads a png file buffer into a valid rgba image
 121  */
 122
 123 static void LoadPNGBuffer( byte *buffer, int size, byte **pixels, int *width, int *height ){
 124         png_struct  *png;
 125         png_info    *info, *end;
 126         pngBuffer_t pb;
 127         //pngBuffer_t     *pb = (pngBuffer_t*) png_get_io_ptr( png );
 128         int bitDepth, colorType;
 129         png_uint_32 w, h, i;
 130         byte        **rowPointers;
 131
 132         /* dummy check */
 133         if ( buffer == NULL || size <= 0 || pixels == NULL || width == NULL || height == NULL ) {
 134                 return;
 135         }
 136
 137         /* null out */
 138         *pixels = 0;
 139         *width = 0;
 140         *height = 0;
 141
 142         /* determine if this is a png file */
 143         if ( png_sig_cmp( buffer, 0, 8 ) != 0 ) {
 144                 Sys_Printf( "WARNING: Invalid PNG file\n" );
 145                 return;
 146         }
 147
 148         /* create png structs */
 149         png = png_create_read_struct( PNG_LIBPNG_VER_STRING, NULL, NULL, NULL );
 150         if ( png == NULL ) {
 151                 Sys_Printf( "WARNING: Unable to create PNG read struct\n" );
 152                 return;
 153         }
 154
 155         info = png_create_info_struct( png );
 156         if ( info == NULL ) {
 157                 Sys_Printf( "WARNING: Unable to create PNG info struct\n" );
 158                 png_destroy_read_struct( &png, NULL, NULL );
 159                 return;
 160         }
 161
 162         end = png_create_info_struct( png );
 163         if ( end == NULL ) {
 164                 Sys_Printf( "WARNING: Unable to create PNG end info struct\n" );
 165                 png_destroy_read_struct( &png, &info, NULL );
 166                 return;
 167         }
 168
 169         /* set read callback */
 170         pb.buffer = buffer;
 171         pb.size = size;
 172         pb.offset = 0;
 173         png_set_read_fn( png, &pb, PNGReadData );
 174         //png->io_ptr = &pb; /* hack! */
 175
 176         /* set error longjmp */
 177         if ( setjmp( png_jmpbuf(png) ) ) {
 178                 Sys_Printf( "WARNING: An error occurred reading PNG image\n" );
 179                 png_destroy_read_struct( &png, &info, &end );
 180                 return;
 181         }
 182
 183         /* fixme: add proper i/o stuff here */
 184
 185         /* read png info */
 186         png_read_info( png, info );
 187
 188         /* read image header chunk */
 189         png_get_IHDR( png, info,
 190                                   &w, &h, &bitDepth, &colorType, NULL, NULL, NULL );
 191
 192         /* the following will probably bork on certain types of png images, but hey... */
 193
 194         /* force indexed/gray/trans chunk to rgb */
 195         if ( ( colorType == PNG_COLOR_TYPE_PALETTE && bitDepth <= 8 ) ||
 196                  ( colorType == PNG_COLOR_TYPE_GRAY && bitDepth <= 8 ) ||
 197                  png_get_valid( png, info, PNG_INFO_tRNS ) ) {
 198                 png_set_expand( png );
 199         }
 200
 201         /* strip 16bpc -> 8bpc */
 202         if ( bitDepth == 16 ) {
 203                 png_set_strip_16( png );
 204         }
 205
 206         /* pad rgb to rgba */
 207         if ( bitDepth == 8 && colorType == PNG_COLOR_TYPE_RGB ) {
 208                 png_set_filler( png, 255, PNG_FILLER_AFTER );
 209         }
 210
 211         /* create image pixel buffer */
 212         *width = w;
 213         *height = h;
 214         *pixels = safe_malloc( w * h * 4 );
 215
 216         /* create row pointers */
 217         rowPointers = safe_malloc( h * sizeof( byte* ) );
 218         for ( i = 0; i < h; i++ )
 219                 rowPointers[ i ] = *pixels + ( i * w * 4 );
 220
 221         /* read the png */
 222         png_read_image( png, rowPointers );
 223
 224         /* clean up */
 225         free( rowPointers );
 226         png_destroy_read_struct( &png, &info, &end );
 227
 228 }
 229
 230
 231
 232 /*
 233    ImageInit()
 234    implicitly called by every function to set up image list
 235  */
 236
 237 static void ImageInit( void ){
 238         int i;
 239
 240
 241         if ( numImages <= 0 ) {
 242                 /* clear images (fixme: this could theoretically leak) */
 243                 memset( images, 0, sizeof( images ) );
 244
 245                 /* generate *bogus image */
 246                 images[ 0 ].name = safe_malloc( strlen( DEFAULT_IMAGE ) + 1 );
 247                 strcpy( images[ 0 ].name, DEFAULT_IMAGE );
 248                 images[ 0 ].filename = safe_malloc( strlen( DEFAULT_IMAGE ) + 1 );
 249                 strcpy( images[ 0 ].filename, DEFAULT_IMAGE );
 250                 images[ 0 ].width = 64;
 251                 images[ 0 ].height = 64;
 252                 images[ 0 ].refCount = 1;
 253                 images[ 0 ].pixels = safe_malloc( 64 * 64 * 4 );
 254                 for ( i = 0; i < ( 64 * 64 * 4 ); i++ )
 255                         images[ 0 ].pixels[ i ] = 255;
 256         }
 257 }
 258
 259
 260
 261 /*
 262    ImageFree()
 263    frees an rgba image
 264  */
 265
 266 void ImageFree( image_t *image ){
 267         /* dummy check */
 268         if ( image == NULL ) {
 269                 return;
 270         }
 271
 272         /* decrement refcount */
 273         image->refCount--;
 274
 275         /* free? */
 276         if ( image->refCount <= 0 ) {
 277                 if ( image->name != NULL ) {
 278                         free( image->name );
 279                 }
 280                 image->name = NULL;
 281                 if ( image->filename != NULL ) {
 282                         free( image->filename );
 283                 }
 284                 image->filename = NULL;
 285                 free( image->pixels );
 286                 image->width = 0;
 287                 image->height = 0;
 288                 numImages--;
 289         }
 290 }
 291
 292
 293
 294 /*
 295    ImageFind()
 296    finds an existing rgba image and returns a pointer to the image_t struct or NULL if not found
 297  */
 298
 299 image_t *ImageFind( const char *filename ){
 300         int i;
 301         char name[ 1024 ];
 302
 303
 304         /* init */
 305         ImageInit();
 306
 307         /* dummy check */
 308         if ( filename == NULL || filename[ 0 ] == '\0' ) {
 309                 return NULL;
 310         }
 311
 312         /* strip file extension off name */
 313         strcpy( name, filename );
 314         StripExtension( name );
 315
 316         /* search list */
 317         for ( i = 0; i < MAX_IMAGES; i++ )
 318         {
 319                 if ( images[ i ].name != NULL && !strcmp( name, images[ i ].name ) ) {
 320                         return &images[ i ];
 321                 }
 322         }
 323
 324         /* no matching image found */
 325         return NULL;
 326 }
 327
 328
 329
 330 /*
 331    ImageLoad()
 332    loads an rgba image and returns a pointer to the image_t struct or NULL if not found
 333  */
 334
 335 image_t *ImageLoad( const char *filename ){
 336         int i;
 337         image_t     *image;
 338         char name[ 1024 ];
 339         int size;
 340         byte        *buffer = NULL;
 341         qboolean alphaHack = qfalse;
 342
 343
 344         /* init */
 345         ImageInit();
 346
 347         /* dummy check */
 348         if ( filename == NULL || filename[ 0 ] == '\0' ) {
 349                 return NULL;
 350         }
 351
 352         /* strip file extension off name */
 353         strcpy( name, filename );
 354         StripExtension( name );
 355
 356         /* try to find existing image */
 357         image = ImageFind( name );
 358         if ( image != NULL ) {
 359                 image->refCount++;
 360                 return image;
 361         }
 362
 363         /* none found, so find first non-null image */
 364         image = NULL;
 365         for ( i = 0; i < MAX_IMAGES; i++ )
 366         {
 367                 if ( images[ i ].name == NULL ) {
 368                         image = &images[ i ];
 369                         break;
 370                 }
 371         }
 372
 373         /* too many images? */
 374         if ( image == NULL ) {
 375                 Error( "MAX_IMAGES (%d) exceeded, there are too many image files referenced by the map.", MAX_IMAGES );
 376         }
 377
 378         /* set it up */
 379         image->name = safe_malloc( strlen( name ) + 1 );
 380         strcpy( image->name, name );
 381
 382         /* attempt to load tga */
 383         StripExtension( name );
 384         strcat( name, ".tga" );
 385         size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
 386         if ( size > 0 ) {
 387                 LoadTGABuffer( buffer, buffer + size, &image->pixels, &image->width, &image->height );
 388         }
 389         else
 390         {
 391                 /* attempt to load png */
 392                 StripExtension( name );
 393                 strcat( name, ".png" );
 394                 size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
 395                 if ( size > 0 ) {
 396                         LoadPNGBuffer( buffer, size, &image->pixels, &image->width, &image->height );
 397                 }
 398                 else
 399                 {
 400                         /* attempt to load jpg */
 401                         StripExtension( name );
 402                         strcat( name, ".jpg" );
 403                         size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
 404                         if ( size > 0 ) {
 405                                 if ( LoadJPGBuff( buffer, size, &image->pixels, &image->width, &image->height ) == -1 && image->pixels != NULL ) {
 406                                         Sys_Printf( "WARNING: LoadJPGBuff: %s\n", (unsigned char*) image->pixels );
 407                                 }
 408                                 alphaHack = qtrue;
 409                         }
 410                         else
 411                         {
 412                                 /* attempt to load dds */
 413                                 StripExtension( name );
 414                                 strcat( name, ".dds" );
 415                                 size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
 416                                 if ( size > 0 ) {
 417                                         LoadDDSBuffer( buffer, size, &image->pixels, &image->width, &image->height );
 418
 419                                         /* debug code */
 420                                         #if 1
 421                                         {
 422                                                 ddsPF_t pf;
 423                                                 DDSGetInfo( (ddsBuffer_t*) buffer, NULL, NULL, &pf );
 424                                                 Sys_Printf( "pf = %d\n", pf );
 425                                                 if ( image->width > 0 ) {
 426                                                         StripExtension( name );
 427                                                         strcat( name, "_converted.tga" );
 428                                                         WriteTGA( "C:\\games\\quake3\\baseq3\\textures\\rad\\dds_converted.tga", image->pixels, image->width, image->height );
 429                                                 }
 430                                         }
 431                                         #endif
 432                                 }
 433                         }
 434                 }
 435         }
 436
 437         /* free file buffer */
 438         free( buffer );
 439
 440         /* make sure everything's kosher */
 441         if ( size <= 0 || image->width <= 0 || image->height <= 0 || image->pixels == NULL ) {
 442                 //%     Sys_Printf( "size = %d  width = %d  height = %d  pixels = 0x%08x (%s)\n",
 443                 //%             size, image->width, image->height, image->pixels, name );
 444                 free( image->name );
 445                 image->name = NULL;
 446                 return NULL;
 447         }
 448
 449         /* set filename */
 450         image->filename = safe_malloc( strlen( name ) + 1 );
 451         strcpy( image->filename, name );
 452
 453         /* set count */
 454         image->refCount = 1;
 455         numImages++;
 456
 457         if ( alphaHack ) {
 458                 StripExtension( name );
 459                 strcat( name, "_alpha.jpg" );
 460                 size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
 461                 if ( size > 0 ) {
 462                         unsigned char *pixels;
 463                         int width, height;
 464                         if ( LoadJPGBuff( buffer, size, &pixels, &width, &height ) == -1 && pixels != NULL ) {
 465                                 Sys_Printf( "WARNING: LoadJPGBuff: %s\n", (unsigned char*) image->pixels );
 466                         }
 467                         if ( pixels && width == image->width && height == image->height ) {
 468                                 int i;
 469                                 for ( i = 0; i < width * height; ++i )
 470                                         image->pixels[4 * i + 3] = pixels[4 * i + 2];  // copy alpha from blue channel
 471                         }
 472                         free( pixels );
 473                         free( buffer );
 474                 }
 475         }
 476
 477         /* return the image */
 478         return image;
 479 }