2 #if 0 /* in case someone actually tries to compile this */
4 /* example.c - an example of using libpng
6 * Maintained 2018 Cosmin Truta
7 * Maintained 1998-2016 Glenn Randers-Pehrson
8 * Maintained 1996-1997 Andreas Dilger
9 * Written 1995-1996 Guy Eric Schalnat, Group 42, Inc.
11 * To the extent possible under law, the authors have waived
12 * all copyright and related or neighboring rights to this file.
13 * This work is published from: United States, Canada.
16 /* This is an example of how to use libpng to read and write PNG files.
17 * The file libpng-manual.txt is much more verbose then this. If you have
18 * not read it, do so first. This was designed to be a starting point of an
19 * implementation. This is not officially part of libpng, is hereby placed
20 * in the public domain, and therefore does not require a copyright notice.
22 * This file does not currently compile, because it is missing certain
23 * parts, like allocating memory to hold an image. You will have to
24 * supply these parts to get it to compile. For an example of a minimal
25 * working PNG reader/writer, see pngtest.c, included in this distribution;
26 * see also the programs in the contrib directory.
29 /* The simple, but restricted approach to reading a PNG file or data stream
30 * requires just two function calls, as in the following complete program.
31 * Writing a file needs just one function call, so long as the data has an
34 * The following code reads PNG image data from a file and writes it, in a
35 * potentially new format, to a new file. While this code will compile, there
36 * is minimal (insufficient) error checking. For a more realistic version,
37 * see contrib/examples/pngtopng.c
47 int main(int argc
, const char **argv
)
51 png_image image
; /* The control structure used by libpng */
53 /* Initialize the 'png_image' structure. */
54 memset(&image
, 0, (sizeof image
));
55 image
.version
= PNG_IMAGE_VERSION
;
57 /* The first argument is the file to read: */
58 if (png_image_begin_read_from_file(&image
, argv
[1]) != 0)
62 /* Set the format in which to read the PNG file; this code chooses a
63 * simple sRGB format with a non-associated alpha channel, adequate to
66 image
.format
= PNG_FORMAT_RGBA
;
68 /* Now allocate enough memory to hold the image in this format; the
69 * PNG_IMAGE_SIZE macro uses the information about the image (width,
70 * height and format) stored in 'image'.
72 buffer
= malloc(PNG_IMAGE_SIZE(image
));
74 /* If enough memory was available, read the image in the desired
75 * format, then write the result out to the new file. 'background' is
76 * not necessary when reading the image, because the alpha channel is
77 * preserved; if it were to be removed, for example if we requested
78 * PNG_FORMAT_RGB, then either a solid background color would have to
79 * be supplied, or the output buffer would have to be initialized to
80 * the actual background of the image.
82 * The fourth argument to png_image_finish_read is the 'row_stride' -
83 * this is the number of components allocated for the image in each
84 * row. It has to be at least as big as the value returned by
85 * PNG_IMAGE_ROW_STRIDE, but if you just allocate space for the
86 * default, minimum size, using PNG_IMAGE_SIZE as above, you can pass
89 * The final argument is a pointer to a buffer for the colormap;
90 * colormaps have exactly the same format as a row of image pixels
91 * (so you choose what format to make the colormap by setting
92 * image.format). A colormap is only returned if
93 * PNG_FORMAT_FLAG_COLORMAP is also set in image.format, so in this
94 * case NULL is passed as the final argument. If you do want to force
95 * all images into an index/color-mapped format, then you can use:
97 * PNG_IMAGE_COLORMAP_SIZE(image)
99 * to find the maximum size of the colormap in bytes.
101 if (buffer
!= NULL
&&
102 png_image_finish_read(&image
, NULL
/*background*/, buffer
,
103 0/*row_stride*/, NULL
/*colormap*/) != 0)
105 /* Now write the image out to the second argument. In the write
106 * call 'convert_to_8bit' allows 16-bit data to be squashed down to
107 * 8 bits; this isn't necessary here because the original read was
108 * to the 8-bit format.
110 if (png_image_write_to_file(&image
, argv
[2], 0/*convert_to_8bit*/,
111 buffer
, 0/*row_stride*/, NULL
/*colormap*/) != 0)
113 /* The image has been written successfully. */
119 /* Calling png_image_free is optional unless the simplified API was
120 * not run to completion. In this case, if there wasn't enough
121 * memory for 'buffer', we didn't complete the read, so we must
125 png_image_free(&image
);
130 /* Something went wrong reading or writing the image. libpng stores a
131 * textual message in the 'png_image' structure:
133 fprintf(stderr
, "pngtopng: error: %s\n", image
.message
);
137 fprintf(stderr
, "pngtopng: usage: pngtopng input-file output-file\n");
141 /* That's it ;-) Of course you probably want to do more with PNG files than
142 * just converting them all to 32-bit RGBA PNG files; you can do that between
143 * the call to png_image_finish_read and png_image_write_to_file. You can also
144 * ask for the image data to be presented in a number of different formats.
145 * You do this by simply changing the 'format' parameter set before allocating
148 * The format parameter consists of five flags that define various aspects of
149 * the image. You can simply add these together to get the format, or you can
150 * use one of the predefined macros from png.h (as above):
152 * PNG_FORMAT_FLAG_COLOR: if set, the image will have three color components
153 * per pixel (red, green and blue); if not set, the image will just have one
154 * luminance (grayscale) component.
156 * PNG_FORMAT_FLAG_ALPHA: if set, each pixel in the image will have an
157 * additional alpha value; a linear value that describes the degree the
158 * image pixel covers (overwrites) the contents of the existing pixel on the
161 * PNG_FORMAT_FLAG_LINEAR: if set, the components of each pixel will be
162 * returned as a series of 16-bit linear values; if not set, the components
163 * will be returned as a series of 8-bit values encoded according to the
164 * sRGB standard. The 8-bit format is the normal format for images intended
165 * for direct display, because almost all display devices do the inverse of
166 * the sRGB transformation to the data they receive. The 16-bit format is
167 * more common for scientific data and image data that must be further
168 * processed; because it is linear, simple math can be done on the component
169 * values. Regardless of the setting of this flag, the alpha channel is
170 * always linear, although it will be 8 bits or 16 bits wide as specified by
173 * PNG_FORMAT_FLAG_BGR: if set, the components of a color pixel will be
174 * returned in the order blue, then green, then red. If not set, the pixel
175 * components are in the order red, then green, then blue.
177 * PNG_FORMAT_FLAG_AFIRST: if set, the alpha channel (if present) precedes the
178 * color or grayscale components. If not set, the alpha channel follows the
181 * You do not have to read directly from a file. You can read from memory or,
182 * on systems that support it, from a <stdio.h> FILE*. This is controlled by
183 * the particular png_image_read_from_ function you call at the start.
184 * Likewise, on write, you can write to a FILE* if your system supports it.
185 * Check the macro PNG_STDIO_SUPPORTED to see if stdio support has been
186 * included in your libpng build.
188 * If you read 16-bit (PNG_FORMAT_FLAG_LINEAR) data, you may need to write it
189 * in the 8-bit format for display. You do this by setting the convert_to_8bit
192 * Don't repeatedly convert between the 8-bit and 16-bit forms. There is
193 * significant data loss when 16-bit data is converted to the 8-bit encoding,
194 * and the current libpng implementation of conversion to 16-bit is also
195 * significantly lossy. The latter will be fixed in the future, but the former
196 * is unavoidable - the 8-bit format just doesn't have enough resolution.
199 /* If your program needs more information from the PNG data it reads, or if you
200 * need to do more complex transformations, or minimize transformations, on the
201 * data you read, then you must use one of the several lower level libpng
204 * All these interfaces require that you do your own error handling - your
205 * program must be able to arrange for control to return to your own code, any
206 * time libpng encounters a problem. There are several ways to do this, but
207 * the standard way is to use the <setjmp.h> interface to establish a return
208 * point within your own code. You must do this if you do not use the
209 * simplified interface (above).
211 * The first step is to include the header files you need, including the libpng
212 * header file. Include any standard headers and feature test macros your
213 * program requires before including png.h:
217 /* The png_jmpbuf() macro, used in error handling, became available in
218 * libpng version 1.0.6. If you want to be able to run your code with older
219 * versions of libpng, you must define the macro yourself (but only if it
220 * is not already defined by libpng!)
224 # define png_jmpbuf(png_ptr) ((png_ptr)->png_jmpbuf)
227 /* Check to see if a file is a PNG file using png_sig_cmp(). png_sig_cmp()
228 * returns zero if the image is a PNG, and nonzero otherwise.
230 * The function check_if_png() shown here, but not used, returns nonzero (true)
231 * if the file can be opened and is a PNG, and 0 (false) otherwise.
233 * If this call is successful, and you are going to keep the file open,
234 * you should call png_set_sig_bytes(png_ptr, PNG_BYTES_TO_CHECK); once
235 * you have created the png_ptr, so that libpng knows your application
236 * has read that many bytes from the start of the file. Make sure you
237 * don't call png_set_sig_bytes() with more than 8 bytes read or give it
238 * an incorrect number of bytes read, or you will either have read too
239 * many bytes (your fault), or you are telling libpng to read the wrong
240 * number of magic bytes (also your fault).
242 * Many applications already read the first 2 or 4 bytes from the start
243 * of the image to determine the file type, so it would be easiest just
244 * to pass the bytes to png_sig_cmp(), or even skip that if you know
245 * you have a PNG file, and call png_set_sig_bytes().
247 #define PNG_BYTES_TO_CHECK 4
248 int check_if_png(char *file_name
, FILE **fp
)
250 char buf
[PNG_BYTES_TO_CHECK
];
252 /* Open the prospective PNG file. */
253 if ((*fp
= fopen(file_name
, "rb")) == NULL
)
256 /* Read in some of the signature bytes. */
257 if (fread(buf
, 1, PNG_BYTES_TO_CHECK
, *fp
) != PNG_BYTES_TO_CHECK
)
260 /* Compare the first PNG_BYTES_TO_CHECK bytes of the signature.
261 * Return nonzero (true) if they match.
263 return(!png_sig_cmp(buf
, 0, PNG_BYTES_TO_CHECK
));
266 /* Read a PNG file. You may want to return an error code if the read
267 * fails (depending upon the failure). There are two "prototypes" given
268 * here - one where we are given the filename, and we need to open the
269 * file, and the other where we are given an open file (possibly with
270 * some or all of the magic bytes read - see comments above).
272 #ifdef open_file /* prototype 1 */
273 void read_png(char *file_name
) /* We need to open the file */
278 png_uint_32 width
, height
;
279 int bit_depth
, color_type
, interlace_type
;
282 if ((fp
= fopen(file_name
, "rb")) == NULL
)
285 #else no_open_file /* prototype 2 */
286 void read_png(FILE *fp
, int sig_read
) /* File is already open */
290 png_uint_32 width
, height
;
291 int bit_depth
, color_type
, interlace_type
;
292 #endif no_open_file /* Only use one prototype! */
294 /* Create and initialize the png_struct with the desired error handler
295 * functions. If you want to use the default stderr and longjump method,
296 * you can supply NULL for the last three parameters. We also supply the
297 * the compiler header file version, so that we know if the application
298 * was compiled with a compatible version of the library. REQUIRED.
300 png_ptr
= png_create_read_struct(PNG_LIBPNG_VER_STRING
,
301 png_voidp user_error_ptr
, user_error_fn
, user_warning_fn
);
309 /* Allocate/initialize the memory for image information. REQUIRED. */
310 info_ptr
= png_create_info_struct(png_ptr
);
311 if (info_ptr
== NULL
)
314 png_destroy_read_struct(&png_ptr
, NULL
, NULL
);
318 /* Set error handling if you are using the setjmp/longjmp method (this is
319 * the normal method of doing things with libpng). REQUIRED unless you
320 * set up your own error handlers in the png_create_read_struct() earlier.
322 if (setjmp(png_jmpbuf(png_ptr
)))
324 /* Free all of the memory associated with the png_ptr and info_ptr. */
325 png_destroy_read_struct(&png_ptr
, &info_ptr
, NULL
);
327 /* If we get here, we had a problem reading the file. */
331 /* One of the following I/O initialization methods is REQUIRED. */
332 #ifdef streams /* PNG file I/O method 1 */
333 /* Set up the input control if you are using standard C streams. */
334 png_init_io(png_ptr
, fp
);
336 #else no_streams /* PNG file I/O method 2 */
337 /* If you are using replacement read functions, instead of calling
338 * png_init_io(), you would call:
340 png_set_read_fn(png_ptr
, (void *)user_io_ptr
, user_read_fn
);
341 /* where user_io_ptr is a structure you want available to the callbacks. */
342 #endif no_streams /* Use only one I/O method! */
344 /* If we have already read some of the signature */
345 png_set_sig_bytes(png_ptr
, sig_read
);
348 /* If you have enough memory to read in the entire image at once,
349 * and you need to specify only transforms that can be controlled
350 * with one of the PNG_TRANSFORM_* bits (this presently excludes
351 * quantizing, filling, setting background, and doing gamma
352 * adjustment), then you can read the entire image (including
353 * pixels) into the info structure with this call:
355 png_read_png(png_ptr
, info_ptr
, png_transforms
, NULL
);
358 /* OK, you're doing it the hard way, with the lower-level functions. */
360 /* The call to png_read_info() gives us all of the information from the
361 * PNG file before the first IDAT (image data chunk). REQUIRED.
363 png_read_info(png_ptr
, info_ptr
);
365 png_get_IHDR(png_ptr
, info_ptr
, &width
, &height
, &bit_depth
, &color_type
,
366 &interlace_type
, NULL
, NULL
);
368 /* Set up the data transformations you want. Note that these are all
369 * optional. Only call them if you want/need them. Many of the
370 * transformations only work on specific types of images, and many
371 * are mutually exclusive.
374 /* Tell libpng to strip 16 bits/color files down to 8 bits/color.
375 * Use accurate scaling if it's available, otherwise just chop off the
378 #ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
379 png_set_scale_16(png_ptr
);
381 png_set_strip_16(png_ptr
);
384 /* Strip alpha bytes from the input data without combining with the
385 * background (not recommended).
387 png_set_strip_alpha(png_ptr
);
389 /* Extract multiple pixels with bit depths of 1, 2 or 4 from a single
390 * byte into separate bytes (useful for paletted and grayscale images).
392 png_set_packing(png_ptr
);
394 /* Change the order of packed pixels to least significant bit first
395 * (not useful if you are using png_set_packing).
397 png_set_packswap(png_ptr
);
399 /* Expand paletted colors into true RGB triplets. */
400 if (color_type
== PNG_COLOR_TYPE_PALETTE
)
401 png_set_palette_to_rgb(png_ptr
);
403 /* Expand grayscale images to the full 8 bits from 1, 2 or 4 bits/pixel. */
404 if (color_type
== PNG_COLOR_TYPE_GRAY
&& bit_depth
< 8)
405 png_set_expand_gray_1_2_4_to_8(png_ptr
);
407 /* Expand paletted or RGB images with transparency to full alpha channels
408 * so the data will be available as RGBA quartets.
410 if (png_get_valid(png_ptr
, info_ptr
, PNG_INFO_tRNS
) != 0)
411 png_set_tRNS_to_alpha(png_ptr
);
413 /* Set the background color to draw transparent and alpha images over.
414 * It is possible to set the red, green and blue components directly
415 * for paletted images, instead of supplying a palette index. Note that,
416 * even if the PNG file supplies a background, you are not required to
417 * use it - you should use the (solid) application background if it has one.
419 png_color_16 my_background
, *image_background
;
421 if (png_get_bKGD(png_ptr
, info_ptr
, &image_background
) != 0)
422 png_set_background(png_ptr
, image_background
,
423 PNG_BACKGROUND_GAMMA_FILE
, 1, 1.0);
425 png_set_background(png_ptr
, &my_background
,
426 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
428 /* Some suggestions as to how to get a screen gamma value.
430 * Note that screen gamma is the display_exponent, which includes
431 * the CRT_exponent and any correction for viewing conditions.
433 if (/* We have a user-defined screen gamma value */)
434 screen_gamma
= user
-defined screen_gamma
;
435 /* This is one way that applications share the same screen gamma value. */
436 else if ((gamma_str
= getenv("SCREEN_GAMMA")) != NULL
)
437 screen_gamma
= atof(gamma_str
);
438 /* If we don't have another value */
441 screen_gamma
= PNG_DEFAULT_sRGB
; /* A good guess for a PC monitor
442 in a dimly lit room */
443 screen_gamma
= PNG_GAMMA_MAC_18
or 1.0; /* Good guesses for Mac
447 /* Tell libpng to handle the gamma conversion for you. The final call
448 * is a good guess for PC generated images, but it should be configurable
449 * by the user at run time. Gamma correction support in your application
450 * is strongly recommended.
455 if (png_get_sRGB(png_ptr
, info_ptr
, &intent
) != 0)
456 png_set_gamma(png_ptr
, screen_gamma
, PNG_DEFAULT_sRGB
);
460 if (png_get_gAMA(png_ptr
, info_ptr
, &image_gamma
) != 0)
461 png_set_gamma(png_ptr
, screen_gamma
, image_gamma
);
463 png_set_gamma(png_ptr
, screen_gamma
, 0.45455);
466 #ifdef PNG_READ_QUANTIZE_SUPPORTED
467 /* Quantize RGB files down to 8-bit palette, or reduce palettes
468 * to the number of colors available on your screen.
470 if ((color_type
& PNG_COLOR_MASK_COLOR
) != 0)
475 /* This reduces the image to the application-supplied palette. */
476 if (/* We have our own palette */)
478 /* An array of colors to which the image should be quantized. */
479 png_color std_color_cube
[MAX_SCREEN_COLORS
];
480 png_set_quantize(png_ptr
, std_color_cube
, MAX_SCREEN_COLORS
,
481 MAX_SCREEN_COLORS
, NULL
, 0);
483 /* This reduces the image to the palette supplied in the file. */
484 else if (png_get_PLTE(png_ptr
, info_ptr
, &palette
, &num_palette
) != 0)
486 png_uint_16p histogram
= NULL
;
487 png_get_hIST(png_ptr
, info_ptr
, &histogram
);
488 png_set_quantize(png_ptr
, palette
, num_palette
,
489 max_screen_colors
, histogram
, 0);
492 #endif /* READ_QUANTIZE */
494 /* Invert monochrome files to have 0 as white and 1 as black. */
495 png_set_invert_mono(png_ptr
);
497 /* If you want to shift the pixel values from the range [0,255] or
498 * [0,65535] to the original [0,7] or [0,31], or whatever range the
499 * colors were originally in:
501 if (png_get_valid(png_ptr
, info_ptr
, PNG_INFO_sBIT
) != 0)
503 png_color_8p sig_bit_p
;
504 png_get_sBIT(png_ptr
, info_ptr
, &sig_bit_p
);
505 png_set_shift(png_ptr
, sig_bit_p
);
508 /* Flip the RGB pixels to BGR (or RGBA to BGRA). */
509 if ((color_type
& PNG_COLOR_MASK_COLOR
) != 0)
510 png_set_bgr(png_ptr
);
512 /* Swap the RGBA or GA data to ARGB or AG (or BGRA to ABGR). */
513 png_set_swap_alpha(png_ptr
);
515 /* Swap bytes of 16-bit files to least significant byte first. */
516 png_set_swap(png_ptr
);
518 /* Add filler (or alpha) byte (before/after each RGB triplet). */
519 png_set_filler(png_ptr
, 0xffff, PNG_FILLER_AFTER
);
521 #ifdef PNG_READ_INTERLACING_SUPPORTED
522 /* Turn on interlace handling. REQUIRED if you are not using
523 * png_read_image(). To see how to handle interlacing passes,
524 * see the png_read_row() method below:
526 number_passes
= png_set_interlace_handling(png_ptr
);
527 #else /* !READ_INTERLACING */
529 #endif /* READ_INTERLACING */
531 /* Optional call to gamma correct and add the background to the palette
532 * and update info structure. REQUIRED if you are expecting libpng to
533 * update the palette for you (i.e. you selected such a transform above).
535 png_read_update_info(png_ptr
, info_ptr
);
537 /* Allocate the memory to hold the image using the fields of info_ptr. */
538 png_bytep row_pointers
[height
];
539 for (row
= 0; row
< height
; row
++)
540 row_pointers
[row
] = NULL
; /* Clear the pointer array */
541 for (row
= 0; row
< height
; row
++)
542 row_pointers
[row
] = png_malloc(png_ptr
, png_get_rowbytes(png_ptr
,
545 /* Now it's time to read the image. One of these methods is REQUIRED. */
546 #ifdef entire /* Read the entire image in one go */
547 png_read_image(png_ptr
, row_pointers
);
549 #else no_entire /* Read the image one or more scanlines at a time */
550 /* The other way to read images - deal with interlacing: */
551 for (pass
= 0; pass
< number_passes
; pass
++)
553 #ifdef single /* Read the image a single row at a time */
554 for (y
= 0; y
< height
; y
++)
555 png_read_rows(png_ptr
, &row_pointers
[y
], NULL
, 1);
557 #else no_single /* Read the image several rows at a time */
558 for (y
= 0; y
< height
; y
+= number_of_rows
)
560 #ifdef sparkle /* Read the image using the "sparkle" effect. */
561 png_read_rows(png_ptr
, &row_pointers
[y
], NULL
,
563 #else no_sparkle /* Read the image using the "rectangle" effect */
564 png_read_rows(png_ptr
, NULL
, &row_pointers
[y
],
566 #endif no_sparkle /* Use only one of these two methods */
569 /* If you want to display the image after every pass, do so here. */
570 #endif no_single /* Use only one of these two methods */
572 #endif no_entire /* Use only one of these two methods */
574 /* Read rest of file, and get additional chunks in info_ptr. REQUIRED. */
575 png_read_end(png_ptr
, info_ptr
);
578 /* At this point you have read the entire image. */
580 /* Clean up after the read, and free any memory allocated. REQUIRED. */
581 png_destroy_read_struct(&png_ptr
, &info_ptr
, NULL
);
583 /* Close the file. */
590 /* Progressively read a file */
593 initialize_png_reader(png_structp
*png_ptr
, png_infop
*info_ptr
)
595 /* Create and initialize the png_struct with the desired error handler
596 * functions. If you want to use the default stderr and longjump method,
597 * you can supply NULL for the last three parameters. We also check that
598 * the library version is compatible, in case we are using dynamically
601 *png_ptr
= png_create_read_struct(PNG_LIBPNG_VER_STRING
,
602 png_voidp user_error_ptr
, user_error_fn
, user_warning_fn
);
603 if (*png_ptr
== NULL
)
608 *info_ptr
= png_create_info_struct(png_ptr
);
609 if (*info_ptr
== NULL
)
611 png_destroy_read_struct(png_ptr
, info_ptr
, NULL
);
614 if (setjmp(png_jmpbuf((*png_ptr
))))
616 png_destroy_read_struct(png_ptr
, info_ptr
, NULL
);
620 /* You will need to provide all three function callbacks,
621 * even if you aren't using all of them.
622 * If you aren't using all functions, you can specify NULL
623 * parameters. Even when all three functions are NULL,
624 * you need to call png_set_progressive_read_fn().
625 * These functions shouldn't be dependent on global or
626 * static variables if you are decoding several images
627 * simultaneously. You should store stream specific data
628 * in a separate struct, given as the second parameter,
629 * and retrieve the pointer from inside the callbacks using
630 * the function png_get_progressive_ptr(png_ptr).
632 png_set_progressive_read_fn(*png_ptr
, (void *)stream_data
,
633 info_callback
, row_callback
, end_callback
);
638 process_data(png_structp
*png_ptr
, png_infop
*info_ptr
,
639 png_bytep buffer
, png_uint_32 length
)
641 if (setjmp(png_jmpbuf((*png_ptr
))))
643 /* Free the png_ptr and info_ptr memory on error. */
644 png_destroy_read_struct(png_ptr
, info_ptr
, NULL
);
648 /* Give chunks of data as they arrive from the data stream
649 * (in order, of course).
650 * On segmented machines, don't give it any more than 64K.
651 * The library seems to run fine with sizes of 4K, although
652 * you can give it much less if necessary. (I assume you can
653 * give it chunks of 1 byte, but I haven't tried with less
654 * than 256 bytes yet.) When this function returns, you may
655 * want to display any rows that were generated in the row
656 * callback, if you aren't already displaying them there.
658 png_process_data(*png_ptr
, *info_ptr
, buffer
, length
);
662 info_callback(png_structp png_ptr
, png_infop info
)
664 /* Do any setup here, including setting any of the transformations
665 * mentioned in the Reading PNG files section. For now, you _must_
666 * call either png_start_read_image() or png_read_update_info()
667 * after all the transformations are set (even if you don't set
668 * any). You may start getting rows before png_process_data()
669 * returns, so this is your last chance to prepare for that.
673 row_callback(png_structp png_ptr
, png_bytep new_row
,
674 png_uint_32 row_num
, int pass
)
676 /* This function is called for every row in the image. If the
677 * image is interlaced, and you turned on the interlace handler,
678 * this function will be called for every row in every pass.
680 * In this function you will receive a pointer to new row data from
681 * libpng called new_row that is to replace a corresponding row (of
682 * the same data format) in a buffer allocated by your application.
684 * The new row data pointer "new_row" may be NULL, indicating there is
685 * no new data to be replaced (in cases of interlace loading).
687 * If new_row is not NULL, then you need to call
688 * png_progressive_combine_row(), to replace the corresponding row as
692 /* Get pointer to corresponding row in our PNG read buffer. */
693 png_bytep old_row
= ((png_bytep
*)our_data
)[row_num
];
695 #ifdef PNG_READ_INTERLACING_SUPPORTED
696 /* If both rows are allocated, then copy the new row
697 * data to the corresponding row data.
699 if (old_row
!= NULL
&& new_row
!= NULL
)
700 png_progressive_combine_row(png_ptr
, old_row
, new_row
);
702 /* The rows and passes are called in order, so you don't really
703 * need the row_num and pass, but I'm supplying them because it
704 * may make your life easier.
706 * For the non-NULL rows of interlaced images, you must call
707 * png_progressive_combine_row() passing in the new row and the
708 * old row, as demonstrated above. You can call this function for
709 * NULL rows (it will just return) and for non-interlaced images
710 * (it just does the memcpy for you) if it will make the code
711 * easier. Thus, you can just do this for all cases:
713 png_progressive_combine_row(png_ptr
, old_row
, new_row
);
715 /* where old_row is what was displayed for previous rows. Note
716 * that the first pass (pass == 0 really) will completely cover
717 * the old row, so the rows do not have to be initialized. After
718 * the first pass (and only for interlaced images), you will have
719 * to pass the current row as new_row, and the function will combine
720 * the old row and the new row.
722 #endif /* READ_INTERLACING */
725 end_callback(png_structp png_ptr
, png_infop info
)
727 /* This function is called when the whole image has been read,
728 * including any chunks after the image (up to and including
729 * the IEND). You will usually have the same info chunk as you
730 * had in the header, although some data may have been added
731 * to the comments and time fields.
733 * Most people won't do much here, perhaps setting a flag that
734 * marks the image as finished.
738 /* Write a png file */
739 void write_png(char *file_name
/* , ... other image information ... */)
747 fp
= fopen(file_name
, "wb");
751 /* Create and initialize the png_struct with the desired error handler
752 * functions. If you want to use the default stderr and longjump method,
753 * you can supply NULL for the last three parameters. We also check that
754 * the library version is compatible with the one used at compile time,
755 * in case we are using dynamically linked libraries. REQUIRED.
757 png_ptr
= png_create_write_struct(PNG_LIBPNG_VER_STRING
,
758 png_voidp user_error_ptr
, user_error_fn
, user_warning_fn
);
765 /* Allocate/initialize the image information data. REQUIRED. */
766 info_ptr
= png_create_info_struct(png_ptr
);
767 if (info_ptr
== NULL
)
770 png_destroy_write_struct(&png_ptr
, NULL
);
774 /* Set up error handling. REQUIRED if you aren't supplying your own
775 * error handling functions in the png_create_write_struct() call.
777 if (setjmp(png_jmpbuf(png_ptr
)))
779 /* If we get here, we had a problem writing the file. */
781 png_destroy_write_struct(&png_ptr
, &info_ptr
);
785 /* One of the following I/O initialization functions is REQUIRED. */
787 #ifdef streams /* I/O initialization method 1 */
788 /* Set up the output control if you are using standard C streams. */
789 png_init_io(png_ptr
, fp
);
791 #else no_streams /* I/O initialization method 2 */
792 /* If you are using replacement write functions, instead of calling
793 * png_init_io(), you would call:
795 png_set_write_fn(png_ptr
, (void *)user_io_ptr
, user_write_fn
,
796 user_IO_flush_function
);
797 /* where user_io_ptr is a structure you want available to the callbacks. */
798 #endif no_streams /* Only use one initialization method */
801 /* This is the easy way. Use it if you already have all the
802 * image info living in the structure. You could "|" many
803 * PNG_TRANSFORM flags into the png_transforms integer here.
805 png_write_png(png_ptr
, info_ptr
, png_transforms
, NULL
);
808 /* This is the hard way. */
810 /* Set the image information here. Width and height are up to 2^31,
811 * bit_depth is one of 1, 2, 4, 8 or 16, but valid values also depend on
812 * the color_type selected. color_type is one of PNG_COLOR_TYPE_GRAY,
813 * PNG_COLOR_TYPE_GRAY_ALPHA, PNG_COLOR_TYPE_PALETTE, PNG_COLOR_TYPE_RGB,
814 * or PNG_COLOR_TYPE_RGB_ALPHA. interlace is either PNG_INTERLACE_NONE or
815 * PNG_INTERLACE_ADAM7, and the compression_type and filter_type MUST
816 * currently be PNG_COMPRESSION_TYPE_BASE and PNG_FILTER_TYPE_BASE.
819 png_set_IHDR(png_ptr
, info_ptr
, width
, height
, bit_depth
,
820 PNG_COLOR_TYPE_
???, PNG_INTERLACE_
????,
821 PNG_COMPRESSION_TYPE_BASE
, PNG_FILTER_TYPE_BASE
);
823 /* Set the palette if there is one. REQUIRED for indexed-color images. */
824 palette
= (png_colorp
)png_malloc(png_ptr
,
825 PNG_MAX_PALETTE_LENGTH
* (sizeof (png_color
)));
826 /* ... Set palette colors ... */
827 png_set_PLTE(png_ptr
, info_ptr
, palette
, PNG_MAX_PALETTE_LENGTH
);
828 /* You must not free palette here, because png_set_PLTE only makes a link
829 * to the palette that you allocated. Wait until you are about to destroy
833 /* Optional significant bit (sBIT) chunk. */
836 /* If we are dealing with a grayscale image then */
837 sig_bit
.gray
= true_bit_depth
;
839 /* Otherwise, if we are dealing with a color image then */
840 sig_bit
.red
= true_red_bit_depth
;
841 sig_bit
.green
= true_green_bit_depth
;
842 sig_bit
.blue
= true_blue_bit_depth
;
844 /* If the image has an alpha channel then */
845 sig_bit
.alpha
= true_alpha_bit_depth
;
847 png_set_sBIT(png_ptr
, info_ptr
, &sig_bit
);
849 /* Optional gamma chunk is strongly suggested if you have any guess
850 * as to the correct gamma of the image.
852 png_set_gAMA(png_ptr
, info_ptr
, gamma
);
854 /* Optionally write comments into the image. */
856 png_text text_ptr
[3];
858 char key0
[] = "Title";
859 char text0
[] = "Mona Lisa";
860 text_ptr
[0].key
= key0
;
861 text_ptr
[0].text
= text0
;
862 text_ptr
[0].compression
= PNG_TEXT_COMPRESSION_NONE
;
863 text_ptr
[0].itxt_length
= 0;
864 text_ptr
[0].lang
= NULL
;
865 text_ptr
[0].lang_key
= NULL
;
867 char key1
[] = "Author";
868 char text1
[] = "Leonardo DaVinci";
869 text_ptr
[1].key
= key1
;
870 text_ptr
[1].text
= text1
;
871 text_ptr
[1].compression
= PNG_TEXT_COMPRESSION_NONE
;
872 text_ptr
[1].itxt_length
= 0;
873 text_ptr
[1].lang
= NULL
;
874 text_ptr
[1].lang_key
= NULL
;
876 char key2
[] = "Description";
877 char text2
[] = "<long text>";
878 text_ptr
[2].key
= key2
;
879 text_ptr
[2].text
= text2
;
880 text_ptr
[2].compression
= PNG_TEXT_COMPRESSION_zTXt
;
881 text_ptr
[2].itxt_length
= 0;
882 text_ptr
[2].lang
= NULL
;
883 text_ptr
[2].lang_key
= NULL
;
885 png_set_text(write_ptr
, write_info_ptr
, text_ptr
, 3);
888 /* Other optional chunks like cHRM, bKGD, tRNS, tIME, oFFs, pHYs. */
890 /* Note that if sRGB is present, the gAMA and cHRM chunks must be ignored
891 * on read and, if your application chooses to write them, they must
892 * be written in accordance with the sRGB profile.
895 /* Write the file header information. REQUIRED. */
896 png_write_info(png_ptr
, info_ptr
);
898 /* If you want, you can write the info in two steps, in case you need to
899 * write your private chunk ahead of PLTE:
901 * png_write_info_before_PLTE(write_ptr, write_info_ptr);
903 * png_write_info(png_ptr, info_ptr);
905 * However, given the level of known- and unknown-chunk support in 1.2.0
906 * and up, this should no longer be necessary.
909 /* Once we write out the header, the compression type on the text
910 * chunk gets changed to PNG_TEXT_COMPRESSION_NONE_WR or
911 * PNG_TEXT_COMPRESSION_zTXt_WR, so it doesn't get written out again
915 /* Set up the transformations you want. Note that these are
916 * all optional. Only call them if you want them.
919 /* Invert monochrome pixels. */
920 png_set_invert_mono(png_ptr
);
922 /* Shift the pixels up to a legal bit depth and fill in
923 * as appropriate to correctly scale the image.
925 png_set_shift(png_ptr
, &sig_bit
);
927 /* Pack pixels into bytes. */
928 png_set_packing(png_ptr
);
930 /* Swap location of alpha bytes from ARGB to RGBA. */
931 png_set_swap_alpha(png_ptr
);
933 /* Get rid of filler (OR ALPHA) bytes, pack XRGB/RGBX/ARGB/RGBA into
934 * RGB (4 channels -> 3 channels). The second parameter is not used.
936 png_set_filler(png_ptr
, 0, PNG_FILLER_BEFORE
);
938 /* Flip BGR pixels to RGB. */
939 png_set_bgr(png_ptr
);
941 /* Swap bytes of 16-bit files to most significant byte first. */
942 png_set_swap(png_ptr
);
944 /* Swap bits of 1-bit, 2-bit, 4-bit packed pixel formats. */
945 png_set_packswap(png_ptr
);
947 /* Turn on interlace handling if you are not using png_write_image(). */
948 if (interlacing
!= 0)
949 number_passes
= png_set_interlace_handling(png_ptr
);
953 /* The easiest way to write the image (you may have a different memory
954 * layout, however, so choose what fits your needs best). You need to
955 * use the first method if you aren't handling interlacing yourself.
957 png_uint_32 k
, height
, width
;
959 /* In this example, "image" is a one-dimensional array of bytes. */
961 /* Guard against integer overflow. */
962 if (height
> PNG_SIZE_MAX
/ (width
* bytes_per_pixel
))
963 png_error(png_ptr
, "Image data buffer would be too large");
965 png_byte image
[height
* width
* bytes_per_pixel
];
966 png_bytep row_pointers
[height
];
968 if (height
> PNG_UINT_32_MAX
/ (sizeof (png_bytep
)))
969 png_error(png_ptr
, "Image is too tall to process in memory");
971 /* Set up pointers into your "image" byte array. */
972 for (k
= 0; k
< height
; k
++)
973 row_pointers
[k
] = image
+ k
* width
* bytes_per_pixel
;
975 /* One of the following output methods is REQUIRED. */
977 #ifdef entire /* Write out the entire image data in one call */
978 png_write_image(png_ptr
, row_pointers
);
980 /* The other way to write the image - deal with interlacing. */
982 #else no_entire /* Write out the image data by one or more scanlines */
984 /* The number of passes is either 1 for non-interlaced images,
985 * or 7 for interlaced images.
987 for (pass
= 0; pass
< number_passes
; pass
++)
989 /* Write a few rows at a time. */
990 png_write_rows(png_ptr
, &row_pointers
[first_row
], number_of_rows
);
992 /* If you are only writing one row at a time, this works. */
993 for (y
= 0; y
< height
; y
++)
994 png_write_rows(png_ptr
, &row_pointers
[y
], 1);
996 #endif no_entire /* Use only one output method */
998 /* You can write optional chunks like tEXt, zTXt, and tIME at the end
999 * as well. Shouldn't be necessary in 1.2.0 and up, as all the public
1000 * chunks are supported, and you can use png_set_unknown_chunks() to
1001 * register unknown chunks into the info structure to be written out.
1004 /* It is REQUIRED to call this to finish writing the rest of the file. */
1005 png_write_end(png_ptr
, info_ptr
);
1008 /* If you png_malloced a palette, free it here.
1009 * (Don't free info_ptr->palette, as shown in versions 1.0.5m and earlier of
1010 * this example; if libpng mallocs info_ptr->palette, libpng will free it).
1011 * If you allocated it with malloc() instead of png_malloc(), use free()
1012 * instead of png_free().
1014 png_free(png_ptr
, palette
);
1017 /* Similarly, if you png_malloced any data that you passed in with
1018 * png_set_something(), such as a hist or trans array, free it here,
1019 * when you can be sure that libpng is through with it.
1021 png_free(png_ptr
, trans
);
1024 /* Whenever you use png_free(), it is a good idea to set the pointer to
1025 * NULL in case your application inadvertently tries to png_free() it
1026 * again. When png_free() sees a NULL it returns without action, avoiding
1027 * the double-free problem.
1030 /* Clean up after the write, and free any allocated memory. */
1031 png_destroy_write_struct(&png_ptr
, &info_ptr
);
1033 /* Close the file. */