example.c 30.8 KB
Newer Older
1

2 3
#if 0 /* in case someone actually tries to compile this */

4
/* example.c - an example of using libpng
5
 * Last changed in libpng 1.5.10 [March 8, 2012]
6
 * Maintained 1998-2012 Glenn Randers-Pehrson
7 8
 * Maintained 1996, 1997 Andreas Dilger
 * Written 1995, 1996 Guy Eric Schalnat, Group 42, Inc.
9
 */
G
Guy Schalnat 已提交
10

A
Andreas Dilger 已提交
11
/* This is an example of how to use libpng to read and write PNG files.
12
 * The file libpng-manual.txt is much more verbose then this.  If you have not
13
 * read it, do so first.  This was designed to be a starting point of an
14 15
 * implementation.  This is not officially part of libpng, is hereby placed
 * in the public domain, and therefore does not require a copyright notice.
16 17
 * To the extent possible under law, the authors have waived all copyright and
 * related or neighboring rights to this file.
18 19 20 21
 *
 * This file does not currently compile, because it is missing certain
 * parts, like allocating memory to hold an image.  You will have to
 * supply these parts to get it to compile.  For an example of a minimal
22 23
 * working PNG reader/writer, see pngtest.c, included in this distribution;
 * see also the programs in the contrib directory.
24
 */
G
Guy Schalnat 已提交
25

26 27 28 29
#define _POSIX_SOURCE 1  /* libpng and zlib are POSIX-compliant.  You may
                          * change this if your application uses non-POSIX
                          * extensions. */

30
#include "png.h"
G
Guy Schalnat 已提交
31

32 33 34 35 36 37 38
 /* The png_jmpbuf() macro, used in error handling, became available in
  * libpng version 1.0.6.  If you want to be able to run your code with older
  * versions of libpng, you must define the macro yourself (but only if it
  * is not already defined by libpng!).
  */

#ifndef png_jmpbuf
39
#  define png_jmpbuf(png_ptr) ((png_ptr)->png_jmpbuf)
40 41
#endif

42 43 44 45 46
/* Check to see if a file is a PNG file using png_sig_cmp().  png_sig_cmp()
 * returns zero if the image is a PNG and nonzero if it isn't a PNG.
 *
 * The function check_if_png() shown here, but not used, returns nonzero (true)
 * if the file can be opened and is a PNG, 0 (false) otherwise.
47 48 49 50 51 52 53 54 55 56 57 58
 *
 * If this call is successful, and you are going to keep the file open,
 * you should call png_set_sig_bytes(png_ptr, PNG_BYTES_TO_CHECK); once
 * you have created the png_ptr, so that libpng knows your application
 * has read that many bytes from the start of the file.  Make sure you
 * don't call png_set_sig_bytes() with more than 8 bytes read or give it
 * an incorrect number of bytes read, or you will either have read too
 * many bytes (your fault), or you are telling libpng to read the wrong
 * number of magic bytes (also your fault).
 *
 * Many applications already read the first 2 or 4 bytes from the start
 * of the image to determine the file type, so it would be easiest just
59
 * to pass the bytes to png_sig_cmp() or even skip that if you know
60 61
 * you have a PNG file, and call png_set_sig_bytes().
 */
A
Andreas Dilger 已提交
62 63
#define PNG_BYTES_TO_CHECK 4
int check_if_png(char *file_name, FILE **fp)
G
Guy Schalnat 已提交
64
{
A
Andreas Dilger 已提交
65
   char buf[PNG_BYTES_TO_CHECK];
G
Guy Schalnat 已提交
66

A
Andreas Dilger 已提交
67
   /* Open the prospective PNG file. */
68
   if ((*fp = fopen(file_name, "rb")) == NULL)
G
Guy Schalnat 已提交
69 70
      return 0;

71
   /* Read in some of the signature bytes */
A
Andreas Dilger 已提交
72
   if (fread(buf, 1, PNG_BYTES_TO_CHECK, *fp) != PNG_BYTES_TO_CHECK)
G
Guy Schalnat 已提交
73 74
      return 0;

75 76 77
   /* Compare the first PNG_BYTES_TO_CHECK bytes of the signature.
      Return nonzero (true) if they match */

78
   return(!png_sig_cmp(buf, (png_size_t)0, PNG_BYTES_TO_CHECK));
G
Guy Schalnat 已提交
79 80
}

A
Andreas Dilger 已提交
81
/* Read a PNG file.  You may want to return an error code if the read
82 83 84 85 86
 * fails (depending upon the failure).  There are two "prototypes" given
 * here - one where we are given the filename, and we need to open the
 * file, and the other where we are given an open file (possibly with
 * some or all of the magic bytes read - see comments above).
 */
87
#ifdef open_file /* prototype 1 */
A
Andreas Dilger 已提交
88
void read_png(char *file_name)  /* We need to open the file */
G
Guy Schalnat 已提交
89
{
G
Guy Schalnat 已提交
90
   png_structp png_ptr;
G
Guy Schalnat 已提交
91
   png_infop info_ptr;
A
Andreas Dilger 已提交
92 93 94
   unsigned int sig_read = 0;
   png_uint_32 width, height;
   int bit_depth, color_type, interlace_type;
A
Andreas Dilger 已提交
95
   FILE *fp;
G
Guy Schalnat 已提交
96

A
Andreas Dilger 已提交
97
   if ((fp = fopen(file_name, "rb")) == NULL)
98
      return (ERROR);
99

100
#else no_open_file /* prototype 2 */
101
void read_png(FILE *fp, unsigned int sig_read)  /* File is already open */
A
Andreas Dilger 已提交
102 103 104
{
   png_structp png_ptr;
   png_infop info_ptr;
A
Andreas Dilger 已提交
105 106
   png_uint_32 width, height;
   int bit_depth, color_type, interlace_type;
107
#endif no_open_file /* Only use one prototype! */
G
Guy Schalnat 已提交
108

G
Guy Schalnat 已提交
109
   /* Create and initialize the png_struct with the desired error handler
A
Andreas Dilger 已提交
110 111 112 113 114
    * functions.  If you want to use the default stderr and longjump method,
    * you can supply NULL for the last three parameters.  We also supply the
    * the compiler header file version, so that we know if the application
    * was compiled with a compatible version of the library.  REQUIRED
    */
G
Guy Schalnat 已提交
115
   png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
116
      png_voidp user_error_ptr, user_error_fn, user_warning_fn);
G
Guy Schalnat 已提交
117

A
Andreas Dilger 已提交
118
   if (png_ptr == NULL)
G
Guy Schalnat 已提交
119 120
   {
      fclose(fp);
121
      return (ERROR);
G
Guy Schalnat 已提交
122 123
   }

A
Andreas Dilger 已提交
124
   /* Allocate/initialize the memory for image information.  REQUIRED. */
125
   info_ptr = png_create_info_struct(png_ptr);
A
Andreas Dilger 已提交
126
   if (info_ptr == NULL)
G
Guy Schalnat 已提交
127 128
   {
      fclose(fp);
129
      png_destroy_read_struct(&png_ptr, NULL, NULL);
130
      return (ERROR);
G
Guy Schalnat 已提交
131 132
   }

A
Andreas Dilger 已提交
133 134 135 136
   /* Set error handling if you are using the setjmp/longjmp method (this is
    * the normal method of doing things with libpng).  REQUIRED unless you
    * set up your own error handlers in the png_create_read_struct() earlier.
    */
137 138

   if (setjmp(png_jmpbuf(png_ptr)))
G
Guy Schalnat 已提交
139
   {
G
Guy Schalnat 已提交
140
      /* Free all of the memory associated with the png_ptr and info_ptr */
141
      png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
G
Guy Schalnat 已提交
142 143
      fclose(fp);
      /* If we get here, we had a problem reading the file */
144
      return (ERROR);
G
Guy Schalnat 已提交
145 146
   }

A
Andreas Dilger 已提交
147
   /* One of the following I/O initialization methods is REQUIRED */
148
#ifdef streams /* PNG file I/O method 1 */
A
Andreas Dilger 已提交
149
   /* Set up the input control if you are using standard C streams */
G
Guy Schalnat 已提交
150 151
   png_init_io(png_ptr, fp);

152
#else no_streams /* PNG file I/O method 2 */
A
Andreas Dilger 已提交
153
   /* If you are using replacement read functions, instead of calling
154 155
    * png_init_io() here you would call:
    */
G
Guy Schalnat 已提交
156 157
   png_set_read_fn(png_ptr, (void *)user_io_ptr, user_read_fn);
   /* where user_io_ptr is a structure you want available to the callbacks */
158
#endif no_streams /* Use only one I/O method! */
G
Guy Schalnat 已提交
159

A
Andreas Dilger 已提交
160
   /* If we have already read some of the signature */
161
   png_set_sig_bytes(png_ptr, sig_read);
A
Andreas Dilger 已提交
162

163 164 165 166 167
#ifdef hilevel
   /*
    * If you have enough memory to read in the entire image at once,
    * and you need to specify only transforms that can be controlled
    * with one of the PNG_TRANSFORM_* bits (this presently excludes
168
    * quantizing, filling, setting background, and doing gamma
169 170 171
    * adjustment), then you can read the entire image (including
    * pixels) into the info structure with this call:
    */
172
   png_read_png(png_ptr, info_ptr, png_transforms, NULL);
173

174 175 176
#else
   /* OK, you're doing it the hard way, with the lower-level functions */

A
Andreas Dilger 已提交
177 178 179
   /* The call to png_read_info() gives us all of the information from the
    * PNG file before the first IDAT (image data chunk).  REQUIRED
    */
G
Guy Schalnat 已提交
180
   png_read_info(png_ptr, info_ptr);
G
Guy Schalnat 已提交
181

A
Andreas Dilger 已提交
182
   png_get_IHDR(png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
183
       &interlace_type, NULL, NULL);
A
Andreas Dilger 已提交
184

185 186 187 188 189
   /* Set up the data transformations you want.  Note that these are all
    * optional.  Only call them if you want/need them.  Many of the
    * transformations only work on specific types of images, and many
    * are mutually exclusive.
    */
A
Andreas Dilger 已提交
190

191 192 193 194
   /* Tell libpng to strip 16 bit/color files down to 8 bits/color.
    * Use accurate scaling if it's available, otherwise just chop off the
    * low byte.
    */
195
#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
196
    png_set_scale_16(png_ptr);
197
#else
198
   png_set_strip_16(png_ptr);
199
#endif
A
Andreas Dilger 已提交
200

201
   /* Strip alpha bytes from the input data without combining with the
202 203
    * background (not recommended).
    */
A
Andreas Dilger 已提交
204 205
   png_set_strip_alpha(png_ptr);

206
   /* Extract multiple pixels with bit depths of 1, 2, and 4 from a single
A
Andreas Dilger 已提交
207 208 209 210
    * byte into separate bytes (useful for paletted and grayscale images).
    */
   png_set_packing(png_ptr);

211
   /* Change the order of packed pixels to least significant bit first
A
Andreas Dilger 已提交
212 213
    * (not useful if you are using png_set_packing). */
   png_set_packswap(png_ptr);
G
Guy Schalnat 已提交
214

215
   /* Expand paletted colors into true RGB triplets */
A
Andreas Dilger 已提交
216
   if (color_type == PNG_COLOR_TYPE_PALETTE)
217
      png_set_palette_to_rgb(png_ptr);
G
Guy Schalnat 已提交
218

219
   /* Expand grayscale images to the full 8 bits from 1, 2, or 4 bits/pixel */
A
Andreas Dilger 已提交
220
   if (color_type == PNG_COLOR_TYPE_GRAY && bit_depth < 8)
221
      png_set_expand_gray_1_2_4_to_8(png_ptr);
G
Guy Schalnat 已提交
222

223 224 225
   /* Expand paletted or RGB images with transparency to full alpha channels
    * so the data will be available as RGBA quartets.
    */
A
Andreas Dilger 已提交
226
   if (png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS))
227
      png_set_tRNS_to_alpha(png_ptr);
G
Guy Schalnat 已提交
228

A
Andreas Dilger 已提交
229 230 231 232 233 234
   /* Set the background color to draw transparent and alpha images over.
    * It is possible to set the red, green, and blue components directly
    * for paletted images instead of supplying a palette index.  Note that
    * even if the PNG file supplies a background, you are not required to
    * use it - you should use the (solid) application background if it has one.
    */
G
Guy Schalnat 已提交
235

236
   png_color_16 my_background, *image_background;
G
Guy Schalnat 已提交
237

238 239
   if (png_get_bKGD(png_ptr, info_ptr, &image_background))
      png_set_background(png_ptr, image_background,
G
Guy Schalnat 已提交
240
                         PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
G
Guy Schalnat 已提交
241 242
   else
      png_set_background(png_ptr, &my_background,
G
Guy Schalnat 已提交
243
                         PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
G
Guy Schalnat 已提交
244

245 246 247
   /* Some suggestions as to how to get a screen gamma value
    *
    * Note that screen gamma is the display_exponent, which includes
248 249
    * the CRT_exponent and any correction for viewing conditions
    */
A
Andreas Dilger 已提交
250 251 252 253 254
   if (/* We have a user-defined screen gamma value */)
   {
      screen_gamma = user-defined screen_gamma;
   }
   /* This is one way that applications share the same screen gamma value */
255
   else if ((gamma_str = getenv("SCREEN_GAMMA")) != NULL)
A
Andreas Dilger 已提交
256 257 258 259
   {
      screen_gamma = atof(gamma_str);
   }
   /* If we don't have another value */
G
Guy Schalnat 已提交
260
   else
A
Andreas Dilger 已提交
261
   {
262
      screen_gamma = 2.2;  /* A good guess for a PC monitor in a dimly
263
                              lit room */
A
Andreas Dilger 已提交
264 265
      screen_gamma = 1.7 or 1.0;  /* A good guess for Mac systems */
   }
G
Guy Schalnat 已提交
266

267
   /* Tell libpng to handle the gamma conversion for you.  The final call
A
Andreas Dilger 已提交
268 269 270 271
    * is a good guess for PC generated images, but it should be configurable
    * by the user at run time by the user.  It is strongly suggested that
    * your application support gamma correction.
    */
272 273 274

   int intent;

275
   if (png_get_sRGB(png_ptr, info_ptr, &intent))
276
      png_set_gamma(png_ptr, screen_gamma, 0.45455);
277 278 279
   else
   {
      double image_gamma;
280
      if (png_get_gAMA(png_ptr, info_ptr, &image_gamma))
281 282
         png_set_gamma(png_ptr, screen_gamma, image_gamma);
      else
283 284
         png_set_gamma(png_ptr, screen_gamma, 0.45455);
   }
G
Guy Schalnat 已提交
285

286 287
#ifdef PNG_READ_QUANTIZE_SUPPORTED
   /* Quantize RGB files down to 8 bit palette or reduce palettes
288 289
    * to the number of colors available on your screen.
    */
A
Andreas Dilger 已提交
290
   if (color_type & PNG_COLOR_MASK_COLOR)
G
Guy Schalnat 已提交
291
   {
292
      int num_palette;
A
Andreas Dilger 已提交
293 294 295
      png_colorp palette;

      /* This reduces the image to the application supplied palette */
296
      if (/* We have our own palette */)
G
Guy Schalnat 已提交
297
      {
298
         /* An array of colors to which the image should be quantized */
A
Andreas Dilger 已提交
299
         png_color std_color_cube[MAX_SCREEN_COLORS];
G
Guy Schalnat 已提交
300

301
         png_set_quantize(png_ptr, std_color_cube, MAX_SCREEN_COLORS,
302
            MAX_SCREEN_COLORS, NULL, 0);
A
Andreas Dilger 已提交
303 304
      }
      /* This reduces the image to the palette supplied in the file */
305
      else if (png_get_PLTE(png_ptr, info_ptr, &palette, &num_palette))
A
Andreas Dilger 已提交
306
      {
307
         png_uint_16p histogram = NULL;
A
Andreas Dilger 已提交
308 309 310

         png_get_hIST(png_ptr, info_ptr, &histogram);

311
         png_set_quantize(png_ptr, palette, num_palette,
A
Andreas Dilger 已提交
312
                        max_screen_colors, histogram, 0);
G
Guy Schalnat 已提交
313
      }
G
Guy Schalnat 已提交
314
   }
315
#endif /* PNG_READ_QUANTIZE_SUPPORTED */
G
Guy Schalnat 已提交
316

317
   /* Invert monochrome files to have 0 as white and 1 as black */
318
   png_set_invert_mono(png_ptr);
G
Guy Schalnat 已提交
319

A
Andreas Dilger 已提交
320 321 322 323 324 325
   /* If you want to shift the pixel values from the range [0,255] or
    * [0,65535] to the original [0,7] or [0,31], or whatever range the
    * colors were originally in:
    */
   if (png_get_valid(png_ptr, info_ptr, PNG_INFO_sBIT))
   {
326
      png_color_8p sig_bit_p;
A
Andreas Dilger 已提交
327

328 329
      png_get_sBIT(png_ptr, info_ptr, &sig_bit_p);
      png_set_shift(png_ptr, sig_bit_p);
A
Andreas Dilger 已提交
330
   }
G
Guy Schalnat 已提交
331

332
   /* Flip the RGB pixels to BGR (or RGBA to BGRA) */
333 334
   if (color_type & PNG_COLOR_MASK_COLOR)
      png_set_bgr(png_ptr);
G
Guy Schalnat 已提交
335

336
   /* Swap the RGBA or GA data to ARGB or AG (or BGRA to ABGR) */
A
Andreas Dilger 已提交
337
   png_set_swap_alpha(png_ptr);
G
Guy Schalnat 已提交
338

339
   /* Swap bytes of 16 bit files to least significant byte first */
A
Andreas Dilger 已提交
340
   png_set_swap(png_ptr);
G
Guy Schalnat 已提交
341

A
Andreas Dilger 已提交
342 343
   /* Add filler (or alpha) byte (before/after each RGB triplet) */
   png_set_filler(png_ptr, 0xff, PNG_FILLER_AFTER);
G
Guy Schalnat 已提交
344

345
#ifdef PNG_READ_INTERLACING_SUPPORTED
A
Andreas Dilger 已提交
346 347
   /* Turn on interlace handling.  REQUIRED if you are not using
    * png_read_image().  To see how to handle interlacing passes,
348
    * see the png_read_row() method below:
A
Andreas Dilger 已提交
349
    */
G
Guy Schalnat 已提交
350
   number_passes = png_set_interlace_handling(png_ptr);
351 352 353 354
#else
   number_passes = 1;
#endif /* PNG_READ_INTERLACING_SUPPORTED */

G
Guy Schalnat 已提交
355

356
   /* Optional call to gamma correct and add the background to the palette
A
Andreas Dilger 已提交
357 358 359
    * and update info structure.  REQUIRED if you are expecting libpng to
    * update the palette for you (ie you selected such a transform above).
    */
G
Guy Schalnat 已提交
360 361
   png_read_update_info(png_ptr, info_ptr);

362
   /* Allocate the memory to hold the image using the fields of info_ptr. */
G
Guy Schalnat 已提交
363

364
   /* The easiest way to read the image: */
G
Guy Schalnat 已提交
365
   png_bytep row_pointers[height];
G
Guy Schalnat 已提交
366

367 368 369 370
   /* Clear the pointer array */
   for (row = 0; row < height; row++)
      row_pointers[row] = NULL;

G
Guy Schalnat 已提交
371
   for (row = 0; row < height; row++)
372 373
      row_pointers[row] = png_malloc(png_ptr, png_get_rowbytes(png_ptr,
         info_ptr));
G
Guy Schalnat 已提交
374

A
Andreas Dilger 已提交
375
   /* Now it's time to read the image.  One of these methods is REQUIRED */
376
#ifdef entire /* Read the entire image in one go */
G
Guy Schalnat 已提交
377 378
   png_read_image(png_ptr, row_pointers);

379
#else no_entire /* Read the image one or more scanlines at a time */
380
   /* The other way to read images - deal with interlacing: */
G
Guy Schalnat 已提交
381 382 383

   for (pass = 0; pass < number_passes; pass++)
   {
384
#ifdef single /* Read the image a single row at a time */
G
Guy Schalnat 已提交
385 386
      for (y = 0; y < height; y++)
      {
387
         png_read_rows(png_ptr, &row_pointers[y], NULL, 1);
G
Guy Schalnat 已提交
388 389
      }

390
#else no_single /* Read the image several rows at a time */
A
Andreas Dilger 已提交
391 392
      for (y = 0; y < height; y += number_of_rows)
      {
393
#ifdef sparkle /* Read the image using the "sparkle" effect. */
394 395
         png_read_rows(png_ptr, &row_pointers[y], NULL,
            number_of_rows);
396
#else no_sparkle /* Read the image using the "rectangle" effect */
397 398
         png_read_rows(png_ptr, NULL, &row_pointers[y],
            number_of_rows);
399
#endif no_sparkle /* Use only one of these two methods */
A
Andreas Dilger 已提交
400
      }
401

402 403
      /* If you want to display the image after every pass, do so here */
#endif no_single /* Use only one of these two methods */
G
Guy Schalnat 已提交
404
   }
405
#endif no_entire /* Use only one of these two methods */
G
Guy Schalnat 已提交
406

407
   /* Read rest of file, and get additional chunks in info_ptr - REQUIRED */
G
Guy Schalnat 已提交
408
   png_read_end(png_ptr, info_ptr);
409 410 411
#endif hilevel

   /* At this point you have read the entire image */
G
Guy Schalnat 已提交
412

413
   /* Clean up after the read, and free any memory allocated - REQUIRED */
414
   png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
G
Guy Schalnat 已提交
415

416
   /* Close the file */
G
Guy Schalnat 已提交
417 418
   fclose(fp);

419
   /* That's it */
420
   return (OK);
G
Guy Schalnat 已提交
421 422
}

423
/* Progressively read a file */
G
Guy Schalnat 已提交
424 425

int
G
Guy Schalnat 已提交
426
initialize_png_reader(png_structp *png_ptr, png_infop *info_ptr)
G
Guy Schalnat 已提交
427
{
G
Guy Schalnat 已提交
428
   /* Create and initialize the png_struct with the desired error handler
A
Andreas Dilger 已提交
429 430 431 432
    * functions.  If you want to use the default stderr and longjump method,
    * you can supply NULL for the last three parameters.  We also check that
    * the library version is compatible in case we are using dynamically
    * linked libraries.
G
Guy Schalnat 已提交
433 434
    */
   *png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
435
       png_voidp user_error_ptr, user_error_fn, user_warning_fn);
G
Guy Schalnat 已提交
436

A
Andreas Dilger 已提交
437
   if (*png_ptr == NULL)
G
Guy Schalnat 已提交
438
   {
G
Guy Schalnat 已提交
439
      *info_ptr = NULL;
440
      return (ERROR);
G
Guy Schalnat 已提交
441 442
   }

G
Guy Schalnat 已提交
443 444
   *info_ptr = png_create_info_struct(png_ptr);

A
Andreas Dilger 已提交
445
   if (*info_ptr == NULL)
G
Guy Schalnat 已提交
446
   {
447
      png_destroy_read_struct(png_ptr, info_ptr, NULL);
448
      return (ERROR);
G
Guy Schalnat 已提交
449 450
   }

451
   if (setjmp(png_jmpbuf((*png_ptr))))
G
Guy Schalnat 已提交
452
   {
453
      png_destroy_read_struct(png_ptr, info_ptr, NULL);
454
      return (ERROR);
G
Guy Schalnat 已提交
455
   }
G
Guy Schalnat 已提交
456

457
   /* This one's new.  You will need to provide all three
A
Andreas Dilger 已提交
458
    * function callbacks, even if you aren't using them all.
459 460 461
    * If you aren't using all functions, you can specify NULL
    * parameters.  Even when all three functions are NULL,
    * you need to call png_set_progressive_read_fn().
A
Andreas Dilger 已提交
462 463 464 465 466 467 468
    * These functions shouldn't be dependent on global or
    * static variables if you are decoding several images
    * simultaneously.  You should store stream specific data
    * in a separate struct, given as the second parameter,
    * and retrieve the pointer from inside the callbacks using
    * the function png_get_progressive_ptr(png_ptr).
    */
G
Guy Schalnat 已提交
469
   png_set_progressive_read_fn(*png_ptr, (void *)stream_data,
G
Guy Schalnat 已提交
470 471
      info_callback, row_callback, end_callback);

472
   return (OK);
G
Guy Schalnat 已提交
473 474 475
}

int
G
Guy Schalnat 已提交
476 477
process_data(png_structp *png_ptr, png_infop *info_ptr,
   png_bytep buffer, png_uint_32 length)
G
Guy Schalnat 已提交
478
{
479
   if (setjmp(png_jmpbuf((*png_ptr))))
G
Guy Schalnat 已提交
480
   {
G
Guy Schalnat 已提交
481
      /* Free the png_ptr and info_ptr memory on error */
482
      png_destroy_read_struct(png_ptr, info_ptr, NULL);
483
      return (ERROR);
G
Guy Schalnat 已提交
484 485
   }

A
Andreas Dilger 已提交
486 487
   /* This one's new also.  Simply give it chunks of data as
    * they arrive from the data stream (in order, of course).
488
    * On segmented machines, don't give it any more than 64K.
A
Andreas Dilger 已提交
489 490 491 492 493 494 495
    * The library seems to run fine with sizes of 4K, although
    * you can give it much less if necessary (I assume you can
    * give it chunks of 1 byte, but I haven't tried with less
    * than 256 bytes yet).  When this function returns, you may
    * want to display any rows that were generated in the row
    * callback, if you aren't already displaying them there.
    */
G
Guy Schalnat 已提交
496
   png_process_data(*png_ptr, *info_ptr, buffer, length);
497
   return (OK);
G
Guy Schalnat 已提交
498 499 500 501
}

info_callback(png_structp png_ptr, png_infop info)
{
502 503 504 505 506 507 508
   /* Do any setup here, including setting any of the transformations
    * mentioned in the Reading PNG files section.  For now, you _must_
    * call either png_start_read_image() or png_read_update_info()
    * after all the transformations are set (even if you don't set
    * any).  You may start getting rows before png_process_data()
    * returns, so this is your last chance to prepare for that.
    */
G
Guy Schalnat 已提交
509 510 511
}

row_callback(png_structp png_ptr, png_bytep new_row,
G
Guy Schalnat 已提交
512
   png_uint_32 row_num, int pass)
G
Guy Schalnat 已提交
513
{
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
   /*
    * This function is called for every row in the image.  If the
    * image is interlaced, and you turned on the interlace handler,
    * this function will be called for every row in every pass.
    *
    * In this function you will receive a pointer to new row data from
    * libpng called new_row that is to replace a corresponding row (of
    * the same data format) in a buffer allocated by your application.
    *
    * The new row data pointer "new_row" may be NULL, indicating there is
    * no new data to be replaced (in cases of interlace loading).
    *
    * If new_row is not NULL then you need to call
    * png_progressive_combine_row() to replace the corresponding row as
    * shown below:
    */

531 532 533 534 535
   /* Get pointer to corresponding row in our
    * PNG read buffer.
    */
   png_bytep old_row = ((png_bytep *)our_data)[row_num];

536
#ifdef PNG_READ_INTERLACING_SUPPORTED
537 538 539 540 541 542
   /* If both rows are allocated then copy the new row
    * data to the corresponding row data.
    */
   if ((old_row != NULL) && (new_row != NULL))
   png_progressive_combine_row(png_ptr, old_row, new_row);

543 544 545 546 547 548 549 550 551 552 553 554
   /*
    * The rows and passes are called in order, so you don't really
    * need the row_num and pass, but I'm supplying them because it
    * may make your life easier.
    *
    * For the non-NULL rows of interlaced images, you must call
    * png_progressive_combine_row() passing in the new row and the
    * old row, as demonstrated above.  You can call this function for
    * NULL rows (it will just return) and for non-interlaced images
    * (it just does the png_memcpy for you) if it will make the code
    * easier.  Thus, you can just do this for all cases:
    */
G
Guy Schalnat 已提交
555 556 557

   png_progressive_combine_row(png_ptr, old_row, new_row);

558 559 560 561 562 563 564
   /* where old_row is what was displayed for previous rows.  Note
    * that the first pass (pass == 0 really) will completely cover
    * the old row, so the rows do not have to be initialized.  After
    * the first pass (and only for interlaced images), you will have
    * to pass the current row as new_row, and the function will combine
    * the old row and the new row.
    */
565
#endif /* PNG_READ_INTERLACING_SUPPORTED */
G
Guy Schalnat 已提交
566 567 568 569
}

end_callback(png_structp png_ptr, png_infop info)
{
570 571 572 573 574 575 576 577 578
   /* This function is called when the whole image has been read,
    * including any chunks after the image (up to and including
    * the IEND).  You will usually have the same info chunk as you
    * had in the header, although some data may have been added
    * to the comments and time fields.
    *
    * Most people won't do much here, perhaps setting a flag that
    * marks the image as finished.
    */
G
Guy Schalnat 已提交
579 580
}

581
/* Write a png file */
582
void write_png(char *file_name /* , ... other image information ... */)
G
Guy Schalnat 已提交
583 584
{
   FILE *fp;
G
Guy Schalnat 已提交
585 586
   png_structp png_ptr;
   png_infop info_ptr;
587
   png_colorp palette;
G
Guy Schalnat 已提交
588

589
   /* Open the file */
G
Guy Schalnat 已提交
590
   fp = fopen(file_name, "wb");
A
Andreas Dilger 已提交
591
   if (fp == NULL)
592
      return (ERROR);
G
Guy Schalnat 已提交
593

G
Guy Schalnat 已提交
594
   /* Create and initialize the png_struct with the desired error handler
A
Andreas Dilger 已提交
595 596 597 598
    * functions.  If you want to use the default stderr and longjump method,
    * you can supply NULL for the last three parameters.  We also check that
    * the library version is compatible with the one used at compile time,
    * in case we are using dynamically linked libraries.  REQUIRED.
G
Guy Schalnat 已提交
599 600
    */
   png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING,
601
      png_voidp user_error_ptr, user_error_fn, user_warning_fn);
G
Guy Schalnat 已提交
602

A
Andreas Dilger 已提交
603
   if (png_ptr == NULL)
G
Guy Schalnat 已提交
604 605
   {
      fclose(fp);
606
      return (ERROR);
G
Guy Schalnat 已提交
607 608
   }

A
Andreas Dilger 已提交
609
   /* Allocate/initialize the image information data.  REQUIRED */
G
Guy Schalnat 已提交
610
   info_ptr = png_create_info_struct(png_ptr);
A
Andreas Dilger 已提交
611
   if (info_ptr == NULL)
G
Guy Schalnat 已提交
612 613
   {
      fclose(fp);
614
      png_destroy_write_struct(&png_ptr,  NULL);
615
      return (ERROR);
G
Guy Schalnat 已提交
616 617
   }

A
Andreas Dilger 已提交
618
   /* Set error handling.  REQUIRED if you aren't supplying your own
619
    * error handling functions in the png_create_write_struct() call.
A
Andreas Dilger 已提交
620
    */
621
   if (setjmp(png_jmpbuf(png_ptr)))
G
Guy Schalnat 已提交
622
   {
623
      /* If we get here, we had a problem writing the file */
G
Guy Schalnat 已提交
624
      fclose(fp);
625
      png_destroy_write_struct(&png_ptr, &info_ptr);
626
      return (ERROR);
G
Guy Schalnat 已提交
627 628
   }

A
Andreas Dilger 已提交
629
   /* One of the following I/O initialization functions is REQUIRED */
630

631
#ifdef streams /* I/O initialization method 1 */
632
   /* Set up the output control if you are using standard C streams */
G
Guy Schalnat 已提交
633
   png_init_io(png_ptr, fp);
634

635
#else no_streams /* I/O initialization method 2 */
636
   /* If you are using replacement write functions, instead of calling
637 638
    * png_init_io() here you would call
    */
A
Andreas Dilger 已提交
639 640 641
   png_set_write_fn(png_ptr, (void *)user_io_ptr, user_write_fn,
      user_IO_flush_function);
   /* where user_io_ptr is a structure you want available to the callbacks */
642
#endif no_streams /* Only use one initialization method */
A
Andreas Dilger 已提交
643

644 645
#ifdef hilevel
   /* This is the easy way.  Use it if you already have all the
646
    * image info living in the structure.  You could "|" many
647 648
    * PNG_TRANSFORM flags into the png_transforms integer here.
    */
649
   png_write_png(png_ptr, info_ptr, png_transforms, NULL);
650

651 652 653
#else
   /* This is the hard way */

A
Andreas Dilger 已提交
654 655 656 657 658 659 660 661 662 663
   /* Set the image information here.  Width and height are up to 2^31,
    * bit_depth is one of 1, 2, 4, 8, or 16, but valid values also depend on
    * the color_type selected. color_type is one of PNG_COLOR_TYPE_GRAY,
    * PNG_COLOR_TYPE_GRAY_ALPHA, PNG_COLOR_TYPE_PALETTE, PNG_COLOR_TYPE_RGB,
    * or PNG_COLOR_TYPE_RGB_ALPHA.  interlace is either PNG_INTERLACE_NONE or
    * PNG_INTERLACE_ADAM7, and the compression_type and filter_type MUST
    * currently be PNG_COMPRESSION_TYPE_BASE and PNG_FILTER_TYPE_BASE. REQUIRED
    */
   png_set_IHDR(png_ptr, info_ptr, width, height, bit_depth, PNG_COLOR_TYPE_???,
      PNG_INTERLACE_????, PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
G
Guy Schalnat 已提交
664

665
   /* Set the palette if there is one.  REQUIRED for indexed-color images */
666
   palette = (png_colorp)png_malloc(png_ptr, PNG_MAX_PALETTE_LENGTH
667
             * png_sizeof(png_color));
668
   /* ... Set palette colors ... */
669
   png_set_PLTE(png_ptr, info_ptr, palette, PNG_MAX_PALETTE_LENGTH);
670
   /* You must not free palette here, because png_set_PLTE only makes a link to
671 672 673
    * the palette that you malloced.  Wait until you are about to destroy
    * the png structure.
    */
G
Guy Schalnat 已提交
674

675
   /* Optional significant bit (sBIT) chunk */
676
   png_color_8 sig_bit;
677

678
   /* If we are dealing with a grayscale image then */
A
Andreas Dilger 已提交
679
   sig_bit.gray = true_bit_depth;
680

681
   /* Otherwise, if we are dealing with a color image then */
A
Andreas Dilger 已提交
682 683 684
   sig_bit.red = true_red_bit_depth;
   sig_bit.green = true_green_bit_depth;
   sig_bit.blue = true_blue_bit_depth;
685

686
   /* If the image has an alpha channel then */
A
Andreas Dilger 已提交
687
   sig_bit.alpha = true_alpha_bit_depth;
688

689
   png_set_sBIT(png_ptr, info_ptr, &sig_bit);
G
Guy Schalnat 已提交
690

691

A
Andreas Dilger 已提交
692
   /* Optional gamma chunk is strongly suggested if you have any guess
693 694
    * as to the correct gamma of the image.
    */
A
Andreas Dilger 已提交
695 696 697
   png_set_gAMA(png_ptr, info_ptr, gamma);

   /* Optionally write comments into the image */
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729
   {
      png_text text_ptr[3];

      char key0[]="Title";
      char text0[]="Mona Lisa";
      text_ptr[0].key = key0;
      text_ptr[0].text = text0;
      text_ptr[0].compression = PNG_TEXT_COMPRESSION_NONE;
      text_ptr[0].itxt_length = 0;
      text_ptr[0].lang = NULL;
      text_ptr[0].lang_key = NULL;

      char key1[]="Author";
      char text1[]="Leonardo DaVinci";
      text_ptr[1].key = key1;
      text_ptr[1].text = text1;
      text_ptr[1].compression = PNG_TEXT_COMPRESSION_NONE;
      text_ptr[1].itxt_length = 0;
      text_ptr[1].lang = NULL;
      text_ptr[1].lang_key = NULL;

      char key2[]="Description";
      char text2[]="<long text>";
      text_ptr[2].key = key2;
      text_ptr[2].text = text2;
      text_ptr[2].compression = PNG_TEXT_COMPRESSION_zTXt;
      text_ptr[2].itxt_length = 0;
      text_ptr[2].lang = NULL;
      text_ptr[2].lang_key = NULL;

      png_set_text(write_ptr, write_info_ptr, text_ptr, 3);
   }
A
Andreas Dilger 已提交
730

731
   /* Other optional chunks like cHRM, bKGD, tRNS, tIME, oFFs, pHYs */
732

733
   /* Note that if sRGB is present the gAMA and cHRM chunks must be ignored
734
    * on read and, if your application chooses to write them, they must
735 736
    * be written in accordance with the sRGB profile
    */
A
Andreas Dilger 已提交
737 738

   /* Write the file header information.  REQUIRED */
G
Guy Schalnat 已提交
739 740
   png_write_info(png_ptr, info_ptr);

741 742 743 744 745 746
   /* If you want, you can write the info in two steps, in case you need to
    * write your private chunk ahead of PLTE:
    *
    *   png_write_info_before_PLTE(write_ptr, write_info_ptr);
    *   write_my_chunk();
    *   png_write_info(png_ptr, info_ptr);
747
    *
748
    * However, given the level of known- and unknown-chunk support in 1.2.0
749
    * and up, this should no longer be necessary.
750 751
    */

A
Andreas Dilger 已提交
752 753 754 755 756 757
   /* Once we write out the header, the compression type on the text
    * chunks gets changed to PNG_TEXT_COMPRESSION_NONE_WR or
    * PNG_TEXT_COMPRESSION_zTXt_WR, so it doesn't get written out again
    * at the end.
    */

758
   /* Set up the transformations you want.  Note that these are
759 760
    * all optional.  Only call them if you want them.
    */
G
Guy Schalnat 已提交
761

762
   /* Invert monochrome pixels */
763
   png_set_invert_mono(png_ptr);
G
Guy Schalnat 已提交
764

A
Andreas Dilger 已提交
765
   /* Shift the pixels up to a legal bit depth and fill in
766 767
    * as appropriate to correctly scale the image.
    */
A
Andreas Dilger 已提交
768
   png_set_shift(png_ptr, &sig_bit);
G
Guy Schalnat 已提交
769

770
   /* Pack pixels into bytes */
G
Guy Schalnat 已提交
771 772
   png_set_packing(png_ptr);

773
   /* Swap location of alpha bytes from ARGB to RGBA */
A
Andreas Dilger 已提交
774 775 776
   png_set_swap_alpha(png_ptr);

   /* Get rid of filler (OR ALPHA) bytes, pack XRGB/RGBX/ARGB/RGBA into
777 778
    * RGB (4 channels -> 3 channels). The second parameter is not used.
    */
A
Andreas Dilger 已提交
779 780
   png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);

781
   /* Flip BGR pixels to RGB */
G
Guy Schalnat 已提交
782 783
   png_set_bgr(png_ptr);

784
   /* Swap bytes of 16-bit files to most significant byte first */
G
Guy Schalnat 已提交
785 786
   png_set_swap(png_ptr);

787
   /* Swap bits of 1, 2, 4 bit packed pixel formats */
A
Andreas Dilger 已提交
788
   png_set_packswap(png_ptr);
G
Guy Schalnat 已提交
789

790
   /* Turn on interlace handling if you are not using png_write_image() */
G
Guy Schalnat 已提交
791 792
   if (interlacing)
      number_passes = png_set_interlace_handling(png_ptr);
793

G
Guy Schalnat 已提交
794 795 796
   else
      number_passes = 1;

A
Andreas Dilger 已提交
797 798 799 800
   /* The easiest way to write the image (you may have a different memory
    * layout, however, so choose what fits your needs best).  You need to
    * use the first method if you aren't handling interlacing yourself.
    */
801
   png_uint_32 k, height, width;
802
   png_byte image[height][width*bytes_per_pixel];
803
   png_bytep row_pointers[height];
804

805
   if (height > PNG_UINT_32_MAX/png_sizeof(png_bytep))
806 807
     png_error (png_ptr, "Image is too tall to process in memory");

808
   for (k = 0; k < height; k++)
809
     row_pointers[k] = image + k*width*bytes_per_pixel;
G
Guy Schalnat 已提交
810

A
Andreas Dilger 已提交
811
   /* One of the following output methods is REQUIRED */
812 813

#ifdef entire /* Write out the entire image data in one call */
G
Guy Schalnat 已提交
814 815
   png_write_image(png_ptr, row_pointers);

816
   /* The other way to write the image - deal with interlacing */
G
Guy Schalnat 已提交
817

818 819
#else no_entire /* Write out the image data by one or more scanlines */

A
Andreas Dilger 已提交
820 821 822
   /* The number of passes is either 1 for non-interlaced images,
    * or 7 for interlaced images.
    */
G
Guy Schalnat 已提交
823 824 825
   for (pass = 0; pass < number_passes; pass++)
   {
      /* Write a few rows at a time. */
826
      png_write_rows(png_ptr, &row_pointers[first_row], number_of_rows);
G
Guy Schalnat 已提交
827 828 829

      /* If you are only writing one row at a time, this works */
      for (y = 0; y < height; y++)
830
         png_write_rows(png_ptr, &row_pointers[y], 1);
G
Guy Schalnat 已提交
831
   }
832
#endif no_entire /* Use only one output method */
G
Guy Schalnat 已提交
833

A
Andreas Dilger 已提交
834
   /* You can write optional chunks like tEXt, zTXt, and tIME at the end
835
    * as well.  Shouldn't be necessary in 1.2.0 and up as all the public
836 837
    * chunks are supported and you can use png_set_unknown_chunks() to
    * register unknown chunks into the info structure to be written out.
G
Guy Schalnat 已提交
838 839
    */

A
Andreas Dilger 已提交
840
   /* It is REQUIRED to call this to finish writing the rest of the file */
G
Guy Schalnat 已提交
841
   png_write_end(png_ptr, info_ptr);
842
#endif hilevel
G
Guy Schalnat 已提交
843

844
   /* If you png_malloced a palette, free it here (don't free info_ptr->palette,
845 846 847 848 849
    * as recommended in versions 1.0.5m and earlier of this example; if
    * libpng mallocs info_ptr->palette, libpng will free it).  If you
    * allocated it with malloc() instead of png_malloc(), use free() instead
    * of png_free().
    */
850
   png_free(png_ptr, palette);
851
   palette = NULL;
852 853

   /* Similarly, if you png_malloced any data that you passed in with
854 855 856
    * png_set_something(), such as a hist or trans array, free it here,
    * when you can be sure that libpng is through with it.
    */
857
   png_free(png_ptr, trans);
858
   trans = NULL;
859 860 861 862 863
   /* Whenever you use png_free() it is a good idea to set the pointer to
    * NULL in case your application inadvertently tries to png_free() it
    * again.  When png_free() sees a NULL it returns without action, thus
    * avoiding the double-free security problem.
    */
G
Guy Schalnat 已提交
864

865
   /* Clean up after the write, and free any memory allocated */
866
   png_destroy_write_struct(&png_ptr, &info_ptr);
G
Guy Schalnat 已提交
867

868
   /* Close the file */
G
Guy Schalnat 已提交
869 870
   fclose(fp);

871
   /* That's it */
872
   return (OK);
G
Guy Schalnat 已提交
873 874
}

875
#endif /* if 0 */