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