core/src/fxcodec/fx_tiff/tiff_v403/tif_fax3.c

   1 /* $Id: tif_fax3.c,v 1.74 2012-06-21 02:01:31 fwarmerdam 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 #if (!defined(_FPDFAPI_MINI_) || defined(_TIFF_DECODER_)) && !defined(_USE_ADDIN_) && !defined _FX_NO_ANSIC_ && !defined(_FX_EMB_NOUSE_DECODER_)
  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
 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
 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
 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
 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
 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
 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
 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; case 14:(cp)[13] = 0xff; case 13: (cp)[12] = 0xff;\
 333     case 12:(cp)[11] = 0xff; case 11:(cp)[10] = 0xff; case 10: (cp)[9] = 0xff;\
 334     case  9: (cp)[8] = 0xff; case  8: (cp)[7] = 0xff; case  7: (cp)[6] = 0xff;\
 335     case  6: (cp)[5] = 0xff; case  5: (cp)[4] = 0xff; case  4: (cp)[3] = 0xff;\
 336     case  3: (cp)[2] = 0xff; case  2: (cp)[1] = 0xff;                         \
 337     case  1: (cp)[0] = 0xff; (cp) += (n); case 0:  ;                          \
 338     }
 339 # define ZERO(n, cp)                                                    \
 340     switch (n) {                                                        \
 341     case 15:(cp)[14] = 0; case 14:(cp)[13] = 0; case 13: (cp)[12] = 0;  \
 342     case 12:(cp)[11] = 0; case 11:(cp)[10] = 0; case 10: (cp)[9] = 0;   \
 343     case  9: (cp)[8] = 0; case  8: (cp)[7] = 0; case  7: (cp)[6] = 0;   \
 344     case  6: (cp)[5] = 0; case  5: (cp)[4] = 0; case  4: (cp)[3] = 0;   \
 345     case  3: (cp)[2] = 0; case  2: (cp)[1] = 0;                         \
 346     case  1: (cp)[0] = 0; (cp) += (n); case 0:  ;                       \
 347     }
 348 #else
 349 # define FILL(n, cp)                                                        \
 350     switch (n) {                                                            \
 351     case 7: (cp)[6] = 0xff; case 6: (cp)[5] = 0xff; case 5: (cp)[4] = 0xff; \
 352     case 4: (cp)[3] = 0xff; case 3: (cp)[2] = 0xff; case 2: (cp)[1] = 0xff; \
 353     case 1: (cp)[0] = 0xff; (cp) += (n); case 0:  ;                         \
 354     }
 355 # define ZERO(n, cp)                                                    \
 356     switch (n) {                                                        \
 357     case 7: (cp)[6] = 0; case 6: (cp)[5] = 0; case 5: (cp)[4] = 0;      \
 358     case 4: (cp)[3] = 0; case 3: (cp)[2] = 0; case 2: (cp)[1] = 0;      \
 359     case 1: (cp)[0] = 0; (cp) += (n); case 0:  ;                        \
 360     }
 361 #endif
 362
 363 /*
 364  * Bit-fill a row according to the white/black
 365  * runs generated during G3/G4 decoding.
 366  */
 367 void
 368 _TIFFFax3fillruns(unsigned char* buf, uint32* runs, uint32* erun, uint32 lastx)
 369 {
 370         static const unsigned char _fillmasks[] =
 371             { 0x00, 0x80, 0xc0, 0xe0, 0xf0, 0xf8, 0xfc, 0xfe, 0xff };
 372         unsigned char* cp;
 373         uint32 x, bx, run,bx_;/* add bx_ = 8-bx for avoid ms evc compiler bug*/
 374         int32 n, nw;
 375         long* lp;
 376
 377         if ((erun-runs)&1)
 378             *erun++ = 0;
 379         x = 0;
 380         for (; runs < erun; runs += 2) {
 381             run = runs[0];
 382             if (x+run > lastx || run > lastx )
 383                 run = runs[0] = (uint32) (lastx - x);
 384             if (run) {
 385                 cp = buf + (x>>3);
 386                 bx = x&7;
 387 //              if (run > 8-bx) {
 388 //                      if (bx) {                       /* align to byte boundary */
 389 //                              *cp++ &= 0xff << (8-bx);
 390 //                              run -= 8-bx;
 391 //                  }
 392 //Modify by Sunliang.Liu 20090804
 393 //Detail: For avoid ms evc compiler bug in WCE ARMV4(I) Release
 394                 bx_ = 8-bx;
 395                 if (run > bx_) {
 396                     if (bx) {                   /* align to byte boundary */
 397                         *cp++ &= 0xff << bx_;
 398                         run -= bx_;
 399                     }
 400                     if( (n = run >> 3) != 0 ) { /* multiple bytes to fill */
 401                         if ((n/sizeof (long)) > 1) {
 402                             /*
 403                              * Align to longword boundary and fill.
 404                              */
 405                             for (; n && !isAligned(cp, long); n--)
 406                                     *cp++ = 0x00;
 407                             lp = (long*) cp;
 408                             nw = (int32)(n / sizeof (long));
 409                             n -= nw * sizeof (long);
 410                             do {
 411                                     *lp++ = 0L;
 412                             } while (--nw);
 413                             cp = (unsigned char*) lp;
 414                         }
 415 #ifdef FAX3_DEBUG
 416                         printf("_TIFFFax3fillruns ZERO: %d\n",n);
 417 #endif
 418                         ZERO(n, cp);
 419                         run &= 7;
 420                     }
 421                     if (run)
 422                         cp[0] &= 0xff >> run;
 423                 } else
 424                     cp[0] &= ~(_fillmasks[run]>>bx);
 425                 x += runs[0];
 426             }
 427             run = runs[1];
 428             if (x+run > lastx || run > lastx )
 429                 run = runs[1] = lastx - x;
 430             if (run) {
 431                 cp = buf + (x>>3);
 432                 bx = x&7;
 433                 if (run > 8-bx) {
 434                     if (bx) {                   /* align to byte boundary */
 435                         *cp++ |= 0xff >> bx;
 436                         run -= 8-bx;
 437                     }
 438                     if( (n = run>>3) != 0 ) {   /* multiple bytes to fill */
 439                         if ((n/sizeof (long)) > 1) {
 440                             /*
 441                              * Align to longword boundary and fill.
 442                              */
 443                             for (; n && !isAligned(cp, long); n--)
 444                                 *cp++ = 0xff;
 445                             lp = (long*) cp;
 446                             nw = (int32)(n / sizeof (long));
 447                             n -= nw * sizeof (long);
 448                             do {
 449                                 *lp++ = -1L;
 450                             } while (--nw);
 451                             cp = (unsigned char*) lp;
 452                         }
 453 #ifdef FAX3_DEBUG
 454                         printf("_TIFFFax3fillruns FILL: %d\n",n);
 455 #endif
 456                         FILL(n, cp);
 457                         run &= 7;
 458                     }
 459                     if (run)
 460                         cp[0] |= 0xff00 >> run;
 461                 } else
 462                     cp[0] |= _fillmasks[run]>>bx;
 463                 x += runs[1];
 464             }
 465         }
 466         assert(x == lastx);
 467 }
 468 #undef  ZERO
 469 #undef  FILL
 470
 471 static int
 472 Fax3FixupTags(TIFF* tif)
 473 {
 474         (void) tif;
 475         return (1);
 476 }
 477
 478 /*
 479  * Setup G3/G4-related compression/decompression state
 480  * before data is processed.  This routine is called once
 481  * per image -- it sets up different state based on whether
 482  * or not decoding or encoding is being done and whether
 483  * 1D- or 2D-encoded data is involved.
 484  */
 485 static int
 486 Fax3SetupState(TIFF* tif)
 487 {
 488         static const char module[] = "Fax3SetupState";
 489         TIFFDirectory* td = &tif->tif_dir;
 490         Fax3BaseState* sp = Fax3State(tif);
 491         int needsRefLine;
 492         Fax3CodecState* dsp = (Fax3CodecState*) Fax3State(tif);
 493         tmsize_t rowbytes;
 494         uint32 rowpixels, nruns;
 495
 496         if (td->td_bitspersample != 1) {
 497                 TIFFErrorExt(tif->tif_clientdata, module,
 498                     "Bits/sample must be 1 for Group 3/4 encoding/decoding");
 499                 return (0);
 500         }
 501         /*
 502          * Calculate the scanline/tile widths.
 503          */
 504         if (isTiled(tif)) {
 505                 rowbytes = TIFFTileRowSize(tif);
 506                 rowpixels = td->td_tilewidth;
 507         } else {
 508                 rowbytes = TIFFScanlineSize(tif);
 509                 rowpixels = td->td_imagewidth;
 510         }
 511         sp->rowbytes = rowbytes;
 512         sp->rowpixels = rowpixels;
 513         /*
 514          * Allocate any additional space required for decoding/encoding.
 515          */
 516         needsRefLine = (
 517             (sp->groupoptions & GROUP3OPT_2DENCODING) ||
 518             td->td_compression == COMPRESSION_CCITTFAX4
 519         );
 520
 521         /*
 522           Assure that allocation computations do not overflow.
 523
 524           TIFFroundup and TIFFSafeMultiply return zero on integer overflow
 525         */
 526         dsp->runs=(uint32*) NULL;
 527         nruns = TIFFroundup_32(rowpixels,32);
 528         if (needsRefLine) {
 529                 nruns = TIFFSafeMultiply(uint32,nruns,2);
 530         }
 531         if ((nruns == 0) || (TIFFSafeMultiply(uint32,nruns,2) == 0)) {
 532                 TIFFErrorExt(tif->tif_clientdata, tif->tif_name,
 533                              "Row pixels integer overflow (rowpixels %u)",
 534                              rowpixels);
 535                 return (0);
 536         }
 537         dsp->runs = (uint32*) _TIFFCheckMalloc(tif,
 538                                                TIFFSafeMultiply(uint32,nruns,2),
 539                                                sizeof (uint32),
 540                                                "for Group 3/4 run arrays");
 541         if (dsp->runs == NULL)
 542                 return (0);
 543         memset( dsp->runs, 0, TIFFSafeMultiply(uint32,nruns,2)*sizeof(uint32));
 544         dsp->curruns = dsp->runs;
 545         if (needsRefLine)
 546                 dsp->refruns = dsp->runs + nruns;
 547         else
 548                 dsp->refruns = NULL;
 549         if (td->td_compression == COMPRESSION_CCITTFAX3
 550             && is2DEncoding(dsp)) {     /* NB: default is 1D routine */
 551                 tif->tif_decoderow = Fax3Decode2D;
 552                 tif->tif_decodestrip = Fax3Decode2D;
 553                 tif->tif_decodetile = Fax3Decode2D;
 554         }
 555
 556         if (needsRefLine) {             /* 2d encoding */
 557                 Fax3CodecState* esp = EncoderState(tif);
 558                 /*
 559                  * 2d encoding requires a scanline
 560                  * buffer for the ``reference line''; the
 561                  * scanline against which delta encoding
 562                  * is referenced.  The reference line must
 563                  * be initialized to be ``white'' (done elsewhere).
 564                  */
 565                 esp->refline = (unsigned char*) _TIFFmalloc(rowbytes);
 566                 if (esp->refline == NULL) {
 567                         TIFFErrorExt(tif->tif_clientdata, module,
 568                             "No space for Group 3/4 reference line");
 569                         return (0);
 570                 }
 571         } else                                  /* 1d encoding */
 572                 EncoderState(tif)->refline = NULL;
 573
 574         return (1);
 575 }
 576
 577 /*
 578  * CCITT Group 3 FAX Encoding.
 579  */
 580
 581 #define Fax3FlushBits(tif, sp) {                                \
 582         if ((tif)->tif_rawcc >= (tif)->tif_rawdatasize)         \
 583                 (void) TIFFFlushData1(tif);                     \
 584         *(tif)->tif_rawcp++ = (uint8) (sp)->data;               \
 585         (tif)->tif_rawcc++;                                     \
 586         (sp)->data = 0, (sp)->bit = 8;                          \
 587 }
 588 #define _FlushBits(tif) {                                       \
 589         if ((tif)->tif_rawcc >= (tif)->tif_rawdatasize)         \
 590                 (void) TIFFFlushData1(tif);                     \
 591         *(tif)->tif_rawcp++ = (uint8) data;             \
 592         (tif)->tif_rawcc++;                                     \
 593         data = 0, bit = 8;                                      \
 594 }
 595 static const int _msbmask[9] =
 596     { 0x00, 0x01, 0x03, 0x07, 0x0f, 0x1f, 0x3f, 0x7f, 0xff };
 597 #define _PutBits(tif, bits, length) {                           \
 598         while (length > bit) {                                  \
 599                 data |= bits >> (length - bit);                 \
 600                 length -= bit;                                  \
 601                 _FlushBits(tif);                                \
 602         }                                                       \
 603         assert( length < 9 );                                   \
 604         data |= (bits & _msbmask[length]) << (bit - length);    \
 605         bit -= length;                                          \
 606         if (bit == 0)                                           \
 607                 _FlushBits(tif);                                \
 608 }
 609
 610 /*
 611  * Write a variable-length bit-value to
 612  * the output stream.  Values are
 613  * assumed to be at most 16 bits.
 614  */
 615 static void
 616 Fax3PutBits(TIFF* tif, unsigned int bits, unsigned int length)
 617 {
 618         Fax3CodecState* sp = EncoderState(tif);
 619         unsigned int bit = sp->bit;
 620         int data = sp->data;
 621
 622         _PutBits(tif, bits, length);
 623
 624         sp->data = data;
 625         sp->bit = bit;
 626 }
 627
 628 /*
 629  * Write a code to the output stream.
 630  */
 631 #define putcode(tif, te)        Fax3PutBits(tif, (te)->code, (te)->length)
 632
 633 #ifdef FAX3_DEBUG
 634 #define DEBUG_COLOR(w) (tab == TIFFFaxWhiteCodes ? w "W" : w "B")
 635 #define DEBUG_PRINT(what,len) {                                         \
 636     int t;                                                              \
 637     printf("%08X/%-2d: %s%5d\t", data, bit, DEBUG_COLOR(what), len);    \
 638     for (t = length-1; t >= 0; t--)                                     \
 639         putchar(code & (1<<t) ? '1' : '0');                             \
 640     putchar('\n');                                                      \
 641 }
 642 #endif
 643
 644 /*
 645  * Write the sequence of codes that describes
 646  * the specified span of zero's or one's.  The
 647  * appropriate table that holds the make-up and
 648  * terminating codes is supplied.
 649  */
 650 static void
 651 putspan(TIFF* tif, int32 span, const tableentry* tab)
 652 {
 653         Fax3CodecState* sp = EncoderState(tif);
 654         unsigned int bit = sp->bit;
 655         int data = sp->data;
 656         unsigned int code, length;
 657
 658         while (span >= 2624) {
 659                 const tableentry* te = &tab[63 + (2560>>6)];
 660                 code = te->code, length = te->length;
 661 #ifdef FAX3_DEBUG
 662                 DEBUG_PRINT("MakeUp", te->runlen);
 663 #endif
 664                 _PutBits(tif, code, length);
 665                 span -= te->runlen;
 666         }
 667         if (span >= 64) {
 668                 const tableentry* te = &tab[63 + (span>>6)];
 669                 assert(te->runlen == 64*(span>>6));
 670                 code = te->code, length = te->length;
 671 #ifdef FAX3_DEBUG
 672                 DEBUG_PRINT("MakeUp", te->runlen);
 673 #endif
 674                 _PutBits(tif, code, length);
 675                 span -= te->runlen;
 676         }
 677         code = tab[span].code, length = tab[span].length;
 678 #ifdef FAX3_DEBUG
 679         DEBUG_PRINT("  Term", tab[span].runlen);
 680 #endif
 681         _PutBits(tif, code, length);
 682
 683         sp->data = data;
 684         sp->bit = bit;
 685 }
 686
 687 /*
 688  * Write an EOL code to the output stream.  The zero-fill
 689  * logic for byte-aligning encoded scanlines is handled
 690  * here.  We also handle writing the tag bit for the next
 691  * scanline when doing 2d encoding.
 692  */
 693 static void
 694 Fax3PutEOL(TIFF* tif)
 695 {
 696         Fax3CodecState* sp = EncoderState(tif);
 697         unsigned int bit = sp->bit;
 698         int data = sp->data;
 699         unsigned int code, length, tparm;
 700
 701         if (sp->b.groupoptions & GROUP3OPT_FILLBITS) {
 702                 /*
 703                  * Force bit alignment so EOL will terminate on
 704                  * a byte boundary.  That is, force the bit alignment
 705                  * to 16-12 = 4 before putting out the EOL code.
 706                  */
 707                 int align = 8 - 4;
 708                 if (align != sp->bit) {
 709                         if (align > sp->bit)
 710                                 align = sp->bit + (8 - align);
 711                         else
 712                                 align = sp->bit - align;
 713                         code = 0;
 714                         tparm=align;
 715                         _PutBits(tif, 0, tparm);
 716                 }
 717         }
 718         code = EOL, length = 12;
 719         if (is2DEncoding(sp))
 720                 code = (code<<1) | (sp->tag == G3_1D), length++;
 721         _PutBits(tif, code, length);
 722
 723         sp->data = data;
 724         sp->bit = bit;
 725 }
 726
 727 /*
 728  * Reset encoding state at the start of a strip.
 729  */
 730 static int
 731 Fax3PreEncode(TIFF* tif, uint16 s)
 732 {
 733         Fax3CodecState* sp = EncoderState(tif);
 734
 735         (void) s;
 736         assert(sp != NULL);
 737         sp->bit = 8;
 738         sp->data = 0;
 739         sp->tag = G3_1D;
 740         /*
 741          * This is necessary for Group 4; otherwise it isn't
 742          * needed because the first scanline of each strip ends
 743          * up being copied into the refline.
 744          */
 745         if (sp->refline)
 746                 _TIFFmemset(sp->refline, 0x00, sp->b.rowbytes);
 747         if (is2DEncoding(sp)) {
 748                 float res = tif->tif_dir.td_yresolution;
 749                 /*
 750                  * The CCITT spec says that when doing 2d encoding, you
 751                  * should only do it on K consecutive scanlines, where K
 752                  * depends on the resolution of the image being encoded
 753                  * (2 for <= 200 lpi, 4 for > 200 lpi).  Since the directory
 754                  * code initializes td_yresolution to 0, this code will
 755                  * select a K of 2 unless the YResolution tag is set
 756                  * appropriately.  (Note also that we fudge a little here
 757                  * and use 150 lpi to avoid problems with units conversion.)
 758                  */
 759                 if (tif->tif_dir.td_resolutionunit == RESUNIT_CENTIMETER)
 760                         res *= 2.54f;           /* convert to inches */
 761                 sp->maxk = (res > 150 ? 4 : 2);
 762                 sp->k = sp->maxk-1;
 763         } else
 764                 sp->k = sp->maxk = 0;
 765         sp->line = 0;
 766         return (1);
 767 }
 768
 769 static const unsigned char zeroruns[256] = {
 770     8, 7, 6, 6, 5, 5, 5, 5, 4, 4, 4, 4, 4, 4, 4, 4,     /* 0x00 - 0x0f */
 771     3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3,     /* 0x10 - 0x1f */
 772     2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,     /* 0x20 - 0x2f */
 773     2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,     /* 0x30 - 0x3f */
 774     1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,     /* 0x40 - 0x4f */
 775     1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,     /* 0x50 - 0x5f */
 776     1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,     /* 0x60 - 0x6f */
 777     1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,     /* 0x70 - 0x7f */
 778     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,     /* 0x80 - 0x8f */
 779     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,     /* 0x90 - 0x9f */
 780     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,     /* 0xa0 - 0xaf */
 781     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,     /* 0xb0 - 0xbf */
 782     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,     /* 0xc0 - 0xcf */
 783     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,     /* 0xd0 - 0xdf */
 784     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,     /* 0xe0 - 0xef */
 785     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,     /* 0xf0 - 0xff */
 786 };
 787 static const unsigned char oneruns[256] = {
 788     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,     /* 0x00 - 0x0f */
 789     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,     /* 0x10 - 0x1f */
 790     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,     /* 0x20 - 0x2f */
 791     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,     /* 0x30 - 0x3f */
 792     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,     /* 0x40 - 0x4f */
 793     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,     /* 0x50 - 0x5f */
 794     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,     /* 0x60 - 0x6f */
 795     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,     /* 0x70 - 0x7f */
 796     1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,     /* 0x80 - 0x8f */
 797     1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,     /* 0x90 - 0x9f */
 798     1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,     /* 0xa0 - 0xaf */
 799     1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,     /* 0xb0 - 0xbf */
 800     2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,     /* 0xc0 - 0xcf */
 801     2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,     /* 0xd0 - 0xdf */
 802     3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3,     /* 0xe0 - 0xef */
 803     4, 4, 4, 4, 4, 4, 4, 4, 5, 5, 5, 5, 6, 6, 7, 8,     /* 0xf0 - 0xff */
 804 };
 805
 806 /*
 807  * On certain systems it pays to inline
 808  * the routines that find pixel spans.
 809  */
 810 #ifdef VAXC
 811 static  int32 find0span(unsigned char*, int32, int32);
 812 static  int32 find1span(unsigned char*, int32, int32);
 813 #pragma inline(find0span,find1span)
 814 #endif
 815
 816 /*
 817  * Find a span of ones or zeros using the supplied
 818  * table.  The ``base'' of the bit string is supplied
 819  * along with the start+end bit indices.
 820  */
 821 inline static int32
 822 find0span(unsigned char* bp, int32 bs, int32 be)
 823 {
 824         int32 bits = be - bs;
 825         int32 n, span;
 826
 827         bp += bs>>3;
 828         /*
 829          * Check partial byte on lhs.
 830          */
 831         if (bits > 0 && (n = (bs & 7))) {
 832                 span = zeroruns[(*bp << n) & 0xff];
 833                 if (span > 8-n)         /* table value too generous */
 834                         span = 8-n;
 835                 if (span > bits)        /* constrain span to bit range */
 836                         span = bits;
 837                 if (n+span < 8)         /* doesn't extend to edge of byte */
 838                         return (span);
 839                 bits -= span;
 840                 bp++;
 841         } else
 842                 span = 0;
 843         if (bits >= (int32)(2 * 8 * sizeof(long))) {
 844                 long* lp;
 845                 /*
 846                  * Align to longword boundary and check longwords.
 847                  */
 848                 while (!isAligned(bp, long)) {
 849                         if (*bp != 0x00)
 850                                 return (span + zeroruns[*bp]);
 851                         span += 8, bits -= 8;
 852                         bp++;
 853                 }
 854                 lp = (long*) bp;
 855                 while ((bits >= (int32)(8 * sizeof(long))) && (0 == *lp)) {
 856                         span += 8*sizeof (long), bits -= 8*sizeof (long);
 857                         lp++;
 858                 }
 859                 bp = (unsigned char*) lp;
 860         }
 861         /*
 862          * Scan full bytes for all 0's.
 863          */
 864         while (bits >= 8) {
 865                 if (*bp != 0x00)        /* end of run */
 866                         return (span + zeroruns[*bp]);
 867                 span += 8, bits -= 8;
 868                 bp++;
 869         }
 870         /*
 871          * Check partial byte on rhs.
 872          */
 873         if (bits > 0) {
 874                 n = zeroruns[*bp];
 875                 span += (n > bits ? bits : n);
 876         }
 877         return (span);
 878 }
 879
 880 inline static int32
 881 find1span(unsigned char* bp, int32 bs, int32 be)
 882 {
 883         int32 bits = be - bs;
 884         int32 n, span;
 885
 886         bp += bs>>3;
 887         /*
 888          * Check partial byte on lhs.
 889          */
 890         if (bits > 0 && (n = (bs & 7))) {
 891                 span = oneruns[(*bp << n) & 0xff];
 892                 if (span > 8-n)         /* table value too generous */
 893                         span = 8-n;
 894                 if (span > bits)        /* constrain span to bit range */
 895                         span = bits;
 896                 if (n+span < 8)         /* doesn't extend to edge of byte */
 897                         return (span);
 898                 bits -= span;
 899                 bp++;
 900         } else
 901                 span = 0;
 902         if (bits >= (int32)(2 * 8 * sizeof(long))) {
 903                 long* lp;
 904                 /*
 905                  * Align to longword boundary and check longwords.
 906                  */
 907                 while (!isAligned(bp, long)) {
 908                         if (*bp != 0xff)
 909                                 return (span + oneruns[*bp]);
 910                         span += 8, bits -= 8;
 911                         bp++;
 912                 }
 913                 lp = (long*) bp;
 914                 while ((bits >= (int32)(8 * sizeof(long))) && (~0 == *lp)) {
 915                         span += 8*sizeof (long), bits -= 8*sizeof (long);
 916                         lp++;
 917                 }
 918                 bp = (unsigned char*) lp;
 919         }
 920         /*
 921          * Scan full bytes for all 1's.
 922          */
 923         while (bits >= 8) {
 924                 if (*bp != 0xff)        /* end of run */
 925                         return (span + oneruns[*bp]);
 926                 span += 8, bits -= 8;
 927                 bp++;
 928         }
 929         /*
 930          * Check partial byte on rhs.
 931          */
 932         if (bits > 0) {
 933                 n = oneruns[*bp];
 934                 span += (n > bits ? bits : n);
 935         }
 936         return (span);
 937 }
 938
 939 /*
 940  * Return the offset of the next bit in the range
 941  * [bs..be] that is different from the specified
 942  * color.  The end, be, is returned if no such bit
 943  * exists.
 944  */
 945 #define finddiff(_cp, _bs, _be, _color) \
 946         (_bs + (_color ? find1span(_cp,_bs,_be) : find0span(_cp,_bs,_be)))
 947 /*
 948  * Like finddiff, but also check the starting bit
 949  * against the end in case start > end.
 950  */
 951 #define finddiff2(_cp, _bs, _be, _color) \
 952         (_bs < _be ? finddiff(_cp,_bs,_be,_color) : _be)
 953
 954 /*
 955  * 1d-encode a row of pixels.  The encoding is
 956  * a sequence of all-white or all-black spans
 957  * of pixels encoded with Huffman codes.
 958  */
 959 static int
 960 Fax3Encode1DRow(TIFF* tif, unsigned char* bp, uint32 bits)
 961 {
 962         Fax3CodecState* sp = EncoderState(tif);
 963         int32 span;
 964         uint32 bs = 0;
 965
 966         for (;;) {
 967                 span = find0span(bp, bs, bits);         /* white span */
 968                 putspan(tif, span, TIFFFaxWhiteCodes);
 969                 bs += span;
 970                 if (bs >= bits)
 971                         break;
 972                 span = find1span(bp, bs, bits);         /* black span */
 973                 putspan(tif, span, TIFFFaxBlackCodes);
 974                 bs += span;
 975                 if (bs >= bits)
 976                         break;
 977         }
 978         if (sp->b.mode & (FAXMODE_BYTEALIGN|FAXMODE_WORDALIGN)) {
 979                 if (sp->bit != 8)                       /* byte-align */
 980                         Fax3FlushBits(tif, sp);
 981                 if ((sp->b.mode&FAXMODE_WORDALIGN) &&
 982                     !isAligned(tif->tif_rawcp, uint16))
 983                         Fax3FlushBits(tif, sp);
 984         }
 985         return (1);
 986 }
 987
 988 static const tableentry horizcode =
 989     { 3, 0x1, 0 };      /* 001 */
 990 static const tableentry passcode =
 991     { 4, 0x1, 0 };      /* 0001 */
 992 static const tableentry vcodes[7] = {
 993     { 7, 0x03, 0 },     /* 0000 011 */
 994     { 6, 0x03, 0 },     /* 0000 11 */
 995     { 3, 0x03, 0 },     /* 011 */
 996     { 1, 0x1, 0 },      /* 1 */
 997     { 3, 0x2, 0 },      /* 010 */
 998     { 6, 0x02, 0 },     /* 0000 10 */
 999     { 7, 0x02, 0 }      /* 0000 010 */
1000 };
1001
1002 /*
1003  * 2d-encode a row of pixels.  Consult the CCITT
1004  * documentation for the algorithm.
1005  */
1006 static int
1007 Fax3Encode2DRow(TIFF* tif, unsigned char* bp, unsigned char* rp, uint32 bits)
1008 {
1009 #define PIXEL(buf,ix)   ((((buf)[(ix)>>3]) >> (7-((ix)&7))) & 1)
1010         uint32 a0 = 0;
1011         uint32 a1 = (PIXEL(bp, 0) != 0 ? 0 : finddiff(bp, 0, bits, 0));
1012         uint32 b1 = (PIXEL(rp, 0) != 0 ? 0 : finddiff(rp, 0, bits, 0));
1013         uint32 a2, b2;
1014
1015         for (;;) {
1016                 b2 = finddiff2(rp, b1, bits, PIXEL(rp,b1));
1017                 if (b2 >= a1) {
1018                         int32 d = b1 - a1;
1019                         if (!(-3 <= d && d <= 3)) {     /* horizontal mode */
1020                                 a2 = finddiff2(bp, a1, bits, PIXEL(bp,a1));
1021                                 putcode(tif, &horizcode);
1022                                 if (a0+a1 == 0 || PIXEL(bp, a0) == 0) {
1023                                         putspan(tif, a1-a0, TIFFFaxWhiteCodes);
1024                                         putspan(tif, a2-a1, TIFFFaxBlackCodes);
1025                                 } else {
1026                                         putspan(tif, a1-a0, TIFFFaxBlackCodes);
1027                                         putspan(tif, a2-a1, TIFFFaxWhiteCodes);
1028                                 }
1029                                 a0 = a2;
1030                         } else {                        /* vertical mode */
1031                                 putcode(tif, &vcodes[d+3]);
1032                                 a0 = a1;
1033                         }
1034                 } else {                                /* pass mode */
1035                         putcode(tif, &passcode);
1036                         a0 = b2;
1037                 }
1038                 if (a0 >= bits)
1039                         break;
1040                 a1 = finddiff(bp, a0, bits, PIXEL(bp,a0));
1041                 b1 = finddiff(rp, a0, bits, !PIXEL(bp,a0));
1042                 b1 = finddiff(rp, b1, bits, PIXEL(bp,a0));
1043         }
1044         return (1);
1045 #undef PIXEL
1046 }
1047
1048 /*
1049  * Encode a buffer of pixels.
1050  */
1051 static int
1052 Fax3Encode(TIFF* tif, uint8* bp, tmsize_t cc, uint16 s)
1053 {
1054         static const char module[] = "Fax3Encode";
1055         Fax3CodecState* sp = EncoderState(tif);
1056         (void) s;
1057         if (cc % sp->b.rowbytes)
1058         {
1059                 TIFFErrorExt(tif->tif_clientdata, module, "Fractional scanlines cannot be written");
1060                 return (0);
1061         }
1062         while (cc > 0) {
1063                 if ((sp->b.mode & FAXMODE_NOEOL) == 0)
1064                         Fax3PutEOL(tif);
1065                 if (is2DEncoding(sp)) {
1066                         if (sp->tag == G3_1D) {
1067                                 if (!Fax3Encode1DRow(tif, bp, sp->b.rowpixels))
1068                                         return (0);
1069                                 sp->tag = G3_2D;
1070                         } else {
1071                                 if (!Fax3Encode2DRow(tif, bp, sp->refline,
1072                                     sp->b.rowpixels))
1073                                         return (0);
1074                                 sp->k--;
1075                         }
1076                         if (sp->k == 0) {
1077                                 sp->tag = G3_1D;
1078                                 sp->k = sp->maxk-1;
1079                         } else
1080                                 _TIFFmemcpy(sp->refline, bp, sp->b.rowbytes);
1081                 } else {
1082                         if (!Fax3Encode1DRow(tif, bp, sp->b.rowpixels))
1083                                 return (0);
1084                 }
1085                 bp += sp->b.rowbytes;
1086                 cc -= sp->b.rowbytes;
1087         }
1088         return (1);
1089 }
1090
1091 static int
1092 Fax3PostEncode(TIFF* tif)
1093 {
1094         Fax3CodecState* sp = EncoderState(tif);
1095
1096         if (sp->bit != 8)
1097                 Fax3FlushBits(tif, sp);
1098         return (1);
1099 }
1100
1101 static void
1102 Fax3Close(TIFF* tif)
1103 {
1104         if ((Fax3State(tif)->mode & FAXMODE_NORTC) == 0) {
1105                 Fax3CodecState* sp = EncoderState(tif);
1106                 unsigned int code = EOL;
1107                 unsigned int length = 12;
1108                 int i;
1109
1110                 if (is2DEncoding(sp))
1111                         code = (code<<1) | (sp->tag == G3_1D), length++;
1112                 for (i = 0; i < 6; i++)
1113                         Fax3PutBits(tif, code, length);
1114                 Fax3FlushBits(tif, sp);
1115         }
1116 }
1117
1118 static void
1119 Fax3Cleanup(TIFF* tif)
1120 {
1121         Fax3CodecState* sp = DecoderState(tif);
1122
1123         assert(sp != 0);
1124
1125         tif->tif_tagmethods.vgetfield = sp->b.vgetparent;
1126         tif->tif_tagmethods.vsetfield = sp->b.vsetparent;
1127         tif->tif_tagmethods.printdir = sp->b.printdir;
1128
1129         if (sp->runs)
1130                 _TIFFfree(sp->runs);
1131         if (sp->refline)
1132                 _TIFFfree(sp->refline);
1133
1134         _TIFFfree(tif->tif_data);
1135         tif->tif_data = NULL;
1136
1137         _TIFFSetDefaultCompressionState(tif);
1138 }
1139
1140 #define FIELD_BADFAXLINES       (FIELD_CODEC+0)
1141 #define FIELD_CLEANFAXDATA      (FIELD_CODEC+1)
1142 #define FIELD_BADFAXRUN         (FIELD_CODEC+2)
1143
1144 #define FIELD_OPTIONS           (FIELD_CODEC+7)
1145
1146 static const TIFFField faxFields[] = {
1147     { TIFFTAG_FAXMODE, 0, 0, TIFF_ANY, 0, TIFF_SETGET_INT, TIFF_SETGET_UNDEFINED, FIELD_PSEUDO, FALSE, FALSE, "FaxMode", NULL },
1148     { TIFFTAG_FAXFILLFUNC, 0, 0, TIFF_ANY, 0, TIFF_SETGET_OTHER, TIFF_SETGET_UNDEFINED, FIELD_PSEUDO, FALSE, FALSE, "FaxFillFunc", NULL },
1149     { TIFFTAG_BADFAXLINES, 1, 1, TIFF_LONG, 0, TIFF_SETGET_UINT32, TIFF_SETGET_UINT32, FIELD_BADFAXLINES, TRUE, FALSE, "BadFaxLines", NULL },
1150     { TIFFTAG_CLEANFAXDATA, 1, 1, TIFF_SHORT, 0, TIFF_SETGET_UINT16, TIFF_SETGET_UINT16, FIELD_CLEANFAXDATA, TRUE, FALSE, "CleanFaxData", NULL },
1151     { TIFFTAG_CONSECUTIVEBADFAXLINES, 1, 1, TIFF_LONG, 0, TIFF_SETGET_UINT32, TIFF_SETGET_UINT32, FIELD_BADFAXRUN, TRUE, FALSE, "ConsecutiveBadFaxLines", NULL }};
1152 static const TIFFField fax3Fields[] = {
1153     { TIFFTAG_GROUP3OPTIONS, 1, 1, TIFF_LONG, 0, TIFF_SETGET_UINT32, TIFF_SETGET_UINT32, FIELD_OPTIONS, FALSE, FALSE, "Group3Options", NULL },
1154 };
1155 static const TIFFField fax4Fields[] = {
1156     { TIFFTAG_GROUP4OPTIONS, 1, 1, TIFF_LONG, 0, TIFF_SETGET_UINT32, TIFF_SETGET_UINT32, FIELD_OPTIONS, FALSE, FALSE, "Group4Options", NULL },
1157 };
1158
1159 static int
1160 Fax3VSetField(TIFF* tif, uint32 tag, va_list ap)
1161 {
1162         Fax3BaseState* sp = Fax3State(tif);
1163         const TIFFField* fip;
1164
1165         assert(sp != 0);
1166         assert(sp->vsetparent != 0);
1167
1168         switch (tag) {
1169         case TIFFTAG_FAXMODE:
1170                 sp->mode = (int) va_arg(ap, int);
1171                 return 1;                       /* NB: pseudo tag */
1172         case TIFFTAG_FAXFILLFUNC:
1173                 DecoderState(tif)->fill = va_arg(ap, TIFFFaxFillFunc);
1174                 return 1;                       /* NB: pseudo tag */
1175         case TIFFTAG_GROUP3OPTIONS:
1176                 /* XXX: avoid reading options if compression mismatches. */
1177                 if (tif->tif_dir.td_compression == COMPRESSION_CCITTFAX3)
1178                         sp->groupoptions = (uint32) va_arg(ap, uint32);
1179                 break;
1180         case TIFFTAG_GROUP4OPTIONS:
1181                 /* XXX: avoid reading options if compression mismatches. */
1182                 if (tif->tif_dir.td_compression == COMPRESSION_CCITTFAX4)
1183                         sp->groupoptions = (uint32) va_arg(ap, uint32);
1184                 break;
1185         case TIFFTAG_BADFAXLINES:
1186                 sp->badfaxlines = (uint32) va_arg(ap, uint32);
1187                 break;
1188         case TIFFTAG_CLEANFAXDATA:
1189                 sp->cleanfaxdata = (uint16) va_arg(ap, uint16_vap);
1190                 break;
1191         case TIFFTAG_CONSECUTIVEBADFAXLINES:
1192                 sp->badfaxrun = (uint32) va_arg(ap, uint32);
1193                 break;
1194         default:
1195                 return (*sp->vsetparent)(tif, tag, ap);
1196         }
1197
1198         if ((fip = TIFFFieldWithTag(tif, tag)))
1199                 TIFFSetFieldBit(tif, fip->field_bit);
1200         else
1201                 return 0;
1202
1203         tif->tif_flags |= TIFF_DIRTYDIRECT;
1204         return 1;
1205 }
1206
1207 static int
1208 Fax3VGetField(TIFF* tif, uint32 tag, va_list ap)
1209 {
1210         Fax3BaseState* sp = Fax3State(tif);
1211
1212         assert(sp != 0);
1213
1214         switch (tag) {
1215         case TIFFTAG_FAXMODE:
1216                 *va_arg(ap, int*) = sp->mode;
1217                 break;
1218         case TIFFTAG_FAXFILLFUNC:
1219                 *va_arg(ap, TIFFFaxFillFunc*) = DecoderState(tif)->fill;
1220                 break;
1221         case TIFFTAG_GROUP3OPTIONS:
1222         case TIFFTAG_GROUP4OPTIONS:
1223                 *va_arg(ap, uint32*) = sp->groupoptions;
1224                 break;
1225         case TIFFTAG_BADFAXLINES:
1226                 *va_arg(ap, uint32*) = sp->badfaxlines;
1227                 break;
1228         case TIFFTAG_CLEANFAXDATA:
1229                 *va_arg(ap, uint16*) = sp->cleanfaxdata;
1230                 break;
1231         case TIFFTAG_CONSECUTIVEBADFAXLINES:
1232                 *va_arg(ap, uint32*) = sp->badfaxrun;
1233                 break;
1234         default:
1235                 return (*sp->vgetparent)(tif, tag, ap);
1236         }
1237         return (1);
1238 }
1239
1240 static void
1241 Fax3PrintDir(TIFF* tif, FILE* fd, long flags)
1242 {
1243         Fax3BaseState* sp = Fax3State(tif);
1244
1245         assert(sp != 0);
1246
1247         (void) flags;
1248         if (TIFFFieldSet(tif,FIELD_OPTIONS)) {
1249                 const char* sep = " ";
1250                 if (tif->tif_dir.td_compression == COMPRESSION_CCITTFAX4) {
1251                         fprintf(fd, "  Group 4 Options:");
1252                         if (sp->groupoptions & GROUP4OPT_UNCOMPRESSED)
1253                                 fprintf(fd, "%suncompressed data", sep);
1254                 } else {
1255
1256                         fprintf(fd, "  Group 3 Options:");
1257                         if (sp->groupoptions & GROUP3OPT_2DENCODING)
1258                                 fprintf(fd, "%s2-d encoding", sep), sep = "+";
1259                         if (sp->groupoptions & GROUP3OPT_FILLBITS)
1260                                 fprintf(fd, "%sEOL padding", sep), sep = "+";
1261                         if (sp->groupoptions & GROUP3OPT_UNCOMPRESSED)
1262                                 fprintf(fd, "%suncompressed data", sep);
1263                 }
1264                 fprintf(fd, " (%lu = 0x%lx)\n",
1265                         (unsigned long) sp->groupoptions,
1266                         (unsigned long) sp->groupoptions);
1267         }
1268         if (TIFFFieldSet(tif,FIELD_CLEANFAXDATA)) {
1269                 fprintf(fd, "  Fax Data:");
1270                 switch (sp->cleanfaxdata) {
1271                 case CLEANFAXDATA_CLEAN:
1272                         fprintf(fd, " clean");
1273                         break;
1274                 case CLEANFAXDATA_REGENERATED:
1275                         fprintf(fd, " receiver regenerated");
1276                         break;
1277                 case CLEANFAXDATA_UNCLEAN:
1278                         fprintf(fd, " uncorrected errors");
1279                         break;
1280                 }
1281                 fprintf(fd, " (%u = 0x%x)\n",
1282                     sp->cleanfaxdata, sp->cleanfaxdata);
1283         }
1284         if (TIFFFieldSet(tif,FIELD_BADFAXLINES))
1285                 fprintf(fd, "  Bad Fax Lines: %lu\n",
1286                         (unsigned long) sp->badfaxlines);
1287         if (TIFFFieldSet(tif,FIELD_BADFAXRUN))
1288                 fprintf(fd, "  Consecutive Bad Fax Lines: %lu\n",
1289                     (unsigned long) sp->badfaxrun);
1290         if (sp->printdir)
1291                 (*sp->printdir)(tif, fd, flags);
1292 }
1293
1294 static int
1295 InitCCITTFax3(TIFF* tif)
1296 {
1297         static const char module[] = "InitCCITTFax3";
1298         Fax3BaseState* sp;
1299
1300         /*
1301          * Merge codec-specific tag information.
1302          */
1303         if (!_TIFFMergeFields(tif, faxFields, TIFFArrayCount(faxFields))) {
1304                 TIFFErrorExt(tif->tif_clientdata, "InitCCITTFax3",
1305                         "Merging common CCITT Fax codec-specific tags failed");
1306                 return 0;
1307         }
1308
1309         /*
1310          * Allocate state block so tag methods have storage to record values.
1311          */
1312         tif->tif_data = (uint8*)
1313                 _TIFFmalloc(sizeof (Fax3CodecState));
1314
1315         if (tif->tif_data == NULL) {
1316                 TIFFErrorExt(tif->tif_clientdata, module,
1317                     "No space for state block");
1318                 return (0);
1319         }
1320
1321         sp = Fax3State(tif);
1322         sp->rw_mode = tif->tif_mode;
1323
1324         /*
1325          * Override parent get/set field methods.
1326          */
1327         sp->vgetparent = tif->tif_tagmethods.vgetfield;
1328         tif->tif_tagmethods.vgetfield = Fax3VGetField; /* hook for codec tags */
1329         sp->vsetparent = tif->tif_tagmethods.vsetfield;
1330         tif->tif_tagmethods.vsetfield = Fax3VSetField; /* hook for codec tags */
1331         sp->printdir = tif->tif_tagmethods.printdir;
1332         tif->tif_tagmethods.printdir = Fax3PrintDir;   /* hook for codec tags */
1333         sp->groupoptions = 0;
1334
1335         if (sp->rw_mode == O_RDONLY) /* FIXME: improve for in place update */
1336                 tif->tif_flags |= TIFF_NOBITREV; /* decoder does bit reversal */
1337         DecoderState(tif)->runs = NULL;
1338         TIFFSetField(tif, TIFFTAG_FAXFILLFUNC, _TIFFFax3fillruns);
1339         EncoderState(tif)->refline = NULL;
1340
1341         /*
1342          * Install codec methods.
1343          */
1344         tif->tif_fixuptags = Fax3FixupTags;
1345         tif->tif_setupdecode = Fax3SetupState;
1346         tif->tif_predecode = Fax3PreDecode;
1347         tif->tif_decoderow = Fax3Decode1D;
1348         tif->tif_decodestrip = Fax3Decode1D;
1349         tif->tif_decodetile = Fax3Decode1D;
1350         tif->tif_setupencode = Fax3SetupState;
1351         tif->tif_preencode = Fax3PreEncode;
1352         tif->tif_postencode = Fax3PostEncode;
1353         tif->tif_encoderow = Fax3Encode;
1354         tif->tif_encodestrip = Fax3Encode;
1355         tif->tif_encodetile = Fax3Encode;
1356         tif->tif_close = Fax3Close;
1357         tif->tif_cleanup = Fax3Cleanup;
1358
1359         return (1);
1360 }
1361
1362 int
1363 TIFFInitCCITTFax3(TIFF* tif, int scheme)
1364 {
1365         (void) scheme;
1366         if (InitCCITTFax3(tif)) {
1367                 /*
1368                  * Merge codec-specific tag information.
1369                  */
1370                 if (!_TIFFMergeFields(tif, fax3Fields,
1371                                       TIFFArrayCount(fax3Fields))) {
1372                         TIFFErrorExt(tif->tif_clientdata, "TIFFInitCCITTFax3",
1373                         "Merging CCITT Fax 3 codec-specific tags failed");
1374                         return 0;
1375                 }
1376
1377                 /*
1378                  * The default format is Class/F-style w/o RTC.
1379                  */
1380                 return TIFFSetField(tif, TIFFTAG_FAXMODE, FAXMODE_CLASSF);
1381         } else
1382                 return 01;
1383 }
1384
1385 /*
1386  * CCITT Group 4 (T.6) Facsimile-compatible
1387  * Compression Scheme Support.
1388  */
1389
1390 #define SWAP(t,a,b) { t x; x = (a); (a) = (b); (b) = x; }
1391 /*
1392  * Decode the requested amount of G4-encoded data.
1393  */
1394 static int
1395 Fax4Decode(TIFF* tif, uint8* buf, tmsize_t occ, uint16 s)
1396 {
1397 #ifdef FAX3_DEBUG
1398         FILE* file;
1399 #endif
1400         DECLARE_STATE_2D(tif, sp, "Fax4Decode");
1401
1402         (void) s;
1403         if (occ % sp->b.rowbytes)
1404         {
1405                 TIFFErrorExt(tif->tif_clientdata, module, "Fractional scanlines cannot be read");
1406                 return (-1);
1407         }
1408         CACHE_STATE(tif, sp);
1409         while (occ > 0) {
1410                 a0 = 0;
1411                 RunLength = 0;
1412                 pa = thisrun = sp->curruns;
1413                 pb = sp->refruns;
1414                 b1 = *pb++;
1415 #ifdef FAX3_DEBUG
1416                 printf("\nBitAcc=%08X, BitsAvail = %d\n", BitAcc, BitsAvail);
1417                 printf("-------------------- %d\n", tif->tif_row);
1418                 fflush(stdout);
1419 #endif
1420                 EXPAND2D(EOFG4);
1421                 if (EOLcnt)
1422                     goto EOFG4;
1423                 (*sp->fill)(buf, thisrun, pa, lastx);
1424 #ifdef FAX3_DEBUG
1425                 file = fopen("fillbuf.txt", "a");
1426                 fwrite(buf, sp->b.rowbytes, 1, file);
1427                 fclose(file);
1428 #endif
1429                 SETVALUE(0);            /* imaginary change for reference */
1430                 SWAP(uint32*, sp->curruns, sp->refruns);
1431                 buf += sp->b.rowbytes;
1432                 occ -= sp->b.rowbytes;
1433                 sp->line++;
1434                 continue;
1435         EOFG4:
1436                 NeedBits16( 13, BADG4 );
1437         BADG4:
1438 #ifdef FAX3_DEBUG
1439                 if( GetBits(13) != 0x1001 )
1440                     fputs( "Bad EOFB\n", stderr );
1441 #endif
1442                 ClrBits( 13 );
1443                 (*sp->fill)(buf, thisrun, pa, lastx);
1444 #ifdef FAX3_DEBUG
1445                 file = fopen("fillbuf.txt", "a");
1446                 fwrite(buf, sp->b.rowbytes, 1, file);
1447                 fclose(file);
1448 #endif
1449                 UNCACHE_STATE(tif, sp);
1450                 return ( sp->line ? 1 : -1);    /* don't error on badly-terminated strips */
1451         }
1452         UNCACHE_STATE(tif, sp);
1453         return (1);
1454 }
1455 #undef  SWAP
1456
1457 /*
1458  * Encode the requested amount of data.
1459  */
1460 static int
1461 Fax4Encode(TIFF* tif, uint8* bp, tmsize_t cc, uint16 s)
1462 {
1463         static const char module[] = "Fax4Encode";
1464         Fax3CodecState *sp = EncoderState(tif);
1465         (void) s;
1466         if (cc % sp->b.rowbytes)
1467         {
1468                 TIFFErrorExt(tif->tif_clientdata, module, "Fractional scanlines cannot be written");
1469                 return (0);
1470         }
1471         while (cc > 0) {
1472                 if (!Fax3Encode2DRow(tif, bp, sp->refline, sp->b.rowpixels))
1473                         return (0);
1474                 _TIFFmemcpy(sp->refline, bp, sp->b.rowbytes);
1475                 bp += sp->b.rowbytes;
1476                 cc -= sp->b.rowbytes;
1477         }
1478         return (1);
1479 }
1480
1481 static int
1482 Fax4PostEncode(TIFF* tif)
1483 {
1484         Fax3CodecState *sp = EncoderState(tif);
1485
1486         /* terminate strip w/ EOFB */
1487         Fax3PutBits(tif, EOL, 12);
1488         Fax3PutBits(tif, EOL, 12);
1489         if (sp->bit != 8)
1490                 Fax3FlushBits(tif, sp);
1491         return (1);
1492 }
1493
1494 int
1495 TIFFInitCCITTFax4(TIFF* tif, int scheme)
1496 {
1497         (void) scheme;
1498         if (InitCCITTFax3(tif)) {               /* reuse G3 support */
1499                 /*
1500                  * Merge codec-specific tag information.
1501                  */
1502                 if (!_TIFFMergeFields(tif, fax4Fields,
1503                                       TIFFArrayCount(fax4Fields))) {
1504                         TIFFErrorExt(tif->tif_clientdata, "TIFFInitCCITTFax4",
1505                         "Merging CCITT Fax 4 codec-specific tags failed");
1506                         return 0;
1507                 }
1508
1509                 tif->tif_decoderow = Fax4Decode;
1510                 tif->tif_decodestrip = Fax4Decode;
1511                 tif->tif_decodetile = Fax4Decode;
1512                 tif->tif_encoderow = Fax4Encode;
1513                 tif->tif_encodestrip = Fax4Encode;
1514                 tif->tif_encodetile = Fax4Encode;
1515                 tif->tif_postencode = Fax4PostEncode;
1516                 /*
1517                  * Suppress RTC at the end of each strip.
1518                  */
1519                 return TIFFSetField(tif, TIFFTAG_FAXMODE, FAXMODE_NORTC);
1520         } else
1521                 return (0);
1522 }
1523
1524 /*
1525  * CCITT Group 3 1-D Modified Huffman RLE Compression Support.
1526  * (Compression algorithms 2 and 32771)
1527  */
1528
1529 /*
1530  * Decode the requested amount of RLE-encoded data.
1531  */
1532 static int
1533 Fax3DecodeRLE(TIFF* tif, uint8* buf, tmsize_t occ, uint16 s)
1534 {
1535         DECLARE_STATE(tif, sp, "Fax3DecodeRLE");
1536         int mode = sp->b.mode;
1537         (void) s;
1538         if (occ % sp->b.rowbytes)
1539         {
1540                 TIFFErrorExt(tif->tif_clientdata, module, "Fractional scanlines cannot be read");
1541                 return (-1);
1542         }
1543         CACHE_STATE(tif, sp);
1544         thisrun = sp->curruns;
1545         while (occ > 0) {
1546                 a0 = 0;
1547                 RunLength = 0;
1548                 pa = thisrun;
1549 #ifdef FAX3_DEBUG
1550                 printf("\nBitAcc=%08X, BitsAvail = %d\n", BitAcc, BitsAvail);
1551                 printf("-------------------- %d\n", tif->tif_row);
1552                 fflush(stdout);
1553 #endif
1554                 EXPAND1D(EOFRLE);
1555                 (*sp->fill)(buf, thisrun, pa, lastx);
1556                 /*
1557                  * Cleanup at the end of the row.
1558                  */
1559                 if (mode & FAXMODE_BYTEALIGN) {
1560                         int n = BitsAvail - (BitsAvail &~ 7);
1561                         ClrBits(n);
1562                 } else if (mode & FAXMODE_WORDALIGN) {
1563                         int n = BitsAvail - (BitsAvail &~ 15);
1564                         ClrBits(n);
1565                         if (BitsAvail == 0 && !isAligned(cp, uint16))
1566                             cp++;
1567                 }
1568                 buf += sp->b.rowbytes;
1569                 occ -= sp->b.rowbytes;
1570                 sp->line++;
1571                 continue;
1572         EOFRLE:                         /* premature EOF */
1573                 (*sp->fill)(buf, thisrun, pa, lastx);
1574                 UNCACHE_STATE(tif, sp);
1575                 return (-1);
1576         }
1577         UNCACHE_STATE(tif, sp);
1578         return (1);
1579 }
1580
1581 int
1582 TIFFInitCCITTRLE(TIFF* tif, int scheme)
1583 {
1584         (void) scheme;
1585         if (InitCCITTFax3(tif)) {               /* reuse G3 support */
1586                 tif->tif_decoderow = Fax3DecodeRLE;
1587                 tif->tif_decodestrip = Fax3DecodeRLE;
1588                 tif->tif_decodetile = Fax3DecodeRLE;
1589                 /*
1590                  * Suppress RTC+EOLs when encoding and byte-align data.
1591                  */
1592                 return TIFFSetField(tif, TIFFTAG_FAXMODE,
1593                     FAXMODE_NORTC|FAXMODE_NOEOL|FAXMODE_BYTEALIGN);
1594         } else
1595                 return (0);
1596 }
1597
1598 int
1599 TIFFInitCCITTRLEW(TIFF* tif, int scheme)
1600 {
1601         (void) scheme;
1602         if (InitCCITTFax3(tif)) {               /* reuse G3 support */
1603                 tif->tif_decoderow = Fax3DecodeRLE;
1604                 tif->tif_decodestrip = Fax3DecodeRLE;
1605                 tif->tif_decodetile = Fax3DecodeRLE;
1606                 /*
1607                  * Suppress RTC+EOLs when encoding and word-align data.
1608                  */
1609                 return TIFFSetField(tif, TIFFTAG_FAXMODE,
1610                     FAXMODE_NORTC|FAXMODE_NOEOL|FAXMODE_WORDALIGN);
1611         } else
1612                 return (0);
1613 }
1614 #endif /* CCITT_SUPPORT */
1615
1616 /* vim: set ts=8 sts=8 sw=8 noet: */
1617 /*
1618  * Local Variables:
1619  * mode: c
1620  * c-basic-offset: 8
1621  * fill-column: 78
1622  * End:
1623  */
1624 #endif
1625