blob: b76632aeb7e14627dde0bd6d82bd2c8e56643245 [file] [log] [blame]
Guy Schalnate5a37791996-06-05 15:50:50 -05001
2/* pngwio.c - functions for data output
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06003 *
Glenn Randers-Pehrson glennrp@comcast.net11a3c7b2009-05-15 20:33:24 -05004 * Last changed in libpng 1.4.0 [May 15, 2009]
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06005 * For conditions of distribution and use, see copyright notice in png.h
Glenn Randers-Pehrson79134c62009-02-14 10:32:18 -06006 * Copyright (c) 1998-2009 Glenn Randers-Pehrson
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -05007 * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger)
8 * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06009 *
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -050010 * This file provides a location for all output. Users who need
11 * special handling are expected to write functions that have the same
12 * arguments as these and perform similar functions, but that possibly
13 * use different output methods. Note that you shouldn't change these
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060014 * functions, but rather write replacement functions and then change
15 * them at run time with png_set_write_fn(...).
16 */
Guy Schalnate5a37791996-06-05 15:50:50 -050017
Guy Schalnate5a37791996-06-05 15:50:50 -050018#include "png.h"
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -050019#ifdef PNG_WRITE_SUPPORTED
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -050020#include "pngpriv.h"
Guy Schalnate5a37791996-06-05 15:50:50 -050021
22/* Write the data to whatever output you are using. The default routine
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -050023 * writes to a file pointer. Note that this routine sometimes gets called
24 * with very small lengths, so you should implement some kind of simple
25 * buffering if you are using unbuffered writes. This should never be asked
26 * to write more than 64K on a 16 bit machine.
27 */
Guy Schalnate5a37791996-06-05 15:50:50 -050028
Glenn Randers-Pehrson75294572000-05-06 14:09:57 -050029void /* PRIVATE */
Andreas Dilger47a0c421997-05-16 02:46:07 -050030png_write_data(png_structp png_ptr, png_bytep data, png_size_t length)
Guy Schalnate5a37791996-06-05 15:50:50 -050031{
Andreas Dilger47a0c421997-05-16 02:46:07 -050032 if (png_ptr->write_data_fn != NULL )
Guy Schalnate5a37791996-06-05 15:50:50 -050033 (*(png_ptr->write_data_fn))(png_ptr, data, length);
34 else
35 png_error(png_ptr, "Call to NULL write function");
36}
37
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -060038#if !defined(PNG_NO_STDIO)
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -050039/* This is the function that does the actual writing of data. If you are
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -050040 * not writing to a standard C stream, you should create a replacement
41 * write_data function and use it at run time with png_set_write_fn(), rather
42 * than changing the library.
43 */
Guy Schalnate5a37791996-06-05 15:50:50 -050044#ifndef USE_FAR_KEYWORD
Glenn Randers-Pehrson25d82242002-05-01 11:51:26 -050045void PNGAPI
Andreas Dilger47a0c421997-05-16 02:46:07 -050046png_default_write_data(png_structp png_ptr, png_bytep data, png_size_t length)
Guy Schalnate5a37791996-06-05 15:50:50 -050047{
48 png_uint_32 check;
49
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -050050 if (png_ptr == NULL) return;
Glenn Randers-Pehrson316f97a2000-07-08 13:19:41 -050051 check = fwrite(data, 1, length, (png_FILE_p)(png_ptr->io_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -050052 if (check != length)
Guy Schalnate5a37791996-06-05 15:50:50 -050053 png_error(png_ptr, "Write Error");
Guy Schalnate5a37791996-06-05 15:50:50 -050054}
55#else
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -050056/* This is the model-independent version. Since the standard I/O library
57 * can't handle far buffers in the medium and small models, we have to copy
58 * the data.
59 */
Guy Schalnate5a37791996-06-05 15:50:50 -050060
61#define NEAR_BUF_SIZE 1024
62#define MIN(a,b) (a <= b ? a : b)
63
Glenn Randers-Pehrson25d82242002-05-01 11:51:26 -050064void PNGAPI
Andreas Dilger47a0c421997-05-16 02:46:07 -050065png_default_write_data(png_structp png_ptr, png_bytep data, png_size_t length)
Guy Schalnate5a37791996-06-05 15:50:50 -050066{
67 png_uint_32 check;
Andreas Dilger47a0c421997-05-16 02:46:07 -050068 png_byte *near_data; /* Needs to be "png_byte *" instead of "png_bytep" */
Glenn Randers-Pehrson316f97a2000-07-08 13:19:41 -050069 png_FILE_p io_ptr;
Guy Schalnate5a37791996-06-05 15:50:50 -050070
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -050071 if (png_ptr == NULL) return;
Guy Schalnate5a37791996-06-05 15:50:50 -050072 /* Check if data really is near. If so, use usual code. */
Andreas Dilger47a0c421997-05-16 02:46:07 -050073 near_data = (png_byte *)CVT_PTR_NOCHECK(data);
Glenn Randers-Pehrson316f97a2000-07-08 13:19:41 -050074 io_ptr = (png_FILE_p)CVT_PTR(png_ptr->io_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -050075 if ((png_bytep)near_data == data)
Guy Schalnate5a37791996-06-05 15:50:50 -050076 {
Andreas Dilger47a0c421997-05-16 02:46:07 -050077 check = fwrite(near_data, 1, length, io_ptr);
Guy Schalnate5a37791996-06-05 15:50:50 -050078 }
79 else
80 {
81 png_byte buf[NEAR_BUF_SIZE];
82 png_size_t written, remaining, err;
83 check = 0;
Andreas Dilger47a0c421997-05-16 02:46:07 -050084 remaining = length;
Guy Schalnate5a37791996-06-05 15:50:50 -050085 do
86 {
87 written = MIN(NEAR_BUF_SIZE, remaining);
88 png_memcpy(buf, data, written); /* copy far buffer to near buffer */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060089 err = fwrite(buf, 1, written, io_ptr);
Guy Schalnate5a37791996-06-05 15:50:50 -050090 if (err != written)
91 break;
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -050092
Guy Schalnate5a37791996-06-05 15:50:50 -050093 else
94 check += err;
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -050095
Guy Schalnate5a37791996-06-05 15:50:50 -050096 data += written;
97 remaining -= written;
98 }
99 while (remaining != 0);
100 }
101 if (check != length)
Guy Schalnate5a37791996-06-05 15:50:50 -0500102 png_error(png_ptr, "Write Error");
Guy Schalnate5a37791996-06-05 15:50:50 -0500103}
104
105#endif
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600106#endif
Guy Schalnate5a37791996-06-05 15:50:50 -0500107
108/* This function is called to output any data pending writing (normally
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500109 * to disk). After png_flush is called, there should be no data pending
110 * writing in any buffers.
111 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500112#if defined(PNG_WRITE_FLUSH_SUPPORTED)
Glenn Randers-Pehrson75294572000-05-06 14:09:57 -0500113void /* PRIVATE */
Guy Schalnate5a37791996-06-05 15:50:50 -0500114png_flush(png_structp png_ptr)
115{
Andreas Dilger47a0c421997-05-16 02:46:07 -0500116 if (png_ptr->output_flush_fn != NULL)
Guy Schalnate5a37791996-06-05 15:50:50 -0500117 (*(png_ptr->output_flush_fn))(png_ptr);
118}
119
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600120#if !defined(PNG_NO_STDIO)
Glenn Randers-Pehrson25d82242002-05-01 11:51:26 -0500121void PNGAPI
Guy Schalnate5a37791996-06-05 15:50:50 -0500122png_default_flush(png_structp png_ptr)
123{
Glenn Randers-Pehrson316f97a2000-07-08 13:19:41 -0500124 png_FILE_p io_ptr;
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500125 if (png_ptr == NULL)
126 return;
Glenn Randers-Pehrson316f97a2000-07-08 13:19:41 -0500127 io_ptr = (png_FILE_p)CVT_PTR((png_ptr->io_ptr));
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500128 fflush(io_ptr);
Guy Schalnate5a37791996-06-05 15:50:50 -0500129}
130#endif
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600131#endif
Guy Schalnate5a37791996-06-05 15:50:50 -0500132
133/* This function allows the application to supply new output functions for
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500134 * libpng if standard C streams aren't being used.
135 *
136 * This function takes as its arguments:
137 * png_ptr - pointer to a png output data structure
138 * io_ptr - pointer to user supplied structure containing info about
139 * the output functions. May be NULL.
140 * write_data_fn - pointer to a new output function that takes as its
141 * arguments a pointer to a png_struct, a pointer to
142 * data to be written, and a 32-bit unsigned int that is
143 * the number of bytes to be written. The new write
144 * function should call png_error(png_ptr, "Error msg")
145 * to exit and output any fatal error messages. May be
146 * NULL, in which case libpng's default function will
147 * be used.
148 * flush_data_fn - pointer to a new flush function that takes as its
149 * arguments a pointer to a png_struct. After a call to
150 * the flush function, there should be no data in any buffers
151 * or pending transmission. If the output method doesn't do
152 * any buffering of ouput, a function prototype must still be
153 * supplied although it doesn't have to do anything. If
154 * PNG_WRITE_FLUSH_SUPPORTED is not defined at libpng compile
155 * time, output_flush_fn will be ignored, although it must be
156 * supplied for compatibility. May be NULL, in which case
157 * libpng's default function will be used, if
158 * PNG_WRITE_FLUSH_SUPPORTED is defined. This is not
159 * a good idea if io_ptr does not point to a standard
160 * *FILE structure.
161 */
Glenn Randers-Pehrson75294572000-05-06 14:09:57 -0500162void PNGAPI
Guy Schalnate5a37791996-06-05 15:50:50 -0500163png_set_write_fn(png_structp png_ptr, png_voidp io_ptr,
164 png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn)
165{
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500166 if (png_ptr == NULL)
167 return;
168
Guy Schalnate5a37791996-06-05 15:50:50 -0500169 png_ptr->io_ptr = io_ptr;
170
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600171#if !defined(PNG_NO_STDIO)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500172 if (write_data_fn != NULL)
Guy Schalnate5a37791996-06-05 15:50:50 -0500173 png_ptr->write_data_fn = write_data_fn;
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500174
Guy Schalnate5a37791996-06-05 15:50:50 -0500175 else
Glenn Randers-Pehrson25d82242002-05-01 11:51:26 -0500176 png_ptr->write_data_fn = png_default_write_data;
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600177#else
178 png_ptr->write_data_fn = write_data_fn;
179#endif
Guy Schalnate5a37791996-06-05 15:50:50 -0500180
181#if defined(PNG_WRITE_FLUSH_SUPPORTED)
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600182#if !defined(PNG_NO_STDIO)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500183 if (output_flush_fn != NULL)
Guy Schalnate5a37791996-06-05 15:50:50 -0500184 png_ptr->output_flush_fn = output_flush_fn;
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500185
Guy Schalnate5a37791996-06-05 15:50:50 -0500186 else
Glenn Randers-Pehrson25d82242002-05-01 11:51:26 -0500187 png_ptr->output_flush_fn = png_default_flush;
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600188#else
189 png_ptr->output_flush_fn = output_flush_fn;
190#endif
Guy Schalnate5a37791996-06-05 15:50:50 -0500191#endif /* PNG_WRITE_FLUSH_SUPPORTED */
192
193 /* It is an error to read while writing a png file */
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -0500194 if (png_ptr->read_data_fn != NULL)
195 {
196 png_ptr->read_data_fn = NULL;
197 png_warning(png_ptr,
198 "Attempted to set both read_data_fn and write_data_fn in");
199 png_warning(png_ptr,
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500200 "the same structure. Resetting read_data_fn to NULL");
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -0500201 }
Guy Schalnate5a37791996-06-05 15:50:50 -0500202}
203
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600204#if defined(USE_FAR_KEYWORD)
205#if defined(_MSC_VER)
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500206void *png_far_to_near(png_structp png_ptr, png_voidp ptr, int check)
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600207{
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600208 void *near_ptr;
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600209 void FAR *far_ptr;
210 FP_OFF(near_ptr) = FP_OFF(ptr);
211 far_ptr = (void FAR *)near_ptr;
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500212
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500213 if (check != 0)
214 if (FP_SEG(ptr) != FP_SEG(far_ptr))
215 png_error(png_ptr, "segment lost in conversion");
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500216
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600217 return(near_ptr);
218}
219# else
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500220void *png_far_to_near(png_structp png_ptr, png_voidp ptr, int check)
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600221{
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600222 void *near_ptr;
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600223 void FAR *far_ptr;
224 near_ptr = (void FAR *)ptr;
225 far_ptr = (void FAR *)near_ptr;
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500226
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500227 if (check != 0)
228 if (far_ptr != ptr)
229 png_error(png_ptr, "segment lost in conversion");
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500230
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600231 return(near_ptr);
232}
233# endif
234# endif
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -0500235#endif /* PNG_WRITE_SUPPORTED */