move debug flag into its own global var (G.debug), split up debug options.
[blender.git] / source / blender / imbuf / intern / tiff.c
1 /*
2  * tiff.c
3  *
4  * 
5  * ***** BEGIN GPL LICENSE BLOCK *****
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  * Contributor(s): Jonathan Merritt.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/imbuf/intern/tiff.c
27  *  \ingroup imbuf
28  */
29
30
31 /**
32  * Provides TIFF file loading and saving for Blender, via libtiff.
33  *
34  * The task of loading is complicated somewhat by the fact that Blender has
35  * already loaded the file into a memory buffer.  libtiff is not well
36  * configured to handle files in memory, so a client wrapper is written to
37  * surround the memory and turn it into a virtual file.  Currently, reading
38  * of TIFF files is done using libtiff's RGBAImage support.  This is a 
39  * high-level routine that loads all images as 32-bit RGBA, handling all the
40  * required conversions between many different TIFF types internally.
41  * 
42  * Saving supports RGB, RGBA and BW (greyscale) images correctly, with
43  * 8 bits per channel in all cases.  The "deflate" compression algorithm is
44  * used to compress images.
45  */
46
47 #include <string.h>
48
49 #include "imbuf.h"
50
51 #include "BLI_math.h"
52 #include "BLI_string.h"
53 #include "BLI_utildefines.h"
54  
55 #include "BKE_global.h"
56
57
58 #include "IMB_imbuf_types.h"
59 #include "IMB_imbuf.h"
60
61 #include "IMB_allocimbuf.h"
62 #include "IMB_filetype.h"
63 #include "IMB_filter.h"
64
65 #include "tiffio.h"
66
67
68
69 /***********************
70  * Local declarations. *
71  ***********************/
72 /* Reading and writing of an in-memory TIFF file. */
73 static tsize_t imb_tiff_ReadProc(thandle_t handle, tdata_t data, tsize_t n);
74 static tsize_t imb_tiff_WriteProc(thandle_t handle, tdata_t data, tsize_t n);
75 static toff_t  imb_tiff_SeekProc(thandle_t handle, toff_t ofs, int whence);
76 static int     imb_tiff_CloseProc(thandle_t handle);
77 static toff_t  imb_tiff_SizeProc(thandle_t handle);
78 static int     imb_tiff_DummyMapProc(thandle_t fd, tdata_t* pbase, toff_t* psize);
79 static void    imb_tiff_DummyUnmapProc(thandle_t fd, tdata_t base, toff_t size);
80
81
82 /* Structure for in-memory TIFF file. */
83 typedef struct ImbTIFFMemFile {
84         unsigned char *mem;     /* Location of first byte of TIFF file. */
85         toff_t offset;          /* Current offset within the file.      */
86         tsize_t size;           /* Size of the TIFF file.               */
87 } ImbTIFFMemFile;
88 #define IMB_TIFF_GET_MEMFILE(x) ((ImbTIFFMemFile*)(x))
89
90
91
92 /*****************************
93  * Function implementations. *
94  *****************************/
95
96
97 static void imb_tiff_DummyUnmapProc(thandle_t fd, tdata_t base, toff_t size)
98 {
99         (void)fd;
100         (void)base;
101         (void)size;
102 }
103
104 static int imb_tiff_DummyMapProc(thandle_t fd, tdata_t* pbase, toff_t* psize) 
105 {
106         (void)fd;
107         (void)pbase;
108         (void)psize;
109
110         return (0);
111 }
112
113 /**
114  * Reads data from an in-memory TIFF file.
115  *
116  * \param handle: Handle of the TIFF file (pointer to ImbTIFFMemFile).
117  * \param data:   Buffer to contain data (treat as void*).
118  * \param n:      Number of bytes to read.
119  *
120  * \return: Number of bytes actually read.
121  *       0 = EOF.
122  */
123 static tsize_t imb_tiff_ReadProc(thandle_t handle, tdata_t data, tsize_t n)
124 {
125         tsize_t nRemaining, nCopy;
126         ImbTIFFMemFile* mfile;
127         void *srcAddr;
128
129         /* get the pointer to the in-memory file */
130         mfile = IMB_TIFF_GET_MEMFILE(handle);
131         if (!mfile || !mfile->mem) {
132                 fprintf(stderr, "imb_tiff_ReadProc: !mfile || !mfile->mem!\n");
133                 return 0;
134         }
135
136         /* find the actual number of bytes to read (copy) */
137         nCopy = n;
138         if ((tsize_t)mfile->offset >= mfile->size)
139                 nRemaining = 0;
140         else
141                 nRemaining = mfile->size - mfile->offset;
142         
143         if (nCopy > nRemaining)
144                 nCopy = nRemaining;
145         
146         /* on EOF, return immediately and read (copy) nothing */
147         if (nCopy <= 0)
148                 return (0);
149
150         /* all set -> do the read (copy) */
151         srcAddr = (void*)(&(mfile->mem[mfile->offset]));
152         memcpy((void*)data, srcAddr, nCopy);
153         mfile->offset += nCopy;         /* advance file ptr by copied bytes */
154         return nCopy;
155 }
156
157
158
159 /**
160  * Writes data to an in-memory TIFF file.
161  *
162  * NOTE: The current Blender implementation should not need this function.  It
163  *       is simply a stub.
164  */
165 static tsize_t imb_tiff_WriteProc(thandle_t handle, tdata_t data, tsize_t n)
166 {
167         (void)handle;
168         (void)data;
169         (void)n;
170         
171         printf("imb_tiff_WriteProc: this function should not be called.\n");
172         return (-1);
173 }
174
175
176
177 /**
178  * Seeks to a new location in an in-memory TIFF file.
179  *
180  * \param handle: Handle of the TIFF file (pointer to ImbTIFFMemFile).
181  * \param ofs:    Offset value (interpreted according to whence below).
182  * \param whence: This can be one of three values:
183  *      SEEK_SET - The offset is set to ofs bytes.
184  *      SEEK_CUR - The offset is set to its current location plus ofs bytes.
185  *      SEEK_END - (This is unsupported and will return -1, indicating an
186  *                  error).
187  *
188  * \return: Resulting offset location within the file, measured in bytes from
189  *          the beginning of the file.  (-1) indicates an error.
190  */
191 static toff_t imb_tiff_SeekProc(thandle_t handle, toff_t ofs, int whence)
192 {
193         ImbTIFFMemFile *mfile;
194         toff_t new_offset;
195
196         /* get the pointer to the in-memory file */
197         mfile = IMB_TIFF_GET_MEMFILE(handle);
198         if (!mfile || !mfile->mem) {
199                 fprintf(stderr, "imb_tiff_SeekProc: !mfile || !mfile->mem!\n");
200                 return (-1);
201         }
202
203         /* find the location we plan to seek to */
204         switch (whence) {
205                 case SEEK_SET:
206                         new_offset = ofs;
207                         break;
208                 case SEEK_CUR:
209                         new_offset = mfile->offset + ofs;
210                         break;
211                 default:
212                         /* no other types are supported - return an error */
213                         fprintf(stderr, 
214                                 "imb_tiff_SeekProc: "
215                                 "Unsupported TIFF SEEK type.\n");
216                         return (-1);
217         }
218
219         /* set the new location */
220         mfile->offset = new_offset;
221         return mfile->offset;
222 }
223
224
225
226 /**
227  * Closes (virtually) an in-memory TIFF file.
228  *
229  * NOTE: All this function actually does is sets the data pointer within the
230  *       TIFF file to NULL.  That should trigger assertion errors if attempts
231  *       are made to access the file after that point.  However, no such
232  *       attempts should ever be made (in theory).
233  *
234  * \param handle: Handle of the TIFF file (pointer to ImbTIFFMemFile).
235  *
236  * \return: 0
237  */
238 static int imb_tiff_CloseProc(thandle_t handle)
239 {
240         ImbTIFFMemFile *mfile;
241
242         /* get the pointer to the in-memory file */
243         mfile = IMB_TIFF_GET_MEMFILE(handle);
244         if (!mfile || !mfile->mem) {
245                 fprintf(stderr,"imb_tiff_CloseProc: !mfile || !mfile->mem!\n");
246                 return (0);
247         }
248         
249         /* virtually close the file */
250         mfile->mem    = NULL;
251         mfile->offset = 0;
252         mfile->size   = 0;
253         
254         return (0);
255 }
256
257
258
259 /**
260  * Returns the size of an in-memory TIFF file in bytes.
261  *
262  * \return: Size of file (in bytes).
263  */
264 static toff_t imb_tiff_SizeProc(thandle_t handle)
265 {
266         ImbTIFFMemFile* mfile;
267
268         /* get the pointer to the in-memory file */
269         mfile = IMB_TIFF_GET_MEMFILE(handle);
270         if (!mfile || !mfile->mem) {
271                 fprintf(stderr,"imb_tiff_SizeProc: !mfile || !mfile->mem!\n");
272                 return (0);
273         }
274
275         /* return the size */
276         return (toff_t)(mfile->size);
277 }
278
279 static TIFF *imb_tiff_client_open(ImbTIFFMemFile *memFile, unsigned char *mem, size_t size)
280 {
281         /* open the TIFF client layer interface to the in-memory file */
282         memFile->mem = mem;
283         memFile->offset = 0;
284         memFile->size = size;
285
286         return TIFFClientOpen("(Blender TIFF Interface Layer)", 
287                 "r", (thandle_t)(memFile),
288                 imb_tiff_ReadProc, imb_tiff_WriteProc,
289                 imb_tiff_SeekProc, imb_tiff_CloseProc,
290                 imb_tiff_SizeProc, imb_tiff_DummyMapProc, imb_tiff_DummyUnmapProc);
291 }
292
293 /**
294  * Checks whether a given memory buffer contains a TIFF file.
295  *
296  * This method uses the format identifiers from:
297  *     http://www.faqs.org/faqs/graphics/fileformats-faq/part4/section-9.html
298  * The first four bytes of big-endian and little-endian TIFF files
299  * respectively are (hex):
300  *      4d 4d 00 2a
301  *      49 49 2a 00
302  * Note that TIFF files on *any* platform can be either big- or little-endian;
303  * it's not platform-specific.
304  *
305  * AFAICT, libtiff doesn't provide a method to do this automatically, and
306  * hence my manual comparison. - Jonathan Merritt (lancelet) 4th Sept 2005.
307  */
308 #define IMB_TIFF_NCB 4          /* number of comparison bytes used */
309 int imb_is_a_tiff(unsigned char *mem)
310 {
311         char big_endian[IMB_TIFF_NCB] = { 0x4d, 0x4d, 0x00, 0x2a };
312         char lil_endian[IMB_TIFF_NCB] = { 0x49, 0x49, 0x2a, 0x00 };
313
314         return ( (memcmp(big_endian, mem, IMB_TIFF_NCB) == 0) ||
315                  (memcmp(lil_endian, mem, IMB_TIFF_NCB) == 0) );
316 }
317
318 static void scanline_contig_16bit(float *rectf, unsigned short *sbuf, int scanline_w, int spp)
319 {
320         int i;
321         for (i=0; i < scanline_w; i++) {
322                 rectf[i*4 + 0] = sbuf[i*spp + 0] / 65535.0;
323                 rectf[i*4 + 1] = sbuf[i*spp + 1] / 65535.0;
324                 rectf[i*4 + 2] = sbuf[i*spp + 2] / 65535.0;
325                 rectf[i*4 + 3] = (spp==4)?(sbuf[i*spp + 3] / 65535.0):1.0;
326         }
327 }
328
329 static void scanline_contig_32bit(float *rectf, float *fbuf, int scanline_w, int spp)
330 {
331         int i;
332         for (i=0; i < scanline_w; i++) {
333                 rectf[i*4 + 0] = fbuf[i*spp + 0];
334                 rectf[i*4 + 1] = fbuf[i*spp + 1];
335                 rectf[i*4 + 2] = fbuf[i*spp + 2];
336                 rectf[i*4 + 3] = (spp==4)?fbuf[i*spp + 3]:1.0f;
337         }
338 }
339
340 static void scanline_separate_16bit(float *rectf, unsigned short *sbuf, int scanline_w, int chan)
341 {
342         int i;
343         for (i=0; i < scanline_w; i++)
344                 rectf[i*4 + chan] = sbuf[i] / 65535.0;
345 }
346
347 static void scanline_separate_32bit(float *rectf, float *fbuf, int scanline_w, int chan)
348 {
349         int i;
350         for (i=0; i < scanline_w; i++)
351                 rectf[i*4 + chan] = fbuf[i];
352 }
353
354 static void imb_read_tiff_resolution(ImBuf *ibuf, TIFF *image)
355 {
356         uint16 unit;
357         float xres;
358         float yres;
359
360         TIFFGetFieldDefaulted(image, TIFFTAG_RESOLUTIONUNIT, &unit);
361         TIFFGetFieldDefaulted(image, TIFFTAG_XRESOLUTION, &xres);
362         TIFFGetFieldDefaulted(image, TIFFTAG_YRESOLUTION, &yres);
363
364         if (unit == RESUNIT_CENTIMETER) {
365                 ibuf->ppm[0]= (double)xres * 100.0;
366                 ibuf->ppm[1]= (double)yres * 100.0;
367         }
368         else {
369                 ibuf->ppm[0]= (double)xres / 0.0254;
370                 ibuf->ppm[1]= (double)yres / 0.0254;
371         }
372 }
373
374 /* 
375  * Use the libTIFF scanline API to read a TIFF image.
376  * This method is most flexible and can handle multiple different bit depths 
377  * and RGB channel orderings.
378  */
379 static int imb_read_tiff_pixels(ImBuf *ibuf, TIFF *image, int premul)
380 {
381         ImBuf *tmpibuf;
382         int success= 0;
383         short bitspersample, spp, config;
384         size_t scanline;
385         int ib_flag=0, row, chan;
386         float *fbuf=NULL;
387         unsigned short *sbuf=NULL;
388
389         TIFFGetField(image, TIFFTAG_BITSPERSAMPLE, &bitspersample);
390         TIFFGetField(image, TIFFTAG_SAMPLESPERPIXEL, &spp);             /* number of 'channels' */
391         TIFFGetField(image, TIFFTAG_PLANARCONFIG, &config);
392
393         imb_read_tiff_resolution(ibuf, image);
394
395         scanline = TIFFScanlineSize(image);
396         
397         if (bitspersample == 32) {
398                 ib_flag = IB_rectfloat;
399                 fbuf = (float *)_TIFFmalloc(scanline);
400         }
401         else if (bitspersample == 16) {
402                 ib_flag = IB_rectfloat;
403                 sbuf = (unsigned short *)_TIFFmalloc(scanline);
404         }
405         else {
406                 ib_flag = IB_rect;
407         }
408         
409         tmpibuf= IMB_allocImBuf(ibuf->x, ibuf->y, ibuf->planes, ib_flag);
410         
411         /* simple RGBA image */
412         if (!(bitspersample == 32 || bitspersample == 16)) {
413                 success |= TIFFReadRGBAImage(image, ibuf->x, ibuf->y, tmpibuf->rect, 0);
414         }
415         /* contiguous channels: RGBRGBRGB */
416         else if (config == PLANARCONFIG_CONTIG) {
417                 for (row = 0; row < ibuf->y; row++) {
418                         int ib_offset = ibuf->x*ibuf->y*4 - ibuf->x*4 * (row+1);
419                 
420                         if (bitspersample == 32) {
421                                 success |= TIFFReadScanline(image, fbuf, row, 0);
422                                 scanline_contig_32bit(tmpibuf->rect_float+ib_offset, fbuf, ibuf->x, spp);
423                                 
424                         }
425                         else if (bitspersample == 16) {
426                                 success |= TIFFReadScanline(image, sbuf, row, 0);
427                                 scanline_contig_16bit(tmpibuf->rect_float+ib_offset, sbuf, ibuf->x, spp);
428                         }
429                 }
430         /* separate channels: RRRGGGBBB */
431         }
432         else if (config == PLANARCONFIG_SEPARATE) {
433                 
434                 /* imbufs always have 4 channels of data, so we iterate over all of them
435                  * but only fill in from the TIFF scanline where necessary. */
436                 for (chan = 0; chan < 4; chan++) {
437                         for (row = 0; row < ibuf->y; row++) {
438                                 int ib_offset = ibuf->x*ibuf->y*4 - ibuf->x*4 * (row+1);
439                                 
440                                 if (bitspersample == 32) {
441                                         if (chan == 3 && spp == 3) /* fill alpha if only RGB TIFF */
442                                                 memset(fbuf, 1.0, sizeof(fbuf));
443                                         else
444                                                 success |= TIFFReadScanline(image, fbuf, row, chan);
445                                         scanline_separate_32bit(tmpibuf->rect_float+ib_offset, fbuf, ibuf->x, chan);
446                                         
447                                 }
448                                 else if (bitspersample == 16) {
449                                         if (chan == 3 && spp == 3) /* fill alpha if only RGB TIFF */
450                                                 memset(sbuf, 65535, sizeof(sbuf));
451                                         else
452                                                 success |= TIFFReadScanline(image, sbuf, row, chan);
453                                         scanline_separate_16bit(tmpibuf->rect_float+ib_offset, sbuf, ibuf->x, chan);
454                                         
455                                 }
456                         }
457                 }
458         }
459         
460         if (bitspersample == 32)
461                 _TIFFfree(fbuf);
462         else if (bitspersample == 16)
463                 _TIFFfree(sbuf);
464
465         if (success) {
466                 ibuf->profile = (bitspersample==32)?IB_PROFILE_LINEAR_RGB:IB_PROFILE_SRGB;
467
468 //              Code seems to be not needed for 16 bits tif, on PPC G5 OSX (ton)
469                 if (bitspersample < 16)
470                         if (ENDIAN_ORDER == B_ENDIAN)
471                                 IMB_convert_rgba_to_abgr(tmpibuf);
472                 if (premul) {
473                         IMB_premultiply_alpha(tmpibuf);
474                         ibuf->flags |= IB_premul;
475                 }
476                 
477                 /* assign rect last */
478                 if (tmpibuf->rect_float)
479                         ibuf->rect_float= tmpibuf->rect_float;
480                 else    
481                         ibuf->rect= tmpibuf->rect;
482                 ibuf->mall |= ib_flag;
483                 ibuf->flags |= ib_flag;
484                 
485                 tmpibuf->mall &= ~ib_flag;
486         }
487
488         IMB_freeImBuf(tmpibuf);
489         
490         return success;
491 }
492
493 void imb_inittiff(void)
494 {
495         if (!(G.debug & G_DEBUG))
496                 TIFFSetErrorHandler(NULL);
497 }
498
499 /**
500  * Loads a TIFF file.
501  *
502  *
503  * \param mem:   Memory containing the TIFF file.
504  * \param size:  Size of the mem buffer.
505  * \param flags: If flags has IB_test set then the file is not actually loaded,
506  *                but all other operations take place.
507  *
508  * \return: A newly allocated ImBuf structure if successful, otherwise NULL.
509  */
510 ImBuf *imb_loadtiff(unsigned char *mem, size_t size, int flags)
511 {
512         TIFF *image = NULL;
513         ImBuf *ibuf = NULL, *hbuf;
514         ImbTIFFMemFile memFile;
515         uint32 width, height;
516         char *format = NULL;
517         int level;
518         short spp;
519         int ib_depth;
520
521         /* check whether or not we have a TIFF file */
522         if (size < IMB_TIFF_NCB) {
523                 fprintf(stderr, "imb_loadtiff: size < IMB_TIFF_NCB\n");
524                 return NULL;
525         }
526         if (imb_is_a_tiff(mem) == 0)
527                 return NULL;
528
529         image = imb_tiff_client_open(&memFile, mem, size);
530
531         if (image == NULL) {
532                 printf("imb_loadtiff: could not open TIFF IO layer.\n");
533                 return NULL;
534         }
535
536         /* allocate the image buffer */
537         TIFFGetField(image, TIFFTAG_IMAGEWIDTH,  &width);
538         TIFFGetField(image, TIFFTAG_IMAGELENGTH, &height);
539         TIFFGetField(image, TIFFTAG_SAMPLESPERPIXEL, &spp);
540         
541         ib_depth = (spp==3)?24:32;
542         
543         ibuf = IMB_allocImBuf(width, height, ib_depth, 0);
544         if (ibuf) {
545                 ibuf->ftype = TIF;
546         }
547         else {
548                 fprintf(stderr, 
549                         "imb_loadtiff: could not allocate memory for TIFF "
550                         "image.\n");
551                 TIFFClose(image);
552                 return NULL;
553         }
554
555         /* if testing, we're done */
556         if (flags & IB_test) {
557                 TIFFClose(image);
558                 return ibuf;
559         }
560
561         /* detect if we are reading a tiled/mipmapped texture, in that case
562          * we don't read pixels but leave it to the cache to load tiles */
563         if (flags & IB_tilecache) {
564                 format= NULL;
565                 TIFFGetField(image, TIFFTAG_PIXAR_TEXTUREFORMAT, &format);
566
567                 if (format && strcmp(format, "Plain Texture")==0 && TIFFIsTiled(image)) {
568                         int numlevel = TIFFNumberOfDirectories(image);
569
570                         /* create empty mipmap levels in advance */
571                         for (level=0; level<numlevel; level++) {
572                                 if (!TIFFSetDirectory(image, level))
573                                         break;
574
575                                 if (level > 0) {
576                                         width= (width > 1)? width/2: 1;
577                                         height= (height > 1)? height/2: 1;
578
579                                         hbuf= IMB_allocImBuf(width, height, 32, 0);
580                                         hbuf->miplevel= level;
581                                         hbuf->ftype= ibuf->ftype;
582                                         ibuf->mipmap[level-1] = hbuf;
583
584                                         if (flags & IB_premul)
585                                                 hbuf->flags |= IB_premul;
586                                 }
587                                 else
588                                         hbuf= ibuf;
589
590                                 hbuf->flags |= IB_tilecache;
591
592                                 TIFFGetField(image, TIFFTAG_TILEWIDTH, &hbuf->tilex);
593                                 TIFFGetField(image, TIFFTAG_TILELENGTH, &hbuf->tiley);
594
595                                 hbuf->xtiles= ceil(hbuf->x/(float)hbuf->tilex);
596                                 hbuf->ytiles= ceil(hbuf->y/(float)hbuf->tiley);
597
598                                 imb_addtilesImBuf(hbuf);
599
600                                 ibuf->miptot++;
601                         }
602                 }
603         }
604
605         /* read pixels */
606         if (!(ibuf->flags & IB_tilecache) && !imb_read_tiff_pixels(ibuf, image, 0)) {
607                 fprintf(stderr, "imb_loadtiff: Failed to read tiff image.\n");
608                 TIFFClose(image);
609                 return NULL;
610         }
611
612         /* close the client layer interface to the in-memory file */
613         TIFFClose(image);
614
615         /* return successfully */
616         return ibuf;
617 }
618
619 void imb_loadtiletiff(ImBuf *ibuf, unsigned char *mem, size_t size, int tx, int ty, unsigned int *rect)
620 {
621         TIFF *image = NULL;
622         uint32 width, height;
623         ImbTIFFMemFile memFile;
624
625         image = imb_tiff_client_open(&memFile, mem, size);
626
627         if (image == NULL) {
628                 printf("imb_loadtiff: could not open TIFF IO layer for loading mipmap level.\n");
629                 return;
630         }
631
632         if (TIFFSetDirectory(image, ibuf->miplevel)) { /* allocate the image buffer */
633                 TIFFGetField(image, TIFFTAG_IMAGEWIDTH,  &width);
634                 TIFFGetField(image, TIFFTAG_IMAGELENGTH, &height);
635
636                 if (width == ibuf->x && height == ibuf->y) {
637                         if (rect) {
638                                 /* tiff pixels are bottom to top, tiles are top to bottom */
639                                 if (TIFFReadRGBATile(image, tx*ibuf->tilex, (ibuf->ytiles - 1 - ty)*ibuf->tiley, rect) == 1) {
640                                         if (ibuf->tiley > ibuf->y)
641                                                 memmove(rect, rect+ibuf->tilex*(ibuf->tiley - ibuf->y), sizeof(int)*ibuf->tilex*ibuf->y);
642
643                                         if (ibuf->flags & IB_premul)
644                                                 IMB_premultiply_rect(rect, 32, ibuf->tilex, ibuf->tiley);
645                                 }
646                                 else
647                                         printf("imb_loadtiff: failed to read tiff tile at mipmap level %d\n", ibuf->miplevel);
648                         }
649                 }
650                 else
651                         printf("imb_loadtiff: mipmap level %d has unexpected size %ux%u instead of %dx%d\n", ibuf->miplevel, width, height, ibuf->x, ibuf->y);
652         }
653         else
654                 printf("imb_loadtiff: could not find mipmap level %d\n", ibuf->miplevel);
655
656         /* close the client layer interface to the in-memory file */
657         TIFFClose(image);
658 }
659
660 /**
661  * Saves a TIFF file.
662  *
663  * ImBuf structures with 1, 3 or 4 bytes per pixel (GRAY, RGB, RGBA 
664  * respectively) are accepted, and interpreted correctly.  Note that the TIFF
665  * convention is to use pre-multiplied alpha, which can be achieved within
666  * Blender by setting "Premul" alpha handling.  Other alpha conventions are
667  * not strictly correct, but are permitted anyhow.
668  *
669  * \param ibuf:  Image buffer.
670  * \param name:  Name of the TIFF file to create.
671  * \param flags: Currently largely ignored.
672  *
673  * \return: 1 if the function is successful, 0 on failure.
674  */
675
676 int imb_savetiff(ImBuf *ibuf, const char *name, int flags)
677 {
678         TIFF *image = NULL;
679         uint16 samplesperpixel, bitspersample;
680         size_t npixels;
681         unsigned char *pixels = NULL;
682         unsigned char *from = NULL, *to = NULL;
683         unsigned short *pixels16 = NULL, *to16 = NULL;
684         float *fromf = NULL;
685         float xres, yres;
686         int x, y, from_i, to_i, i;
687         int extraSampleTypes[1] = { EXTRASAMPLE_ASSOCALPHA };
688         
689
690         /* check for a valid number of bytes per pixel.  Like the PNG writer,
691          * the TIFF writer supports 1, 3 or 4 bytes per pixel, corresponding
692          * to gray, RGB, RGBA respectively. */
693         samplesperpixel = (uint16)((ibuf->planes + 7) >> 3);
694         if ((samplesperpixel > 4) || (samplesperpixel == 2)) {
695                 fprintf(stderr,
696                         "imb_savetiff: unsupported number of bytes per " 
697                         "pixel: %d\n", samplesperpixel);
698                 return (0);
699         }
700
701         if ((ibuf->ftype & TIF_16BIT) && ibuf->rect_float)
702                 bitspersample = 16;
703         else
704                 bitspersample = 8;
705
706         /* open TIFF file for writing */
707         if (flags & IB_mem) {
708                 /* bork at the creation of a TIFF in memory */
709                 fprintf(stderr,
710                         "imb_savetiff: creation of in-memory TIFF files is " 
711                         "not yet supported.\n");
712                 return (0);
713         }
714         else {
715                 /* create image as a file */
716                 image = TIFFOpen(name, "w");
717         }
718         if (image == NULL) {
719                 fprintf(stderr,
720                         "imb_savetiff: could not open TIFF for writing.\n");
721                 return (0);
722         }
723
724         /* allocate array for pixel data */
725         npixels = ibuf->x * ibuf->y;
726         if (bitspersample == 16)
727                 pixels16 = (unsigned short*)_TIFFmalloc(npixels *
728                         samplesperpixel * sizeof(unsigned short));
729         else
730                 pixels = (unsigned char*)_TIFFmalloc(npixels *
731                         samplesperpixel * sizeof(unsigned char));
732
733         if (pixels == NULL && pixels16 == NULL) {
734                 fprintf(stderr,
735                         "imb_savetiff: could not allocate pixels array.\n");
736                 TIFFClose(image);
737                 return (0);
738         }
739
740         /* setup pointers */
741         if (bitspersample == 16) {
742                 fromf = ibuf->rect_float;
743                 to16   = pixels16;
744         }
745         else {
746                 from = (unsigned char*)ibuf->rect;
747                 to   = pixels;
748         }
749
750         /* setup samples per pixel */
751         TIFFSetField(image, TIFFTAG_BITSPERSAMPLE, bitspersample);
752         TIFFSetField(image, TIFFTAG_SAMPLESPERPIXEL, samplesperpixel);
753
754         if (samplesperpixel == 4) {
755                 /* RGBA images */
756                 TIFFSetField(image, TIFFTAG_EXTRASAMPLES, 1,
757                                 extraSampleTypes);
758                 TIFFSetField(image, TIFFTAG_PHOTOMETRIC, 
759                                 PHOTOMETRIC_RGB);
760         }
761         else if (samplesperpixel == 3) {
762                 /* RGB images */
763                 TIFFSetField(image, TIFFTAG_PHOTOMETRIC,
764                                 PHOTOMETRIC_RGB);
765         }
766         else if (samplesperpixel == 1) {
767                 /* greyscale images, 1 channel */
768                 TIFFSetField(image, TIFFTAG_PHOTOMETRIC,
769                                 PHOTOMETRIC_MINISBLACK);
770         }
771
772         /* copy pixel data.  While copying, we flip the image vertically. */
773         for (x = 0; x < ibuf->x; x++) {
774                 for (y = 0; y < ibuf->y; y++) {
775                         from_i = 4*(y*ibuf->x+x);
776                         to_i   = samplesperpixel*((ibuf->y-y-1)*ibuf->x+x);
777
778                         if (pixels16) {
779                                 /* convert from float source */
780                                 float rgb[3];
781                                 
782                                 if (ibuf->profile == IB_PROFILE_LINEAR_RGB)
783                                         linearrgb_to_srgb_v3_v3(rgb, &fromf[from_i]);
784                                 else
785                                         copy_v3_v3(rgb, &fromf[from_i]);
786
787                                 to16[to_i+0] = FTOUSHORT(rgb[0]);
788                                 to16[to_i+1] = FTOUSHORT(rgb[1]);
789                                 to16[to_i+2] = FTOUSHORT(rgb[2]);
790                                 to_i += 3; from_i+=3;
791                                 
792                                 if (samplesperpixel == 4) {
793                                         to16[to_i+3] = FTOUSHORT(fromf[from_i+3]);
794                                         /*to_i++; from_i++;*/ /*unused, set on each loop */
795                                 }
796                         }
797                         else {
798                                 for (i = 0; i < samplesperpixel; i++, to_i++, from_i++)
799                                         to[to_i] = from[from_i];
800                         }
801                 }
802         }
803
804         /* write the actual TIFF file */
805         TIFFSetField(image, TIFFTAG_IMAGEWIDTH,      ibuf->x);
806         TIFFSetField(image, TIFFTAG_IMAGELENGTH,     ibuf->y);
807         TIFFSetField(image, TIFFTAG_ROWSPERSTRIP,    ibuf->y);
808         TIFFSetField(image, TIFFTAG_COMPRESSION, COMPRESSION_DEFLATE);
809         TIFFSetField(image, TIFFTAG_FILLORDER, FILLORDER_MSB2LSB);
810         TIFFSetField(image, TIFFTAG_PLANARCONFIG, PLANARCONFIG_CONTIG);
811
812
813         if (ibuf->ppm[0] > 0.0 && ibuf->ppm[1] > 0.0) {
814                 xres= (float)(ibuf->ppm[0] * 0.0254);
815                 yres= (float)(ibuf->ppm[1] * 0.0254);
816         }
817         else {
818                 xres= yres= 150.0f;
819         }
820
821         TIFFSetField(image, TIFFTAG_XRESOLUTION,     xres);
822         TIFFSetField(image, TIFFTAG_YRESOLUTION,     yres);
823         TIFFSetField(image, TIFFTAG_RESOLUTIONUNIT,  RESUNIT_INCH);
824         if (TIFFWriteEncodedStrip(image, 0,
825                         (bitspersample == 16)? (unsigned char*)pixels16: pixels,
826                         ibuf->x*ibuf->y*samplesperpixel*bitspersample/8) == -1) {
827                 fprintf(stderr,
828                         "imb_savetiff: Could not write encoded TIFF.\n");
829                 TIFFClose(image);
830                 if (pixels) _TIFFfree(pixels);
831                 if (pixels16) _TIFFfree(pixels16);
832                 return (1);
833         }
834
835         /* close the TIFF file */
836         TIFFClose(image);
837         if (pixels) _TIFFfree(pixels);
838         if (pixels16) _TIFFfree(pixels16);
839         return (1);
840 }