1 /* -------------------------------------------------------------------------------
3 Copyright (C) 1999-2007 id Software, Inc. and contributors.
4 For a list of contributors, see the accompanying CONTRIBUTORS file.
6 This file is part of GtkRadiant.
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.
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.
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
22 ----------------------------------------------------------------------------------
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."
27 ------------------------------------------------------------------------------- */
41 /* -------------------------------------------------------------------------------
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
46 ------------------------------------------------------------------------------- */
50 loads a dxtc (1, 3, 5) dds buffer into a valid rgba image
53 static void LoadDDSBuffer( byte *buffer, int size, byte **pixels, int *width, int *height ){
59 if ( buffer == NULL || size <= 0 || pixels == NULL || width == NULL || height == NULL ) {
69 if ( DDSGetInfo( (ddsBuffer_t*) buffer, &w, &h, &pf ) ) {
70 Sys_FPrintf( SYS_WRN, "WARNING: Invalid DDS texture\n" );
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 );
80 /* create image pixel buffer */
83 *pixels = safe_malloc( w * h * 4 );
85 /* decompress the dds texture */
86 DDSDecompress( (ddsBuffer_t*) buffer, *pixels );
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!
97 typedef struct pngBuffer_s
100 png_size_t size, offset;
103 void PNGReadData( png_struct *png, png_byte *buffer, png_size_t size ){
104 pngBuffer_t *pb = (pngBuffer_t*) png_get_io_ptr( png );
107 if ( ( pb->offset + size ) > pb->size ) {
108 size = ( pb->size - pb->offset );
110 memcpy( buffer, &pb->buffer[ pb->offset ], size );
112 //% 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 );
119 loads a png file buffer into a valid rgba image
122 static void LoadPNGBuffer( byte *buffer, int size, byte **pixels, int *width, int *height ){
124 png_info *info, *end;
126 int bitDepth, colorType;
131 if ( buffer == NULL || size <= 0 || pixels == NULL || width == NULL || height == NULL ) {
140 /* determine if this is a png file */
141 if ( png_sig_cmp( buffer, 0, 8 ) != 0 ) {
142 Sys_FPrintf( SYS_WRN, "WARNING: Invalid PNG file\n" );
146 /* create png structs */
147 png = png_create_read_struct( PNG_LIBPNG_VER_STRING, NULL, NULL, NULL );
149 Sys_FPrintf( SYS_WRN, "WARNING: Unable to create PNG read struct\n" );
153 info = png_create_info_struct( png );
154 if ( info == NULL ) {
155 Sys_FPrintf( SYS_WRN, "WARNING: Unable to create PNG info struct\n" );
156 png_destroy_read_struct( &png, NULL, NULL );
160 end = png_create_info_struct( png );
162 Sys_FPrintf( SYS_WRN, "WARNING: Unable to create PNG end info struct\n" );
163 png_destroy_read_struct( &png, &info, NULL );
167 /* set read callback */
171 png_set_read_fn( png, &pb, PNGReadData );
173 /* set error longjmp */
174 if ( setjmp( png_jmpbuf(png) ) ) {
175 Sys_FPrintf( SYS_WRN, "WARNING: An error occurred reading PNG image\n" );
176 png_destroy_read_struct( &png, &info, &end );
180 /* fixme: add proper i/o stuff here */
183 png_read_info( png, info );
185 /* read image header chunk */
186 png_get_IHDR( png, info,
187 &w, &h, &bitDepth, &colorType, NULL, NULL, NULL );
189 /* the following will probably bork on certain types of png images, but hey... */
191 /* force indexed/gray/trans chunk to rgb */
192 if ( ( colorType == PNG_COLOR_TYPE_PALETTE && bitDepth <= 8 ) ||
193 ( colorType == PNG_COLOR_TYPE_GRAY && bitDepth <= 8 ) ||
194 png_get_valid( png, info, PNG_INFO_tRNS ) ) {
195 png_set_expand( png );
198 /* strip 16bpc -> 8bpc */
199 if ( bitDepth == 16 ) {
200 png_set_strip_16( png );
203 /* pad rgb to rgba */
204 if ( bitDepth == 8 && colorType == PNG_COLOR_TYPE_RGB ) {
205 png_set_filler( png, 255, PNG_FILLER_AFTER );
208 /* create image pixel buffer */
211 *pixels = safe_malloc( w * h * 4 );
213 /* create row pointers */
214 rowPointers = safe_malloc( h * sizeof( byte* ) );
215 for ( i = 0; i < h; i++ )
216 rowPointers[ i ] = *pixels + ( i * w * 4 );
219 png_read_image( png, rowPointers );
223 png_destroy_read_struct( &png, &info, &end );
231 implicitly called by every function to set up image list
234 static void ImageInit( void ){
238 if ( numImages <= 0 ) {
239 /* clear images (fixme: this could theoretically leak) */
240 memset( images, 0, sizeof( images ) );
242 /* generate *bogus image */
243 images[ 0 ].name = safe_malloc( strlen( DEFAULT_IMAGE ) + 1 );
244 strcpy( images[ 0 ].name, DEFAULT_IMAGE );
245 images[ 0 ].filename = safe_malloc( strlen( DEFAULT_IMAGE ) + 1 );
246 strcpy( images[ 0 ].filename, DEFAULT_IMAGE );
247 images[ 0 ].width = 64;
248 images[ 0 ].height = 64;
249 images[ 0 ].refCount = 1;
250 images[ 0 ].pixels = safe_malloc( 64 * 64 * 4 );
251 for ( i = 0; i < ( 64 * 64 * 4 ); i++ )
252 images[ 0 ].pixels[ i ] = 255;
263 void ImageFree( image_t *image ){
265 if ( image == NULL ) {
269 /* decrement refcount */
273 if ( image->refCount <= 0 ) {
274 if ( image->name != NULL ) {
278 if ( image->filename != NULL ) {
279 free( image->filename );
281 image->filename = NULL;
282 free( image->pixels );
293 finds an existing rgba image and returns a pointer to the image_t struct or NULL if not found
296 image_t *ImageFind( const char *filename ){
305 if ( filename == NULL || filename[ 0 ] == '\0' ) {
309 /* strip file extension off name */
310 strcpy( name, filename );
311 StripExtension( name );
314 for ( i = 0; i < MAX_IMAGES; i++ )
316 if ( images[ i ].name != NULL && !strcmp( name, images[ i ].name ) ) {
321 /* no matching image found */
329 loads an rgba image and returns a pointer to the image_t struct or NULL if not found
332 image_t *ImageLoad( const char *filename ){
338 qboolean alphaHack = qfalse;
345 if ( filename == NULL || filename[ 0 ] == '\0' ) {
349 /* strip file extension off name */
350 strcpy( name, filename );
351 StripExtension( name );
353 /* try to find existing image */
354 image = ImageFind( name );
355 if ( image != NULL ) {
360 /* none found, so find first non-null image */
362 for ( i = 0; i < MAX_IMAGES; i++ )
364 if ( images[ i ].name == NULL ) {
365 image = &images[ i ];
370 /* too many images? */
371 if ( image == NULL ) {
372 Error( "MAX_IMAGES (%d) exceeded, there are too many image files referenced by the map.", MAX_IMAGES );
376 image->name = safe_malloc( strlen( name ) + 1 );
377 strcpy( image->name, name );
379 /* attempt to load tga */
380 StripExtension( name );
381 strcat( name, ".tga" );
382 size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
384 LoadTGABuffer( buffer, buffer + size, &image->pixels, &image->width, &image->height );
388 /* attempt to load png */
389 StripExtension( name );
390 strcat( name, ".png" );
391 size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
393 LoadPNGBuffer( buffer, size, &image->pixels, &image->width, &image->height );
397 /* attempt to load jpg */
398 StripExtension( name );
399 strcat( name, ".jpg" );
400 size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
402 if ( LoadJPGBuff( buffer, size, &image->pixels, &image->width, &image->height ) == -1 && image->pixels != NULL ) {
403 // On error, LoadJPGBuff might store a pointer to the error message in image->pixels
404 Sys_FPrintf( SYS_WRN, "WARNING: LoadJPGBuff: %s\n", (unsigned char*) image->pixels );
410 /* attempt to load dds */
411 StripExtension( name );
412 strcat( name, ".dds" );
413 size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
415 LoadDDSBuffer( buffer, size, &image->pixels, &image->width, &image->height );
421 DDSGetInfo( (ddsBuffer_t*) buffer, NULL, NULL, &pf );
422 Sys_Printf( "pf = %d\n", pf );
423 if ( image->width > 0 ) {
424 StripExtension( name );
425 strcat( name, "_converted.tga" );
426 WriteTGA( "C:\\games\\quake3\\baseq3\\textures\\rad\\dds_converted.tga", image->pixels, image->width, image->height );
433 /* attempt to load ktx */
434 StripExtension( name );
435 strcat( name, ".ktx" );
436 size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
438 LoadKTXBufferFirstImage( buffer, size, &image->pixels, &image->width, &image->height );
445 /* free file buffer */
448 /* make sure everything's kosher */
449 if ( size <= 0 || image->width <= 0 || image->height <= 0 || image->pixels == NULL ) {
450 //% Sys_Printf( "size = %d width = %d height = %d pixels = 0x%08x (%s)\n",
451 //% size, image->width, image->height, image->pixels, name );
458 image->filename = safe_malloc( strlen( name ) + 1 );
459 strcpy( image->filename, name );
466 StripExtension( name );
467 strcat( name, "_alpha.jpg" );
468 size = vfsLoadFile( (const char*) name, (void**) &buffer, 0 );
470 unsigned char *pixels;
472 if ( LoadJPGBuff( buffer, size, &pixels, &width, &height ) == -1 ) {
474 // On error, LoadJPGBuff might store a pointer to the error message in pixels
475 Sys_FPrintf( SYS_WRN, "WARNING: LoadJPGBuff %s %s\n", name, (unsigned char*) pixels );
478 if ( width == image->width && height == image->height ) {
480 for ( i = 0; i < width * height; ++i )
481 image->pixels[4 * i + 3] = pixels[4 * i + 2]; // copy alpha from blue channel
489 /* return the image */