/src/ghostpdl/jbig2dec/jbig2_halftone.c
Line | Count | Source |
1 | | /* Copyright (C) 2001-2023 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 | | jbig2dec |
18 | | */ |
19 | | |
20 | | /* JBIG2 Pattern Dictionary and Halftone Region decoding */ |
21 | | |
22 | | #ifdef HAVE_CONFIG_H |
23 | | #include "config.h" |
24 | | #endif |
25 | | #include "os_types.h" |
26 | | |
27 | | #include <string.h> /* memset() */ |
28 | | |
29 | | #include "jbig2.h" |
30 | | #include "jbig2_priv.h" |
31 | | #include "jbig2_arith.h" |
32 | | #include "jbig2_generic.h" |
33 | | #include "jbig2_image.h" |
34 | | #include "jbig2_halftone.h" |
35 | | #include "jbig2_mmr.h" |
36 | | #include "jbig2_page.h" |
37 | | #include "jbig2_segment.h" |
38 | | |
39 | | /** |
40 | | * jbig2_hd_new: create a new dictionary from a collective bitmap |
41 | | */ |
42 | | static Jbig2PatternDict * |
43 | | jbig2_hd_new(Jbig2Ctx *ctx, const Jbig2PatternDictParams *params, Jbig2Image *image) |
44 | 152 | { |
45 | 152 | Jbig2PatternDict *new; |
46 | 152 | const uint32_t N = params->GRAYMAX + 1; |
47 | 152 | const uint32_t HPW = params->HDPW; |
48 | 152 | const uint32_t HPH = params->HDPH; |
49 | 152 | int code; |
50 | 152 | uint32_t i, j; |
51 | | |
52 | 152 | if (N == 0) { |
53 | | /* We've wrapped. */ |
54 | 0 | jbig2_error(ctx, JBIG2_SEVERITY_WARNING, JBIG2_UNKNOWN_SEGMENT_NUMBER, "params->GRAYMAX out of range"); |
55 | 0 | return NULL; |
56 | 0 | } |
57 | | |
58 | | /* allocate a new struct */ |
59 | 152 | new = jbig2_new(ctx, Jbig2PatternDict, 1); |
60 | 152 | if (new != NULL) { |
61 | 152 | new->patterns = jbig2_new(ctx, Jbig2Image *, N); |
62 | 152 | if (new->patterns == NULL) { |
63 | 2 | jbig2_error(ctx, JBIG2_SEVERITY_FATAL, JBIG2_UNKNOWN_SEGMENT_NUMBER, "failed to allocate pattern in collective bitmap dictionary"); |
64 | 2 | jbig2_free(ctx->allocator, new); |
65 | 2 | return NULL; |
66 | 2 | } |
67 | 150 | new->n_patterns = N; |
68 | 150 | new->HPW = HPW; |
69 | 150 | new->HPH = HPH; |
70 | | |
71 | | /* 6.7.5(4) - copy out the individual pattern images */ |
72 | 2.45M | for (i = 0; i < N; i++) { |
73 | 2.45M | new->patterns[i] = jbig2_image_new(ctx, HPW, HPH); |
74 | 2.45M | if (new->patterns[i] == NULL) { |
75 | 0 | jbig2_error(ctx, JBIG2_SEVERITY_WARNING, JBIG2_UNKNOWN_SEGMENT_NUMBER, "failed to allocate pattern element image"); |
76 | | /* new->patterns[i] above did not succeed, so releasing patterns 0..i-1 is enough */ |
77 | 0 | for (j = 0; j < i; j++) |
78 | 0 | jbig2_image_release(ctx, new->patterns[j]); |
79 | 0 | jbig2_free(ctx->allocator, new->patterns); |
80 | 0 | jbig2_free(ctx->allocator, new); |
81 | 0 | return NULL; |
82 | 0 | } |
83 | | /* compose with the REPLACE operator; the source |
84 | | will be clipped to the destination, selecting the |
85 | | proper sub image */ |
86 | 2.45M | code = jbig2_image_compose(ctx, new->patterns[i], image, -((int64_t) i) * HPW, 0, JBIG2_COMPOSE_REPLACE); |
87 | 2.45M | if (code < 0) { |
88 | 0 | jbig2_error(ctx, JBIG2_SEVERITY_WARNING, JBIG2_UNKNOWN_SEGMENT_NUMBER, "failed to compose image into collective bitmap dictionary"); |
89 | | /* new->patterns[i] above succeeded, so release all patterns 0..i */ |
90 | 0 | for (j = 0; j <= i; j++) |
91 | 0 | jbig2_image_release(ctx, new->patterns[j]); |
92 | 0 | jbig2_free(ctx->allocator, new->patterns); |
93 | 0 | jbig2_free(ctx->allocator, new); |
94 | 0 | return NULL; |
95 | 0 | } |
96 | 2.45M | } |
97 | 150 | } else { |
98 | 0 | jbig2_error(ctx, JBIG2_SEVERITY_FATAL, JBIG2_UNKNOWN_SEGMENT_NUMBER, "failed to allocate collective bitmap dictionary"); |
99 | 0 | } |
100 | | |
101 | 150 | return new; |
102 | 152 | } |
103 | | |
104 | | /** |
105 | | * jbig2_hd_release: release a pattern dictionary |
106 | | */ |
107 | | void |
108 | | jbig2_hd_release(Jbig2Ctx *ctx, Jbig2PatternDict *dict) |
109 | 150 | { |
110 | 150 | int i; |
111 | | |
112 | 150 | if (dict == NULL) |
113 | 0 | return; |
114 | 150 | if (dict->patterns != NULL) |
115 | 2.45M | for (i = 0; i < dict->n_patterns; i++) |
116 | 2.45M | jbig2_image_release(ctx, dict->patterns[i]); |
117 | 150 | jbig2_free(ctx->allocator, dict->patterns); |
118 | 150 | jbig2_free(ctx->allocator, dict); |
119 | 150 | } |
120 | | |
121 | | /** |
122 | | * jbig2_decode_pattern_dict: decode pattern dictionary data |
123 | | * |
124 | | * @ctx: jbig2 decoder context |
125 | | * @segment: jbig2 segment (header) structure |
126 | | * @params: parameters from the pattern dictionary header |
127 | | * @data: pointer to text region data to be decoded |
128 | | * @size: length of text region data |
129 | | * @GB_stats: arithmetic coding context to use |
130 | | * |
131 | | * Implements the pattern dictionary decoding procedure |
132 | | * described in section 6.7 of the JBIG2 spec. |
133 | | * |
134 | | * returns: a pointer to the resulting dictionary on success |
135 | | * returns: 0 on failure |
136 | | **/ |
137 | | static Jbig2PatternDict * |
138 | | jbig2_decode_pattern_dict(Jbig2Ctx *ctx, Jbig2Segment *segment, |
139 | | const Jbig2PatternDictParams *params, const byte *data, const size_t size, Jbig2ArithCx *GB_stats) |
140 | 201 | { |
141 | 201 | Jbig2PatternDict *hd = NULL; |
142 | 201 | Jbig2Image *image = NULL; |
143 | 201 | Jbig2GenericRegionParams rparams; |
144 | 201 | int code = 0; |
145 | | |
146 | | /* allocate the collective image */ |
147 | 201 | image = jbig2_image_new(ctx, params->HDPW * (params->GRAYMAX + 1), params->HDPH); |
148 | 201 | if (image == NULL) { |
149 | 14 | jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate collective bitmap for halftone dictionary"); |
150 | 14 | return NULL; |
151 | 14 | } |
152 | | |
153 | | /* fill out the generic region decoder parameters */ |
154 | 187 | rparams.MMR = params->HDMMR; |
155 | 187 | rparams.GBTEMPLATE = params->HDTEMPLATE; |
156 | 187 | rparams.TPGDON = 0; /* not used if HDMMR = 1 */ |
157 | 187 | rparams.USESKIP = 0; |
158 | 187 | rparams.gbat[0] = -(int8_t) params->HDPW; |
159 | 187 | rparams.gbat[1] = 0; |
160 | 187 | rparams.gbat[2] = -3; |
161 | 187 | rparams.gbat[3] = -1; |
162 | 187 | rparams.gbat[4] = 2; |
163 | 187 | rparams.gbat[5] = -2; |
164 | 187 | rparams.gbat[6] = -2; |
165 | 187 | rparams.gbat[7] = -2; |
166 | | |
167 | 187 | if (params->HDMMR) { |
168 | 169 | code = jbig2_decode_generic_mmr(ctx, segment, &rparams, data, size, image); |
169 | 169 | } else { |
170 | 18 | Jbig2WordStream *ws = jbig2_word_stream_buf_new(ctx, data, size); |
171 | | |
172 | 18 | if (ws != NULL) { |
173 | 18 | Jbig2ArithState *as = jbig2_arith_new(ctx, ws); |
174 | | |
175 | 18 | if (as != NULL) { |
176 | 18 | code = jbig2_decode_generic_region(ctx, segment, &rparams, as, image, GB_stats); |
177 | 18 | } else { |
178 | 0 | code = jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate arithmetic coding state when handling halftone dictionary"); |
179 | 0 | } |
180 | | |
181 | 18 | jbig2_free(ctx->allocator, as); |
182 | 18 | jbig2_word_stream_buf_free(ctx, ws); |
183 | 18 | } else { |
184 | 0 | code = jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate word stream when handling halftone dictionary"); |
185 | 0 | } |
186 | 18 | } |
187 | | |
188 | 187 | if (code == 0) |
189 | 152 | hd = jbig2_hd_new(ctx, params, image); |
190 | 35 | else |
191 | 35 | jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to decode immediate generic region"); |
192 | 187 | jbig2_image_release(ctx, image); |
193 | | |
194 | 187 | return hd; |
195 | 201 | } |
196 | | |
197 | | /* 7.4.4 */ |
198 | | int |
199 | | jbig2_pattern_dictionary(Jbig2Ctx *ctx, Jbig2Segment *segment, const byte *segment_data) |
200 | 205 | { |
201 | 205 | Jbig2PatternDictParams params; |
202 | 205 | Jbig2ArithCx *GB_stats = NULL; |
203 | 205 | byte flags; |
204 | 205 | int offset = 0; |
205 | | |
206 | | /* 7.4.4.1 - Data header */ |
207 | 205 | if (segment->data_length < 7) { |
208 | 4 | return jbig2_error(ctx, JBIG2_SEVERITY_FATAL, segment->number, "segment too short"); |
209 | 4 | } |
210 | 201 | flags = segment_data[0]; |
211 | 201 | params.HDMMR = flags & 1; |
212 | 201 | params.HDTEMPLATE = (flags & 6) >> 1; |
213 | 201 | params.HDPW = segment_data[1]; |
214 | 201 | params.HDPH = segment_data[2]; |
215 | 201 | params.GRAYMAX = jbig2_get_uint32(segment_data + 3); |
216 | 201 | offset += 7; |
217 | | |
218 | 201 | jbig2_error(ctx, JBIG2_SEVERITY_INFO, segment->number, |
219 | 201 | "pattern dictionary, flags=%02x, %d grays (%dx%d cell)", flags, params.GRAYMAX + 1, params.HDPW, params.HDPH); |
220 | | |
221 | 201 | if (params.HDMMR && params.HDTEMPLATE) { |
222 | 182 | jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "HDTEMPLATE is %d when HDMMR is %d, contrary to spec", params.HDTEMPLATE, params.HDMMR); |
223 | 182 | } |
224 | 201 | if (flags & 0xf8) { |
225 | 176 | jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "reserved flag bits non-zero"); |
226 | 176 | } |
227 | | |
228 | | /* 7.4.4.2 */ |
229 | 201 | if (!params.HDMMR) { |
230 | | /* allocate and zero arithmetic coding stats */ |
231 | 18 | int stats_size = jbig2_generic_stats_size(ctx, params.HDTEMPLATE); |
232 | | |
233 | 18 | GB_stats = jbig2_new(ctx, Jbig2ArithCx, stats_size); |
234 | 18 | if (GB_stats == NULL) |
235 | 0 | return jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate arithmetic coding state when handling pattern dictionary"); |
236 | 18 | memset(GB_stats, 0, stats_size); |
237 | 18 | } |
238 | | |
239 | 201 | segment->result = jbig2_decode_pattern_dict(ctx, segment, ¶ms, segment_data + offset, segment->data_length - offset, GB_stats); |
240 | | |
241 | | /* todo: retain GB_stats? */ |
242 | 201 | if (!params.HDMMR) { |
243 | 18 | jbig2_free(ctx->allocator, GB_stats); |
244 | 18 | } |
245 | | |
246 | 201 | return (segment->result != NULL) ? 0 : -1; |
247 | 201 | } |
248 | | |
249 | | /** |
250 | | * jbig2_decode_gray_scale_image: decode gray-scale image |
251 | | * |
252 | | * @ctx: jbig2 decoder context |
253 | | * @segment: jbig2 segment (header) structure |
254 | | * @data: pointer to text region data to be decoded |
255 | | * @size: length of text region data |
256 | | * @GSMMR: if MMR is used |
257 | | * @GSW: width of gray-scale image |
258 | | * @GSH: height of gray-scale image |
259 | | * @GSBPP: number of bitplanes/Jbig2Images to use |
260 | | * @GSKIP: mask indicating which values should be skipped |
261 | | * @GSTEMPLATE: template used to code the gray-scale bitplanes |
262 | | * @GB_stats: arithmetic coding context to use |
263 | | * |
264 | | * Implements the decoding a gray-scale image described in |
265 | | * annex C.5. This is part of the halftone region decoding. |
266 | | * |
267 | | * returns: array of gray-scale values with GSW x GSH width/height |
268 | | * 0 on failure |
269 | | **/ |
270 | | static uint16_t ** |
271 | | jbig2_decode_gray_scale_image(Jbig2Ctx *ctx, Jbig2Segment *segment, |
272 | | const byte *data, const size_t size, |
273 | | bool GSMMR, uint32_t GSW, uint32_t GSH, |
274 | | uint32_t GSBPP, bool GSUSESKIP, Jbig2Image *GSKIP, int GSTEMPLATE, Jbig2ArithCx *GB_stats) |
275 | 28 | { |
276 | 28 | uint16_t **GSVALS = NULL; |
277 | 28 | size_t consumed_bytes = 0; |
278 | 28 | uint32_t i, j, stride; |
279 | 28 | int64_t x, y; |
280 | 28 | int code; |
281 | 28 | Jbig2Image **GSPLANES; |
282 | 28 | Jbig2GenericRegionParams rparams; |
283 | 28 | Jbig2WordStream *ws = NULL; |
284 | 28 | Jbig2ArithState *as = NULL; |
285 | | |
286 | | /* allocate GSPLANES */ |
287 | 28 | GSPLANES = jbig2_new(ctx, Jbig2Image *, GSBPP); |
288 | 28 | if (GSPLANES == NULL) { |
289 | 0 | jbig2_error(ctx, JBIG2_SEVERITY_FATAL, segment->number, "failed to allocate %d bytes for GSPLANES", GSBPP); |
290 | 0 | return NULL; |
291 | 0 | } |
292 | | |
293 | 204 | for (i = 0; i < GSBPP; ++i) { |
294 | 176 | GSPLANES[i] = jbig2_image_new(ctx, GSW, GSH); |
295 | 176 | if (GSPLANES[i] == NULL) { |
296 | 0 | jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate %dx%d image for GSPLANES", GSW, GSH); |
297 | | /* free already allocated */ |
298 | 0 | for (j = i; j > 0;) |
299 | 0 | jbig2_image_release(ctx, GSPLANES[--j]); |
300 | 0 | jbig2_free(ctx->allocator, GSPLANES); |
301 | 0 | return NULL; |
302 | 0 | } |
303 | 176 | } |
304 | | |
305 | | /* C.5 step 1. Decode GSPLANES[GSBPP-1] */ |
306 | | /* fill generic region decoder parameters */ |
307 | 28 | rparams.MMR = GSMMR; |
308 | 28 | rparams.GBTEMPLATE = GSTEMPLATE; |
309 | 28 | rparams.TPGDON = 0; |
310 | 28 | rparams.USESKIP = GSUSESKIP; |
311 | 28 | rparams.SKIP = GSKIP; |
312 | 28 | rparams.gbat[0] = (GSTEMPLATE <= 1 ? 3 : 2); |
313 | 28 | rparams.gbat[1] = -1; |
314 | 28 | rparams.gbat[2] = -3; |
315 | 28 | rparams.gbat[3] = -1; |
316 | 28 | rparams.gbat[4] = 2; |
317 | 28 | rparams.gbat[5] = -2; |
318 | 28 | rparams.gbat[6] = -2; |
319 | 28 | rparams.gbat[7] = -2; |
320 | | |
321 | 28 | if (GSMMR) { |
322 | 1 | code = jbig2_decode_halftone_mmr(ctx, &rparams, data, size, GSPLANES[GSBPP - 1], &consumed_bytes); |
323 | 27 | } else { |
324 | 27 | ws = jbig2_word_stream_buf_new(ctx, data, size); |
325 | 27 | if (ws == NULL) { |
326 | 0 | jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate word stream when decoding gray scale image"); |
327 | 0 | goto cleanup; |
328 | 0 | } |
329 | | |
330 | 27 | as = jbig2_arith_new(ctx, ws); |
331 | 27 | if (as == NULL) { |
332 | 0 | jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate arithmetic coding state when decoding gray scale image"); |
333 | 0 | goto cleanup; |
334 | 0 | } |
335 | | |
336 | 27 | code = jbig2_decode_generic_region(ctx, segment, &rparams, as, GSPLANES[GSBPP - 1], GB_stats); |
337 | 27 | } |
338 | 28 | if (code < 0) { |
339 | 0 | jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "error decoding GSPLANES for halftone image"); |
340 | 0 | goto cleanup; |
341 | 0 | } |
342 | | |
343 | | /* C.5 step 2. Set j = GSBPP-2 */ |
344 | 28 | j = GSBPP - 1; |
345 | | /* C.5 step 3. decode loop */ |
346 | 176 | while (j > 0) { |
347 | 148 | j--; |
348 | | /* C.5 step 3. (a) */ |
349 | 148 | if (GSMMR) { |
350 | 9 | code = jbig2_decode_halftone_mmr(ctx, &rparams, data + consumed_bytes, size - consumed_bytes, GSPLANES[j], &consumed_bytes); |
351 | 139 | } else { |
352 | 139 | code = jbig2_decode_generic_region(ctx, segment, &rparams, as, GSPLANES[j], GB_stats); |
353 | 139 | } |
354 | 148 | if (code < 0) { |
355 | 0 | jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to decode GSPLANES for halftone image"); |
356 | 0 | goto cleanup; |
357 | 0 | } |
358 | | |
359 | | /* C.5 step 3. (b): |
360 | | * for each [x,y] |
361 | | * GSPLANES[j][x][y] = GSPLANES[j+1][x][y] XOR GSPLANES[j][x][y] */ |
362 | 148 | stride = GSPLANES[j]->stride; |
363 | 12.3k | for (i = 0; i < stride * GSH; ++i) |
364 | 12.2k | GSPLANES[j]->data[i] ^= GSPLANES[j + 1]->data[i]; |
365 | | |
366 | | /* C.5 step 3. (c) */ |
367 | 148 | } |
368 | | |
369 | | /* allocate GSVALS */ |
370 | 28 | GSVALS = jbig2_new(ctx, uint16_t *, GSW); |
371 | 28 | if (GSVALS == NULL) { |
372 | 0 | jbig2_error(ctx, JBIG2_SEVERITY_FATAL, segment->number, "failed to allocate GSVALS: %d bytes", GSW); |
373 | 0 | goto cleanup; |
374 | 0 | } |
375 | 442 | for (i = 0; i < GSW; ++i) { |
376 | 414 | GSVALS[i] = jbig2_new(ctx, uint16_t, GSH); |
377 | 414 | if (GSVALS[i] == NULL) { |
378 | 0 | jbig2_error(ctx, JBIG2_SEVERITY_FATAL, segment->number, "failed to allocate GSVALS: %d bytes", GSH * GSW); |
379 | | /* free already allocated */ |
380 | 0 | for (j = i; j > 0;) |
381 | 0 | jbig2_free(ctx->allocator, GSVALS[--j]); |
382 | 0 | jbig2_free(ctx->allocator, GSVALS); |
383 | 0 | GSVALS = NULL; |
384 | 0 | goto cleanup; |
385 | 0 | } |
386 | 414 | } |
387 | | |
388 | | /* C.5 step 4. */ |
389 | 442 | for (x = 0; x < GSW; ++x) { |
390 | 12.2k | for (y = 0; y < GSH; ++y) { |
391 | 11.8k | GSVALS[x][y] = 0; |
392 | | |
393 | 104k | for (j = 0; j < GSBPP; ++j) |
394 | 92.5k | GSVALS[x][y] += jbig2_image_get_pixel(GSPLANES[j], x, y) << j; |
395 | 11.8k | } |
396 | 414 | } |
397 | | |
398 | 28 | cleanup: |
399 | | /* free memory */ |
400 | 28 | if (!GSMMR) { |
401 | 27 | jbig2_free(ctx->allocator, as); |
402 | 27 | jbig2_word_stream_buf_free(ctx, ws); |
403 | 27 | } |
404 | 204 | for (i = 0; i < GSBPP; ++i) |
405 | 176 | jbig2_image_release(ctx, GSPLANES[i]); |
406 | | |
407 | 28 | jbig2_free(ctx->allocator, GSPLANES); |
408 | | |
409 | 28 | return GSVALS; |
410 | 28 | } |
411 | | |
412 | | /** |
413 | | * jbig2_decode_ht_region_get_hpats: get pattern dictionary |
414 | | * |
415 | | * @ctx: jbig2 decoder context |
416 | | * @segment: jbig2 halftone region segment |
417 | | * |
418 | | * Returns the first referred pattern dictionary of segment |
419 | | * |
420 | | * returns: pattern dictionary |
421 | | * 0 if search failed |
422 | | **/ |
423 | | static Jbig2PatternDict * |
424 | | jbig2_decode_ht_region_get_hpats(Jbig2Ctx *ctx, Jbig2Segment *segment) |
425 | 28 | { |
426 | 28 | int index = 0; |
427 | 28 | Jbig2PatternDict *pattern_dict = NULL; |
428 | 28 | Jbig2Segment *rsegment = NULL; |
429 | | |
430 | | /* loop through all referred segments */ |
431 | 28 | while (!pattern_dict && segment->referred_to_segment_count > index) { |
432 | 28 | rsegment = jbig2_find_segment(ctx, segment->referred_to_segments[index]); |
433 | 28 | if (rsegment) { |
434 | | /* segment type is pattern dictionary and result is not empty */ |
435 | 28 | if ((rsegment->flags & 0x3f) == 16 && rsegment->result) { |
436 | 28 | pattern_dict = (Jbig2PatternDict *) rsegment->result; |
437 | 28 | return pattern_dict; |
438 | 28 | } |
439 | 28 | } |
440 | 0 | index++; |
441 | 0 | } |
442 | 0 | return pattern_dict; |
443 | 28 | } |
444 | | |
445 | | /** |
446 | | * jbig2_decode_halftone_region: decode a halftone region |
447 | | * |
448 | | * @ctx: jbig2 decoder context |
449 | | * @segment: jbig2 halftone region segment |
450 | | * @params: parameters |
451 | | * @data: pointer to halftone region data to be decoded |
452 | | * @size: length of halftone region data |
453 | | * @GB_stats: arithmetic coding context to use |
454 | | * |
455 | | * Implements the halftone region decoding procedure |
456 | | * described in section 6.6.5 of the JBIG2 spec. |
457 | | * |
458 | | * returns: 0 on success |
459 | | * <0 on failure |
460 | | **/ |
461 | | static int |
462 | | jbig2_decode_halftone_region(Jbig2Ctx *ctx, Jbig2Segment *segment, |
463 | | Jbig2HalftoneRegionParams *params, const byte *data, const size_t size, Jbig2Image *image, Jbig2ArithCx *GB_stats) |
464 | 28 | { |
465 | 28 | uint32_t HBPP; |
466 | 28 | uint32_t HNUMPATS; |
467 | 28 | uint16_t **GI = NULL; |
468 | 28 | Jbig2Image *HSKIP = NULL; |
469 | 28 | Jbig2PatternDict *HPATS; |
470 | 28 | uint32_t i; |
471 | 28 | int64_t mg, ng; |
472 | 28 | uint16_t gray_val; |
473 | 28 | int code = 0; |
474 | | |
475 | | /* We need the patterns used in this region, get them from the referred pattern dictionary */ |
476 | 28 | HPATS = jbig2_decode_ht_region_get_hpats(ctx, segment); |
477 | 28 | if (!HPATS) { |
478 | 0 | code = jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "no pattern dictionary found, skipping halftone image"); |
479 | 0 | goto cleanup; |
480 | 0 | } |
481 | | |
482 | | /* 6.6.5 point 1. Fill bitmap with HDEFPIXEL */ |
483 | 28 | memset(image->data, params->HDEFPIXEL, image->stride * image->height); |
484 | | |
485 | | /* 6.6.5 point 2. compute HSKIP according to 6.6.5.1 */ |
486 | 28 | if (params->HENABLESKIP == 1) { |
487 | 4 | HSKIP = jbig2_image_new(ctx, params->HGW, params->HGH); |
488 | 4 | if (HSKIP == NULL) |
489 | 0 | return jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate skip image"); |
490 | | |
491 | 152 | for (mg = 0; mg < params->HGH; ++mg) { |
492 | 6.06k | for (ng = 0; ng < params->HGW; ++ng) { |
493 | 5.91k | int64_t x = ((int64_t) params->HGX + mg * params->HRY + ng * params->HRX) >> 8; |
494 | 5.91k | int64_t y = ((int64_t) params->HGY + mg * params->HRX - ng * params->HRY) >> 8; |
495 | | |
496 | 5.91k | if (x + HPATS->HPW <= 0 || x >= image->width || y + HPATS->HPH <= 0 || y >= image->height) { |
497 | 2.08k | jbig2_image_set_pixel(HSKIP, ng, mg, 1); |
498 | 3.82k | } else { |
499 | 3.82k | jbig2_image_set_pixel(HSKIP, ng, mg, 0); |
500 | 3.82k | } |
501 | 5.91k | } |
502 | 148 | } |
503 | 4 | } |
504 | | |
505 | | /* 6.6.5 point 3. set HBPP to ceil(log2(HNUMPATS)): */ |
506 | 28 | HNUMPATS = HPATS->n_patterns; |
507 | 28 | HBPP = 0; |
508 | 176 | while (HNUMPATS > (1U << ++HBPP)); |
509 | 28 | if (HBPP > 16) { |
510 | 0 | code = jbig2_error(ctx, JBIG2_SEVERITY_FATAL, segment->number, "HBPP is larger than supported (%u)", HBPP); |
511 | 0 | goto cleanup; |
512 | 0 | } |
513 | | |
514 | | /* 6.6.5 point 4. decode gray-scale image as mentioned in annex C */ |
515 | 28 | GI = jbig2_decode_gray_scale_image(ctx, segment, data, size, |
516 | 28 | params->HMMR, params->HGW, params->HGH, HBPP, params->HENABLESKIP, HSKIP, params->HTEMPLATE, GB_stats); |
517 | 28 | if (!GI) { |
518 | 0 | code = jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "unable to acquire gray-scale image, skipping halftone image"); |
519 | 0 | goto cleanup; |
520 | 0 | } |
521 | | |
522 | | /* 6.6.5 point 5. place patterns with procedure mentioned in 6.6.5.2 */ |
523 | 477 | for (mg = 0; mg < params->HGH; ++mg) { |
524 | 12.2k | for (ng = 0; ng < params->HGW; ++ng) { |
525 | 11.8k | int64_t x = ((int64_t) params->HGX + mg * params->HRY + ng * params->HRX) >> 8; |
526 | 11.8k | int64_t y = ((int64_t) params->HGY + mg * params->HRX - ng * params->HRY) >> 8; |
527 | | |
528 | | /* prevent pattern index >= HNUMPATS */ |
529 | 11.8k | gray_val = GI[ng][mg]; |
530 | 11.8k | if (gray_val >= HNUMPATS) { |
531 | 0 | jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "gray-scale index %d out of range, using largest index", gray_val); |
532 | | /* use highest available pattern */ |
533 | 0 | gray_val = HNUMPATS - 1; |
534 | 0 | } |
535 | 11.8k | code = jbig2_image_compose(ctx, image, HPATS->patterns[gray_val], x, y, params->HCOMBOP); |
536 | 11.8k | if (code < 0) { |
537 | 0 | code = jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to compose pattern with gray-scale image"); |
538 | 0 | goto cleanup; |
539 | 0 | } |
540 | 11.8k | } |
541 | 449 | } |
542 | | |
543 | 28 | cleanup: |
544 | 28 | if (GI) { |
545 | 442 | for (i = 0; i < params->HGW; ++i) { |
546 | 414 | jbig2_free(ctx->allocator, GI[i]); |
547 | 414 | } |
548 | 28 | } |
549 | 28 | jbig2_free(ctx->allocator, GI); |
550 | 28 | jbig2_image_release(ctx, HSKIP); |
551 | | |
552 | 28 | return code; |
553 | 28 | } |
554 | | |
555 | | /** |
556 | | * jbig2_halftone_region: read a halftone region segment header |
557 | | **/ |
558 | | int |
559 | | jbig2_halftone_region(Jbig2Ctx *ctx, Jbig2Segment *segment, const byte *segment_data) |
560 | 30 | { |
561 | 30 | int offset = 0; |
562 | 30 | Jbig2RegionSegmentInfo region_info; |
563 | 30 | Jbig2HalftoneRegionParams params; |
564 | 30 | Jbig2Image *image = NULL; |
565 | 30 | Jbig2ArithCx *GB_stats = NULL; |
566 | 30 | int code = 0; |
567 | | |
568 | | /* 7.4.5.1 */ |
569 | 30 | if (segment->data_length < 17) |
570 | 0 | goto too_short; |
571 | 30 | jbig2_get_region_segment_info(®ion_info, segment_data); |
572 | 30 | offset += 17; |
573 | | |
574 | 30 | if (segment->data_length < 18) |
575 | 0 | goto too_short; |
576 | | |
577 | | /* 7.4.5.1.1 Figure 42 */ |
578 | 30 | params.flags = segment_data[offset]; |
579 | 30 | params.HMMR = params.flags & 1; |
580 | 30 | params.HTEMPLATE = (params.flags & 6) >> 1; |
581 | 30 | params.HENABLESKIP = (params.flags & 8) >> 3; |
582 | 30 | params.HCOMBOP = (Jbig2ComposeOp)((params.flags & 0x70) >> 4); |
583 | 30 | params.HDEFPIXEL = (params.flags & 0x80) >> 7; |
584 | 30 | offset += 1; |
585 | | |
586 | 30 | jbig2_error(ctx, JBIG2_SEVERITY_INFO, segment->number, |
587 | 30 | "halftone region: %u x %u @ (%u, %u), flags = %02x", region_info.width, region_info.height, region_info.x, region_info.y, params.flags); |
588 | | |
589 | 30 | if (params.HMMR && params.HTEMPLATE) { |
590 | 0 | jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "HTEMPLATE is %d when HMMR is %d, contrary to spec", params.HTEMPLATE, params.HMMR); |
591 | 0 | } |
592 | 30 | if (params.HMMR && params.HENABLESKIP) { |
593 | 0 | jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "HENABLESKIP is %d when HMMR is %d, contrary to spec", params.HENABLESKIP, params.HMMR); |
594 | 0 | } |
595 | | |
596 | | /* 7.4.5.1.2 Figure 43 */ |
597 | 30 | if (segment->data_length - offset < 16) |
598 | 0 | goto too_short; |
599 | 30 | params.HGW = jbig2_get_uint32(segment_data + offset); |
600 | 30 | params.HGH = jbig2_get_uint32(segment_data + offset + 4); |
601 | 30 | params.HGX = jbig2_get_int32(segment_data + offset + 8); |
602 | 30 | params.HGY = jbig2_get_int32(segment_data + offset + 12); |
603 | 30 | offset += 16; |
604 | | |
605 | | /* 7.4.5.1.3 Figure 44 */ |
606 | 30 | if (segment->data_length - offset < 4) |
607 | 0 | goto too_short; |
608 | 30 | params.HRX = jbig2_get_uint16(segment_data + offset); |
609 | 30 | params.HRY = jbig2_get_uint16(segment_data + offset + 2); |
610 | 30 | offset += 4; |
611 | | |
612 | 30 | jbig2_error(ctx, JBIG2_SEVERITY_INFO, segment->number, |
613 | 30 | "grid %d x %d @ (%d.%d,%d.%d) vector (%d.%d,%d.%d)", |
614 | 30 | params.HGW, params.HGH, |
615 | 30 | params.HGX >> 8, params.HGX & 0xff, |
616 | 30 | params.HGY >> 8, params.HGY & 0xff, |
617 | 30 | params.HRX >> 8, params.HRX & 0xff, |
618 | 30 | params.HRY >> 8, params.HRY & 0xff); |
619 | | |
620 | | /* 7.4.5.2 */ |
621 | 30 | if (!params.HMMR) { |
622 | | /* allocate and zero arithmetic coding stats */ |
623 | 27 | int stats_size = jbig2_generic_stats_size(ctx, params.HTEMPLATE); |
624 | | |
625 | 27 | GB_stats = jbig2_new(ctx, Jbig2ArithCx, stats_size); |
626 | 27 | if (GB_stats == NULL) { |
627 | 0 | return jbig2_error(ctx, JBIG2_SEVERITY_FATAL, segment->number, "failed to allocate arithmetic decoder states in halftone region"); |
628 | 0 | } |
629 | 27 | memset(GB_stats, 0, stats_size); |
630 | 27 | } |
631 | | |
632 | 30 | image = jbig2_image_new(ctx, region_info.width, region_info.height); |
633 | 30 | if (image == NULL) { |
634 | 2 | jbig2_free(ctx->allocator, GB_stats); |
635 | 2 | return jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to allocate halftone image"); |
636 | 2 | } |
637 | | |
638 | 28 | code = jbig2_decode_halftone_region(ctx, segment, ¶ms, segment_data + offset, segment->data_length - offset, image, GB_stats); |
639 | 28 | if (code < 0) { |
640 | 0 | jbig2_image_release(ctx, image); |
641 | 0 | jbig2_free(ctx->allocator, GB_stats); |
642 | 0 | return jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "failed to decode halftone region"); |
643 | 0 | } |
644 | | |
645 | | /* todo: retain GB_stats? */ |
646 | 28 | if (!params.HMMR) { |
647 | 27 | jbig2_free(ctx->allocator, GB_stats); |
648 | 27 | } |
649 | | |
650 | 28 | code = jbig2_page_add_result(ctx, &ctx->pages[ctx->current_page], image, region_info.x, region_info.y, region_info.op); |
651 | 28 | if (code < 0) { |
652 | 0 | jbig2_image_release(ctx, image); |
653 | 0 | return jbig2_error(ctx, JBIG2_SEVERITY_WARNING, segment->number, "unable to add halftone region to page"); |
654 | 0 | } |
655 | | |
656 | 28 | jbig2_image_release(ctx, image); |
657 | | |
658 | 28 | return code; |
659 | | |
660 | 0 | too_short: |
661 | 0 | return jbig2_error(ctx, JBIG2_SEVERITY_FATAL, segment->number, "segment too short"); |
662 | 28 | } |