]> rtime.felk.cvut.cz Git - l4.git/blob - l4/pkg/libpng/lib/dist/example.c
update
[l4.git] / l4 / pkg / libpng / lib / dist / example.c
1
2 #if 0 /* in case someone actually tries to compile this */
3
4 /* example.c - an example of using libpng
5  * Last changed in libpng 1.5.2 [March 31, 2011]
6  * This file has been placed in the public domain by the authors.
7  * Maintained 1998-2011 Glenn Randers-Pehrson
8  * Maintained 1996, 1997 Andreas Dilger)
9  * Written 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
10  */
11
12 /* This is an example of how to use libpng to read and write PNG files.
13  * The file libpng-manual.txt is much more verbose then this.  If you have not
14  * read it, do so first.  This was designed to be a starting point of an
15  * implementation.  This is not officially part of libpng, is hereby placed
16  * in the public domain, and therefore does not require a copyright notice.
17  *
18  * This file does not currently compile, because it is missing certain
19  * parts, like allocating memory to hold an image.  You will have to
20  * supply these parts to get it to compile.  For an example of a minimal
21  * working PNG reader/writer, see pngtest.c, included in this distribution;
22  * see also the programs in the contrib directory.
23  */
24
25 #include "png.h"
26
27  /* The png_jmpbuf() macro, used in error handling, became available in
28   * libpng version 1.0.6.  If you want to be able to run your code with older
29   * versions of libpng, you must define the macro yourself (but only if it
30   * is not already defined by libpng!).
31   */
32
33 #ifndef png_jmpbuf
34 #  define png_jmpbuf(png_ptr) ((png_ptr)->png_jmpbuf)
35 #endif
36
37 /* Check to see if a file is a PNG file using png_sig_cmp().  png_sig_cmp()
38  * returns zero if the image is a PNG and nonzero if it isn't a PNG.
39  *
40  * The function check_if_png() shown here, but not used, returns nonzero (true)
41  * if the file can be opened and is a PNG, 0 (false) otherwise.
42  *
43  * If this call is successful, and you are going to keep the file open,
44  * you should call png_set_sig_bytes(png_ptr, PNG_BYTES_TO_CHECK); once
45  * you have created the png_ptr, so that libpng knows your application
46  * has read that many bytes from the start of the file.  Make sure you
47  * don't call png_set_sig_bytes() with more than 8 bytes read or give it
48  * an incorrect number of bytes read, or you will either have read too
49  * many bytes (your fault), or you are telling libpng to read the wrong
50  * number of magic bytes (also your fault).
51  *
52  * Many applications already read the first 2 or 4 bytes from the start
53  * of the image to determine the file type, so it would be easiest just
54  * to pass the bytes to png_sig_cmp() or even skip that if you know
55  * you have a PNG file, and call png_set_sig_bytes().
56  */
57 #define PNG_BYTES_TO_CHECK 4
58 int check_if_png(char *file_name, FILE **fp)
59 {
60    char buf[PNG_BYTES_TO_CHECK];
61
62    /* Open the prospective PNG file. */
63    if ((*fp = fopen(file_name, "rb")) == NULL)
64       return 0;
65
66    /* Read in some of the signature bytes */
67    if (fread(buf, 1, PNG_BYTES_TO_CHECK, *fp) != PNG_BYTES_TO_CHECK)
68       return 0;
69
70    /* Compare the first PNG_BYTES_TO_CHECK bytes of the signature.
71       Return nonzero (true) if they match */
72
73    return(!png_sig_cmp(buf, (png_size_t)0, PNG_BYTES_TO_CHECK));
74 }
75
76 /* Read a PNG file.  You may want to return an error code if the read
77  * fails (depending upon the failure).  There are two "prototypes" given
78  * here - one where we are given the filename, and we need to open the
79  * file, and the other where we are given an open file (possibly with
80  * some or all of the magic bytes read - see comments above).
81  */
82 #ifdef open_file /* prototype 1 */
83 void read_png(char *file_name)  /* We need to open the file */
84 {
85    png_structp png_ptr;
86    png_infop info_ptr;
87    unsigned int sig_read = 0;
88    png_uint_32 width, height;
89    int bit_depth, color_type, interlace_type;
90    FILE *fp;
91
92    if ((fp = fopen(file_name, "rb")) == NULL)
93       return (ERROR);
94
95 #else no_open_file /* prototype 2 */
96 void read_png(FILE *fp, unsigned int sig_read)  /* File is already open */
97 {
98    png_structp png_ptr;
99    png_infop info_ptr;
100    png_uint_32 width, height;
101    int bit_depth, color_type, interlace_type;
102 #endif no_open_file /* Only use one prototype! */
103
104    /* Create and initialize the png_struct with the desired error handler
105     * functions.  If you want to use the default stderr and longjump method,
106     * you can supply NULL for the last three parameters.  We also supply the
107     * the compiler header file version, so that we know if the application
108     * was compiled with a compatible version of the library.  REQUIRED
109     */
110    png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
111       png_voidp user_error_ptr, user_error_fn, user_warning_fn);
112
113    if (png_ptr == NULL)
114    {
115       fclose(fp);
116       return (ERROR);
117    }
118
119    /* Allocate/initialize the memory for image information.  REQUIRED. */
120    info_ptr = png_create_info_struct(png_ptr);
121    if (info_ptr == NULL)
122    {
123       fclose(fp);
124       png_destroy_read_struct(&png_ptr, NULL, NULL);
125       return (ERROR);
126    }
127
128    /* Set error handling if you are using the setjmp/longjmp method (this is
129     * the normal method of doing things with libpng).  REQUIRED unless you
130     * set up your own error handlers in the png_create_read_struct() earlier.
131     */
132
133    if (setjmp(png_jmpbuf(png_ptr)))
134    {
135       /* Free all of the memory associated with the png_ptr and info_ptr */
136       png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
137       fclose(fp);
138       /* If we get here, we had a problem reading the file */
139       return (ERROR);
140    }
141
142    /* One of the following I/O initialization methods is REQUIRED */
143 #ifdef streams /* PNG file I/O method 1 */
144    /* Set up the input control if you are using standard C streams */
145    png_init_io(png_ptr, fp);
146
147 #else no_streams /* PNG file I/O method 2 */
148    /* If you are using replacement read functions, instead of calling
149     * png_init_io() here you would call:
150     */
151    png_set_read_fn(png_ptr, (void *)user_io_ptr, user_read_fn);
152    /* where user_io_ptr is a structure you want available to the callbacks */
153 #endif no_streams /* Use only one I/O method! */
154
155    /* If we have already read some of the signature */
156    png_set_sig_bytes(png_ptr, sig_read);
157
158 #ifdef hilevel
159    /*
160     * If you have enough memory to read in the entire image at once,
161     * and you need to specify only transforms that can be controlled
162     * with one of the PNG_TRANSFORM_* bits (this presently excludes
163     * quantizing, filling, setting background, and doing gamma
164     * adjustment), then you can read the entire image (including
165     * pixels) into the info structure with this call:
166     */
167    png_read_png(png_ptr, info_ptr, png_transforms, NULL);
168
169 #else
170    /* OK, you're doing it the hard way, with the lower-level functions */
171
172    /* The call to png_read_info() gives us all of the information from the
173     * PNG file before the first IDAT (image data chunk).  REQUIRED
174     */
175    png_read_info(png_ptr, info_ptr);
176
177    png_get_IHDR(png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
178        &interlace_type, NULL, NULL);
179
180    /* Set up the data transformations you want.  Note that these are all
181     * optional.  Only call them if you want/need them.  Many of the
182     * transformations only work on specific types of images, and many
183     * are mutually exclusive.
184     */
185
186    /* Tell libpng to strip 16 bit/color files down to 8 bits/color */
187    png_set_strip_16(png_ptr);
188
189    /* Strip alpha bytes from the input data without combining with the
190     * background (not recommended).
191     */
192    png_set_strip_alpha(png_ptr);
193
194    /* Extract multiple pixels with bit depths of 1, 2, and 4 from a single
195     * byte into separate bytes (useful for paletted and grayscale images).
196     */
197    png_set_packing(png_ptr);
198
199    /* Change the order of packed pixels to least significant bit first
200     * (not useful if you are using png_set_packing). */
201    png_set_packswap(png_ptr);
202
203    /* Expand paletted colors into true RGB triplets */
204    if (color_type == PNG_COLOR_TYPE_PALETTE)
205       png_set_palette_to_rgb(png_ptr);
206
207    /* Expand grayscale images to the full 8 bits from 1, 2, or 4 bits/pixel */
208    if (color_type == PNG_COLOR_TYPE_GRAY && bit_depth < 8)
209       png_set_expand_gray_1_2_4_to_8(png_ptr);
210
211    /* Expand paletted or RGB images with transparency to full alpha channels
212     * so the data will be available as RGBA quartets.
213     */
214    if (png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS))
215       png_set_tRNS_to_alpha(png_ptr);
216
217    /* Set the background color to draw transparent and alpha images over.
218     * It is possible to set the red, green, and blue components directly
219     * for paletted images instead of supplying a palette index.  Note that
220     * even if the PNG file supplies a background, you are not required to
221     * use it - you should use the (solid) application background if it has one.
222     */
223
224    png_color_16 my_background, *image_background;
225
226    if (png_get_bKGD(png_ptr, info_ptr, &image_background))
227       png_set_background(png_ptr, image_background,
228                          PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
229    else
230       png_set_background(png_ptr, &my_background,
231                          PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
232
233    /* Some suggestions as to how to get a screen gamma value
234     *
235     * Note that screen gamma is the display_exponent, which includes
236     * the CRT_exponent and any correction for viewing conditions
237     */
238    if (/* We have a user-defined screen gamma value */)
239    {
240       screen_gamma = user-defined screen_gamma;
241    }
242    /* This is one way that applications share the same screen gamma value */
243    else if ((gamma_str = getenv("SCREEN_GAMMA")) != NULL)
244    {
245       screen_gamma = atof(gamma_str);
246    }
247    /* If we don't have another value */
248    else
249    {
250       screen_gamma = 2.2;  /* A good guess for a PC monitor in a dimly
251                               lit room */
252       screen_gamma = 1.7 or 1.0;  /* A good guess for Mac systems */
253    }
254
255    /* Tell libpng to handle the gamma conversion for you.  The final call
256     * is a good guess for PC generated images, but it should be configurable
257     * by the user at run time by the user.  It is strongly suggested that
258     * your application support gamma correction.
259     */
260
261    int intent;
262
263    if (png_get_sRGB(png_ptr, info_ptr, &intent))
264       png_set_gamma(png_ptr, screen_gamma, 0.45455);
265    else
266    {
267       double image_gamma;
268       if (png_get_gAMA(png_ptr, info_ptr, &image_gamma))
269          png_set_gamma(png_ptr, screen_gamma, image_gamma);
270       else
271          png_set_gamma(png_ptr, screen_gamma, 0.45455);
272    }
273
274 #ifdef PNG_READ_QUANTIZE_SUPPORTED
275    /* Quantize RGB files down to 8 bit palette or reduce palettes
276     * to the number of colors available on your screen.
277     */
278    if (color_type & PNG_COLOR_MASK_COLOR)
279    {
280       int num_palette;
281       png_colorp palette;
282
283       /* This reduces the image to the application supplied palette */
284       if (/* We have our own palette */)
285       {
286          /* An array of colors to which the image should be quantized */
287          png_color std_color_cube[MAX_SCREEN_COLORS];
288
289          png_set_quantize(png_ptr, std_color_cube, MAX_SCREEN_COLORS,
290             MAX_SCREEN_COLORS, NULL, 0);
291       }
292       /* This reduces the image to the palette supplied in the file */
293       else if (png_get_PLTE(png_ptr, info_ptr, &palette, &num_palette))
294       {
295          png_uint_16p histogram = NULL;
296
297          png_get_hIST(png_ptr, info_ptr, &histogram);
298
299          png_set_quantize(png_ptr, palette, num_palette,
300                         max_screen_colors, histogram, 0);
301       }
302    }
303 #endif /* PNG_READ_QUANTIZE_SUPPORTED */
304
305    /* Invert monochrome files to have 0 as white and 1 as black */
306    png_set_invert_mono(png_ptr);
307
308    /* If you want to shift the pixel values from the range [0,255] or
309     * [0,65535] to the original [0,7] or [0,31], or whatever range the
310     * colors were originally in:
311     */
312    if (png_get_valid(png_ptr, info_ptr, PNG_INFO_sBIT))
313    {
314       png_color_8p sig_bit_p;
315
316       png_get_sBIT(png_ptr, info_ptr, &sig_bit_p);
317       png_set_shift(png_ptr, sig_bit_p);
318    }
319
320    /* Flip the RGB pixels to BGR (or RGBA to BGRA) */
321    if (color_type & PNG_COLOR_MASK_COLOR)
322       png_set_bgr(png_ptr);
323
324    /* Swap the RGBA or GA data to ARGB or AG (or BGRA to ABGR) */
325    png_set_swap_alpha(png_ptr);
326
327    /* Swap bytes of 16 bit files to least significant byte first */
328    png_set_swap(png_ptr);
329
330    /* Add filler (or alpha) byte (before/after each RGB triplet) */
331    png_set_filler(png_ptr, 0xff, PNG_FILLER_AFTER);
332
333    /* Turn on interlace handling.  REQUIRED if you are not using
334     * png_read_image().  To see how to handle interlacing passes,
335     * see the png_read_row() method below:
336     */
337    number_passes = png_set_interlace_handling(png_ptr);
338
339    /* Optional call to gamma correct and add the background to the palette
340     * and update info structure.  REQUIRED if you are expecting libpng to
341     * update the palette for you (ie you selected such a transform above).
342     */
343    png_read_update_info(png_ptr, info_ptr);
344
345    /* Allocate the memory to hold the image using the fields of info_ptr. */
346
347    /* The easiest way to read the image: */
348    png_bytep row_pointers[height];
349
350    /* Clear the pointer array */
351    for (row = 0; row < height; row++)
352       row_pointers[row] = NULL;
353
354    for (row = 0; row < height; row++)
355       row_pointers[row] = png_malloc(png_ptr, png_get_rowbytes(png_ptr,
356          info_ptr));
357
358    /* Now it's time to read the image.  One of these methods is REQUIRED */
359 #ifdef entire /* Read the entire image in one go */
360    png_read_image(png_ptr, row_pointers);
361
362 #else no_entire /* Read the image one or more scanlines at a time */
363    /* The other way to read images - deal with interlacing: */
364
365    for (pass = 0; pass < number_passes; pass++)
366    {
367 #ifdef single /* Read the image a single row at a time */
368       for (y = 0; y < height; y++)
369       {
370          png_read_rows(png_ptr, &row_pointers[y], NULL, 1);
371       }
372
373 #else no_single /* Read the image several rows at a time */
374       for (y = 0; y < height; y += number_of_rows)
375       {
376 #ifdef sparkle /* Read the image using the "sparkle" effect. */
377          png_read_rows(png_ptr, &row_pointers[y], NULL,
378             number_of_rows);
379 #else no_sparkle /* Read the image using the "rectangle" effect */
380          png_read_rows(png_ptr, NULL, &row_pointers[y],
381             number_of_rows);
382 #endif no_sparkle /* Use only one of these two methods */
383       }
384
385       /* If you want to display the image after every pass, do so here */
386 #endif no_single /* Use only one of these two methods */
387    }
388 #endif no_entire /* Use only one of these two methods */
389
390    /* Read rest of file, and get additional chunks in info_ptr - REQUIRED */
391    png_read_end(png_ptr, info_ptr);
392 #endif hilevel
393
394    /* At this point you have read the entire image */
395
396    /* Clean up after the read, and free any memory allocated - REQUIRED */
397    png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
398
399    /* Close the file */
400    fclose(fp);
401
402    /* That's it */
403    return (OK);
404 }
405
406 /* Progressively read a file */
407
408 int
409 initialize_png_reader(png_structp *png_ptr, png_infop *info_ptr)
410 {
411    /* Create and initialize the png_struct with the desired error handler
412     * functions.  If you want to use the default stderr and longjump method,
413     * you can supply NULL for the last three parameters.  We also check that
414     * the library version is compatible in case we are using dynamically
415     * linked libraries.
416     */
417    *png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
418        png_voidp user_error_ptr, user_error_fn, user_warning_fn);
419
420    if (*png_ptr == NULL)
421    {
422       *info_ptr = NULL;
423       return (ERROR);
424    }
425
426    *info_ptr = png_create_info_struct(png_ptr);
427
428    if (*info_ptr == NULL)
429    {
430       png_destroy_read_struct(png_ptr, info_ptr, NULL);
431       return (ERROR);
432    }
433
434    if (setjmp(png_jmpbuf((*png_ptr))))
435    {
436       png_destroy_read_struct(png_ptr, info_ptr, NULL);
437       return (ERROR);
438    }
439
440    /* This one's new.  You will need to provide all three
441     * function callbacks, even if you aren't using them all.
442     * If you aren't using all functions, you can specify NULL
443     * parameters.  Even when all three functions are NULL,
444     * you need to call png_set_progressive_read_fn().
445     * These functions shouldn't be dependent on global or
446     * static variables if you are decoding several images
447     * simultaneously.  You should store stream specific data
448     * in a separate struct, given as the second parameter,
449     * and retrieve the pointer from inside the callbacks using
450     * the function png_get_progressive_ptr(png_ptr).
451     */
452    png_set_progressive_read_fn(*png_ptr, (void *)stream_data,
453       info_callback, row_callback, end_callback);
454
455    return (OK);
456 }
457
458 int
459 process_data(png_structp *png_ptr, png_infop *info_ptr,
460    png_bytep buffer, png_uint_32 length)
461 {
462    if (setjmp(png_jmpbuf((*png_ptr))))
463    {
464       /* Free the png_ptr and info_ptr memory on error */
465       png_destroy_read_struct(png_ptr, info_ptr, NULL);
466       return (ERROR);
467    }
468
469    /* This one's new also.  Simply give it chunks of data as
470     * they arrive from the data stream (in order, of course).
471     * On segmented machines, don't give it any more than 64K.
472     * The library seems to run fine with sizes of 4K, although
473     * you can give it much less if necessary (I assume you can
474     * give it chunks of 1 byte, but I haven't tried with less
475     * than 256 bytes yet).  When this function returns, you may
476     * want to display any rows that were generated in the row
477     * callback, if you aren't already displaying them there.
478     */
479    png_process_data(*png_ptr, *info_ptr, buffer, length);
480    return (OK);
481 }
482
483 info_callback(png_structp png_ptr, png_infop info)
484 {
485    /* Do any setup here, including setting any of the transformations
486     * mentioned in the Reading PNG files section.  For now, you _must_
487     * call either png_start_read_image() or png_read_update_info()
488     * after all the transformations are set (even if you don't set
489     * any).  You may start getting rows before png_process_data()
490     * returns, so this is your last chance to prepare for that.
491     */
492 }
493
494 row_callback(png_structp png_ptr, png_bytep new_row,
495    png_uint_32 row_num, int pass)
496 {
497    /*
498     * This function is called for every row in the image.  If the
499     * image is interlaced, and you turned on the interlace handler,
500     * this function will be called for every row in every pass.
501     *
502     * In this function you will receive a pointer to new row data from
503     * libpng called new_row that is to replace a corresponding row (of
504     * the same data format) in a buffer allocated by your application.
505     *
506     * The new row data pointer "new_row" may be NULL, indicating there is
507     * no new data to be replaced (in cases of interlace loading).
508     *
509     * If new_row is not NULL then you need to call
510     * png_progressive_combine_row() to replace the corresponding row as
511     * shown below:
512     */
513
514    /* Get pointer to corresponding row in our
515     * PNG read buffer.
516     */
517    png_bytep old_row = ((png_bytep *)our_data)[row_num];
518
519    /* If both rows are allocated then copy the new row
520     * data to the corresponding row data.
521     */
522    if ((old_row != NULL) && (new_row != NULL))
523    png_progressive_combine_row(png_ptr, old_row, new_row);
524
525    /*
526     * The rows and passes are called in order, so you don't really
527     * need the row_num and pass, but I'm supplying them because it
528     * may make your life easier.
529     *
530     * For the non-NULL rows of interlaced images, you must call
531     * png_progressive_combine_row() passing in the new row and the
532     * old row, as demonstrated above.  You can call this function for
533     * NULL rows (it will just return) and for non-interlaced images
534     * (it just does the png_memcpy for you) if it will make the code
535     * easier.  Thus, you can just do this for all cases:
536     */
537
538    png_progressive_combine_row(png_ptr, old_row, new_row);
539
540    /* where old_row is what was displayed for previous rows.  Note
541     * that the first pass (pass == 0 really) will completely cover
542     * the old row, so the rows do not have to be initialized.  After
543     * the first pass (and only for interlaced images), you will have
544     * to pass the current row as new_row, and the function will combine
545     * the old row and the new row.
546     */
547 }
548
549 end_callback(png_structp png_ptr, png_infop info)
550 {
551    /* This function is called when the whole image has been read,
552     * including any chunks after the image (up to and including
553     * the IEND).  You will usually have the same info chunk as you
554     * had in the header, although some data may have been added
555     * to the comments and time fields.
556     *
557     * Most people won't do much here, perhaps setting a flag that
558     * marks the image as finished.
559     */
560 }
561
562 /* Write a png file */
563 void write_png(char *file_name /* , ... other image information ... */)
564 {
565    FILE *fp;
566    png_structp png_ptr;
567    png_infop info_ptr;
568    png_colorp palette;
569
570    /* Open the file */
571    fp = fopen(file_name, "wb");
572    if (fp == NULL)
573       return (ERROR);
574
575    /* Create and initialize the png_struct with the desired error handler
576     * functions.  If you want to use the default stderr and longjump method,
577     * you can supply NULL for the last three parameters.  We also check that
578     * the library version is compatible with the one used at compile time,
579     * in case we are using dynamically linked libraries.  REQUIRED.
580     */
581    png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING,
582       png_voidp user_error_ptr, user_error_fn, user_warning_fn);
583
584    if (png_ptr == NULL)
585    {
586       fclose(fp);
587       return (ERROR);
588    }
589
590    /* Allocate/initialize the image information data.  REQUIRED */
591    info_ptr = png_create_info_struct(png_ptr);
592    if (info_ptr == NULL)
593    {
594       fclose(fp);
595       png_destroy_write_struct(&png_ptr,  NULL);
596       return (ERROR);
597    }
598
599    /* Set error handling.  REQUIRED if you aren't supplying your own
600     * error handling functions in the png_create_write_struct() call.
601     */
602    if (setjmp(png_jmpbuf(png_ptr)))
603    {
604       /* If we get here, we had a problem writing the file */
605       fclose(fp);
606       png_destroy_write_struct(&png_ptr, &info_ptr);
607       return (ERROR);
608    }
609
610    /* One of the following I/O initialization functions is REQUIRED */
611
612 #ifdef streams /* I/O initialization method 1 */
613    /* Set up the output control if you are using standard C streams */
614    png_init_io(png_ptr, fp);
615
616 #else no_streams /* I/O initialization method 2 */
617    /* If you are using replacement write functions, instead of calling
618     * png_init_io() here you would call
619     */
620    png_set_write_fn(png_ptr, (void *)user_io_ptr, user_write_fn,
621       user_IO_flush_function);
622    /* where user_io_ptr is a structure you want available to the callbacks */
623 #endif no_streams /* Only use one initialization method */
624
625 #ifdef hilevel
626    /* This is the easy way.  Use it if you already have all the
627     * image info living in the structure.  You could "|" many
628     * PNG_TRANSFORM flags into the png_transforms integer here.
629     */
630    png_write_png(png_ptr, info_ptr, png_transforms, NULL);
631
632 #else
633    /* This is the hard way */
634
635    /* Set the image information here.  Width and height are up to 2^31,
636     * bit_depth is one of 1, 2, 4, 8, or 16, but valid values also depend on
637     * the color_type selected. color_type is one of PNG_COLOR_TYPE_GRAY,
638     * PNG_COLOR_TYPE_GRAY_ALPHA, PNG_COLOR_TYPE_PALETTE, PNG_COLOR_TYPE_RGB,
639     * or PNG_COLOR_TYPE_RGB_ALPHA.  interlace is either PNG_INTERLACE_NONE or
640     * PNG_INTERLACE_ADAM7, and the compression_type and filter_type MUST
641     * currently be PNG_COMPRESSION_TYPE_BASE and PNG_FILTER_TYPE_BASE. REQUIRED
642     */
643    png_set_IHDR(png_ptr, info_ptr, width, height, bit_depth, PNG_COLOR_TYPE_???,
644       PNG_INTERLACE_????, PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
645
646    /* Set the palette if there is one.  REQUIRED for indexed-color images */
647    palette = (png_colorp)png_malloc(png_ptr, PNG_MAX_PALETTE_LENGTH
648              * png_sizeof(png_color));
649    /* ... Set palette colors ... */
650    png_set_PLTE(png_ptr, info_ptr, palette, PNG_MAX_PALETTE_LENGTH);
651    /* You must not free palette here, because png_set_PLTE only makes a link to
652     * the palette that you malloced.  Wait until you are about to destroy
653     * the png structure.
654     */
655
656    /* Optional significant bit (sBIT) chunk */
657    png_color_8 sig_bit;
658
659    /* If we are dealing with a grayscale image then */
660    sig_bit.gray = true_bit_depth;
661
662    /* Otherwise, if we are dealing with a color image then */
663    sig_bit.red = true_red_bit_depth;
664    sig_bit.green = true_green_bit_depth;
665    sig_bit.blue = true_blue_bit_depth;
666
667    /* If the image has an alpha channel then */
668    sig_bit.alpha = true_alpha_bit_depth;
669
670    png_set_sBIT(png_ptr, info_ptr, &sig_bit);
671
672
673    /* Optional gamma chunk is strongly suggested if you have any guess
674     * as to the correct gamma of the image.
675     */
676    png_set_gAMA(png_ptr, info_ptr, gamma);
677
678    /* Optionally write comments into the image */
679    text_ptr[0].key = "Title";
680    text_ptr[0].text = "Mona Lisa";
681    text_ptr[0].compression = PNG_TEXT_COMPRESSION_NONE;
682    text_ptr[0].itxt_length = 0;
683    text_ptr[0].lang = NULL;
684    text_ptr[0].lang_key = NULL;
685    text_ptr[1].key = "Author";
686    text_ptr[1].text = "Leonardo DaVinci";
687    text_ptr[1].compression = PNG_TEXT_COMPRESSION_NONE;
688    text_ptr[1].itxt_length = 0;
689    text_ptr[1].lang = NULL;
690    text_ptr[1].lang_key = NULL;
691    text_ptr[2].key = "Description";
692    text_ptr[2].text = "<long text>";
693    text_ptr[2].compression = PNG_TEXT_COMPRESSION_zTXt;
694    text_ptr[2].itxt_length = 0;
695    text_ptr[2].lang = NULL;
696    text_ptr[2].lang_key = NULL;
697    png_set_text(png_ptr, info_ptr, text_ptr, 3);
698
699    /* Other optional chunks like cHRM, bKGD, tRNS, tIME, oFFs, pHYs */
700
701    /* Note that if sRGB is present the gAMA and cHRM chunks must be ignored
702     * on read and, if your application chooses to write them, they must
703     * be written in accordance with the sRGB profile
704     */
705
706    /* Write the file header information.  REQUIRED */
707    png_write_info(png_ptr, info_ptr);
708
709    /* If you want, you can write the info in two steps, in case you need to
710     * write your private chunk ahead of PLTE:
711     *
712     *   png_write_info_before_PLTE(write_ptr, write_info_ptr);
713     *   write_my_chunk();
714     *   png_write_info(png_ptr, info_ptr);
715     *
716     * However, given the level of known- and unknown-chunk support in 1.2.0
717     * and up, this should no longer be necessary.
718     */
719
720    /* Once we write out the header, the compression type on the text
721     * chunks gets changed to PNG_TEXT_COMPRESSION_NONE_WR or
722     * PNG_TEXT_COMPRESSION_zTXt_WR, so it doesn't get written out again
723     * at the end.
724     */
725
726    /* Set up the transformations you want.  Note that these are
727     * all optional.  Only call them if you want them.
728     */
729
730    /* Invert monochrome pixels */
731    png_set_invert_mono(png_ptr);
732
733    /* Shift the pixels up to a legal bit depth and fill in
734     * as appropriate to correctly scale the image.
735     */
736    png_set_shift(png_ptr, &sig_bit);
737
738    /* Pack pixels into bytes */
739    png_set_packing(png_ptr);
740
741    /* Swap location of alpha bytes from ARGB to RGBA */
742    png_set_swap_alpha(png_ptr);
743
744    /* Get rid of filler (OR ALPHA) bytes, pack XRGB/RGBX/ARGB/RGBA into
745     * RGB (4 channels -> 3 channels). The second parameter is not used.
746     */
747    png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);
748
749    /* Flip BGR pixels to RGB */
750    png_set_bgr(png_ptr);
751
752    /* Swap bytes of 16-bit files to most significant byte first */
753    png_set_swap(png_ptr);
754
755    /* Swap bits of 1, 2, 4 bit packed pixel formats */
756    png_set_packswap(png_ptr);
757
758    /* Turn on interlace handling if you are not using png_write_image() */
759    if (interlacing)
760       number_passes = png_set_interlace_handling(png_ptr);
761
762    else
763       number_passes = 1;
764
765    /* The easiest way to write the image (you may have a different memory
766     * layout, however, so choose what fits your needs best).  You need to
767     * use the first method if you aren't handling interlacing yourself.
768     */
769    png_uint_32 k, height, width;
770    png_byte image[height][width*bytes_per_pixel];
771    png_bytep row_pointers[height];
772
773    if (height > PNG_UINT_32_MAX/png_sizeof(png_bytep))
774      png_error (png_ptr, "Image is too tall to process in memory");
775
776    for (k = 0; k < height; k++)
777      row_pointers[k] = image + k*width*bytes_per_pixel;
778
779    /* One of the following output methods is REQUIRED */
780
781 #ifdef entire /* Write out the entire image data in one call */
782    png_write_image(png_ptr, row_pointers);
783
784    /* The other way to write the image - deal with interlacing */
785
786 #else no_entire /* Write out the image data by one or more scanlines */
787
788    /* The number of passes is either 1 for non-interlaced images,
789     * or 7 for interlaced images.
790     */
791    for (pass = 0; pass < number_passes; pass++)
792    {
793       /* Write a few rows at a time. */
794       png_write_rows(png_ptr, &row_pointers[first_row], number_of_rows);
795
796       /* If you are only writing one row at a time, this works */
797       for (y = 0; y < height; y++)
798          png_write_rows(png_ptr, &row_pointers[y], 1);
799    }
800 #endif no_entire /* Use only one output method */
801
802    /* You can write optional chunks like tEXt, zTXt, and tIME at the end
803     * as well.  Shouldn't be necessary in 1.2.0 and up as all the public
804     * chunks are supported and you can use png_set_unknown_chunks() to
805     * register unknown chunks into the info structure to be written out.
806     */
807
808    /* It is REQUIRED to call this to finish writing the rest of the file */
809    png_write_end(png_ptr, info_ptr);
810 #endif hilevel
811
812    /* If you png_malloced a palette, free it here (don't free info_ptr->palette,
813     * as recommended in versions 1.0.5m and earlier of this example; if
814     * libpng mallocs info_ptr->palette, libpng will free it).  If you
815     * allocated it with malloc() instead of png_malloc(), use free() instead
816     * of png_free().
817     */
818    png_free(png_ptr, palette);
819    palette = NULL;
820
821    /* Similarly, if you png_malloced any data that you passed in with
822     * png_set_something(), such as a hist or trans array, free it here,
823     * when you can be sure that libpng is through with it.
824     */
825    png_free(png_ptr, trans);
826    trans = NULL;
827    /* Whenever you use png_free() it is a good idea to set the pointer to
828     * NULL in case your application inadvertently tries to png_free() it
829     * again.  When png_free() sees a NULL it returns without action, thus
830     * avoiding the double-free security problem.
831     */
832
833    /* Clean up after the write, and free any memory allocated */
834    png_destroy_write_struct(&png_ptr, &info_ptr);
835
836    /* Close the file */
837    fclose(fp);
838
839    /* That's it */
840    return (OK);
841 }
842
843 #endif /* if 0 */