blob: b821710ac308ffc7758e97104ad84451729ef9bc [file] [log] [blame]
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +00001/*
2 * jcmaster.c
3 *
DRCa73e8702012-12-31 02:52:30 +00004 * This file was part of the Independent JPEG Group's software:
Thomas G. Lane5ead57a1998-03-27 00:00:00 +00005 * Copyright (C) 1991-1997, Thomas G. Lane.
Guido Vollbeding989630f2010-01-10 00:00:00 +00006 * Modified 2003-2010 by Guido Vollbeding.
DRCa6ef2822013-09-28 03:23:49 +00007 * libjpeg-turbo Modifications:
DRCa6289522018-07-24 18:36:51 -05008 * Copyright (C) 2010, 2016, 2018, D. R. Commander.
DRC7e3acc02015-10-10 10:25:46 -05009 * For conditions of distribution and use, see the accompanying README.ijg
10 * file.
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +000011 *
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000012 * This file contains master control logic for the JPEG compressor.
Thomas G. Lanebc79e061995-08-02 00:00:00 +000013 * These routines are concerned with parameter validation, initial setup,
DRCe5eaf372014-05-09 18:00:32 +000014 * and inter-pass control (determining the number of passes and the work
Thomas G. Lanebc79e061995-08-02 00:00:00 +000015 * to be done in each pass).
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +000016 */
17
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000018#define JPEG_INTERNALS
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +000019#include "jinclude.h"
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000020#include "jpeglib.h"
DRCc04bd3c2010-10-10 02:15:56 +000021#include "jpegcomp.h"
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +000022
23
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000024/* Private state */
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +000025
Thomas G. Lanebc79e061995-08-02 00:00:00 +000026typedef enum {
DRC19c791c2018-03-08 10:55:20 -060027 main_pass, /* input data, also do first output step */
28 huff_opt_pass, /* Huffman code optimization pass */
29 output_pass /* data output pass */
Thomas G. Lanebc79e061995-08-02 00:00:00 +000030} c_pass_type;
31
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000032typedef struct {
DRCe5eaf372014-05-09 18:00:32 +000033 struct jpeg_comp_master pub; /* public fields */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000034
DRCe5eaf372014-05-09 18:00:32 +000035 c_pass_type pass_type; /* the type of the current pass */
Thomas G. Lanebc79e061995-08-02 00:00:00 +000036
DRCe5eaf372014-05-09 18:00:32 +000037 int pass_number; /* # of passes completed */
38 int total_passes; /* total # of passes needed */
Thomas G. Lanebc79e061995-08-02 00:00:00 +000039
DRCe5eaf372014-05-09 18:00:32 +000040 int scan_number; /* current index in scan_info[] */
DRC6f241d42016-03-16 07:10:35 -050041
42 /*
43 * This is here so we can add libjpeg-turbo version/build information to the
44 * global string table without introducing a new global symbol. Adding this
45 * information to the global string table allows one to examine a binary
46 * object and determine which version of libjpeg-turbo it was built from or
47 * linked against.
48 */
49 const char *jpeg_version;
50
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000051} my_comp_master;
52
DRCbd498032016-02-19 08:53:33 -060053typedef my_comp_master *my_master_ptr;
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000054
55
56/*
57 * Support routines that do various essential calculations.
58 */
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +000059
DRC36a6eec2010-10-08 08:05:44 +000060#if JPEG_LIB_VERSION >= 70
Guido Vollbeding5996a252009-06-27 00:00:00 +000061/*
62 * Compute JPEG image dimensions and related values.
63 * NOTE: this is exported for possible use by application.
64 * Hence it mustn't do anything that can't be done twice.
65 */
66
67GLOBAL(void)
DRC19c791c2018-03-08 10:55:20 -060068jpeg_calc_jpeg_dimensions(j_compress_ptr cinfo)
Guido Vollbeding5996a252009-06-27 00:00:00 +000069/* Do computations that are needed before master selection phase */
70{
Guido Vollbeding5996a252009-06-27 00:00:00 +000071 /* Hardwire it to "no scaling" */
72 cinfo->jpeg_width = cinfo->image_width;
73 cinfo->jpeg_height = cinfo->image_height;
74 cinfo->min_DCT_h_scaled_size = DCTSIZE;
75 cinfo->min_DCT_v_scaled_size = DCTSIZE;
Guido Vollbeding5996a252009-06-27 00:00:00 +000076}
DRC36a6eec2010-10-08 08:05:44 +000077#endif
Guido Vollbeding5996a252009-06-27 00:00:00 +000078
79
Thomas G. Lane489583f1996-02-07 00:00:00 +000080LOCAL(void)
DRC19c791c2018-03-08 10:55:20 -060081initial_setup(j_compress_ptr cinfo, boolean transcode_only)
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000082/* Do computations that are needed before master selection phase */
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +000083{
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000084 int ci;
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +000085 jpeg_component_info *compptr;
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000086 long samplesperrow;
87 JDIMENSION jd_samplesperrow;
88
DRC36a6eec2010-10-08 08:05:44 +000089#if JPEG_LIB_VERSION >= 70
DRCe7fde872011-04-03 07:09:49 +000090#if JPEG_LIB_VERSION >= 80
DRCc04bd3c2010-10-10 02:15:56 +000091 if (!transcode_only)
DRCe7fde872011-04-03 07:09:49 +000092#endif
Guido Vollbeding989630f2010-01-10 00:00:00 +000093 jpeg_calc_jpeg_dimensions(cinfo);
DRC36a6eec2010-10-08 08:05:44 +000094#endif
Guido Vollbeding5996a252009-06-27 00:00:00 +000095
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000096 /* Sanity check on image dimensions */
DRC19c791c2018-03-08 10:55:20 -060097 if (cinfo->_jpeg_height <= 0 || cinfo->_jpeg_width <= 0 ||
98 cinfo->num_components <= 0 || cinfo->input_components <= 0)
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000099 ERREXIT(cinfo, JERR_EMPTY_IMAGE);
100
101 /* Make sure image isn't bigger than I can handle */
DRC19c791c2018-03-08 10:55:20 -0600102 if ((long)cinfo->_jpeg_height > (long)JPEG_MAX_DIMENSION ||
103 (long)cinfo->_jpeg_width > (long)JPEG_MAX_DIMENSION)
104 ERREXIT1(cinfo, JERR_IMAGE_TOO_BIG, (unsigned int)JPEG_MAX_DIMENSION);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000105
106 /* Width of an input scanline must be representable as JDIMENSION. */
DRC19c791c2018-03-08 10:55:20 -0600107 samplesperrow = (long)cinfo->image_width * (long)cinfo->input_components;
108 jd_samplesperrow = (JDIMENSION)samplesperrow;
109 if ((long)jd_samplesperrow != samplesperrow)
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000110 ERREXIT(cinfo, JERR_WIDTH_OVERFLOW);
111
112 /* For now, precision must match compiled-in value... */
113 if (cinfo->data_precision != BITS_IN_JSAMPLE)
114 ERREXIT1(cinfo, JERR_BAD_PRECISION, cinfo->data_precision);
115
116 /* Check that number of components won't exceed internal array sizes */
117 if (cinfo->num_components > MAX_COMPONENTS)
118 ERREXIT2(cinfo, JERR_COMPONENT_COUNT, cinfo->num_components,
DRCe5eaf372014-05-09 18:00:32 +0000119 MAX_COMPONENTS);
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +0000120
121 /* Compute maximum sampling factors; check factor validity */
122 cinfo->max_h_samp_factor = 1;
123 cinfo->max_v_samp_factor = 1;
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000124 for (ci = 0, compptr = cinfo->comp_info; ci < cinfo->num_components;
125 ci++, compptr++) {
DRC19c791c2018-03-08 10:55:20 -0600126 if (compptr->h_samp_factor <= 0 ||
127 compptr->h_samp_factor > MAX_SAMP_FACTOR ||
128 compptr->v_samp_factor <= 0 ||
129 compptr->v_samp_factor > MAX_SAMP_FACTOR)
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000130 ERREXIT(cinfo, JERR_BAD_SAMPLING);
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +0000131 cinfo->max_h_samp_factor = MAX(cinfo->max_h_samp_factor,
DRCe5eaf372014-05-09 18:00:32 +0000132 compptr->h_samp_factor);
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +0000133 cinfo->max_v_samp_factor = MAX(cinfo->max_v_samp_factor,
DRCe5eaf372014-05-09 18:00:32 +0000134 compptr->v_samp_factor);
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +0000135 }
136
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000137 /* Compute dimensions of components */
138 for (ci = 0, compptr = cinfo->comp_info; ci < cinfo->num_components;
139 ci++, compptr++) {
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000140 /* Fill in the correct component_index value; don't rely on application */
141 compptr->component_index = ci;
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000142 /* For compression, we never do DCT scaling. */
DRC36a6eec2010-10-08 08:05:44 +0000143#if JPEG_LIB_VERSION >= 70
144 compptr->DCT_h_scaled_size = compptr->DCT_v_scaled_size = DCTSIZE;
145#else
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000146 compptr->DCT_scaled_size = DCTSIZE;
Guido Vollbeding5996a252009-06-27 00:00:00 +0000147#endif
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000148 /* Size in DCT blocks */
149 compptr->width_in_blocks = (JDIMENSION)
DRC19c791c2018-03-08 10:55:20 -0600150 jdiv_round_up((long)cinfo->_jpeg_width * (long)compptr->h_samp_factor,
151 (long)(cinfo->max_h_samp_factor * DCTSIZE));
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000152 compptr->height_in_blocks = (JDIMENSION)
DRC19c791c2018-03-08 10:55:20 -0600153 jdiv_round_up((long)cinfo->_jpeg_height * (long)compptr->v_samp_factor,
154 (long)(cinfo->max_v_samp_factor * DCTSIZE));
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000155 /* Size in samples */
156 compptr->downsampled_width = (JDIMENSION)
DRC19c791c2018-03-08 10:55:20 -0600157 jdiv_round_up((long)cinfo->_jpeg_width * (long)compptr->h_samp_factor,
158 (long)cinfo->max_h_samp_factor);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000159 compptr->downsampled_height = (JDIMENSION)
DRC19c791c2018-03-08 10:55:20 -0600160 jdiv_round_up((long)cinfo->_jpeg_height * (long)compptr->v_samp_factor,
161 (long)cinfo->max_v_samp_factor);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000162 /* Mark component needed (this flag isn't actually used for compression) */
163 compptr->component_needed = TRUE;
164 }
165
166 /* Compute number of fully interleaved MCU rows (number of times that
167 * main controller will call coefficient controller).
168 */
169 cinfo->total_iMCU_rows = (JDIMENSION)
DRC19c791c2018-03-08 10:55:20 -0600170 jdiv_round_up((long)cinfo->_jpeg_height,
171 (long)(cinfo->max_v_samp_factor * DCTSIZE));
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000172}
173
174
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000175#ifdef C_MULTISCAN_FILES_SUPPORTED
176
Thomas G. Lane489583f1996-02-07 00:00:00 +0000177LOCAL(void)
DRC19c791c2018-03-08 10:55:20 -0600178validate_script(j_compress_ptr cinfo)
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000179/* Verify that the scan script in cinfo->scan_info[] is valid; also
180 * determine whether it uses progressive JPEG, and set cinfo->progressive_mode.
181 */
182{
DRCbd498032016-02-19 08:53:33 -0600183 const jpeg_scan_info *scanptr;
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000184 int scanno, ncomps, ci, coefi, thisi;
185 int Ss, Se, Ah, Al;
186 boolean component_sent[MAX_COMPONENTS];
187#ifdef C_PROGRESSIVE_SUPPORTED
DRCbd498032016-02-19 08:53:33 -0600188 int *last_bitpos_ptr;
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000189 int last_bitpos[MAX_COMPONENTS][DCTSIZE2];
190 /* -1 until that coefficient has been seen; then last Al for it */
191#endif
192
193 if (cinfo->num_scans <= 0)
194 ERREXIT1(cinfo, JERR_BAD_SCAN_SCRIPT, 0);
195
196 /* For sequential JPEG, all scans must have Ss=0, Se=DCTSIZE2-1;
197 * for progressive JPEG, no scan can have this.
198 */
199 scanptr = cinfo->scan_info;
DRC19c791c2018-03-08 10:55:20 -0600200 if (scanptr->Ss != 0 || scanptr->Se != DCTSIZE2 - 1) {
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000201#ifdef C_PROGRESSIVE_SUPPORTED
202 cinfo->progressive_mode = TRUE;
DRC19c791c2018-03-08 10:55:20 -0600203 last_bitpos_ptr = &last_bitpos[0][0];
DRCe5eaf372014-05-09 18:00:32 +0000204 for (ci = 0; ci < cinfo->num_components; ci++)
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000205 for (coefi = 0; coefi < DCTSIZE2; coefi++)
DRCe5eaf372014-05-09 18:00:32 +0000206 *last_bitpos_ptr++ = -1;
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000207#else
208 ERREXIT(cinfo, JERR_NOT_COMPILED);
209#endif
210 } else {
211 cinfo->progressive_mode = FALSE;
DRCe5eaf372014-05-09 18:00:32 +0000212 for (ci = 0; ci < cinfo->num_components; ci++)
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000213 component_sent[ci] = FALSE;
214 }
215
216 for (scanno = 1; scanno <= cinfo->num_scans; scanptr++, scanno++) {
217 /* Validate component indexes */
218 ncomps = scanptr->comps_in_scan;
219 if (ncomps <= 0 || ncomps > MAX_COMPS_IN_SCAN)
220 ERREXIT2(cinfo, JERR_COMPONENT_COUNT, ncomps, MAX_COMPS_IN_SCAN);
221 for (ci = 0; ci < ncomps; ci++) {
222 thisi = scanptr->component_index[ci];
223 if (thisi < 0 || thisi >= cinfo->num_components)
DRCe5eaf372014-05-09 18:00:32 +0000224 ERREXIT1(cinfo, JERR_BAD_SCAN_SCRIPT, scanno);
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000225 /* Components must appear in SOF order within each scan */
DRC19c791c2018-03-08 10:55:20 -0600226 if (ci > 0 && thisi <= scanptr->component_index[ci - 1])
DRCe5eaf372014-05-09 18:00:32 +0000227 ERREXIT1(cinfo, JERR_BAD_SCAN_SCRIPT, scanno);
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000228 }
229 /* Validate progression parameters */
230 Ss = scanptr->Ss;
231 Se = scanptr->Se;
232 Ah = scanptr->Ah;
233 Al = scanptr->Al;
234 if (cinfo->progressive_mode) {
235#ifdef C_PROGRESSIVE_SUPPORTED
DRCa6289522018-07-24 18:36:51 -0500236 /* Rec. ITU-T T.81 | ISO/IEC 10918-1 simply gives the ranges 0..13 for Ah
237 * and Al, but that seems wrong: the upper bound ought to depend on data
238 * precision. Perhaps they really meant 0..N+1 for N-bit precision.
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000239 * Here we allow 0..10 for 8-bit data; Al larger than 10 results in
240 * out-of-range reconstructed DC values during the first DC scan,
241 * which might cause problems for some decoders.
242 */
243#if BITS_IN_JSAMPLE == 8
DRC293263c2018-03-17 15:14:35 -0500244#define MAX_AH_AL 10
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000245#else
DRC293263c2018-03-17 15:14:35 -0500246#define MAX_AH_AL 13
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000247#endif
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000248 if (Ss < 0 || Ss >= DCTSIZE2 || Se < Ss || Se >= DCTSIZE2 ||
DRCe5eaf372014-05-09 18:00:32 +0000249 Ah < 0 || Ah > MAX_AH_AL || Al < 0 || Al > MAX_AH_AL)
250 ERREXIT1(cinfo, JERR_BAD_PROG_SCRIPT, scanno);
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000251 if (Ss == 0) {
DRCe5eaf372014-05-09 18:00:32 +0000252 if (Se != 0) /* DC and AC together not OK */
253 ERREXIT1(cinfo, JERR_BAD_PROG_SCRIPT, scanno);
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000254 } else {
DRCe5eaf372014-05-09 18:00:32 +0000255 if (ncomps != 1) /* AC scans must be for only one component */
256 ERREXIT1(cinfo, JERR_BAD_PROG_SCRIPT, scanno);
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000257 }
258 for (ci = 0; ci < ncomps; ci++) {
DRC19c791c2018-03-08 10:55:20 -0600259 last_bitpos_ptr = &last_bitpos[scanptr->component_index[ci]][0];
DRCe5eaf372014-05-09 18:00:32 +0000260 if (Ss != 0 && last_bitpos_ptr[0] < 0) /* AC without prior DC scan */
261 ERREXIT1(cinfo, JERR_BAD_PROG_SCRIPT, scanno);
262 for (coefi = Ss; coefi <= Se; coefi++) {
263 if (last_bitpos_ptr[coefi] < 0) {
264 /* first scan of this coefficient */
265 if (Ah != 0)
266 ERREXIT1(cinfo, JERR_BAD_PROG_SCRIPT, scanno);
267 } else {
268 /* not first scan */
DRC19c791c2018-03-08 10:55:20 -0600269 if (Ah != last_bitpos_ptr[coefi] || Al != Ah - 1)
DRCe5eaf372014-05-09 18:00:32 +0000270 ERREXIT1(cinfo, JERR_BAD_PROG_SCRIPT, scanno);
271 }
272 last_bitpos_ptr[coefi] = Al;
273 }
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000274 }
275#endif
276 } else {
277 /* For sequential JPEG, all progression parameters must be these: */
DRC19c791c2018-03-08 10:55:20 -0600278 if (Ss != 0 || Se != DCTSIZE2 - 1 || Ah != 0 || Al != 0)
DRCe5eaf372014-05-09 18:00:32 +0000279 ERREXIT1(cinfo, JERR_BAD_PROG_SCRIPT, scanno);
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000280 /* Make sure components are not sent twice */
281 for (ci = 0; ci < ncomps; ci++) {
DRCe5eaf372014-05-09 18:00:32 +0000282 thisi = scanptr->component_index[ci];
283 if (component_sent[thisi])
284 ERREXIT1(cinfo, JERR_BAD_SCAN_SCRIPT, scanno);
285 component_sent[thisi] = TRUE;
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000286 }
287 }
288 }
289
290 /* Now verify that everything got sent. */
291 if (cinfo->progressive_mode) {
292#ifdef C_PROGRESSIVE_SUPPORTED
293 /* For progressive mode, we only check that at least some DC data
294 * got sent for each component; the spec does not require that all bits
295 * of all coefficients be transmitted. Would it be wiser to enforce
296 * transmission of all coefficient bits??
297 */
298 for (ci = 0; ci < cinfo->num_components; ci++) {
299 if (last_bitpos[ci][0] < 0)
DRCe5eaf372014-05-09 18:00:32 +0000300 ERREXIT(cinfo, JERR_MISSING_DATA);
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000301 }
302#endif
303 } else {
304 for (ci = 0; ci < cinfo->num_components; ci++) {
DRC19c791c2018-03-08 10:55:20 -0600305 if (!component_sent[ci])
DRCe5eaf372014-05-09 18:00:32 +0000306 ERREXIT(cinfo, JERR_MISSING_DATA);
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000307 }
308 }
309}
310
311#endif /* C_MULTISCAN_FILES_SUPPORTED */
312
313
Thomas G. Lane489583f1996-02-07 00:00:00 +0000314LOCAL(void)
DRC19c791c2018-03-08 10:55:20 -0600315select_scan_parameters(j_compress_ptr cinfo)
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000316/* Set up the scan parameters for the current scan */
317{
318 int ci;
319
320#ifdef C_MULTISCAN_FILES_SUPPORTED
321 if (cinfo->scan_info != NULL) {
322 /* Prepare for current scan --- the script is already validated */
DRC19c791c2018-03-08 10:55:20 -0600323 my_master_ptr master = (my_master_ptr)cinfo->master;
DRCbd498032016-02-19 08:53:33 -0600324 const jpeg_scan_info *scanptr = cinfo->scan_info + master->scan_number;
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000325
326 cinfo->comps_in_scan = scanptr->comps_in_scan;
327 for (ci = 0; ci < scanptr->comps_in_scan; ci++) {
328 cinfo->cur_comp_info[ci] =
DRCe5eaf372014-05-09 18:00:32 +0000329 &cinfo->comp_info[scanptr->component_index[ci]];
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000330 }
331 cinfo->Ss = scanptr->Ss;
332 cinfo->Se = scanptr->Se;
333 cinfo->Ah = scanptr->Ah;
334 cinfo->Al = scanptr->Al;
DRC19c791c2018-03-08 10:55:20 -0600335 } else
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000336#endif
337 {
338 /* Prepare for single sequential-JPEG scan containing all components */
339 if (cinfo->num_components > MAX_COMPS_IN_SCAN)
340 ERREXIT2(cinfo, JERR_COMPONENT_COUNT, cinfo->num_components,
DRCe5eaf372014-05-09 18:00:32 +0000341 MAX_COMPS_IN_SCAN);
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000342 cinfo->comps_in_scan = cinfo->num_components;
343 for (ci = 0; ci < cinfo->num_components; ci++) {
344 cinfo->cur_comp_info[ci] = &cinfo->comp_info[ci];
345 }
346 cinfo->Ss = 0;
DRC19c791c2018-03-08 10:55:20 -0600347 cinfo->Se = DCTSIZE2 - 1;
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000348 cinfo->Ah = 0;
349 cinfo->Al = 0;
350 }
351}
352
353
Thomas G. Lane489583f1996-02-07 00:00:00 +0000354LOCAL(void)
DRC19c791c2018-03-08 10:55:20 -0600355per_scan_setup(j_compress_ptr cinfo)
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000356/* Do computations that are needed before processing a JPEG scan */
357/* cinfo->comps_in_scan and cinfo->cur_comp_info[] are already set */
358{
359 int ci, mcublks, tmp;
360 jpeg_component_info *compptr;
DRCe5eaf372014-05-09 18:00:32 +0000361
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000362 if (cinfo->comps_in_scan == 1) {
DRCe5eaf372014-05-09 18:00:32 +0000363
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000364 /* Noninterleaved (single-component) scan */
365 compptr = cinfo->cur_comp_info[0];
DRCe5eaf372014-05-09 18:00:32 +0000366
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000367 /* Overall image size in MCUs */
368 cinfo->MCUs_per_row = compptr->width_in_blocks;
369 cinfo->MCU_rows_in_scan = compptr->height_in_blocks;
DRCe5eaf372014-05-09 18:00:32 +0000370
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000371 /* For noninterleaved scan, always one block per MCU */
372 compptr->MCU_width = 1;
373 compptr->MCU_height = 1;
374 compptr->MCU_blocks = 1;
375 compptr->MCU_sample_width = DCTSIZE;
376 compptr->last_col_width = 1;
Thomas G. Lanea8b67c41995-03-15 00:00:00 +0000377 /* For noninterleaved scans, it is convenient to define last_row_height
378 * as the number of block rows present in the last iMCU row.
379 */
DRC19c791c2018-03-08 10:55:20 -0600380 tmp = (int)(compptr->height_in_blocks % compptr->v_samp_factor);
Thomas G. Lanea8b67c41995-03-15 00:00:00 +0000381 if (tmp == 0) tmp = compptr->v_samp_factor;
382 compptr->last_row_height = tmp;
DRCe5eaf372014-05-09 18:00:32 +0000383
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000384 /* Prepare array describing MCU composition */
385 cinfo->blocks_in_MCU = 1;
386 cinfo->MCU_membership[0] = 0;
DRCe5eaf372014-05-09 18:00:32 +0000387
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000388 } else {
DRCe5eaf372014-05-09 18:00:32 +0000389
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000390 /* Interleaved (multi-component) scan */
391 if (cinfo->comps_in_scan <= 0 || cinfo->comps_in_scan > MAX_COMPS_IN_SCAN)
392 ERREXIT2(cinfo, JERR_COMPONENT_COUNT, cinfo->comps_in_scan,
DRCe5eaf372014-05-09 18:00:32 +0000393 MAX_COMPS_IN_SCAN);
394
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000395 /* Overall image size in MCUs */
396 cinfo->MCUs_per_row = (JDIMENSION)
DRC19c791c2018-03-08 10:55:20 -0600397 jdiv_round_up((long)cinfo->_jpeg_width,
398 (long)(cinfo->max_h_samp_factor * DCTSIZE));
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000399 cinfo->MCU_rows_in_scan = (JDIMENSION)
DRC19c791c2018-03-08 10:55:20 -0600400 jdiv_round_up((long)cinfo->_jpeg_height,
401 (long)(cinfo->max_v_samp_factor * DCTSIZE));
DRCe5eaf372014-05-09 18:00:32 +0000402
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000403 cinfo->blocks_in_MCU = 0;
DRCe5eaf372014-05-09 18:00:32 +0000404
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000405 for (ci = 0; ci < cinfo->comps_in_scan; ci++) {
406 compptr = cinfo->cur_comp_info[ci];
407 /* Sampling factors give # of blocks of component in each MCU */
408 compptr->MCU_width = compptr->h_samp_factor;
409 compptr->MCU_height = compptr->v_samp_factor;
410 compptr->MCU_blocks = compptr->MCU_width * compptr->MCU_height;
411 compptr->MCU_sample_width = compptr->MCU_width * DCTSIZE;
412 /* Figure number of non-dummy blocks in last MCU column & row */
DRC19c791c2018-03-08 10:55:20 -0600413 tmp = (int)(compptr->width_in_blocks % compptr->MCU_width);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000414 if (tmp == 0) tmp = compptr->MCU_width;
415 compptr->last_col_width = tmp;
DRC19c791c2018-03-08 10:55:20 -0600416 tmp = (int)(compptr->height_in_blocks % compptr->MCU_height);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000417 if (tmp == 0) tmp = compptr->MCU_height;
418 compptr->last_row_height = tmp;
419 /* Prepare array describing MCU composition */
420 mcublks = compptr->MCU_blocks;
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000421 if (cinfo->blocks_in_MCU + mcublks > C_MAX_BLOCKS_IN_MCU)
DRCe5eaf372014-05-09 18:00:32 +0000422 ERREXIT(cinfo, JERR_BAD_MCU_SIZE);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000423 while (mcublks-- > 0) {
DRCe5eaf372014-05-09 18:00:32 +0000424 cinfo->MCU_membership[cinfo->blocks_in_MCU++] = ci;
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000425 }
426 }
DRCe5eaf372014-05-09 18:00:32 +0000427
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000428 }
429
430 /* Convert restart specified in rows to actual MCU count. */
431 /* Note that count must fit in 16 bits, so we provide limiting. */
432 if (cinfo->restart_in_rows > 0) {
DRC19c791c2018-03-08 10:55:20 -0600433 long nominal = (long)cinfo->restart_in_rows * (long)cinfo->MCUs_per_row;
434 cinfo->restart_interval = (unsigned int)MIN(nominal, 65535L);
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +0000435 }
436}
437
438
439/*
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000440 * Per-pass setup.
441 * This is called at the beginning of each pass. We determine which modules
442 * will be active during this pass and give them appropriate start_pass calls.
443 * We also set is_last_pass to indicate whether any more passes will be
444 * required.
445 */
446
Thomas G. Lane489583f1996-02-07 00:00:00 +0000447METHODDEF(void)
DRC19c791c2018-03-08 10:55:20 -0600448prepare_for_pass(j_compress_ptr cinfo)
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000449{
DRC19c791c2018-03-08 10:55:20 -0600450 my_master_ptr master = (my_master_ptr)cinfo->master;
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000451
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000452 switch (master->pass_type) {
453 case main_pass:
454 /* Initial pass: will collect input data, and do either Huffman
455 * optimization or data output for the first scan.
456 */
457 select_scan_parameters(cinfo);
458 per_scan_setup(cinfo);
DRC19c791c2018-03-08 10:55:20 -0600459 if (!cinfo->raw_data_in) {
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000460 (*cinfo->cconvert->start_pass) (cinfo);
461 (*cinfo->downsample->start_pass) (cinfo);
462 (*cinfo->prep->start_pass) (cinfo, JBUF_PASS_THRU);
463 }
464 (*cinfo->fdct->start_pass) (cinfo);
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000465 (*cinfo->entropy->start_pass) (cinfo, cinfo->optimize_coding);
466 (*cinfo->coef->start_pass) (cinfo,
DRCe5eaf372014-05-09 18:00:32 +0000467 (master->total_passes > 1 ?
468 JBUF_SAVE_AND_PASS : JBUF_PASS_THRU));
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000469 (*cinfo->main->start_pass) (cinfo, JBUF_PASS_THRU);
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000470 if (cinfo->optimize_coding) {
471 /* No immediate data output; postpone writing frame/scan headers */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000472 master->pub.call_pass_startup = FALSE;
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000473 } else {
474 /* Will write frame/scan headers at first jpeg_write_scanlines call */
475 master->pub.call_pass_startup = TRUE;
476 }
477 break;
478#ifdef ENTROPY_OPT_SUPPORTED
479 case huff_opt_pass:
480 /* Do Huffman optimization for a scan after the first one. */
481 select_scan_parameters(cinfo);
482 per_scan_setup(cinfo);
483 if (cinfo->Ss != 0 || cinfo->Ah == 0 || cinfo->arith_code) {
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000484 (*cinfo->entropy->start_pass) (cinfo, TRUE);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000485 (*cinfo->coef->start_pass) (cinfo, JBUF_CRANK_DEST);
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000486 master->pub.call_pass_startup = FALSE;
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000487 break;
488 }
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000489 /* Special case: Huffman DC refinement scans need no Huffman table
490 * and therefore we can skip the optimization pass for them.
491 */
492 master->pass_type = output_pass;
493 master->pass_number++;
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000494#endif
Peter Kasting9df57862021-06-26 16:22:21 -0700495 FALLTHROUGH /*FALLTHROUGH*/
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000496 case output_pass:
497 /* Do a data-output pass. */
498 /* We need not repeat per-scan setup if prior optimization pass did it. */
DRC19c791c2018-03-08 10:55:20 -0600499 if (!cinfo->optimize_coding) {
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000500 select_scan_parameters(cinfo);
501 per_scan_setup(cinfo);
502 }
503 (*cinfo->entropy->start_pass) (cinfo, FALSE);
504 (*cinfo->coef->start_pass) (cinfo, JBUF_CRANK_DEST);
505 /* We emit frame/scan headers now */
506 if (master->scan_number == 0)
507 (*cinfo->marker->write_frame_header) (cinfo);
508 (*cinfo->marker->write_scan_header) (cinfo);
509 master->pub.call_pass_startup = FALSE;
510 break;
511 default:
512 ERREXIT(cinfo, JERR_NOT_COMPILED);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000513 }
514
DRC19c791c2018-03-08 10:55:20 -0600515 master->pub.is_last_pass = (master->pass_number == master->total_passes - 1);
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000516
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000517 /* Set up progress monitor's pass info if present */
518 if (cinfo->progress != NULL) {
519 cinfo->progress->completed_passes = master->pass_number;
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000520 cinfo->progress->total_passes = master->total_passes;
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000521 }
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000522}
523
524
525/*
526 * Special start-of-pass hook.
527 * This is called by jpeg_write_scanlines if call_pass_startup is TRUE.
528 * In single-pass processing, we need this hook because we don't want to
529 * write frame/scan headers during jpeg_start_compress; we want to let the
530 * application write COM markers etc. between jpeg_start_compress and the
531 * jpeg_write_scanlines loop.
532 * In multi-pass processing, this routine is not used.
533 */
534
Thomas G. Lane489583f1996-02-07 00:00:00 +0000535METHODDEF(void)
DRC19c791c2018-03-08 10:55:20 -0600536pass_startup(j_compress_ptr cinfo)
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000537{
538 cinfo->master->call_pass_startup = FALSE; /* reset flag so call only once */
539
540 (*cinfo->marker->write_frame_header) (cinfo);
541 (*cinfo->marker->write_scan_header) (cinfo);
542}
543
544
545/*
546 * Finish up at end of pass.
547 */
548
Thomas G. Lane489583f1996-02-07 00:00:00 +0000549METHODDEF(void)
DRC19c791c2018-03-08 10:55:20 -0600550finish_pass_master(j_compress_ptr cinfo)
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000551{
DRC19c791c2018-03-08 10:55:20 -0600552 my_master_ptr master = (my_master_ptr)cinfo->master;
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000553
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000554 /* The entropy coder always needs an end-of-pass call,
555 * either to analyze statistics or to flush its output buffer.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000556 */
557 (*cinfo->entropy->finish_pass) (cinfo);
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000558
559 /* Update state for next pass */
560 switch (master->pass_type) {
561 case main_pass:
562 /* next pass is either output of scan 0 (after optimization)
563 * or output of scan 1 (if no optimization).
564 */
565 master->pass_type = output_pass;
DRC19c791c2018-03-08 10:55:20 -0600566 if (!cinfo->optimize_coding)
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000567 master->scan_number++;
568 break;
569 case huff_opt_pass:
570 /* next pass is always output of current scan */
571 master->pass_type = output_pass;
572 break;
573 case output_pass:
574 /* next pass is either optimization or output of next scan */
575 if (cinfo->optimize_coding)
576 master->pass_type = huff_opt_pass;
577 master->scan_number++;
578 break;
579 }
580
581 master->pass_number++;
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000582}
583
584
585/*
586 * Initialize master compression control.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000587 */
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +0000588
Thomas G. Lane489583f1996-02-07 00:00:00 +0000589GLOBAL(void)
DRC19c791c2018-03-08 10:55:20 -0600590jinit_c_master_control(j_compress_ptr cinfo, boolean transcode_only)
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +0000591{
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000592 my_master_ptr master;
Thomas G. Lane4a6b7301992-03-17 00:00:00 +0000593
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000594 master = (my_master_ptr)
DRC19c791c2018-03-08 10:55:20 -0600595 (*cinfo->mem->alloc_small) ((j_common_ptr)cinfo, JPOOL_IMAGE,
596 sizeof(my_comp_master));
597 cinfo->master = (struct jpeg_comp_master *)master;
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000598 master->pub.prepare_for_pass = prepare_for_pass;
599 master->pub.pass_startup = pass_startup;
600 master->pub.finish_pass = finish_pass_master;
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000601 master->pub.is_last_pass = FALSE;
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +0000602
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000603 /* Validate parameters, determine derived values */
Guido Vollbeding989630f2010-01-10 00:00:00 +0000604 initial_setup(cinfo, transcode_only);
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000605
606 if (cinfo->scan_info != NULL) {
607#ifdef C_MULTISCAN_FILES_SUPPORTED
608 validate_script(cinfo);
609#else
610 ERREXIT(cinfo, JERR_NOT_COMPILED);
611#endif
612 } else {
613 cinfo->progressive_mode = FALSE;
614 cinfo->num_scans = 1;
615 }
616
DRCe621dfc2016-02-19 10:35:09 -0600617 if (cinfo->progressive_mode && !cinfo->arith_code) /* TEMPORARY HACK ??? */
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000618 cinfo->optimize_coding = TRUE; /* assume default tables no good for progressive mode */
619
620 /* Initialize my private state */
621 if (transcode_only) {
622 /* no main pass in transcoding */
623 if (cinfo->optimize_coding)
624 master->pass_type = huff_opt_pass;
625 else
626 master->pass_type = output_pass;
627 } else {
628 /* for normal compression, first pass is always this type: */
629 master->pass_type = main_pass;
630 }
631 master->scan_number = 0;
632 master->pass_number = 0;
633 if (cinfo->optimize_coding)
634 master->total_passes = cinfo->num_scans * 2;
635 else
636 master->total_passes = cinfo->num_scans;
DRC6f241d42016-03-16 07:10:35 -0500637
638 master->jpeg_version = PACKAGE_NAME " version " VERSION " (build " BUILD ")";
Thomas G. Lane2cbeb8a1991-10-07 00:00:00 +0000639}