Blame contrib/gregbook/writepng.c

Packit 0ba690
/*---------------------------------------------------------------------------
Packit 0ba690
Packit 0ba690
   wpng - simple PNG-writing program                             writepng.c
Packit 0ba690
Packit 0ba690
  ---------------------------------------------------------------------------
Packit 0ba690
Packit 0ba690
      Copyright (c) 1998-2007 Greg Roelofs.  All rights reserved.
Packit 0ba690
Packit 0ba690
      This software is provided "as is," without warranty of any kind,
Packit 0ba690
      express or implied.  In no event shall the author or contributors
Packit 0ba690
      be held liable for any damages arising in any way from the use of
Packit 0ba690
      this software.
Packit 0ba690
Packit 0ba690
      The contents of this file are DUAL-LICENSED.  You may modify and/or
Packit 0ba690
      redistribute this software according to the terms of one of the
Packit 0ba690
      following two licenses (at your option):
Packit 0ba690
Packit 0ba690
Packit 0ba690
      LICENSE 1 ("BSD-like with advertising clause"):
Packit 0ba690
Packit 0ba690
      Permission is granted to anyone to use this software for any purpose,
Packit 0ba690
      including commercial applications, and to alter it and redistribute
Packit 0ba690
      it freely, subject to the following restrictions:
Packit 0ba690
Packit 0ba690
      1. Redistributions of source code must retain the above copyright
Packit 0ba690
         notice, disclaimer, and this list of conditions.
Packit 0ba690
      2. Redistributions in binary form must reproduce the above copyright
Packit 0ba690
         notice, disclaimer, and this list of conditions in the documenta-
Packit 0ba690
         tion and/or other materials provided with the distribution.
Packit 0ba690
      3. All advertising materials mentioning features or use of this
Packit 0ba690
         software must display the following acknowledgment:
Packit 0ba690
Packit 0ba690
            This product includes software developed by Greg Roelofs
Packit 0ba690
            and contributors for the book, "PNG: The Definitive Guide,"
Packit 0ba690
            published by O'Reilly and Associates.
Packit 0ba690
Packit 0ba690
Packit 0ba690
      LICENSE 2 (GNU GPL v2 or later):
Packit 0ba690
Packit 0ba690
      This program is free software; you can redistribute it and/or modify
Packit 0ba690
      it under the terms of the GNU General Public License as published by
Packit 0ba690
      the Free Software Foundation; either version 2 of the License, or
Packit 0ba690
      (at your option) any later version.
Packit 0ba690
Packit 0ba690
      This program is distributed in the hope that it will be useful,
Packit 0ba690
      but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 0ba690
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit 0ba690
      GNU General Public License for more details.
Packit 0ba690
Packit 0ba690
      You should have received a copy of the GNU General Public License
Packit 0ba690
      along with this program; if not, write to the Free Software Foundation,
Packit 0ba690
      Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
Packit 0ba690
Packit 0ba690
  ---------------------------------------------------------------------------*/
Packit 0ba690
Packit 0ba690
Packit 0ba690
#include <stdlib.h>     /* for exit() prototype */
Packit 0ba690
Packit 0ba690
#include "png.h"        /* libpng header; includes zlib.h and setjmp.h */
Packit 0ba690
#include "writepng.h"   /* typedefs, common macros, public prototypes */
Packit 0ba690
Packit 0ba690
Packit 0ba690
/* local prototype */
Packit 0ba690
Packit 0ba690
static void writepng_error_handler(png_structp png_ptr, png_const_charp msg);
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
void writepng_version_info(void)
Packit 0ba690
{
Packit 0ba690
  fprintf(stderr, "   Compiled with libpng %s; using libpng %s.\n",
Packit 0ba690
    PNG_LIBPNG_VER_STRING, png_libpng_ver);
Packit 0ba690
  fprintf(stderr, "   Compiled with zlib %s; using zlib %s.\n",
Packit 0ba690
    ZLIB_VERSION, zlib_version);
Packit 0ba690
}
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
/* returns 0 for success, 2 for libpng problem, 4 for out of memory, 11 for
Packit 0ba690
 *  unexpected pnmtype; note that outfile might be stdout */
Packit 0ba690
Packit 0ba690
int writepng_init(mainprog_info *mainprog_ptr)
Packit 0ba690
{
Packit 0ba690
    png_structp  png_ptr;       /* note:  temporary variables! */
Packit 0ba690
    png_infop  info_ptr;
Packit 0ba690
    int color_type, interlace_type;
Packit 0ba690
Packit 0ba690
Packit 0ba690
    /* could also replace libpng warning-handler (final NULL), but no need: */
Packit 0ba690
Packit 0ba690
    png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING, mainprog_ptr,
Packit 0ba690
      writepng_error_handler, NULL);
Packit 0ba690
    if (!png_ptr)
Packit 0ba690
        return 4;   /* out of memory */
Packit 0ba690
Packit 0ba690
    info_ptr = png_create_info_struct(png_ptr);
Packit 0ba690
    if (!info_ptr) {
Packit 0ba690
        png_destroy_write_struct(&png_ptr, NULL);
Packit 0ba690
        return 4;   /* out of memory */
Packit 0ba690
    }
Packit 0ba690
Packit 0ba690
Packit 0ba690
    /* setjmp() must be called in every function that calls a PNG-writing
Packit 0ba690
     * libpng function, unless an alternate error handler was installed--
Packit 0ba690
     * but compatible error handlers must either use longjmp() themselves
Packit 0ba690
     * (as in this program) or exit immediately, so here we go: */
Packit 0ba690
Packit 0ba690
    if (setjmp(mainprog_ptr->jmpbuf)) {
Packit 0ba690
        png_destroy_write_struct(&png_ptr, &info_ptr);
Packit 0ba690
        return 2;
Packit 0ba690
    }
Packit 0ba690
Packit 0ba690
Packit 0ba690
    /* make sure outfile is (re)opened in BINARY mode */
Packit 0ba690
Packit 0ba690
    png_init_io(png_ptr, mainprog_ptr->outfile);
Packit 0ba690
Packit 0ba690
Packit 0ba690
    /* set the compression levels--in general, always want to leave filtering
Packit 0ba690
     * turned on (except for palette images) and allow all of the filters,
Packit 0ba690
     * which is the default; want 32K zlib window, unless entire image buffer
Packit 0ba690
     * is 16K or smaller (unknown here)--also the default; usually want max
Packit 0ba690
     * compression (NOT the default); and remaining compression flags should
Packit 0ba690
     * be left alone */
Packit 0ba690
Packit 0ba690
    png_set_compression_level(png_ptr, Z_BEST_COMPRESSION);
Packit 0ba690
/*
Packit 0ba690
    >> this is default for no filtering; Z_FILTERED is default otherwise:
Packit 0ba690
    png_set_compression_strategy(png_ptr, Z_DEFAULT_STRATEGY);
Packit 0ba690
    >> these are all defaults:
Packit 0ba690
    png_set_compression_mem_level(png_ptr, 8);
Packit 0ba690
    png_set_compression_window_bits(png_ptr, 15);
Packit 0ba690
    png_set_compression_method(png_ptr, 8);
Packit 0ba690
 */
Packit 0ba690
Packit 0ba690
Packit 0ba690
    /* set the image parameters appropriately */
Packit 0ba690
Packit 0ba690
    if (mainprog_ptr->pnmtype == 5)
Packit 0ba690
        color_type = PNG_COLOR_TYPE_GRAY;
Packit 0ba690
    else if (mainprog_ptr->pnmtype == 6)
Packit 0ba690
        color_type = PNG_COLOR_TYPE_RGB;
Packit 0ba690
    else if (mainprog_ptr->pnmtype == 8)
Packit 0ba690
        color_type = PNG_COLOR_TYPE_RGB_ALPHA;
Packit 0ba690
    else {
Packit 0ba690
        png_destroy_write_struct(&png_ptr, &info_ptr);
Packit 0ba690
        return 11;
Packit 0ba690
    }
Packit 0ba690
Packit 0ba690
    interlace_type = mainprog_ptr->interlaced? PNG_INTERLACE_ADAM7 :
Packit 0ba690
                                               PNG_INTERLACE_NONE;
Packit 0ba690
Packit 0ba690
    png_set_IHDR(png_ptr, info_ptr, mainprog_ptr->width, mainprog_ptr->height,
Packit 0ba690
      mainprog_ptr->sample_depth, color_type, interlace_type,
Packit 0ba690
      PNG_COMPRESSION_TYPE_DEFAULT, PNG_FILTER_TYPE_DEFAULT);
Packit 0ba690
Packit 0ba690
    if (mainprog_ptr->gamma > 0.0)
Packit 0ba690
        png_set_gAMA(png_ptr, info_ptr, mainprog_ptr->gamma);
Packit 0ba690
Packit 0ba690
    if (mainprog_ptr->have_bg) {   /* we know it's RGBA, not gray+alpha */
Packit 0ba690
        png_color_16  background;
Packit 0ba690
Packit 0ba690
        background.red = mainprog_ptr->bg_red;
Packit 0ba690
        background.green = mainprog_ptr->bg_green;
Packit 0ba690
        background.blue = mainprog_ptr->bg_blue;
Packit 0ba690
        png_set_bKGD(png_ptr, info_ptr, &background);
Packit 0ba690
    }
Packit 0ba690
Packit 0ba690
    if (mainprog_ptr->have_time) {
Packit 0ba690
        png_time  modtime;
Packit 0ba690
Packit 0ba690
        png_convert_from_time_t(&modtime, mainprog_ptr->modtime);
Packit 0ba690
        png_set_tIME(png_ptr, info_ptr, &modtime);
Packit 0ba690
    }
Packit 0ba690
Packit 0ba690
    if (mainprog_ptr->have_text) {
Packit 0ba690
        png_text  text[6];
Packit 0ba690
        int  num_text = 0;
Packit 0ba690
Packit 0ba690
        if (mainprog_ptr->have_text & TEXT_TITLE) {
Packit 0ba690
            text[num_text].compression = PNG_TEXT_COMPRESSION_NONE;
Packit 0ba690
            text[num_text].key = "Title";
Packit 0ba690
            text[num_text].text = mainprog_ptr->title;
Packit 0ba690
            ++num_text;
Packit 0ba690
        }
Packit 0ba690
        if (mainprog_ptr->have_text & TEXT_AUTHOR) {
Packit 0ba690
            text[num_text].compression = PNG_TEXT_COMPRESSION_NONE;
Packit 0ba690
            text[num_text].key = "Author";
Packit 0ba690
            text[num_text].text = mainprog_ptr->author;
Packit 0ba690
            ++num_text;
Packit 0ba690
        }
Packit 0ba690
        if (mainprog_ptr->have_text & TEXT_DESC) {
Packit 0ba690
            text[num_text].compression = PNG_TEXT_COMPRESSION_NONE;
Packit 0ba690
            text[num_text].key = "Description";
Packit 0ba690
            text[num_text].text = mainprog_ptr->desc;
Packit 0ba690
            ++num_text;
Packit 0ba690
        }
Packit 0ba690
        if (mainprog_ptr->have_text & TEXT_COPY) {
Packit 0ba690
            text[num_text].compression = PNG_TEXT_COMPRESSION_NONE;
Packit 0ba690
            text[num_text].key = "Copyright";
Packit 0ba690
            text[num_text].text = mainprog_ptr->copyright;
Packit 0ba690
            ++num_text;
Packit 0ba690
        }
Packit 0ba690
        if (mainprog_ptr->have_text & TEXT_EMAIL) {
Packit 0ba690
            text[num_text].compression = PNG_TEXT_COMPRESSION_NONE;
Packit 0ba690
            text[num_text].key = "E-mail";
Packit 0ba690
            text[num_text].text = mainprog_ptr->email;
Packit 0ba690
            ++num_text;
Packit 0ba690
        }
Packit 0ba690
        if (mainprog_ptr->have_text & TEXT_URL) {
Packit 0ba690
            text[num_text].compression = PNG_TEXT_COMPRESSION_NONE;
Packit 0ba690
            text[num_text].key = "URL";
Packit 0ba690
            text[num_text].text = mainprog_ptr->url;
Packit 0ba690
            ++num_text;
Packit 0ba690
        }
Packit 0ba690
        png_set_text(png_ptr, info_ptr, text, num_text);
Packit 0ba690
    }
Packit 0ba690
Packit 0ba690
Packit 0ba690
    /* write all chunks up to (but not including) first IDAT */
Packit 0ba690
Packit 0ba690
    png_write_info(png_ptr, info_ptr);
Packit 0ba690
Packit 0ba690
Packit 0ba690
    /* if we wanted to write any more text info *after* the image data, we
Packit 0ba690
     * would set up text struct(s) here and call png_set_text() again, with
Packit 0ba690
     * just the new data; png_set_tIME() could also go here, but it would
Packit 0ba690
     * have no effect since we already called it above (only one tIME chunk
Packit 0ba690
     * allowed) */
Packit 0ba690
Packit 0ba690
Packit 0ba690
    /* set up the transformations:  for now, just pack low-bit-depth pixels
Packit 0ba690
     * into bytes (one, two or four pixels per byte) */
Packit 0ba690
Packit 0ba690
    png_set_packing(png_ptr);
Packit 0ba690
/*  png_set_shift(png_ptr, &sig_bit);  to scale low-bit-depth values */
Packit 0ba690
Packit 0ba690
Packit 0ba690
    /* make sure we save our pointers for use in writepng_encode_image() */
Packit 0ba690
Packit 0ba690
    mainprog_ptr->png_ptr = png_ptr;
Packit 0ba690
    mainprog_ptr->info_ptr = info_ptr;
Packit 0ba690
Packit 0ba690
Packit 0ba690
    /* OK, that's all we need to do for now; return happy */
Packit 0ba690
Packit 0ba690
    return 0;
Packit 0ba690
}
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
/* returns 0 for success, 2 for libpng (longjmp) problem */
Packit 0ba690
Packit 0ba690
int writepng_encode_image(mainprog_info *mainprog_ptr)
Packit 0ba690
{
Packit 0ba690
    png_structp png_ptr = (png_structp)mainprog_ptr->png_ptr;
Packit 0ba690
    png_infop info_ptr = (png_infop)mainprog_ptr->info_ptr;
Packit 0ba690
Packit 0ba690
Packit 0ba690
    /* as always, setjmp() must be called in every function that calls a
Packit 0ba690
     * PNG-writing libpng function */
Packit 0ba690
Packit 0ba690
    if (setjmp(mainprog_ptr->jmpbuf)) {
Packit 0ba690
        png_destroy_write_struct(&png_ptr, &info_ptr);
Packit 0ba690
        mainprog_ptr->png_ptr = NULL;
Packit 0ba690
        mainprog_ptr->info_ptr = NULL;
Packit 0ba690
        return 2;
Packit 0ba690
    }
Packit 0ba690
Packit 0ba690
Packit 0ba690
    /* and now we just write the whole image; libpng takes care of interlacing
Packit 0ba690
     * for us */
Packit 0ba690
Packit 0ba690
    png_write_image(png_ptr, mainprog_ptr->row_pointers);
Packit 0ba690
Packit 0ba690
Packit 0ba690
    /* since that's it, we also close out the end of the PNG file now--if we
Packit 0ba690
     * had any text or time info to write after the IDATs, second argument
Packit 0ba690
     * would be info_ptr, but we optimize slightly by sending NULL pointer: */
Packit 0ba690
Packit 0ba690
    png_write_end(png_ptr, NULL);
Packit 0ba690
Packit 0ba690
    return 0;
Packit 0ba690
}
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
/* returns 0 if succeeds, 2 if libpng problem */
Packit 0ba690
Packit 0ba690
int writepng_encode_row(mainprog_info *mainprog_ptr)  /* NON-interlaced only! */
Packit 0ba690
{
Packit 0ba690
    png_structp png_ptr = (png_structp)mainprog_ptr->png_ptr;
Packit 0ba690
    png_infop info_ptr = (png_infop)mainprog_ptr->info_ptr;
Packit 0ba690
Packit 0ba690
Packit 0ba690
    /* as always, setjmp() must be called in every function that calls a
Packit 0ba690
     * PNG-writing libpng function */
Packit 0ba690
Packit 0ba690
    if (setjmp(mainprog_ptr->jmpbuf)) {
Packit 0ba690
        png_destroy_write_struct(&png_ptr, &info_ptr);
Packit 0ba690
        mainprog_ptr->png_ptr = NULL;
Packit 0ba690
        mainprog_ptr->info_ptr = NULL;
Packit 0ba690
        return 2;
Packit 0ba690
    }
Packit 0ba690
Packit 0ba690
Packit 0ba690
    /* image_data points at our one row of image data */
Packit 0ba690
Packit 0ba690
    png_write_row(png_ptr, mainprog_ptr->image_data);
Packit 0ba690
Packit 0ba690
    return 0;
Packit 0ba690
}
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
/* returns 0 if succeeds, 2 if libpng problem */
Packit 0ba690
Packit 0ba690
int writepng_encode_finish(mainprog_info *mainprog_ptr)   /* NON-interlaced! */
Packit 0ba690
{
Packit 0ba690
    png_structp png_ptr = (png_structp)mainprog_ptr->png_ptr;
Packit 0ba690
    png_infop info_ptr = (png_infop)mainprog_ptr->info_ptr;
Packit 0ba690
Packit 0ba690
Packit 0ba690
    /* as always, setjmp() must be called in every function that calls a
Packit 0ba690
     * PNG-writing libpng function */
Packit 0ba690
Packit 0ba690
    if (setjmp(mainprog_ptr->jmpbuf)) {
Packit 0ba690
        png_destroy_write_struct(&png_ptr, &info_ptr);
Packit 0ba690
        mainprog_ptr->png_ptr = NULL;
Packit 0ba690
        mainprog_ptr->info_ptr = NULL;
Packit 0ba690
        return 2;
Packit 0ba690
    }
Packit 0ba690
Packit 0ba690
Packit 0ba690
    /* close out PNG file; if we had any text or time info to write after
Packit 0ba690
     * the IDATs, second argument would be info_ptr: */
Packit 0ba690
Packit 0ba690
    png_write_end(png_ptr, NULL);
Packit 0ba690
Packit 0ba690
    return 0;
Packit 0ba690
}
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
void writepng_cleanup(mainprog_info *mainprog_ptr)
Packit 0ba690
{
Packit 0ba690
    png_structp png_ptr = (png_structp)mainprog_ptr->png_ptr;
Packit 0ba690
    png_infop info_ptr = (png_infop)mainprog_ptr->info_ptr;
Packit 0ba690
Packit 0ba690
    if (png_ptr && info_ptr)
Packit 0ba690
        png_destroy_write_struct(&png_ptr, &info_ptr);
Packit 0ba690
}
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
Packit 0ba690
static void writepng_error_handler(png_structp png_ptr, png_const_charp msg)
Packit 0ba690
{
Packit 0ba690
    mainprog_info  *mainprog_ptr;
Packit 0ba690
Packit 0ba690
    /* This function, aside from the extra step of retrieving the "error
Packit 0ba690
     * pointer" (below) and the fact that it exists within the application
Packit 0ba690
     * rather than within libpng, is essentially identical to libpng's
Packit 0ba690
     * default error handler.  The second point is critical:  since both
Packit 0ba690
     * setjmp() and longjmp() are called from the same code, they are
Packit 0ba690
     * guaranteed to have compatible notions of how big a jmp_buf is,
Packit 0ba690
     * regardless of whether _BSD_SOURCE or anything else has (or has not)
Packit 0ba690
     * been defined. */
Packit 0ba690
Packit 0ba690
    fprintf(stderr, "writepng libpng error: %s\n", msg);
Packit 0ba690
    fflush(stderr);
Packit 0ba690
Packit 0ba690
    mainprog_ptr = png_get_error_ptr(png_ptr);
Packit 0ba690
    if (mainprog_ptr == NULL) {         /* we are completely hosed now */
Packit 0ba690
        fprintf(stderr,
Packit 0ba690
          "writepng severe error:  jmpbuf not recoverable; terminating.\n");
Packit 0ba690
        fflush(stderr);
Packit 0ba690
        exit(99);
Packit 0ba690
    }
Packit 0ba690
Packit 0ba690
    longjmp(mainprog_ptr->jmpbuf, 1);
Packit 0ba690
}