1/* $Id: tiffiop.h 290 2010-07-08 08:53:05Z nijtmans $ */ 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 56extern void *lfind(const void *, const void *, size_t *, size_t, 57 int (*)(const void *, const void *)); 58#endif 59 60#if 0 61/* 62 Libtiff itself does not require a 64-bit type, but bundled TIFF 63 utilities may use it. 64*/ 65typedef TIFF_INT64_T int64; 66typedef TIFF_UINT64_T uint64; 67#endif 68 69#include "tiffio.h" 70#include "tif_dir.h" 71 72#ifndef STRIP_SIZE_DEFAULT 73# define STRIP_SIZE_DEFAULT 8192 74#endif 75 76#define streq(a,b) (strcmp(a,b) == 0) 77 78#ifndef TRUE 79#define TRUE 1 80#define FALSE 0 81#endif 82 83typedef struct client_info { 84 struct client_info *next; 85 void *data; 86 char *name; 87} TIFFClientInfoLink; 88 89/* 90 * Typedefs for ``method pointers'' used internally. 91 */ 92typedef unsigned char tidataval_t; /* internal image data value type */ 93typedef tidataval_t* tidata_t; /* reference to internal image data */ 94 95typedef void (*TIFFVoidMethod)(TIFF*); 96typedef int (*TIFFBoolMethod)(TIFF*); 97typedef int (*TIFFPreMethod)(TIFF*, tsample_t); 98typedef int (*TIFFCodeMethod)(TIFF*, tidata_t, tsize_t, tsample_t); 99typedef int (*TIFFSeekMethod)(TIFF*, uint32); 100typedef void (*TIFFPostMethod)(TIFF*, tidata_t, tsize_t); 101typedef uint32 (*TIFFStripMethod)(TIFF*, uint32); 102typedef void (*TIFFTileMethod)(TIFF*, uint32*, uint32*); 103 104struct tiff { 105 char* tif_name; /* name of open file */ 106 int tif_fd; /* open file descriptor */ 107 int tif_mode; /* open mode (O_*) */ 108 uint32 tif_flags; 109#define TIFF_FILLORDER 0x00003 /* natural bit fill order for machine */ 110#define TIFF_DIRTYHEADER 0x00004 /* header must be written on close */ 111#define TIFF_DIRTYDIRECT 0x00008 /* current directory must be written */ 112#define TIFF_BUFFERSETUP 0x00010 /* data buffers setup */ 113#define TIFF_CODERSETUP 0x00020 /* encoder/decoder setup done */ 114#define TIFF_BEENWRITING 0x00040 /* written 1+ scanlines to file */ 115#define TIFF_SWAB 0x00080 /* byte swap file information */ 116#define TIFF_NOBITREV 0x00100 /* inhibit bit reversal logic */ 117#define TIFF_MYBUFFER 0x00200 /* my raw data buffer; free on close */ 118#define TIFF_ISTILED 0x00400 /* file is tile, not strip- based */ 119#define TIFF_MAPPED 0x00800 /* file is mapped into memory */ 120#define TIFF_POSTENCODE 0x01000 /* need call to postencode routine */ 121#define TIFF_INSUBIFD 0x02000 /* currently writing a subifd */ 122#define TIFF_UPSAMPLED 0x04000 /* library is doing data up-sampling */ 123#define TIFF_STRIPCHOP 0x08000 /* enable strip chopping support */ 124#define TIFF_HEADERONLY 0x10000 /* read header only, do not process */ 125 /* the first directory */ 126#define TIFF_NOREADRAW 0x20000 /* skip reading of raw uncompressed */ 127 /* image data */ 128#define TIFF_INCUSTOMIFD 0x40000 /* currently writing a custom IFD */ 129 toff_t tif_diroff; /* file offset of current directory */ 130 toff_t tif_nextdiroff; /* file offset of following directory */ 131 toff_t* tif_dirlist; /* list of offsets to already seen */ 132 /* directories to prevent IFD looping */ 133 tsize_t tif_dirlistsize;/* number of entires in offset list */ 134 uint16 tif_dirnumber; /* number of already seen directories */ 135 TIFFDirectory tif_dir; /* internal rep of current directory */ 136 TIFFDirectory tif_customdir; /* custom IFDs are separated from 137 the main ones */ 138 TIFFHeader tif_header; /* file's header block */ 139 const int* tif_typeshift; /* data type shift counts */ 140 const long* tif_typemask; /* data type masks */ 141 uint32 tif_row; /* current scanline */ 142 tdir_t tif_curdir; /* current directory (index) */ 143 tstrip_t tif_curstrip; /* current strip for read/write */ 144 toff_t tif_curoff; /* current offset for read/write */ 145 toff_t tif_dataoff; /* current offset for writing dir */ 146/* SubIFD support */ 147 uint16 tif_nsubifd; /* remaining subifds to write */ 148 toff_t tif_subifdoff; /* offset for patching SubIFD link */ 149/* tiling support */ 150 uint32 tif_col; /* current column (offset by row too) */ 151 ttile_t tif_curtile; /* current tile for read/write */ 152 tsize_t tif_tilesize; /* # of bytes in a tile */ 153/* compression scheme hooks */ 154 int tif_decodestatus; 155 TIFFBoolMethod tif_setupdecode;/* called once before predecode */ 156 TIFFPreMethod tif_predecode; /* pre- row/strip/tile decoding */ 157 TIFFBoolMethod tif_setupencode;/* called once before preencode */ 158 int tif_encodestatus; 159 TIFFPreMethod tif_preencode; /* pre- row/strip/tile encoding */ 160 TIFFBoolMethod tif_postencode; /* post- row/strip/tile encoding */ 161 TIFFCodeMethod tif_decoderow; /* scanline decoding routine */ 162 TIFFCodeMethod tif_encoderow; /* scanline encoding routine */ 163 TIFFCodeMethod tif_decodestrip;/* strip decoding routine */ 164 TIFFCodeMethod tif_encodestrip;/* strip encoding routine */ 165 TIFFCodeMethod tif_decodetile; /* tile decoding routine */ 166 TIFFCodeMethod tif_encodetile; /* tile encoding routine */ 167 TIFFVoidMethod tif_close; /* cleanup-on-close routine */ 168 TIFFSeekMethod tif_seek; /* position within a strip routine */ 169 TIFFVoidMethod tif_cleanup; /* cleanup state routine */ 170 TIFFStripMethod tif_defstripsize;/* calculate/constrain strip size */ 171 TIFFTileMethod tif_deftilesize;/* calculate/constrain tile size */ 172 tidata_t tif_data; /* compression scheme private data */ 173/* input/output buffering */ 174 tsize_t tif_scanlinesize;/* # of bytes in a scanline */ 175 tsize_t tif_scanlineskew;/* scanline skew for reading strips */ 176 tidata_t tif_rawdata; /* raw data buffer */ 177 tsize_t tif_rawdatasize;/* # of bytes in raw data buffer */ 178 tidata_t tif_rawcp; /* current spot in raw buffer */ 179 tsize_t tif_rawcc; /* bytes unread from raw buffer */ 180/* memory-mapped file support */ 181 tidata_t tif_base; /* base of mapped file */ 182 toff_t tif_size; /* size of mapped file region (bytes) 183 FIXME: it should be tsize_t */ 184 TIFFMapFileProc tif_mapproc; /* map file method */ 185 TIFFUnmapFileProc tif_unmapproc;/* unmap file method */ 186/* input/output callback methods */ 187 thandle_t tif_clientdata; /* callback parameter */ 188 TIFFReadWriteProc tif_readproc; /* read method */ 189 TIFFReadWriteProc tif_writeproc;/* write method */ 190 TIFFSeekProc tif_seekproc; /* lseek method */ 191 TIFFCloseProc tif_closeproc; /* close method */ 192 TIFFSizeProc tif_sizeproc; /* filesize method */ 193/* post-decoding support */ 194 TIFFPostMethod tif_postdecode; /* post decoding routine */ 195/* tag support */ 196 TIFFFieldInfo** tif_fieldinfo; /* sorted table of registered tags */ 197 size_t tif_nfields; /* # entries in registered tag table */ 198 const TIFFFieldInfo *tif_foundfield;/* cached pointer to already found tag */ 199 TIFFTagMethods tif_tagmethods; /* tag get/set/print routines */ 200 TIFFClientInfoLink *tif_clientinfo; /* extra client information. */ 201}; 202 203#define isPseudoTag(t) (t > 0xffff) /* is tag value normal or pseudo */ 204 205#define isTiled(tif) (((tif)->tif_flags & TIFF_ISTILED) != 0) 206#define isMapped(tif) (((tif)->tif_flags & TIFF_MAPPED) != 0) 207#define isFillOrder(tif, o) (((tif)->tif_flags & (o)) != 0) 208#define isUpSampled(tif) (((tif)->tif_flags & TIFF_UPSAMPLED) != 0) 209#define TIFFReadFile(tif, buf, size) \ 210 ((*(tif)->tif_readproc)((tif)->tif_clientdata,buf,size)) 211#define TIFFWriteFile(tif, buf, size) \ 212 ((*(tif)->tif_writeproc)((tif)->tif_clientdata,buf,size)) 213#define TIFFSeekFile(tif, off, whence) \ 214 ((*(tif)->tif_seekproc)((tif)->tif_clientdata,(toff_t)(off),whence)) 215#define TIFFCloseFile(tif) \ 216 ((*(tif)->tif_closeproc)((tif)->tif_clientdata)) 217#define TIFFGetFileSize(tif) \ 218 ((*(tif)->tif_sizeproc)((tif)->tif_clientdata)) 219#define TIFFMapFileContents(tif, paddr, psize) \ 220 ((*(tif)->tif_mapproc)((tif)->tif_clientdata,paddr,psize)) 221#define TIFFUnmapFileContents(tif, addr, size) \ 222 ((*(tif)->tif_unmapproc)((tif)->tif_clientdata,addr,size)) 223 224/* 225 * Default Read/Seek/Write definitions. 226 */ 227#ifndef ReadOK 228#define ReadOK(tif, buf, size) \ 229 (TIFFReadFile(tif, (tdata_t) buf, (tsize_t)(size)) == (tsize_t)(size)) 230#endif 231#ifndef SeekOK 232#define SeekOK(tif, off) \ 233 (TIFFSeekFile(tif, (toff_t) off, SEEK_SET) == (toff_t) off) 234#endif 235#ifndef WriteOK 236#define WriteOK(tif, buf, size) \ 237 (TIFFWriteFile(tif, (tdata_t) buf, (tsize_t) size) == (tsize_t) size) 238#endif 239 240/* NB: the uint32 casts are to silence certain ANSI-C compilers */ 241#define TIFFhowmany(x, y) (((uint32)x < (0xffffffff - (uint32)(y-1))) ? \ 242 ((((uint32)(x))+(((uint32)(y))-1))/((uint32)(y))) : \ 243 0U) 244#define TIFFhowmany8(x) (((x)&0x07)?((uint32)(x)>>3)+1:(uint32)(x)>>3) 245#define TIFFroundup(x, y) (TIFFhowmany(x,y)*(y)) 246 247/* Safe multiply which returns zero if there is an integer overflow */ 248#define TIFFSafeMultiply(t,v,m) ((((t)m != (t)0) && (((t)((v*m)/m)) == (t)v)) ? (t)(v*m) : (t)0) 249 250#define TIFFmax(A,B) ((A)>(B)?(A):(B)) 251#define TIFFmin(A,B) ((A)<(B)?(A):(B)) 252 253#define TIFFArrayCount(a) (sizeof (a) / sizeof ((a)[0])) 254 255#if defined(__cplusplus) 256extern "C" { 257#endif 258extern int _TIFFgetMode(const char*, const char*); 259extern int _TIFFNoRowEncode(TIFF*, tidata_t, tsize_t, tsample_t); 260extern int _TIFFNoStripEncode(TIFF*, tidata_t, tsize_t, tsample_t); 261extern int _TIFFNoTileEncode(TIFF*, tidata_t, tsize_t, tsample_t); 262extern int _TIFFNoRowDecode(TIFF*, tidata_t, tsize_t, tsample_t); 263extern int _TIFFNoStripDecode(TIFF*, tidata_t, tsize_t, tsample_t); 264extern int _TIFFNoTileDecode(TIFF*, tidata_t, tsize_t, tsample_t); 265extern void _TIFFNoPostDecode(TIFF*, tidata_t, tsize_t); 266extern int _TIFFNoPreCode (TIFF*, tsample_t); 267extern int _TIFFNoSeek(TIFF*, uint32); 268extern void _TIFFSwab16BitData(TIFF*, tidata_t, tsize_t); 269extern void _TIFFSwab24BitData(TIFF*, tidata_t, tsize_t); 270extern void _TIFFSwab32BitData(TIFF*, tidata_t, tsize_t); 271extern void _TIFFSwab64BitData(TIFF*, tidata_t, tsize_t); 272extern int TIFFFlushData1(TIFF*); 273extern int TIFFDefaultDirectory(TIFF*); 274extern void _TIFFSetDefaultCompressionState(TIFF*); 275extern int TIFFSetCompressionScheme(TIFF*, int); 276extern int TIFFSetDefaultCompressionState(TIFF*); 277extern uint32 _TIFFDefaultStripSize(TIFF*, uint32); 278extern void _TIFFDefaultTileSize(TIFF*, uint32*, uint32*); 279extern int _TIFFDataSize(TIFFDataType); 280 281extern void _TIFFsetByteArray(void**, void*, uint32); 282extern void _TIFFsetString(char**, char*); 283extern void _TIFFsetShortArray(uint16**, uint16*, uint32); 284extern void _TIFFsetLongArray(uint32**, uint32*, uint32); 285extern void _TIFFsetFloatArray(float**, float*, uint32); 286extern void _TIFFsetDoubleArray(double**, double*, uint32); 287 288extern void _TIFFprintAscii(FILE*, const char*); 289extern void _TIFFprintAsciiTag(FILE*, const char*, const char*); 290 291extern TIFFErrorHandler _TIFFwarningHandler; 292extern TIFFErrorHandler _TIFFerrorHandler; 293extern TIFFErrorHandlerExt _TIFFwarningHandlerExt; 294extern TIFFErrorHandlerExt _TIFFerrorHandlerExt; 295 296extern tdata_t _TIFFCheckMalloc(TIFF*, size_t, size_t, const char*); 297extern tdata_t _TIFFCheckRealloc(TIFF*, tdata_t, size_t, size_t, const char*); 298 299extern int TIFFInitDumpMode(TIFF*, int); 300#ifdef PACKBITS_SUPPORT 301extern int TIFFInitPackBits(TIFF*, int); 302#endif 303#ifdef CCITT_SUPPORT 304extern int TIFFInitCCITTRLE(TIFF*, int), TIFFInitCCITTRLEW(TIFF*, int); 305extern int TIFFInitCCITTFax3(TIFF*, int), TIFFInitCCITTFax4(TIFF*, int); 306#endif 307#ifdef THUNDER_SUPPORT 308extern int TIFFInitThunderScan(TIFF*, int); 309#endif 310#ifdef NEXT_SUPPORT 311extern int TIFFInitNeXT(TIFF*, int); 312#endif 313#ifdef LZW_SUPPORT 314extern int TIFFInitLZW(TIFF*, int); 315#endif 316#ifdef OJPEG_SUPPORT 317extern int TIFFInitOJPEG(TIFF*, int); 318#endif 319#ifdef JPEG_SUPPORT 320extern int TIFFInitJPEG(TIFF*, int); 321#endif 322#ifdef JBIG_SUPPORT 323extern int TIFFInitJBIG(TIFF*, int); 324#endif 325#ifdef ZIP_SUPPORT 326extern int TIFFInitZIP(TIFF*, int); 327#endif 328#ifdef PIXARLOG_SUPPORT 329extern int TIFFInitPixarLog(TIFF*, int); 330#endif 331#ifdef LOGLUV_SUPPORT 332extern int TIFFInitSGILog(TIFF*, int); 333#endif 334#ifdef VMS 335extern const TIFFCodec _TIFFBuiltinCODECS[]; 336#else 337extern TIFFCodec _TIFFBuiltinCODECS[]; 338#endif 339 340#if defined(__cplusplus) 341} 342#endif 343#endif /* _TIFFIOP_ */ 344 345/* vim: set ts=8 sts=8 sw=8 noet: */ 346/* 347 * Local Variables: 348 * mode: c 349 * c-basic-offset: 8 350 * fill-column: 78 351 * End: 352 */ 353