Coverage Report

Created: 2025-08-28 07:06

/src/ghostpdl/base/scfd.c
Line
Count
Source (jump to first uncovered line)
1
/* Copyright (C) 2001-2025 Artifex Software, Inc.
2
   All Rights Reserved.
3
4
   This software is provided AS-IS with no warranty, either express or
5
   implied.
6
7
   This software is distributed under license and may not be copied,
8
   modified or distributed except as expressly authorized under the terms
9
   of the license contained in the file LICENSE in this distribution.
10
11
   Refer to licensing information at http://www.artifex.com or contact
12
   Artifex Software, Inc.,  39 Mesa Street, Suite 108A, San Francisco,
13
   CA 94129, USA, for further information.
14
*/
15
16
17
/* CCITTFax decoding filter */
18
#include "stdio_.h"   /* includes std.h */
19
#include "memory_.h"
20
#include "gdebug.h"
21
#include "strimpl.h"
22
#include "scf.h"
23
#include "scfx.h"
24
25
/* ------ CCITTFaxDecode ------ */
26
27
private_st_CFD_state();
28
29
98.8M
#define CFD_BUFFER_SLOP 4
30
31
static inline int
32
get_run(stream_CFD_state *ss, stream_cursor_read *pr, const cfd_node decode[],
33
    int initial_bits, int min_bits, int *runlen, const char *str);
34
35
static inline int
36
invert_data(stream_CFD_state *ss, stream_cursor_read *pr, int *rlen, byte black_byte);
37
38
static inline int
39
skip_data(stream_CFD_state *ss, stream_cursor_read *pr, int rlen);
40
41
/* Set default parameter values. */
42
static void
43
s_CFD_set_defaults(register stream_state * st)
44
1.70M
{
45
1.70M
    stream_CFD_state *const ss = (stream_CFD_state *) st;
46
47
1.70M
    s_CFD_set_defaults_inline(ss);
48
1.70M
}
49
50
/* Initialize CCITTFaxDecode filter */
51
static int
52
s_CFD_init(stream_state * st)
53
1.70M
{
54
1.70M
    stream_CFD_state *const ss = (stream_CFD_state *) st;
55
1.70M
    int raster = ss->raster =
56
1.70M
        ROUND_UP((ss->Columns + 7) >> 3, ss->DecodedByteAlign);
57
1.70M
    byte white = (ss->BlackIs1 ? 0 : 0xff);
58
59
1.70M
    if (raster < 0)
60
1
        return ERRC;
61
62
1.70M
    if (ss->Columns <= 0)
63
0
        return ERRC;
64
65
1.70M
    s_hcd_init_inline(ss);
66
    /* Because skip_white_pixels can look as many as 4 bytes ahead, */
67
    /* we need to allow 4 extra bytes at the end of the row buffers. */
68
1.70M
    ss->lbufstart = gs_alloc_bytes(st->memory, raster + CFD_BUFFER_SLOP * (size_t)2, "CFD lbuf");
69
1.70M
    ss->lprev = 0;
70
1.70M
    if (ss->lbufstart == 0)
71
0
        return ERRC;   /****** WRONG ******/
72
1.70M
    ss->lbuf = ss->lbufstart + CFD_BUFFER_SLOP;
73
1.70M
    memset(ss->lbufstart, 0xaa, CFD_BUFFER_SLOP);
74
1.70M
    memset(ss->lbuf, white, raster);
75
1.70M
    memset(ss->lbuf + raster, 0xaa, CFD_BUFFER_SLOP);  /* for Valgrind */
76
1.70M
    if (ss->K != 0) {
77
1.70M
        ss->lprevstart = gs_alloc_bytes(st->memory, raster + CFD_BUFFER_SLOP * (size_t)2, "CFD lprev");
78
1.70M
        if (ss->lprevstart == 0)
79
0
            return ERRC; /****** WRONG ******/
80
1.70M
        ss->lprev = ss->lprevstart + CFD_BUFFER_SLOP;
81
        /* Clear the initial reference line for 2-D encoding. */
82
1.70M
        memset(ss->lprev, white, raster);
83
        /* Ensure that the scan of the reference line will stop. */
84
1.70M
        memset(ss->lprev + raster, 0xaa, CFD_BUFFER_SLOP);
85
1.70M
        memset(ss->lprevstart, 0xaa, CFD_BUFFER_SLOP);
86
1.70M
    }
87
1.70M
    ss->k_left = min(ss->K, 0);
88
1.70M
    ss->run_color = 0;
89
1.70M
    ss->damaged_rows = 0;
90
1.70M
    ss->skipping_damage = false;
91
1.70M
    ss->cbit = 0;
92
1.70M
    ss->uncomp_run = 0;
93
1.70M
    ss->rows_left = (ss->Rows <= 0 || ss->EndOfBlock ? -1 : ss->Rows);
94
1.70M
    ss->row = 0;
95
1.70M
    ss->rpos = ss->wpos = -1;
96
1.70M
    ss->eol_count = 0;
97
1.70M
    ss->invert = white;
98
1.70M
    ss->min_left = 1;
99
1.70M
    return 0;
100
1.70M
}
101
102
/* Release the filter. */
103
static void
104
s_CFD_release(stream_state * st)
105
1.70M
{
106
1.70M
    stream_CFD_state *const ss = (stream_CFD_state *) st;
107
108
1.70M
    gs_free_object(st->memory, ss->lprevstart, "CFD lprev(close)");
109
1.70M
    gs_free_object(st->memory, ss->lbufstart, "CFD lbuf(close)");
110
1.70M
}
111
112
/* Declare the variables that hold the state. */
113
#define cfd_declare_state\
114
171M
        hcd_declare_state;\
115
171M
        register byte *q;\
116
171M
        int qbit
117
/* Load the state from the stream. */
118
#define cfd_load_state()\
119
293M
        hcd_load_state(),\
120
0
        q = ss->lbuf + ss->wpos, qbit = ss->cbit
121
/* Store the state back in the stream. */
122
#define cfd_store_state()\
123
293M
        hcd_store_state(),\
124
108M
        ss->wpos = q - ss->lbuf, ss->cbit = qbit
125
126
/* Macros to get blocks of bits from the input stream. */
127
/* Invariants: 0 <= bits_left <= bits_size; */
128
/* bits [bits_left-1..0] contain valid data. */
129
130
1.28M
#define avail_bits(n) hcd_bits_available(n)
131
328M
#define ensure_bits(n, outl) hcd_ensure_bits(n, outl)
132
355M
#define peek_bits(n) hcd_peek_bits(n)
133
1.28M
#define peek_var_bits(n) hcd_peek_var_bits(n)
134
295M
#define skip_bits(n) hcd_skip_bits(n)
135
136
/* Get a run from the stream. */
137
#ifdef DEBUG
138
#  define IF_DEBUG(expr) expr
139
#else
140
1.28M
#  define IF_DEBUG(expr) DO_NOTHING
141
#endif
142
143
static inline int get_run(stream_CFD_state *ss, stream_cursor_read *pr, const cfd_node decode[],
144
           int initial_bits, int min_bits, int *runlen, const char *str)
145
28.1M
{
146
28.1M
    cfd_declare_state;
147
28.1M
    const cfd_node *np;
148
28.1M
    int clen;
149
28.1M
    cfd_load_state();
150
151
28.1M
    HCD_ENSURE_BITS_ELSE(initial_bits) {
152
        /* We might still have enough bits for the specific code. */
153
1.49k
        if (bits_left < min_bits)
154
447
            goto outl;
155
1.04k
        np = &decode[hcd_peek_bits_left() << (initial_bits - bits_left)];
156
1.04k
        if ((clen = np->code_length) > bits_left)
157
544
            goto outl;
158
505
        goto locl;
159
1.04k
    }
160
28.1M
    np = &decode[peek_bits(initial_bits)];
161
28.1M
    if ((clen = np->code_length) > initial_bits) {
162
1.28M
            IF_DEBUG(uint init_bits = peek_bits(initial_bits));
163
1.28M
            if (!avail_bits(clen)) goto outl;
164
1.28M
            clen -= initial_bits;
165
1.28M
            skip_bits(initial_bits);
166
1.28M
            ensure_bits(clen, outl);                /* can't goto outl */
167
1.28M
            np = &decode[np->run_length + peek_var_bits(clen)];
168
1.28M
            if_debug4('W', "%s xcode=0x%x,%d rlen=%d\n", str,
169
1.28M
                      (init_bits << np->code_length) +
170
1.28M
                        peek_var_bits(np->code_length),
171
1.28M
                      initial_bits + np->code_length,
172
1.28M
                      np->run_length);
173
1.28M
            skip_bits(np->code_length);
174
26.8M
    } else {
175
26.8M
locl:
176
26.8M
       if_debug4('W', "%s code=0x%x,%d rlen=%d\n", str,
177
26.8M
                      peek_var_bits(clen), clen, np->run_length);
178
26.8M
       skip_bits(clen);
179
26.8M
    }
180
28.1M
    *runlen = np->run_length;
181
182
28.1M
    cfd_store_state();
183
28.1M
    return(0);
184
1.05k
outl:
185
1.05k
    cfd_store_state();
186
1.05k
    return(-1);
187
28.1M
}
188
189
190
/* Skip data bits for a white run. */
191
/* rlen is either less than 64, or a multiple of 64. */
192
static inline int skip_data(stream_CFD_state *ss, stream_cursor_read *pr, int rlen)
193
8.26M
{
194
8.26M
    cfd_declare_state;
195
8.26M
    cfd_load_state();
196
8.26M
    (void)rlimit;
197
198
8.26M
    if ( (qbit -= rlen) < 0 )
199
6.02M
    {
200
6.02M
        q -= qbit >> 3, qbit &= 7;
201
6.02M
        if ( rlen >= 64 ) {
202
310k
            cfd_store_state();
203
310k
            return(-1);
204
310k
        }
205
6.02M
    }
206
8.26M
    cfd_store_state();
207
7.95M
    return(0);
208
8.26M
}
209
210
211
/* Invert data bits for a black run. */
212
/* If rlen >= 64, execute makeup_action: this is to handle */
213
/* makeup codes efficiently, since these are always a multiple of 64. */
214
215
static inline int invert_data(stream_CFD_state *ss, stream_cursor_read *pr, int *rlen, byte black_byte)
216
85.1M
{
217
85.1M
    byte *qlim = ss->lbuf + ss->raster + CFD_BUFFER_SLOP;
218
85.1M
    cfd_declare_state;
219
85.1M
    cfd_load_state();
220
85.1M
    (void)rlimit;
221
222
85.1M
    if (q >= qlim || q < ss->lbufstart) {
223
0
        return(-1);
224
0
    }
225
226
85.1M
    if ( (*rlen) > qbit )
227
52.9M
    {
228
52.9M
        if (q + ((*rlen - qbit) >> 3) > qlim) {
229
5
            return(-1);
230
5
        }
231
232
52.9M
        if (q >= ss->lbuf) {
233
51.3M
          *q++ ^= (1 << qbit) - 1;
234
51.3M
        }
235
1.57M
        else {
236
1.57M
            q++;
237
1.57M
        }
238
52.9M
        (*rlen) -= qbit;
239
240
52.9M
        if (q + ((*rlen) >> 3) >= qlim) {
241
12
            return(-1);
242
12
        }
243
244
52.9M
        switch ( (*rlen) >> 3 )
245
52.9M
        {
246
290k
          case 7:         /* original rlen possibly >= 64 */
247
290k
                  if ( (*rlen) + qbit >= 64 ) {
248
160k
                    goto d;
249
160k
                  }
250
129k
                  *q++ = black_byte;
251
375k
          case 6: *q++ = black_byte;
252
675k
          case 5: *q++ = black_byte;
253
1.18M
          case 4: *q++ = black_byte;
254
2.10M
          case 3: *q++ = black_byte;
255
4.89M
          case 2: *q++ = black_byte;
256
13.1M
          case 1: *q = black_byte;
257
13.1M
              (*rlen) &= 7;
258
13.1M
              if ( !(*rlen) ) {
259
2.36M
                  qbit = 0;
260
2.36M
                  break;
261
2.36M
              }
262
10.8M
              q++;
263
49.8M
          case 0:                 /* know rlen != 0 */
264
49.8M
              qbit = 8 - (*rlen);
265
49.8M
              *q ^= 0xff << qbit;
266
49.8M
              break;
267
537k
          default:        /* original rlen >= 64 */
268
698k
d:            memset(q, black_byte, (*rlen) >> 3);
269
698k
              q += (*rlen) >> 3;
270
698k
              (*rlen) &= 7;
271
698k
              if ( !(*rlen) ) {
272
101k
                qbit = 0;
273
101k
                q--;
274
101k
              }
275
596k
              else {
276
596k
                qbit = 8 - (*rlen);
277
596k
                *q ^= 0xff << qbit;
278
596k
              }
279
698k
              cfd_store_state();
280
698k
              return(-1);
281
52.9M
          }
282
52.9M
    }
283
32.2M
    else {
284
32.2M
            qbit -= (*rlen),
285
32.2M
            *q ^= ((1 << (*rlen)) - 1) << qbit;
286
287
32.2M
    }
288
85.1M
    cfd_store_state();
289
84.4M
    return(0);
290
85.1M
}
291
292
293
/* Buffer refill for CCITTFaxDecode filter */
294
static int cf_decode_eol(stream_CFD_state *, stream_cursor_read *);
295
static int cf_decode_1d(stream_CFD_state *, stream_cursor_read *);
296
static int cf_decode_2d(stream_CFD_state *, stream_cursor_read *);
297
static int cf_decode_uncompressed(stream_CFD_state *, stream_cursor_read *);
298
static int
299
s_CFD_process(stream_state * st, stream_cursor_read * pr,
300
              stream_cursor_write * pw, bool last)
301
1.74M
{
302
1.74M
    stream_CFD_state *const ss = (stream_CFD_state *) st;
303
1.74M
    int wstop = ss->raster - 1;
304
1.74M
    int eol_count = ss->eol_count;
305
1.74M
    int k_left = ss->k_left;
306
1.74M
    int rows_left = ss->rows_left;
307
1.74M
    int status = 0;
308
309
#ifdef DEBUG
310
    const byte *rstart = pr->ptr;
311
    const byte *wstart = pw->ptr;
312
313
#endif
314
315
    /* Update the pointers we actually use, in case GC moved the buffer */
316
1.74M
    ss->lbuf = ss->lbufstart + CFD_BUFFER_SLOP;
317
1.74M
    ss->lprev = ss->lprevstart + CFD_BUFFER_SLOP;
318
319
51.5M
top:
320
#ifdef DEBUG
321
    {
322
        hcd_declare_state;
323
        hcd_load_state();
324
        (void)rlimit;
325
        if_debug8m('w', ss->memory,
326
                   "[w]CFD_process top: eol_count=%d, k_left=%d, rows_left=%d\n"
327
                   "    bits="PRI_INTPTR", bits_left=%d, read %u, wrote %u%s\n",
328
                   eol_count, k_left, rows_left,
329
                   (intptr_t) bits, bits_left,
330
                   (uint) (p - rstart), (uint) (pw->ptr - wstart),
331
                   (ss->skipping_damage ? ", skipping damage" : ""));
332
    }
333
#endif
334
51.5M
    if (ss->skipping_damage) { /* Skip until we reach an EOL. */
335
0
        hcd_declare_state;
336
0
        int skip;
337
0
        (void)rlimit;
338
339
0
        status = 0;
340
0
        do {
341
0
            switch ((skip = cf_decode_eol(ss, pr))) {
342
0
                default:  /* not EOL */
343
0
                    hcd_load_state();
344
0
                    skip_bits(-skip);
345
0
                    hcd_store_state();
346
0
                    continue;
347
0
                case 0: /* need more input */
348
0
                    goto out;
349
0
                case 1: /* EOL */
350
0
                    {   /* Back up over the EOL. */
351
0
                        hcd_load_state();
352
0
                        bits_left += run_eol_code_length;
353
0
                        hcd_store_state();
354
0
                    }
355
0
                    ss->skipping_damage = false;
356
0
            }
357
0
        }
358
0
        while (ss->skipping_damage);
359
0
        ss->damaged_rows++;
360
0
    }
361
    /*
362
     * Check for a completed input scan line.  This isn't quite as
363
     * simple as it seems, because we could have run out of input data
364
     * between a makeup code and a 0-length termination code, or in a
365
     * 2-D line before a final horizontal code with a 0-length second
366
     * run.  There's probably a way to think about this situation that
367
     * doesn't require a special check, but I haven't found it yet.
368
     */
369
51.5M
    if (ss->wpos == wstop && ss->cbit <= (-ss->Columns & 7) &&
370
51.5M
        (k_left == 0 ? !(ss->run_color & ~1) : ss->run_color == 0)
371
51.5M
        ) {     /* Check for completed data to be copied to the client. */
372
        /* (We could avoid the extra copy step for 1-D, but */
373
        /* it's simpler not to, and it doesn't cost much.) */
374
49.8M
        if (ss->rpos < ss->wpos) {
375
49.8M
            stream_cursor_read cr;
376
377
49.8M
            cr.ptr = ss->lbuf + ss->rpos;
378
49.8M
            cr.limit = ss->lbuf + ss->wpos;
379
49.8M
            status = stream_move(&cr, pw);
380
49.8M
            ss->rpos = cr.ptr - ss->lbuf;
381
49.8M
            if (status)
382
38.1k
                goto out;
383
49.8M
        }
384
49.8M
        ss->row++;
385
49.8M
        if (rows_left > 0 && --rows_left == 0)
386
221
            goto ck_eol;  /* handle EOD if it is present */
387
49.8M
        if (ss->K != 0) {
388
49.7M
            byte *prev_bits = ss->lprev;
389
49.7M
            byte *prev_start = ss->lprevstart;
390
391
49.7M
            ss->lprev = ss->lbuf;
392
49.7M
            ss->lprevstart = ss->lbufstart;
393
49.7M
            ss->lbuf = prev_bits;
394
49.7M
            ss->lbufstart = prev_start;
395
49.7M
            if (ss->K > 0)
396
2.12k
                k_left = (k_left == 0 ? ss->K : k_left) - 1;
397
49.7M
        }
398
49.8M
        ss->rpos = ss->wpos = -1;
399
49.8M
        ss->eol_count = eol_count = 0;
400
49.8M
        ss->cbit = 0;
401
49.8M
        ss->invert = (ss->BlackIs1 ? 0 : 0xff);
402
49.8M
        memset(ss->lbuf, ss->invert, wstop + 1);
403
49.8M
        ss->run_color = 0;
404
        /*
405
         * If EndOfLine is true, we want to include the byte padding
406
         * in the string of initial zeros in the EOL.  If EndOfLine
407
         * is false, we aren't sure what we should do....
408
         */
409
49.8M
        if (ss->EncodedByteAlign && !ss->EndOfLine)
410
0
            ss->bits_left &= ~7;
411
49.8M
    }
412
    /* If we're between scan lines, scan for EOLs. */
413
51.5M
    if (ss->wpos < 0) {
414
            /*
415
             * According to Adobe, the decoder should always check for
416
             * the EOD sequence, regardless of EndOfBlock: the Red Book's
417
             * documentation of EndOfBlock is wrong.
418
             */
419
51.5M
ck_eol:
420
53.2M
        while ((status = cf_decode_eol(ss, pr)) > 0) {
421
3.43M
            if_debug0m('w', ss->memory, "[w]EOL\n");
422
            /* If we are in a Group 3 mixed regime, */
423
            /* check the next bit for 1- vs. 2-D. */
424
3.43M
            if (ss->K > 0) {
425
2.38k
                hcd_declare_state;
426
2.38k
                hcd_load_state();
427
2.38k
                ensure_bits(1, out); /* can't fail */
428
2.38k
                k_left = (peek_bits(1) ? 0 : 1);
429
2.38k
                skip_bits(1);
430
2.38k
                hcd_store_state();
431
2.38k
            }
432
3.43M
            ++eol_count;
433
3.43M
            if (eol_count == (ss->K < 0 ? 2 : 6)) {
434
1.70M
                status = EOFC;
435
1.70M
                goto out;
436
1.70M
            }
437
3.43M
        }
438
49.8M
        if (rows_left == 0) {
439
218
            status = EOFC;
440
218
            goto out;
441
218
        }
442
49.8M
        if (status == 0)  /* input empty while scanning EOLs */
443
2.50k
            goto out;
444
49.8M
        switch (eol_count) {
445
49.7M
            case 0:
446
49.7M
                if (ss->EndOfLine) { /* EOL is required, but none is present. */
447
0
                    status = ERRC;
448
0
                    goto check;
449
0
                }
450
49.8M
            case 1:
451
49.8M
                break;
452
1
            default:
453
1
                status = ERRC;
454
1
                goto check;
455
49.8M
        }
456
49.8M
    }
457
    /* Now decode actual data. */
458
49.8M
    if (k_left < 0) {
459
49.7M
        if_debug0m('w', ss->memory, "[w2]new row\n");
460
49.7M
        status = cf_decode_2d(ss, pr);
461
49.7M
    } else if (k_left == 0) {
462
30.6k
        if_debug0m('w', ss->memory, "[w1]new row\n");
463
30.6k
        status = cf_decode_1d(ss, pr);
464
30.6k
    } else {
465
2.06k
        if_debug1m('w', ss->memory, "[w1]new 2-D row, k_left=%d\n", k_left);
466
2.06k
        status = cf_decode_2d(ss, pr);
467
2.06k
    }
468
49.8M
    if_debug3m('w', ss->memory, "[w]CFD status = %d, wpos = %d, cbit = %d\n",
469
49.8M
               status, ss->wpos, ss->cbit);
470
49.8M
  check:switch (status) {
471
49.8M
        case 1:   /* output full */
472
49.8M
            goto top;
473
1.69k
        case ERRC:
474
            /* Check for special handling of damaged rows. */
475
1.69k
            if (ss->damaged_rows >= ss->DamagedRowsBeforeError ||
476
1.69k
                !(ss->EndOfLine && ss->K >= 0)
477
1.69k
                )
478
1.69k
                break;
479
            /* Substitute undamaged data if appropriate. */
480
            /****** NOT IMPLEMENTED YET ******/
481
0
            {
482
0
                ss->wpos = wstop;
483
0
                ss->cbit = -ss->Columns & 7;
484
0
                ss->run_color = 0;
485
0
            }
486
0
            ss->skipping_damage = true;
487
0
            goto top;
488
1.47k
        default:
489
1.47k
            ss->damaged_rows = 0; /* finished a good row */
490
49.8M
    }
491
1.74M
  out:ss->k_left = k_left;
492
1.74M
    ss->rows_left = rows_left;
493
1.74M
    ss->eol_count = eol_count;
494
1.74M
    if (ss->ErrsAsEOD && status < 0)
495
0
        return EOFC;
496
1.74M
    return status;
497
1.74M
}
498
499
/*
500
 * Decode a leading EOL, if any.
501
 * If an EOL is present, skip over it and return 1;
502
 * if no EOL is present, read no input and return -N, where N is the
503
 * number of initial bits that can be skipped in the search for an EOL;
504
 * if more input is needed, return 0.
505
 * Note that if we detected an EOL, we know that we can back up over it;
506
 * if we detected an N-bit non-EOL, we know that at least N bits of data
507
 * are available in the buffer.
508
 */
509
static int
510
cf_decode_eol(stream_CFD_state * ss, stream_cursor_read * pr)
511
53.2M
{
512
53.2M
    hcd_declare_state;
513
53.2M
    int zeros;
514
53.2M
    int look_ahead;
515
516
53.2M
    hcd_load_state();
517
117M
    for (zeros = 0; zeros < run_eol_code_length - 1; zeros++) {
518
114M
        ensure_bits(1, out);
519
114M
        if (peek_bits(1))
520
49.8M
            return -(zeros + 1);
521
64.6M
        skip_bits(1);
522
64.6M
    }
523
    /* We definitely have an EOL.  Skip further zero bits. */
524
3.43M
    look_ahead = (ss->K > 0 ? 2 : 1);
525
3.43M
    for (;;) {
526
3.43M
        ensure_bits(look_ahead, back);
527
3.43M
        if (peek_bits(1))
528
3.43M
            break;
529
907
        skip_bits(1);
530
907
    }
531
3.43M
    skip_bits(1);
532
3.43M
    hcd_store_state();
533
3.43M
    return 1;
534
0
  back:     /*
535
                                 * We ran out of data while skipping zeros.
536
                                 * We know we are at a byte boundary, and have just skipped
537
                                 * at least run_eol_code_length - 1 zeros.  However,
538
                                 * bits_left may be 1 if look_ahead == 2.
539
                                 */
540
0
    bits &= (1 << bits_left) - 1;
541
0
    bits_left += run_eol_code_length - 1;
542
0
    hcd_store_state();
543
2.50k
  out:return 0;
544
0
}
545
546
/* Decode a 1-D scan line. */
547
static int
548
cf_decode_1d(stream_CFD_state * ss, stream_cursor_read * pr)
549
30.6k
{
550
30.6k
    cfd_declare_state;
551
30.6k
    byte black_byte = (ss->BlackIs1 ? 0xff : 0);
552
30.6k
    int end_bit = -ss->Columns & 7;
553
30.6k
    byte *stop = ss->lbuf - 1 + ss->raster;
554
30.6k
    int run_color = ss->run_color;
555
30.6k
    int status;
556
30.6k
    int bcnt;
557
30.6k
    (void)rlimit;
558
559
30.6k
    cfd_load_state();
560
30.6k
    if_debug1m('w', ss->memory, "[w1]entry run_color = %d\n", ss->run_color);
561
30.6k
    if (run_color > 0)
562
219
        goto db;
563
30.3k
    else
564
30.3k
        goto dw;
565
1.49M
#define q_at_stop() (q >= stop && (qbit <= end_bit || q > stop))
566
735k
    while (1)
567
735k
    {
568
735k
        run_color = 0;
569
735k
        if (q_at_stop())
570
3.39k
            goto done;
571
572
762k
  dw:   /* Decode a white run. */
573
980k
        do {
574
980k
            cfd_store_state();
575
980k
            status = get_run(ss, pr, cf_white_decode, cfd_white_initial_bits,
576
980k
                             cfd_white_min_bits, &bcnt, "[w1]white");
577
980k
            cfd_load_state();
578
980k
            if (status < 0) {
579
                /* We already set run_color to 0 or -1. */
580
399
                status = 0;
581
399
                goto out;
582
399
            }
583
584
979k
            if (bcnt < 0) {   /* exceptional situation */
585
24
                switch (bcnt) {
586
0
                    case run_uncompressed: /* Uncompressed data. */
587
0
                        cfd_store_state();
588
0
                        bcnt = cf_decode_uncompressed(ss, pr);
589
0
                        if (bcnt < 0)
590
0
                            return bcnt;
591
0
                        cfd_load_state();
592
0
                        if (bcnt)
593
0
                            goto db;
594
0
                        else
595
0
                            continue; /* Restart decoding white */
596
                        /*case run_error: */
597
                        /*case run_zeros: *//* Premature end-of-line. */
598
24
                    default:
599
24
                        status = ERRC;
600
24
                        goto out;
601
24
                }
602
24
            }
603
604
979k
            cfd_store_state();
605
979k
            status = skip_data(ss, pr, bcnt);
606
979k
            cfd_load_state();
607
979k
            if (status < 0) {
608
                /* If we run out of data after a makeup code, */
609
                /* note that we are still processing a white run. */
610
217k
                run_color = -1;
611
217k
            }
612
979k
        } while (status < 0);
613
614
762k
        if (q_at_stop()) {
615
26.5k
            run_color = 0;    /* not inside a run */
616
29.9k
  done:
617
29.9k
            if (q > stop || qbit < end_bit)
618
217
                status = ERRC;
619
29.7k
            else
620
29.7k
                status = 1;
621
29.9k
            break;
622
26.5k
        }
623
735k
        run_color = 1;
624
625
736k
  db:   /* Decode a black run. */
626
736k
        do {
627
736k
            cfd_store_state();
628
736k
            status = get_run(ss, pr, cf_black_decode, cfd_black_initial_bits,
629
736k
                             cfd_black_min_bits, &bcnt, "[w1]black");
630
736k
            cfd_load_state();
631
736k
            if (status < 0) {
632
                /* We already set run_color to 1 or 2. */
633
219
                status = 0;
634
219
                goto out;
635
219
            }
636
637
736k
            if (bcnt < 0) {  /* All exceptional codes are invalid here. */
638
                /****** WRONG, uncompressed IS ALLOWED ******/
639
29
                status = ERRC;
640
29
                goto out;
641
29
            }
642
643
            /* Invert bits designated by black run. */
644
736k
            cfd_store_state();
645
736k
            status = invert_data(ss, pr, &bcnt, black_byte);
646
736k
            cfd_load_state();
647
736k
            if (status < 0) {
648
                /* If we run out of data after a makeup code, */
649
                /* note that we are still processing a black run. */
650
446
                run_color = 2;
651
446
            }
652
736k
        } while (status < 0);
653
736k
    }
654
655
30.6k
out:
656
30.6k
    cfd_store_state();
657
30.6k
    ss->run_color = run_color;
658
30.6k
    if_debug1m('w', ss->memory, "[w1]exit run_color = %d\n", run_color);
659
30.6k
    return status;
660
0
}
661
662
/* Decode a 2-D scan line. */
663
static int
664
cf_decode_2d(stream_CFD_state * ss, stream_cursor_read * pr)
665
49.7M
{
666
49.7M
    cfd_declare_state;
667
49.7M
    byte invert_white = (ss->BlackIs1 ? 0 : 0xff);
668
49.7M
    byte black_byte = ~invert_white;
669
49.7M
    byte invert = ss->invert;
670
49.7M
    int end_count = -ss->Columns & 7;
671
49.7M
    uint raster = ss->raster;
672
49.7M
    byte *q0 = ss->lbuf;
673
49.7M
    byte *prev_q01 = ss->lprev + 1;
674
49.7M
    byte *endptr = q0 - 1 + raster;
675
49.7M
    int init_count = raster << 3;
676
49.7M
    register int count;
677
49.7M
    int rlen;
678
49.7M
    int status;
679
680
49.7M
    cfd_load_state();
681
49.7M
    count = ((endptr - q) << 3) + qbit;
682
49.7M
    endptr[1] = 0xa0;   /* a byte with some 0s and some 1s, */
683
    /* to ensure run scan will stop */
684
49.7M
    if_debug1m('W', ss->memory, "[w2]raster=%d\n", raster);
685
49.7M
    switch (ss->run_color) {
686
35
        case -2:
687
35
            ss->run_color = 0;
688
35
            goto hww;
689
105
        case -1:
690
105
            ss->run_color = 0;
691
105
            goto hbw;
692
84
        case 1:
693
84
            ss->run_color = 0;
694
84
            goto hwb;
695
18
        case 2:
696
18
            ss->run_color = 0;
697
18
            goto hbb;
698
            /*case 0: */
699
49.7M
    }
700
701
    /* top of decode loop */
702
259M
    while (1)
703
259M
    {
704
259M
        if (count <= end_count) {
705
49.7M
            status = (count < end_count ? ERRC : 1);
706
49.7M
            goto out;
707
49.7M
        }
708
        /* If invert == invert_white, white and black have their */
709
        /* correct meanings; if invert == ~invert_white, */
710
        /* black and white are interchanged. */
711
259M
        if_debug1m('W', ss->memory, "[w2]%4d:\n", count);
712
#ifdef DEBUG
713
        /* Check the invariant between q, qbit, and count. */
714
        {
715
            int pcount = (endptr - q) * 8 + qbit;
716
717
            if (pcount != count)
718
                dmlprintf2(ss->memory, "[w2]Error: count=%d pcount=%d\n",
719
                           count, pcount);
720
        }
721
#endif
722
        /*
723
         * We could just use get_run here, but we can do better.  However,
724
         * we must be careful to handle the case where the very last codes
725
         * in the input stream are 1-bit "vertical 0" codes: we can't just
726
         * use ensure_bits(3, ...) and go to get more data if it fails.
727
         */
728
209M
        ensure_bits(3, out3);
729
390M
#define vertical_0 (countof(cf2_run_vertical) / 2)
730
209M
        switch (peek_bits(3)) {
731
153M
        default /*4..7*/ :  /* vertical(0) */
732
153M
            if (0) {
733
602
 out3:
734
                /* Unless it's a 1-bit "vertical 0" code, exit. */
735
602
                if (!(bits_left > 0 && peek_bits(1)))
736
401
                    goto out0;
737
602
            }
738
153M
            skip_bits(1);
739
153M
            rlen = vertical_0;
740
153M
            break;
741
20.3M
        case 2:   /* vertical(+1) */
742
20.3M
            skip_bits(3);
743
20.3M
            rlen = vertical_0 + 1;
744
20.3M
            break;
745
16.7M
        case 3:   /* vertical(-1) */
746
16.7M
            skip_bits(3);
747
16.7M
            rlen = vertical_0 - 1;
748
16.7M
            break;
749
7.19M
        case 1:   /* horizontal */
750
7.19M
            skip_bits(3);
751
7.19M
            if (invert == invert_white) {
752
                /* We handle horizontal decoding here, so that we can
753
                 * branch back into it if we run out of input data. */
754
                /* White, then black. */
755
4.48M
  hww:
756
4.53M
                do {
757
4.53M
                    cfd_store_state();
758
4.53M
                    status = get_run(ss, pr, cf_white_decode,
759
4.53M
                                     cfd_white_initial_bits,
760
4.53M
                                     cfd_white_min_bits, &rlen, " white");
761
4.53M
                    cfd_load_state();
762
4.53M
                    if (status < 0) {
763
43
                        ss->run_color = -2;
764
43
                        goto out0;
765
43
                    }
766
767
4.53M
                    if ((count -= rlen) < end_count) {
768
100
                        status = ERRC;
769
100
                        goto out;
770
100
                    }
771
4.53M
                    if (rlen < 0) goto rlen_lt_zero;
772
773
4.53M
                    cfd_store_state();
774
4.53M
                    status = skip_data(ss, pr, rlen);
775
4.53M
                    cfd_load_state();
776
4.53M
                } while (status < 0);
777
778
                /* Handle the second half of a white-black horizontal code. */
779
4.48M
  hwb:
780
4.52M
                do {
781
4.52M
                    cfd_store_state();
782
4.52M
                    status = get_run(ss, pr, cf_black_decode,
783
4.52M
                                     cfd_black_initial_bits,
784
4.52M
                                     cfd_black_min_bits, &rlen, " black");
785
4.52M
                    cfd_load_state();
786
4.52M
                    if (status < 0){
787
91
                        ss->run_color = 1;
788
91
                        goto out0;
789
91
                    }
790
791
4.52M
                    if ((count -= rlen) < end_count) {
792
69
                        status = ERRC;
793
69
                        goto out;
794
69
                    }
795
4.52M
                    if (rlen < 0) goto rlen_lt_zero;
796
797
4.52M
                    cfd_store_state();
798
4.52M
                    status = invert_data(ss, pr, &rlen, black_byte);
799
4.52M
                    cfd_load_state();
800
4.52M
                } while (status < 0);
801
4.48M
            } else {
802
                /* Black, then white. */
803
2.71M
  hbb:
804
2.73M
                do {
805
2.73M
                    cfd_store_state();
806
2.73M
                    status = get_run(ss, pr, cf_black_decode,
807
2.73M
                                     cfd_black_initial_bits,
808
2.73M
                                     cfd_black_min_bits, &rlen, " black");
809
2.73M
                    cfd_load_state();
810
2.73M
                    if (status < 0) {
811
18
                        ss->run_color = 2;
812
18
                        goto out0;
813
18
                    }
814
815
2.73M
                    if ((count -= rlen) < end_count) {
816
119
                        status = ERRC;
817
119
                        goto out;
818
119
                    }
819
2.73M
                    if (rlen < 0) goto rlen_lt_zero;
820
821
2.73M
                    cfd_store_state();
822
2.73M
                    status = invert_data(ss, pr, &rlen, black_byte);
823
2.73M
                    cfd_load_state();
824
2.73M
                }
825
2.73M
                while (status < 0);
826
827
                /* Handle the second half of a black-white horizontal code. */
828
2.71M
  hbw:
829
2.75M
                do {
830
2.75M
                    cfd_store_state();
831
2.75M
                    status = get_run(ss, pr, cf_white_decode,
832
2.75M
                                     cfd_white_initial_bits,
833
2.75M
                                     cfd_white_min_bits, &rlen, " white");
834
2.75M
                    cfd_load_state();
835
2.75M
                    if (status < 0) {
836
107
                        ss->run_color = -1;
837
107
                        goto out0;
838
107
                    }
839
840
2.75M
                    if ((count -= rlen) < end_count) {
841
290
                        status = ERRC;
842
290
                        goto out;
843
290
                    }
844
2.75M
                    if (rlen < 0) goto rlen_lt_zero;
845
846
2.75M
                    cfd_store_state();
847
2.75M
                    status = skip_data(ss, pr, rlen);
848
2.75M
                    cfd_load_state();
849
2.75M
                } while (status < 0);
850
2.71M
            }
851
7.19M
            continue; /* jump back to top of decode loop */
852
11.9M
        case 0:   /* everything else */
853
11.9M
            cfd_store_state();
854
11.9M
            status = get_run(ss, pr, cf_2d_decode, cfd_2d_initial_bits,
855
11.9M
                             cfd_2d_min_bits, &rlen, "[w2]");
856
11.9M
            cfd_load_state();
857
11.9M
            if (status < 0) {
858
175
                goto out0;
859
175
            }
860
861
            /* rlen may be run2_pass, run_uncompressed, or */
862
            /* 0..countof(cf2_run_vertical)-1. */
863
11.9M
            if (rlen < 0) {
864
3.16M
rlen_lt_zero:
865
3.16M
                switch (rlen) {
866
3.16M
                case run2_pass:
867
3.16M
                    break;
868
7
                case run_uncompressed:
869
7
                {
870
7
                    int which;
871
872
7
                    cfd_store_state();
873
7
                    which = cf_decode_uncompressed(ss, pr);
874
7
                    if (which < 0) {
875
7
                        status = which;
876
7
                        goto out;
877
7
                    }
878
7
                    cfd_load_state();
879
/****** ADJUST count ******/
880
0
                    invert = (which ? ~invert_white : invert_white);
881
0
                    continue; /* jump back to top of decode loop */
882
7
                }
883
267
                default:  /* run_error, run_zeros */
884
267
                    status = ERRC;
885
267
                    goto out;
886
3.16M
                }
887
3.16M
            }
888
209M
        }
889
        /* Interpreting the run requires scanning the */
890
        /* previous ('reference') line. */
891
202M
        {
892
202M
            int prev_count = count;
893
202M
            byte prev_data;
894
202M
            int dlen;
895
202M
            static const byte count_bit[8] =
896
202M
                                   {0x80, 1, 2, 4, 8, 0x10, 0x20, 0x40};
897
202M
            byte *prev_q = prev_q01 + (q - q0);
898
202M
            int plen;
899
900
202M
            if (!(count & 7))
901
65.7M
                prev_q++;   /* because of skip macros */
902
202M
            prev_data = prev_q[-1] ^ invert;
903
            /* Find the b1 transition. */
904
202M
            if ((prev_data & count_bit[prev_count & 7]) &&
905
202M
                (prev_count < init_count || invert != invert_white)
906
202M
                ) {     /* Look for changing white first. */
907
24.3M
                if_debug1m('W', ss->memory, " data=0x%x", prev_data);
908
24.3M
                skip_black_pixels(prev_data, prev_q,
909
24.3M
                                  prev_count, invert, plen);
910
24.3M
                if (prev_count < end_count)    /* overshot */
911
8.32k
                    prev_count = end_count;
912
24.3M
                if_debug1m('W', ss->memory, " b1 other=%d", prev_count);
913
24.3M
            }
914
202M
            if (prev_count != end_count) {
915
202M
                if_debug1m('W', ss->memory, " data=0x%x", prev_data);
916
202M
                skip_white_pixels(prev_data, prev_q,
917
202M
                                  prev_count, invert, plen);
918
202M
                if (prev_count < end_count)    /* overshot */
919
253k
                    prev_count = end_count;
920
202M
                if_debug1m('W', ss->memory, " b1 same=%d", prev_count);
921
202M
            }
922
            /* b1 = prev_count; */
923
202M
            if (rlen == run2_pass) { /* Pass mode.  Find b2. */
924
3.16M
                if (prev_count != end_count) {
925
3.16M
                    if_debug1m('W', ss->memory, " data=0x%x", prev_data);
926
3.16M
                    skip_black_pixels(prev_data, prev_q,
927
3.16M
                                      prev_count, invert, plen);
928
3.16M
                    if (prev_count < end_count)  /* overshot */
929
125
                        prev_count = end_count;
930
3.16M
                }
931
                /* b2 = prev_count; */
932
3.16M
                if_debug2m('W', ss->memory, " b2=%d, pass %d\n",
933
3.16M
                           prev_count, count - prev_count);
934
199M
            } else {   /* Vertical coding. */
935
                /* Remember that count counts *down*. */
936
199M
                prev_count += rlen - vertical_0; /* a1 */
937
199M
                if_debug2m('W', ss->memory, " vertical %d -> %d\n",
938
199M
                           (int)(rlen - vertical_0), prev_count);
939
199M
            }
940
            /* Now either invert or skip from count */
941
            /* to prev_count, and reset count. */
942
202M
            if (invert == invert_white) { /* Skip data bits. */
943
125M
                q = endptr - (prev_count >> 3);
944
125M
                qbit = prev_count & 7;
945
125M
            } else {   /* Invert data bits. */
946
77.1M
                dlen = count - prev_count;
947
948
77.1M
                cfd_store_state();
949
77.1M
                (void)invert_data(ss, pr, &dlen, black_byte);
950
77.1M
                cfd_load_state();
951
77.1M
            }
952
202M
            count = prev_count;
953
202M
            if (rlen >= 0)    /* vertical mode */
954
199M
                invert = ~invert; /* polarity changes */
955
202M
        }
956
        /* jump back to top of decode loop */
957
202M
    }
958
959
835
  out0:status = 0;
960
    /* falls through */
961
49.7M
  out:cfd_store_state();
962
49.7M
    ss->invert = invert;
963
    /* Ignore an error (missing EOFB/RTC when EndOfBlock == true) */
964
    /* if we have finished all rows. */
965
49.7M
    if (status == ERRC && ss->Rows > 0 && ss->row > ss->Rows)
966
20
        status = EOFC;
967
49.7M
    return status;
968
835
}
969
970
#if 1       /*************** */
971
static int
972
cf_decode_uncompressed(stream_CFD_state * ss, stream_cursor_read * pr)
973
7
{
974
7
    return ERRC;
975
7
}
976
#else /*************** */
977
978
/* Decode uncompressed data. */
979
/* (Not tested: no sample data available!) */
980
/****** DOESN'T CHECK FOR OVERFLOWING SCAN LINE ******/
981
static int
982
cf_decode_uncompressed(stream * s)
983
{
984
    cfd_declare_state;
985
    const cfd_node *np;
986
    int clen, rlen;
987
988
    cfd_load_state();
989
    while (1) {
990
        ensure_bits(cfd_uncompressed_initial_bits, NOOUT);
991
        np = &cf_uncompressed_decode[peek_bits(cfd_uncompressed_initial_bits)];
992
        clen = np->code_length;
993
        rlen = np->run_length;
994
        if (clen > cfd_uncompressed_initial_bits) { /* Must be an exit code. */
995
            break;
996
        }
997
        if (rlen == cfd_uncompressed_initial_bits) {  /* Longest representable white run */
998
            if_debug1m('W', s->memory, "[wu]%d\n", rlen);
999
            if ((qbit -= cfd_uncompressed_initial_bits) < 0)
1000
                qbit += 8, q++;
1001
        } else {
1002
            if_debug1m('W', s->memory, "[wu]%d+1\n", rlen);
1003
            if (qbit -= rlen < 0)
1004
                qbit += 8, q++;
1005
            *q ^= 1 << qbit;
1006
        }
1007
        skip_bits(clen);
1008
    }
1009
    clen -= cfd_uncompressed_initial_bits;
1010
    skip_bits(cfd_uncompressed_initial_bits);
1011
    ensure_bits(clen, NOOUT);
1012
    np = &cf_uncompressed_decode[rlen + peek_var_bits(clen)];
1013
    rlen = np->run_length;
1014
    skip_bits(np->code_length);
1015
    if_debug1m('w', s->memory, "[wu]exit %d\n", rlen);
1016
    if (rlen >= 0) {    /* Valid exit code, rlen = 2 * run length + next polarity */
1017
        if ((qbit -= rlen >> 1) < 0)
1018
            qbit += 8, q++;
1019
        rlen &= 1;
1020
    }
1021
  out:        /******* WRONG ******/
1022
    cfd_store_state();
1023
    return rlen;
1024
}
1025
1026
#endif /*************** */
1027
1028
/* Stream template */
1029
const stream_template s_CFD_template =
1030
{&st_CFD_state, s_CFD_init, s_CFD_process, 1, 1, s_CFD_release,
1031
 s_CFD_set_defaults
1032
};