blob: 4961cb09f217e73f53f83cb16d88e994ceab7aef [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-Pehrsonf81b50b2009-12-29 16:50:15 -06004 * Last changed in libpng 1.4.0 [December 29, 2009]
Glenn Randers-Pehrson79134c62009-02-14 10:32:18 -06005 * Copyright (c) 1998-2009 Glenn Randers-Pehrson
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -05006 * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger)
7 * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -06008 *
Glenn Randers-Pehrsonbfbf8652009-06-26 21:46:52 -05009 * This code is released under the libpng license.
Glenn Randers-Pehrsonc332bbc2009-06-25 13:43:50 -050010 * For conditions of distribution and use, see the disclaimer
Glenn Randers-Pehrson037023b2009-06-24 10:27:36 -050011 * and license in png.h
Glenn Randers-Pehrson3e61d792009-06-24 09:31:28 -050012 *
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -050013 * This file provides a location for all output. Users who need
14 * special handling are expected to write functions that have the same
15 * arguments as these and perform similar functions, but that possibly
16 * use different output methods. Note that you shouldn't change these
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060017 * functions, but rather write replacement functions and then change
18 * them at run time with png_set_write_fn(...).
19 */
Guy Schalnate5a37791996-06-05 15:50:50 -050020
Glenn Randers-Pehrson03f9b022009-12-04 08:40:41 -060021#define PNG_NO_PEDANTIC_WARNINGS
Guy Schalnate5a37791996-06-05 15:50:50 -050022#include "png.h"
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -050023#ifdef PNG_WRITE_SUPPORTED
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -050024#include "pngpriv.h"
Guy Schalnate5a37791996-06-05 15:50:50 -050025
26/* Write the data to whatever output you are using. The default routine
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -050027 * writes to a file pointer. Note that this routine sometimes gets called
28 * with very small lengths, so you should implement some kind of simple
29 * buffering if you are using unbuffered writes. This should never be asked
30 * to write more than 64K on a 16 bit machine.
31 */
Guy Schalnate5a37791996-06-05 15:50:50 -050032
Glenn Randers-Pehrson75294572000-05-06 14:09:57 -050033void /* PRIVATE */
Andreas Dilger47a0c421997-05-16 02:46:07 -050034png_write_data(png_structp png_ptr, png_bytep data, png_size_t length)
Guy Schalnate5a37791996-06-05 15:50:50 -050035{
Andreas Dilger47a0c421997-05-16 02:46:07 -050036 if (png_ptr->write_data_fn != NULL )
Guy Schalnate5a37791996-06-05 15:50:50 -050037 (*(png_ptr->write_data_fn))(png_ptr, data, length);
38 else
39 png_error(png_ptr, "Call to NULL write function");
40}
41
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -050042#ifdef PNG_STDIO_SUPPORTED
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -050043/* 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 -050044 * not writing to a standard C stream, you should create a replacement
45 * write_data function and use it at run time with png_set_write_fn(), rather
46 * than changing the library.
47 */
Guy Schalnate5a37791996-06-05 15:50:50 -050048#ifndef USE_FAR_KEYWORD
Glenn Randers-Pehrson25d82242002-05-01 11:51:26 -050049void PNGAPI
Andreas Dilger47a0c421997-05-16 02:46:07 -050050png_default_write_data(png_structp png_ptr, png_bytep data, png_size_t length)
Guy Schalnate5a37791996-06-05 15:50:50 -050051{
52 png_uint_32 check;
53
Glenn Randers-Pehrsond8eb62f2009-05-30 20:19:20 -050054 if (png_ptr == NULL)
55 return;
Glenn Randers-Pehrson316f97a2000-07-08 13:19:41 -050056 check = fwrite(data, 1, length, (png_FILE_p)(png_ptr->io_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -050057 if (check != length)
Guy Schalnate5a37791996-06-05 15:50:50 -050058 png_error(png_ptr, "Write Error");
Guy Schalnate5a37791996-06-05 15:50:50 -050059}
60#else
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -050061/* This is the model-independent version. Since the standard I/O library
62 * can't handle far buffers in the medium and small models, we have to copy
63 * the data.
64 */
Guy Schalnate5a37791996-06-05 15:50:50 -050065
66#define NEAR_BUF_SIZE 1024
67#define MIN(a,b) (a <= b ? a : b)
68
Glenn Randers-Pehrson25d82242002-05-01 11:51:26 -050069void PNGAPI
Andreas Dilger47a0c421997-05-16 02:46:07 -050070png_default_write_data(png_structp png_ptr, png_bytep data, png_size_t length)
Guy Schalnate5a37791996-06-05 15:50:50 -050071{
72 png_uint_32 check;
Andreas Dilger47a0c421997-05-16 02:46:07 -050073 png_byte *near_data; /* Needs to be "png_byte *" instead of "png_bytep" */
Glenn Randers-Pehrson316f97a2000-07-08 13:19:41 -050074 png_FILE_p io_ptr;
Guy Schalnate5a37791996-06-05 15:50:50 -050075
Glenn Randers-Pehrsond8eb62f2009-05-30 20:19:20 -050076 if (png_ptr == NULL)
77 return;
Guy Schalnate5a37791996-06-05 15:50:50 -050078 /* Check if data really is near. If so, use usual code. */
Andreas Dilger47a0c421997-05-16 02:46:07 -050079 near_data = (png_byte *)CVT_PTR_NOCHECK(data);
Glenn Randers-Pehrson316f97a2000-07-08 13:19:41 -050080 io_ptr = (png_FILE_p)CVT_PTR(png_ptr->io_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -050081 if ((png_bytep)near_data == data)
Guy Schalnate5a37791996-06-05 15:50:50 -050082 {
Andreas Dilger47a0c421997-05-16 02:46:07 -050083 check = fwrite(near_data, 1, length, io_ptr);
Guy Schalnate5a37791996-06-05 15:50:50 -050084 }
85 else
86 {
87 png_byte buf[NEAR_BUF_SIZE];
88 png_size_t written, remaining, err;
89 check = 0;
Andreas Dilger47a0c421997-05-16 02:46:07 -050090 remaining = length;
Guy Schalnate5a37791996-06-05 15:50:50 -050091 do
92 {
93 written = MIN(NEAR_BUF_SIZE, remaining);
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -050094 png_memcpy(buf, data, written); /* Copy far buffer to near buffer */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060095 err = fwrite(buf, 1, written, io_ptr);
Guy Schalnate5a37791996-06-05 15:50:50 -050096 if (err != written)
97 break;
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -050098
Guy Schalnate5a37791996-06-05 15:50:50 -050099 else
100 check += err;
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500101
Guy Schalnate5a37791996-06-05 15:50:50 -0500102 data += written;
103 remaining -= written;
104 }
105 while (remaining != 0);
106 }
107 if (check != length)
Guy Schalnate5a37791996-06-05 15:50:50 -0500108 png_error(png_ptr, "Write Error");
Guy Schalnate5a37791996-06-05 15:50:50 -0500109}
110
111#endif
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600112#endif
Guy Schalnate5a37791996-06-05 15:50:50 -0500113
114/* This function is called to output any data pending writing (normally
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500115 * to disk). After png_flush is called, there should be no data pending
116 * writing in any buffers.
117 */
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -0500118#ifdef PNG_WRITE_FLUSH_SUPPORTED
Glenn Randers-Pehrson75294572000-05-06 14:09:57 -0500119void /* PRIVATE */
Guy Schalnate5a37791996-06-05 15:50:50 -0500120png_flush(png_structp png_ptr)
121{
Andreas Dilger47a0c421997-05-16 02:46:07 -0500122 if (png_ptr->output_flush_fn != NULL)
Guy Schalnate5a37791996-06-05 15:50:50 -0500123 (*(png_ptr->output_flush_fn))(png_ptr);
124}
125
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -0500126#ifdef PNG_STDIO_SUPPORTED
Glenn Randers-Pehrson25d82242002-05-01 11:51:26 -0500127void PNGAPI
Guy Schalnate5a37791996-06-05 15:50:50 -0500128png_default_flush(png_structp png_ptr)
129{
Glenn Randers-Pehrson316f97a2000-07-08 13:19:41 -0500130 png_FILE_p io_ptr;
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500131 if (png_ptr == NULL)
132 return;
Glenn Randers-Pehrson316f97a2000-07-08 13:19:41 -0500133 io_ptr = (png_FILE_p)CVT_PTR((png_ptr->io_ptr));
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500134 fflush(io_ptr);
Guy Schalnate5a37791996-06-05 15:50:50 -0500135}
136#endif
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600137#endif
Guy Schalnate5a37791996-06-05 15:50:50 -0500138
139/* This function allows the application to supply new output functions for
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500140 * libpng if standard C streams aren't being used.
141 *
142 * This function takes as its arguments:
143 * png_ptr - pointer to a png output data structure
144 * io_ptr - pointer to user supplied structure containing info about
145 * the output functions. May be NULL.
146 * write_data_fn - pointer to a new output function that takes as its
147 * arguments a pointer to a png_struct, a pointer to
148 * data to be written, and a 32-bit unsigned int that is
149 * the number of bytes to be written. The new write
150 * function should call png_error(png_ptr, "Error msg")
151 * to exit and output any fatal error messages. May be
152 * NULL, in which case libpng's default function will
153 * be used.
154 * flush_data_fn - pointer to a new flush function that takes as its
155 * arguments a pointer to a png_struct. After a call to
156 * the flush function, there should be no data in any buffers
157 * or pending transmission. If the output method doesn't do
158 * any buffering of ouput, a function prototype must still be
159 * supplied although it doesn't have to do anything. If
160 * PNG_WRITE_FLUSH_SUPPORTED is not defined at libpng compile
161 * time, output_flush_fn will be ignored, although it must be
162 * supplied for compatibility. May be NULL, in which case
163 * libpng's default function will be used, if
164 * PNG_WRITE_FLUSH_SUPPORTED is defined. This is not
165 * a good idea if io_ptr does not point to a standard
166 * *FILE structure.
167 */
Glenn Randers-Pehrson75294572000-05-06 14:09:57 -0500168void PNGAPI
Guy Schalnate5a37791996-06-05 15:50:50 -0500169png_set_write_fn(png_structp png_ptr, png_voidp io_ptr,
170 png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn)
171{
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500172 if (png_ptr == NULL)
173 return;
174
Guy Schalnate5a37791996-06-05 15:50:50 -0500175 png_ptr->io_ptr = io_ptr;
176
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -0500177#ifdef PNG_STDIO_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -0500178 if (write_data_fn != NULL)
Guy Schalnate5a37791996-06-05 15:50:50 -0500179 png_ptr->write_data_fn = write_data_fn;
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500180
Guy Schalnate5a37791996-06-05 15:50:50 -0500181 else
Glenn Randers-Pehrson25d82242002-05-01 11:51:26 -0500182 png_ptr->write_data_fn = png_default_write_data;
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600183#else
184 png_ptr->write_data_fn = write_data_fn;
185#endif
Guy Schalnate5a37791996-06-05 15:50:50 -0500186
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -0500187#ifdef PNG_WRITE_FLUSH_SUPPORTED
188#ifdef PNG_STDIO_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -0500189 if (output_flush_fn != NULL)
Guy Schalnate5a37791996-06-05 15:50:50 -0500190 png_ptr->output_flush_fn = output_flush_fn;
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500191
Guy Schalnate5a37791996-06-05 15:50:50 -0500192 else
Glenn Randers-Pehrson25d82242002-05-01 11:51:26 -0500193 png_ptr->output_flush_fn = png_default_flush;
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600194#else
195 png_ptr->output_flush_fn = output_flush_fn;
196#endif
Guy Schalnate5a37791996-06-05 15:50:50 -0500197#endif /* PNG_WRITE_FLUSH_SUPPORTED */
198
199 /* It is an error to read while writing a png file */
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -0500200 if (png_ptr->read_data_fn != NULL)
201 {
202 png_ptr->read_data_fn = NULL;
203 png_warning(png_ptr,
204 "Attempted to set both read_data_fn and write_data_fn in");
205 png_warning(png_ptr,
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500206 "the same structure. Resetting read_data_fn to NULL");
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -0500207 }
Guy Schalnate5a37791996-06-05 15:50:50 -0500208}
209
Glenn Randers-Pehrsondbd40142009-08-31 08:42:02 -0500210#ifdef USE_FAR_KEYWORD
211#ifdef _MSC_VER
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500212void *png_far_to_near(png_structp png_ptr, png_voidp ptr, int check)
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600213{
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600214 void *near_ptr;
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600215 void FAR *far_ptr;
216 FP_OFF(near_ptr) = FP_OFF(ptr);
217 far_ptr = (void FAR *)near_ptr;
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500218
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500219 if (check != 0)
220 if (FP_SEG(ptr) != FP_SEG(far_ptr))
221 png_error(png_ptr, "segment lost in conversion");
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500222
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600223 return(near_ptr);
224}
225# else
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500226void *png_far_to_near(png_structp png_ptr, png_voidp ptr, int check)
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600227{
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600228 void *near_ptr;
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600229 void FAR *far_ptr;
230 near_ptr = (void FAR *)ptr;
231 far_ptr = (void FAR *)near_ptr;
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500232
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500233 if (check != 0)
234 if (far_ptr != ptr)
235 png_error(png_ptr, "segment lost in conversion");
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500236
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600237 return(near_ptr);
238}
239# endif
240# endif
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -0500241#endif /* PNG_WRITE_SUPPORTED */