1 /* $Id: tif_fax3.c,v 1.80 2017-04-27 19:50:01 erouault Exp $ */
2
3 /*
4 * Copyright (c) 1990-1997 Sam Leffler
5 * Copyright (c) 1991-1997 Silicon Graphics, Inc.
6 *
7 * Permission to use, copy, modify, distribute, and sell this software and
8 * its documentation for any purpose is hereby granted without fee, provided
9 * that (i) the above copyright notices and this permission notice appear in
10 * all copies of the software and related documentation, and (ii) the names of
11 * Sam Leffler and Silicon Graphics may not be used in any advertising or
12 * publicity relating to the software without the specific, prior written
13 * permission of Sam Leffler and Silicon Graphics.
14 *
15 * THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
16 * EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
17 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
18 *
19 * IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
20 * ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
21 * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
22 * WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
23 * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
24 * OF THIS SOFTWARE.
25 */
26
27 #include "tiffiop.h"
28 #ifdef CCITT_SUPPORT
29 /*
30 * TIFF Library.
31 *
32 * CCITT Group 3 (T.4) and Group 4 (T.6) Compression Support.
33 *
34 * This file contains support for decoding and encoding TIFF
35 * compression algorithms 2, 3, 4, and 32771.
36 *
37 * Decoder support is derived, with permission, from the code
38 * in Frank Cringle's viewfax program;
39 * Copyright (C) 1990, 1995 Frank D. Cringle.
40 */
41 #include "tif_fax3.h"
42 #define G3CODES
43 #include "t4.h"
44 #include <stdio.h>
45
46 /*
47 * Compression+decompression state blocks are
48 * derived from this ``base state'' block.
49 */
50 typedef struct {
51 int rw_mode; /* O_RDONLY for decode, else encode */
52 int mode; /* operating mode */
53 tmsize_t rowbytes; /* bytes in a decoded scanline */
54 uint32 rowpixels; /* pixels in a scanline */
55
56 uint16 cleanfaxdata; /* CleanFaxData tag */
57 uint32 badfaxrun; /* BadFaxRun tag */
58 uint32 badfaxlines; /* BadFaxLines tag */
59 uint32 groupoptions; /* Group 3/4 options tag */
60
61 TIFFVGetMethod vgetparent; /* super-class method */
62 TIFFVSetMethod vsetparent; /* super-class method */
63 TIFFPrintMethod printdir; /* super-class method */
64 } Fax3BaseState;
65 #define Fax3State(tif) ((Fax3BaseState*) (tif)->tif_data)
66
67 typedef enum { G3_1D, G3_2D } Ttag;
68 typedef struct {
69 Fax3BaseState b;
70
71 /* Decoder state info */
72 const unsigned char* bitmap; /* bit reversal table */
73 uint32 data; /* current i/o byte/word */
74 int bit; /* current i/o bit in byte */
75 int EOLcnt; /* count of EOL codes recognized */
76 TIFFFaxFillFunc fill; /* fill routine */
77 uint32* runs; /* b&w runs for current/previous row */
78 uint32* refruns; /* runs for reference line */
79 uint32* curruns; /* runs for current line */
80
81 /* Encoder state info */
82 Ttag tag; /* encoding state */
83 unsigned char* refline; /* reference line for 2d decoding */
84 int k; /* #rows left that can be 2d encoded */
85 int maxk; /* max #rows that can be 2d encoded */
86
87 int line;
88 } Fax3CodecState;
89 #define DecoderState(tif) ((Fax3CodecState*) Fax3State(tif))
90 #define EncoderState(tif) ((Fax3CodecState*) Fax3State(tif))
91
92 #define is2DEncoding(sp) (sp->b.groupoptions & GROUP3OPT_2DENCODING)
93 #define isAligned(p,t) ((((size_t)(p)) & (sizeof (t)-1)) == 0)
94
95 /*
96 * Group 3 and Group 4 Decoding.
97 */
98
99 /*
100 * These macros glue the TIFF library state to
101 * the state expected by Frank's decoder.
102 */
103 #define DECLARE_STATE(tif, sp, mod) \
104 static const char module[] = mod; \
105 Fax3CodecState* sp = DecoderState(tif); \
106 int a0; /* reference element */ \
107 int lastx = sp->b.rowpixels; /* last element in row */ \
108 uint32 BitAcc; /* bit accumulator */ \
109 int BitsAvail; /* # valid bits in BitAcc */ \
110 int RunLength; /* length of current run */ \
111 unsigned char* cp; /* next byte of input data */ \
112 unsigned char* ep; /* end of input data */ \
113 uint32* pa; /* place to stuff next run */ \
114 uint32* thisrun; /* current row's run array */ \
115 int EOLcnt; /* # EOL codes recognized */ \
116 const unsigned char* bitmap = sp->bitmap; /* input data bit reverser */ \
117 const TIFFFaxTabEnt* TabEnt
118 #define DECLARE_STATE_2D(tif, sp, mod) \
119 DECLARE_STATE(tif, sp, mod); \
120 int b1; /* next change on prev line */ \
121 uint32* pb /* next run in reference line */\
122 /*
123 * Load any state that may be changed during decoding.
124 */
125 #define CACHE_STATE(tif, sp) do { \
126 BitAcc = sp->data; \
127 BitsAvail = sp->bit; \
128 EOLcnt = sp->EOLcnt; \
129 cp = (unsigned char*) tif->tif_rawcp; \
130 ep = cp + tif->tif_rawcc; \
131 } while (0)
132 /*
133 * Save state possibly changed during decoding.
134 */
135 #define UNCACHE_STATE(tif, sp) do { \
136 sp->bit = BitsAvail; \
137 sp->data = BitAcc; \
138 sp->EOLcnt = EOLcnt; \
139 tif->tif_rawcc -= (tmsize_t)((uint8*) cp - tif->tif_rawcp); \
140 tif->tif_rawcp = (uint8*) cp; \
141 } while (0)
142
143 /*
144 * Setup state for decoding a strip.
145 */
146 static int
Fax3PreDecode(TIFF * tif,uint16 s)147 Fax3PreDecode(TIFF* tif, uint16 s)
148 {
149 Fax3CodecState* sp = DecoderState(tif);
150
151 (void) s;
152 assert(sp != NULL);
153 sp->bit = 0; /* force initial read */
154 sp->data = 0;
155 sp->EOLcnt = 0; /* force initial scan for EOL */
156 /*
157 * Decoder assumes lsb-to-msb bit order. Note that we select
158 * this here rather than in Fax3SetupState so that viewers can
159 * hold the image open, fiddle with the FillOrder tag value,
160 * and then re-decode the image. Otherwise they'd need to close
161 * and open the image to get the state reset.
162 */
163 sp->bitmap =
164 TIFFGetBitRevTable(tif->tif_dir.td_fillorder != FILLORDER_LSB2MSB);
165 if (sp->refruns) { /* init reference line to white */
166 sp->refruns[0] = (uint32) sp->b.rowpixels;
167 sp->refruns[1] = 0;
168 }
169 sp->line = 0;
170 return (1);
171 }
172
173 /*
174 * Routine for handling various errors/conditions.
175 * Note how they are "glued into the decoder" by
176 * overriding the definitions used by the decoder.
177 */
178
179 static void
Fax3Unexpected(const char * module,TIFF * tif,uint32 line,uint32 a0)180 Fax3Unexpected(const char* module, TIFF* tif, uint32 line, uint32 a0)
181 {
182 TIFFErrorExt(tif->tif_clientdata, module, "Bad code word at line %u of %s %u (x %u)",
183 line, isTiled(tif) ? "tile" : "strip",
184 (isTiled(tif) ? tif->tif_curtile : tif->tif_curstrip),
185 a0);
186 }
187 #define unexpected(table, a0) Fax3Unexpected(module, tif, sp->line, a0)
188
189 static void
Fax3Extension(const char * module,TIFF * tif,uint32 line,uint32 a0)190 Fax3Extension(const char* module, TIFF* tif, uint32 line, uint32 a0)
191 {
192 TIFFErrorExt(tif->tif_clientdata, module,
193 "Uncompressed data (not supported) at line %u of %s %u (x %u)",
194 line, isTiled(tif) ? "tile" : "strip",
195 (isTiled(tif) ? tif->tif_curtile : tif->tif_curstrip),
196 a0);
197 }
198 #define extension(a0) Fax3Extension(module, tif, sp->line, a0)
199
200 static void
Fax3BadLength(const char * module,TIFF * tif,uint32 line,uint32 a0,uint32 lastx)201 Fax3BadLength(const char* module, TIFF* tif, uint32 line, uint32 a0, uint32 lastx)
202 {
203 TIFFWarningExt(tif->tif_clientdata, module, "%s at line %u of %s %u (got %u, expected %u)",
204 a0 < lastx ? "Premature EOL" : "Line length mismatch",
205 line, isTiled(tif) ? "tile" : "strip",
206 (isTiled(tif) ? tif->tif_curtile : tif->tif_curstrip),
207 a0, lastx);
208 }
209 #define badlength(a0,lastx) Fax3BadLength(module, tif, sp->line, a0, lastx)
210
211 static void
Fax3PrematureEOF(const char * module,TIFF * tif,uint32 line,uint32 a0)212 Fax3PrematureEOF(const char* module, TIFF* tif, uint32 line, uint32 a0)
213 {
214 TIFFWarningExt(tif->tif_clientdata, module, "Premature EOF at line %u of %s %u (x %u)",
215 line, isTiled(tif) ? "tile" : "strip",
216 (isTiled(tif) ? tif->tif_curtile : tif->tif_curstrip),
217 a0);
218 }
219 #define prematureEOF(a0) Fax3PrematureEOF(module, tif, sp->line, a0)
220
221 #define Nop
222
223 /*
224 * Decode the requested amount of G3 1D-encoded data.
225 */
226 static int
Fax3Decode1D(TIFF * tif,uint8 * buf,tmsize_t occ,uint16 s)227 Fax3Decode1D(TIFF* tif, uint8* buf, tmsize_t occ, uint16 s)
228 {
229 DECLARE_STATE(tif, sp, "Fax3Decode1D");
230 (void) s;
231 if (occ % sp->b.rowbytes)
232 {
233 TIFFErrorExt(tif->tif_clientdata, module, "Fractional scanlines cannot be read");
234 return (-1);
235 }
236 CACHE_STATE(tif, sp);
237 thisrun = sp->curruns;
238 while (occ > 0) {
239 a0 = 0;
240 RunLength = 0;
241 pa = thisrun;
242 #ifdef FAX3_DEBUG
243 printf("\nBitAcc=%08X, BitsAvail = %d\n", BitAcc, BitsAvail);
244 printf("-------------------- %d\n", tif->tif_row);
245 fflush(stdout);
246 #endif
247 SYNC_EOL(EOF1D);
248 EXPAND1D(EOF1Da);
249 (*sp->fill)(buf, thisrun, pa, lastx);
250 buf += sp->b.rowbytes;
251 occ -= sp->b.rowbytes;
252 sp->line++;
253 continue;
254 EOF1D: /* premature EOF */
255 CLEANUP_RUNS();
256 EOF1Da: /* premature EOF */
257 (*sp->fill)(buf, thisrun, pa, lastx);
258 UNCACHE_STATE(tif, sp);
259 return (-1);
260 }
261 UNCACHE_STATE(tif, sp);
262 return (1);
263 }
264
265 #define SWAP(t,a,b) { t x; x = (a); (a) = (b); (b) = x; }
266 /*
267 * Decode the requested amount of G3 2D-encoded data.
268 */
269 static int
Fax3Decode2D(TIFF * tif,uint8 * buf,tmsize_t occ,uint16 s)270 Fax3Decode2D(TIFF* tif, uint8* buf, tmsize_t occ, uint16 s)
271 {
272 DECLARE_STATE_2D(tif, sp, "Fax3Decode2D");
273 int is1D; /* current line is 1d/2d-encoded */
274 (void) s;
275 if (occ % sp->b.rowbytes)
276 {
277 TIFFErrorExt(tif->tif_clientdata, module, "Fractional scanlines cannot be read");
278 return (-1);
279 }
280 CACHE_STATE(tif, sp);
281 while (occ > 0) {
282 a0 = 0;
283 RunLength = 0;
284 pa = thisrun = sp->curruns;
285 #ifdef FAX3_DEBUG
286 printf("\nBitAcc=%08X, BitsAvail = %d EOLcnt = %d",
287 BitAcc, BitsAvail, EOLcnt);
288 #endif
289 SYNC_EOL(EOF2D);
290 NeedBits8(1, EOF2D);
291 is1D = GetBits(1); /* 1D/2D-encoding tag bit */
292 ClrBits(1);
293 #ifdef FAX3_DEBUG
294 printf(" %s\n-------------------- %d\n",
295 is1D ? "1D" : "2D", tif->tif_row);
296 fflush(stdout);
297 #endif
298 pb = sp->refruns;
299 b1 = *pb++;
300 if (is1D)
301 EXPAND1D(EOF2Da);
302 else
303 EXPAND2D(EOF2Da);
304 (*sp->fill)(buf, thisrun, pa, lastx);
305 SETVALUE(0); /* imaginary change for reference */
306 SWAP(uint32*, sp->curruns, sp->refruns);
307 buf += sp->b.rowbytes;
308 occ -= sp->b.rowbytes;
309 sp->line++;
310 continue;
311 EOF2D: /* premature EOF */
312 CLEANUP_RUNS();
313 EOF2Da: /* premature EOF */
314 (*sp->fill)(buf, thisrun, pa, lastx);
315 UNCACHE_STATE(tif, sp);
316 return (-1);
317 }
318 UNCACHE_STATE(tif, sp);
319 return (1);
320 }
321 #undef SWAP
322
323 /*
324 * The ZERO & FILL macros must handle spans < 2*sizeof(long) bytes.
325 * For machines with 64-bit longs this is <16 bytes; otherwise
326 * this is <8 bytes. We optimize the code here to reflect the
327 * machine characteristics.
328 */
329 #if SIZEOF_UNSIGNED_LONG == 8
330 # define FILL(n, cp) \
331 switch (n) { \
332 case 15:(cp)[14] = 0xff; /*-fallthrough*/ \
333 case 14:(cp)[13] = 0xff; /*-fallthrough*/ \
334 case 13:(cp)[12] = 0xff; /*-fallthrough*/ \
335 case 12:(cp)[11] = 0xff; /*-fallthrough*/ \
336 case 11:(cp)[10] = 0xff; /*-fallthrough*/ \
337 case 10: (cp)[9] = 0xff; /*-fallthrough*/ \
338 case 9: (cp)[8] = 0xff; /*-fallthrough*/ \
339 case 8: (cp)[7] = 0xff; /*-fallthrough*/ \
340 case 7: (cp)[6] = 0xff; /*-fallthrough*/ \
341 case 6: (cp)[5] = 0xff; /*-fallthrough*/ \
342 case 5: (cp)[4] = 0xff; /*-fallthrough*/ \
343 case 4: (cp)[3] = 0xff; /*-fallthrough*/ \
344 case 3: (cp)[2] = 0xff; /*-fallthrough*/ \
345 case 2: (cp)[1] = 0xff; /*-fallthrough*/ \
346 case 1: (cp)[0] = 0xff; (cp) += (n); /*-fallthrough*/ \
347 case 0: ; \
348 }
349 # define ZERO(n, cp) \
350 switch (n) { \
351 case 15:(cp)[14] = 0; /*-fallthrough*/ \
352 case 14:(cp)[13] = 0; /*-fallthrough*/ \
353 case 13:(cp)[12] = 0; /*-fallthrough*/ \
354 case 12:(cp)[11] = 0; /*-fallthrough*/ \
355 case 11:(cp)[10] = 0; /*-fallthrough*/ \
356 case 10: (cp)[9] = 0; /*-fallthrough*/ \
357 case 9: (cp)[8] = 0; /*-fallthrough*/ \
358 case 8: (cp)[7] = 0; /*-fallthrough*/ \
359 case 7: (cp)[6] = 0; /*-fallthrough*/ \
360 case 6: (cp)[5] = 0; /*-fallthrough*/ \
361 case 5: (cp)[4] = 0; /*-fallthrough*/ \
362 case 4: (cp)[3] = 0; /*-fallthrough*/ \
363 case 3: (cp)[2] = 0; /*-fallthrough*/ \
364 case 2: (cp)[1] = 0; /*-fallthrough*/ \
365 case 1: (cp)[0] = 0; (cp) += (n); /*-fallthrough*/ \
366 case 0: ; \
367 }
368 #else
369 # define FILL(n, cp) \
370 switch (n) { \
371 case 7: (cp)[6] = 0xff; /*-fallthrough*/ \
372 case 6: (cp)[5] = 0xff; /*-fallthrough*/ \
373 case 5: (cp)[4] = 0xff; /*-fallthrough*/ \
374 case 4: (cp)[3] = 0xff; /*-fallthrough*/ \
375 case 3: (cp)[2] = 0xff; /*-fallthrough*/ \
376 case 2: (cp)[1] = 0xff; /*-fallthrough*/ \
377 case 1: (cp)[0] = 0xff; (cp) += (n); /*-fallthrough*/ \
378 case 0: ; \
379 }
380 # define ZERO(n, cp) \
381 switch (n) { \
382 case 7: (cp)[6] = 0; /*-fallthrough*/ \
383 case 6: (cp)[5] = 0; /*-fallthrough*/ \
384 case 5: (cp)[4] = 0; /*-fallthrough*/ \
385 case 4: (cp)[3] = 0; /*-fallthrough*/ \
386 case 3: (cp)[2] = 0; /*-fallthrough*/ \
387 case 2: (cp)[1] = 0; /*-fallthrough*/ \
388 case 1: (cp)[0] = 0; (cp) += (n); /*-fallthrough*/ \
389 case 0: ; \
390 }
391 #endif
392
393 /*
394 * Bit-fill a row according to the white/black
395 * runs generated during G3/G4 decoding.
396 */
397 void
_TIFFFax3fillruns(unsigned char * buf,uint32 * runs,uint32 * erun,uint32 lastx)398 _TIFFFax3fillruns(unsigned char* buf, uint32* runs, uint32* erun, uint32 lastx)
399 {
400 static const unsigned char _fillmasks[] =
401 { 0x00, 0x80, 0xc0, 0xe0, 0xf0, 0xf8, 0xfc, 0xfe, 0xff };
402 unsigned char* cp;
403 uint32 x, bx, run;
404 int32 n, nw;
405 long* lp;
406
407 if ((erun-runs)&1)
408 *erun++ = 0;
409 x = 0;
410 for (; runs < erun; runs += 2) {
411 run = runs[0];
412 if (x+run > lastx || run > lastx )
413 run = runs[0] = (uint32) (lastx - x);
414 if (run) {
415 cp = buf + (x>>3);
416 bx = x&7;
417 if (run > 8-bx) {
418 if (bx) { /* align to byte boundary */
419 *cp++ &= 0xff << (8-bx);
420 run -= 8-bx;
421 }
422 if( (n = run >> 3) != 0 ) { /* multiple bytes to fill */
423 if ((n/sizeof (long)) > 1) {
424 /*
425 * Align to longword boundary and fill.
426 */
427 for (; n && !isAligned(cp, long); n--)
428 *cp++ = 0x00;
429 lp = (long*) cp;
430 nw = (int32)(n / sizeof (long));
431 n -= nw * sizeof (long);
432 do {
433 *lp++ = 0L;
434 } while (--nw);
435 cp = (unsigned char*) lp;
436 }
437 ZERO(n, cp);
438 run &= 7;
439 }
440 if (run)
441 cp[0] &= 0xff >> run;
442 } else
443 cp[0] &= ~(_fillmasks[run]>>bx);
444 x += runs[0];
445 }
446 run = runs[1];
447 if (x+run > lastx || run > lastx )
448 run = runs[1] = lastx - x;
449 if (run) {
450 cp = buf + (x>>3);
451 bx = x&7;
452 if (run > 8-bx) {
453 if (bx) { /* align to byte boundary */
454 *cp++ |= 0xff >> bx;
455 run -= 8-bx;
456 }
457 if( (n = run>>3) != 0 ) { /* multiple bytes to fill */
458 if ((n/sizeof (long)) > 1) {
459 /*
460 * Align to longword boundary and fill.
461 */
462 for (; n && !isAligned(cp, long); n--)
463 *cp++ = 0xff;
464 lp = (long*) cp;
465 nw = (int32)(n / sizeof (long));
466 n -= nw * sizeof (long);
467 do {
468 *lp++ = -1L;
469 } while (--nw);
470 cp = (unsigned char*) lp;
471 }
472 FILL(n, cp);
473 run &= 7;
474 }
475 /* Explicit 0xff masking to make icc -check=conversions happy */
476 if (run)
477 cp[0] = (unsigned char)((cp[0] | (0xff00 >> run))&0xff);
478 } else
479 cp[0] |= _fillmasks[run]>>bx;
480 x += runs[1];
481 }
482 }
483 assert(x == lastx);
484 }
485 #undef ZERO
486 #undef FILL
487
488 static int
Fax3FixupTags(TIFF * tif)489 Fax3FixupTags(TIFF* tif)
490 {
491 (void) tif;
492 return (1);
493 }
494
495 /*
496 * Setup G3/G4-related compression/decompression state
497 * before data is processed. This routine is called once
498 * per image -- it sets up different state based on whether
499 * or not decoding or encoding is being done and whether
500 * 1D- or 2D-encoded data is involved.
501 */
502 static int
Fax3SetupState(TIFF * tif)503 Fax3SetupState(TIFF* tif)
504 {
505 static const char module[] = "Fax3SetupState";
506 TIFFDirectory* td = &tif->tif_dir;
507 Fax3BaseState* sp = Fax3State(tif);
508 int needsRefLine;
509 Fax3CodecState* dsp = (Fax3CodecState*) Fax3State(tif);
510 tmsize_t rowbytes;
511 uint32 rowpixels, nruns;
512
513 if (td->td_bitspersample != 1) {
514 TIFFErrorExt(tif->tif_clientdata, module,
515 "Bits/sample must be 1 for Group 3/4 encoding/decoding");
516 return (0);
517 }
518 /*
519 * Calculate the scanline/tile widths.
520 */
521 if (isTiled(tif)) {
522 rowbytes = TIFFTileRowSize(tif);
523 rowpixels = td->td_tilewidth;
524 } else {
525 rowbytes = TIFFScanlineSize(tif);
526 rowpixels = td->td_imagewidth;
527 }
528 sp->rowbytes = rowbytes;
529 sp->rowpixels = rowpixels;
530 /*
531 * Allocate any additional space required for decoding/encoding.
532 */
533 needsRefLine = (
534 (sp->groupoptions & GROUP3OPT_2DENCODING) ||
535 td->td_compression == COMPRESSION_CCITTFAX4
536 );
537
538 /*
539 Assure that allocation computations do not overflow.
540
541 TIFFroundup and TIFFSafeMultiply return zero on integer overflow
542 */
543 dsp->runs=(uint32*) NULL;
544 nruns = TIFFroundup_32(rowpixels,32);
545 if (needsRefLine) {
546 nruns = TIFFSafeMultiply(uint32,nruns,2);
547 }
548 if ((nruns == 0) || (TIFFSafeMultiply(uint32,nruns,2) == 0)) {
549 TIFFErrorExt(tif->tif_clientdata, tif->tif_name,
550 "Row pixels integer overflow (rowpixels %u)",
551 rowpixels);
552 return (0);
553 }
554 dsp->runs = (uint32*) _TIFFCheckMalloc(tif,
555 TIFFSafeMultiply(uint32,nruns,2),
556 sizeof (uint32),
557 "for Group 3/4 run arrays");
558 if (dsp->runs == NULL)
559 return (0);
560 memset( dsp->runs, 0, TIFFSafeMultiply(uint32,nruns,2)*sizeof(uint32));
561 dsp->curruns = dsp->runs;
562 if (needsRefLine)
563 dsp->refruns = dsp->runs + nruns;
564 else
565 dsp->refruns = NULL;
566 if (td->td_compression == COMPRESSION_CCITTFAX3
567 && is2DEncoding(dsp)) { /* NB: default is 1D routine */
568 tif->tif_decoderow = Fax3Decode2D;
569 tif->tif_decodestrip = Fax3Decode2D;
570 tif->tif_decodetile = Fax3Decode2D;
571 }
572
573 if (needsRefLine) { /* 2d encoding */
574 Fax3CodecState* esp = EncoderState(tif);
575 /*
576 * 2d encoding requires a scanline
577 * buffer for the ``reference line''; the
578 * scanline against which delta encoding
579 * is referenced. The reference line must
580 * be initialized to be ``white'' (done elsewhere).
581 */
582 esp->refline = (unsigned char*) _TIFFmalloc(rowbytes);
583 if (esp->refline == NULL) {
584 TIFFErrorExt(tif->tif_clientdata, module,
585 "No space for Group 3/4 reference line");
586 return (0);
587 }
588 } else /* 1d encoding */
589 EncoderState(tif)->refline = NULL;
590
591 return (1);
592 }
593
594 /*
595 * CCITT Group 3 FAX Encoding.
596 */
597
598 #define Fax3FlushBits(tif, sp) { \
599 if ((tif)->tif_rawcc >= (tif)->tif_rawdatasize) \
600 (void) TIFFFlushData1(tif); \
601 *(tif)->tif_rawcp++ = (uint8) (sp)->data; \
602 (tif)->tif_rawcc++; \
603 (sp)->data = 0, (sp)->bit = 8; \
604 }
605 #define _FlushBits(tif) { \
606 if ((tif)->tif_rawcc >= (tif)->tif_rawdatasize) \
607 (void) TIFFFlushData1(tif); \
608 *(tif)->tif_rawcp++ = (uint8) data; \
609 (tif)->tif_rawcc++; \
610 data = 0, bit = 8; \
611 }
612 static const int _msbmask[9] =
613 { 0x00, 0x01, 0x03, 0x07, 0x0f, 0x1f, 0x3f, 0x7f, 0xff };
614 #define _PutBits(tif, bits, length) { \
615 while (length > bit) { \
616 data |= bits >> (length - bit); \
617 length -= bit; \
618 _FlushBits(tif); \
619 } \
620 assert( length < 9 ); \
621 data |= (bits & _msbmask[length]) << (bit - length); \
622 bit -= length; \
623 if (bit == 0) \
624 _FlushBits(tif); \
625 }
626
627 /*
628 * Write a variable-length bit-value to
629 * the output stream. Values are
630 * assumed to be at most 16 bits.
631 */
632 static void
Fax3PutBits(TIFF * tif,unsigned int bits,unsigned int length)633 Fax3PutBits(TIFF* tif, unsigned int bits, unsigned int length)
634 {
635 Fax3CodecState* sp = EncoderState(tif);
636 unsigned int bit = sp->bit;
637 int data = sp->data;
638
639 _PutBits(tif, bits, length);
640
641 sp->data = data;
642 sp->bit = bit;
643 }
644
645 /*
646 * Write a code to the output stream.
647 */
648 #define putcode(tif, te) Fax3PutBits(tif, (te)->code, (te)->length)
649
650 #ifdef FAX3_DEBUG
651 #define DEBUG_COLOR(w) (tab == TIFFFaxWhiteCodes ? w "W" : w "B")
652 #define DEBUG_PRINT(what,len) { \
653 int t; \
654 printf("%08X/%-2d: %s%5d\t", data, bit, DEBUG_COLOR(what), len); \
655 for (t = length-1; t >= 0; t--) \
656 putchar(code & (1<<t) ? '1' : '0'); \
657 putchar('\n'); \
658 }
659 #endif
660
661 /*
662 * Write the sequence of codes that describes
663 * the specified span of zero's or one's. The
664 * appropriate table that holds the make-up and
665 * terminating codes is supplied.
666 */
667 static void
putspan(TIFF * tif,int32 span,const tableentry * tab)668 putspan(TIFF* tif, int32 span, const tableentry* tab)
669 {
670 Fax3CodecState* sp = EncoderState(tif);
671 unsigned int bit = sp->bit;
672 int data = sp->data;
673 unsigned int code, length;
674
675 while (span >= 2624) {
676 const tableentry* te = &tab[63 + (2560>>6)];
677 code = te->code;
678 length = te->length;
679 #ifdef FAX3_DEBUG
680 DEBUG_PRINT("MakeUp", te->runlen);
681 #endif
682 _PutBits(tif, code, length);
683 span -= te->runlen;
684 }
685 if (span >= 64) {
686 const tableentry* te = &tab[63 + (span>>6)];
687 assert(te->runlen == 64*(span>>6));
688 code = te->code;
689 length = te->length;
690 #ifdef FAX3_DEBUG
691 DEBUG_PRINT("MakeUp", te->runlen);
692 #endif
693 _PutBits(tif, code, length);
694 span -= te->runlen;
695 }
696 code = tab[span].code;
697 length = tab[span].length;
698 #ifdef FAX3_DEBUG
699 DEBUG_PRINT(" Term", tab[span].runlen);
700 #endif
701 _PutBits(tif, code, length);
702
703 sp->data = data;
704 sp->bit = bit;
705 }
706
707 /*
708 * Write an EOL code to the output stream. The zero-fill
709 * logic for byte-aligning encoded scanlines is handled
710 * here. We also handle writing the tag bit for the next
711 * scanline when doing 2d encoding.
712 */
713 static void
Fax3PutEOL(TIFF * tif)714 Fax3PutEOL(TIFF* tif)
715 {
716 Fax3CodecState* sp = EncoderState(tif);
717 unsigned int bit = sp->bit;
718 int data = sp->data;
719 unsigned int code, length, tparm;
720
721 if (sp->b.groupoptions & GROUP3OPT_FILLBITS) {
722 /*
723 * Force bit alignment so EOL will terminate on
724 * a byte boundary. That is, force the bit alignment
725 * to 16-12 = 4 before putting out the EOL code.
726 */
727 int align = 8 - 4;
728 if (align != sp->bit) {
729 if (align > sp->bit)
730 align = sp->bit + (8 - align);
731 else
732 align = sp->bit - align;
733 tparm=align;
734 _PutBits(tif, 0, tparm);
735 }
736 }
737 code = EOL;
738 length = 12;
739 if (is2DEncoding(sp)) {
740 code = (code<<1) | (sp->tag == G3_1D);
741 length++;
742 }
743 _PutBits(tif, code, length);
744
745 sp->data = data;
746 sp->bit = bit;
747 }
748
749 /*
750 * Reset encoding state at the start of a strip.
751 */
752 static int
Fax3PreEncode(TIFF * tif,uint16 s)753 Fax3PreEncode(TIFF* tif, uint16 s)
754 {
755 Fax3CodecState* sp = EncoderState(tif);
756
757 (void) s;
758 assert(sp != NULL);
759 sp->bit = 8;
760 sp->data = 0;
761 sp->tag = G3_1D;
762 /*
763 * This is necessary for Group 4; otherwise it isn't
764 * needed because the first scanline of each strip ends
765 * up being copied into the refline.
766 */
767 if (sp->refline)
768 _TIFFmemset(sp->refline, 0x00, sp->b.rowbytes);
769 if (is2DEncoding(sp)) {
770 float res = tif->tif_dir.td_yresolution;
771 /*
772 * The CCITT spec says that when doing 2d encoding, you
773 * should only do it on K consecutive scanlines, where K
774 * depends on the resolution of the image being encoded
775 * (2 for <= 200 lpi, 4 for > 200 lpi). Since the directory
776 * code initializes td_yresolution to 0, this code will
777 * select a K of 2 unless the YResolution tag is set
778 * appropriately. (Note also that we fudge a little here
779 * and use 150 lpi to avoid problems with units conversion.)
780 */
781 if (tif->tif_dir.td_resolutionunit == RESUNIT_CENTIMETER)
782 res *= 2.54f; /* convert to inches */
783 sp->maxk = (res > 150 ? 4 : 2);
784 sp->k = sp->maxk-1;
785 } else
786 sp->k = sp->maxk = 0;
787 sp->line = 0;
788 return (1);
789 }
790
791 static const unsigned char zeroruns[256] = {
792 8, 7, 6, 6, 5, 5, 5, 5, 4, 4, 4, 4, 4, 4, 4, 4, /* 0x00 - 0x0f */
793 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, /* 0x10 - 0x1f */
794 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /* 0x20 - 0x2f */
795 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /* 0x30 - 0x3f */
796 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 0x40 - 0x4f */
797 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 0x50 - 0x5f */
798 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 0x60 - 0x6f */
799 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 0x70 - 0x7f */
800 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x80 - 0x8f */
801 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x90 - 0x9f */
802 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xa0 - 0xaf */
803 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xb0 - 0xbf */
804 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xc0 - 0xcf */
805 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xd0 - 0xdf */
806 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xe0 - 0xef */
807 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xf0 - 0xff */
808 };
809 static const unsigned char oneruns[256] = {
810 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x00 - 0x0f */
811 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x10 - 0x1f */
812 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x20 - 0x2f */
813 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x30 - 0x3f */
814 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x40 - 0x4f */
815 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x50 - 0x5f */
816 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x60 - 0x6f */
817 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x70 - 0x7f */
818 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 0x80 - 0x8f */
819 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 0x90 - 0x9f */
820 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 0xa0 - 0xaf */
821 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 0xb0 - 0xbf */
822 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /* 0xc0 - 0xcf */
823 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /* 0xd0 - 0xdf */
824 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, /* 0xe0 - 0xef */
825 4, 4, 4, 4, 4, 4, 4, 4, 5, 5, 5, 5, 6, 6, 7, 8, /* 0xf0 - 0xff */
826 };
827
828 /*
829 * On certain systems it pays to inline
830 * the routines that find pixel spans.
831 */
832 #ifdef VAXC
833 static int32 find0span(unsigned char*, int32, int32);
834 static int32 find1span(unsigned char*, int32, int32);
835 #pragma inline(find0span,find1span)
836 #endif
837
838 /*
839 * Find a span of ones or zeros using the supplied
840 * table. The ``base'' of the bit string is supplied
841 * along with the start+end bit indices.
842 */
843 inline static int32
find0span(unsigned char * bp,int32 bs,int32 be)844 find0span(unsigned char* bp, int32 bs, int32 be)
845 {
846 int32 bits = be - bs;
847 int32 n, span;
848
849 bp += bs>>3;
850 /*
851 * Check partial byte on lhs.
852 */
853 if (bits > 0 && (n = (bs & 7)) != 0) {
854 span = zeroruns[(*bp << n) & 0xff];
855 if (span > 8-n) /* table value too generous */
856 span = 8-n;
857 if (span > bits) /* constrain span to bit range */
858 span = bits;
859 if (n+span < 8) /* doesn't extend to edge of byte */
860 return (span);
861 bits -= span;
862 bp++;
863 } else
864 span = 0;
865 if (bits >= (int32)(2 * 8 * sizeof(long))) {
866 long* lp;
867 /*
868 * Align to longword boundary and check longwords.
869 */
870 while (!isAligned(bp, long)) {
871 if (*bp != 0x00)
872 return (span + zeroruns[*bp]);
873 span += 8;
874 bits -= 8;
875 bp++;
876 }
877 lp = (long*) bp;
878 while ((bits >= (int32)(8 * sizeof(long))) && (0 == *lp)) {
879 span += 8*sizeof (long);
880 bits -= 8*sizeof (long);
881 lp++;
882 }
883 bp = (unsigned char*) lp;
884 }
885 /*
886 * Scan full bytes for all 0's.
887 */
888 while (bits >= 8) {
889 if (*bp != 0x00) /* end of run */
890 return (span + zeroruns[*bp]);
891 span += 8;
892 bits -= 8;
893 bp++;
894 }
895 /*
896 * Check partial byte on rhs.
897 */
898 if (bits > 0) {
899 n = zeroruns[*bp];
900 span += (n > bits ? bits : n);
901 }
902 return (span);
903 }
904
905 inline static int32
find1span(unsigned char * bp,int32 bs,int32 be)906 find1span(unsigned char* bp, int32 bs, int32 be)
907 {
908 int32 bits = be - bs;
909 int32 n, span;
910
911 bp += bs>>3;
912 /*
913 * Check partial byte on lhs.
914 */
915 if (bits > 0 && (n = (bs & 7)) != 0) {
916 span = oneruns[(*bp << n) & 0xff];
917 if (span > 8-n) /* table value too generous */
918 span = 8-n;
919 if (span > bits) /* constrain span to bit range */
920 span = bits;
921 if (n+span < 8) /* doesn't extend to edge of byte */
922 return (span);
923 bits -= span;
924 bp++;
925 } else
926 span = 0;
927 if (bits >= (int32)(2 * 8 * sizeof(long))) {
928 long* lp;
929 /*
930 * Align to longword boundary and check longwords.
931 */
932 while (!isAligned(bp, long)) {
933 if (*bp != 0xff)
934 return (span + oneruns[*bp]);
935 span += 8;
936 bits -= 8;
937 bp++;
938 }
939 lp = (long*) bp;
940 while ((bits >= (int32)(8 * sizeof(long))) && (~0 == *lp)) {
941 span += 8*sizeof (long);
942 bits -= 8*sizeof (long);
943 lp++;
944 }
945 bp = (unsigned char*) lp;
946 }
947 /*
948 * Scan full bytes for all 1's.
949 */
950 while (bits >= 8) {
951 if (*bp != 0xff) /* end of run */
952 return (span + oneruns[*bp]);
953 span += 8;
954 bits -= 8;
955 bp++;
956 }
957 /*
958 * Check partial byte on rhs.
959 */
960 if (bits > 0) {
961 n = oneruns[*bp];
962 span += (n > bits ? bits : n);
963 }
964 return (span);
965 }
966
967 /*
968 * Return the offset of the next bit in the range
969 * [bs..be] that is different from the specified
970 * color. The end, be, is returned if no such bit
971 * exists.
972 */
973 #define finddiff(_cp, _bs, _be, _color) \
974 (_bs + (_color ? find1span(_cp,_bs,_be) : find0span(_cp,_bs,_be)))
975 /*
976 * Like finddiff, but also check the starting bit
977 * against the end in case start > end.
978 */
979 #define finddiff2(_cp, _bs, _be, _color) \
980 (_bs < _be ? finddiff(_cp,_bs,_be,_color) : _be)
981
982 /*
983 * 1d-encode a row of pixels. The encoding is
984 * a sequence of all-white or all-black spans
985 * of pixels encoded with Huffman codes.
986 */
987 static int
Fax3Encode1DRow(TIFF * tif,unsigned char * bp,uint32 bits)988 Fax3Encode1DRow(TIFF* tif, unsigned char* bp, uint32 bits)
989 {
990 Fax3CodecState* sp = EncoderState(tif);
991 int32 span;
992 uint32 bs = 0;
993
994 for (;;) {
995 span = find0span(bp, bs, bits); /* white span */
996 putspan(tif, span, TIFFFaxWhiteCodes);
997 bs += span;
998 if (bs >= bits)
999 break;
1000 span = find1span(bp, bs, bits); /* black span */
1001 putspan(tif, span, TIFFFaxBlackCodes);
1002 bs += span;
1003 if (bs >= bits)
1004 break;
1005 }
1006 if (sp->b.mode & (FAXMODE_BYTEALIGN|FAXMODE_WORDALIGN)) {
1007 if (sp->bit != 8) /* byte-align */
1008 Fax3FlushBits(tif, sp);
1009 if ((sp->b.mode&FAXMODE_WORDALIGN) &&
1010 !isAligned(tif->tif_rawcp, uint16))
1011 Fax3FlushBits(tif, sp);
1012 }
1013 return (1);
1014 }
1015
1016 static const tableentry horizcode =
1017 { 3, 0x1, 0 }; /* 001 */
1018 static const tableentry passcode =
1019 { 4, 0x1, 0 }; /* 0001 */
1020 static const tableentry vcodes[7] = {
1021 { 7, 0x03, 0 }, /* 0000 011 */
1022 { 6, 0x03, 0 }, /* 0000 11 */
1023 { 3, 0x03, 0 }, /* 011 */
1024 { 1, 0x1, 0 }, /* 1 */
1025 { 3, 0x2, 0 }, /* 010 */
1026 { 6, 0x02, 0 }, /* 0000 10 */
1027 { 7, 0x02, 0 } /* 0000 010 */
1028 };
1029
1030 /*
1031 * 2d-encode a row of pixels. Consult the CCITT
1032 * documentation for the algorithm.
1033 */
1034 static int
Fax3Encode2DRow(TIFF * tif,unsigned char * bp,unsigned char * rp,uint32 bits)1035 Fax3Encode2DRow(TIFF* tif, unsigned char* bp, unsigned char* rp, uint32 bits)
1036 {
1037 #define PIXEL(buf,ix) ((((buf)[(ix)>>3]) >> (7-((ix)&7))) & 1)
1038 uint32 a0 = 0;
1039 uint32 a1 = (PIXEL(bp, 0) != 0 ? 0 : finddiff(bp, 0, bits, 0));
1040 uint32 b1 = (PIXEL(rp, 0) != 0 ? 0 : finddiff(rp, 0, bits, 0));
1041 uint32 a2, b2;
1042
1043 for (;;) {
1044 b2 = finddiff2(rp, b1, bits, PIXEL(rp,b1));
1045 if (b2 >= a1) {
1046 int32 d = b1 - a1;
1047 if (!(-3 <= d && d <= 3)) { /* horizontal mode */
1048 a2 = finddiff2(bp, a1, bits, PIXEL(bp,a1));
1049 putcode(tif, &horizcode);
1050 if (a0+a1 == 0 || PIXEL(bp, a0) == 0) {
1051 putspan(tif, a1-a0, TIFFFaxWhiteCodes);
1052 putspan(tif, a2-a1, TIFFFaxBlackCodes);
1053 } else {
1054 putspan(tif, a1-a0, TIFFFaxBlackCodes);
1055 putspan(tif, a2-a1, TIFFFaxWhiteCodes);
1056 }
1057 a0 = a2;
1058 } else { /* vertical mode */
1059 putcode(tif, &vcodes[d+3]);
1060 a0 = a1;
1061 }
1062 } else { /* pass mode */
1063 putcode(tif, &passcode);
1064 a0 = b2;
1065 }
1066 if (a0 >= bits)
1067 break;
1068 a1 = finddiff(bp, a0, bits, PIXEL(bp,a0));
1069 b1 = finddiff(rp, a0, bits, !PIXEL(bp,a0));
1070 b1 = finddiff(rp, b1, bits, PIXEL(bp,a0));
1071 }
1072 return (1);
1073 #undef PIXEL
1074 }
1075
1076 /*
1077 * Encode a buffer of pixels.
1078 */
1079 static int
Fax3Encode(TIFF * tif,uint8 * bp,tmsize_t cc,uint16 s)1080 Fax3Encode(TIFF* tif, uint8* bp, tmsize_t cc, uint16 s)
1081 {
1082 static const char module[] = "Fax3Encode";
1083 Fax3CodecState* sp = EncoderState(tif);
1084 (void) s;
1085 if (cc % sp->b.rowbytes)
1086 {
1087 TIFFErrorExt(tif->tif_clientdata, module, "Fractional scanlines cannot be written");
1088 return (0);
1089 }
1090 while (cc > 0) {
1091 if ((sp->b.mode & FAXMODE_NOEOL) == 0)
1092 Fax3PutEOL(tif);
1093 if (is2DEncoding(sp)) {
1094 if (sp->tag == G3_1D) {
1095 if (!Fax3Encode1DRow(tif, bp, sp->b.rowpixels))
1096 return (0);
1097 sp->tag = G3_2D;
1098 } else {
1099 if (!Fax3Encode2DRow(tif, bp, sp->refline,
1100 sp->b.rowpixels))
1101 return (0);
1102 sp->k--;
1103 }
1104 if (sp->k == 0) {
1105 sp->tag = G3_1D;
1106 sp->k = sp->maxk-1;
1107 } else
1108 _TIFFmemcpy(sp->refline, bp, sp->b.rowbytes);
1109 } else {
1110 if (!Fax3Encode1DRow(tif, bp, sp->b.rowpixels))
1111 return (0);
1112 }
1113 bp += sp->b.rowbytes;
1114 cc -= sp->b.rowbytes;
1115 }
1116 return (1);
1117 }
1118
1119 static int
Fax3PostEncode(TIFF * tif)1120 Fax3PostEncode(TIFF* tif)
1121 {
1122 Fax3CodecState* sp = EncoderState(tif);
1123
1124 if (sp->bit != 8)
1125 Fax3FlushBits(tif, sp);
1126 return (1);
1127 }
1128
1129 static void
Fax3Close(TIFF * tif)1130 Fax3Close(TIFF* tif)
1131 {
1132 if ((Fax3State(tif)->mode & FAXMODE_NORTC) == 0 && tif->tif_rawcp) {
1133 Fax3CodecState* sp = EncoderState(tif);
1134 unsigned int code = EOL;
1135 unsigned int length = 12;
1136 int i;
1137
1138 if (is2DEncoding(sp)) {
1139 code = (code<<1) | (sp->tag == G3_1D);
1140 length++;
1141 }
1142 for (i = 0; i < 6; i++)
1143 Fax3PutBits(tif, code, length);
1144 Fax3FlushBits(tif, sp);
1145 }
1146 }
1147
1148 static void
Fax3Cleanup(TIFF * tif)1149 Fax3Cleanup(TIFF* tif)
1150 {
1151 Fax3CodecState* sp = DecoderState(tif);
1152
1153 assert(sp != 0);
1154
1155 tif->tif_tagmethods.vgetfield = sp->b.vgetparent;
1156 tif->tif_tagmethods.vsetfield = sp->b.vsetparent;
1157 tif->tif_tagmethods.printdir = sp->b.printdir;
1158
1159 if (sp->runs)
1160 _TIFFfree(sp->runs);
1161 if (sp->refline)
1162 _TIFFfree(sp->refline);
1163
1164 _TIFFfree(tif->tif_data);
1165 tif->tif_data = NULL;
1166
1167 _TIFFSetDefaultCompressionState(tif);
1168 }
1169
1170 #define FIELD_BADFAXLINES (FIELD_CODEC+0)
1171 #define FIELD_CLEANFAXDATA (FIELD_CODEC+1)
1172 #define FIELD_BADFAXRUN (FIELD_CODEC+2)
1173
1174 #define FIELD_OPTIONS (FIELD_CODEC+7)
1175
1176 static const TIFFField faxFields[] = {
1177 { TIFFTAG_FAXMODE, 0, 0, TIFF_ANY, 0, TIFF_SETGET_INT, TIFF_SETGET_UNDEFINED, FIELD_PSEUDO, FALSE, FALSE, "FaxMode", NULL },
1178 { TIFFTAG_FAXFILLFUNC, 0, 0, TIFF_ANY, 0, TIFF_SETGET_OTHER, TIFF_SETGET_UNDEFINED, FIELD_PSEUDO, FALSE, FALSE, "FaxFillFunc", NULL },
1179 { TIFFTAG_BADFAXLINES, 1, 1, TIFF_LONG, 0, TIFF_SETGET_UINT32, TIFF_SETGET_UINT32, FIELD_BADFAXLINES, TRUE, FALSE, "BadFaxLines", NULL },
1180 { TIFFTAG_CLEANFAXDATA, 1, 1, TIFF_SHORT, 0, TIFF_SETGET_UINT16, TIFF_SETGET_UINT16, FIELD_CLEANFAXDATA, TRUE, FALSE, "CleanFaxData", NULL },
1181 { TIFFTAG_CONSECUTIVEBADFAXLINES, 1, 1, TIFF_LONG, 0, TIFF_SETGET_UINT32, TIFF_SETGET_UINT32, FIELD_BADFAXRUN, TRUE, FALSE, "ConsecutiveBadFaxLines", NULL }};
1182 static const TIFFField fax3Fields[] = {
1183 { TIFFTAG_GROUP3OPTIONS, 1, 1, TIFF_LONG, 0, TIFF_SETGET_UINT32, TIFF_SETGET_UINT32, FIELD_OPTIONS, FALSE, FALSE, "Group3Options", NULL },
1184 };
1185 static const TIFFField fax4Fields[] = {
1186 { TIFFTAG_GROUP4OPTIONS, 1, 1, TIFF_LONG, 0, TIFF_SETGET_UINT32, TIFF_SETGET_UINT32, FIELD_OPTIONS, FALSE, FALSE, "Group4Options", NULL },
1187 };
1188
1189 static int
Fax3VSetField(TIFF * tif,uint32 tag,va_list ap)1190 Fax3VSetField(TIFF* tif, uint32 tag, va_list ap)
1191 {
1192 Fax3BaseState* sp = Fax3State(tif);
1193 const TIFFField* fip;
1194
1195 assert(sp != 0);
1196 assert(sp->vsetparent != 0);
1197
1198 switch (tag) {
1199 case TIFFTAG_FAXMODE:
1200 sp->mode = (int) va_arg(ap, int);
1201 return 1; /* NB: pseudo tag */
1202 case TIFFTAG_FAXFILLFUNC:
1203 DecoderState(tif)->fill = va_arg(ap, TIFFFaxFillFunc);
1204 return 1; /* NB: pseudo tag */
1205 case TIFFTAG_GROUP3OPTIONS:
1206 /* XXX: avoid reading options if compression mismatches. */
1207 if (tif->tif_dir.td_compression == COMPRESSION_CCITTFAX3)
1208 sp->groupoptions = (uint32) va_arg(ap, uint32);
1209 break;
1210 case TIFFTAG_GROUP4OPTIONS:
1211 /* XXX: avoid reading options if compression mismatches. */
1212 if (tif->tif_dir.td_compression == COMPRESSION_CCITTFAX4)
1213 sp->groupoptions = (uint32) va_arg(ap, uint32);
1214 break;
1215 case TIFFTAG_BADFAXLINES:
1216 sp->badfaxlines = (uint32) va_arg(ap, uint32);
1217 break;
1218 case TIFFTAG_CLEANFAXDATA:
1219 sp->cleanfaxdata = (uint16) va_arg(ap, uint16_vap);
1220 break;
1221 case TIFFTAG_CONSECUTIVEBADFAXLINES:
1222 sp->badfaxrun = (uint32) va_arg(ap, uint32);
1223 break;
1224 default:
1225 return (*sp->vsetparent)(tif, tag, ap);
1226 }
1227
1228 if ((fip = TIFFFieldWithTag(tif, tag)) != NULL)
1229 TIFFSetFieldBit(tif, fip->field_bit);
1230 else
1231 return 0;
1232
1233 tif->tif_flags |= TIFF_DIRTYDIRECT;
1234 return 1;
1235 }
1236
1237 static int
Fax3VGetField(TIFF * tif,uint32 tag,va_list ap)1238 Fax3VGetField(TIFF* tif, uint32 tag, va_list ap)
1239 {
1240 Fax3BaseState* sp = Fax3State(tif);
1241
1242 assert(sp != 0);
1243
1244 switch (tag) {
1245 case TIFFTAG_FAXMODE:
1246 *va_arg(ap, int*) = sp->mode;
1247 break;
1248 case TIFFTAG_FAXFILLFUNC:
1249 *va_arg(ap, TIFFFaxFillFunc*) = DecoderState(tif)->fill;
1250 break;
1251 case TIFFTAG_GROUP3OPTIONS:
1252 case TIFFTAG_GROUP4OPTIONS:
1253 *va_arg(ap, uint32*) = sp->groupoptions;
1254 break;
1255 case TIFFTAG_BADFAXLINES:
1256 *va_arg(ap, uint32*) = sp->badfaxlines;
1257 break;
1258 case TIFFTAG_CLEANFAXDATA:
1259 *va_arg(ap, uint16*) = sp->cleanfaxdata;
1260 break;
1261 case TIFFTAG_CONSECUTIVEBADFAXLINES:
1262 *va_arg(ap, uint32*) = sp->badfaxrun;
1263 break;
1264 default:
1265 return (*sp->vgetparent)(tif, tag, ap);
1266 }
1267 return (1);
1268 }
1269
1270 static void
Fax3PrintDir(TIFF * tif,FILE * fd,long flags)1271 Fax3PrintDir(TIFF* tif, FILE* fd, long flags)
1272 {
1273 Fax3BaseState* sp = Fax3State(tif);
1274
1275 assert(sp != 0);
1276
1277 (void) flags;
1278 if (TIFFFieldSet(tif,FIELD_OPTIONS)) {
1279 const char* sep = " ";
1280 if (tif->tif_dir.td_compression == COMPRESSION_CCITTFAX4) {
1281 fprintf(fd, " Group 4 Options:");
1282 if (sp->groupoptions & GROUP4OPT_UNCOMPRESSED)
1283 fprintf(fd, "%suncompressed data", sep);
1284 } else {
1285
1286 fprintf(fd, " Group 3 Options:");
1287 if (sp->groupoptions & GROUP3OPT_2DENCODING) {
1288 fprintf(fd, "%s2-d encoding", sep);
1289 sep = "+";
1290 }
1291 if (sp->groupoptions & GROUP3OPT_FILLBITS) {
1292 fprintf(fd, "%sEOL padding", sep);
1293 sep = "+";
1294 }
1295 if (sp->groupoptions & GROUP3OPT_UNCOMPRESSED)
1296 fprintf(fd, "%suncompressed data", sep);
1297 }
1298 fprintf(fd, " (%lu = 0x%lx)\n",
1299 (unsigned long) sp->groupoptions,
1300 (unsigned long) sp->groupoptions);
1301 }
1302 if (TIFFFieldSet(tif,FIELD_CLEANFAXDATA)) {
1303 fprintf(fd, " Fax Data:");
1304 switch (sp->cleanfaxdata) {
1305 case CLEANFAXDATA_CLEAN:
1306 fprintf(fd, " clean");
1307 break;
1308 case CLEANFAXDATA_REGENERATED:
1309 fprintf(fd, " receiver regenerated");
1310 break;
1311 case CLEANFAXDATA_UNCLEAN:
1312 fprintf(fd, " uncorrected errors");
1313 break;
1314 }
1315 fprintf(fd, " (%u = 0x%x)\n",
1316 sp->cleanfaxdata, sp->cleanfaxdata);
1317 }
1318 if (TIFFFieldSet(tif,FIELD_BADFAXLINES))
1319 fprintf(fd, " Bad Fax Lines: %lu\n",
1320 (unsigned long) sp->badfaxlines);
1321 if (TIFFFieldSet(tif,FIELD_BADFAXRUN))
1322 fprintf(fd, " Consecutive Bad Fax Lines: %lu\n",
1323 (unsigned long) sp->badfaxrun);
1324 if (sp->printdir)
1325 (*sp->printdir)(tif, fd, flags);
1326 }
1327
1328 static int
InitCCITTFax3(TIFF * tif)1329 InitCCITTFax3(TIFF* tif)
1330 {
1331 static const char module[] = "InitCCITTFax3";
1332 Fax3BaseState* sp;
1333
1334 /*
1335 * Merge codec-specific tag information.
1336 */
1337 if (!_TIFFMergeFields(tif, faxFields, TIFFArrayCount(faxFields))) {
1338 TIFFErrorExt(tif->tif_clientdata, "InitCCITTFax3",
1339 "Merging common CCITT Fax codec-specific tags failed");
1340 return 0;
1341 }
1342
1343 /*
1344 * Allocate state block so tag methods have storage to record values.
1345 */
1346 tif->tif_data = (uint8*)
1347 _TIFFmalloc(sizeof (Fax3CodecState));
1348
1349 if (tif->tif_data == NULL) {
1350 TIFFErrorExt(tif->tif_clientdata, module,
1351 "No space for state block");
1352 return (0);
1353 }
1354 _TIFFmemset(tif->tif_data, 0, sizeof (Fax3CodecState));
1355
1356 sp = Fax3State(tif);
1357 sp->rw_mode = tif->tif_mode;
1358
1359 /*
1360 * Override parent get/set field methods.
1361 */
1362 sp->vgetparent = tif->tif_tagmethods.vgetfield;
1363 tif->tif_tagmethods.vgetfield = Fax3VGetField; /* hook for codec tags */
1364 sp->vsetparent = tif->tif_tagmethods.vsetfield;
1365 tif->tif_tagmethods.vsetfield = Fax3VSetField; /* hook for codec tags */
1366 sp->printdir = tif->tif_tagmethods.printdir;
1367 tif->tif_tagmethods.printdir = Fax3PrintDir; /* hook for codec tags */
1368 sp->groupoptions = 0;
1369
1370 if (sp->rw_mode == O_RDONLY) /* FIXME: improve for in place update */
1371 tif->tif_flags |= TIFF_NOBITREV; /* decoder does bit reversal */
1372 DecoderState(tif)->runs = NULL;
1373 TIFFSetField(tif, TIFFTAG_FAXFILLFUNC, _TIFFFax3fillruns);
1374 EncoderState(tif)->refline = NULL;
1375
1376 /*
1377 * Install codec methods.
1378 */
1379 tif->tif_fixuptags = Fax3FixupTags;
1380 tif->tif_setupdecode = Fax3SetupState;
1381 tif->tif_predecode = Fax3PreDecode;
1382 tif->tif_decoderow = Fax3Decode1D;
1383 tif->tif_decodestrip = Fax3Decode1D;
1384 tif->tif_decodetile = Fax3Decode1D;
1385 tif->tif_setupencode = Fax3SetupState;
1386 tif->tif_preencode = Fax3PreEncode;
1387 tif->tif_postencode = Fax3PostEncode;
1388 tif->tif_encoderow = Fax3Encode;
1389 tif->tif_encodestrip = Fax3Encode;
1390 tif->tif_encodetile = Fax3Encode;
1391 tif->tif_close = Fax3Close;
1392 tif->tif_cleanup = Fax3Cleanup;
1393
1394 return (1);
1395 }
1396
1397 int
TIFFInitCCITTFax3(TIFF * tif,int scheme)1398 TIFFInitCCITTFax3(TIFF* tif, int scheme)
1399 {
1400 (void) scheme;
1401 if (InitCCITTFax3(tif)) {
1402 /*
1403 * Merge codec-specific tag information.
1404 */
1405 if (!_TIFFMergeFields(tif, fax3Fields,
1406 TIFFArrayCount(fax3Fields))) {
1407 TIFFErrorExt(tif->tif_clientdata, "TIFFInitCCITTFax3",
1408 "Merging CCITT Fax 3 codec-specific tags failed");
1409 return 0;
1410 }
1411
1412 /*
1413 * The default format is Class/F-style w/o RTC.
1414 */
1415 return TIFFSetField(tif, TIFFTAG_FAXMODE, FAXMODE_CLASSF);
1416 } else
1417 return 01;
1418 }
1419
1420 /*
1421 * CCITT Group 4 (T.6) Facsimile-compatible
1422 * Compression Scheme Support.
1423 */
1424
1425 #define SWAP(t,a,b) { t x; x = (a); (a) = (b); (b) = x; }
1426 /*
1427 * Decode the requested amount of G4-encoded data.
1428 */
1429 static int
Fax4Decode(TIFF * tif,uint8 * buf,tmsize_t occ,uint16 s)1430 Fax4Decode(TIFF* tif, uint8* buf, tmsize_t occ, uint16 s)
1431 {
1432 DECLARE_STATE_2D(tif, sp, "Fax4Decode");
1433 (void) s;
1434 if (occ % sp->b.rowbytes)
1435 {
1436 TIFFErrorExt(tif->tif_clientdata, module, "Fractional scanlines cannot be read");
1437 return (-1);
1438 }
1439 CACHE_STATE(tif, sp);
1440 while (occ > 0) {
1441 a0 = 0;
1442 RunLength = 0;
1443 pa = thisrun = sp->curruns;
1444 pb = sp->refruns;
1445 b1 = *pb++;
1446 #ifdef FAX3_DEBUG
1447 printf("\nBitAcc=%08X, BitsAvail = %d\n", BitAcc, BitsAvail);
1448 printf("-------------------- %d\n", tif->tif_row);
1449 fflush(stdout);
1450 #endif
1451 EXPAND2D(EOFG4);
1452 if (EOLcnt)
1453 goto EOFG4;
1454 (*sp->fill)(buf, thisrun, pa, lastx);
1455 SETVALUE(0); /* imaginary change for reference */
1456 SWAP(uint32*, sp->curruns, sp->refruns);
1457 buf += sp->b.rowbytes;
1458 occ -= sp->b.rowbytes;
1459 sp->line++;
1460 continue;
1461 EOFG4:
1462 NeedBits16( 13, BADG4 );
1463 BADG4:
1464 #ifdef FAX3_DEBUG
1465 if( GetBits(13) != 0x1001 )
1466 fputs( "Bad EOFB\n", stderr );
1467 #endif
1468 ClrBits( 13 );
1469 (*sp->fill)(buf, thisrun, pa, lastx);
1470 UNCACHE_STATE(tif, sp);
1471 return ( sp->line ? 1 : -1); /* don't error on badly-terminated strips */
1472 }
1473 UNCACHE_STATE(tif, sp);
1474 return (1);
1475 }
1476 #undef SWAP
1477
1478 /*
1479 * Encode the requested amount of data.
1480 */
1481 static int
Fax4Encode(TIFF * tif,uint8 * bp,tmsize_t cc,uint16 s)1482 Fax4Encode(TIFF* tif, uint8* bp, tmsize_t cc, uint16 s)
1483 {
1484 static const char module[] = "Fax4Encode";
1485 Fax3CodecState *sp = EncoderState(tif);
1486 (void) s;
1487 if (cc % sp->b.rowbytes)
1488 {
1489 TIFFErrorExt(tif->tif_clientdata, module, "Fractional scanlines cannot be written");
1490 return (0);
1491 }
1492 while (cc > 0) {
1493 if (!Fax3Encode2DRow(tif, bp, sp->refline, sp->b.rowpixels))
1494 return (0);
1495 _TIFFmemcpy(sp->refline, bp, sp->b.rowbytes);
1496 bp += sp->b.rowbytes;
1497 cc -= sp->b.rowbytes;
1498 }
1499 return (1);
1500 }
1501
1502 static int
Fax4PostEncode(TIFF * tif)1503 Fax4PostEncode(TIFF* tif)
1504 {
1505 Fax3CodecState *sp = EncoderState(tif);
1506
1507 /* terminate strip w/ EOFB */
1508 Fax3PutBits(tif, EOL, 12);
1509 Fax3PutBits(tif, EOL, 12);
1510 if (sp->bit != 8)
1511 Fax3FlushBits(tif, sp);
1512 return (1);
1513 }
1514
1515 int
TIFFInitCCITTFax4(TIFF * tif,int scheme)1516 TIFFInitCCITTFax4(TIFF* tif, int scheme)
1517 {
1518 (void) scheme;
1519 if (InitCCITTFax3(tif)) { /* reuse G3 support */
1520 /*
1521 * Merge codec-specific tag information.
1522 */
1523 if (!_TIFFMergeFields(tif, fax4Fields,
1524 TIFFArrayCount(fax4Fields))) {
1525 TIFFErrorExt(tif->tif_clientdata, "TIFFInitCCITTFax4",
1526 "Merging CCITT Fax 4 codec-specific tags failed");
1527 return 0;
1528 }
1529
1530 tif->tif_decoderow = Fax4Decode;
1531 tif->tif_decodestrip = Fax4Decode;
1532 tif->tif_decodetile = Fax4Decode;
1533 tif->tif_encoderow = Fax4Encode;
1534 tif->tif_encodestrip = Fax4Encode;
1535 tif->tif_encodetile = Fax4Encode;
1536 tif->tif_postencode = Fax4PostEncode;
1537 /*
1538 * Suppress RTC at the end of each strip.
1539 */
1540 return TIFFSetField(tif, TIFFTAG_FAXMODE, FAXMODE_NORTC);
1541 } else
1542 return (0);
1543 }
1544
1545 /*
1546 * CCITT Group 3 1-D Modified Huffman RLE Compression Support.
1547 * (Compression algorithms 2 and 32771)
1548 */
1549
1550 /*
1551 * Decode the requested amount of RLE-encoded data.
1552 */
1553 static int
Fax3DecodeRLE(TIFF * tif,uint8 * buf,tmsize_t occ,uint16 s)1554 Fax3DecodeRLE(TIFF* tif, uint8* buf, tmsize_t occ, uint16 s)
1555 {
1556 DECLARE_STATE(tif, sp, "Fax3DecodeRLE");
1557 int mode = sp->b.mode;
1558 (void) s;
1559 if (occ % sp->b.rowbytes)
1560 {
1561 TIFFErrorExt(tif->tif_clientdata, module, "Fractional scanlines cannot be read");
1562 return (-1);
1563 }
1564 CACHE_STATE(tif, sp);
1565 thisrun = sp->curruns;
1566 while (occ > 0) {
1567 a0 = 0;
1568 RunLength = 0;
1569 pa = thisrun;
1570 #ifdef FAX3_DEBUG
1571 printf("\nBitAcc=%08X, BitsAvail = %d\n", BitAcc, BitsAvail);
1572 printf("-------------------- %d\n", tif->tif_row);
1573 fflush(stdout);
1574 #endif
1575 EXPAND1D(EOFRLE);
1576 (*sp->fill)(buf, thisrun, pa, lastx);
1577 /*
1578 * Cleanup at the end of the row.
1579 */
1580 if (mode & FAXMODE_BYTEALIGN) {
1581 int n = BitsAvail - (BitsAvail &~ 7);
1582 ClrBits(n);
1583 } else if (mode & FAXMODE_WORDALIGN) {
1584 int n = BitsAvail - (BitsAvail &~ 15);
1585 ClrBits(n);
1586 if (BitsAvail == 0 && !isAligned(cp, uint16))
1587 cp++;
1588 }
1589 buf += sp->b.rowbytes;
1590 occ -= sp->b.rowbytes;
1591 sp->line++;
1592 continue;
1593 EOFRLE: /* premature EOF */
1594 (*sp->fill)(buf, thisrun, pa, lastx);
1595 UNCACHE_STATE(tif, sp);
1596 return (-1);
1597 }
1598 UNCACHE_STATE(tif, sp);
1599 return (1);
1600 }
1601
1602 int
TIFFInitCCITTRLE(TIFF * tif,int scheme)1603 TIFFInitCCITTRLE(TIFF* tif, int scheme)
1604 {
1605 (void) scheme;
1606 if (InitCCITTFax3(tif)) { /* reuse G3 support */
1607 tif->tif_decoderow = Fax3DecodeRLE;
1608 tif->tif_decodestrip = Fax3DecodeRLE;
1609 tif->tif_decodetile = Fax3DecodeRLE;
1610 /*
1611 * Suppress RTC+EOLs when encoding and byte-align data.
1612 */
1613 return TIFFSetField(tif, TIFFTAG_FAXMODE,
1614 FAXMODE_NORTC|FAXMODE_NOEOL|FAXMODE_BYTEALIGN);
1615 } else
1616 return (0);
1617 }
1618
1619 int
TIFFInitCCITTRLEW(TIFF * tif,int scheme)1620 TIFFInitCCITTRLEW(TIFF* tif, int scheme)
1621 {
1622 (void) scheme;
1623 if (InitCCITTFax3(tif)) { /* reuse G3 support */
1624 tif->tif_decoderow = Fax3DecodeRLE;
1625 tif->tif_decodestrip = Fax3DecodeRLE;
1626 tif->tif_decodetile = Fax3DecodeRLE;
1627 /*
1628 * Suppress RTC+EOLs when encoding and word-align data.
1629 */
1630 return TIFFSetField(tif, TIFFTAG_FAXMODE,
1631 FAXMODE_NORTC|FAXMODE_NOEOL|FAXMODE_WORDALIGN);
1632 } else
1633 return (0);
1634 }
1635 #endif /* CCITT_SUPPORT */
1636
1637 /* vim: set ts=8 sts=8 sw=8 noet: */
1638 /*
1639 * Local Variables:
1640 * mode: c
1641 * c-basic-offset: 8
1642 * fill-column: 78
1643 * End:
1644 */
1645