1 /* $Id: tiffiop.h,v 1.87 2015-08-23 17:49:01 bfriesen Exp $ */
2 
3 /*
4  * Copyright (c) 1988-1997 Sam Leffler
5  * Copyright (c) 1991-1997 Silicon Graphics, Inc.
6  *
7  * Permission to use, copy, modify, distribute, and sell this software and
8  * its documentation for any purpose is hereby granted without fee, provided
9  * that (i) the above copyright notices and this permission notice appear in
10  * all copies of the software and related documentation, and (ii) the names of
11  * Sam Leffler and Silicon Graphics may not be used in any advertising or
12  * publicity relating to the software without the specific, prior written
13  * permission of Sam Leffler and Silicon Graphics.
14  *
15  * THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
16  * EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
17  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
18  *
19  * IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
20  * ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
21  * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
22  * WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
24  * OF THIS SOFTWARE.
25  */
26 
27 #ifndef _TIFFIOP_
28 #define	_TIFFIOP_
29 /*
30  * ``Library-private'' definitions.
31  */
32 
33 #include "tif_config.h"
34 
35 #ifdef HAVE_FCNTL_H
36 # include <fcntl.h>
37 #endif
38 
39 #ifdef HAVE_SYS_TYPES_H
40 # include <sys/types.h>
41 #endif
42 
43 #ifdef HAVE_STRING_H
44 # include <string.h>
45 #endif
46 
47 #ifdef HAVE_ASSERT_H
48 # include <assert.h>
49 #else
50 # define assert(x)
51 #endif
52 
53 #ifdef HAVE_SEARCH_H
54 # include <search.h>
55 #else
56 extern void *lfind(const void *, const void *, size_t *, size_t,
57 		   int (*)(const void *, const void *));
58 #endif
59 
60 #if !defined(HAVE_SNPRINTF) && !defined(HAVE__SNPRINTF)
61 #undef snprintf
62 #define snprintf _TIFF_snprintf_f
63 extern int snprintf(char* str, size_t size, const char* format, ...);
64 #endif
65 
66 #include "tiffio.h"
67 
68 #include "tif_dir.h"
69 
70 #ifndef STRIP_SIZE_DEFAULT
71 # define STRIP_SIZE_DEFAULT 8192
72 #endif
73 
74 #define    streq(a,b)      (strcmp(a,b) == 0)
75 
76 #ifndef TRUE
77 #define	TRUE	1
78 #define	FALSE	0
79 #endif
80 
81 typedef struct client_info {
82     struct client_info *next;
83     void *data;
84     char *name;
85 } TIFFClientInfoLink;
86 
87 /*
88  * Typedefs for ``method pointers'' used internally.
89  * these are depriciated and provided only for backwards compatibility
90  */
91 typedef unsigned char tidataval_t;    /* internal image data value type */
92 typedef tidataval_t* tidata_t;        /* reference to internal image data */
93 
94 typedef void (*TIFFVoidMethod)(TIFF*);
95 typedef int (*TIFFBoolMethod)(TIFF*);
96 typedef int (*TIFFPreMethod)(TIFF*, uint16);
97 typedef int (*TIFFCodeMethod)(TIFF* tif, uint8* buf, tmsize_t size, uint16 sample);
98 typedef int (*TIFFSeekMethod)(TIFF*, uint32);
99 typedef void (*TIFFPostMethod)(TIFF* tif, uint8* buf, tmsize_t size);
100 typedef uint32 (*TIFFStripMethod)(TIFF*, uint32);
101 typedef void (*TIFFTileMethod)(TIFF*, uint32*, uint32*);
102 
103 struct tiff {
104 	char*                tif_name;         /* name of open file */
105 	int                  tif_fd;           /* open file descriptor */
106 	int                  tif_mode;         /* open mode (O_*) */
107 	uint32               tif_flags;
108 	#define TIFF_FILLORDER   0x00003 /* natural bit fill order for machine */
109 	#define TIFF_DIRTYHEADER 0x00004 /* header must be written on close */
110 	#define TIFF_DIRTYDIRECT 0x00008 /* current directory must be written */
111 	#define TIFF_BUFFERSETUP 0x00010 /* data buffers setup */
112 	#define TIFF_CODERSETUP  0x00020 /* encoder/decoder setup done */
113 	#define TIFF_BEENWRITING 0x00040 /* written 1+ scanlines to file */
114 	#define TIFF_SWAB        0x00080 /* byte swap file information */
115 	#define TIFF_NOBITREV    0x00100 /* inhibit bit reversal logic */
116 	#define TIFF_MYBUFFER    0x00200 /* my raw data buffer; free on close */
117 	#define TIFF_ISTILED     0x00400 /* file is tile, not strip- based */
118 	#define TIFF_MAPPED      0x00800 /* file is mapped into memory */
119 	#define TIFF_POSTENCODE  0x01000 /* need call to postencode routine */
120 	#define TIFF_INSUBIFD    0x02000 /* currently writing a subifd */
121 	#define TIFF_UPSAMPLED   0x04000 /* library is doing data up-sampling */
122 	#define TIFF_STRIPCHOP   0x08000 /* enable strip chopping support */
123 	#define TIFF_HEADERONLY  0x10000 /* read header only, do not process the first directory */
124 	#define TIFF_NOREADRAW   0x20000 /* skip reading of raw uncompressed image data */
125 	#define TIFF_INCUSTOMIFD 0x40000 /* currently writing a custom IFD */
126 	#define TIFF_BIGTIFF     0x80000 /* read/write bigtiff */
127         #define TIFF_BUF4WRITE  0x100000 /* rawcc bytes are for writing */
128         #define TIFF_DIRTYSTRIP 0x200000 /* stripoffsets/stripbytecount dirty*/
129         #define TIFF_PERSAMPLE  0x400000 /* get/set per sample tags as arrays */
130         #define TIFF_BUFFERMMAP 0x800000 /* read buffer (tif_rawdata) points into mmap() memory */
131 	uint64               tif_diroff;       /* file offset of current directory */
132 	uint64               tif_nextdiroff;   /* file offset of following directory */
133 	uint64*              tif_dirlist;      /* list of offsets to already seen directories to prevent IFD looping */
134 	uint16               tif_dirlistsize;  /* number of entires in offset list */
135 	uint16               tif_dirnumber;    /* number of already seen directories */
136 	TIFFDirectory        tif_dir;          /* internal rep of current directory */
137 	TIFFDirectory        tif_customdir;    /* custom IFDs are separated from the main ones */
138 	union {
139 		TIFFHeaderCommon common;
140 		TIFFHeaderClassic classic;
141 		TIFFHeaderBig big;
142 	} tif_header;
143 	uint16               tif_header_size;  /* file's header block and its length */
144 	uint32               tif_row;          /* current scanline */
145 	uint16               tif_curdir;       /* current directory (index) */
146 	uint32               tif_curstrip;     /* current strip for read/write */
147 	uint64               tif_curoff;       /* current offset for read/write */
148 	uint64               tif_dataoff;      /* current offset for writing dir */
149 	/* SubIFD support */
150 	uint16               tif_nsubifd;      /* remaining subifds to write */
151 	uint64               tif_subifdoff;    /* offset for patching SubIFD link */
152 	/* tiling support */
153 	uint32               tif_col;          /* current column (offset by row too) */
154 	uint32               tif_curtile;      /* current tile for read/write */
155 	tmsize_t             tif_tilesize;     /* # of bytes in a tile */
156 	/* compression scheme hooks */
157 	int                  tif_decodestatus;
158 	TIFFBoolMethod       tif_fixuptags;    /* called in TIFFReadDirectory */
159 	TIFFBoolMethod       tif_setupdecode;  /* called once before predecode */
160 	TIFFPreMethod        tif_predecode;    /* pre- row/strip/tile decoding */
161 	TIFFBoolMethod       tif_setupencode;  /* called once before preencode */
162 	int                  tif_encodestatus;
163 	TIFFPreMethod        tif_preencode;    /* pre- row/strip/tile encoding */
164 	TIFFBoolMethod       tif_postencode;   /* post- row/strip/tile encoding */
165 	TIFFCodeMethod       tif_decoderow;    /* scanline decoding routine */
166 	TIFFCodeMethod       tif_encoderow;    /* scanline encoding routine */
167 	TIFFCodeMethod       tif_decodestrip;  /* strip decoding routine */
168 	TIFFCodeMethod       tif_encodestrip;  /* strip encoding routine */
169 	TIFFCodeMethod       tif_decodetile;   /* tile decoding routine */
170 	TIFFCodeMethod       tif_encodetile;   /* tile encoding routine */
171 	TIFFVoidMethod       tif_close;        /* cleanup-on-close routine */
172 	TIFFSeekMethod       tif_seek;         /* position within a strip routine */
173 	TIFFVoidMethod       tif_cleanup;      /* cleanup state routine */
174 	TIFFStripMethod      tif_defstripsize; /* calculate/constrain strip size */
175 	TIFFTileMethod       tif_deftilesize;  /* calculate/constrain tile size */
176 	uint8*               tif_data;         /* compression scheme private data */
177 	/* input/output buffering */
178 	tmsize_t             tif_scanlinesize; /* # of bytes in a scanline */
179 	tmsize_t             tif_scanlineskew; /* scanline skew for reading strips */
180 	uint8*               tif_rawdata;      /* raw data buffer */
181 	tmsize_t             tif_rawdatasize;  /* # of bytes in raw data buffer */
182         tmsize_t             tif_rawdataoff;   /* rawdata offset within strip */
183         tmsize_t             tif_rawdataloaded;/* amount of data in rawdata */
184 	uint8*               tif_rawcp;        /* current spot in raw buffer */
185 	tmsize_t             tif_rawcc;        /* bytes unread from raw buffer */
186 	/* memory-mapped file support */
187 	uint8*               tif_base;         /* base of mapped file */
188 	tmsize_t             tif_size;         /* size of mapped file region (bytes, thus tmsize_t) */
189 	TIFFMapFileProc      tif_mapproc;      /* map file method */
190 	TIFFUnmapFileProc    tif_unmapproc;    /* unmap file method */
191 	/* input/output callback methods */
192 	thandle_t            tif_clientdata;   /* callback parameter */
193 	TIFFReadWriteProc    tif_readproc;     /* read method */
194 	TIFFReadWriteProc    tif_writeproc;    /* write method */
195 	TIFFSeekProc         tif_seekproc;     /* lseek method */
196 	TIFFCloseProc        tif_closeproc;    /* close method */
197 	TIFFSizeProc         tif_sizeproc;     /* filesize method */
198 	/* post-decoding support */
199 	TIFFPostMethod       tif_postdecode;   /* post decoding routine */
200 	/* tag support */
201 	TIFFField**          tif_fields;       /* sorted table of registered tags */
202 	size_t               tif_nfields;      /* # entries in registered tag table */
203 	const TIFFField*     tif_foundfield;   /* cached pointer to already found tag */
204 	TIFFTagMethods       tif_tagmethods;   /* tag get/set/print routines */
205 	TIFFClientInfoLink*  tif_clientinfo;   /* extra client information. */
206 	/* Backward compatibility stuff. We need these two fields for
207 	 * setting up an old tag extension scheme. */
208 	TIFFFieldArray*      tif_fieldscompat;
209 	size_t               tif_nfieldscompat;
210 };
211 
212 #define isPseudoTag(t) (t > 0xffff)            /* is tag value normal or pseudo */
213 
214 #define isTiled(tif) (((tif)->tif_flags & TIFF_ISTILED) != 0)
215 #define isMapped(tif) (((tif)->tif_flags & TIFF_MAPPED) != 0)
216 #define isFillOrder(tif, o) (((tif)->tif_flags & (o)) != 0)
217 #define isUpSampled(tif) (((tif)->tif_flags & TIFF_UPSAMPLED) != 0)
218 #define TIFFReadFile(tif, buf, size) \
219 	((*(tif)->tif_readproc)((tif)->tif_clientdata,(buf),(size)))
220 #define TIFFWriteFile(tif, buf, size) \
221 	((*(tif)->tif_writeproc)((tif)->tif_clientdata,(buf),(size)))
222 #define TIFFSeekFile(tif, off, whence) \
223 	((*(tif)->tif_seekproc)((tif)->tif_clientdata,(off),(whence)))
224 #define TIFFCloseFile(tif) \
225 	((*(tif)->tif_closeproc)((tif)->tif_clientdata))
226 #define TIFFGetFileSize(tif) \
227 	((*(tif)->tif_sizeproc)((tif)->tif_clientdata))
228 #define TIFFMapFileContents(tif, paddr, psize) \
229 	((*(tif)->tif_mapproc)((tif)->tif_clientdata,(paddr),(psize)))
230 #define TIFFUnmapFileContents(tif, addr, size) \
231 	((*(tif)->tif_unmapproc)((tif)->tif_clientdata,(addr),(size)))
232 
233 /*
234  * Default Read/Seek/Write definitions.
235  */
236 #ifndef ReadOK
237 #define ReadOK(tif, buf, size) \
238 	(TIFFReadFile((tif),(buf),(size))==(size))
239 #endif
240 #ifndef SeekOK
241 #define SeekOK(tif, off) \
242 	(TIFFSeekFile((tif),(off),SEEK_SET)==(off))
243 #endif
244 #ifndef WriteOK
245 #define WriteOK(tif, buf, size) \
246 	(TIFFWriteFile((tif),(buf),(size))==(size))
247 #endif
248 
249 /* NB: the uint32 casts are to silence certain ANSI-C compilers */
250 #define TIFFhowmany_32(x, y) (((uint32)x < (0xffffffff - (uint32)(y-1))) ? \
251 			   ((((uint32)(x))+(((uint32)(y))-1))/((uint32)(y))) : \
252 			   0U)
253 #define TIFFhowmany8_32(x) (((x)&0x07)?((uint32)(x)>>3)+1:(uint32)(x)>>3)
254 #define TIFFroundup_32(x, y) (TIFFhowmany_32(x,y)*(y))
255 #define TIFFhowmany_64(x, y) ((((uint64)(x))+(((uint64)(y))-1))/((uint64)(y)))
256 #define TIFFhowmany8_64(x) (((x)&0x07)?((uint64)(x)>>3)+1:(uint64)(x)>>3)
257 #define TIFFroundup_64(x, y) (TIFFhowmany_64(x,y)*(y))
258 
259 /* Safe multiply which returns zero if there is an integer overflow */
260 #define TIFFSafeMultiply(t,v,m) ((((t)(m) != (t)0) && (((t)(((v)*(m))/(m))) == (t)(v))) ? (t)((v)*(m)) : (t)0)
261 
262 #define TIFFmax(A,B) ((A)>(B)?(A):(B))
263 #define TIFFmin(A,B) ((A)<(B)?(A):(B))
264 
265 #define TIFFArrayCount(a) (sizeof (a) / sizeof ((a)[0]))
266 
267 /*
268   Support for large files.
269 
270   Windows read/write APIs support only 'unsigned int' rather than 'size_t'.
271   Windows off_t is only 32-bit, even in 64-bit builds.
272 */
273 #if defined(HAVE_FSEEKO)
274 /*
275   Use fseeko() and ftello() if they are available since they use
276   'off_t' rather than 'long'.  It is wrong to use fseeko() and
277   ftello() only on systems with special LFS support since some systems
278   (e.g. FreeBSD) support a 64-bit off_t by default.
279 
280   For MinGW, __MSVCRT_VERSION__ must be at least 0x800 to expose these
281   interfaces. The MinGW compiler must support the requested version.  MinGW
282   does not distribute the CRT (it is supplied by Microsoft) so the correct CRT
283   must be available on the target computer in order for the program to run.
284 */
285 #if defined(HAVE_FSEEKO)
286 #  define fseek(stream,offset,whence)  fseeko(stream,offset,whence)
287 #  define ftell(stream,offset,whence)  ftello(stream,offset,whence)
288 #endif
289 #endif
290 #if defined(__WIN32__) && \
291         !(defined(_MSC_VER) && _MSC_VER < 1400) && \
292         !(defined(__MSVCRT_VERSION__) && __MSVCRT_VERSION__ < 0x800)
293 typedef unsigned int TIFFIOSize_t;
294 #define _TIFF_lseek_f(fildes,offset,whence)  _lseeki64(fildes,/* __int64 */ offset,whence)
295 /* #define _TIFF_tell_f(fildes) /\* __int64 *\/ _telli64(fildes) */
296 #define _TIFF_fseek_f(stream,offset,whence) _fseeki64(stream,/* __int64 */ offset,whence)
297 #define _TIFF_fstat_f(fildes,stat_buff) _fstati64(fildes,/* struct _stati64 */ stat_buff)
298 /* #define _TIFF_ftell_f(stream) /\* __int64 *\/ _ftelli64(stream) */
299 /* #define _TIFF_stat_f(path,stat_buff) _stati64(path,/\* struct _stati64 *\/ stat_buff) */
300 #define _TIFF_stat_s struct _stati64
301 #define _TIFF_off_t __int64
302 #else
303 typedef size_t TIFFIOSize_t;
304 #define _TIFF_lseek_f(fildes,offset,whence) lseek(fildes,offset,whence)
305 /* #define _TIFF_tell_f(fildes) (_TIFF_lseek_f(fildes,0,SEEK_CUR)) */
306 #define _TIFF_fseek_f(stream,offset,whence) fseek(stream,offset,whence)
307 #define _TIFF_fstat_f(fildes,stat_buff) fstat(fildes,stat_buff)
308 /* #define _TIFF_ftell_f(stream) ftell(stream) */
309 /* #define _TIFF_stat_f(path,stat_buff) stat(path,stat_buff) */
310 #define _TIFF_stat_s struct stat
311 #define _TIFF_off_t off_t
312 #endif
313 
314 #if defined(__cplusplus)
315 extern "C" {
316 #endif
317 extern int _TIFFgetMode(const char* mode, const char* module);
318 extern int _TIFFNoRowEncode(TIFF* tif, uint8* pp, tmsize_t cc, uint16 s);
319 extern int _TIFFNoStripEncode(TIFF* tif, uint8* pp, tmsize_t cc, uint16 s);
320 extern int _TIFFNoTileEncode(TIFF*, uint8* pp, tmsize_t cc, uint16 s);
321 extern int _TIFFNoRowDecode(TIFF* tif, uint8* pp, tmsize_t cc, uint16 s);
322 extern int _TIFFNoStripDecode(TIFF* tif, uint8* pp, tmsize_t cc, uint16 s);
323 extern int _TIFFNoTileDecode(TIFF*, uint8* pp, tmsize_t cc, uint16 s);
324 extern void _TIFFNoPostDecode(TIFF* tif, uint8* buf, tmsize_t cc);
325 extern int _TIFFNoPreCode(TIFF* tif, uint16 s);
326 extern int _TIFFNoSeek(TIFF* tif, uint32 off);
327 extern void _TIFFSwab16BitData(TIFF* tif, uint8* buf, tmsize_t cc);
328 extern void _TIFFSwab24BitData(TIFF* tif, uint8* buf, tmsize_t cc);
329 extern void _TIFFSwab32BitData(TIFF* tif, uint8* buf, tmsize_t cc);
330 extern void _TIFFSwab64BitData(TIFF* tif, uint8* buf, tmsize_t cc);
331 extern int TIFFFlushData1(TIFF* tif);
332 extern int TIFFDefaultDirectory(TIFF* tif);
333 extern void _TIFFSetDefaultCompressionState(TIFF* tif);
334 extern int _TIFFRewriteField(TIFF *, uint16, TIFFDataType, tmsize_t, void *);
335 extern int TIFFSetCompressionScheme(TIFF* tif, int scheme);
336 extern int TIFFSetDefaultCompressionState(TIFF* tif);
337 extern uint32 _TIFFDefaultStripSize(TIFF* tif, uint32 s);
338 extern void _TIFFDefaultTileSize(TIFF* tif, uint32* tw, uint32* th);
339 extern int _TIFFDataSize(TIFFDataType type);
340 
341 extern void _TIFFsetByteArray(void**, void*, uint32);
342 extern void _TIFFsetString(char**, char*);
343 extern void _TIFFsetShortArray(uint16**, uint16*, uint32);
344 extern void _TIFFsetLongArray(uint32**, uint32*, uint32);
345 extern void _TIFFsetFloatArray(float**, float*, uint32);
346 extern void _TIFFsetDoubleArray(double**, double*, uint32);
347 
348 extern void _TIFFprintAscii(FILE*, const char*);
349 extern void _TIFFprintAsciiTag(FILE*, const char*, const char*);
350 
351 extern TIFFErrorHandler _TIFFwarningHandler;
352 extern TIFFErrorHandler _TIFFerrorHandler;
353 extern TIFFErrorHandlerExt _TIFFwarningHandlerExt;
354 extern TIFFErrorHandlerExt _TIFFerrorHandlerExt;
355 
356 extern uint32 _TIFFMultiply32(TIFF*, uint32, uint32, const char*);
357 extern uint64 _TIFFMultiply64(TIFF*, uint64, uint64, const char*);
358 extern void* _TIFFCheckMalloc(TIFF*, tmsize_t, tmsize_t, const char*);
359 extern void* _TIFFCheckRealloc(TIFF*, void*, tmsize_t, tmsize_t, const char*);
360 
361 extern double _TIFFUInt64ToDouble(uint64);
362 extern float _TIFFUInt64ToFloat(uint64);
363 
364 extern int TIFFInitDumpMode(TIFF*, int);
365 #ifdef PACKBITS_SUPPORT
366 extern int TIFFInitPackBits(TIFF*, int);
367 #endif
368 #ifdef CCITT_SUPPORT
369 extern int TIFFInitCCITTRLE(TIFF*, int), TIFFInitCCITTRLEW(TIFF*, int);
370 extern int TIFFInitCCITTFax3(TIFF*, int), TIFFInitCCITTFax4(TIFF*, int);
371 #endif
372 #ifdef THUNDER_SUPPORT
373 extern int TIFFInitThunderScan(TIFF*, int);
374 #endif
375 #ifdef NEXT_SUPPORT
376 extern int TIFFInitNeXT(TIFF*, int);
377 #endif
378 #ifdef LZW_SUPPORT
379 extern int TIFFInitLZW(TIFF*, int);
380 #endif
381 #ifdef OJPEG_SUPPORT
382 extern int TIFFInitOJPEG(TIFF*, int);
383 #endif
384 #ifdef JPEG_SUPPORT
385 extern int TIFFInitJPEG(TIFF*, int);
386 #endif
387 #ifdef JBIG_SUPPORT
388 extern int TIFFInitJBIG(TIFF*, int);
389 #endif
390 #ifdef ZIP_SUPPORT
391 extern int TIFFInitZIP(TIFF*, int);
392 #endif
393 #ifdef PIXARLOG_SUPPORT
394 extern int TIFFInitPixarLog(TIFF*, int);
395 #endif
396 #ifdef LOGLUV_SUPPORT
397 extern int TIFFInitSGILog(TIFF*, int);
398 #endif
399 #ifdef LZMA_SUPPORT
400 extern int TIFFInitLZMA(TIFF*, int);
401 #endif
402 #ifdef VMS
403 extern const TIFFCodec _TIFFBuiltinCODECS[];
404 #else
405 extern TIFFCodec _TIFFBuiltinCODECS[];
406 #endif
407 
408 #if defined(__cplusplus)
409 }
410 #endif
411 #endif /* _TIFFIOP_ */
412 
413 /* vim: set ts=8 sts=8 sw=8 noet: */
414 /*
415  * Local Variables:
416  * mode: c
417  * c-basic-offset: 8
418  * fill-column: 78
419  * End:
420  */
421