Coverage Report

Created: 2026-09-14 06:44

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/work/libjpeg-turbo/src/jdapistd.c
Line
Count
Source
1
/*
2
 * jdapistd.c
3
 *
4
 * This file was part of the Independent JPEG Group's software:
5
 * Copyright (C) 1994-1996, Thomas G. Lane.
6
 * libjpeg-turbo Modifications:
7
 * Copyright (C) 2010, 2015-2020, 2022-2026, D. R. Commander.
8
 * Copyright (C) 2015, Google, Inc.
9
 * For conditions of distribution and use, see the accompanying README.ijg
10
 * file.
11
 *
12
 * This file contains application interface code for the decompression half
13
 * of the JPEG library.  These are the "standard" API routines that are
14
 * used in the normal full-decompression case.  They are not used by a
15
 * transcoding-only application.  Note that if an application links in
16
 * jpeg_start_decompress, it will end up linking in the entire decompressor.
17
 * We thus must separate this file from jdapimin.c to avoid linking the
18
 * whole decompression library into a transcoder.
19
 */
20
21
#include "jinclude.h"
22
#if BITS_IN_JSAMPLE != 16 || defined(D_LOSSLESS_SUPPORTED)
23
#include "jdmainct.h"
24
#include "jdcoefct.h"
25
#else
26
#define JPEG_INTERNALS
27
#include "jpeglib.h"
28
#endif
29
#include "jdmaster.h"
30
#include "jdmerge.h"
31
#include "jdsample.h"
32
#include "jmemsys.h"
33
#ifdef WITH_PROFILE
34
#include "tjutil.h"
35
#endif
36
37
#if BITS_IN_JSAMPLE == 8
38
39
/* Forward declarations */
40
LOCAL(boolean) output_pass_setup(j_decompress_ptr cinfo);
41
42
43
/*
44
 * Decompression initialization.
45
 * jpeg_read_header must be completed before calling this.
46
 *
47
 * If a multipass operating mode was selected, this will do all but the
48
 * last pass, and thus may take a great deal of time.
49
 *
50
 * Returns FALSE if suspended.  The return value need be inspected only if
51
 * a suspending data source is used.
52
 */
53
54
GLOBAL(boolean)
55
jpeg_start_decompress(j_decompress_ptr cinfo)
56
0
{
57
0
  if (cinfo->global_state == DSTATE_READY) {
58
    /* First call: initialize master control, select active modules */
59
0
    jinit_master_decompress(cinfo);
60
0
    if (cinfo->buffered_image) {
61
      /* No more work here; expecting jpeg_start_output next */
62
0
      cinfo->global_state = DSTATE_BUFIMAGE;
63
0
      return TRUE;
64
0
    }
65
0
    cinfo->global_state = DSTATE_PRELOAD;
66
0
  }
67
0
  if (cinfo->global_state == DSTATE_PRELOAD) {
68
    /* If file has multiple scans, absorb them all into the coef buffer */
69
0
    if (cinfo->inputctl->has_multiple_scans) {
70
0
#ifdef D_MULTISCAN_FILES_SUPPORTED
71
0
      for (;;) {
72
0
        int retcode;
73
        /* Call progress monitor hook if present */
74
0
        if (cinfo->progress != NULL)
75
0
          (*cinfo->progress->progress_monitor) ((j_common_ptr)cinfo);
76
        /* Absorb some more input */
77
0
        retcode = (*cinfo->inputctl->consume_input) (cinfo);
78
0
        if (retcode == JPEG_SUSPENDED)
79
0
          return FALSE;
80
0
        if (retcode == JPEG_REACHED_EOI)
81
0
          break;
82
        /* Advance progress counter if appropriate */
83
0
        if (cinfo->progress != NULL &&
84
0
            (retcode == JPEG_ROW_COMPLETED || retcode == JPEG_REACHED_SOS)) {
85
0
          if (++cinfo->progress->pass_counter >= cinfo->progress->pass_limit) {
86
            /* jdmaster underestimated number of scans; ratchet up one scan */
87
0
            cinfo->progress->pass_limit += (long)cinfo->total_iMCU_rows;
88
0
          }
89
0
        }
90
0
      }
91
#else
92
      ERREXIT(cinfo, JERR_NOT_COMPILED);
93
#endif /* D_MULTISCAN_FILES_SUPPORTED */
94
0
    }
95
0
    cinfo->output_scan_number = cinfo->input_scan_number;
96
0
  } else if (cinfo->global_state != DSTATE_PRESCAN)
97
0
    ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
98
  /* Perform any dummy output passes, and set up for the final pass */
99
0
  return output_pass_setup(cinfo);
100
0
}
101
102
103
/*
104
 * Set up for an output pass, and perform any dummy pass(es) needed.
105
 * Common subroutine for jpeg_start_decompress and jpeg_start_output.
106
 * Entry: global_state = DSTATE_PRESCAN only if previously suspended.
107
 * Exit: If done, returns TRUE and sets global_state for proper output mode.
108
 *       If suspended, returns FALSE and sets global_state = DSTATE_PRESCAN.
109
 */
110
111
LOCAL(boolean)
112
output_pass_setup(j_decompress_ptr cinfo)
113
0
{
114
0
  if (cinfo->global_state != DSTATE_PRESCAN) {
115
    /* First call: do pass setup */
116
0
    (*cinfo->master->prepare_for_output_pass) (cinfo);
117
0
    cinfo->output_scanline = 0;
118
0
    cinfo->global_state = DSTATE_PRESCAN;
119
0
  }
120
  /* Loop over any required dummy passes */
121
0
  while (cinfo->master->is_dummy_pass) {
122
0
#ifdef QUANT_2PASS_SUPPORTED
123
    /* Crank through the dummy pass */
124
0
    while (cinfo->output_scanline < cinfo->output_height) {
125
0
      JDIMENSION last_scanline;
126
      /* Call progress monitor hook if present */
127
0
      if (cinfo->progress != NULL) {
128
0
        cinfo->progress->pass_counter = (long)cinfo->output_scanline;
129
0
        cinfo->progress->pass_limit = (long)cinfo->output_height;
130
0
        (*cinfo->progress->progress_monitor) ((j_common_ptr)cinfo);
131
0
      }
132
      /* Process some data */
133
0
      last_scanline = cinfo->output_scanline;
134
0
      if (cinfo->data_precision <= 8) {
135
0
        if (cinfo->main->process_data == NULL)
136
0
          ERREXIT1(cinfo, JERR_BAD_PRECISION, cinfo->data_precision);
137
0
        (*cinfo->main->process_data) (cinfo, (JSAMPARRAY)NULL,
138
0
                                      &cinfo->output_scanline, (JDIMENSION)0);
139
0
      } else if (cinfo->data_precision <= 12) {
140
0
        if (cinfo->main->process_data_12 == NULL)
141
0
          ERREXIT1(cinfo, JERR_BAD_PRECISION, cinfo->data_precision);
142
0
        (*cinfo->main->process_data_12) (cinfo, (J12SAMPARRAY)NULL,
143
0
                                         &cinfo->output_scanline,
144
0
                                         (JDIMENSION)0);
145
0
      } else {
146
0
#ifdef D_LOSSLESS_SUPPORTED
147
0
        if (cinfo->main->process_data_16 == NULL)
148
0
          ERREXIT1(cinfo, JERR_BAD_PRECISION, cinfo->data_precision);
149
0
        (*cinfo->main->process_data_16) (cinfo, (J16SAMPARRAY)NULL,
150
0
                                         &cinfo->output_scanline,
151
0
                                         (JDIMENSION)0);
152
#else
153
        ERREXIT1(cinfo, JERR_BAD_PRECISION, cinfo->data_precision);
154
#endif
155
0
      }
156
0
      if (cinfo->output_scanline == last_scanline)
157
0
        return FALSE;           /* No progress made, must suspend */
158
0
    }
159
    /* Finish up dummy pass, and set up for another one */
160
0
    (*cinfo->master->finish_output_pass) (cinfo);
161
0
    (*cinfo->master->prepare_for_output_pass) (cinfo);
162
0
    cinfo->output_scanline = 0;
163
#else
164
    ERREXIT(cinfo, JERR_NOT_COMPILED);
165
#endif /* QUANT_2PASS_SUPPORTED */
166
0
  }
167
  /* Ready for application to drive output pass through
168
   * _jpeg_read_scanlines or _jpeg_read_raw_data.
169
   */
170
0
  cinfo->global_state = cinfo->raw_data_out ? DSTATE_RAW_OK : DSTATE_SCANNING;
171
0
  return TRUE;
172
0
}
173
174
#endif /* BITS_IN_JSAMPLE == 8 */
175
176
177
#if BITS_IN_JSAMPLE != 16
178
179
/*
180
 * Enable partial scanline decompression
181
 *
182
 * Must be called after jpeg_start_decompress() and before any calls to
183
 * _jpeg_read_scanlines() or _jpeg_skip_scanlines().
184
 *
185
 * Refer to libjpeg.txt for more information.
186
 */
187
188
GLOBAL(void)
189
_jpeg_crop_scanline(j_decompress_ptr cinfo, JDIMENSION *xoffset,
190
                    JDIMENSION *width)
191
0
{
192
0
  int ci, align, orig_downsampled_width;
193
0
  JDIMENSION input_xoffset;
194
0
  boolean reinit_upsampler = FALSE;
195
0
  jpeg_component_info *compptr;
196
0
#ifdef UPSAMPLE_MERGING_SUPPORTED
197
0
  my_master_ptr master = (my_master_ptr)cinfo->master;
198
0
#endif
199
200
0
  if (cinfo->data_precision != BITS_IN_JSAMPLE)
201
0
    ERREXIT1(cinfo, JERR_BAD_PRECISION, cinfo->data_precision);
202
203
0
  if (cinfo->master->lossless || cinfo->raw_data_out)
204
0
    ERREXIT(cinfo, JERR_NOTIMPL);
205
206
0
  if ((cinfo->global_state != DSTATE_SCANNING &&
207
0
       cinfo->global_state != DSTATE_BUFIMAGE) || cinfo->output_scanline != 0)
208
0
    ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
209
210
0
  if (!xoffset || !width)
211
0
    ERREXIT(cinfo, JERR_BAD_CROP_SPEC);
212
213
  /* xoffset and width must fall within the output image dimensions. */
214
0
  if (*width == 0 ||
215
0
      (unsigned long long)(*xoffset) + *width > cinfo->output_width)
216
0
    ERREXIT(cinfo, JERR_WIDTH_OVERFLOW);
217
218
  /* No need to do anything if the caller wants the entire width. */
219
0
  if (*width == cinfo->output_width)
220
0
    return;
221
222
  /* Ensuring the proper alignment of xoffset is tricky.  At minimum, it
223
   * must align with an MCU boundary, because:
224
   *
225
   *   (1) The IDCT is performed in blocks, and it is not feasible to modify
226
   *       the algorithm so that it can transform partial blocks.
227
   *   (2) Because of the SIMD extensions, any input buffer passed to the
228
   *       upsampling and color conversion routines must be aligned to the
229
   *       SIMD word size (for instance, 128-bit in the case of SSE2.)  The
230
   *       easiest way to accomplish this without copying data is to ensure
231
   *       that upsampling and color conversion begin at the start of the
232
   *       first MCU column that will be inverse transformed.
233
   *
234
   * In practice, we actually impose a stricter alignment requirement.  We
235
   * require that xoffset be a multiple of the maximum MCU column width of all
236
   * of the components (the "iMCU column width.")  This is to simplify the
237
   * single-pass decompression case, allowing us to use the same MCU column
238
   * width for all of the components.
239
   */
240
0
  if (cinfo->comps_in_scan == 1 && cinfo->num_components == 1)
241
0
    align = cinfo->_min_DCT_scaled_size;
242
0
  else
243
0
    align = cinfo->_min_DCT_scaled_size * cinfo->max_h_samp_factor;
244
245
  /* Adjust xoffset to the nearest iMCU boundary <= the requested value */
246
0
  input_xoffset = *xoffset;
247
0
  *xoffset = (input_xoffset / align) * align;
248
249
  /* Adjust the width so that the right edge of the output image is as
250
   * requested (only the left edge is altered.)  It is important that calling
251
   * programs check this value after this function returns, so that they can
252
   * allocate an output buffer with the appropriate size.
253
   */
254
0
  *width = *width + input_xoffset - *xoffset;
255
0
  cinfo->output_width = *width;
256
0
#ifdef UPSAMPLE_MERGING_SUPPORTED
257
0
  if (master->using_merged_upsample && cinfo->max_v_samp_factor == 2) {
258
0
    my_merged_upsample_ptr upsample = (my_merged_upsample_ptr)cinfo->upsample;
259
0
    upsample->out_row_width =
260
0
      cinfo->output_width * cinfo->out_color_components;
261
0
  }
262
0
#endif
263
264
  /* Set the first and last iMCU columns that we must decompress.  These values
265
   * will be used in single-scan decompressions.
266
   */
267
0
  cinfo->master->first_iMCU_col = (JDIMENSION)(long)(*xoffset) / (long)align;
268
0
  cinfo->master->last_iMCU_col =
269
0
    (JDIMENSION)jdiv_round_up((long)(*xoffset + cinfo->output_width),
270
0
                              (long)align) - 1;
271
272
0
  for (ci = 0, compptr = cinfo->comp_info; ci < cinfo->num_components;
273
0
       ci++, compptr++) {
274
0
    int hsf = (cinfo->comps_in_scan == 1 && cinfo->num_components == 1) ?
275
0
              1 : compptr->h_samp_factor;
276
277
    /* Set downsampled_width to the new output width. */
278
0
    orig_downsampled_width = compptr->downsampled_width;
279
0
    compptr->downsampled_width =
280
0
      (JDIMENSION)jdiv_round_up((long)cinfo->output_width *
281
0
                                (long)(compptr->h_samp_factor *
282
0
                                       compptr->_DCT_scaled_size),
283
0
                                (long)(cinfo->max_h_samp_factor *
284
0
                                       cinfo->_min_DCT_scaled_size));
285
0
    if (compptr->downsampled_width < 2 &&
286
0
#ifdef UPSAMPLE_MERGING_SUPPORTED
287
0
        !master->using_merged_upsample &&
288
0
#endif
289
0
        orig_downsampled_width >= 2)
290
0
      reinit_upsampler = TRUE;
291
292
    /* Set the first and last iMCU columns that we must decompress.  These
293
     * values will be used in multi-scan decompressions.
294
     */
295
0
    cinfo->master->first_MCU_col[ci] =
296
0
      (JDIMENSION)(long)(*xoffset * hsf) / (long)align;
297
0
    cinfo->master->last_MCU_col[ci] =
298
0
      (JDIMENSION)jdiv_round_up((long)((*xoffset + cinfo->output_width) * hsf),
299
0
                                (long)align) - 1;
300
0
  }
301
302
0
  if (reinit_upsampler) {
303
0
    cinfo->master->jinit_upsampler_no_alloc = TRUE;
304
0
    _jinit_upsampler(cinfo);
305
0
    cinfo->master->jinit_upsampler_no_alloc = FALSE;
306
0
  }
307
0
}
308
309
#endif /* BITS_IN_JSAMPLE != 16 */
310
311
312
/*
313
 * Read some scanlines of data from the JPEG decompressor.
314
 *
315
 * The return value will be the number of lines actually read.
316
 * This may be less than the number requested in several cases,
317
 * including bottom of image, data source suspension, and operating
318
 * modes that emit multiple scanlines at a time.
319
 *
320
 * Note: we warn about excess calls to _jpeg_read_scanlines() since
321
 * this likely signals an application programmer error.  However,
322
 * an oversize buffer (max_lines > scanlines remaining) is not an error.
323
 */
324
325
GLOBAL(JDIMENSION)
326
_jpeg_read_scanlines(j_decompress_ptr cinfo, _JSAMPARRAY scanlines,
327
                     JDIMENSION max_lines)
328
0
{
329
0
#if BITS_IN_JSAMPLE != 16 || defined(D_LOSSLESS_SUPPORTED)
330
0
  JDIMENSION row_ctr;
331
332
0
#ifdef D_LOSSLESS_SUPPORTED
333
0
  if (cinfo->master->lossless) {
334
0
#if BITS_IN_JSAMPLE == 8
335
0
    if (cinfo->data_precision > BITS_IN_JSAMPLE || cinfo->data_precision < 2)
336
#else
337
    if (cinfo->data_precision > BITS_IN_JSAMPLE ||
338
        cinfo->data_precision < BITS_IN_JSAMPLE - 3)
339
#endif
340
0
      ERREXIT1(cinfo, JERR_BAD_PRECISION, cinfo->data_precision);
341
0
  } else
342
0
#endif
343
0
  {
344
0
    if (cinfo->data_precision != BITS_IN_JSAMPLE)
345
0
      ERREXIT1(cinfo, JERR_BAD_PRECISION, cinfo->data_precision);
346
0
  }
347
348
0
  if (cinfo->global_state != DSTATE_SCANNING)
349
0
    ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
350
0
  if (cinfo->output_scanline >= cinfo->output_height) {
351
0
    WARNMS(cinfo, JWRN_TOO_MUCH_DATA);
352
0
    return 0;
353
0
  }
354
355
  /* Call progress monitor hook if present */
356
0
  if (cinfo->progress != NULL) {
357
0
    cinfo->progress->pass_counter = (long)cinfo->output_scanline;
358
0
    cinfo->progress->pass_limit = (long)cinfo->output_height;
359
0
    (*cinfo->progress->progress_monitor) ((j_common_ptr)cinfo);
360
0
  }
361
362
  /* Process some data */
363
0
  row_ctr = 0;
364
0
  if (cinfo->main->_process_data == NULL)
365
0
    ERREXIT1(cinfo, JERR_BAD_PRECISION, cinfo->data_precision);
366
0
  (*cinfo->main->_process_data) (cinfo, scanlines, &row_ctr, max_lines);
367
0
  cinfo->output_scanline += row_ctr;
368
0
  return row_ctr;
369
#else
370
  ERREXIT1(cinfo, JERR_BAD_PRECISION, cinfo->data_precision);
371
  return 0;
372
#endif
373
0
}
374
375
376
#if BITS_IN_JSAMPLE != 16
377
378
/* Dummy color convert function used by _jpeg_skip_scanlines() */
379
LOCAL(void)
380
noop_convert(j_decompress_ptr cinfo, _JSAMPIMAGE input_buf,
381
             JDIMENSION input_row, _JSAMPARRAY output_buf, int num_rows)
382
0
{
383
0
}
384
385
386
/* Dummy quantize function used by _jpeg_skip_scanlines() */
387
LOCAL(void)
388
noop_quantize(j_decompress_ptr cinfo, _JSAMPARRAY input_buf,
389
              _JSAMPARRAY output_buf, int num_rows)
390
0
{
391
0
}
392
393
394
/*
395
 * In some cases, it is best to call _jpeg_read_scanlines() and discard the
396
 * output, rather than skipping the scanlines, because this allows us to
397
 * maintain the internal state of the context-based upsampler.  In these cases,
398
 * we set up and tear down a dummy color converter in order to avoid valgrind
399
 * errors and to achieve the best possible performance.
400
 */
401
402
LOCAL(void)
403
read_and_discard_scanlines(j_decompress_ptr cinfo, JDIMENSION num_lines)
404
0
{
405
0
  JDIMENSION n;
406
0
#ifdef UPSAMPLE_MERGING_SUPPORTED
407
0
  my_master_ptr master = (my_master_ptr)cinfo->master;
408
0
#endif
409
0
  _JSAMPLE dummy_sample[1] = { 0 };
410
0
  _JSAMPROW dummy_row = dummy_sample;
411
0
  _JSAMPARRAY scanlines = NULL;
412
0
  void (*color_convert) (j_decompress_ptr cinfo, _JSAMPIMAGE input_buf,
413
0
                         JDIMENSION input_row, _JSAMPARRAY output_buf,
414
0
                         int num_rows) = NULL;
415
0
  void (*color_quantize) (j_decompress_ptr cinfo, _JSAMPARRAY input_buf,
416
0
                          _JSAMPARRAY output_buf, int num_rows) = NULL;
417
418
0
  if (cinfo->cconvert &&
419
0
#ifdef UPSAMPLE_MERGING_SUPPORTED
420
0
      !master->using_merged_upsample &&
421
0
#endif
422
0
      cinfo->cconvert->_color_convert) {
423
0
    color_convert = cinfo->cconvert->_color_convert;
424
0
    cinfo->cconvert->_color_convert = noop_convert;
425
    /* This just prevents UBSan from complaining about adding 0 to a NULL
426
     * pointer.  The pointer isn't actually used.
427
     */
428
0
    scanlines = &dummy_row;
429
0
  }
430
431
0
  if (cinfo->quantize_colors && cinfo->cquantize &&
432
0
      cinfo->cquantize->_color_quantize) {
433
0
    color_quantize = cinfo->cquantize->_color_quantize;
434
0
    cinfo->cquantize->_color_quantize = noop_quantize;
435
0
  }
436
437
0
#ifdef UPSAMPLE_MERGING_SUPPORTED
438
0
  if (master->using_merged_upsample && cinfo->max_v_samp_factor == 2) {
439
0
    my_merged_upsample_ptr upsample = (my_merged_upsample_ptr)cinfo->upsample;
440
0
    scanlines = &upsample->spare_row;
441
0
  }
442
0
#endif
443
444
0
  for (n = 0; n < num_lines; n++)
445
0
    _jpeg_read_scanlines(cinfo, scanlines, 1);
446
447
0
  if (color_convert)
448
0
    cinfo->cconvert->_color_convert = color_convert;
449
450
0
  if (color_quantize)
451
0
    cinfo->cquantize->_color_quantize = color_quantize;
452
0
}
453
454
455
/*
456
 * Called by _jpeg_skip_scanlines().  This partially skips a decompress block
457
 * by incrementing the rowgroup counter.
458
 */
459
460
LOCAL(void)
461
increment_simple_rowgroup_ctr(j_decompress_ptr cinfo, JDIMENSION rows)
462
0
{
463
0
  JDIMENSION rows_left;
464
0
  my_main_ptr main_ptr = (my_main_ptr)cinfo->main;
465
466
0
  if (!cinfo->upsample->need_context_rows && cinfo->max_v_samp_factor != 1) {
467
0
    read_and_discard_scanlines(cinfo, rows);
468
0
    return;
469
0
  }
470
471
  /* Increment the counter to the next row group after the skipped rows. */
472
0
  main_ptr->rowgroup_ctr += rows / cinfo->max_v_samp_factor;
473
474
  /* Partially skipping a row group would involve modifying the internal state
475
   * of the upsampler, so read the remaining rows into a dummy buffer instead.
476
   */
477
0
  rows_left = rows % cinfo->max_v_samp_factor;
478
0
  cinfo->output_scanline += rows - rows_left;
479
480
0
  read_and_discard_scanlines(cinfo, rows_left);
481
0
}
482
483
/*
484
 * Skips some scanlines of data from the JPEG decompressor.
485
 *
486
 * The return value will be the number of lines actually skipped.  If skipping
487
 * num_lines would move beyond the end of the image, then the actual number of
488
 * lines remaining in the image is returned.  Otherwise, the return value will
489
 * be equal to num_lines.
490
 *
491
 * Refer to libjpeg.txt for more information.
492
 */
493
494
GLOBAL(JDIMENSION)
495
_jpeg_skip_scanlines(j_decompress_ptr cinfo, JDIMENSION num_lines)
496
0
{
497
0
  my_main_ptr main_ptr = (my_main_ptr)cinfo->main;
498
0
  my_coef_ptr coef = (my_coef_ptr)cinfo->coef;
499
0
  my_master_ptr master = (my_master_ptr)cinfo->master;
500
0
  JDIMENSION i, x;
501
0
  int y;
502
0
  JDIMENSION lines_per_iMCU_row, lines_left_in_iMCU_row, lines_after_iMCU_row;
503
0
  JDIMENSION lines_to_skip, lines_to_read;
504
505
0
  if (cinfo->data_precision != BITS_IN_JSAMPLE)
506
0
    ERREXIT1(cinfo, JERR_BAD_PRECISION, cinfo->data_precision);
507
508
0
  if (cinfo->master->lossless)
509
0
    ERREXIT(cinfo, JERR_NOTIMPL);
510
511
  /* Two-pass color quantization is not supported. */
512
0
  if (cinfo->quantize_colors && cinfo->two_pass_quantize)
513
0
    ERREXIT(cinfo, JERR_NOTIMPL);
514
515
0
  if (cinfo->global_state != DSTATE_SCANNING)
516
0
    ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
517
518
  /* Do not skip past the bottom of the image. */
519
0
  if ((unsigned long long)cinfo->output_scanline + num_lines >=
520
0
      cinfo->output_height) {
521
0
    num_lines = cinfo->output_height - cinfo->output_scanline;
522
0
    cinfo->output_scanline = cinfo->output_height;
523
0
    (*cinfo->inputctl->finish_input_pass) (cinfo);
524
0
    cinfo->inputctl->eoi_reached = TRUE;
525
0
    return num_lines;
526
0
  }
527
528
0
  if (num_lines == 0)
529
0
    return 0;
530
531
0
  lines_per_iMCU_row = cinfo->_min_DCT_scaled_size * cinfo->max_v_samp_factor;
532
0
  lines_left_in_iMCU_row =
533
0
    (lines_per_iMCU_row - (cinfo->output_scanline % lines_per_iMCU_row)) %
534
0
    lines_per_iMCU_row;
535
0
  lines_after_iMCU_row = num_lines - lines_left_in_iMCU_row;
536
537
  /* Skip the lines remaining in the current iMCU row.  When upsampling
538
   * requires context rows, we need the previous and next rows in order to read
539
   * the current row.  This adds some complexity.
540
   */
541
0
  if (cinfo->upsample->need_context_rows) {
542
    /* If the skipped lines would not move us past the current iMCU row, we
543
     * read the lines and ignore them.  There might be a faster way of doing
544
     * this, but we are facing increasing complexity for diminishing returns.
545
     * The increasing complexity would be a by-product of meddling with the
546
     * state machine used to skip context rows.  Near the end of an iMCU row,
547
     * the next iMCU row may have already been entropy-decoded.  In this unique
548
     * case, we will read the next iMCU row if we cannot skip past it as well.
549
     */
550
0
    if ((num_lines < lines_left_in_iMCU_row + 1) ||
551
0
        (lines_left_in_iMCU_row <= 1 && main_ptr->buffer_full &&
552
0
         lines_after_iMCU_row < lines_per_iMCU_row + 1)) {
553
0
      read_and_discard_scanlines(cinfo, num_lines);
554
0
      return num_lines;
555
0
    }
556
557
    /* If the next iMCU row has already been entropy-decoded, make sure that
558
     * we do not skip too far.
559
     */
560
0
    if (lines_left_in_iMCU_row <= 1 && main_ptr->buffer_full) {
561
0
      cinfo->output_scanline += lines_left_in_iMCU_row + lines_per_iMCU_row;
562
0
      lines_after_iMCU_row -= lines_per_iMCU_row;
563
0
    } else {
564
0
      cinfo->output_scanline += lines_left_in_iMCU_row;
565
0
    }
566
567
    /* If we have just completed the first block, adjust the buffer pointers */
568
0
    if (main_ptr->iMCU_row_ctr == 0 ||
569
0
        (main_ptr->iMCU_row_ctr == 1 && lines_left_in_iMCU_row > 2))
570
0
      set_wraparound_pointers(cinfo);
571
0
    main_ptr->buffer_full = FALSE;
572
0
    main_ptr->rowgroup_ctr = 0;
573
0
    main_ptr->context_state = CTX_PREPARE_FOR_IMCU;
574
0
    if (!master->using_merged_upsample) {
575
0
      my_upsample_ptr upsample = (my_upsample_ptr)cinfo->upsample;
576
0
      upsample->next_row_out = cinfo->max_v_samp_factor;
577
0
      upsample->rows_to_go = cinfo->output_height - cinfo->output_scanline;
578
0
    }
579
0
  }
580
581
  /* Skipping is much simpler when context rows are not required. */
582
0
  else {
583
0
    if (num_lines < lines_left_in_iMCU_row) {
584
0
      increment_simple_rowgroup_ctr(cinfo, num_lines);
585
0
      return num_lines;
586
0
    } else {
587
0
      cinfo->output_scanline += lines_left_in_iMCU_row;
588
0
      main_ptr->buffer_full = FALSE;
589
0
      main_ptr->rowgroup_ctr = 0;
590
0
#ifdef UPSAMPLE_MERGING_SUPPORTED
591
0
      if (master->using_merged_upsample) {
592
0
        my_merged_upsample_ptr upsample =
593
0
          (my_merged_upsample_ptr)cinfo->upsample;
594
0
        upsample->spare_full = FALSE;
595
0
      } else
596
0
#endif
597
0
      {
598
0
        my_upsample_ptr upsample = (my_upsample_ptr)cinfo->upsample;
599
0
        upsample->next_row_out = cinfo->max_v_samp_factor;
600
0
        upsample->rows_to_go = cinfo->output_height - cinfo->output_scanline;
601
0
      }
602
0
    }
603
0
  }
604
605
  /* Calculate how many full iMCU rows we can skip. */
606
0
  if (cinfo->upsample->need_context_rows)
607
0
    lines_to_skip = ((lines_after_iMCU_row - 1) / lines_per_iMCU_row) *
608
0
                    lines_per_iMCU_row;
609
0
  else
610
0
    lines_to_skip = (lines_after_iMCU_row / lines_per_iMCU_row) *
611
0
                    lines_per_iMCU_row;
612
  /* Calculate the number of lines that remain to be skipped after skipping all
613
   * of the full iMCU rows that we can.  We will not read these lines unless we
614
   * have to.
615
   */
616
0
  lines_to_read = lines_after_iMCU_row - lines_to_skip;
617
618
  /* For images requiring multiple scans (progressive, non-interleaved, etc.),
619
   * all of the entropy decoding occurs in jpeg_start_decompress(), assuming
620
   * that the input data source is non-suspending.  This makes skipping easy.
621
   */
622
0
  if (cinfo->inputctl->has_multiple_scans || cinfo->buffered_image) {
623
0
    if (cinfo->upsample->need_context_rows) {
624
0
      cinfo->output_scanline += lines_to_skip;
625
0
      cinfo->output_iMCU_row += lines_to_skip / lines_per_iMCU_row;
626
0
      main_ptr->iMCU_row_ctr += lines_to_skip / lines_per_iMCU_row;
627
      /* It is complex to properly move to the middle of a context block, so
628
       * read the remaining lines instead of skipping them.
629
       */
630
0
      read_and_discard_scanlines(cinfo, lines_to_read);
631
0
    } else {
632
0
      cinfo->output_scanline += lines_to_skip;
633
0
      cinfo->output_iMCU_row += lines_to_skip / lines_per_iMCU_row;
634
0
      increment_simple_rowgroup_ctr(cinfo, lines_to_read);
635
0
    }
636
0
#ifdef UPSAMPLE_MERGING_SUPPORTED
637
0
    if (master->using_merged_upsample) {
638
0
      my_merged_upsample_ptr upsample =
639
0
        (my_merged_upsample_ptr)cinfo->upsample;
640
0
      upsample->rows_to_go = cinfo->output_height - cinfo->output_scanline;
641
0
    } else
642
0
#endif
643
0
    {
644
0
      my_upsample_ptr upsample = (my_upsample_ptr)cinfo->upsample;
645
0
      upsample->rows_to_go = cinfo->output_height - cinfo->output_scanline;
646
0
    }
647
0
    return num_lines;
648
0
  }
649
650
  /* Skip the iMCU rows that we can safely skip. */
651
0
  for (i = 0; i < lines_to_skip; i += lines_per_iMCU_row) {
652
0
    for (y = 0; y < coef->MCU_rows_per_iMCU_row; y++) {
653
0
      for (x = 0; x < cinfo->MCUs_per_row; x++) {
654
        /* Calling decode_mcu() with a NULL pointer causes it to discard the
655
         * decoded coefficients.  This is ~5% faster for large subsets, but
656
         * it's tough to tell a difference for smaller images.
657
         */
658
0
        if (!cinfo->entropy->insufficient_data)
659
0
          cinfo->master->last_good_iMCU_row = cinfo->input_iMCU_row;
660
#ifdef WITH_PROFILE
661
        cinfo->master->start = getTime();
662
#endif
663
0
        (*cinfo->entropy->decode_mcu) (cinfo, NULL);
664
#ifdef WITH_PROFILE
665
        cinfo->master->entropy_elapsed += getTime() - cinfo->master->start;
666
        cinfo->master->entropy_mcoeffs +=
667
          (double)cinfo->blocks_in_MCU * DCTSIZE2 / 1000000.;
668
#endif
669
0
      }
670
0
    }
671
0
    cinfo->input_iMCU_row++;
672
0
    cinfo->output_iMCU_row++;
673
0
    if (cinfo->input_iMCU_row < cinfo->total_iMCU_rows)
674
0
      start_iMCU_row(cinfo);
675
0
    else
676
0
      (*cinfo->inputctl->finish_input_pass) (cinfo);
677
0
  }
678
0
  cinfo->output_scanline += lines_to_skip;
679
680
0
  if (cinfo->upsample->need_context_rows) {
681
    /* Context-based upsampling keeps track of iMCU rows. */
682
0
    main_ptr->iMCU_row_ctr += lines_to_skip / lines_per_iMCU_row;
683
684
    /* It is complex to properly move to the middle of a context block, so
685
     * read the remaining lines instead of skipping them.
686
     */
687
0
    read_and_discard_scanlines(cinfo, lines_to_read);
688
0
  } else {
689
0
    increment_simple_rowgroup_ctr(cinfo, lines_to_read);
690
0
  }
691
692
  /* Since skipping lines involves skipping the upsampling step, the value of
693
   * "rows_to_go" will become invalid unless we set it here.  NOTE: This is a
694
   * bit odd, since "rows_to_go" seems to be redundantly keeping track of
695
   * output_scanline.
696
   */
697
0
#ifdef UPSAMPLE_MERGING_SUPPORTED
698
0
  if (master->using_merged_upsample) {
699
0
    my_merged_upsample_ptr upsample = (my_merged_upsample_ptr)cinfo->upsample;
700
0
    upsample->rows_to_go = cinfo->output_height - cinfo->output_scanline;
701
0
  } else
702
0
#endif
703
0
  {
704
0
    my_upsample_ptr upsample = (my_upsample_ptr)cinfo->upsample;
705
0
    upsample->rows_to_go = cinfo->output_height - cinfo->output_scanline;
706
0
  }
707
708
  /* Always skip the requested number of lines. */
709
0
  return num_lines;
710
0
}
711
712
/*
713
 * Alternate entry point to read raw data.
714
 * Processes exactly one iMCU row per call, unless suspended.
715
 */
716
717
GLOBAL(JDIMENSION)
718
_jpeg_read_raw_data(j_decompress_ptr cinfo, _JSAMPIMAGE data,
719
                    JDIMENSION max_lines)
720
0
{
721
0
  JDIMENSION lines_per_iMCU_row;
722
723
0
  if (cinfo->data_precision != BITS_IN_JSAMPLE)
724
0
    ERREXIT1(cinfo, JERR_BAD_PRECISION, cinfo->data_precision);
725
726
0
  if (cinfo->master->lossless)
727
0
    ERREXIT(cinfo, JERR_NOTIMPL);
728
729
0
  if (cinfo->global_state != DSTATE_RAW_OK)
730
0
    ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
731
0
  if (cinfo->output_scanline >= cinfo->output_height) {
732
0
    WARNMS(cinfo, JWRN_TOO_MUCH_DATA);
733
0
    return 0;
734
0
  }
735
736
  /* Call progress monitor hook if present */
737
0
  if (cinfo->progress != NULL) {
738
0
    cinfo->progress->pass_counter = (long)cinfo->output_scanline;
739
0
    cinfo->progress->pass_limit = (long)cinfo->output_height;
740
0
    (*cinfo->progress->progress_monitor) ((j_common_ptr)cinfo);
741
0
  }
742
743
  /* Verify that at least one iMCU row can be returned. */
744
0
  lines_per_iMCU_row = cinfo->max_v_samp_factor * cinfo->_min_DCT_scaled_size;
745
0
  if (max_lines < lines_per_iMCU_row)
746
0
    ERREXIT(cinfo, JERR_BUFFER_SIZE);
747
748
  /* Decompress directly into user's buffer. */
749
0
  if (cinfo->coef->_decompress_data == NULL)
750
0
    ERREXIT1(cinfo, JERR_BAD_PRECISION, cinfo->data_precision);
751
0
  if (!(*cinfo->coef->_decompress_data) (cinfo, data))
752
0
    return 0;                   /* suspension forced, can do nothing more */
753
754
  /* OK, we processed one iMCU row. */
755
0
  cinfo->output_scanline += lines_per_iMCU_row;
756
0
  return lines_per_iMCU_row;
757
0
}
758
759
#endif /* BITS_IN_JSAMPLE != 16 */
760
761
762
#if BITS_IN_JSAMPLE == 8
763
764
/* Additional entry points for buffered-image mode. */
765
766
#ifdef D_MULTISCAN_FILES_SUPPORTED
767
768
/*
769
 * Initialize for an output pass in buffered-image mode.
770
 */
771
772
GLOBAL(boolean)
773
jpeg_start_output(j_decompress_ptr cinfo, int scan_number)
774
0
{
775
0
  if (cinfo->global_state != DSTATE_BUFIMAGE &&
776
0
      cinfo->global_state != DSTATE_PRESCAN)
777
0
    ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
778
  /* Limit scan number to valid range */
779
0
  if (scan_number <= 0)
780
0
    scan_number = 1;
781
0
  if (cinfo->inputctl->eoi_reached && scan_number > cinfo->input_scan_number)
782
0
    scan_number = cinfo->input_scan_number;
783
0
  cinfo->output_scan_number = scan_number;
784
  /* Perform any dummy output passes, and set up for the real pass */
785
0
  return output_pass_setup(cinfo);
786
0
}
787
788
789
/*
790
 * Finish up after an output pass in buffered-image mode.
791
 *
792
 * Returns FALSE if suspended.  The return value need be inspected only if
793
 * a suspending data source is used.
794
 */
795
796
GLOBAL(boolean)
797
jpeg_finish_output(j_decompress_ptr cinfo)
798
0
{
799
0
  if ((cinfo->global_state == DSTATE_SCANNING ||
800
0
       cinfo->global_state == DSTATE_RAW_OK) && cinfo->buffered_image) {
801
    /* Terminate this pass. */
802
    /* We do not require the whole pass to have been completed. */
803
0
    (*cinfo->master->finish_output_pass) (cinfo);
804
0
    cinfo->global_state = DSTATE_BUFPOST;
805
0
  } else if (cinfo->global_state != DSTATE_BUFPOST) {
806
    /* BUFPOST = repeat call after a suspension, anything else is error */
807
0
    ERREXIT1(cinfo, JERR_BAD_STATE, cinfo->global_state);
808
0
  }
809
  /* Read markers looking for SOS or EOI */
810
0
  while (cinfo->input_scan_number <= cinfo->output_scan_number &&
811
0
         !cinfo->inputctl->eoi_reached) {
812
0
    if ((*cinfo->inputctl->consume_input) (cinfo) == JPEG_SUSPENDED)
813
0
      return FALSE;             /* Suspend, come back later */
814
0
  }
815
0
  cinfo->global_state = DSTATE_BUFIMAGE;
816
0
  return TRUE;
817
0
}
818
819
#endif /* D_MULTISCAN_FILES_SUPPORTED */
820
821
#endif /* BITS_IN_JSAMPLE == 8 */