blob: 34ecfde22c7fe4199341b812c265bdbc8ad7960c [file] [log] [blame]
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001
Glenn Randers-Pehrson860ab2b1999-10-14 07:43:10 -05002#if 0 /* in case someone actually tries to compile this */
3
Glenn Randers-Pehrsonb7f95932006-03-05 20:15:20 -06004/* example.c - an example of using libpng
Cosmin Truta46aedd82018-07-15 23:58:00 -04005 * Last changed in libpng 1.6.35 [July 15, 2018]
6 * Maintained 2018 Cosmin Truta
Glenn Randers-Pehrson7a18a2d2016-07-13 16:26:00 -05007 * Maintained 1998-2016 Glenn Randers-Pehrson
Glenn Randers-Pehrsonb7f95932006-03-05 20:15:20 -06008 * Maintained 1996, 1997 Andreas Dilger)
9 * Written 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
Glenn Randers-Pehrson2ddb2522011-11-25 07:27:51 -060010 * To the extent possible under law, the authors have waived
11 * all copyright and related or neighboring rights to this file.
Cosmin Truta46aedd82018-07-15 23:58:00 -040012 * This work is published from: United States, Canada.
Glenn Randers-Pehrsonb7f95932006-03-05 20:15:20 -060013 */
Guy Schalnat0d580581995-07-20 02:43:20 -050014
Andreas Dilger47a0c421997-05-16 02:46:07 -050015/* This is an example of how to use libpng to read and write PNG files.
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -050016 * The file libpng-manual.txt is much more verbose then this. If you have not
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060017 * read it, do so first. This was designed to be a starting point of an
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060018 * implementation. This is not officially part of libpng, is hereby placed
19 * in the public domain, and therefore does not require a copyright notice.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060020 *
21 * This file does not currently compile, because it is missing certain
22 * parts, like allocating memory to hold an image. You will have to
23 * supply these parts to get it to compile. For an example of a minimal
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060024 * working PNG reader/writer, see pngtest.c, included in this distribution;
25 * see also the programs in the contrib directory.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060026 */
Guy Schalnat0d580581995-07-20 02:43:20 -050027
Glenn Randers-Pehrson7455cbf2011-11-24 14:40:36 -060028/* The simple, but restricted, approach to reading a PNG file or data stream
29 * just requires two function calls, as in the following complete program.
30 * Writing a file just needs one function call, so long as the data has an
31 * appropriate layout.
32 *
33 * The following code reads PNG image data from a file and writes it, in a
34 * potentially new format, to a new file. While this code will compile there is
35 * minimal (insufficient) error checking; for a more realistic version look at
36 * contrib/examples/pngtopng.c
37 */
38#include <stddef.h>
39#include <stdlib.h>
40#include <string.h>
41#include <stdio.h>
42#include <png.h>
John Bowler5d567862011-12-24 09:12:00 -060043#include <zlib.h>
Glenn Randers-Pehrsone1018a52011-05-05 21:03:07 -050044
Glenn Randers-Pehrson7455cbf2011-11-24 14:40:36 -060045int main(int argc, const char **argv)
46{
47 if (argc == 3)
48 {
49 png_image image; /* The control structure used by libpng */
50
51 /* Initialize the 'png_image' structure. */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -060052 memset(&image, 0, (sizeof image));
53 image.version = PNG_IMAGE_VERSION;
Glenn Randers-Pehrson7455cbf2011-11-24 14:40:36 -060054
55 /* The first argument is the file to read: */
Glenn Randers-Pehrson5d713fe2014-10-31 20:48:55 -050056 if (png_image_begin_read_from_file(&image, argv[1]) != 0)
Glenn Randers-Pehrson7455cbf2011-11-24 14:40:36 -060057 {
58 png_bytep buffer;
59
60 /* Set the format in which to read the PNG file; this code chooses a
61 * simple sRGB format with a non-associated alpha channel, adequate to
62 * store most images.
63 */
64 image.format = PNG_FORMAT_RGBA;
65
66 /* Now allocate enough memory to hold the image in this format; the
67 * PNG_IMAGE_SIZE macro uses the information about the image (width,
68 * height and format) stored in 'image'.
69 */
70 buffer = malloc(PNG_IMAGE_SIZE(image));
71
72 /* If enough memory was available read the image in the desired format
73 * then write the result out to the new file. 'background' is not
74 * necessary when reading the image because the alpha channel is
75 * preserved; if it were to be removed, for example if we requested
76 * PNG_FORMAT_RGB, then either a solid background color would have to
77 * be supplied or the output buffer would have to be initialized to the
78 * actual background of the image.
79 *
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -060080 * The fourth argument to png_image_finish_read is the 'row_stride' -
Glenn Randers-Pehrson7455cbf2011-11-24 14:40:36 -060081 * this is the number of components allocated for the image in each
82 * row. It has to be at least as big as the value returned by
83 * PNG_IMAGE_ROW_STRIDE, but if you just allocate space for the
84 * default, minimum, size using PNG_IMAGE_SIZE as above you can pass
85 * zero.
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -060086 *
87 * The final argument is a pointer to a buffer for the colormap;
88 * colormaps have exactly the same format as a row of image pixels (so
89 * you choose what format to make the colormap by setting
90 * image.format). A colormap is only returned if
91 * PNG_FORMAT_FLAG_COLORMAP is also set in image.format, so in this
92 * case NULL is passed as the final argument. If you do want to force
93 * all images into an index/color-mapped format then you can use:
94 *
95 * PNG_IMAGE_COLORMAP_SIZE(image)
96 *
97 * to find the maximum size of the colormap in bytes.
Glenn Randers-Pehrson7455cbf2011-11-24 14:40:36 -060098 */
99 if (buffer != NULL &&
100 png_image_finish_read(&image, NULL/*background*/, buffer,
Glenn Randers-Pehrsondd706042016-07-15 11:20:46 -0500101 0/*row_stride*/, NULL/*colormap*/) != 0)
Glenn Randers-Pehrson7455cbf2011-11-24 14:40:36 -0600102 {
103 /* Now write the image out to the second argument. In the write
104 * call 'convert_to_8bit' allows 16-bit data to be squashed down to
105 * 8 bits; this isn't necessary here because the original read was
106 * to the 8-bit format.
107 */
108 if (png_image_write_to_file(&image, argv[2], 0/*convert_to_8bit*/,
Glenn Randers-Pehrsondd706042016-07-15 11:20:46 -0500109 buffer, 0/*row_stride*/, NULL/*colormap*/) != 0)
Glenn Randers-Pehrson7455cbf2011-11-24 14:40:36 -0600110 {
111 /* The image has been written successfully. */
112 exit(0);
113 }
114 }
John Bowler414769b2011-11-27 21:39:13 -0600115
116 else
117 {
Glenn Randers-Pehrson1ed0b3f2017-07-25 15:32:19 -0500118 /* Calling png_image_free is optional unless the simplified API was
John Bowler414769b2011-11-27 21:39:13 -0600119 * not run to completion. In this case if there wasn't enough
120 * memory for 'buffer' we didn't complete the read, so we must free
121 * the image:
122 */
123 if (buffer == NULL)
Glenn Randers-Pehrson1ed0b3f2017-07-25 15:32:19 -0500124 png_image_free(&image);
John Bowler414769b2011-11-27 21:39:13 -0600125
126 else
127 free(buffer);
Glenn Randers-Pehrson7455cbf2011-11-24 14:40:36 -0600128 }
129
130 /* Something went wrong reading or writing the image. libpng stores a
131 * textual message in the 'png_image' structure:
132 */
133 fprintf(stderr, "pngtopng: error: %s\n", image.message);
134 exit (1);
135 }
136
137 fprintf(stderr, "pngtopng: usage: pngtopng input-file output-file\n");
138 exit(1);
139}
140
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. You
145 * do this by simply changing the 'format' parameter set before allocating the
146 * buffer.
147 *
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 use
150 * one of the predefined macros from png.h (as above):
151 *
152 * PNG_FORMAT_FLAG_COLOR: if set the image will have three color components per
153 * pixel (red, green and blue), if not set the image will just have one
154 * luminance (grayscale) component.
155 *
156 * PNG_FORMAT_FLAG_ALPHA: if set each pixel in the image will have an additional
157 * alpha value; a linear value that describes the degree the image pixel
158 * covers (overwrites) the contents of the existing pixel on the display.
159 *
160 * PNG_FORMAT_FLAG_LINEAR: if set the components of each pixel will be returned
161 * as a series of 16-bit linear values, if not set the components will be
162 * returned as a series of 8-bit values encoded according to the 'sRGB'
163 * standard. The 8-bit format is the normal format for images intended for
164 * direct display, because almost all display devices do the inverse of the
165 * sRGB transformation to the data they receive. The 16-bit format is more
166 * common for scientific data and image data that must be further processed;
167 * because it is linear simple math can be done on the component values.
168 * Regardless of the setting of this flag the alpha channel is always linear,
169 * although it will be 8 bits or 16 bits wide as specified by the flag.
170 *
171 * PNG_FORMAT_FLAG_BGR: if set the components of a color pixel will be returned
172 * in the order blue, then green, then red. If not set the pixel components
173 * are in the order red, then green, then blue.
174 *
175 * PNG_FORMAT_FLAG_AFIRST: if set the alpha channel (if present) precedes the
176 * color or grayscale components. If not set the alpha channel follows the
177 * components.
178 *
179 * You do not have to read directly from a file. You can read from memory or,
180 * on systems that support it, from a <stdio.h> FILE*. This is controlled by
181 * the particular png_image_read_from_ function you call at the start. Likewise
182 * on write you can write to a FILE* if your system supports it. Check the
183 * macro PNG_STDIO_SUPPORTED to see if stdio support has been included in your
184 * libpng build.
185 *
186 * If you read 16-bit (PNG_FORMAT_FLAG_LINEAR) data you may need to write it in
187 * the 8-bit format for display. You do this by setting the convert_to_8bit
188 * flag to 'true'.
189 *
190 * Don't repeatedly convert between the 8-bit and 16-bit forms. There is
191 * significant data loss when 16-bit data is converted to the 8-bit encoding and
Glenn Randers-Pehrson6cae24c2014-10-13 11:11:21 -0500192 * the current libpng implementation of conversion to 16-bit is also
Glenn Randers-Pehrson7455cbf2011-11-24 14:40:36 -0600193 * significantly lossy. The latter will be fixed in the future, but the former
194 * is unavoidable - the 8-bit format just doesn't have enough resolution.
195 */
196
197/* If your program needs more information from the PNG data it reads, or if you
Glenn Randers-Pehrson6cae24c2014-10-13 11:11:21 -0500198 * need to do more complex transformations, or minimize transformations, on the
Glenn Randers-Pehrson7455cbf2011-11-24 14:40:36 -0600199 * data you read, then you must use one of the several lower level libpng
200 * interfaces.
201 *
202 * All these interfaces require that you do your own error handling - your
203 * program must be able to arrange for control to return to your own code any
204 * time libpng encounters a problem. There are several ways to do this, but the
205 * standard way is to use the ANSI-C (C90) <setjmp.h> interface to establish a
206 * return point within your own code. You must do this if you do not use the
207 * simplified interface (above).
208 *
209 * The first step is to include the header files you need, including the libpng
210 * header file. Include any standard headers and feature test macros your
211 * program requires before including png.h:
212 */
213#include <png.h>
Guy Schalnat0d580581995-07-20 02:43:20 -0500214
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600215 /* The png_jmpbuf() macro, used in error handling, became available in
216 * libpng version 1.0.6. If you want to be able to run your code with older
217 * versions of libpng, you must define the macro yourself (but only if it
218 * is not already defined by libpng!).
219 */
220
221#ifndef png_jmpbuf
Glenn Randers-Pehrson95ca51b2010-02-19 14:09:09 -0600222# define png_jmpbuf(png_ptr) ((png_ptr)->png_jmpbuf)
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600223#endif
224
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -0600225/* Check to see if a file is a PNG file using png_sig_cmp(). png_sig_cmp()
226 * returns zero if the image is a PNG and nonzero if it isn't a PNG.
227 *
228 * The function check_if_png() shown here, but not used, returns nonzero (true)
229 * if the file can be opened and is a PNG, 0 (false) otherwise.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600230 *
231 * If this call is successful, and you are going to keep the file open,
232 * you should call png_set_sig_bytes(png_ptr, PNG_BYTES_TO_CHECK); once
233 * you have created the png_ptr, so that libpng knows your application
234 * has read that many bytes from the start of the file. Make sure you
235 * don't call png_set_sig_bytes() with more than 8 bytes read or give it
236 * an incorrect number of bytes read, or you will either have read too
237 * many bytes (your fault), or you are telling libpng to read the wrong
238 * number of magic bytes (also your fault).
239 *
240 * Many applications already read the first 2 or 4 bytes from the start
241 * of the image to determine the file type, so it would be easiest just
Glenn Randers-Pehrson0f7202f1998-03-08 18:52:15 -0600242 * to pass the bytes to png_sig_cmp() or even skip that if you know
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600243 * you have a PNG file, and call png_set_sig_bytes().
244 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500245#define PNG_BYTES_TO_CHECK 4
246int check_if_png(char *file_name, FILE **fp)
Guy Schalnat0d580581995-07-20 02:43:20 -0500247{
Andreas Dilger47a0c421997-05-16 02:46:07 -0500248 char buf[PNG_BYTES_TO_CHECK];
Guy Schalnat0d580581995-07-20 02:43:20 -0500249
Andreas Dilger47a0c421997-05-16 02:46:07 -0500250 /* Open the prospective PNG file. */
Glenn Randers-Pehrson68ea2432000-04-01 21:10:05 -0600251 if ((*fp = fopen(file_name, "rb")) == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500252 return 0;
253
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -0600254 /* Read in some of the signature bytes */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500255 if (fread(buf, 1, PNG_BYTES_TO_CHECK, *fp) != PNG_BYTES_TO_CHECK)
256 return 0;
Guy Schalnat0d580581995-07-20 02:43:20 -0500257
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -0600258 /* Compare the first PNG_BYTES_TO_CHECK bytes of the signature.
259 Return nonzero (true) if they match */
260
Cosmin Trutaa74aa9a2018-06-17 22:37:44 -0400261 return(!png_sig_cmp(buf, 0, PNG_BYTES_TO_CHECK));
Guy Schalnat0d580581995-07-20 02:43:20 -0500262}
263
Andreas Dilger47a0c421997-05-16 02:46:07 -0500264/* Read a PNG file. You may want to return an error code if the read
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600265 * fails (depending upon the failure). There are two "prototypes" given
266 * here - one where we are given the filename, and we need to open the
267 * file, and the other where we are given an open file (possibly with
268 * some or all of the magic bytes read - see comments above).
269 */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600270#ifdef open_file /* prototype 1 */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600271void read_png(char *file_name) /* We need to open the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500272{
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600273 png_structp png_ptr;
Guy Schalnat6d764711995-12-19 03:22:19 -0600274 png_infop info_ptr;
Glenn Randers-Pehrsona8242fe2015-08-17 20:46:27 -0500275 int sig_read = 0;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500276 png_uint_32 width, height;
277 int bit_depth, color_type, interlace_type;
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600278 FILE *fp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500279
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600280 if ((fp = fopen(file_name, "rb")) == NULL)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500281 return (ERROR);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500282
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600283#else no_open_file /* prototype 2 */
Glenn Randers-Pehrsona8242fe2015-08-17 20:46:27 -0500284void read_png(FILE *fp, int sig_read) /* File is already open */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600285{
286 png_structp png_ptr;
287 png_infop info_ptr;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500288 png_uint_32 width, height;
289 int bit_depth, color_type, interlace_type;
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500290#endif no_open_file /* Only use one prototype! */
Guy Schalnat0d580581995-07-20 02:43:20 -0500291
Guy Schalnate5a37791996-06-05 15:50:50 -0500292 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500293 * functions. If you want to use the default stderr and longjump method,
294 * you can supply NULL for the last three parameters. We also supply the
295 * the compiler header file version, so that we know if the application
296 * was compiled with a compatible version of the library. REQUIRED
297 */
Glenn Randers-Pehrson61ea3ea2014-11-06 06:39:56 -0600298 png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsondd706042016-07-15 11:20:46 -0500299 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500300
Andreas Dilger47a0c421997-05-16 02:46:07 -0500301 if (png_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500302 {
303 fclose(fp);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500304 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500305 }
306
Andreas Dilger47a0c421997-05-16 02:46:07 -0500307 /* Allocate/initialize the memory for image information. REQUIRED. */
Glenn Randers-Pehrson0f7202f1998-03-08 18:52:15 -0600308 info_ptr = png_create_info_struct(png_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500309 if (info_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500310 {
311 fclose(fp);
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500312 png_destroy_read_struct(&png_ptr, NULL, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500313 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500314 }
315
Andreas Dilger47a0c421997-05-16 02:46:07 -0500316 /* Set error handling if you are using the setjmp/longjmp method (this is
317 * the normal method of doing things with libpng). REQUIRED unless you
318 * set up your own error handlers in the png_create_read_struct() earlier.
319 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600320
321 if (setjmp(png_jmpbuf(png_ptr)))
Guy Schalnat0d580581995-07-20 02:43:20 -0500322 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500323 /* Free all of the memory associated with the png_ptr and info_ptr */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500324 png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
Guy Schalnat0d580581995-07-20 02:43:20 -0500325 fclose(fp);
Guy Schalnat0d580581995-07-20 02:43:20 -0500326 /* If we get here, we had a problem reading the file */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500327 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500328 }
329
Andreas Dilger47a0c421997-05-16 02:46:07 -0500330 /* One of the following I/O initialization methods is REQUIRED */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600331#ifdef streams /* PNG file I/O method 1 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500332 /* Set up the input control if you are using standard C streams */
Guy Schalnat0d580581995-07-20 02:43:20 -0500333 png_init_io(png_ptr, fp);
334
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600335#else no_streams /* PNG file I/O method 2 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500336 /* If you are using replacement read functions, instead of calling
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600337 * png_init_io() here you would call:
338 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500339 png_set_read_fn(png_ptr, (void *)user_io_ptr, user_read_fn);
340 /* where user_io_ptr is a structure you want available to the callbacks */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600341#endif no_streams /* Use only one I/O method! */
Guy Schalnat69b14481996-01-10 02:56:49 -0600342
Andreas Dilger47a0c421997-05-16 02:46:07 -0500343 /* If we have already read some of the signature */
Glenn Randers-Pehrson0f7202f1998-03-08 18:52:15 -0600344 png_set_sig_bytes(png_ptr, sig_read);
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600345
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600346#ifdef hilevel
347 /*
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
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500351 * quantizing, filling, setting background, and doing gamma
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600352 * adjustment), then you can read the entire image (including
353 * pixels) into the info structure with this call:
354 */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500355 png_read_png(png_ptr, info_ptr, png_transforms, NULL);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500356
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600357#else
358 /* OK, you're doing it the hard way, with the lower-level functions */
359
Andreas Dilger47a0c421997-05-16 02:46:07 -0500360 /* 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
362 */
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600363 png_read_info(png_ptr, info_ptr);
Guy Schalnat69b14481996-01-10 02:56:49 -0600364
Andreas Dilger47a0c421997-05-16 02:46:07 -0500365 png_get_IHDR(png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500366 &interlace_type, NULL, NULL);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500367
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500368 /* 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.
372 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500373
Glenn Randers-Pehrson8b83ff32015-08-13 20:57:18 -0500374 /* Tell libpng to strip 16 bits/color files down to 8 bits/color.
Glenn Randers-Pehrson857dbbe2011-06-16 09:39:40 -0500375 * Use accurate scaling if it's available, otherwise just chop off the
376 * low byte.
377 */
John Bowler8d261262011-06-18 13:37:11 -0500378#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
Glenn Randers-Pehrson192e92d2016-07-13 14:43:42 -0500379 png_set_scale_16(png_ptr);
Glenn Randers-Pehrson857dbbe2011-06-16 09:39:40 -0500380#else
Glenn Randers-Pehrsonab63dd02011-06-17 20:04:17 -0500381 png_set_strip_16(png_ptr);
Glenn Randers-Pehrson857dbbe2011-06-16 09:39:40 -0500382#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -0500383
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500384 /* Strip alpha bytes from the input data without combining with the
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600385 * background (not recommended).
386 */
Glenn Randers-Pehrson7a18a2d2016-07-13 16:26:00 -0500387 png_set_strip_alpha(png_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500388
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600389 /* Extract multiple pixels with bit depths of 1, 2, and 4 from a single
Andreas Dilger47a0c421997-05-16 02:46:07 -0500390 * byte into separate bytes (useful for paletted and grayscale images).
391 */
Glenn Randers-Pehrson7a18a2d2016-07-13 16:26:00 -0500392 png_set_packing(png_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500393
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600394 /* Change the order of packed pixels to least significant bit first
Andreas Dilger47a0c421997-05-16 02:46:07 -0500395 * (not useful if you are using png_set_packing). */
396 png_set_packswap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500397
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600398 /* Expand paletted colors into true RGB triplets */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500399 if (color_type == PNG_COLOR_TYPE_PALETTE)
Glenn Randers-Pehrsonf46918d2006-06-02 05:31:20 -0500400 png_set_palette_to_rgb(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500401
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600402 /* Expand grayscale images to the full 8 bits from 1, 2, or 4 bits/pixel */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500403 if (color_type == PNG_COLOR_TYPE_GRAY && bit_depth < 8)
Glenn Randers-Pehrson56f63962008-10-06 10:16:17 -0500404 png_set_expand_gray_1_2_4_to_8(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500405
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600406 /* Expand paletted or RGB images with transparency to full alpha channels
407 * so the data will be available as RGBA quartets.
408 */
Glenn Randers-Pehrson5d713fe2014-10-31 20:48:55 -0500409 if (png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS) != 0)
Glenn Randers-Pehrsonb1828932001-06-23 08:03:17 -0500410 png_set_tRNS_to_alpha(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500411
Andreas Dilger47a0c421997-05-16 02:46:07 -0500412 /* Set the background color to draw transparent and alpha images over.
413 * It is possible to set the red, green, and blue components directly
414 * for paletted images instead of supplying a palette index. Note that
415 * even if the PNG file supplies a background, you are not required to
416 * use it - you should use the (solid) application background if it has one.
417 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500418
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600419 png_color_16 my_background, *image_background;
Guy Schalnat0d580581995-07-20 02:43:20 -0500420
Glenn Randers-Pehrson5d713fe2014-10-31 20:48:55 -0500421 if (png_get_bKGD(png_ptr, info_ptr, &image_background) != 0)
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600422 png_set_background(png_ptr, image_background,
Glenn Randers-Pehrsondd706042016-07-15 11:20:46 -0500423 PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600424 else
425 png_set_background(png_ptr, &my_background,
Glenn Randers-Pehrsondd706042016-07-15 11:20:46 -0500426 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
Guy Schalnat0d580581995-07-20 02:43:20 -0500427
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500428 /* Some suggestions as to how to get a screen gamma value
429 *
430 * Note that screen gamma is the display_exponent, which includes
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500431 * the CRT_exponent and any correction for viewing conditions
432 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500433 if (/* We have a user-defined screen gamma value */)
434 {
435 screen_gamma = user-defined screen_gamma;
436 }
437 /* This is one way that applications share the same screen gamma value */
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600438 else if ((gamma_str = getenv("SCREEN_GAMMA")) != NULL)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500439 {
440 screen_gamma = atof(gamma_str);
441 }
442 /* If we don't have another value */
443 else
444 {
Glenn Randers-Pehrsonb0d97352013-06-25 19:36:15 -0500445 screen_gamma = PNG_DEFAULT_sRGB; /* A good guess for a PC monitor
Glenn Randers-Pehrson56a1a662013-06-27 16:56:16 -0500446 in a dimly lit room */
Glenn Randers-Pehrsonb0d97352013-06-25 19:36:15 -0500447 screen_gamma = PNG_GAMMA_MAC_18 or 1.0; /* Good guesses for Mac systems */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500448 }
449
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600450 /* Tell libpng to handle the gamma conversion for you. The final call
Andreas Dilger47a0c421997-05-16 02:46:07 -0500451 * is a good guess for PC generated images, but it should be configurable
452 * by the user at run time by the user. It is strongly suggested that
453 * your application support gamma correction.
454 */
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600455
456 int intent;
457
Glenn Randers-Pehrson5d713fe2014-10-31 20:48:55 -0500458 if (png_get_sRGB(png_ptr, info_ptr, &intent) != 0)
Glenn Randers-Pehrsonb0d97352013-06-25 19:36:15 -0500459 png_set_gamma(png_ptr, screen_gamma, PNG_DEFAULT_sRGB);
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600460 else
461 {
462 double image_gamma;
Glenn Randers-Pehrson5d713fe2014-10-31 20:48:55 -0500463 if (png_get_gAMA(png_ptr, info_ptr, &image_gamma) != 0)
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600464 png_set_gamma(png_ptr, screen_gamma, image_gamma);
465 else
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600466 png_set_gamma(png_ptr, screen_gamma, 0.45455);
467 }
Guy Schalnat0d580581995-07-20 02:43:20 -0500468
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500469#ifdef PNG_READ_QUANTIZE_SUPPORTED
Glenn Randers-Pehrson8b83ff32015-08-13 20:57:18 -0500470 /* Quantize RGB files down to 8-bit palette or reduce palettes
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600471 * to the number of colors available on your screen.
472 */
Glenn Randers-Pehrson5d713fe2014-10-31 20:48:55 -0500473 if ((color_type & PNG_COLOR_MASK_COLOR) != 0)
Guy Schalnat0d580581995-07-20 02:43:20 -0500474 {
Glenn Randers-Pehrsonf05f8032000-12-23 14:27:39 -0600475 int num_palette;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500476 png_colorp palette;
477
478 /* This reduces the image to the application supplied palette */
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500479 if (/* We have our own palette */)
Guy Schalnat0d580581995-07-20 02:43:20 -0500480 {
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500481 /* An array of colors to which the image should be quantized */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500482 png_color std_color_cube[MAX_SCREEN_COLORS];
Guy Schalnat0d580581995-07-20 02:43:20 -0500483
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500484 png_set_quantize(png_ptr, std_color_cube, MAX_SCREEN_COLORS,
Glenn Randers-Pehrsondd706042016-07-15 11:20:46 -0500485 MAX_SCREEN_COLORS, NULL, 0);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500486 }
487 /* This reduces the image to the palette supplied in the file */
Glenn Randers-Pehrson5d713fe2014-10-31 20:48:55 -0500488 else if (png_get_PLTE(png_ptr, info_ptr, &palette, &num_palette) != 0)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500489 {
Glenn Randers-Pehrson865f4f02002-09-15 20:30:38 -0500490 png_uint_16p histogram = NULL;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500491
492 png_get_hIST(png_ptr, info_ptr, &histogram);
493
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500494 png_set_quantize(png_ptr, palette, num_palette,
Glenn Randers-Pehrsondd706042016-07-15 11:20:46 -0500495 max_screen_colors, histogram, 0);
Guy Schalnat0d580581995-07-20 02:43:20 -0500496 }
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600497 }
Glenn Randers-Pehrson985dc002014-11-06 23:17:35 -0600498#endif /* READ_QUANTIZE */
Guy Schalnat0d580581995-07-20 02:43:20 -0500499
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500500 /* Invert monochrome files to have 0 as white and 1 as black */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600501 png_set_invert_mono(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500502
Andreas Dilger47a0c421997-05-16 02:46:07 -0500503 /* If you want to shift the pixel values from the range [0,255] or
504 * [0,65535] to the original [0,7] or [0,31], or whatever range the
505 * colors were originally in:
506 */
Glenn Randers-Pehrson5d713fe2014-10-31 20:48:55 -0500507 if (png_get_valid(png_ptr, info_ptr, PNG_INFO_sBIT) != 0)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500508 {
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500509 png_color_8p sig_bit_p;
Guy Schalnat0d580581995-07-20 02:43:20 -0500510
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500511 png_get_sBIT(png_ptr, info_ptr, &sig_bit_p);
512 png_set_shift(png_ptr, sig_bit_p);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500513 }
Guy Schalnat0d580581995-07-20 02:43:20 -0500514
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500515 /* Flip the RGB pixels to BGR (or RGBA to BGRA) */
Glenn Randers-Pehrson5d713fe2014-10-31 20:48:55 -0500516 if ((color_type & PNG_COLOR_MASK_COLOR) != 0)
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -0500517 png_set_bgr(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500518
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500519 /* Swap the RGBA or GA data to ARGB or AG (or BGRA to ABGR) */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500520 png_set_swap_alpha(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500521
Glenn Randers-Pehrson8b83ff32015-08-13 20:57:18 -0500522 /* Swap bytes of 16-bit files to least significant byte first */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500523 png_set_swap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500524
Andreas Dilger47a0c421997-05-16 02:46:07 -0500525 /* Add filler (or alpha) byte (before/after each RGB triplet) */
Glenn Randers-Pehrson01a0e802015-09-24 22:39:53 -0500526 png_set_filler(png_ptr, 0xffff, PNG_FILLER_AFTER);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500527
Glenn Randers-Pehrson4daae302011-10-06 21:37:47 -0500528#ifdef PNG_READ_INTERLACING_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -0500529 /* Turn on interlace handling. REQUIRED if you are not using
530 * png_read_image(). To see how to handle interlacing passes,
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600531 * see the png_read_row() method below:
Andreas Dilger47a0c421997-05-16 02:46:07 -0500532 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500533 number_passes = png_set_interlace_handling(png_ptr);
Glenn Randers-Pehrson7a18a2d2016-07-13 16:26:00 -0500534#else /* !READ_INTERLACING */
Glenn Randers-Pehrson4daae302011-10-06 21:37:47 -0500535 number_passes = 1;
Glenn Randers-Pehrsoncda68df2014-11-06 22:11:39 -0600536#endif /* READ_INTERLACING */
Glenn Randers-Pehrson4daae302011-10-06 21:37:47 -0500537
Guy Schalnat0d580581995-07-20 02:43:20 -0500538
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600539 /* Optional call to gamma correct and add the background to the palette
Andreas Dilger47a0c421997-05-16 02:46:07 -0500540 * and update info structure. REQUIRED if you are expecting libpng to
541 * update the palette for you (ie you selected such a transform above).
542 */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500543 png_read_update_info(png_ptr, info_ptr);
544
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600545 /* Allocate the memory to hold the image using the fields of info_ptr. */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500546
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600547 /* The easiest way to read the image: */
Guy Schalnat6d764711995-12-19 03:22:19 -0600548 png_bytep row_pointers[height];
Guy Schalnate5a37791996-06-05 15:50:50 -0500549
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500550 /* Clear the pointer array */
Guy Schalnate5a37791996-06-05 15:50:50 -0500551 for (row = 0; row < height; row++)
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500552 row_pointers[row] = NULL;
553
554 for (row = 0; row < height; row++)
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -0500555 row_pointers[row] = png_malloc(png_ptr, png_get_rowbytes(png_ptr,
Glenn Randers-Pehrsondd706042016-07-15 11:20:46 -0500556 info_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -0500557
Andreas Dilger47a0c421997-05-16 02:46:07 -0500558 /* Now it's time to read the image. One of these methods is REQUIRED */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600559#ifdef entire /* Read the entire image in one go */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500560 png_read_image(png_ptr, row_pointers);
561
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600562#else no_entire /* Read the image one or more scanlines at a time */
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600563 /* The other way to read images - deal with interlacing: */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500564
Guy Schalnat0d580581995-07-20 02:43:20 -0500565 for (pass = 0; pass < number_passes; pass++)
566 {
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600567#ifdef single /* Read the image a single row at a time */
Guy Schalnat0d580581995-07-20 02:43:20 -0500568 for (y = 0; y < height; y++)
569 {
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500570 png_read_rows(png_ptr, &row_pointers[y], NULL, 1);
Guy Schalnat0d580581995-07-20 02:43:20 -0500571 }
572
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600573#else no_single /* Read the image several rows at a time */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500574 for (y = 0; y < height; y += number_of_rows)
575 {
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600576#ifdef sparkle /* Read the image using the "sparkle" effect. */
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500577 png_read_rows(png_ptr, &row_pointers[y], NULL,
Glenn Randers-Pehrsondd706042016-07-15 11:20:46 -0500578 number_of_rows);
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600579#else no_sparkle /* Read the image using the "rectangle" effect */
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500580 png_read_rows(png_ptr, NULL, &row_pointers[y],
Glenn Randers-Pehrsondd706042016-07-15 11:20:46 -0500581 number_of_rows);
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500582#endif no_sparkle /* Use only one of these two methods */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500583 }
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600584
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500585 /* If you want to display the image after every pass, do so here */
586#endif no_single /* Use only one of these two methods */
Guy Schalnat0d580581995-07-20 02:43:20 -0500587 }
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500588#endif no_entire /* Use only one of these two methods */
Guy Schalnat0d580581995-07-20 02:43:20 -0500589
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500590 /* Read rest of file, and get additional chunks in info_ptr - REQUIRED */
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600591 png_read_end(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600592#endif hilevel
593
594 /* At this point you have read the entire image */
Guy Schalnat0d580581995-07-20 02:43:20 -0500595
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500596 /* Clean up after the read, and free any memory allocated - REQUIRED */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500597 png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
Guy Schalnat0d580581995-07-20 02:43:20 -0500598
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500599 /* Close the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500600 fclose(fp);
601
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500602 /* That's it */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500603 return (OK);
Guy Schalnat0d580581995-07-20 02:43:20 -0500604}
605
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500606/* Progressively read a file */
Guy Schalnat6d764711995-12-19 03:22:19 -0600607
Guy Schalnat6d764711995-12-19 03:22:19 -0600608int
Guy Schalnate5a37791996-06-05 15:50:50 -0500609initialize_png_reader(png_structp *png_ptr, png_infop *info_ptr)
Guy Schalnat6d764711995-12-19 03:22:19 -0600610{
Guy Schalnate5a37791996-06-05 15:50:50 -0500611 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500612 * functions. If you want to use the default stderr and longjump method,
613 * you can supply NULL for the last three parameters. We also check that
614 * the library version is compatible in case we are using dynamically
615 * linked libraries.
Guy Schalnate5a37791996-06-05 15:50:50 -0500616 */
Glenn Randers-Pehrson61ea3ea2014-11-06 06:39:56 -0600617 *png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsondd706042016-07-15 11:20:46 -0500618 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500619
Andreas Dilger47a0c421997-05-16 02:46:07 -0500620 if (*png_ptr == NULL)
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600621 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500622 *info_ptr = NULL;
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500623 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600624 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600625
Guy Schalnate5a37791996-06-05 15:50:50 -0500626 *info_ptr = png_create_info_struct(png_ptr);
627
Andreas Dilger47a0c421997-05-16 02:46:07 -0500628 if (*info_ptr == NULL)
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600629 {
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500630 png_destroy_read_struct(png_ptr, info_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500631 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600632 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600633
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600634 if (setjmp(png_jmpbuf((*png_ptr))))
Guy Schalnate5a37791996-06-05 15:50:50 -0500635 {
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500636 png_destroy_read_struct(png_ptr, info_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500637 return (ERROR);
Guy Schalnate5a37791996-06-05 15:50:50 -0500638 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600639
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600640 /* This one's new. You will need to provide all three
Andreas Dilger47a0c421997-05-16 02:46:07 -0500641 * function callbacks, even if you aren't using them all.
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600642 * If you aren't using all functions, you can specify NULL
643 * parameters. Even when all three functions are NULL,
644 * you need to call png_set_progressive_read_fn().
Andreas Dilger47a0c421997-05-16 02:46:07 -0500645 * These functions shouldn't be dependent on global or
646 * static variables if you are decoding several images
647 * simultaneously. You should store stream specific data
648 * in a separate struct, given as the second parameter,
649 * and retrieve the pointer from inside the callbacks using
650 * the function png_get_progressive_ptr(png_ptr).
651 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500652 png_set_progressive_read_fn(*png_ptr, (void *)stream_data,
Glenn Randers-Pehrsondd706042016-07-15 11:20:46 -0500653 info_callback, row_callback, end_callback);
Guy Schalnat6d764711995-12-19 03:22:19 -0600654
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500655 return (OK);
Guy Schalnat6d764711995-12-19 03:22:19 -0600656}
657
658int
Guy Schalnate5a37791996-06-05 15:50:50 -0500659process_data(png_structp *png_ptr, png_infop *info_ptr,
Glenn Randers-Pehrsondd706042016-07-15 11:20:46 -0500660 png_bytep buffer, png_uint_32 length)
Guy Schalnat6d764711995-12-19 03:22:19 -0600661{
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600662 if (setjmp(png_jmpbuf((*png_ptr))))
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600663 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500664 /* Free the png_ptr and info_ptr memory on error */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500665 png_destroy_read_struct(png_ptr, info_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500666 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600667 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600668
Andreas Dilger47a0c421997-05-16 02:46:07 -0500669 /* This one's new also. Simply give it chunks of data as
670 * they arrive from the data stream (in order, of course).
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500671 * On segmented machines, don't give it any more than 64K.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500672 * The library seems to run fine with sizes of 4K, although
673 * you can give it much less if necessary (I assume you can
674 * give it chunks of 1 byte, but I haven't tried with less
675 * than 256 bytes yet). When this function returns, you may
676 * want to display any rows that were generated in the row
677 * callback, if you aren't already displaying them there.
678 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500679 png_process_data(*png_ptr, *info_ptr, buffer, length);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500680 return (OK);
Guy Schalnat6d764711995-12-19 03:22:19 -0600681}
682
683info_callback(png_structp png_ptr, png_infop info)
684{
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500685 /* Do any setup here, including setting any of the transformations
686 * mentioned in the Reading PNG files section. For now, you _must_
687 * call either png_start_read_image() or png_read_update_info()
688 * after all the transformations are set (even if you don't set
689 * any). You may start getting rows before png_process_data()
690 * returns, so this is your last chance to prepare for that.
691 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600692}
693
694row_callback(png_structp png_ptr, png_bytep new_row,
Glenn Randers-Pehrsondd706042016-07-15 11:20:46 -0500695 png_uint_32 row_num, int pass)
Guy Schalnat6d764711995-12-19 03:22:19 -0600696{
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500697 /*
698 * This function is called for every row in the image. If the
699 * image is interlaced, and you turned on the interlace handler,
700 * this function will be called for every row in every pass.
701 *
702 * In this function you will receive a pointer to new row data from
703 * libpng called new_row that is to replace a corresponding row (of
704 * the same data format) in a buffer allocated by your application.
705 *
706 * The new row data pointer "new_row" may be NULL, indicating there is
707 * no new data to be replaced (in cases of interlace loading).
708 *
709 * If new_row is not NULL then you need to call
710 * png_progressive_combine_row() to replace the corresponding row as
711 * shown below:
712 */
713
Glenn Randers-Pehrson53c07f52010-06-18 18:55:55 -0500714 /* Get pointer to corresponding row in our
715 * PNG read buffer.
716 */
717 png_bytep old_row = ((png_bytep *)our_data)[row_num];
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -0500718
Glenn Randers-Pehrson4daae302011-10-06 21:37:47 -0500719#ifdef PNG_READ_INTERLACING_SUPPORTED
Glenn Randers-Pehrson53c07f52010-06-18 18:55:55 -0500720 /* If both rows are allocated then copy the new row
721 * data to the corresponding row data.
722 */
723 if ((old_row != NULL) && (new_row != NULL))
724 png_progressive_combine_row(png_ptr, old_row, new_row);
725
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500726 /*
727 * The rows and passes are called in order, so you don't really
728 * need the row_num and pass, but I'm supplying them because it
729 * may make your life easier.
730 *
731 * For the non-NULL rows of interlaced images, you must call
732 * png_progressive_combine_row() passing in the new row and the
733 * old row, as demonstrated above. You can call this function for
734 * NULL rows (it will just return) and for non-interlaced images
John Bowlerfcd301d2011-12-28 21:34:27 -0600735 * (it just does the memcpy for you) if it will make the code
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500736 * easier. Thus, you can just do this for all cases:
737 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600738
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600739 png_progressive_combine_row(png_ptr, old_row, new_row);
Guy Schalnat6d764711995-12-19 03:22:19 -0600740
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500741 /* where old_row is what was displayed for previous rows. Note
742 * that the first pass (pass == 0 really) will completely cover
743 * the old row, so the rows do not have to be initialized. After
744 * the first pass (and only for interlaced images), you will have
745 * to pass the current row as new_row, and the function will combine
746 * the old row and the new row.
747 */
Glenn Randers-Pehrsoncda68df2014-11-06 22:11:39 -0600748#endif /* READ_INTERLACING */
Guy Schalnat6d764711995-12-19 03:22:19 -0600749}
750
751end_callback(png_structp png_ptr, png_infop info)
752{
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500753 /* This function is called when the whole image has been read,
754 * including any chunks after the image (up to and including
755 * the IEND). You will usually have the same info chunk as you
756 * had in the header, although some data may have been added
757 * to the comments and time fields.
758 *
759 * Most people won't do much here, perhaps setting a flag that
760 * marks the image as finished.
761 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600762}
763
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500764/* Write a png file */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600765void write_png(char *file_name /* , ... other image information ... */)
Guy Schalnat0d580581995-07-20 02:43:20 -0500766{
767 FILE *fp;
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600768 png_structp png_ptr;
769 png_infop info_ptr;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600770 png_colorp palette;
Guy Schalnat0d580581995-07-20 02:43:20 -0500771
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500772 /* Open the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500773 fp = fopen(file_name, "wb");
Andreas Dilger47a0c421997-05-16 02:46:07 -0500774 if (fp == NULL)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500775 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500776
Guy Schalnate5a37791996-06-05 15:50:50 -0500777 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500778 * functions. If you want to use the default stderr and longjump method,
779 * you can supply NULL for the last three parameters. We also check that
780 * the library version is compatible with the one used at compile time,
781 * in case we are using dynamically linked libraries. REQUIRED.
Guy Schalnate5a37791996-06-05 15:50:50 -0500782 */
Glenn Randers-Pehrson61ea3ea2014-11-06 06:39:56 -0600783 png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsondd706042016-07-15 11:20:46 -0500784 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500785
Andreas Dilger47a0c421997-05-16 02:46:07 -0500786 if (png_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500787 {
788 fclose(fp);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500789 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500790 }
791
Andreas Dilger47a0c421997-05-16 02:46:07 -0500792 /* Allocate/initialize the image information data. REQUIRED */
Guy Schalnate5a37791996-06-05 15:50:50 -0500793 info_ptr = png_create_info_struct(png_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500794 if (info_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500795 {
796 fclose(fp);
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500797 png_destroy_write_struct(&png_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500798 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500799 }
800
Andreas Dilger47a0c421997-05-16 02:46:07 -0500801 /* Set error handling. REQUIRED if you aren't supplying your own
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600802 * error handling functions in the png_create_write_struct() call.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500803 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600804 if (setjmp(png_jmpbuf(png_ptr)))
Guy Schalnat0d580581995-07-20 02:43:20 -0500805 {
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500806 /* If we get here, we had a problem writing the file */
Guy Schalnate5a37791996-06-05 15:50:50 -0500807 fclose(fp);
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -0500808 png_destroy_write_struct(&png_ptr, &info_ptr);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500809 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500810 }
811
Andreas Dilger47a0c421997-05-16 02:46:07 -0500812 /* One of the following I/O initialization functions is REQUIRED */
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500813
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600814#ifdef streams /* I/O initialization method 1 */
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500815 /* Set up the output control if you are using standard C streams */
Guy Schalnat0d580581995-07-20 02:43:20 -0500816 png_init_io(png_ptr, fp);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500817
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600818#else no_streams /* I/O initialization method 2 */
Glenn Randers-Pehrsona5fa5c92008-09-06 07:06:22 -0500819 /* If you are using replacement write functions, instead of calling
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500820 * png_init_io() here you would call
821 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500822 png_set_write_fn(png_ptr, (void *)user_io_ptr, user_write_fn,
Glenn Randers-Pehrsondd706042016-07-15 11:20:46 -0500823 user_IO_flush_function);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500824 /* where user_io_ptr is a structure you want available to the callbacks */
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500825#endif no_streams /* Only use one initialization method */
Guy Schalnat0d580581995-07-20 02:43:20 -0500826
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600827#ifdef hilevel
828 /* This is the easy way. Use it if you already have all the
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500829 * image info living in the structure. You could "|" many
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600830 * PNG_TRANSFORM flags into the png_transforms integer here.
831 */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500832 png_write_png(png_ptr, info_ptr, png_transforms, NULL);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500833
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600834#else
835 /* This is the hard way */
836
Andreas Dilger47a0c421997-05-16 02:46:07 -0500837 /* Set the image information here. Width and height are up to 2^31,
838 * bit_depth is one of 1, 2, 4, 8, or 16, but valid values also depend on
839 * the color_type selected. color_type is one of PNG_COLOR_TYPE_GRAY,
840 * PNG_COLOR_TYPE_GRAY_ALPHA, PNG_COLOR_TYPE_PALETTE, PNG_COLOR_TYPE_RGB,
841 * or PNG_COLOR_TYPE_RGB_ALPHA. interlace is either PNG_INTERLACE_NONE or
842 * PNG_INTERLACE_ADAM7, and the compression_type and filter_type MUST
843 * currently be PNG_COMPRESSION_TYPE_BASE and PNG_FILTER_TYPE_BASE. REQUIRED
844 */
845 png_set_IHDR(png_ptr, info_ptr, width, height, bit_depth, PNG_COLOR_TYPE_???,
Glenn Randers-Pehrsondd706042016-07-15 11:20:46 -0500846 PNG_INTERLACE_????, PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
Guy Schalnat0d580581995-07-20 02:43:20 -0500847
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500848 /* Set the palette if there is one. REQUIRED for indexed-color images */
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -0500849 palette = (png_colorp)png_malloc(png_ptr, PNG_MAX_PALETTE_LENGTH
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600850 * (sizeof (png_color)));
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500851 /* ... Set palette colors ... */
Glenn Randers-Pehrson76e5fd62000-12-28 07:50:05 -0600852 png_set_PLTE(png_ptr, info_ptr, palette, PNG_MAX_PALETTE_LENGTH);
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600853 /* You must not free palette here, because png_set_PLTE only makes a link to
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500854 * the palette that you malloced. Wait until you are about to destroy
855 * the png structure.
856 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500857
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500858 /* Optional significant bit (sBIT) chunk */
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500859 png_color_8 sig_bit;
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500860
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500861 /* If we are dealing with a grayscale image then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500862 sig_bit.gray = true_bit_depth;
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500863
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500864 /* Otherwise, if we are dealing with a color image then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500865 sig_bit.red = true_red_bit_depth;
866 sig_bit.green = true_green_bit_depth;
867 sig_bit.blue = true_blue_bit_depth;
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500868
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500869 /* If the image has an alpha channel then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500870 sig_bit.alpha = true_alpha_bit_depth;
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500871
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500872 png_set_sBIT(png_ptr, info_ptr, &sig_bit);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500873
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600874
Andreas Dilger47a0c421997-05-16 02:46:07 -0500875 /* Optional gamma chunk is strongly suggested if you have any guess
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600876 * as to the correct gamma of the image.
877 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500878 png_set_gAMA(png_ptr, info_ptr, gamma);
Guy Schalnat0d580581995-07-20 02:43:20 -0500879
Andreas Dilger47a0c421997-05-16 02:46:07 -0500880 /* Optionally write comments into the image */
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600881 {
882 png_text text_ptr[3];
883
884 char key0[]="Title";
885 char text0[]="Mona Lisa";
886 text_ptr[0].key = key0;
887 text_ptr[0].text = text0;
888 text_ptr[0].compression = PNG_TEXT_COMPRESSION_NONE;
889 text_ptr[0].itxt_length = 0;
890 text_ptr[0].lang = NULL;
891 text_ptr[0].lang_key = NULL;
892
893 char key1[]="Author";
894 char text1[]="Leonardo DaVinci";
895 text_ptr[1].key = key1;
896 text_ptr[1].text = text1;
897 text_ptr[1].compression = PNG_TEXT_COMPRESSION_NONE;
898 text_ptr[1].itxt_length = 0;
899 text_ptr[1].lang = NULL;
900 text_ptr[1].lang_key = NULL;
901
902 char key2[]="Description";
903 char text2[]="<long text>";
904 text_ptr[2].key = key2;
905 text_ptr[2].text = text2;
906 text_ptr[2].compression = PNG_TEXT_COMPRESSION_zTXt;
907 text_ptr[2].itxt_length = 0;
908 text_ptr[2].lang = NULL;
909 text_ptr[2].lang_key = NULL;
910
911 png_set_text(write_ptr, write_info_ptr, text_ptr, 3);
912 }
Guy Schalnat0d580581995-07-20 02:43:20 -0500913
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500914 /* Other optional chunks like cHRM, bKGD, tRNS, tIME, oFFs, pHYs */
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500915
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500916 /* Note that if sRGB is present the gAMA and cHRM chunks must be ignored
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500917 * on read and, if your application chooses to write them, they must
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500918 * be written in accordance with the sRGB profile
919 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500920
921 /* Write the file header information. REQUIRED */
Guy Schalnat0d580581995-07-20 02:43:20 -0500922 png_write_info(png_ptr, info_ptr);
923
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600924 /* If you want, you can write the info in two steps, in case you need to
925 * write your private chunk ahead of PLTE:
926 *
927 * png_write_info_before_PLTE(write_ptr, write_info_ptr);
928 * write_my_chunk();
929 * png_write_info(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600930 *
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500931 * However, given the level of known- and unknown-chunk support in 1.2.0
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600932 * and up, this should no longer be necessary.
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600933 */
934
Andreas Dilger47a0c421997-05-16 02:46:07 -0500935 /* Once we write out the header, the compression type on the text
Glenn Randers-Pehrsona11cd842014-10-05 13:45:38 -0500936 * chunk gets changed to PNG_TEXT_COMPRESSION_NONE_WR or
Andreas Dilger47a0c421997-05-16 02:46:07 -0500937 * PNG_TEXT_COMPRESSION_zTXt_WR, so it doesn't get written out again
938 * at the end.
939 */
940
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500941 /* Set up the transformations you want. Note that these are
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600942 * all optional. Only call them if you want them.
943 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500944
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500945 /* Invert monochrome pixels */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600946 png_set_invert_mono(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500947
Andreas Dilger47a0c421997-05-16 02:46:07 -0500948 /* Shift the pixels up to a legal bit depth and fill in
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600949 * as appropriate to correctly scale the image.
950 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500951 png_set_shift(png_ptr, &sig_bit);
Guy Schalnat0d580581995-07-20 02:43:20 -0500952
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500953 /* Pack pixels into bytes */
Guy Schalnat0d580581995-07-20 02:43:20 -0500954 png_set_packing(png_ptr);
955
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500956 /* Swap location of alpha bytes from ARGB to RGBA */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500957 png_set_swap_alpha(png_ptr);
958
959 /* Get rid of filler (OR ALPHA) bytes, pack XRGB/RGBX/ARGB/RGBA into
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600960 * RGB (4 channels -> 3 channels). The second parameter is not used.
961 */
Glenn Randers-Pehrson01a0e802015-09-24 22:39:53 -0500962 png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500963
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500964 /* Flip BGR pixels to RGB */
Guy Schalnat0d580581995-07-20 02:43:20 -0500965 png_set_bgr(png_ptr);
966
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500967 /* Swap bytes of 16-bit files to most significant byte first */
Guy Schalnat0d580581995-07-20 02:43:20 -0500968 png_set_swap(png_ptr);
969
Glenn Randers-Pehrson8b83ff32015-08-13 20:57:18 -0500970 /* Swap bits of 1-bit, 2-bit, 4-bit packed pixel formats */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500971 png_set_packswap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500972
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500973 /* Turn on interlace handling if you are not using png_write_image() */
Glenn Randers-Pehrson05670152014-03-08 12:39:52 -0600974 if (interlacing != 0)
Guy Schalnat0d580581995-07-20 02:43:20 -0500975 number_passes = png_set_interlace_handling(png_ptr);
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500976
Guy Schalnat0d580581995-07-20 02:43:20 -0500977 else
978 number_passes = 1;
979
Andreas Dilger47a0c421997-05-16 02:46:07 -0500980 /* The easiest way to write the image (you may have a different memory
981 * layout, however, so choose what fits your needs best). You need to
982 * use the first method if you aren't handling interlacing yourself.
983 */
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500984 png_uint_32 k, height, width;
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600985
986 /* In this example, "image" is a one-dimensional array of bytes */
Glenn Randers-Pehrson2eff8ef2017-04-22 15:30:52 -0500987
988 /* Guard against integer overflow */
989 if (height > PNG_SIZE_MAX/(width*bytes_per_pixel)) {
990 png_error(png_ptr, "Image_data buffer would be too large");
991 }
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600992 png_byte image[height*width*bytes_per_pixel];
993
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500994 png_bytep row_pointers[height];
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500995
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600996 if (height > PNG_UINT_32_MAX/(sizeof (png_bytep)))
Glenn Randers-Pehrson192e92d2016-07-13 14:43:42 -0500997 png_error (png_ptr, "Image is too tall to process in memory");
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -0500998
Glenn Randers-Pehrson871b1d02013-03-02 14:58:22 -0600999 /* Set up pointers into your "image" byte array */
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -05001000 for (k = 0; k < height; k++)
Glenn Randers-Pehrson192e92d2016-07-13 14:43:42 -05001001 row_pointers[k] = image + k*width*bytes_per_pixel;
Guy Schalnate5a37791996-06-05 15:50:50 -05001002
Andreas Dilger47a0c421997-05-16 02:46:07 -05001003 /* One of the following output methods is REQUIRED */
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -05001004
1005#ifdef entire /* Write out the entire image data in one call */
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001006 png_write_image(png_ptr, row_pointers);
1007
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -05001008 /* The other way to write the image - deal with interlacing */
Guy Schalnat51f0eb41995-09-26 05:22:39 -05001009
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -05001010#else no_entire /* Write out the image data by one or more scanlines */
1011
Andreas Dilger47a0c421997-05-16 02:46:07 -05001012 /* The number of passes is either 1 for non-interlaced images,
1013 * or 7 for interlaced images.
1014 */
Guy Schalnat0d580581995-07-20 02:43:20 -05001015 for (pass = 0; pass < number_passes; pass++)
1016 {
1017 /* Write a few rows at a time. */
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -05001018 png_write_rows(png_ptr, &row_pointers[first_row], number_of_rows);
Guy Schalnat0d580581995-07-20 02:43:20 -05001019
1020 /* If you are only writing one row at a time, this works */
1021 for (y = 0; y < height; y++)
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -05001022 png_write_rows(png_ptr, &row_pointers[y], 1);
Guy Schalnat0d580581995-07-20 02:43:20 -05001023 }
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -05001024#endif no_entire /* Use only one output method */
Guy Schalnat0d580581995-07-20 02:43:20 -05001025
Andreas Dilger47a0c421997-05-16 02:46:07 -05001026 /* You can write optional chunks like tEXt, zTXt, and tIME at the end
Glenn Randers-Pehrsonf0a8fe02009-04-14 08:28:15 -05001027 * as well. Shouldn't be necessary in 1.2.0 and up as all the public
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06001028 * chunks are supported and you can use png_set_unknown_chunks() to
1029 * register unknown chunks into the info structure to be written out.
Guy Schalnate5a37791996-06-05 15:50:50 -05001030 */
1031
Andreas Dilger47a0c421997-05-16 02:46:07 -05001032 /* It is REQUIRED to call this to finish writing the rest of the file */
Guy Schalnat0d580581995-07-20 02:43:20 -05001033 png_write_end(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06001034#endif hilevel
Guy Schalnat0d580581995-07-20 02:43:20 -05001035
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001036 /* If you png_malloced a palette, free it here (don't free info_ptr->palette,
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -05001037 * as recommended in versions 1.0.5m and earlier of this example; if
1038 * libpng mallocs info_ptr->palette, libpng will free it). If you
1039 * allocated it with malloc() instead of png_malloc(), use free() instead
1040 * of png_free().
1041 */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001042 png_free(png_ptr, palette);
Glenn Randers-Pehrson895a9c92008-07-25 08:51:18 -05001043 palette = NULL;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001044
1045 /* Similarly, if you png_malloced any data that you passed in with
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -05001046 * png_set_something(), such as a hist or trans array, free it here,
1047 * when you can be sure that libpng is through with it.
1048 */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001049 png_free(png_ptr, trans);
Glenn Randers-Pehrson895a9c92008-07-25 08:51:18 -05001050 trans = NULL;
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -05001051 /* Whenever you use png_free() it is a good idea to set the pointer to
1052 * NULL in case your application inadvertently tries to png_free() it
1053 * again. When png_free() sees a NULL it returns without action, thus
1054 * avoiding the double-free security problem.
1055 */
Guy Schalnat0d580581995-07-20 02:43:20 -05001056
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -05001057 /* Clean up after the write, and free any memory allocated */
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -05001058 png_destroy_write_struct(&png_ptr, &info_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -05001059
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -05001060 /* Close the file */
Guy Schalnat0d580581995-07-20 02:43:20 -05001061 fclose(fp);
1062
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -05001063 /* That's it */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -05001064 return (OK);
Guy Schalnat0d580581995-07-20 02:43:20 -05001065}
1066
Glenn Randers-Pehrson860ab2b1999-10-14 07:43:10 -05001067#endif /* if 0 */