io-png.c 36.8 KB
Newer Older
1
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 8 -*- */
2
/* GdkPixbuf library - PNG image loader
3
 *
4
 * Copyright (C) 1999 Mark Crichton
5 6 7 8
 * Copyright (C) 1999 The Free Software Foundation
 *
 * Authors: Mark Crichton <crichton@gimp.org>
 *          Federico Mena-Quintero <federico@gimp.org>
9
 *
10
 * This library is free software; you can redistribute it and/or
11
 * modify it under the terms of the GNU Lesser General Public
12 13 14 15 16 17
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18
 * Lesser General Public License for more details.
19
 *
20
 * You should have received a copy of the GNU Lesser General Public
21 22 23
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
24
 */
25

26 27
#include <config.h>
#include <stdio.h>
28
#include <stdlib.h>
29
#include <png.h>
30
#include "gdk-pixbuf-private.h"
31
#include "gdk-pixbuf-io.h"
32 33 34



35
static gboolean
36
setup_png_transformations(png_structp png_read_ptr, png_infop png_info_ptr,
37
                          GError **error,
38 39 40 41 42 43 44 45 46
                          png_uint_32* width_p, png_uint_32* height_p,
                          int* color_type_p)
{
        png_uint_32 width, height;
        int bit_depth, color_type, interlace_type, compression_type, filter_type;
        int channels;
        
        /* Get the image info */

47 48 49 50 51 52 53 54 55 56 57
        /* Must check bit depth, since png_get_IHDR generates an 
           FPE on bit_depth 0.
        */
        bit_depth = png_get_bit_depth (png_read_ptr, png_info_ptr);
        if (bit_depth < 1 || bit_depth > 16) {
                g_set_error (error,
                             GDK_PIXBUF_ERROR,
                             GDK_PIXBUF_ERROR_CORRUPT_IMAGE,
                             _("Bits per channel of PNG image is invalid."));
                return FALSE;
        }
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
        png_get_IHDR (png_read_ptr, png_info_ptr,
                      &width, &height,
                      &bit_depth,
                      &color_type,
                      &interlace_type,
                      &compression_type,
                      &filter_type);

        /* set_expand() basically needs to be called unless
           we are already in RGB/RGBA mode
        */
        if (color_type == PNG_COLOR_TYPE_PALETTE &&
            bit_depth <= 8) {

                /* Convert indexed images to RGB */
                png_set_expand (png_read_ptr);

        } else if (color_type == PNG_COLOR_TYPE_GRAY &&
                   bit_depth < 8) {

                /* Convert grayscale to RGB */
                png_set_expand (png_read_ptr);

        } else if (png_get_valid (png_read_ptr, 
                                  png_info_ptr, PNG_INFO_tRNS)) {

                /* If we have transparency header, convert it to alpha
                   channel */
                png_set_expand(png_read_ptr);
                
        } else if (bit_depth < 8) {

                /* If we have < 8 scale it up to 8 */
                png_set_expand(png_read_ptr);


                /* Conceivably, png_set_packing() is a better idea;
                 * God only knows how libpng works
                 */
        }

        /* If we are 16-bit, convert to 8-bit */
        if (bit_depth == 16) {
                png_set_strip_16(png_read_ptr);
        }

        /* If gray scale, convert to RGB */
        if (color_type == PNG_COLOR_TYPE_GRAY ||
            color_type == PNG_COLOR_TYPE_GRAY_ALPHA) {
                png_set_gray_to_rgb(png_read_ptr);
        }
        
        /* If interlaced, handle that */
        if (interlace_type != PNG_INTERLACE_NONE) {
                png_set_interlace_handling(png_read_ptr);
        }
        
        /* Update the info the reflect our transformations */
        png_read_update_info(png_read_ptr, png_info_ptr);
        
        png_get_IHDR (png_read_ptr, png_info_ptr,
                      &width, &height,
                      &bit_depth,
                      &color_type,
                      &interlace_type,
                      &compression_type,
                      &filter_type);

        *width_p = width;
        *height_p = height;
        *color_type_p = color_type;
        
        /* Check that the new info is what we want */
        
132 133 134 135 136 137 138 139
        if (width == 0 || height == 0) {
                g_set_error (error,
                             GDK_PIXBUF_ERROR,
                             GDK_PIXBUF_ERROR_CORRUPT_IMAGE,
                             _("Transformed PNG has zero width or height."));
                return FALSE;
        }

140
        if (bit_depth != 8) {
141 142 143 144 145
                g_set_error (error,
                             GDK_PIXBUF_ERROR,
                             GDK_PIXBUF_ERROR_CORRUPT_IMAGE,
                             _("Bits per channel of transformed PNG is not 8."));
                return FALSE;
146 147 148 149
        }

        if ( ! (color_type == PNG_COLOR_TYPE_RGB ||
                color_type == PNG_COLOR_TYPE_RGB_ALPHA) ) {
150 151 152 153 154
                g_set_error (error,
                             GDK_PIXBUF_ERROR,
                             GDK_PIXBUF_ERROR_CORRUPT_IMAGE,
                             _("Transformed PNG not RGB or RGBA."));
                return FALSE;
155 156 157 158
        }

        channels = png_get_channels(png_read_ptr, png_info_ptr);
        if ( ! (channels == 3 || channels == 4) ) {
159 160 161 162 163
                g_set_error (error,
                             GDK_PIXBUF_ERROR,
                             GDK_PIXBUF_ERROR_CORRUPT_IMAGE,
                             _("Transformed PNG has unsupported number of channels, must be 3 or 4."));
                return FALSE;
164
        }
165
        return TRUE;
166 167
}

Havoc Pennington's avatar
Havoc Pennington committed
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
static void
png_simple_error_callback(png_structp png_save_ptr,
                          png_const_charp error_msg)
{
        GError **error;
        
        error = png_get_error_ptr(png_save_ptr);

        /* I don't trust libpng to call the error callback only once,
         * so check for already-set error
         */
        if (error && *error == NULL) {
                g_set_error (error,
                             GDK_PIXBUF_ERROR,
                             GDK_PIXBUF_ERROR_FAILED,
183
                             _("Fatal error in PNG image file: %s"),
Havoc Pennington's avatar
Havoc Pennington committed
184 185
                             error_msg);
        }
186 187

        longjmp (png_save_ptr->jmpbuf, 1);
Havoc Pennington's avatar
Havoc Pennington committed
188 189 190 191 192 193 194 195 196 197 198 199 200 201
}

static void
png_simple_warning_callback(png_structp png_save_ptr,
                            png_const_charp warning_msg)
{
        /* Don't print anything; we should not be dumping junk to
         * stderr, since that may be bad for some apps. If it's
         * important enough to display, we need to add a GError
         * **warning return location wherever we have an error return
         * location.
         */
}

202 203 204 205 206
static gboolean
png_text_to_pixbuf_option (png_text   text_ptr,
                           gchar    **key,
                           gchar    **value)
{
Michael Natterer's avatar
Michael Natterer committed
207 208 209 210 211 212 213 214 215 216 217
        gboolean is_ascii = TRUE;
        int i;

        /* Avoid loading iconv if the text is plain ASCII */
        for (i = 0; i < text_ptr.text_length; i++)
                if (text_ptr.text[i] & 0x80) {
                        is_ascii = FALSE;
                        break;
                }

        if (is_ascii) {
218
                *value = g_strdup (text_ptr.text);
Michael Natterer's avatar
Michael Natterer committed
219 220 221 222
        } else {
                *value = g_convert (text_ptr.text, -1,
                                     "UTF-8", "ISO-8859-1",
                                     NULL, NULL, NULL);
223
        }
Michael Natterer's avatar
Michael Natterer committed
224

225 226 227 228
        if (*value) {
                *key = g_strconcat ("tEXt::", text_ptr.key, NULL);
                return TRUE;
        } else {
229
                g_warning ("Couldn't convert text chunk value to UTF-8.");
230 231 232 233 234
                *key = NULL;
                return FALSE;
        }
}

235 236 237 238 239 240 241 242 243 244 245 246
static png_voidp
png_malloc_callback (png_structp o, png_size_t size)
{
        return g_try_malloc (size);
}

static void
png_free_callback (png_structp o, png_voidp x)
{
        g_free (x);
}

247
/* Shared library entry point */
248
static GdkPixbuf *
Havoc Pennington's avatar
Havoc Pennington committed
249
gdk_pixbuf__png_image_load (FILE *f, GError **error)
250
{
251
        GdkPixbuf * volatile pixbuf = NULL;
252
	png_structp png_ptr;
Matthias Clasen's avatar
Matthias Clasen committed
253
	png_infop info_ptr;
254
        png_textp text_ptr;
255
	gint i, ctype;
256
	png_uint_32 w, h;
257
	png_bytepp volatile rows = NULL;
258
        gint    num_texts;
259 260
        gchar *key;
        gchar *value;
261

262 263 264 265 266 267 268 269 270
#ifdef PNG_USER_MEM_SUPPORTED
	png_ptr = png_create_read_struct_2 (PNG_LIBPNG_VER_STRING,
                                            error,
                                            png_simple_error_callback,
                                            png_simple_warning_callback,
                                            NULL, 
                                            png_malloc_callback, 
                                            png_free_callback);
#else
Havoc Pennington's avatar
Havoc Pennington committed
271 272 273 274
	png_ptr = png_create_read_struct (PNG_LIBPNG_VER_STRING,
                                          error,
                                          png_simple_error_callback,
                                          png_simple_warning_callback);
275
#endif
276 277 278 279 280 281 282 283 284 285
	if (!png_ptr)
		return NULL;

	info_ptr = png_create_info_struct (png_ptr);
	if (!info_ptr) {
		png_destroy_read_struct (&png_ptr, NULL, NULL);
		return NULL;
	}

	if (setjmp (png_ptr->jmpbuf)) {
286 287 288
	    	if (rows)
		  	g_free (rows);

289 290
		if (pixbuf)
			g_object_unref (pixbuf);
291

Matthias Clasen's avatar
Matthias Clasen committed
292
		png_destroy_read_struct (&png_ptr, &info_ptr, NULL);
293 294 295
		return NULL;
	}

296
	png_init_io (png_ptr, f);
297
	png_read_info (png_ptr, info_ptr);
298

299
        if (!setup_png_transformations(png_ptr, info_ptr, error, &w, &h, &ctype)) {
Matthias Clasen's avatar
Matthias Clasen committed
300
                png_destroy_read_struct (&png_ptr, &info_ptr, NULL);
301 302 303
                return NULL;
        }
        
304 305 306
        pixbuf = gdk_pixbuf_new (GDK_COLORSPACE_RGB, ctype & PNG_COLOR_MASK_ALPHA, 8, w, h);

	if (!pixbuf) {
Havoc Pennington's avatar
Havoc Pennington committed
307 308 309 310 311 312 313
                if (error && *error == NULL) {
                        g_set_error (error,
                                     GDK_PIXBUF_ERROR,
                                     GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY,
                                     _("Insufficient memory to load PNG file"));
                }
                
314

Matthias Clasen's avatar
Matthias Clasen committed
315
		png_destroy_read_struct (&png_ptr, &info_ptr, NULL);
316 317
		return NULL;
	}
318

319
	rows = g_new (png_bytep, h);
320

321
	for (i = 0; i < h; i++)
322
		rows[i] = pixbuf->pixels + i * pixbuf->rowstride;
323

324
	png_read_image (png_ptr, rows);
Matthias Clasen's avatar
Matthias Clasen committed
325
        png_read_end (png_ptr, info_ptr);
326 327 328

        if (png_get_text (png_ptr, info_ptr, &text_ptr, &num_texts)) {
                for (i = 0; i < num_texts; i++) {
329
                        png_text_to_pixbuf_option (text_ptr[i], &key, &value);
330
                        gdk_pixbuf_set_option (pixbuf, key, value);
331 332
                        g_free (key);
                        g_free (value);
333 334 335
                }
        }

336 337
	g_free (rows);
	png_destroy_read_struct (&png_ptr, &info_ptr, NULL);
338 339

        return pixbuf;
340
}
341

342 343
/* I wish these avoided the setjmp()/longjmp() crap in libpng instead
   just allow you to change the error reporting. */
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
static void png_error_callback  (png_structp png_read_ptr,
                                 png_const_charp error_msg);

static void png_warning_callback(png_structp png_read_ptr,
                                 png_const_charp warning_msg);

/* Called at the start of the progressive load */
static void png_info_callback   (png_structp png_read_ptr,
                                 png_infop   png_info_ptr);

/* Called for each row; note that you will get duplicate row numbers
   for interlaced PNGs */
static void png_row_callback   (png_structp png_read_ptr,
                                png_bytep   new_row,
                                png_uint_32 row_num,
                                int pass_num);

/* Called after reading the entire image */
static void png_end_callback   (png_structp png_read_ptr,
                                png_infop   png_info_ptr);

typedef struct _LoadContext LoadContext;

struct _LoadContext {
        png_structp png_read_ptr;
        png_infop   png_info_ptr;

371
        GdkPixbufModuleSizeFunc size_func;
372 373
        GdkPixbufModulePreparedFunc prepare_func;
        GdkPixbufModuleUpdatedFunc update_func;
374 375 376
        gpointer notify_user_data;

        GdkPixbuf* pixbuf;
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392

        /* row number of first row seen, or -1 if none yet seen */

        gint first_row_seen_in_chunk;

        /* pass number for the first row seen */

        gint first_pass_seen_in_chunk;
        
        /* row number of last row seen */
        gint last_row_seen_in_chunk;

        gint last_pass_seen_in_chunk;

        /* highest row number seen */
        gint max_row_seen_in_chunk;
393 394 395
        
        guint fatal_error_occurred : 1;

Havoc Pennington's avatar
Havoc Pennington committed
396
        GError **error;
397 398
};

399
static gpointer
400 401 402
gdk_pixbuf__png_image_begin_load (GdkPixbufModuleSizeFunc size_func,
                                  GdkPixbufModulePreparedFunc prepare_func,
				  GdkPixbufModuleUpdatedFunc update_func,
Havoc Pennington's avatar
Havoc Pennington committed
403 404
				  gpointer user_data,
                                  GError **error)
405 406 407 408 409 410 411
{
        LoadContext* lc;
        
        lc = g_new0(LoadContext, 1);
        
        lc->fatal_error_occurred = FALSE;

412
        lc->size_func = size_func;
413 414
        lc->prepare_func = prepare_func;
        lc->update_func = update_func;
415 416
        lc->notify_user_data = user_data;

417 418 419 420 421
        lc->first_row_seen_in_chunk = -1;
        lc->last_row_seen_in_chunk = -1;
        lc->first_pass_seen_in_chunk = -1;
        lc->last_pass_seen_in_chunk = -1;
        lc->max_row_seen_in_chunk = -1;
Havoc Pennington's avatar
Havoc Pennington committed
422
        lc->error = error;
423
        
424 425
        /* Create the main PNG context struct */

426 427 428 429 430 431 432 433 434
#ifdef PNG_USER_MEM_SUPPORTED
        lc->png_read_ptr = png_create_read_struct_2 (PNG_LIBPNG_VER_STRING,
                                                     lc, /* error/warning callback data */
                                                     png_error_callback,
                                                     png_warning_callback,
                                                     NULL,
                                                     png_malloc_callback,
                                                     png_free_callback);
#else
435 436 437 438
        lc->png_read_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
                                                  lc, /* error/warning callback data */
                                                  png_error_callback,
                                                  png_warning_callback);
439
#endif
440 441
        if (lc->png_read_ptr == NULL) {
                g_free(lc);
Havoc Pennington's avatar
Havoc Pennington committed
442
                /* error callback should have set the error */
443 444
                return NULL;
        }
Havoc Pennington's avatar
Havoc Pennington committed
445
        
446 447 448 449
	if (setjmp (lc->png_read_ptr->jmpbuf)) {
		if (lc->png_info_ptr)
			png_destroy_read_struct(&lc->png_read_ptr, NULL, NULL);
                g_free(lc);
Havoc Pennington's avatar
Havoc Pennington committed
450
                /* error callback should have set the error */
451 452 453
                return NULL;
	}

454
        /* Create the auxiliary context struct */
455 456 457 458 459 460

        lc->png_info_ptr = png_create_info_struct(lc->png_read_ptr);

        if (lc->png_info_ptr == NULL) {
                png_destroy_read_struct(&lc->png_read_ptr, NULL, NULL);
                g_free(lc);
Havoc Pennington's avatar
Havoc Pennington committed
461
                /* error callback should have set the error */
462 463 464 465 466 467 468 469 470 471
                return NULL;
        }

        png_set_progressive_read_fn(lc->png_read_ptr,
                                    lc, /* callback data */
                                    png_info_callback,
                                    png_row_callback,
                                    png_end_callback);
        

Havoc Pennington's avatar
Havoc Pennington committed
472 473 474 475 476
        /* We don't want to keep modifying error after returning here,
         * it may no longer be valid.
         */
        lc->error = NULL;
        
477 478 479
        return lc;
}

480 481
static gboolean
gdk_pixbuf__png_image_stop_load (gpointer context, GError **error)
482 483 484
{
        LoadContext* lc = context;

485
        g_return_val_if_fail(lc != NULL, TRUE);
486

487 488 489 490
        /* FIXME this thing needs to report errors if
         * we have unused image data
         */
        
491
        if (lc->pixbuf)
492
                g_object_unref (lc->pixbuf);
493
        
Matthias Clasen's avatar
Matthias Clasen committed
494
        png_destroy_read_struct(&lc->png_read_ptr, &lc->png_info_ptr, NULL);
495
        g_free(lc);
496 497

        return TRUE;
498 499
}

500 501 502
static gboolean
gdk_pixbuf__png_image_load_increment(gpointer context,
                                     const guchar *buf, guint size,
Havoc Pennington's avatar
Havoc Pennington committed
503
                                     GError **error)
504 505 506 507 508
{
        LoadContext* lc = context;

        g_return_val_if_fail(lc != NULL, FALSE);

509 510 511 512 513 514
        /* reset */
        lc->first_row_seen_in_chunk = -1;
        lc->last_row_seen_in_chunk = -1;
        lc->first_pass_seen_in_chunk = -1;
        lc->last_pass_seen_in_chunk = -1;
        lc->max_row_seen_in_chunk = -1;
Havoc Pennington's avatar
Havoc Pennington committed
515
        lc->error = error;
516
        
517
        /* Invokes our callbacks as needed */
518
	if (setjmp (lc->png_read_ptr->jmpbuf)) {
Havoc Pennington's avatar
Havoc Pennington committed
519
                lc->error = NULL;
520 521
		return FALSE;
	} else {
522 523
		png_process_data(lc->png_read_ptr, lc->png_info_ptr,
                                 (guchar*) buf, size);
524
	}
525

Havoc Pennington's avatar
Havoc Pennington committed
526 527
        if (lc->fatal_error_occurred) {
                lc->error = NULL;
528
                return FALSE;
Havoc Pennington's avatar
Havoc Pennington committed
529
        } else {
530
                if (lc->first_row_seen_in_chunk >= 0 && lc->update_func) {
531 532 533 534 535 536 537
                        /* We saw at least one row */
                        gint pass_diff = lc->last_pass_seen_in_chunk - lc->first_pass_seen_in_chunk;
                        
                        g_assert(pass_diff >= 0);
                        
                        if (pass_diff == 0) {
                                /* start and end row were in the same pass */
538
                                (lc->update_func)(lc->pixbuf, 0,
539
                                                  lc->first_row_seen_in_chunk,
540
                                                  lc->pixbuf->width,
541
                                                  (lc->last_row_seen_in_chunk -
542 543
                                                   lc->first_row_seen_in_chunk) + 1,
						  lc->notify_user_data);
544 545 546 547 548 549
                        } else if (pass_diff == 1) {
                                /* We have from the first row seen to
                                   the end of the image (max row
                                   seen), then from the top of the
                                   image to the last row seen */
                                /* first row to end */
550
                                (lc->update_func)(lc->pixbuf, 0,
551
                                                  lc->first_row_seen_in_chunk,
552
                                                  lc->pixbuf->width,
553
                                                  (lc->max_row_seen_in_chunk -
554 555
                                                   lc->first_row_seen_in_chunk) + 1,
						  lc->notify_user_data);
556
                                /* top to last row */
557
                                (lc->update_func)(lc->pixbuf,
558
                                                  0, 0, 
559
                                                  lc->pixbuf->width,
560 561
                                                  lc->last_row_seen_in_chunk + 1,
						  lc->notify_user_data);
562 563 564
                        } else {
                                /* We made at least one entire pass, so update the
                                   whole image */
565
                                (lc->update_func)(lc->pixbuf,
566
                                                  0, 0, 
567
                                                  lc->pixbuf->width,
568 569
                                                  lc->max_row_seen_in_chunk + 1,
						  lc->notify_user_data);
570 571
                        }
                }
Havoc Pennington's avatar
Havoc Pennington committed
572 573

                lc->error = NULL;
574
                
575
                return TRUE;
576
        }
577 578 579 580 581 582 583 584 585
}

/* Called at the start of the progressive load, once we have image info */
static void
png_info_callback   (png_structp png_read_ptr,
                     png_infop   png_info_ptr)
{
        LoadContext* lc;
        png_uint_32 width, height;
586 587
        png_textp png_text_ptr;
        int i, num_texts;
588
        int color_type;
589 590 591 592 593 594 595
        gboolean have_alpha = FALSE;
        
        lc = png_get_progressive_ptr(png_read_ptr);

        if (lc->fatal_error_occurred)
                return;

596 597 598 599
        if (!setup_png_transformations(lc->png_read_ptr,
                                       lc->png_info_ptr,
                                       lc->error,
                                       &width, &height, &color_type)) {
600 601
                lc->fatal_error_occurred = TRUE;
                return;
602 603 604 605
        }

        /* If we have alpha, set a flag */
        if (color_type & PNG_COLOR_MASK_ALPHA)
606
                have_alpha = TRUE;
607
        
608 609 610 611 612 613 614
        if (lc->size_func) {
                gint w = width;
                gint h = height;
                (* lc->size_func) (&w, &h, lc->notify_user_data);
                
                if (w == 0 || h == 0) {
                        lc->fatal_error_occurred = TRUE;
Michael Natterer's avatar
Michael Natterer committed
615 616 617 618 619 620
                        if (lc->error && *lc->error == NULL) {
                                g_set_error (lc->error,
                                             GDK_PIXBUF_ERROR,
                                             GDK_PIXBUF_ERROR_FAILED,
                                             _("Transformed PNG has zero width or height."));
                        }
621 622 623 624 625
                        return;
                }
        }

        lc->pixbuf = gdk_pixbuf_new (GDK_COLORSPACE_RGB, have_alpha, 8, width, height);
626 627 628 629

        if (lc->pixbuf == NULL) {
                /* Failed to allocate memory */
                lc->fatal_error_occurred = TRUE;
Havoc Pennington's avatar
Havoc Pennington committed
630 631 632 633 634 635 636
                if (lc->error && *lc->error == NULL) {
                        g_set_error (lc->error,
                                     GDK_PIXBUF_ERROR,
                                     GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY,
                                     _("Insufficient memory to store a %ld by %ld image; try exiting some applications to reduce memory usage"),
                                     width, height);
                }
637 638
                return;
        }
639

640
        /* Extract text chunks and attach them as pixbuf options */
641
        
642 643 644 645 646 647
        if (png_get_text (png_read_ptr, png_info_ptr, &png_text_ptr, &num_texts)) {
                for (i = 0; i < num_texts; i++) {
                        gchar *key, *value;

                        if (png_text_to_pixbuf_option (png_text_ptr[i],
                                                       &key, &value)) {
648
                                gdk_pixbuf_set_option (lc->pixbuf, key, value);
649 650 651 652 653 654
                                g_free (key);
                                g_free (value);
                        }
                }
        }

655 656
        /* Notify the client that we are ready to go */

657
        if (lc->prepare_func)
Havoc Pennington's avatar
Havoc Pennington committed
658
                (* lc->prepare_func) (lc->pixbuf, NULL, lc->notify_user_data);
659 660 661 662 663 664 665 666 667 668 669 670 671 672
        
        return;
}

/* Called for each row; note that you will get duplicate row numbers
   for interlaced PNGs */
static void
png_row_callback   (png_structp png_read_ptr,
                    png_bytep   new_row,
                    png_uint_32 row_num,
                    int pass_num)
{
        LoadContext* lc;
        guchar* old_row = NULL;
673

674 675 676 677
        lc = png_get_progressive_ptr(png_read_ptr);

        if (lc->fatal_error_occurred)
                return;
678

Matthias Clasen's avatar
Matthias Clasen committed
679
        if (row_num >= lc->pixbuf->height) {
680 681 682 683 684 685 686 687 688 689
                lc->fatal_error_occurred = TRUE;
                if (lc->error && *lc->error == NULL) {
                        g_set_error (lc->error,
                                     GDK_PIXBUF_ERROR,
                                     GDK_PIXBUF_ERROR_CORRUPT_IMAGE,
                                     _("Fatal error reading PNG image file"));
                }
                return;
        }

690 691 692 693 694 695 696 697 698
        if (lc->first_row_seen_in_chunk < 0) {
                lc->first_row_seen_in_chunk = row_num;
                lc->first_pass_seen_in_chunk = pass_num;
        }

        lc->max_row_seen_in_chunk = MAX(lc->max_row_seen_in_chunk, ((gint)row_num));
        lc->last_row_seen_in_chunk = row_num;
        lc->last_pass_seen_in_chunk = pass_num;
        
699
        old_row = lc->pixbuf->pixels + (row_num * lc->pixbuf->rowstride);
700

701 702 703 704 705 706 707
        png_progressive_combine_row(lc->png_read_ptr, old_row, new_row);
}

/* Called after reading the entire image */
static void
png_end_callback   (png_structp png_read_ptr,
                    png_infop   png_info_ptr)
708
{
709 710 711 712 713 714
        LoadContext* lc;

        lc = png_get_progressive_ptr(png_read_ptr);

        if (lc->fatal_error_occurred)
                return;
715
}
716 717 718 719 720 721 722 723 724 725

static void
png_error_callback(png_structp png_read_ptr,
                   png_const_charp error_msg)
{
        LoadContext* lc;
        
        lc = png_get_error_ptr(png_read_ptr);
        
        lc->fatal_error_occurred = TRUE;
Havoc Pennington's avatar
Havoc Pennington committed
726 727 728 729 730 731 732 733 734 735 736

        /* I don't trust libpng to call the error callback only once,
         * so check for already-set error
         */
        if (lc->error && *lc->error == NULL) {
                g_set_error (lc->error,
                             GDK_PIXBUF_ERROR,
                             GDK_PIXBUF_ERROR_CORRUPT_IMAGE,
                             _("Fatal error reading PNG image file: %s"),
                             error_msg);
        }
737 738

        longjmp (png_read_ptr->jmpbuf, 1);
739 740 741 742 743 744 745 746 747
}

static void
png_warning_callback(png_structp png_read_ptr,
                     png_const_charp warning_msg)
{
        LoadContext* lc;
        
        lc = png_get_error_ptr(png_read_ptr);
Havoc Pennington's avatar
Havoc Pennington committed
748 749 750 751 752 753 754

        /* Don't print anything; we should not be dumping junk to
         * stderr, since that may be bad for some apps. If it's
         * important enough to display, we need to add a GError
         * **warning return location wherever we have an error return
         * location.
         */
755
}
756 757


758
/* Save */
Havoc Pennington's avatar
Havoc Pennington committed
759

760 761 762 763 764 765 766 767 768 769 770 771 772
typedef struct {
        GdkPixbufSaveFunc save_func;
        gpointer user_data;
        GError **error;
} SaveToFunctionIoPtr;

static void
png_save_to_callback_write_func (png_structp png_ptr,
                                 png_bytep   data,
                                 png_size_t  length)
{
        SaveToFunctionIoPtr *ioptr = png_get_io_ptr (png_ptr);

773
        if (!ioptr->save_func ((gchar *)data, length, ioptr->error, ioptr->user_data)) {
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
                /* If save_func has already set an error, which it
                   should have done, this won't overwrite it. */
                png_error (png_ptr, "write function failed");
        }
}

static void
png_save_to_callback_flush_func (png_structp png_ptr)
{
        ;
}

static gboolean real_save_png (GdkPixbuf        *pixbuf, 
                               gchar           **keys,
                               gchar           **values,
                               GError          **error,
                               gboolean          to_callback,
                               FILE             *f,
                               GdkPixbufSaveFunc save_func,
                               gpointer          user_data)
794 795 796
{
       png_structp png_ptr;
       png_infop info_ptr;
797
       png_textp text_ptr = NULL;
798 799
       guchar *ptr;
       guchar *pixels;
800 801
       int y;
       int i;
802
       png_bytep row_ptr;
803 804 805 806
       png_color_8 sig_bit;
       int w, h, rowstride;
       int has_alpha;
       int bpc;
807
       int num_keys;
808
       int compression = -1;
809
       gboolean success = TRUE;
810
       SaveToFunctionIoPtr to_callback_ioptr;
811 812

       num_keys = 0;
813 814

       if (keys && *keys) {
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841
               gchar **kiter = keys;
               gchar **viter = values;

               while (*kiter) {
                       if (strncmp (*kiter, "tEXt::", 6) == 0) {
                               gchar  *key = *kiter + 6;
                               int     len = strlen (key);
                               if (len <= 1 || len > 79) {
                                       g_set_error (error,
                                                    GDK_PIXBUF_ERROR,
                                                    GDK_PIXBUF_ERROR_BAD_OPTION,
                                                    _("Keys for PNG text chunks must have at least 1 and at most 79 characters."));
                                       return FALSE;
                               }
                               for (i = 0; i < len; i++) {
                                       if ((guchar) key[i] > 127) {
                                               g_set_error (error,
                                                            GDK_PIXBUF_ERROR,
                                                            GDK_PIXBUF_ERROR_BAD_OPTION,
                                                            _("Keys for PNG text chunks must be ASCII characters."));
                                               return FALSE;
                                       }
                               }
                               num_keys++;
                       } else if (strcmp (*kiter, "compression") == 0) {
                               char *endptr = NULL;
                               compression = strtol (*viter, &endptr, 10);
842

843 844 845 846 847 848 849 850 851 852 853 854 855
                               if (endptr == *viter) {
                                       g_set_error (error,
                                                    GDK_PIXBUF_ERROR,
                                                    GDK_PIXBUF_ERROR_BAD_OPTION,
                                                    _("PNG compression level must be a value between 0 and 9; value '%s' could not be parsed."),
                                                    *viter);
                                       return FALSE;
                               }
                               if (compression < 0 || compression > 9) {
                                       /* This is a user-visible error;
                                        * lets people skip the range-checking
                                        * in their app.
                                        */
856 857 858
                                       g_set_error (error,
                                                    GDK_PIXBUF_ERROR,
                                                    GDK_PIXBUF_ERROR_BAD_OPTION,
859 860
                                                    _("PNG compression level must be a value between 0 and 9; value '%d' is not allowed."),
                                                    compression);
861 862
                                       return FALSE;
                               }
863 864 865 866
                       } else {
                               g_warning ("Bad option name '%s' passed to PNG saver",
                                          *kiter);
                               return FALSE;
867
                       }
868 869 870

                       ++kiter;
                       ++viter;
871 872 873 874 875 876 877 878 879 880 881 882
               }
       }

       if (num_keys > 0) {
               text_ptr = g_new0 (png_text, num_keys);
               for (i = 0; i < num_keys; i++) {
                       text_ptr[i].compression = PNG_TEXT_COMPRESSION_NONE;
                       text_ptr[i].key  = keys[i] + 6;
                       text_ptr[i].text = g_convert (values[i], -1, 
                                                     "ISO-8859-1", "UTF-8", 
                                                     NULL, &text_ptr[i].text_length, 
                                                     NULL);
883 884 885 886 887 888 889 890 891 892 893 894

#ifdef PNG_iTXt_SUPPORTED 
                       if (!text_ptr[i].text) {
                               text_ptr[i].compression = PNG_ITXT_COMPRESSION_NONE;
                               text_ptr[i].text = g_strdup (values[i]);
                               text_ptr[i].text_length = 0;
                               text_ptr[i].itxt_length = strlen (text_ptr[i].text);
                               text_ptr[i].lang = NULL;
                               text_ptr[i].lang_key = NULL;
                       }
#endif

895 896 897 898
                       if (!text_ptr[i].text) {
                               g_set_error (error,
                                            GDK_PIXBUF_ERROR,
                                            GDK_PIXBUF_ERROR_BAD_OPTION,
899
                                            _("Value for PNG text chunk %s cannot be converted to ISO-8859-1 encoding."), keys[i] + 6);
900 901 902 903 904 905
                               num_keys = i;
                               for (i = 0; i < num_keys; i++)
                                       g_free (text_ptr[i].text);
                               g_free (text_ptr);
                               return FALSE;
                       }
906 907
               }
       }
908

909 910 911 912 913 914 915 916
       bpc = gdk_pixbuf_get_bits_per_sample (pixbuf);
       w = gdk_pixbuf_get_width (pixbuf);
       h = gdk_pixbuf_get_height (pixbuf);
       rowstride = gdk_pixbuf_get_rowstride (pixbuf);
       has_alpha = gdk_pixbuf_get_has_alpha (pixbuf);
       pixels = gdk_pixbuf_get_pixels (pixbuf);

       png_ptr = png_create_write_struct (PNG_LIBPNG_VER_STRING,
Havoc Pennington's avatar
Havoc Pennington committed
917 918 919
                                          error,
                                          png_simple_error_callback,
                                          png_simple_warning_callback);
920 921 922 923 924

       g_return_val_if_fail (png_ptr != NULL, FALSE);

       info_ptr = png_create_info_struct (png_ptr);
       if (info_ptr == NULL) {
925 926
	       success = FALSE;
	       goto cleanup;
927 928
       }
       if (setjmp (png_ptr->jmpbuf)) {
929 930
	       success = FALSE;
	       goto cleanup;
931
       }
932 933 934 935 936

       if (num_keys > 0) {
               png_set_text (png_ptr, info_ptr, text_ptr, num_keys);
       }

937 938 939 940 941 942 943 944 945 946
       if (to_callback) {
               to_callback_ioptr.save_func = save_func;
               to_callback_ioptr.user_data = user_data;
               to_callback_ioptr.error = error;
               png_set_write_fn (png_ptr, &to_callback_ioptr,
                                 png_save_to_callback_write_func,
                                 png_save_to_callback_flush_func);
       } else {
               png_init_io (png_ptr, f);
       }
947

948 949 950
       if (compression >= 0)
               png_set_compression_level (png_ptr, compression);

951 952
       if (has_alpha) {
               png_set_IHDR (png_ptr, info_ptr, w, h, bpc,
Havoc Pennington's avatar
Havoc Pennington committed
953 954
                             PNG_COLOR_TYPE_RGB_ALPHA, PNG_INTERLACE_NONE,
                             PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
955 956
       } else {
               png_set_IHDR (png_ptr, info_ptr, w, h, bpc,
Havoc Pennington's avatar
Havoc Pennington committed
957 958
                             PNG_COLOR_TYPE_RGB, PNG_INTERLACE_NONE,
                             PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
959 960 961 962 963 964 965 966 967 968 969 970
       }
       sig_bit.red = bpc;
       sig_bit.green = bpc;
       sig_bit.blue = bpc;
       sig_bit.alpha = bpc;
       png_set_sBIT (png_ptr, info_ptr, &sig_bit);
       png_write_info (png_ptr, info_ptr);
       png_set_shift (png_ptr, &sig_bit);
       png_set_packing (png_ptr);

       ptr = pixels;
       for (y = 0; y < h; y++) {
971
               row_ptr = (png_bytep)ptr;
972 973 974 975 976
               png_write_rows (png_ptr, &row_ptr, 1);
               ptr += rowstride;
       }

       png_write_end (png_ptr, info_ptr);
977 978

cleanup:
979
       png_destroy_write_struct (&png_ptr, &info_ptr);
980

981 982 983 984 985 986
       if (num_keys > 0) {
               for (i = 0; i < num_keys; i++)
                       g_free (text_ptr[i].text);
               g_free (text_ptr);
       }

987
       return success;
988 989
}

990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
static gboolean
gdk_pixbuf__png_image_save (FILE          *f, 
                            GdkPixbuf     *pixbuf, 
                            gchar        **keys,
                            gchar        **values,
                            GError       **error)
{
        return real_save_png (pixbuf, keys, values, error,
                              FALSE, f, NULL, NULL);
}

static gboolean
gdk_pixbuf__png_image_save_to_callback (GdkPixbufSaveFunc   save_func,
                                        gpointer            user_data,
                                        GdkPixbuf          *pixbuf, 
                                        gchar             **keys,
                                        gchar             **values,
                                        GError            **error)
{
        return real_save_png (pixbuf, keys, values, error,
                              TRUE, NULL, save_func, user_data);
}

1013 1014 1015 1016 1017 1018
#ifndef INCLUDE_png
#define MODULE_ENTRY(type,function) function
#else
#define MODULE_ENTRY(type,function) _gdk_pixbuf__ ## type ## _ ## function
#endif

1019 1020 1021 1022 1023 1024 1025 1026
void
MODULE_ENTRY (png, fill_vtable) (GdkPixbufModule *module)
{
        module->load = gdk_pixbuf__png_image_load;
        module->begin_load = gdk_pixbuf__png_image_begin_load;
        module->stop_load = gdk_pixbuf__png_image_stop_load;
        module->load_increment = gdk_pixbuf__png_image_load_increment;
        module->save = gdk_pixbuf__png_image_save;
1027
        module->save_to_callback = gdk_pixbuf__png_image_save_to_callback;
1028
}
1029

1030
void
1031
MODULE_ENTRY (png, fill_info) (GdkPixbufFormat *info)
1032
{
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
        static GdkPixbufModulePattern signature[] = {
                { "\x89PNG\r\n\x1a\x0a", NULL, 100 },
                { NULL, NULL, 0 }
        };
	static gchar * mime_types[] = {
		"image/png",
		NULL
	};
	static gchar * extensions[] = {
		"png",
		NULL
	};

	info->name = "png";
        info->signature = signature;
	info->description = N_("The PNG image format");
	info->mime_types = mime_types;
	info->extensions = extensions;
1051
	info->flags = GDK_PIXBUF_FORMAT_WRITABLE | GDK_PIXBUF_FORMAT_THREADSAFE;
1052
	info->license = "LGPL";
1053
}