blob: 29cb01067b3fdb15efb531fb45f8cba3b92272be [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-Pehrson8fb550c2009-03-21 08:15:32 -05004 * Last changed in libpng 1.4.0 [March 21, 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
23 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
Glenn Randers-Pehrson345bc271998-06-14 14:43:31 -050026 to write more than 64K on a 16 bit machine. */
Guy Schalnate5a37791996-06-05 15:50:50 -050027
Glenn Randers-Pehrson75294572000-05-06 14:09:57 -050028void /* PRIVATE */
Andreas Dilger47a0c421997-05-16 02:46:07 -050029png_write_data(png_structp png_ptr, png_bytep data, png_size_t length)
Guy Schalnate5a37791996-06-05 15:50:50 -050030{
Andreas Dilger47a0c421997-05-16 02:46:07 -050031 if (png_ptr->write_data_fn != NULL )
Guy Schalnate5a37791996-06-05 15:50:50 -050032 (*(png_ptr->write_data_fn))(png_ptr, data, length);
33 else
34 png_error(png_ptr, "Call to NULL write function");
35}
36
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -060037#if !defined(PNG_NO_STDIO)
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -050038/* This is the function that does the actual writing of data. If you are
Guy Schalnate5a37791996-06-05 15:50:50 -050039 not writing to a standard C stream, you should create a replacement
40 write_data function and use it at run time with png_set_write_fn(), rather
41 than changing the library. */
42#ifndef USE_FAR_KEYWORD
Glenn Randers-Pehrson25d82242002-05-01 11:51:26 -050043void PNGAPI
Andreas Dilger47a0c421997-05-16 02:46:07 -050044png_default_write_data(png_structp png_ptr, png_bytep data, png_size_t length)
Guy Schalnate5a37791996-06-05 15:50:50 -050045{
46 png_uint_32 check;
47
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -050048 if (png_ptr == NULL) return;
Glenn Randers-Pehrson316f97a2000-07-08 13:19:41 -050049 check = fwrite(data, 1, length, (png_FILE_p)(png_ptr->io_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -050050 if (check != length)
Guy Schalnate5a37791996-06-05 15:50:50 -050051 png_error(png_ptr, "Write Error");
Guy Schalnate5a37791996-06-05 15:50:50 -050052}
53#else
54/* this is the model-independent version. Since the standard I/O library
55 can't handle far buffers in the medium and small models, we have to copy
56 the data.
57*/
58
59#define NEAR_BUF_SIZE 1024
60#define MIN(a,b) (a <= b ? a : b)
61
Glenn Randers-Pehrson25d82242002-05-01 11:51:26 -050062void PNGAPI
Andreas Dilger47a0c421997-05-16 02:46:07 -050063png_default_write_data(png_structp png_ptr, png_bytep data, png_size_t length)
Guy Schalnate5a37791996-06-05 15:50:50 -050064{
65 png_uint_32 check;
Andreas Dilger47a0c421997-05-16 02:46:07 -050066 png_byte *near_data; /* Needs to be "png_byte *" instead of "png_bytep" */
Glenn Randers-Pehrson316f97a2000-07-08 13:19:41 -050067 png_FILE_p io_ptr;
Guy Schalnate5a37791996-06-05 15:50:50 -050068
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -050069 if (png_ptr == NULL) return;
Guy Schalnate5a37791996-06-05 15:50:50 -050070 /* Check if data really is near. If so, use usual code. */
Andreas Dilger47a0c421997-05-16 02:46:07 -050071 near_data = (png_byte *)CVT_PTR_NOCHECK(data);
Glenn Randers-Pehrson316f97a2000-07-08 13:19:41 -050072 io_ptr = (png_FILE_p)CVT_PTR(png_ptr->io_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -050073 if ((png_bytep)near_data == data)
Guy Schalnate5a37791996-06-05 15:50:50 -050074 {
Andreas Dilger47a0c421997-05-16 02:46:07 -050075 check = fwrite(near_data, 1, length, io_ptr);
Guy Schalnate5a37791996-06-05 15:50:50 -050076 }
77 else
78 {
79 png_byte buf[NEAR_BUF_SIZE];
80 png_size_t written, remaining, err;
81 check = 0;
Andreas Dilger47a0c421997-05-16 02:46:07 -050082 remaining = length;
Guy Schalnate5a37791996-06-05 15:50:50 -050083 do
84 {
85 written = MIN(NEAR_BUF_SIZE, remaining);
86 png_memcpy(buf, data, written); /* copy far buffer to near buffer */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060087 err = fwrite(buf, 1, written, io_ptr);
Guy Schalnate5a37791996-06-05 15:50:50 -050088 if (err != written)
89 break;
90 else
91 check += err;
92 data += written;
93 remaining -= written;
94 }
95 while (remaining != 0);
96 }
97 if (check != length)
Guy Schalnate5a37791996-06-05 15:50:50 -050098 png_error(png_ptr, "Write Error");
Guy Schalnate5a37791996-06-05 15:50:50 -050099}
100
101#endif
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600102#endif
Guy Schalnate5a37791996-06-05 15:50:50 -0500103
104/* This function is called to output any data pending writing (normally
105 to disk). After png_flush is called, there should be no data pending
106 writing in any buffers. */
107#if defined(PNG_WRITE_FLUSH_SUPPORTED)
Glenn Randers-Pehrson75294572000-05-06 14:09:57 -0500108void /* PRIVATE */
Guy Schalnate5a37791996-06-05 15:50:50 -0500109png_flush(png_structp png_ptr)
110{
Andreas Dilger47a0c421997-05-16 02:46:07 -0500111 if (png_ptr->output_flush_fn != NULL)
Guy Schalnate5a37791996-06-05 15:50:50 -0500112 (*(png_ptr->output_flush_fn))(png_ptr);
113}
114
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600115#if !defined(PNG_NO_STDIO)
Glenn Randers-Pehrson25d82242002-05-01 11:51:26 -0500116void PNGAPI
Guy Schalnate5a37791996-06-05 15:50:50 -0500117png_default_flush(png_structp png_ptr)
118{
Glenn Randers-Pehrson316f97a2000-07-08 13:19:41 -0500119 png_FILE_p io_ptr;
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500120 if (png_ptr == NULL) return;
Glenn Randers-Pehrson316f97a2000-07-08 13:19:41 -0500121 io_ptr = (png_FILE_p)CVT_PTR((png_ptr->io_ptr));
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500122 fflush(io_ptr);
Guy Schalnate5a37791996-06-05 15:50:50 -0500123}
124#endif
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600125#endif
Guy Schalnate5a37791996-06-05 15:50:50 -0500126
127/* This function allows the application to supply new output functions for
128 libpng if standard C streams aren't being used.
129
130 This function takes as its arguments:
131 png_ptr - pointer to a png output data structure
132 io_ptr - pointer to user supplied structure containing info about
133 the output functions. May be NULL.
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500134 write_data_fn - pointer to a new output function that takes as its
Guy Schalnate5a37791996-06-05 15:50:50 -0500135 arguments a pointer to a png_struct, a pointer to
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500136 data to be written, and a 32-bit unsigned int that is
Guy Schalnate5a37791996-06-05 15:50:50 -0500137 the number of bytes to be written. The new write
138 function should call png_error(png_ptr, "Error msg")
Glenn Randers-Pehrson0ffb71a2009-02-28 06:08:20 -0600139 to exit and output any fatal error messages. May be
140 NULL, in which case libpng's default function will
141 be used.
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500142 flush_data_fn - pointer to a new flush function that takes as its
Guy Schalnate5a37791996-06-05 15:50:50 -0500143 arguments a pointer to a png_struct. After a call to
144 the flush function, there should be no data in any buffers
145 or pending transmission. If the output method doesn't do
146 any buffering of ouput, a function prototype must still be
147 supplied although it doesn't have to do anything. If
148 PNG_WRITE_FLUSH_SUPPORTED is not defined at libpng compile
149 time, output_flush_fn will be ignored, although it must be
Glenn Randers-Pehrson0ffb71a2009-02-28 06:08:20 -0600150 supplied for compatibility. May be NULL, in which case
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500151 libpng's default function will be used, if
152 PNG_WRITE_FLUSH_SUPPORTED is defined. This is not
153 a good idea if io_ptr does not point to a standard
154 *FILE structure. */
Glenn Randers-Pehrson75294572000-05-06 14:09:57 -0500155void PNGAPI
Guy Schalnate5a37791996-06-05 15:50:50 -0500156png_set_write_fn(png_structp png_ptr, png_voidp io_ptr,
157 png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn)
158{
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500159 if (png_ptr == NULL) return;
Guy Schalnate5a37791996-06-05 15:50:50 -0500160 png_ptr->io_ptr = io_ptr;
161
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600162#if !defined(PNG_NO_STDIO)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500163 if (write_data_fn != NULL)
Guy Schalnate5a37791996-06-05 15:50:50 -0500164 png_ptr->write_data_fn = write_data_fn;
165 else
Glenn Randers-Pehrson25d82242002-05-01 11:51:26 -0500166 png_ptr->write_data_fn = png_default_write_data;
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600167#else
168 png_ptr->write_data_fn = write_data_fn;
169#endif
Guy Schalnate5a37791996-06-05 15:50:50 -0500170
171#if defined(PNG_WRITE_FLUSH_SUPPORTED)
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600172#if !defined(PNG_NO_STDIO)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500173 if (output_flush_fn != NULL)
Guy Schalnate5a37791996-06-05 15:50:50 -0500174 png_ptr->output_flush_fn = output_flush_fn;
175 else
Glenn Randers-Pehrson25d82242002-05-01 11:51:26 -0500176 png_ptr->output_flush_fn = png_default_flush;
Glenn Randers-Pehrson70e3f541998-01-03 22:40:55 -0600177#else
178 png_ptr->output_flush_fn = output_flush_fn;
179#endif
Guy Schalnate5a37791996-06-05 15:50:50 -0500180#endif /* PNG_WRITE_FLUSH_SUPPORTED */
181
182 /* It is an error to read while writing a png file */
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -0500183 if (png_ptr->read_data_fn != NULL)
184 {
185 png_ptr->read_data_fn = NULL;
186 png_warning(png_ptr,
187 "Attempted to set both read_data_fn and write_data_fn in");
188 png_warning(png_ptr,
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500189 "the same structure. Resetting read_data_fn to NULL");
Glenn Randers-Pehrsonf7d1a171998-06-06 15:31:35 -0500190 }
Guy Schalnate5a37791996-06-05 15:50:50 -0500191}
192
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600193#if defined(USE_FAR_KEYWORD)
194#if defined(_MSC_VER)
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500195void *png_far_to_near(png_structp png_ptr, png_voidp ptr, int check)
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600196{
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600197 void *near_ptr;
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600198 void FAR *far_ptr;
199 FP_OFF(near_ptr) = FP_OFF(ptr);
200 far_ptr = (void FAR *)near_ptr;
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500201 if (check != 0)
202 if (FP_SEG(ptr) != FP_SEG(far_ptr))
203 png_error(png_ptr, "segment lost in conversion");
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600204 return(near_ptr);
205}
206# else
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500207void *png_far_to_near(png_structp png_ptr, png_voidp ptr, int check)
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600208{
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600209 void *near_ptr;
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600210 void FAR *far_ptr;
211 near_ptr = (void FAR *)ptr;
212 far_ptr = (void FAR *)near_ptr;
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500213 if (check != 0)
214 if (far_ptr != ptr)
215 png_error(png_ptr, "segment lost in conversion");
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600216 return(near_ptr);
217}
218# endif
219# endif
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -0500220#endif /* PNG_WRITE_SUPPORTED */