Update to 2.0.0 tree from current Fremantle build
[opencv] / 3rdparty / libtiff / tif_tile.c
1 /* $Id: tif_tile.c,v 1.1 2005-06-17 13:54:52 vp153 Exp $ */
2
3 /*
4  * Copyright (c) 1991-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 /*
28  * TIFF Library.
29  *
30  * Tiled Image Support Routines.
31  */
32 #include "tiffiop.h"
33
34 static uint32
35 summarize(TIFF* tif, size_t summand1, size_t summand2, const char* where)
36 {
37         /*
38          * XXX: We are using casting to uint32 here, bacause sizeof(size_t)
39          * may be larger than sizeof(uint32) on 64-bit architectures.
40          */
41         uint32  bytes = summand1 + summand2;
42
43         if (bytes - summand1 != summand2) {
44                 TIFFError(tif->tif_name, "Integer overflow in %s", where);
45                 bytes = 0;
46         }
47
48         return (bytes);
49 }
50
51 static uint32
52 multiply(TIFF* tif, size_t nmemb, size_t elem_size, const char* where)
53 {
54         uint32  bytes = nmemb * elem_size;
55
56         if (elem_size && bytes / elem_size != nmemb) {
57                 TIFFError(tif->tif_name, "Integer overflow in %s", where);
58                 bytes = 0;
59         }
60
61         return (bytes);
62 }
63
64 /*
65  * Compute which tile an (x,y,z,s) value is in.
66  */
67 ttile_t
68 TIFFComputeTile(TIFF* tif, uint32 x, uint32 y, uint32 z, tsample_t s)
69 {
70         TIFFDirectory *td = &tif->tif_dir;
71         uint32 dx = td->td_tilewidth;
72         uint32 dy = td->td_tilelength;
73         uint32 dz = td->td_tiledepth;
74         ttile_t tile = 1;
75
76         if (td->td_imagedepth == 1)
77                 z = 0;
78         if (dx == (uint32) -1)
79                 dx = td->td_imagewidth;
80         if (dy == (uint32) -1)
81                 dy = td->td_imagelength;
82         if (dz == (uint32) -1)
83                 dz = td->td_imagedepth;
84         if (dx != 0 && dy != 0 && dz != 0) {
85                 uint32 xpt = TIFFhowmany(td->td_imagewidth, dx); 
86                 uint32 ypt = TIFFhowmany(td->td_imagelength, dy); 
87                 uint32 zpt = TIFFhowmany(td->td_imagedepth, dz); 
88
89                 if (td->td_planarconfig == PLANARCONFIG_SEPARATE) 
90                         tile = (xpt*ypt*zpt)*s +
91                              (xpt*ypt)*(z/dz) +
92                              xpt*(y/dy) +
93                              x/dx;
94                 else
95                         tile = (xpt*ypt)*(z/dz) + xpt*(y/dy) + x/dx;
96         }
97         return (tile);
98 }
99
100 /*
101  * Check an (x,y,z,s) coordinate
102  * against the image bounds.
103  */
104 int
105 TIFFCheckTile(TIFF* tif, uint32 x, uint32 y, uint32 z, tsample_t s)
106 {
107         TIFFDirectory *td = &tif->tif_dir;
108
109         if (x >= td->td_imagewidth) {
110                 TIFFError(tif->tif_name, "%lu: Col out of range, max %lu",
111                     (unsigned long) x, (unsigned long) td->td_imagewidth);
112                 return (0);
113         }
114         if (y >= td->td_imagelength) {
115                 TIFFError(tif->tif_name, "%lu: Row out of range, max %lu",
116                     (unsigned long) y, (unsigned long) td->td_imagelength);
117                 return (0);
118         }
119         if (z >= td->td_imagedepth) {
120                 TIFFError(tif->tif_name, "%lu: Depth out of range, max %lu",
121                     (unsigned long) z, (unsigned long) td->td_imagedepth);
122                 return (0);
123         }
124         if (td->td_planarconfig == PLANARCONFIG_SEPARATE &&
125             s >= td->td_samplesperpixel) {
126                 TIFFError(tif->tif_name, "%lu: Sample out of range, max %lu",
127                     (unsigned long) s, (unsigned long) td->td_samplesperpixel);
128                 return (0);
129         }
130         return (1);
131 }
132
133 /*
134  * Compute how many tiles are in an image.
135  */
136 ttile_t
137 TIFFNumberOfTiles(TIFF* tif)
138 {
139         TIFFDirectory *td = &tif->tif_dir;
140         uint32 dx = td->td_tilewidth;
141         uint32 dy = td->td_tilelength;
142         uint32 dz = td->td_tiledepth;
143         ttile_t ntiles;
144
145         if (dx == (uint32) -1)
146                 dx = td->td_imagewidth;
147         if (dy == (uint32) -1)
148                 dy = td->td_imagelength;
149         if (dz == (uint32) -1)
150                 dz = td->td_imagedepth;
151         ntiles = (dx == 0 || dy == 0 || dz == 0) ? 0 :
152             multiply(tif, multiply(tif, TIFFhowmany(td->td_imagewidth, dx),
153                                    TIFFhowmany(td->td_imagelength, dy),
154                                    "TIFFNumberOfTiles"),
155                      TIFFhowmany(td->td_imagedepth, dz), "TIFFNumberOfTiles");
156         if (td->td_planarconfig == PLANARCONFIG_SEPARATE)
157                 ntiles = multiply(tif, ntiles, td->td_samplesperpixel,
158                                   "TIFFNumberOfTiles");
159         return (ntiles);
160 }
161
162 /*
163  * Compute the # bytes in each row of a tile.
164  */
165 tsize_t
166 TIFFTileRowSize(TIFF* tif)
167 {
168         TIFFDirectory *td = &tif->tif_dir;
169         tsize_t rowsize;
170         
171         if (td->td_tilelength == 0 || td->td_tilewidth == 0)
172                 return ((tsize_t) 0);
173         rowsize = multiply(tif, td->td_bitspersample, td->td_tilewidth,
174                            "TIFFTileRowSize");
175         if (td->td_planarconfig == PLANARCONFIG_CONTIG)
176                 rowsize = multiply(tif, rowsize, td->td_samplesperpixel,
177                                    "TIFFTileRowSize");
178         return ((tsize_t) TIFFhowmany8(rowsize));
179 }
180
181 /*
182  * Compute the # bytes in a variable length, row-aligned tile.
183  */
184 tsize_t
185 TIFFVTileSize(TIFF* tif, uint32 nrows)
186 {
187         TIFFDirectory *td = &tif->tif_dir;
188         tsize_t tilesize;
189
190         if (td->td_tilelength == 0 || td->td_tilewidth == 0 ||
191             td->td_tiledepth == 0)
192                 return ((tsize_t) 0);
193         if (td->td_planarconfig == PLANARCONFIG_CONTIG &&
194             td->td_photometric == PHOTOMETRIC_YCBCR &&
195             !isUpSampled(tif)) {
196                 /*
197                  * Packed YCbCr data contain one Cb+Cr for every
198                  * HorizontalSampling*VerticalSampling Y values.
199                  * Must also roundup width and height when calculating
200                  * since images that are not a multiple of the
201                  * horizontal/vertical subsampling area include
202                  * YCbCr data for the extended image.
203                  */
204                 tsize_t w =
205                     TIFFroundup(td->td_tilewidth, td->td_ycbcrsubsampling[0]);
206                 tsize_t rowsize =
207                     TIFFhowmany8(multiply(tif, w, td->td_bitspersample,
208                                           "TIFFVTileSize"));
209                 tsize_t samplingarea =
210                     td->td_ycbcrsubsampling[0]*td->td_ycbcrsubsampling[1];
211                 if (samplingarea == 0) {
212                         TIFFError(tif->tif_name, "Invalid YCbCr subsampling");
213                         return 0;
214                 }
215                 nrows = TIFFroundup(nrows, td->td_ycbcrsubsampling[1]);
216                 /* NB: don't need TIFFhowmany here 'cuz everything is rounded */
217                 tilesize = multiply(tif, nrows, rowsize, "TIFFVTileSize");
218                 tilesize = summarize(tif, tilesize,
219                                      multiply(tif, 2, tilesize / samplingarea,
220                                               "TIFFVTileSize"),
221                                      "TIFFVTileSize");
222         } else
223                 tilesize = multiply(tif, nrows, TIFFTileRowSize(tif),
224                                     "TIFFVTileSize");
225         return ((tsize_t)
226             multiply(tif, tilesize, td->td_tiledepth, "TIFFVTileSize"));
227 }
228
229 /*
230  * Compute the # bytes in a row-aligned tile.
231  */
232 tsize_t
233 TIFFTileSize(TIFF* tif)
234 {
235         return (TIFFVTileSize(tif, tif->tif_dir.td_tilelength));
236 }
237
238 /*
239  * Compute a default tile size based on the image
240  * characteristics and a requested value.  If a
241  * request is <1 then we choose a size according
242  * to certain heuristics.
243  */
244 void
245 TIFFDefaultTileSize(TIFF* tif, uint32* tw, uint32* th)
246 {
247         (*tif->tif_deftilesize)(tif, tw, th);
248 }
249
250 void
251 _TIFFDefaultTileSize(TIFF* tif, uint32* tw, uint32* th)
252 {
253         (void) tif;
254         if (*(int32*) tw < 1)
255                 *tw = 256;
256         if (*(int32*) th < 1)
257                 *th = 256;
258         /* roundup to a multiple of 16 per the spec */
259         if (*tw & 0xf)
260                 *tw = TIFFroundup(*tw, 16);
261         if (*th & 0xf)
262                 *th = TIFFroundup(*th, 16);
263 }
264
265 /* vim: set ts=8 sts=8 sw=8 noet: */