example.c 29.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.4.0 [December 25, 2009]
6
 * This file has been placed in the public domain by the authors.
7
 * Maintained 1998-2009 Glenn Randers-Pehrson
8 9 10
 * Maintained 1996, 1997 Andreas Dilger)
 * Written 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
 */
G
Guy Schalnat 已提交
11

A
Andreas Dilger 已提交
12
/* This is an example of how to use libpng to read and write PNG files.
13 14
 * The file libpng.txt is much more verbose then this.  If you have not
 * read it, do so first.  This was designed to be a starting point of an
15 16
 * implementation.  This is not officially part of libpng, is hereby placed
 * in the public domain, and therefore does not require a copyright notice.
17 18 19 20
 *
 * 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
21 22
 * working PNG reader/writer, see pngtest.c, included in this distribution;
 * see also the programs in the contrib directory.
23
 */
G
Guy Schalnat 已提交
24

25
#include "png.h"
G
Guy Schalnat 已提交
26

27 28 29 30 31 32 33 34 35 36
 /* 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
#  define png_jmpbuf(png_ptr) ((png_ptr)->jmpbuf)
#endif

37 38 39 40 41
/* 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.
42 43 44 45 46 47 48 49 50 51 52 53
 *
 * 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
54
 * to pass the bytes to png_sig_cmp() or even skip that if you know
55 56
 * you have a PNG file, and call png_set_sig_bytes().
 */
A
Andreas Dilger 已提交
57 58
#define PNG_BYTES_TO_CHECK 4
int check_if_png(char *file_name, FILE **fp)
G
Guy Schalnat 已提交
59
{
A
Andreas Dilger 已提交
60
   char buf[PNG_BYTES_TO_CHECK];
G
Guy Schalnat 已提交
61

A
Andreas Dilger 已提交
62
   /* Open the prospective PNG file. */
63
   if ((*fp = fopen(file_name, "rb")) == NULL)
G
Guy Schalnat 已提交
64 65
      return 0;

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

70 71 72
   /* Compare the first PNG_BYTES_TO_CHECK bytes of the signature.
      Return nonzero (true) if they match */

73
   return(!png_sig_cmp(buf, (png_size_t)0, PNG_BYTES_TO_CHECK));
G
Guy Schalnat 已提交
74 75
}

A
Andreas Dilger 已提交
76
/* Read a PNG file.  You may want to return an error code if the read
77 78 79 80 81
 * 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).
 */
82
#ifdef open_file /* prototype 1 */
A
Andreas Dilger 已提交
83
void read_png(char *file_name)  /* We need to open the file */
G
Guy Schalnat 已提交
84
{
G
Guy Schalnat 已提交
85
   png_structp png_ptr;
G
Guy Schalnat 已提交
86
   png_infop info_ptr;
A
Andreas Dilger 已提交
87 88 89
   unsigned int sig_read = 0;
   png_uint_32 width, height;
   int bit_depth, color_type, interlace_type;
A
Andreas Dilger 已提交
90
   FILE *fp;
G
Guy Schalnat 已提交
91

A
Andreas Dilger 已提交
92
   if ((fp = fopen(file_name, "rb")) == NULL)
93
      return (ERROR);
94

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

G
Guy Schalnat 已提交
104
   /* Create and initialize the png_struct with the desired error handler
A
Andreas Dilger 已提交
105 106 107 108 109
    * 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 已提交
110
   png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
111
      png_voidp user_error_ptr, user_error_fn, user_warning_fn);
G
Guy Schalnat 已提交
112

A
Andreas Dilger 已提交
113
   if (png_ptr == NULL)
G
Guy Schalnat 已提交
114 115
   {
      fclose(fp);
116
      return (ERROR);
G
Guy Schalnat 已提交
117 118
   }

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

A
Andreas Dilger 已提交
128 129 130 131
   /* 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.
    */
132 133

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

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

147
#else no_streams /* PNG file I/O method 2 */
A
Andreas Dilger 已提交
148
   /* If you are using replacement read functions, instead of calling
149 150
    * png_init_io() here you would call:
    */
G
Guy Schalnat 已提交
151 152
   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 */
153
#endif no_streams /* Use only one I/O method! */
G
Guy Schalnat 已提交
154

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

158 159 160 161 162 163 164 165 166
#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
    * dithering, filling, setting background, and doing gamma
    * adjustment), then you can read the entire image (including
    * pixels) into the info structure with this call:
    */
167
   png_read_png(png_ptr, info_ptr, png_transforms, NULL);
168

169 170 171
#else
   /* OK, you're doing it the hard way, with the lower-level functions */

A
Andreas Dilger 已提交
172 173 174
   /* 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 已提交
175
   png_read_info(png_ptr, info_ptr);
G
Guy Schalnat 已提交
176

A
Andreas Dilger 已提交
177
   png_get_IHDR(png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
178
       &interlace_type, NULL, NULL);
A
Andreas Dilger 已提交
179

180 181 182 183 184
   /* 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 已提交
185

186
   /* Tell libpng to strip 16 bit/color files down to 8 bits/color */
A
Andreas Dilger 已提交
187 188
   png_set_strip_16(png_ptr);

189
   /* Strip alpha bytes from the input data without combining with the
190 191
    * background (not recommended).
    */
A
Andreas Dilger 已提交
192 193
   png_set_strip_alpha(png_ptr);

194
   /* Extract multiple pixels with bit depths of 1, 2, and 4 from a single
A
Andreas Dilger 已提交
195 196 197 198
    * byte into separate bytes (useful for paletted and grayscale images).
    */
   png_set_packing(png_ptr);

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

203
   /* Expand paletted colors into true RGB triplets */
A
Andreas Dilger 已提交
204
   if (color_type == PNG_COLOR_TYPE_PALETTE)
205
      png_set_palette_to_rgb(png_ptr);
G
Guy Schalnat 已提交
206

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

211 212 213
   /* Expand paletted or RGB images with transparency to full alpha channels
    * so the data will be available as RGBA quartets.
    */
A
Andreas Dilger 已提交
214
   if (png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS))
215
      png_set_tRNS_to_alpha(png_ptr);
G
Guy Schalnat 已提交
216

A
Andreas Dilger 已提交
217 218 219 220 221 222
   /* 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 已提交
223

224
   png_color_16 my_background, *image_background;
G
Guy Schalnat 已提交
225

226 227
   if (png_get_bKGD(png_ptr, info_ptr, &image_background))
      png_set_background(png_ptr, image_background,
G
Guy Schalnat 已提交
228
                         PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
G
Guy Schalnat 已提交
229 230
   else
      png_set_background(png_ptr, &my_background,
G
Guy Schalnat 已提交
231
                         PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
G
Guy Schalnat 已提交
232

233 234 235
   /* Some suggestions as to how to get a screen gamma value
    *
    * Note that screen gamma is the display_exponent, which includes
236 237
    * the CRT_exponent and any correction for viewing conditions
    */
A
Andreas Dilger 已提交
238 239 240 241 242
   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 */
243
   else if ((gamma_str = getenv("SCREEN_GAMMA")) != NULL)
A
Andreas Dilger 已提交
244 245 246 247
   {
      screen_gamma = atof(gamma_str);
   }
   /* If we don't have another value */
G
Guy Schalnat 已提交
248
   else
A
Andreas Dilger 已提交
249
   {
250
      screen_gamma = 2.2;  /* A good guess for a PC monitor in a dimly
251
                              lit room */
A
Andreas Dilger 已提交
252 253
      screen_gamma = 1.7 or 1.0;  /* A good guess for Mac systems */
   }
G
Guy Schalnat 已提交
254

255
   /* Tell libpng to handle the gamma conversion for you.  The final call
A
Andreas Dilger 已提交
256 257 258 259
    * 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.
    */
260 261 262

   int intent;

263
   if (png_get_sRGB(png_ptr, info_ptr, &intent))
264
      png_set_gamma(png_ptr, screen_gamma, 0.45455);
265 266 267
   else
   {
      double image_gamma;
268
      if (png_get_gAMA(png_ptr, info_ptr, &image_gamma))
269 270
         png_set_gamma(png_ptr, screen_gamma, image_gamma);
      else
271 272
         png_set_gamma(png_ptr, screen_gamma, 0.45455);
   }
G
Guy Schalnat 已提交
273

A
Andreas Dilger 已提交
274
   /* Dither RGB files down to 8 bit palette or reduce palettes
275 276
    * to the number of colors available on your screen.
    */
A
Andreas Dilger 已提交
277
   if (color_type & PNG_COLOR_MASK_COLOR)
G
Guy Schalnat 已提交
278
   {
279
      int num_palette;
A
Andreas Dilger 已提交
280 281 282
      png_colorp palette;

      /* This reduces the image to the application supplied palette */
283
      if (/* We have our own palette */)
G
Guy Schalnat 已提交
284
      {
A
Andreas Dilger 已提交
285 286
         /* An array of colors to which the image should be dithered */
         png_color std_color_cube[MAX_SCREEN_COLORS];
G
Guy Schalnat 已提交
287 288

         png_set_dither(png_ptr, std_color_cube, MAX_SCREEN_COLORS,
289
            MAX_SCREEN_COLORS, NULL, 0);
A
Andreas Dilger 已提交
290 291
      }
      /* This reduces the image to the palette supplied in the file */
292
      else if (png_get_PLTE(png_ptr, info_ptr, &palette, &num_palette))
A
Andreas Dilger 已提交
293
      {
294
         png_uint_16p histogram = NULL;
A
Andreas Dilger 已提交
295 296 297 298 299

         png_get_hIST(png_ptr, info_ptr, &histogram);

         png_set_dither(png_ptr, palette, num_palette,
                        max_screen_colors, histogram, 0);
G
Guy Schalnat 已提交
300
      }
G
Guy Schalnat 已提交
301
   }
G
Guy Schalnat 已提交
302

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

A
Andreas Dilger 已提交
306 307 308 309 310 311
   /* 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))
   {
312
      png_color_8p sig_bit_p;
A
Andreas Dilger 已提交
313

314 315
      png_get_sBIT(png_ptr, info_ptr, &sig_bit_p);
      png_set_shift(png_ptr, sig_bit_p);
A
Andreas Dilger 已提交
316
   }
G
Guy Schalnat 已提交
317

318
   /* Flip the RGB pixels to BGR (or RGBA to BGRA) */
319 320
   if (color_type & PNG_COLOR_MASK_COLOR)
      png_set_bgr(png_ptr);
G
Guy Schalnat 已提交
321

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

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

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

A
Andreas Dilger 已提交
331 332
   /* Turn on interlace handling.  REQUIRED if you are not using
    * png_read_image().  To see how to handle interlacing passes,
333
    * see the png_read_row() method below:
A
Andreas Dilger 已提交
334
    */
G
Guy Schalnat 已提交
335
   number_passes = png_set_interlace_handling(png_ptr);
G
Guy Schalnat 已提交
336

337
   /* Optional call to gamma correct and add the background to the palette
A
Andreas Dilger 已提交
338 339 340
    * 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 已提交
341 342
   png_read_update_info(png_ptr, info_ptr);

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

345
   /* The easiest way to read the image: */
G
Guy Schalnat 已提交
346
   png_bytep row_pointers[height];
G
Guy Schalnat 已提交
347

348 349 350 351
   /* Clear the pointer array */
   for (row = 0; row < height; row++)
      row_pointers[row] = NULL;

G
Guy Schalnat 已提交
352
   for (row = 0; row < height; row++)
353 354
      row_pointers[row] = png_malloc(png_ptr, png_get_rowbytes(png_ptr,
         info_ptr));
G
Guy Schalnat 已提交
355

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

360
#else no_entire /* Read the image one or more scanlines at a time */
361
   /* The other way to read images - deal with interlacing: */
G
Guy Schalnat 已提交
362 363 364

   for (pass = 0; pass < number_passes; pass++)
   {
365
#ifdef single /* Read the image a single row at a time */
G
Guy Schalnat 已提交
366 367
      for (y = 0; y < height; y++)
      {
368
         png_read_rows(png_ptr, &row_pointers[y], NULL, 1);
G
Guy Schalnat 已提交
369 370
      }

371
#else no_single /* Read the image several rows at a time */
A
Andreas Dilger 已提交
372 373
      for (y = 0; y < height; y += number_of_rows)
      {
374
#ifdef sparkle /* Read the image using the "sparkle" effect. */
375 376
         png_read_rows(png_ptr, &row_pointers[y], NULL,
            number_of_rows);
377
#else no_sparkle /* Read the image using the "rectangle" effect */
378 379
         png_read_rows(png_ptr, NULL, &row_pointers[y],
            number_of_rows);
380
#endif no_sparkle /* Use only one of these two methods */
A
Andreas Dilger 已提交
381
      }
382

383 384
      /* 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 已提交
385
   }
386
#endif no_entire /* Use only one of these two methods */
G
Guy Schalnat 已提交
387

388
   /* Read rest of file, and get additional chunks in info_ptr - REQUIRED */
G
Guy Schalnat 已提交
389
   png_read_end(png_ptr, info_ptr);
390 391 392
#endif hilevel

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

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

397
   /* Close the file */
G
Guy Schalnat 已提交
398 399
   fclose(fp);

400
   /* That's it */
401
   return (OK);
G
Guy Schalnat 已提交
402 403
}

404
/* Progressively read a file */
G
Guy Schalnat 已提交
405 406

int
G
Guy Schalnat 已提交
407
initialize_png_reader(png_structp *png_ptr, png_infop *info_ptr)
G
Guy Schalnat 已提交
408
{
G
Guy Schalnat 已提交
409
   /* Create and initialize the png_struct with the desired error handler
A
Andreas Dilger 已提交
410 411 412 413
    * 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 已提交
414 415
    */
   *png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
416
       png_voidp user_error_ptr, user_error_fn, user_warning_fn);
G
Guy Schalnat 已提交
417

A
Andreas Dilger 已提交
418
   if (*png_ptr == NULL)
G
Guy Schalnat 已提交
419
   {
G
Guy Schalnat 已提交
420
      *info_ptr = NULL;
421
      return (ERROR);
G
Guy Schalnat 已提交
422 423
   }

G
Guy Schalnat 已提交
424 425
   *info_ptr = png_create_info_struct(png_ptr);

A
Andreas Dilger 已提交
426
   if (*info_ptr == NULL)
G
Guy Schalnat 已提交
427
   {
428
      png_destroy_read_struct(png_ptr, info_ptr, NULL);
429
      return (ERROR);
G
Guy Schalnat 已提交
430 431
   }

432
   if (setjmp(png_jmpbuf((*png_ptr))))
G
Guy Schalnat 已提交
433
   {
434
      png_destroy_read_struct(png_ptr, info_ptr, NULL);
435
      return (ERROR);
G
Guy Schalnat 已提交
436
   }
G
Guy Schalnat 已提交
437

438
   /* This one's new.  You will need to provide all three
A
Andreas Dilger 已提交
439
    * function callbacks, even if you aren't using them all.
440 441 442
    * 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 已提交
443 444 445 446 447 448 449
    * 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 已提交
450
   png_set_progressive_read_fn(*png_ptr, (void *)stream_data,
G
Guy Schalnat 已提交
451 452
      info_callback, row_callback, end_callback);

453
   return (OK);
G
Guy Schalnat 已提交
454 455 456
}

int
G
Guy Schalnat 已提交
457 458
process_data(png_structp *png_ptr, png_infop *info_ptr,
   png_bytep buffer, png_uint_32 length)
G
Guy Schalnat 已提交
459
{
460
   if (setjmp(png_jmpbuf((*png_ptr))))
G
Guy Schalnat 已提交
461
   {
G
Guy Schalnat 已提交
462
      /* Free the png_ptr and info_ptr memory on error */
463
      png_destroy_read_struct(png_ptr, info_ptr, NULL);
464
      return (ERROR);
G
Guy Schalnat 已提交
465 466
   }

A
Andreas Dilger 已提交
467 468
   /* This one's new also.  Simply give it chunks of data as
    * they arrive from the data stream (in order, of course).
469
    * On segmented machines, don't give it any more than 64K.
A
Andreas Dilger 已提交
470 471 472 473 474 475 476
    * 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 已提交
477
   png_process_data(*png_ptr, *info_ptr, buffer, length);
478
   return (OK);
G
Guy Schalnat 已提交
479 480 481 482
}

info_callback(png_structp png_ptr, png_infop info)
{
483 484 485 486 487 488 489
   /* 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 已提交
490 491 492
}

row_callback(png_structp png_ptr, png_bytep new_row,
G
Guy Schalnat 已提交
493
   png_uint_32 row_num, int pass)
G
Guy Schalnat 已提交
494
{
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
   /*
    * 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:
    */

512
   /* Check if row_num is in bounds. */
513
   if ((row_num >= 0) && (row_num < height))
514 515 516 517 518 519 520 521 522
   {
     /* Get pointer to corresponding row in our
      * PNG read buffer.
      */
     png_bytep old_row = ((png_bytep *)our_data)[row_num];

     /* If both rows are allocated then copy the new row
      * data to the corresponding row data.
      */
523
     if ((old_row != NULL) && (new_row != NULL))
524 525
     png_progressive_combine_row(png_ptr, old_row, new_row);
   }
526 527 528 529 530 531 532 533 534 535 536 537
   /*
    * 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 已提交
538 539 540

   png_progressive_combine_row(png_ptr, old_row, new_row);

541 542 543 544 545 546 547
   /* 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.
    */
G
Guy Schalnat 已提交
548 549 550 551
}

end_callback(png_structp png_ptr, png_infop info)
{
552 553 554 555 556 557 558 559 560
   /* 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 已提交
561 562
}

563
/* Write a png file */
564
void write_png(char *file_name /* , ... other image information ... */)
G
Guy Schalnat 已提交
565 566
{
   FILE *fp;
G
Guy Schalnat 已提交
567 568
   png_structp png_ptr;
   png_infop info_ptr;
569
   png_colorp palette;
G
Guy Schalnat 已提交
570

571
   /* Open the file */
G
Guy Schalnat 已提交
572
   fp = fopen(file_name, "wb");
A
Andreas Dilger 已提交
573
   if (fp == NULL)
574
      return (ERROR);
G
Guy Schalnat 已提交
575

G
Guy Schalnat 已提交
576
   /* Create and initialize the png_struct with the desired error handler
A
Andreas Dilger 已提交
577 578 579 580
    * 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 已提交
581 582
    */
   png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING,
583
      png_voidp user_error_ptr, user_error_fn, user_warning_fn);
G
Guy Schalnat 已提交
584

A
Andreas Dilger 已提交
585
   if (png_ptr == NULL)
G
Guy Schalnat 已提交
586 587
   {
      fclose(fp);
588
      return (ERROR);
G
Guy Schalnat 已提交
589 590
   }

A
Andreas Dilger 已提交
591
   /* Allocate/initialize the image information data.  REQUIRED */
G
Guy Schalnat 已提交
592
   info_ptr = png_create_info_struct(png_ptr);
A
Andreas Dilger 已提交
593
   if (info_ptr == NULL)
G
Guy Schalnat 已提交
594 595
   {
      fclose(fp);
596
      png_destroy_write_struct(&png_ptr,  NULL);
597
      return (ERROR);
G
Guy Schalnat 已提交
598 599
   }

A
Andreas Dilger 已提交
600
   /* Set error handling.  REQUIRED if you aren't supplying your own
601
    * error handling functions in the png_create_write_struct() call.
A
Andreas Dilger 已提交
602
    */
603
   if (setjmp(png_jmpbuf(png_ptr)))
G
Guy Schalnat 已提交
604
   {
605
      /* If we get here, we had a problem writing the file */
G
Guy Schalnat 已提交
606
      fclose(fp);
607
      png_destroy_write_struct(&png_ptr, &info_ptr);
608
      return (ERROR);
G
Guy Schalnat 已提交
609 610
   }

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

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

617
#else no_streams /* I/O initialization method 2 */
618
   /* If you are using replacement write functions, instead of calling
619 620
    * png_init_io() here you would call
    */
A
Andreas Dilger 已提交
621 622 623
   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 */
624
#endif no_streams /* Only use one initialization method */
A
Andreas Dilger 已提交
625

626 627
#ifdef hilevel
   /* This is the easy way.  Use it if you already have all the
628
    * image info living in the structure.  You could "|" many
629 630
    * PNG_TRANSFORM flags into the png_transforms integer here.
    */
631
   png_write_png(png_ptr, info_ptr, png_transforms, NULL);
632

633 634 635
#else
   /* This is the hard way */

A
Andreas Dilger 已提交
636 637 638 639 640 641 642 643 644 645
   /* 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 已提交
646

647
   /* Set the palette if there is one.  REQUIRED for indexed-color images */
648
   palette = (png_colorp)png_malloc(png_ptr, PNG_MAX_PALETTE_LENGTH
649
             * png_sizeof(png_color));
650
   /* ... Set palette colors ... */
651
   png_set_PLTE(png_ptr, info_ptr, palette, PNG_MAX_PALETTE_LENGTH);
652
   /* You must not free palette here, because png_set_PLTE only makes a link to
653 654 655
    * the palette that you malloced.  Wait until you are about to destroy
    * the png structure.
    */
G
Guy Schalnat 已提交
656

657
   /* Optional significant bit (sBIT) chunk */
658
   png_color_8 sig_bit;
659
   /* If we are dealing with a grayscale image then */
A
Andreas Dilger 已提交
660
   sig_bit.gray = true_bit_depth;
661
   /* Otherwise, if we are dealing with a color image then */
A
Andreas Dilger 已提交
662 663 664
   sig_bit.red = true_red_bit_depth;
   sig_bit.green = true_green_bit_depth;
   sig_bit.blue = true_blue_bit_depth;
665
   /* If the image has an alpha channel then */
A
Andreas Dilger 已提交
666
   sig_bit.alpha = true_alpha_bit_depth;
667
   png_set_sBIT(png_ptr, info_ptr, &sig_bit);
G
Guy Schalnat 已提交
668

669

A
Andreas Dilger 已提交
670
   /* Optional gamma chunk is strongly suggested if you have any guess
671 672
    * as to the correct gamma of the image.
    */
A
Andreas Dilger 已提交
673 674 675 676 677 678 679 680 681 682 683 684
   png_set_gAMA(png_ptr, info_ptr, gamma);

   /* Optionally write comments into the image */
   text_ptr[0].key = "Title";
   text_ptr[0].text = "Mona Lisa";
   text_ptr[0].compression = PNG_TEXT_COMPRESSION_NONE;
   text_ptr[1].key = "Author";
   text_ptr[1].text = "Leonardo DaVinci";
   text_ptr[1].compression = PNG_TEXT_COMPRESSION_NONE;
   text_ptr[2].key = "Description";
   text_ptr[2].text = "<long text>";
   text_ptr[2].compression = PNG_TEXT_COMPRESSION_zTXt;
685 686 687 688 689
#ifdef PNG_iTXt_SUPPORTED
   text_ptr[0].lang = NULL;
   text_ptr[1].lang = NULL;
   text_ptr[2].lang = NULL;
#endif
690
   png_set_text(png_ptr, info_ptr, text_ptr, 3);
A
Andreas Dilger 已提交
691

692
   /* Other optional chunks like cHRM, bKGD, tRNS, tIME, oFFs, pHYs */
693

694
   /* Note that if sRGB is present the gAMA and cHRM chunks must be ignored
695
    * on read and, if your application chooses to write them, they must
696 697
    * be written in accordance with the sRGB profile
    */
A
Andreas Dilger 已提交
698 699

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

702 703 704 705 706 707
   /* 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);
708
    *
709
    * However, given the level of known- and unknown-chunk support in 1.2.0
710
    * and up, this should no longer be necessary.
711 712
    */

A
Andreas Dilger 已提交
713 714 715 716 717 718
   /* 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.
    */

719
   /* Set up the transformations you want.  Note that these are
720 721
    * all optional.  Only call them if you want them.
    */
G
Guy Schalnat 已提交
722

723
   /* Invert monochrome pixels */
724
   png_set_invert_mono(png_ptr);
G
Guy Schalnat 已提交
725

A
Andreas Dilger 已提交
726
   /* Shift the pixels up to a legal bit depth and fill in
727 728
    * as appropriate to correctly scale the image.
    */
A
Andreas Dilger 已提交
729
   png_set_shift(png_ptr, &sig_bit);
G
Guy Schalnat 已提交
730

731
   /* Pack pixels into bytes */
G
Guy Schalnat 已提交
732 733
   png_set_packing(png_ptr);

734
   /* Swap location of alpha bytes from ARGB to RGBA */
A
Andreas Dilger 已提交
735 736 737
   png_set_swap_alpha(png_ptr);

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

742
   /* Flip BGR pixels to RGB */
G
Guy Schalnat 已提交
743 744
   png_set_bgr(png_ptr);

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

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

751
   /* Turn on interlace handling if you are not using png_write_image() */
G
Guy Schalnat 已提交
752 753 754 755 756
   if (interlacing)
      number_passes = png_set_interlace_handling(png_ptr);
   else
      number_passes = 1;

A
Andreas Dilger 已提交
757 758 759 760
   /* 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.
    */
761
   png_uint_32 k, height, width;
762
   png_byte image[height][width*bytes_per_pixel];
763
   png_bytep row_pointers[height];
764

765
   if (height > PNG_UINT_32_MAX/png_sizeof(png_bytep))
766 767
     png_error (png_ptr, "Image is too tall to process in memory");

768
   for (k = 0; k < height; k++)
769
     row_pointers[k] = image + k*width*bytes_per_pixel;
G
Guy Schalnat 已提交
770

A
Andreas Dilger 已提交
771
   /* One of the following output methods is REQUIRED */
772 773

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

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

778 779
#else no_entire /* Write out the image data by one or more scanlines */

A
Andreas Dilger 已提交
780 781 782
   /* The number of passes is either 1 for non-interlaced images,
    * or 7 for interlaced images.
    */
G
Guy Schalnat 已提交
783 784 785
   for (pass = 0; pass < number_passes; pass++)
   {
      /* Write a few rows at a time. */
786
      png_write_rows(png_ptr, &row_pointers[first_row], number_of_rows);
G
Guy Schalnat 已提交
787 788 789

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

A
Andreas Dilger 已提交
794
   /* You can write optional chunks like tEXt, zTXt, and tIME at the end
795
    * as well.  Shouldn't be necessary in 1.2.0 and up as all the public
796 797
    * 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 已提交
798 799
    */

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

804
   /* If you png_malloced a palette, free it here (don't free info_ptr->palette,
805 806 807 808 809
    * 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().
    */
810
   png_free(png_ptr, palette);
811
   palette = NULL;
812 813

   /* Similarly, if you png_malloced any data that you passed in with
814 815 816
    * png_set_something(), such as a hist or trans array, free it here,
    * when you can be sure that libpng is through with it.
    */
817
   png_free(png_ptr, trans);
818
   trans = NULL;
819 820 821 822 823
   /* 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 已提交
824

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

828
   /* Close the file */
G
Guy Schalnat 已提交
829 830
   fclose(fp);

831
   /* That's it */
832
   return (OK);
G
Guy Schalnat 已提交
833 834
}

835
#endif /* if 0 */