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