1 /* $Id: tif_pixarlog.c,v 1.39 2012-12-10 17:27:13 tgl Exp $ */
4 * Copyright (c) 1996-1997 Sam Leffler
5 * Copyright (c) 1996 Pixar
7 * Permission to use, copy, modify, distribute, and sell this software and
8 * its documentation for any purpose is hereby granted without fee, provided
9 * that (i) the above copyright notices and this permission notice appear in
10 * all copies of the software and related documentation, and (ii) the names of
11 * Pixar, Sam Leffler and Silicon Graphics may not be used in any advertising or
12 * publicity relating to the software without the specific, prior written
13 * permission of Pixar, Sam Leffler and Silicon Graphics.
15 * THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
16 * EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
17 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
19 * IN NO EVENT SHALL PIXAR, SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
20 * ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
21 * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
22 * WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
23 * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
28 #ifdef PIXARLOG_SUPPORT
32 * PixarLog Compression Support
34 * Contributed by Dan McCoy.
36 * PixarLog film support uses the TIFF library to store companded
37 * 11 bit values into a tiff file, which are compressed using the
40 * The codec can take as input and produce as output 32-bit IEEE float values
41 * as well as 16-bit or 8-bit unsigned integer values.
43 * On writing any of the above are converted into the internal
44 * 11-bit log format. In the case of 8 and 16 bit values, the
45 * input is assumed to be unsigned linear color values that represent
46 * the range 0-1. In the case of IEEE values, the 0-1 range is assumed to
47 * be the normal linear color range, in addition over 1 values are
48 * accepted up to a value of about 25.0 to encode "hot" hightlights and such.
49 * The encoding is lossless for 8-bit values, slightly lossy for the
50 * other bit depths. The actual color precision should be better
51 * than the human eye can perceive with extra room to allow for
52 * error introduced by further image computation. As with any quantized
53 * color format, it is possible to perform image calculations which
54 * expose the quantization error. This format should certainly be less
55 * susceptable to such errors than standard 8-bit encodings, but more
56 * susceptable than straight 16-bit or 32-bit encodings.
58 * On reading the internal format is converted to the desired output format.
59 * The program can request which format it desires by setting the internal
60 * pseudo tag TIFFTAG_PIXARLOGDATAFMT to one of these possible values:
61 * PIXARLOGDATAFMT_FLOAT = provide IEEE float values.
62 * PIXARLOGDATAFMT_16BIT = provide unsigned 16-bit integer values
63 * PIXARLOGDATAFMT_8BIT = provide unsigned 8-bit integer values
65 * alternately PIXARLOGDATAFMT_8BITABGR provides unsigned 8-bit integer
66 * values with the difference that if there are exactly three or four channels
67 * (rgb or rgba) it swaps the channel order (bgr or abgr).
69 * PIXARLOGDATAFMT_11BITLOG provides the internal encoding directly
70 * packed in 16-bit values. However no tools are supplied for interpreting
73 * "hot" (over 1.0) areas written in floating point get clamped to
74 * 1.0 in the integer data types.
76 * When the file is closed after writing, the bit depth and sample format
77 * are set always to appear as if 8-bit data has been written into it.
78 * That way a naive program unaware of the particulars of the encoding
79 * gets the format it is most likely able to handle.
81 * The codec does it's own horizontal differencing step on the coded
82 * values so the libraries predictor stuff should be turned off.
83 * The codec also handle byte swapping the encoded values as necessary
84 * since the library does not have the information necessary
85 * to know the bit depth of the raw unencoded buffer.
87 * NOTE: This decoder does not appear to update tif_rawcp, and tif_rawcc.
88 * This can cause problems with the implementation of CHUNKY_STRIP_READ_SUPPORT
89 * as noted in http://trac.osgeo.org/gdal/ticket/3894. FrankW - Jan'11
92 #include "tif_predict.h"
99 /* Tables for converting to/from 11 bit coded values */
101 #define TSIZE 2048 /* decode table size (11-bit tokens) */
102 #define TSIZEP1 2049 /* Plus one for slop */
103 #define ONE 1250 /* token value of 1.0 exactly */
104 #define RATIO 1.004 /* nominal ratio for log part */
106 #define CODE_MASK 0x7ff /* 11 bits. */
108 static float Fltsize;
109 static float LogK1, LogK2;
111 #define REPEAT(n, op) { int i; i=n; do { i--; op; } while (i>0); }
114 horizontalAccumulateF(uint16 *wp, int n, int stride, float *op,
117 register unsigned int cr, cg, cb, ca, mask;
118 register float t0, t1, t2, t3;
123 t0 = ToLinearF[cr = (wp[0] & mask)];
124 t1 = ToLinearF[cg = (wp[1] & mask)];
125 t2 = ToLinearF[cb = (wp[2] & mask)];
134 t0 = ToLinearF[(cr += wp[0]) & mask];
135 t1 = ToLinearF[(cg += wp[1]) & mask];
136 t2 = ToLinearF[(cb += wp[2]) & mask];
141 } else if (stride == 4) {
142 t0 = ToLinearF[cr = (wp[0] & mask)];
143 t1 = ToLinearF[cg = (wp[1] & mask)];
144 t2 = ToLinearF[cb = (wp[2] & mask)];
145 t3 = ToLinearF[ca = (wp[3] & mask)];
155 t0 = ToLinearF[(cr += wp[0]) & mask];
156 t1 = ToLinearF[(cg += wp[1]) & mask];
157 t2 = ToLinearF[(cb += wp[2]) & mask];
158 t3 = ToLinearF[(ca += wp[3]) & mask];
165 REPEAT(stride, *op = ToLinearF[*wp&mask]; wp++; op++)
169 wp[stride] += *wp; *op = ToLinearF[*wp&mask]; wp++; op++)
177 horizontalAccumulate12(uint16 *wp, int n, int stride, int16 *op,
180 register unsigned int cr, cg, cb, ca, mask;
181 register float t0, t1, t2, t3;
183 #define SCALE12 2048.0F
184 #define CLAMP12(t) (((t) < 3071) ? (uint16) (t) : 3071)
189 t0 = ToLinearF[cr = (wp[0] & mask)] * SCALE12;
190 t1 = ToLinearF[cg = (wp[1] & mask)] * SCALE12;
191 t2 = ToLinearF[cb = (wp[2] & mask)] * SCALE12;
200 t0 = ToLinearF[(cr += wp[0]) & mask] * SCALE12;
201 t1 = ToLinearF[(cg += wp[1]) & mask] * SCALE12;
202 t2 = ToLinearF[(cb += wp[2]) & mask] * SCALE12;
207 } else if (stride == 4) {
208 t0 = ToLinearF[cr = (wp[0] & mask)] * SCALE12;
209 t1 = ToLinearF[cg = (wp[1] & mask)] * SCALE12;
210 t2 = ToLinearF[cb = (wp[2] & mask)] * SCALE12;
211 t3 = ToLinearF[ca = (wp[3] & mask)] * SCALE12;
221 t0 = ToLinearF[(cr += wp[0]) & mask] * SCALE12;
222 t1 = ToLinearF[(cg += wp[1]) & mask] * SCALE12;
223 t2 = ToLinearF[(cb += wp[2]) & mask] * SCALE12;
224 t3 = ToLinearF[(ca += wp[3]) & mask] * SCALE12;
231 REPEAT(stride, t0 = ToLinearF[*wp&mask] * SCALE12;
232 *op = CLAMP12(t0); wp++; op++)
236 wp[stride] += *wp; t0 = ToLinearF[wp[stride]&mask]*SCALE12;
237 *op = CLAMP12(t0); wp++; op++)
245 horizontalAccumulate16(uint16 *wp, int n, int stride, uint16 *op,
248 register unsigned int cr, cg, cb, ca, mask;
253 op[0] = ToLinear16[cr = (wp[0] & mask)];
254 op[1] = ToLinear16[cg = (wp[1] & mask)];
255 op[2] = ToLinear16[cb = (wp[2] & mask)];
261 op[0] = ToLinear16[(cr += wp[0]) & mask];
262 op[1] = ToLinear16[(cg += wp[1]) & mask];
263 op[2] = ToLinear16[(cb += wp[2]) & mask];
265 } else if (stride == 4) {
266 op[0] = ToLinear16[cr = (wp[0] & mask)];
267 op[1] = ToLinear16[cg = (wp[1] & mask)];
268 op[2] = ToLinear16[cb = (wp[2] & mask)];
269 op[3] = ToLinear16[ca = (wp[3] & mask)];
275 op[0] = ToLinear16[(cr += wp[0]) & mask];
276 op[1] = ToLinear16[(cg += wp[1]) & mask];
277 op[2] = ToLinear16[(cb += wp[2]) & mask];
278 op[3] = ToLinear16[(ca += wp[3]) & mask];
281 REPEAT(stride, *op = ToLinear16[*wp&mask]; wp++; op++)
285 wp[stride] += *wp; *op = ToLinear16[*wp&mask]; wp++; op++)
293 * Returns the log encoded 11-bit values with the horizontal
294 * differencing undone.
297 horizontalAccumulate11(uint16 *wp, int n, int stride, uint16 *op)
299 register unsigned int cr, cg, cb, ca, mask;
304 op[0] = cr = wp[0]; op[1] = cg = wp[1]; op[2] = cb = wp[2];
310 op[0] = (cr += wp[0]) & mask;
311 op[1] = (cg += wp[1]) & mask;
312 op[2] = (cb += wp[2]) & mask;
314 } else if (stride == 4) {
315 op[0] = cr = wp[0]; op[1] = cg = wp[1];
316 op[2] = cb = wp[2]; op[3] = ca = wp[3];
322 op[0] = (cr += wp[0]) & mask;
323 op[1] = (cg += wp[1]) & mask;
324 op[2] = (cb += wp[2]) & mask;
325 op[3] = (ca += wp[3]) & mask;
328 REPEAT(stride, *op = *wp&mask; wp++; op++)
332 wp[stride] += *wp; *op = *wp&mask; wp++; op++)
340 horizontalAccumulate8(uint16 *wp, int n, int stride, unsigned char *op,
341 unsigned char *ToLinear8)
343 register unsigned int cr, cg, cb, ca, mask;
348 op[0] = ToLinear8[cr = (wp[0] & mask)];
349 op[1] = ToLinear8[cg = (wp[1] & mask)];
350 op[2] = ToLinear8[cb = (wp[2] & mask)];
356 op[0] = ToLinear8[(cr += wp[0]) & mask];
357 op[1] = ToLinear8[(cg += wp[1]) & mask];
358 op[2] = ToLinear8[(cb += wp[2]) & mask];
360 } else if (stride == 4) {
361 op[0] = ToLinear8[cr = (wp[0] & mask)];
362 op[1] = ToLinear8[cg = (wp[1] & mask)];
363 op[2] = ToLinear8[cb = (wp[2] & mask)];
364 op[3] = ToLinear8[ca = (wp[3] & mask)];
370 op[0] = ToLinear8[(cr += wp[0]) & mask];
371 op[1] = ToLinear8[(cg += wp[1]) & mask];
372 op[2] = ToLinear8[(cb += wp[2]) & mask];
373 op[3] = ToLinear8[(ca += wp[3]) & mask];
376 REPEAT(stride, *op = ToLinear8[*wp&mask]; wp++; op++)
380 wp[stride] += *wp; *op = ToLinear8[*wp&mask]; wp++; op++)
389 horizontalAccumulate8abgr(uint16 *wp, int n, int stride, unsigned char *op,
390 unsigned char *ToLinear8)
392 register unsigned int cr, cg, cb, ca, mask;
393 register unsigned char t0, t1, t2, t3;
399 t1 = ToLinear8[cb = (wp[2] & mask)];
400 t2 = ToLinear8[cg = (wp[1] & mask)];
401 t3 = ToLinear8[cr = (wp[0] & mask)];
411 t1 = ToLinear8[(cb += wp[2]) & mask];
412 t2 = ToLinear8[(cg += wp[1]) & mask];
413 t3 = ToLinear8[(cr += wp[0]) & mask];
418 } else if (stride == 4) {
419 t0 = ToLinear8[ca = (wp[3] & mask)];
420 t1 = ToLinear8[cb = (wp[2] & mask)];
421 t2 = ToLinear8[cg = (wp[1] & mask)];
422 t3 = ToLinear8[cr = (wp[0] & mask)];
432 t0 = ToLinear8[(ca += wp[3]) & mask];
433 t1 = ToLinear8[(cb += wp[2]) & mask];
434 t2 = ToLinear8[(cg += wp[1]) & mask];
435 t3 = ToLinear8[(cr += wp[0]) & mask];
442 REPEAT(stride, *op = ToLinear8[*wp&mask]; wp++; op++)
446 wp[stride] += *wp; *op = ToLinear8[*wp&mask]; wp++; op++)
454 * State block for each open TIFF
455 * file using PixarLog compression/decompression.
458 TIFFPredictorState predict;
465 #define PLSTATE_INIT 1
467 TIFFVSetMethod vgetparent; /* super-class method */
468 TIFFVSetMethod vsetparent; /* super-class method */
472 unsigned char *ToLinear8;
474 uint16 *From14; /* Really for 16-bit data, but we shift down 2 */
480 PixarLogMakeTables(PixarLogState *sp)
484 * We make several tables here to convert between various external
485 * representations (float, 16-bit, and 8-bit) and the internal
486 * 11-bit companded representation. The 11-bit representation has two
487 * distinct regions. A linear bottom end up through .018316 in steps
488 * of about .000073, and a region of constant ratio up to about 25.
489 * These floating point numbers are stored in the main table ToLinearF.
490 * All other tables are derived from this one. The tables (and the
491 * ratios) are continuous at the internal seam.
496 double b, c, linstep, v;
499 unsigned char *ToLinear8;
501 uint16 *From14; /* Really for 16-bit data, but we shift down 2 */
505 nlin = (int)(1./c); /* nlin must be an integer */
507 b = exp(-c*ONE); /* multiplicative scale factor [b*exp(c*ONE) = 1] */
508 linstep = b*c*exp(1.);
510 LogK1 = (float)(1./c); /* if (v >= 2) token = k1*log(v*k2) */
511 LogK2 = (float)(1./b);
512 lt2size = (int)(2./linstep) + 1;
513 FromLT2 = (uint16 *)_TIFFmalloc(lt2size*sizeof(uint16));
514 From14 = (uint16 *)_TIFFmalloc(16384*sizeof(uint16));
515 From8 = (uint16 *)_TIFFmalloc(256*sizeof(uint16));
516 ToLinearF = (float *)_TIFFmalloc(TSIZEP1 * sizeof(float));
517 ToLinear16 = (uint16 *)_TIFFmalloc(TSIZEP1 * sizeof(uint16));
518 ToLinear8 = (unsigned char *)_TIFFmalloc(TSIZEP1 * sizeof(unsigned char));
519 if (FromLT2 == NULL || From14 == NULL || From8 == NULL ||
520 ToLinearF == NULL || ToLinear16 == NULL || ToLinear8 == NULL) {
521 if (FromLT2) _TIFFfree(FromLT2);
522 if (From14) _TIFFfree(From14);
523 if (From8) _TIFFfree(From8);
524 if (ToLinearF) _TIFFfree(ToLinearF);
525 if (ToLinear16) _TIFFfree(ToLinear16);
526 if (ToLinear8) _TIFFfree(ToLinear8);
530 sp->ToLinearF = NULL;
531 sp->ToLinear16 = NULL;
532 sp->ToLinear8 = NULL;
538 for (i = 0; i < nlin; i++) {
540 ToLinearF[j++] = (float)v;
543 for (i = nlin; i < TSIZE; i++)
544 ToLinearF[j++] = (float)(b*exp(c*i));
546 ToLinearF[2048] = ToLinearF[2047];
548 for (i = 0; i < TSIZEP1; i++) {
549 v = ToLinearF[i]*65535.0 + 0.5;
550 ToLinear16[i] = (v > 65535.0) ? 65535 : (uint16)v;
551 v = ToLinearF[i]*255.0 + 0.5;
552 ToLinear8[i] = (v > 255.0) ? 255 : (unsigned char)v;
556 for (i = 0; i < lt2size; i++) {
557 if ((i*linstep)*(i*linstep) > ToLinearF[j]*ToLinearF[j+1])
563 * Since we lose info anyway on 16-bit data, we set up a 14-bit
564 * table and shift 16-bit values down two bits on input.
565 * saves a little table space.
568 for (i = 0; i < 16384; i++) {
569 while ((i/16383.)*(i/16383.) > ToLinearF[j]*ToLinearF[j+1])
575 for (i = 0; i < 256; i++) {
576 while ((i/255.)*(i/255.) > ToLinearF[j]*ToLinearF[j+1])
581 Fltsize = (float)(lt2size/2);
583 sp->ToLinearF = ToLinearF;
584 sp->ToLinear16 = ToLinear16;
585 sp->ToLinear8 = ToLinear8;
586 sp->FromLT2 = FromLT2;
593 #define DecoderState(tif) ((PixarLogState*) (tif)->tif_data)
594 #define EncoderState(tif) ((PixarLogState*) (tif)->tif_data)
596 static int PixarLogEncode(TIFF* tif, uint8* bp, tmsize_t cc, uint16 s);
597 static int PixarLogDecode(TIFF* tif, uint8* op, tmsize_t occ, uint16 s);
599 #define PIXARLOGDATAFMT_UNKNOWN -1
602 PixarLogGuessDataFmt(TIFFDirectory *td)
604 int guess = PIXARLOGDATAFMT_UNKNOWN;
605 int format = td->td_sampleformat;
607 /* If the user didn't tell us his datafmt,
608 * take our best guess from the bitspersample.
610 switch (td->td_bitspersample) {
612 if (format == SAMPLEFORMAT_IEEEFP)
613 guess = PIXARLOGDATAFMT_FLOAT;
616 if (format == SAMPLEFORMAT_VOID || format == SAMPLEFORMAT_UINT)
617 guess = PIXARLOGDATAFMT_16BIT;
620 if (format == SAMPLEFORMAT_VOID || format == SAMPLEFORMAT_INT)
621 guess = PIXARLOGDATAFMT_12BITPICIO;
624 if (format == SAMPLEFORMAT_VOID || format == SAMPLEFORMAT_UINT)
625 guess = PIXARLOGDATAFMT_11BITLOG;
628 if (format == SAMPLEFORMAT_VOID || format == SAMPLEFORMAT_UINT)
629 guess = PIXARLOGDATAFMT_8BIT;
637 multiply_ms(tmsize_t m1, tmsize_t m2)
639 tmsize_t bytes = m1 * m2;
641 if (m1 && bytes / m1 != m2)
648 add_ms(tmsize_t m1, tmsize_t m2)
650 tmsize_t bytes = m1 + m2;
652 /* if either input is zero, assume overflow already occurred */
653 if (m1 == 0 || m2 == 0)
655 else if (bytes <= m1 || bytes <= m2)
662 PixarLogFixupTags(TIFF* tif)
669 PixarLogSetupDecode(TIFF* tif)
671 static const char module[] = "PixarLogSetupDecode";
672 TIFFDirectory *td = &tif->tif_dir;
673 PixarLogState* sp = DecoderState(tif);
678 /* Make sure no byte swapping happens on the data
679 * after decompression. */
680 tif->tif_postdecode = _TIFFNoPostDecode;
682 /* for some reason, we can't do this in TIFFInitPixarLog */
684 sp->stride = (td->td_planarconfig == PLANARCONFIG_CONTIG ?
685 td->td_samplesperpixel : 1);
686 tbuf_size = multiply_ms(multiply_ms(multiply_ms(sp->stride, td->td_imagewidth),
687 td->td_rowsperstrip), sizeof(uint16));
688 /* add one more stride in case input ends mid-stride */
689 tbuf_size = add_ms(tbuf_size, sizeof(uint16) * sp->stride);
691 return (0); /* TODO: this is an error return without error report through TIFFErrorExt */
692 sp->tbuf = (uint16 *) _TIFFmalloc(tbuf_size);
693 if (sp->tbuf == NULL)
695 if (sp->user_datafmt == PIXARLOGDATAFMT_UNKNOWN)
696 sp->user_datafmt = PixarLogGuessDataFmt(td);
697 if (sp->user_datafmt == PIXARLOGDATAFMT_UNKNOWN) {
698 TIFFErrorExt(tif->tif_clientdata, module,
699 "PixarLog compression can't handle bits depth/data format combination (depth: %d)",
700 td->td_bitspersample);
704 if (inflateInit(&sp->stream) != Z_OK) {
705 TIFFErrorExt(tif->tif_clientdata, module, "%s", sp->stream.msg);
708 sp->state |= PLSTATE_INIT;
714 * Setup state for decoding a strip.
717 PixarLogPreDecode(TIFF* tif, uint16 s)
719 static const char module[] = "PixarLogPreDecode";
720 PixarLogState* sp = DecoderState(tif);
724 sp->stream.next_in = tif->tif_rawdata;
725 assert(sizeof(sp->stream.avail_in)==4); /* if this assert gets raised,
726 we need to simplify this code to reflect a ZLib that is likely updated
727 to deal with 8byte memory sizes, though this code will respond
728 apropriately even before we simplify it */
729 sp->stream.avail_in = (uInt) tif->tif_rawcc;
730 if ((tmsize_t)sp->stream.avail_in != tif->tif_rawcc)
732 TIFFErrorExt(tif->tif_clientdata, module, "ZLib cannot deal with buffers this size");
735 return (inflateReset(&sp->stream) == Z_OK);
739 PixarLogDecode(TIFF* tif, uint8* op, tmsize_t occ, uint16 s)
741 static const char module[] = "PixarLogDecode";
742 TIFFDirectory *td = &tif->tif_dir;
743 PixarLogState* sp = DecoderState(tif);
749 switch (sp->user_datafmt) {
750 case PIXARLOGDATAFMT_FLOAT:
751 nsamples = occ / sizeof(float); /* XXX float == 32 bits */
753 case PIXARLOGDATAFMT_16BIT:
754 case PIXARLOGDATAFMT_12BITPICIO:
755 case PIXARLOGDATAFMT_11BITLOG:
756 nsamples = occ / sizeof(uint16); /* XXX uint16 == 16 bits */
758 case PIXARLOGDATAFMT_8BIT:
759 case PIXARLOGDATAFMT_8BITABGR:
763 TIFFErrorExt(tif->tif_clientdata, module,
764 "%d bit input not supported in PixarLog",
765 td->td_bitspersample);
769 llen = sp->stride * td->td_imagewidth;
773 sp->stream.next_out = (unsigned char *) sp->tbuf;
774 assert(sizeof(sp->stream.avail_out)==4); /* if this assert gets raised,
775 we need to simplify this code to reflect a ZLib that is likely updated
776 to deal with 8byte memory sizes, though this code will respond
777 apropriately even before we simplify it */
778 sp->stream.avail_out = (uInt) (nsamples * sizeof(uint16));
779 if (sp->stream.avail_out != nsamples * sizeof(uint16))
781 TIFFErrorExt(tif->tif_clientdata, module, "ZLib cannot deal with buffers this size");
785 int state = inflate(&sp->stream, Z_PARTIAL_FLUSH);
786 if (state == Z_STREAM_END) {
789 if (state == Z_DATA_ERROR) {
790 TIFFErrorExt(tif->tif_clientdata, module,
791 "Decoding error at scanline %lu, %s",
792 (unsigned long) tif->tif_row, sp->stream.msg);
793 if (inflateSync(&sp->stream) != Z_OK)
798 TIFFErrorExt(tif->tif_clientdata, module, "ZLib error: %s",
802 } while (sp->stream.avail_out > 0);
804 /* hopefully, we got all the bytes we needed */
805 if (sp->stream.avail_out != 0) {
806 TIFFErrorExt(tif->tif_clientdata, module,
807 "Not enough data at scanline %lu (short " TIFF_UINT64_FORMAT " bytes)",
808 (unsigned long) tif->tif_row, (TIFF_UINT64_T) sp->stream.avail_out);
813 /* Swap bytes in the data if from a different endian machine. */
814 if (tif->tif_flags & TIFF_SWAB)
815 TIFFSwabArrayOfShort(up, nsamples);
818 * if llen is not an exact multiple of nsamples, the decode operation
819 * may overflow the output buffer, so truncate it enough to prevent
820 * that but still salvage as much data as possible.
822 if (nsamples % llen) {
823 TIFFWarningExt(tif->tif_clientdata, module,
824 "stride %lu is not a multiple of sample count, "
825 "%lu, data truncated.", (unsigned long) llen, (unsigned long) nsamples);
826 nsamples -= nsamples % llen;
829 for (i = 0; i < nsamples; i += llen, up += llen) {
830 switch (sp->user_datafmt) {
831 case PIXARLOGDATAFMT_FLOAT:
832 horizontalAccumulateF(up, llen, sp->stride,
833 (float *)op, sp->ToLinearF);
834 op += llen * sizeof(float);
836 case PIXARLOGDATAFMT_16BIT:
837 horizontalAccumulate16(up, llen, sp->stride,
838 (uint16 *)op, sp->ToLinear16);
839 op += llen * sizeof(uint16);
841 case PIXARLOGDATAFMT_12BITPICIO:
842 horizontalAccumulate12(up, llen, sp->stride,
843 (int16 *)op, sp->ToLinearF);
844 op += llen * sizeof(int16);
846 case PIXARLOGDATAFMT_11BITLOG:
847 horizontalAccumulate11(up, llen, sp->stride,
849 op += llen * sizeof(uint16);
851 case PIXARLOGDATAFMT_8BIT:
852 horizontalAccumulate8(up, llen, sp->stride,
853 (unsigned char *)op, sp->ToLinear8);
854 op += llen * sizeof(unsigned char);
856 case PIXARLOGDATAFMT_8BITABGR:
857 horizontalAccumulate8abgr(up, llen, sp->stride,
858 (unsigned char *)op, sp->ToLinear8);
859 op += llen * sizeof(unsigned char);
862 TIFFErrorExt(tif->tif_clientdata, module,
863 "Unsupported bits/sample: %d",
864 td->td_bitspersample);
873 PixarLogSetupEncode(TIFF* tif)
875 static const char module[] = "PixarLogSetupEncode";
876 TIFFDirectory *td = &tif->tif_dir;
877 PixarLogState* sp = EncoderState(tif);
882 /* for some reason, we can't do this in TIFFInitPixarLog */
884 sp->stride = (td->td_planarconfig == PLANARCONFIG_CONTIG ?
885 td->td_samplesperpixel : 1);
886 tbuf_size = multiply_ms(multiply_ms(multiply_ms(sp->stride, td->td_imagewidth),
887 td->td_rowsperstrip), sizeof(uint16));
889 return (0); /* TODO: this is an error return without error report through TIFFErrorExt */
890 sp->tbuf = (uint16 *) _TIFFmalloc(tbuf_size);
891 if (sp->tbuf == NULL)
893 if (sp->user_datafmt == PIXARLOGDATAFMT_UNKNOWN)
894 sp->user_datafmt = PixarLogGuessDataFmt(td);
895 if (sp->user_datafmt == PIXARLOGDATAFMT_UNKNOWN) {
896 TIFFErrorExt(tif->tif_clientdata, module, "PixarLog compression can't handle %d bit linear encodings", td->td_bitspersample);
900 if (deflateInit(&sp->stream, sp->quality) != Z_OK) {
901 TIFFErrorExt(tif->tif_clientdata, module, "%s", sp->stream.msg);
904 sp->state |= PLSTATE_INIT;
910 * Reset encoding state at the start of a strip.
913 PixarLogPreEncode(TIFF* tif, uint16 s)
915 static const char module[] = "PixarLogPreEncode";
916 PixarLogState *sp = EncoderState(tif);
920 sp->stream.next_out = tif->tif_rawdata;
921 assert(sizeof(sp->stream.avail_out)==4); /* if this assert gets raised,
922 we need to simplify this code to reflect a ZLib that is likely updated
923 to deal with 8byte memory sizes, though this code will respond
924 apropriately even before we simplify it */
925 sp->stream.avail_out = tif->tif_rawdatasize;
926 if ((tmsize_t)sp->stream.avail_out != tif->tif_rawdatasize)
928 TIFFErrorExt(tif->tif_clientdata, module, "ZLib cannot deal with buffers this size");
931 return (deflateReset(&sp->stream) == Z_OK);
935 horizontalDifferenceF(float *ip, int n, int stride, uint16 *wp, uint16 *FromLT2)
937 int32 r1, g1, b1, a1, r2, g2, b2, a2, mask;
938 float fltsize = Fltsize;
940 #define CLAMP(v) ( (v<(float)0.) ? 0 \
941 : (v<(float)2.) ? FromLT2[(int)(v*fltsize)] \
942 : (v>(float)24.2) ? 2047 \
943 : LogK1*log(v*LogK2) + 0.5 )
948 r2 = wp[0] = (uint16) CLAMP(ip[0]);
949 g2 = wp[1] = (uint16) CLAMP(ip[1]);
950 b2 = wp[2] = (uint16) CLAMP(ip[2]);
956 r1 = (int32) CLAMP(ip[0]); wp[0] = (r1-r2) & mask; r2 = r1;
957 g1 = (int32) CLAMP(ip[1]); wp[1] = (g1-g2) & mask; g2 = g1;
958 b1 = (int32) CLAMP(ip[2]); wp[2] = (b1-b2) & mask; b2 = b1;
960 } else if (stride == 4) {
961 r2 = wp[0] = (uint16) CLAMP(ip[0]);
962 g2 = wp[1] = (uint16) CLAMP(ip[1]);
963 b2 = wp[2] = (uint16) CLAMP(ip[2]);
964 a2 = wp[3] = (uint16) CLAMP(ip[3]);
970 r1 = (int32) CLAMP(ip[0]); wp[0] = (r1-r2) & mask; r2 = r1;
971 g1 = (int32) CLAMP(ip[1]); wp[1] = (g1-g2) & mask; g2 = g1;
972 b1 = (int32) CLAMP(ip[2]); wp[2] = (b1-b2) & mask; b2 = b1;
973 a1 = (int32) CLAMP(ip[3]); wp[3] = (a1-a2) & mask; a2 = a1;
976 ip += n - 1; /* point to last one */
977 wp += n - 1; /* point to last one */
980 REPEAT(stride, wp[0] = (uint16) CLAMP(ip[0]);
986 REPEAT(stride, wp[0] = (uint16) CLAMP(ip[0]); wp--; ip--)
992 horizontalDifference16(unsigned short *ip, int n, int stride,
993 unsigned short *wp, uint16 *From14)
995 register int r1, g1, b1, a1, r2, g2, b2, a2, mask;
997 /* assumption is unsigned pixel values */
999 #define CLAMP(v) From14[(v) >> 2]
1004 r2 = wp[0] = CLAMP(ip[0]); g2 = wp[1] = CLAMP(ip[1]);
1005 b2 = wp[2] = CLAMP(ip[2]);
1011 r1 = CLAMP(ip[0]); wp[0] = (r1-r2) & mask; r2 = r1;
1012 g1 = CLAMP(ip[1]); wp[1] = (g1-g2) & mask; g2 = g1;
1013 b1 = CLAMP(ip[2]); wp[2] = (b1-b2) & mask; b2 = b1;
1015 } else if (stride == 4) {
1016 r2 = wp[0] = CLAMP(ip[0]); g2 = wp[1] = CLAMP(ip[1]);
1017 b2 = wp[2] = CLAMP(ip[2]); a2 = wp[3] = CLAMP(ip[3]);
1023 r1 = CLAMP(ip[0]); wp[0] = (r1-r2) & mask; r2 = r1;
1024 g1 = CLAMP(ip[1]); wp[1] = (g1-g2) & mask; g2 = g1;
1025 b1 = CLAMP(ip[2]); wp[2] = (b1-b2) & mask; b2 = b1;
1026 a1 = CLAMP(ip[3]); wp[3] = (a1-a2) & mask; a2 = a1;
1029 ip += n - 1; /* point to last one */
1030 wp += n - 1; /* point to last one */
1033 REPEAT(stride, wp[0] = CLAMP(ip[0]);
1034 wp[stride] -= wp[0];
1039 REPEAT(stride, wp[0] = CLAMP(ip[0]); wp--; ip--)
1046 horizontalDifference8(unsigned char *ip, int n, int stride,
1047 unsigned short *wp, uint16 *From8)
1049 register int r1, g1, b1, a1, r2, g2, b2, a2, mask;
1052 #define CLAMP(v) (From8[(v)])
1057 r2 = wp[0] = CLAMP(ip[0]); g2 = wp[1] = CLAMP(ip[1]);
1058 b2 = wp[2] = CLAMP(ip[2]);
1062 r1 = CLAMP(ip[3]); wp[3] = (r1-r2) & mask; r2 = r1;
1063 g1 = CLAMP(ip[4]); wp[4] = (g1-g2) & mask; g2 = g1;
1064 b1 = CLAMP(ip[5]); wp[5] = (b1-b2) & mask; b2 = b1;
1068 } else if (stride == 4) {
1069 r2 = wp[0] = CLAMP(ip[0]); g2 = wp[1] = CLAMP(ip[1]);
1070 b2 = wp[2] = CLAMP(ip[2]); a2 = wp[3] = CLAMP(ip[3]);
1074 r1 = CLAMP(ip[4]); wp[4] = (r1-r2) & mask; r2 = r1;
1075 g1 = CLAMP(ip[5]); wp[5] = (g1-g2) & mask; g2 = g1;
1076 b1 = CLAMP(ip[6]); wp[6] = (b1-b2) & mask; b2 = b1;
1077 a1 = CLAMP(ip[7]); wp[7] = (a1-a2) & mask; a2 = a1;
1082 wp += n + stride - 1; /* point to last one */
1083 ip += n + stride - 1; /* point to last one */
1086 REPEAT(stride, wp[0] = CLAMP(ip[0]);
1087 wp[stride] -= wp[0];
1092 REPEAT(stride, wp[0] = CLAMP(ip[0]); wp--; ip--)
1098 * Encode a chunk of pixels.
1101 PixarLogEncode(TIFF* tif, uint8* bp, tmsize_t cc, uint16 s)
1103 static const char module[] = "PixarLogEncode";
1104 TIFFDirectory *td = &tif->tif_dir;
1105 PixarLogState *sp = EncoderState(tif);
1109 unsigned short * up;
1113 switch (sp->user_datafmt) {
1114 case PIXARLOGDATAFMT_FLOAT:
1115 n = cc / sizeof(float); /* XXX float == 32 bits */
1117 case PIXARLOGDATAFMT_16BIT:
1118 case PIXARLOGDATAFMT_12BITPICIO:
1119 case PIXARLOGDATAFMT_11BITLOG:
1120 n = cc / sizeof(uint16); /* XXX uint16 == 16 bits */
1122 case PIXARLOGDATAFMT_8BIT:
1123 case PIXARLOGDATAFMT_8BITABGR:
1127 TIFFErrorExt(tif->tif_clientdata, module,
1128 "%d bit input not supported in PixarLog",
1129 td->td_bitspersample);
1133 llen = sp->stride * td->td_imagewidth;
1135 for (i = 0, up = sp->tbuf; i < n; i += llen, up += llen) {
1136 switch (sp->user_datafmt) {
1137 case PIXARLOGDATAFMT_FLOAT:
1138 horizontalDifferenceF((float *)bp, llen,
1139 sp->stride, up, sp->FromLT2);
1140 bp += llen * sizeof(float);
1142 case PIXARLOGDATAFMT_16BIT:
1143 horizontalDifference16((uint16 *)bp, llen,
1144 sp->stride, up, sp->From14);
1145 bp += llen * sizeof(uint16);
1147 case PIXARLOGDATAFMT_8BIT:
1148 horizontalDifference8((unsigned char *)bp, llen,
1149 sp->stride, up, sp->From8);
1150 bp += llen * sizeof(unsigned char);
1153 TIFFErrorExt(tif->tif_clientdata, module,
1154 "%d bit input not supported in PixarLog",
1155 td->td_bitspersample);
1160 sp->stream.next_in = (unsigned char *) sp->tbuf;
1161 assert(sizeof(sp->stream.avail_in)==4); /* if this assert gets raised,
1162 we need to simplify this code to reflect a ZLib that is likely updated
1163 to deal with 8byte memory sizes, though this code will respond
1164 apropriately even before we simplify it */
1165 sp->stream.avail_in = (uInt) (n * sizeof(uint16));
1166 if ((sp->stream.avail_in / sizeof(uint16)) != (uInt) n)
1168 TIFFErrorExt(tif->tif_clientdata, module,
1169 "ZLib cannot deal with buffers this size");
1174 if (deflate(&sp->stream, Z_NO_FLUSH) != Z_OK) {
1175 TIFFErrorExt(tif->tif_clientdata, module, "Encoder error: %s",
1179 if (sp->stream.avail_out == 0) {
1180 tif->tif_rawcc = tif->tif_rawdatasize;
1181 TIFFFlushData1(tif);
1182 sp->stream.next_out = tif->tif_rawdata;
1183 sp->stream.avail_out = (uInt) tif->tif_rawdatasize; /* this is a safe typecast, as check is made already in PixarLogPreEncode */
1185 } while (sp->stream.avail_in > 0);
1190 * Finish off an encoded strip by flushing the last
1191 * string and tacking on an End Of Information code.
1195 PixarLogPostEncode(TIFF* tif)
1197 static const char module[] = "PixarLogPostEncode";
1198 PixarLogState *sp = EncoderState(tif);
1201 sp->stream.avail_in = 0;
1204 state = deflate(&sp->stream, Z_FINISH);
1208 if ((tmsize_t)sp->stream.avail_out != tif->tif_rawdatasize) {
1210 tif->tif_rawdatasize - sp->stream.avail_out;
1211 TIFFFlushData1(tif);
1212 sp->stream.next_out = tif->tif_rawdata;
1213 sp->stream.avail_out = (uInt) tif->tif_rawdatasize; /* this is a safe typecast, as check is made already in PixarLogPreEncode */
1217 TIFFErrorExt(tif->tif_clientdata, module, "ZLib error: %s",
1221 } while (state != Z_STREAM_END);
1226 PixarLogClose(TIFF* tif)
1228 TIFFDirectory *td = &tif->tif_dir;
1230 /* In a really sneaky (and really incorrect, and untruthfull, and
1231 * troublesome, and error-prone) maneuver that completely goes against
1232 * the spirit of TIFF, and breaks TIFF, on close, we covertly
1233 * modify both bitspersample and sampleformat in the directory to
1234 * indicate 8-bit linear. This way, the decode "just works" even for
1235 * readers that don't know about PixarLog, or how to set
1236 * the PIXARLOGDATFMT pseudo-tag.
1238 td->td_bitspersample = 8;
1239 td->td_sampleformat = SAMPLEFORMAT_UINT;
1243 PixarLogCleanup(TIFF* tif)
1245 PixarLogState* sp = (PixarLogState*) tif->tif_data;
1249 (void)TIFFPredictorCleanup(tif);
1251 tif->tif_tagmethods.vgetfield = sp->vgetparent;
1252 tif->tif_tagmethods.vsetfield = sp->vsetparent;
1254 if (sp->FromLT2) _TIFFfree(sp->FromLT2);
1255 if (sp->From14) _TIFFfree(sp->From14);
1256 if (sp->From8) _TIFFfree(sp->From8);
1257 if (sp->ToLinearF) _TIFFfree(sp->ToLinearF);
1258 if (sp->ToLinear16) _TIFFfree(sp->ToLinear16);
1259 if (sp->ToLinear8) _TIFFfree(sp->ToLinear8);
1260 if (sp->state&PLSTATE_INIT) {
1261 if (tif->tif_mode == O_RDONLY)
1262 inflateEnd(&sp->stream);
1264 deflateEnd(&sp->stream);
1267 _TIFFfree(sp->tbuf);
1269 tif->tif_data = NULL;
1271 _TIFFSetDefaultCompressionState(tif);
1275 PixarLogVSetField(TIFF* tif, uint32 tag, va_list ap)
1277 static const char module[] = "PixarLogVSetField";
1278 PixarLogState *sp = (PixarLogState *)tif->tif_data;
1282 case TIFFTAG_PIXARLOGQUALITY:
1283 sp->quality = (int) va_arg(ap, int);
1284 if (tif->tif_mode != O_RDONLY && (sp->state&PLSTATE_INIT)) {
1285 if (deflateParams(&sp->stream,
1286 sp->quality, Z_DEFAULT_STRATEGY) != Z_OK) {
1287 TIFFErrorExt(tif->tif_clientdata, module, "ZLib error: %s",
1293 case TIFFTAG_PIXARLOGDATAFMT:
1294 sp->user_datafmt = (int) va_arg(ap, int);
1295 /* Tweak the TIFF header so that the rest of libtiff knows what
1296 * size of data will be passed between app and library, and
1297 * assume that the app knows what it is doing and is not
1298 * confused by these header manipulations...
1300 switch (sp->user_datafmt) {
1301 case PIXARLOGDATAFMT_8BIT:
1302 case PIXARLOGDATAFMT_8BITABGR:
1303 TIFFSetField(tif, TIFFTAG_BITSPERSAMPLE, 8);
1304 TIFFSetField(tif, TIFFTAG_SAMPLEFORMAT, SAMPLEFORMAT_UINT);
1306 case PIXARLOGDATAFMT_11BITLOG:
1307 TIFFSetField(tif, TIFFTAG_BITSPERSAMPLE, 16);
1308 TIFFSetField(tif, TIFFTAG_SAMPLEFORMAT, SAMPLEFORMAT_UINT);
1310 case PIXARLOGDATAFMT_12BITPICIO:
1311 TIFFSetField(tif, TIFFTAG_BITSPERSAMPLE, 16);
1312 TIFFSetField(tif, TIFFTAG_SAMPLEFORMAT, SAMPLEFORMAT_INT);
1314 case PIXARLOGDATAFMT_16BIT:
1315 TIFFSetField(tif, TIFFTAG_BITSPERSAMPLE, 16);
1316 TIFFSetField(tif, TIFFTAG_SAMPLEFORMAT, SAMPLEFORMAT_UINT);
1318 case PIXARLOGDATAFMT_FLOAT:
1319 TIFFSetField(tif, TIFFTAG_BITSPERSAMPLE, 32);
1320 TIFFSetField(tif, TIFFTAG_SAMPLEFORMAT, SAMPLEFORMAT_IEEEFP);
1324 * Must recalculate sizes should bits/sample change.
1326 tif->tif_tilesize = isTiled(tif) ? TIFFTileSize(tif) : (tmsize_t)(-1);
1327 tif->tif_scanlinesize = TIFFScanlineSize(tif);
1328 result = 1; /* NB: pseudo tag */
1331 result = (*sp->vsetparent)(tif, tag, ap);
1337 PixarLogVGetField(TIFF* tif, uint32 tag, va_list ap)
1339 PixarLogState *sp = (PixarLogState *)tif->tif_data;
1342 case TIFFTAG_PIXARLOGQUALITY:
1343 *va_arg(ap, int*) = sp->quality;
1345 case TIFFTAG_PIXARLOGDATAFMT:
1346 *va_arg(ap, int*) = sp->user_datafmt;
1349 return (*sp->vgetparent)(tif, tag, ap);
1354 static const TIFFField pixarlogFields[] = {
1355 {TIFFTAG_PIXARLOGDATAFMT, 0, 0, TIFF_ANY, 0, TIFF_SETGET_INT, TIFF_SETGET_UNDEFINED, FIELD_PSEUDO, FALSE, FALSE, "", NULL},
1356 {TIFFTAG_PIXARLOGQUALITY, 0, 0, TIFF_ANY, 0, TIFF_SETGET_INT, TIFF_SETGET_UNDEFINED, FIELD_PSEUDO, FALSE, FALSE, "", NULL}
1360 TIFFInitPixarLog(TIFF* tif, int scheme)
1362 static const char module[] = "TIFFInitPixarLog";
1366 assert(scheme == COMPRESSION_PIXARLOG);
1369 * Merge codec-specific tag information.
1371 if (!_TIFFMergeFields(tif, pixarlogFields,
1372 TIFFArrayCount(pixarlogFields))) {
1373 TIFFErrorExt(tif->tif_clientdata, module,
1374 "Merging PixarLog codec-specific tags failed");
1379 * Allocate state block so tag methods have storage to record values.
1381 tif->tif_data = (uint8*) _TIFFmalloc(sizeof (PixarLogState));
1382 if (tif->tif_data == NULL)
1384 sp = (PixarLogState*) tif->tif_data;
1385 _TIFFmemset(sp, 0, sizeof (*sp));
1386 sp->stream.data_type = Z_BINARY;
1387 sp->user_datafmt = PIXARLOGDATAFMT_UNKNOWN;
1390 * Install codec methods.
1392 tif->tif_fixuptags = PixarLogFixupTags;
1393 tif->tif_setupdecode = PixarLogSetupDecode;
1394 tif->tif_predecode = PixarLogPreDecode;
1395 tif->tif_decoderow = PixarLogDecode;
1396 tif->tif_decodestrip = PixarLogDecode;
1397 tif->tif_decodetile = PixarLogDecode;
1398 tif->tif_setupencode = PixarLogSetupEncode;
1399 tif->tif_preencode = PixarLogPreEncode;
1400 tif->tif_postencode = PixarLogPostEncode;
1401 tif->tif_encoderow = PixarLogEncode;
1402 tif->tif_encodestrip = PixarLogEncode;
1403 tif->tif_encodetile = PixarLogEncode;
1404 tif->tif_close = PixarLogClose;
1405 tif->tif_cleanup = PixarLogCleanup;
1407 /* Override SetField so we can handle our private pseudo-tag */
1408 sp->vgetparent = tif->tif_tagmethods.vgetfield;
1409 tif->tif_tagmethods.vgetfield = PixarLogVGetField; /* hook for codec tags */
1410 sp->vsetparent = tif->tif_tagmethods.vsetfield;
1411 tif->tif_tagmethods.vsetfield = PixarLogVSetField; /* hook for codec tags */
1413 /* Default values for codec-specific fields */
1414 sp->quality = Z_DEFAULT_COMPRESSION; /* default comp. level */
1417 /* we don't wish to use the predictor,
1418 * the default is none, which predictor value 1
1420 (void) TIFFPredictorInit(tif);
1423 * build the companding tables
1425 PixarLogMakeTables(sp);
1429 TIFFErrorExt(tif->tif_clientdata, module,
1430 "No space for PixarLog state block");
1433 #endif /* PIXARLOG_SUPPORT */
1435 /* vim: set ts=8 sts=8 sw=8 noet: */