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