zenjpeg 0.8.0

Pure Rust JPEG encoder/decoder with perceptual optimizations
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
//! Arithmetic scan decoding for JPEG.
//!
//! This module handles decoding of arithmetic-coded JPEG scans (SOF9/SOF10).

use crate::entropy::ArithmeticDecoder;
use crate::error::{Error, Result, ScanRead};
use crate::foundation::alloc::{checked_size_2d, try_alloc_dct_blocks, try_alloc_filled};
use enough::Stop;

use super::JpegParser;

/// Arithmetic scan decoding methods for JpegParser.
impl<'a> JpegParser<'a> {
    /// Decode an arithmetic-coded sequential scan.
    ///
    /// The `stop` parameter allows cancellation of long-running decodes.
    pub(super) fn decode_arithmetic_scan(
        &mut self,
        scan_components: &[(usize, u8, u8)],
        stop: &impl Stop,
    ) -> Result<()> {
        // DNL mode not supported
        if self.height == 0 {
            return Err(Error::unsupported_feature(
                "DNL mode (height=0 in SOF) not yet supported for arithmetic scan decoding",
            ));
        }

        // Calculate MCU structure
        let mut max_h_samp = 1u8;
        let mut max_v_samp = 1u8;
        for i in 0..self.num_components as usize {
            max_h_samp = max_h_samp.max(self.components[i].h_samp_factor);
            max_v_samp = max_v_samp.max(self.components[i].v_samp_factor);
        }

        let mcu_width = (max_h_samp as usize) * 8;
        let mcu_height = (max_v_samp as usize) * 8;
        let mcu_cols = (self.width as usize + mcu_width - 1) / mcu_width;
        let mcu_rows = (self.height as usize + mcu_height - 1) / mcu_height;

        // Initialize coefficient storage
        if self.coeffs.is_empty() {
            for i in 0..self.num_components as usize {
                let h_samp = self.components[i].h_samp_factor as usize;
                let v_samp = self.components[i].v_samp_factor as usize;
                let comp_blocks_h = checked_size_2d(mcu_cols, h_samp)?;
                let comp_blocks_v = checked_size_2d(mcu_rows, v_samp)?;
                let num_blocks = checked_size_2d(comp_blocks_h, comp_blocks_v)?;
                self.coeffs.push(try_alloc_dct_blocks(
                    num_blocks,
                    "allocating DCT coefficients",
                )?);
                self.coeff_counts.push(try_alloc_filled(
                    num_blocks,
                    64u8,
                    "allocating coefficient counts",
                )?);
                self.nonzero_bitmaps.push(try_alloc_filled(
                    num_blocks,
                    0u64,
                    "allocating nonzero bitmaps",
                )?);
            }
        }

        // Set up arithmetic decoder
        let scan_data = &self.data[self.position..];
        let mut decoder = ArithmeticDecoder::new(scan_data);

        // Configure decoder with conditioning parameters and restart interval
        decoder.set_restart_interval(self.restart_interval);
        for tbl in 0..4 {
            let (l, u) = self.arith_dc_cond[tbl];
            decoder.set_dc_conditioning(tbl, l, u);
            decoder.set_ac_conditioning(tbl, self.arith_ac_kx[tbl]);
        }

        // Reset decoder for this scan
        decoder.reset_for_scan();

        // Decode MCUs
        for mcu_y in 0..mcu_rows {
            // Check for cancellation at each MCU row
            if stop.should_stop() {
                return Err(Error::cancelled());
            }

            for mcu_x in 0..mcu_cols {
                // For each component in the scan
                for (comp_idx, dc_table, ac_table) in scan_components {
                    let h_samp = self.components[*comp_idx].h_samp_factor as usize;
                    let v_samp = self.components[*comp_idx].v_samp_factor as usize;
                    let comp_blocks_h = mcu_cols * h_samp;

                    // Decode all blocks for this component in this MCU
                    for v in 0..v_samp {
                        for h in 0..h_samp {
                            let block_x = mcu_x * h_samp + h;
                            let block_y = mcu_y * v_samp + v;
                            let block_idx = block_y * comp_blocks_h + block_x;

                            // Decode block
                            match decoder.decode_block(
                                &mut self.coeffs[*comp_idx][block_idx],
                                *comp_idx,
                                *dc_table as usize,
                                *ac_table as usize,
                            )? {
                                ScanRead::Value(()) => {
                                    // Count non-zero coefficients (approximation for tiered IDCT)
                                    let block = &self.coeffs[*comp_idx][block_idx];
                                    let mut count = 0u8;
                                    for (i, &coef) in block.iter().enumerate() {
                                        if coef != 0 {
                                            count = (i + 1) as u8;
                                        }
                                    }
                                    self.coeff_counts[*comp_idx][block_idx] = count.max(1);
                                }
                                ScanRead::EndOfScan | ScanRead::Truncated => {
                                    // Handle truncation - zero remaining blocks
                                    self.coeffs[*comp_idx][block_idx] = [0i16; 64];
                                    self.coeff_counts[*comp_idx][block_idx] = 1;
                                }
                            }
                        }
                    }
                }
            }
        }

        self.position += decoder.position();
        Ok(())
    }

    /// Decode an arithmetic-coded progressive scan.
    ///
    /// The `stop` parameter allows cancellation of long-running decodes.
    pub(super) fn decode_arithmetic_progressive_scan(
        &mut self,
        scan_components: &[(usize, u8, u8)],
        ss: u8,
        se: u8,
        ah: u8,
        al: u8,
        stop: &impl Stop,
    ) -> Result<()> {
        // DNL mode not supported
        if self.height == 0 {
            return Err(Error::unsupported_feature(
                "DNL mode (height=0 in SOF) not supported for progressive scan",
            ));
        }

        // Calculate MCU structure
        let mut max_h_samp = 1u8;
        let mut max_v_samp = 1u8;
        for i in 0..self.num_components as usize {
            max_h_samp = max_h_samp.max(self.components[i].h_samp_factor);
            max_v_samp = max_v_samp.max(self.components[i].v_samp_factor);
        }

        let mcu_width = (max_h_samp as usize) * 8;
        let mcu_height = (max_v_samp as usize) * 8;
        let mcu_cols = (self.width as usize + mcu_width - 1) / mcu_width;
        let mcu_rows = (self.height as usize + mcu_height - 1) / mcu_height;

        // Initialize coefficient storage if needed
        if self.coeffs.is_empty() {
            for i in 0..self.num_components as usize {
                let h_samp = self.components[i].h_samp_factor as usize;
                let v_samp = self.components[i].v_samp_factor as usize;
                let comp_blocks_h = checked_size_2d(mcu_cols, h_samp)?;
                let comp_blocks_v = checked_size_2d(mcu_rows, v_samp)?;
                let num_blocks = checked_size_2d(comp_blocks_h, comp_blocks_v)?;
                self.coeffs.push(try_alloc_dct_blocks(
                    num_blocks,
                    "allocating DCT coefficients",
                )?);
                self.coeff_counts.push(try_alloc_filled(
                    num_blocks,
                    64u8,
                    "allocating coefficient counts",
                )?);
                self.nonzero_bitmaps.push(try_alloc_filled(
                    num_blocks,
                    0u64,
                    "allocating nonzero bitmaps",
                )?);
            }
        }

        // Set up arithmetic decoder
        let scan_data = &self.data[self.position..];
        let mut decoder = ArithmeticDecoder::new(scan_data);

        // Configure decoder
        decoder.set_restart_interval(self.restart_interval);
        for tbl in 0..4 {
            let (l, u) = self.arith_dc_cond[tbl];
            decoder.set_dc_conditioning(tbl, l, u);
            decoder.set_ac_conditioning(tbl, self.arith_ac_kx[tbl]);
        }

        // Reset for scan (clears stats appropriate for this scan type)
        decoder.reset_for_scan();

        let is_dc_scan = ss == 0;
        let is_first_scan = ah == 0;

        if is_dc_scan {
            // DC scan
            if is_first_scan {
                self.decode_arith_dc_first(
                    &mut decoder,
                    scan_components,
                    mcu_cols,
                    mcu_rows,
                    al,
                    stop,
                )?;
            } else {
                self.decode_arith_dc_refine(
                    &mut decoder,
                    scan_components,
                    mcu_cols,
                    mcu_rows,
                    al,
                    stop,
                )?;
            }
        } else {
            // AC scan (single component only)
            if scan_components.len() != 1 {
                return Err(Error::invalid_jpeg_data(
                    "progressive AC scan must have exactly one component",
                ));
            }
            let (comp_idx, _dc_tbl, ac_tbl) = scan_components[0];

            if is_first_scan {
                self.decode_arith_ac_first(
                    &mut decoder,
                    comp_idx,
                    ac_tbl as usize,
                    mcu_cols,
                    mcu_rows,
                    ss,
                    se,
                    al,
                    stop,
                )?;
            } else {
                self.decode_arith_ac_refine(
                    &mut decoder,
                    comp_idx,
                    ac_tbl as usize,
                    mcu_cols,
                    mcu_rows,
                    ss,
                    se,
                    al,
                    stop,
                )?;
            }
        }

        self.position += decoder.position();
        Ok(())
    }

    /// Decode DC first scan (progressive arithmetic).
    fn decode_arith_dc_first(
        &mut self,
        decoder: &mut ArithmeticDecoder,
        scan_components: &[(usize, u8, u8)],
        mcu_cols: usize,
        mcu_rows: usize,
        al: u8,
        stop: &impl Stop,
    ) -> Result<()> {
        for mcu_y in 0..mcu_rows {
            // Check for cancellation at each MCU row
            if stop.should_stop() {
                return Err(Error::cancelled());
            }

            for mcu_x in 0..mcu_cols {
                for (comp_idx, dc_tbl, _ac_tbl) in scan_components {
                    let h_samp = self.components[*comp_idx].h_samp_factor as usize;
                    let v_samp = self.components[*comp_idx].v_samp_factor as usize;
                    let comp_blocks_h = mcu_cols * h_samp;

                    for v in 0..v_samp {
                        for h in 0..h_samp {
                            let block_x = mcu_x * h_samp + h;
                            let block_y = mcu_y * v_samp + v;
                            let block_idx = block_y * comp_blocks_h + block_x;

                            match decoder.decode_dc_first(*comp_idx, *dc_tbl as usize, al)? {
                                ScanRead::Value(dc) => {
                                    self.coeffs[*comp_idx][block_idx][0] = dc;
                                }
                                ScanRead::EndOfScan | ScanRead::Truncated => {
                                    // Truncated - leave as zero
                                }
                            }
                        }
                    }
                }
            }
        }
        Ok(())
    }

    /// Decode DC refinement scan (progressive arithmetic).
    fn decode_arith_dc_refine(
        &mut self,
        decoder: &mut ArithmeticDecoder,
        scan_components: &[(usize, u8, u8)],
        mcu_cols: usize,
        mcu_rows: usize,
        al: u8,
        stop: &impl Stop,
    ) -> Result<()> {
        for mcu_y in 0..mcu_rows {
            // Check for cancellation at each MCU row
            if stop.should_stop() {
                return Err(Error::cancelled());
            }

            for mcu_x in 0..mcu_cols {
                for (comp_idx, _dc_tbl, _ac_tbl) in scan_components {
                    let h_samp = self.components[*comp_idx].h_samp_factor as usize;
                    let v_samp = self.components[*comp_idx].v_samp_factor as usize;
                    let comp_blocks_h = mcu_cols * h_samp;

                    for v in 0..v_samp {
                        for h in 0..h_samp {
                            let block_x = mcu_x * h_samp + h;
                            let block_y = mcu_y * v_samp + v;
                            let block_idx = block_y * comp_blocks_h + block_x;

                            decoder.decode_dc_refine(&mut self.coeffs[*comp_idx][block_idx], al)?;
                        }
                    }
                }
            }
        }
        Ok(())
    }

    /// Decode AC first scan (progressive arithmetic).
    #[allow(clippy::too_many_arguments)]
    fn decode_arith_ac_first(
        &mut self,
        decoder: &mut ArithmeticDecoder,
        comp_idx: usize,
        ac_tbl: usize,
        mcu_cols: usize,
        mcu_rows: usize,
        ss: u8,
        se: u8,
        al: u8,
        stop: &impl Stop,
    ) -> Result<()> {
        let h_samp = self.components[comp_idx].h_samp_factor as usize;
        let v_samp = self.components[comp_idx].v_samp_factor as usize;
        let comp_blocks_h = mcu_cols * h_samp;
        let comp_blocks_v = mcu_rows * v_samp;

        // AC progressive scans process blocks in raster order (not MCU order)
        for block_y in 0..comp_blocks_v {
            // Check for cancellation at each block row
            if stop.should_stop() {
                return Err(Error::cancelled());
            }

            for block_x in 0..comp_blocks_h {
                let block_idx = block_y * comp_blocks_h + block_x;
                decoder.decode_ac_first(
                    &mut self.coeffs[comp_idx][block_idx],
                    &mut self.nonzero_bitmaps[comp_idx][block_idx],
                    ac_tbl,
                    ss,
                    se,
                    al,
                )?;
            }
        }
        Ok(())
    }

    /// Decode AC refinement scan (progressive arithmetic).
    #[allow(clippy::too_many_arguments)]
    fn decode_arith_ac_refine(
        &mut self,
        decoder: &mut ArithmeticDecoder,
        comp_idx: usize,
        ac_tbl: usize,
        mcu_cols: usize,
        mcu_rows: usize,
        ss: u8,
        se: u8,
        al: u8,
        stop: &impl Stop,
    ) -> Result<()> {
        let h_samp = self.components[comp_idx].h_samp_factor as usize;
        let v_samp = self.components[comp_idx].v_samp_factor as usize;
        let comp_blocks_h = mcu_cols * h_samp;
        let comp_blocks_v = mcu_rows * v_samp;

        for block_y in 0..comp_blocks_v {
            // Check for cancellation at each block row
            if stop.should_stop() {
                return Err(Error::cancelled());
            }

            for block_x in 0..comp_blocks_h {
                let block_idx = block_y * comp_blocks_h + block_x;
                decoder.decode_ac_refine(
                    &mut self.coeffs[comp_idx][block_idx],
                    &mut self.nonzero_bitmaps[comp_idx][block_idx],
                    ac_tbl,
                    ss,
                    se,
                    al,
                )?;
            }
        }
        Ok(())
    }
}