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