j2k-native 0.6.2

Pure-Rust JPEG 2000 and HTJ2K codec engine for j2k
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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
use j2k_native::{
    encode, encode_component_planes_53, encode_precomputed_htj2k_53, encode_precomputed_htj2k_97,
    encode_precomputed_j2k_53, DecodeSettings, DecoderContext, EncodeComponentPlane, EncodeOptions,
    Image, J2kForwardDwt53Level, J2kForwardDwt53Output, J2kForwardDwt97Level,
    J2kForwardDwt97Output, PrecomputedHtj2k53Component, PrecomputedHtj2k53Image,
    PrecomputedHtj2k97Component, PrecomputedHtj2k97Image,
};

#[test]
fn native_encode_rejects_dimension_overflow_before_length_check() {
    let err = encode(
        &[0; 16],
        u32::MAX,
        u32::MAX,
        4,
        16,
        false,
        &EncodeOptions::default(),
    )
    .expect_err("dimension overflow should be rejected");

    assert_eq!(err, "image dimensions overflow");
}

#[test]
fn native_decode_rejects_zero_target_resolution() {
    let bytes = encode(
        &[10, 20, 30, 40],
        2,
        2,
        1,
        8,
        false,
        &EncodeOptions::default(),
    )
    .expect("encode fixture");
    let settings = DecodeSettings {
        target_resolution: Some((0, 1)),
        ..DecodeSettings::default()
    };

    assert!(Image::new(&bytes, &settings).is_err());
}

#[test]
fn jp2_decode_rejects_short_channel_definition_box() {
    let codestream = encode(
        &[10, 20, 30, 40, 50, 60],
        2,
        1,
        3,
        8,
        false,
        &EncodeOptions::default(),
    )
    .expect("encode RGB fixture");
    let jp2 = wrap_codestream_jp2_with_short_cdef(&codestream, 2, 1, 3, 8);

    let image = Image::new(&jp2, &DecodeSettings::default()).expect("parse JP2 fixture");
    let err = image
        .decode()
        .expect_err("short cdef must not silently drop a component");

    assert_eq!(err.to_string(), "invalid channel definition");
}

#[test]
fn precomputed_zero_grayscale_53_coefficients_decode_with_native_decoder() {
    let image = PrecomputedHtj2k53Image {
        width: 8,
        height: 8,
        bit_depth: 8,
        signed: false,
        components: vec![PrecomputedHtj2k53Component {
            x_rsiz: 1,
            y_rsiz: 1,
            dwt: zero_dwt53(8, 8),
        }],
    };
    let bytes = encode_precomputed_htj2k_53(&image, &precomputed_options())
        .expect("encode precomputed HTJ2K coefficients");
    let decoded = Image::new(&bytes, &DecodeSettings::default())
        .expect("native parser accepts codestream")
        .decode_native()
        .expect("native decoder accepts codestream");

    assert_eq!((decoded.width, decoded.height), (8, 8));
    assert_eq!(decoded.num_components, 1);
    assert!(decoded.data.iter().all(|&sample| sample == 128));
}

#[test]
fn precomputed_53_encode_roundtrips_more_than_four_components() {
    let image = PrecomputedHtj2k53Image {
        width: 8,
        height: 8,
        bit_depth: 8,
        signed: false,
        components: (0..5)
            .map(|_| PrecomputedHtj2k53Component {
                x_rsiz: 1,
                y_rsiz: 1,
                dwt: zero_dwt53(8, 8),
            })
            .collect(),
    };
    let bytes = encode_precomputed_htj2k_53(&image, &precomputed_options())
        .expect("encode five-component precomputed 5/3 HTJ2K coefficients");
    let decoded = Image::new(&bytes, &DecodeSettings::default())
        .expect("native parser accepts five-component codestream")
        .decode_native()
        .expect("native decoder accepts five-component codestream");

    assert_eq!((decoded.width, decoded.height), (8, 8));
    assert_eq!(decoded.num_components, 5);
    assert_eq!(decoded.data.len(), 8 * 8 * 5);
    assert!(decoded.data.iter().all(|&sample| sample == 128));
}

#[test]
fn precomputed_encode_writes_component_sampling_in_siz() {
    let image = PrecomputedHtj2k53Image {
        width: 16,
        height: 16,
        bit_depth: 8,
        signed: false,
        components: vec![
            PrecomputedHtj2k53Component {
                x_rsiz: 1,
                y_rsiz: 1,
                dwt: zero_dwt53(16, 16),
            },
            PrecomputedHtj2k53Component {
                x_rsiz: 2,
                y_rsiz: 2,
                dwt: zero_dwt53(8, 8),
            },
            PrecomputedHtj2k53Component {
                x_rsiz: 2,
                y_rsiz: 2,
                dwt: zero_dwt53(8, 8),
            },
        ],
    };
    let bytes = encode_precomputed_htj2k_53(&image, &precomputed_options())
        .expect("encode precomputed subsampled HTJ2K coefficients");
    let siz = find_marker(&bytes, 0x51).expect("SIZ marker");
    let component_info = siz + 40;

    assert_eq!(bytes[component_info + 1], 1);
    assert_eq!(bytes[component_info + 2], 1);
    assert_eq!(bytes[component_info + 4], 2);
    assert_eq!(bytes[component_info + 5], 2);
    assert_eq!(bytes[component_info + 7], 2);
    assert_eq!(bytes[component_info + 8], 2);

    let image = Image::new(&bytes, &DecodeSettings::default()).expect("parse sampled codestream");
    let mut context = DecoderContext::default();
    let components = image
        .decode_components_with_context(&mut context)
        .expect("decode sampled component planes");
    let sampling = components
        .planes()
        .iter()
        .map(|plane| plane.sampling())
        .collect::<Vec<_>>();
    assert_eq!(sampling, [(1, 1), (2, 2), (2, 2)]);
}

#[test]
fn precomputed_classic_53_encode_preserves_component_sampling_in_siz() {
    let image = PrecomputedHtj2k53Image {
        width: 16,
        height: 16,
        bit_depth: 8,
        signed: false,
        components: vec![
            PrecomputedHtj2k53Component {
                x_rsiz: 1,
                y_rsiz: 1,
                dwt: zero_dwt53(16, 16),
            },
            PrecomputedHtj2k53Component {
                x_rsiz: 2,
                y_rsiz: 2,
                dwt: zero_dwt53(8, 8),
            },
            PrecomputedHtj2k53Component {
                x_rsiz: 2,
                y_rsiz: 2,
                dwt: zero_dwt53(8, 8),
            },
        ],
    };

    let bytes = encode_precomputed_j2k_53(&image, &precomputed_options())
        .expect("encode precomputed sampled classic J2K coefficients");
    let decoded = Image::new(&bytes, &DecodeSettings::default())
        .expect("native parser accepts sampled classic codestream")
        .decode_native()
        .expect("native decoder accepts sampled classic codestream");

    assert_eq!((decoded.width, decoded.height), (16, 16));
    assert_eq!(decoded.num_components, 3);

    let image = Image::new(&bytes, &DecodeSettings::default()).expect("parse sampled codestream");
    let mut context = DecoderContext::default();
    let components = image
        .decode_components_with_context(&mut context)
        .expect("decode sampled classic component planes");
    let sampling = components
        .planes()
        .iter()
        .map(|plane| plane.sampling())
        .collect::<Vec<_>>();
    assert_eq!(sampling, [(1, 1), (2, 2), (2, 2)]);
}

#[test]
fn component_plane_53_encode_preserves_sampling_for_classic_and_htj2k() {
    let luma = vec![128_u8; 16 * 16];
    let chroma_blue = vec![96_u8; 8 * 8];
    let chroma_red = vec![160_u8; 8 * 8];
    let planes = [
        EncodeComponentPlane {
            data: &luma,
            x_rsiz: 1,
            y_rsiz: 1,
        },
        EncodeComponentPlane {
            data: &chroma_blue,
            x_rsiz: 2,
            y_rsiz: 2,
        },
        EncodeComponentPlane {
            data: &chroma_red,
            x_rsiz: 2,
            y_rsiz: 2,
        },
    ];

    for use_ht_block_coding in [false, true] {
        let options = EncodeOptions {
            reversible: true,
            use_ht_block_coding,
            num_decomposition_levels: 1,
            use_mct: false,
            validate_high_throughput_codestream: false,
            ..EncodeOptions::default()
        };
        let bytes = encode_component_planes_53(&planes, 16, 16, 8, false, &options)
            .expect("component-plane encode");
        let image = Image::new(&bytes, &DecodeSettings::default()).expect("parse codestream");
        let mut context = DecoderContext::default();
        let components = image
            .decode_components_with_context(&mut context)
            .expect("decode component planes");
        let sampling = components
            .planes()
            .iter()
            .map(|plane| plane.sampling())
            .collect::<Vec<_>>();

        assert_eq!(sampling, [(1, 1), (2, 2), (2, 2)]);
    }
}

#[test]
fn raw_pixel_encode_rejects_component_sampling_without_component_sized_dwt() {
    let pixels = vec![0; 16 * 16 * 3];
    let options = EncodeOptions {
        reversible: true,
        num_decomposition_levels: 1,
        use_mct: false,
        component_sampling: Some(vec![(1, 1), (2, 2), (2, 2)]),
        ..EncodeOptions::default()
    };

    let err = encode(&pixels, 16, 16, 3, 8, false, &options)
        .expect_err("raw pixel encode cannot infer sampled component grids");

    assert_eq!(
        err,
        "component sampling requires component-sized DWT geometry"
    );
}

#[test]
fn precomputed_encode_rejects_component_sampling_geometry_mismatch() {
    let image = PrecomputedHtj2k53Image {
        width: 16,
        height: 16,
        bit_depth: 8,
        signed: false,
        components: vec![PrecomputedHtj2k53Component {
            x_rsiz: 2,
            y_rsiz: 2,
            dwt: zero_dwt53(16, 16),
        }],
    };

    let err = encode_precomputed_htj2k_53(&image, &precomputed_options())
        .expect_err("component DWT geometry must match SIZ sampling");

    assert_eq!(err, "precomputed DWT component dimensions mismatch");
}

#[test]
fn precomputed_encode_rejects_recursive_level_geometry_mismatch() {
    let mut dwt = zero_dwt53(8, 8);
    dwt.levels[0].low_width = 3;
    let image = PrecomputedHtj2k53Image {
        width: 8,
        height: 8,
        bit_depth: 8,
        signed: false,
        components: vec![PrecomputedHtj2k53Component {
            x_rsiz: 1,
            y_rsiz: 1,
            dwt,
        }],
    };

    let err = encode_precomputed_htj2k_53(&image, &precomputed_options())
        .expect_err("level geometry must match recursive 5/3 expectations");

    assert_eq!(err, "precomputed DWT recursive geometry mismatch");
}

#[test]
fn precomputed_zero_grayscale_97_coefficients_decode_with_native_decoder() {
    let image = PrecomputedHtj2k97Image {
        width: 8,
        height: 8,
        bit_depth: 8,
        signed: false,
        components: vec![PrecomputedHtj2k97Component {
            x_rsiz: 1,
            y_rsiz: 1,
            dwt: zero_dwt97(8, 8),
        }],
    };
    let bytes = encode_precomputed_htj2k_97(&image, &precomputed_lossy_options())
        .expect("encode precomputed 9/7 HTJ2K coefficients");
    let decoded = Image::new(&bytes, &DecodeSettings::default())
        .expect("native parser accepts 9/7 codestream")
        .decode_native()
        .expect("native decoder accepts 9/7 codestream");

    assert_eq!((decoded.width, decoded.height), (8, 8));
    assert_eq!(decoded.num_components, 1);
    assert!(decoded.data.iter().all(|&sample| sample == 128));
}

#[test]
fn precomputed_97_encode_roundtrips_more_than_four_components() {
    let image = PrecomputedHtj2k97Image {
        width: 8,
        height: 8,
        bit_depth: 8,
        signed: false,
        components: (0..5)
            .map(|_| PrecomputedHtj2k97Component {
                x_rsiz: 1,
                y_rsiz: 1,
                dwt: zero_dwt97(8, 8),
            })
            .collect(),
    };
    let bytes = encode_precomputed_htj2k_97(&image, &precomputed_lossy_options())
        .expect("encode five-component precomputed 9/7 HTJ2K coefficients");
    let decoded = Image::new(&bytes, &DecodeSettings::default())
        .expect("native parser accepts five-component 9/7 codestream")
        .decode_native()
        .expect("native decoder accepts five-component 9/7 codestream");

    assert_eq!((decoded.width, decoded.height), (8, 8));
    assert_eq!(decoded.num_components, 5);
    assert_eq!(decoded.data.len(), 8 * 8 * 5);
    assert!(decoded.data.iter().all(|&sample| sample == 128));
}

#[test]
fn precomputed_97_encode_rejects_component_sampling_geometry_mismatch() {
    let image = PrecomputedHtj2k97Image {
        width: 16,
        height: 16,
        bit_depth: 8,
        signed: false,
        components: vec![PrecomputedHtj2k97Component {
            x_rsiz: 2,
            y_rsiz: 2,
            dwt: zero_dwt97(16, 16),
        }],
    };

    let err = encode_precomputed_htj2k_97(&image, &precomputed_lossy_options())
        .expect_err("component DWT geometry must match SIZ sampling");

    assert_eq!(err, "precomputed DWT component dimensions mismatch");
}

fn precomputed_options() -> EncodeOptions {
    EncodeOptions {
        num_decomposition_levels: 1,
        reversible: true,
        use_ht_block_coding: true,
        use_mct: false,
        validate_high_throughput_codestream: false,
        ..EncodeOptions::default()
    }
}

fn precomputed_lossy_options() -> EncodeOptions {
    EncodeOptions {
        num_decomposition_levels: 1,
        reversible: false,
        use_ht_block_coding: true,
        use_mct: false,
        validate_high_throughput_codestream: false,
        ..EncodeOptions::default()
    }
}

fn zero_dwt53(width: u32, height: u32) -> J2kForwardDwt53Output {
    let low_width = width.div_ceil(2);
    let low_height = height.div_ceil(2);
    let high_width = width / 2;
    let high_height = height / 2;

    J2kForwardDwt53Output {
        ll: vec![0.0; (low_width * low_height) as usize],
        ll_width: low_width,
        ll_height: low_height,
        levels: vec![J2kForwardDwt53Level {
            hl: vec![0.0; (high_width * low_height) as usize],
            lh: vec![0.0; (low_width * high_height) as usize],
            hh: vec![0.0; (high_width * high_height) as usize],
            width,
            height,
            low_width,
            low_height,
            high_width,
            high_height,
        }],
    }
}

fn zero_dwt97(width: u32, height: u32) -> J2kForwardDwt97Output {
    let low_width = width.div_ceil(2);
    let low_height = height.div_ceil(2);
    let high_width = width / 2;
    let high_height = height / 2;

    J2kForwardDwt97Output {
        ll: vec![0.0; (low_width * low_height) as usize],
        ll_width: low_width,
        ll_height: low_height,
        levels: vec![J2kForwardDwt97Level {
            hl: vec![0.0; (high_width * low_height) as usize],
            lh: vec![0.0; (low_width * high_height) as usize],
            hh: vec![0.0; (high_width * high_height) as usize],
            width,
            height,
            low_width,
            low_height,
            high_width,
            high_height,
        }],
    }
}

fn find_marker(codestream: &[u8], marker: u8) -> Option<usize> {
    codestream
        .windows(2)
        .position(|window| window == [0xff, marker])
}

fn wrap_codestream_jp2_with_short_cdef(
    codestream: &[u8],
    width: u32,
    height: u32,
    components: u16,
    bit_depth: u8,
) -> Vec<u8> {
    let mut bytes = Vec::new();
    push_box(&mut bytes, b"jP  ", &[0x0D, 0x0A, 0x87, 0x0A]);
    push_box(
        &mut bytes,
        b"ftyp",
        &[b'j', b'p', b'2', b' ', 0, 0, 0, 0, b'j', b'p', b'2', b' '],
    );

    let mut jp2h = Vec::new();
    let mut ihdr = Vec::new();
    ihdr.extend_from_slice(&height.to_be_bytes());
    ihdr.extend_from_slice(&width.to_be_bytes());
    ihdr.extend_from_slice(&components.to_be_bytes());
    ihdr.extend_from_slice(&[bit_depth.saturating_sub(1), 7, 0, 0]);
    push_box(&mut jp2h, b"ihdr", &ihdr);

    let mut colr = vec![1, 0, 0];
    colr.extend_from_slice(&16_u32.to_be_bytes());
    push_box(&mut jp2h, b"colr", &colr);

    let mut cdef = Vec::new();
    cdef.extend_from_slice(&2_u16.to_be_bytes());
    for (channel_index, association) in [(0_u16, 1_u16), (1, 2)] {
        cdef.extend_from_slice(&channel_index.to_be_bytes());
        cdef.extend_from_slice(&0_u16.to_be_bytes());
        cdef.extend_from_slice(&association.to_be_bytes());
    }
    push_box(&mut jp2h, b"cdef", &cdef);

    push_box(&mut bytes, b"jp2h", &jp2h);
    push_box(&mut bytes, b"jp2c", codestream);
    bytes
}

fn push_box(bytes: &mut Vec<u8>, box_type: &[u8; 4], payload: &[u8]) {
    let len = (8 + payload.len()) as u32;
    bytes.extend_from_slice(&len.to_be_bytes());
    bytes.extend_from_slice(box_type);
    bytes.extend_from_slice(payload);
}