openjph-core 0.1.0

HTJ2K (JPEG 2000 Part 15) codec library — pure Rust port of OpenJPH
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
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
//! Error handling and edge case tests for the OpenJPH-RS codec.
//!
//! Tests invalid parameters, truncated codestreams, boundary conditions,
//! and other edge cases that should be handled gracefully.

mod common;

use openjph_core::codestream::Codestream;
use openjph_core::file::{MemInfile, MemOutfile};
use openjph_core::types::{Point, Size};

// ============================================================================
// Invalid parameter tests
// ============================================================================

/// Attempting to write headers without setting image dimensions should fail.
#[test]
fn error_no_siz_set() {
    let mut cs = Codestream::new();
    // Only set num_components, but not image extent
    cs.access_siz_mut().set_num_components(1);
    cs.access_siz_mut()
        .set_comp_info(0, Point::new(1, 1), 8, false);
    let mut outfile = MemOutfile::new();
    // Missing image extent — should error or produce minimal output
    let result = cs.write_headers(&mut outfile, &[]);
    // It's valid for the codec to either error here or produce a degenerate stream
    let _ = result;
}

/// Truncated codestream: just a SOC marker (0xFF4F)
#[test]
fn error_truncated_soc_only() {
    let data = [0xFF, 0x4F]; // SOC marker only
    let mut cs = Codestream::new();
    let mut infile = MemInfile::new(&data);
    let result = cs.read_headers(&mut infile);
    assert!(
        result.is_err(),
        "truncated codestream after SOC should fail"
    );
}

/// Empty codestream
#[test]
fn error_empty_codestream() {
    let data: [u8; 0] = [];
    let mut cs = Codestream::new();
    let mut infile = MemInfile::new(&data);
    let result = cs.read_headers(&mut infile);
    assert!(result.is_err(), "empty codestream should fail");
}

/// Random garbage data
#[test]
fn error_garbage_data() {
    let data = [0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07];
    let mut cs = Codestream::new();
    let mut infile = MemInfile::new(&data);
    let result = cs.read_headers(&mut infile);
    assert!(result.is_err(), "garbage data should fail header parse");
}

/// SOC + partial SIZ marker (truncated)
#[test]
fn error_truncated_siz() {
    let data = [
        0xFF, 0x4F, // SOC
        0xFF, 0x51, // SIZ marker
        0x00, 0x10, // Lsiz = 16 (but data stops here)
    ];
    let mut cs = Codestream::new();
    let mut infile = MemInfile::new(&data);
    let result = cs.read_headers(&mut infile);
    assert!(result.is_err(), "truncated SIZ should fail");
}

/// Valid encoding followed by decode of truncated J2K data
#[test]
fn error_truncated_encoded_data() {
    // First, generate valid J2K data
    let mut cs = Codestream::new();
    {
        let siz = cs.access_siz_mut();
        siz.set_image_extent(Point::new(16, 16));
        siz.set_tile_size(Size::new(16, 16));
        siz.set_num_components(1);
        siz.set_comp_info(0, Point::new(1, 1), 8, false);
    }
    {
        let cod = cs.access_cod_mut();
        cod.set_reversible(true);
        cod.set_color_transform(false);
        cod.set_num_decomposition(2);
    }
    let mut outfile = MemOutfile::new();
    cs.write_headers(&mut outfile, &[]).unwrap();
    for y in 0..16u32 {
        let line: Vec<i32> = (0..16).map(|x| ((x + y * 16) % 256) as i32).collect();
        cs.exchange(&line, 0).unwrap();
    }
    cs.flush(&mut outfile).unwrap();
    let full_data = outfile.get_data().to_vec();
    assert!(full_data.len() > 20);

    // Truncate at ~75% of the data
    let trunc_len = full_data.len() * 3 / 4;
    let truncated = &full_data[..trunc_len];

    // Try to decode truncated data — may error or produce partial results
    let mut cs2 = Codestream::new();
    let mut infile = MemInfile::new(truncated);
    let header_result = cs2.read_headers(&mut infile);
    if header_result.is_ok() {
        // Headers might parse fine; create may fail
        let create_result = cs2.create(&mut infile);
        // Either create fails, or pull produces partial/incorrect data
        // The key is it doesn't panic
        if create_result.is_ok() {
            for _ in 0..16 {
                let _ = cs2.pull(0);
            }
        }
    }
    // If we get here without panic, the test passes
}

// ============================================================================
// Edge case: minimum and maximum dimensions
// ============================================================================

/// 1×1 image roundtrip
#[test]
fn edge_1x1_image() {
    let mut cs = Codestream::new();
    {
        let siz = cs.access_siz_mut();
        siz.set_image_extent(Point::new(1, 1));
        siz.set_tile_size(Size::new(1, 1));
        siz.set_num_components(1);
        siz.set_comp_info(0, Point::new(1, 1), 8, false);
    }
    {
        let cod = cs.access_cod_mut();
        cod.set_reversible(true);
        cod.set_color_transform(false);
        cod.set_num_decomposition(0);
    }
    let mut outfile = MemOutfile::new();
    cs.write_headers(&mut outfile, &[]).unwrap();
    cs.exchange(&[42], 0).unwrap();
    cs.flush(&mut outfile).unwrap();

    let data = outfile.get_data().to_vec();
    let mut cs2 = Codestream::new();
    let mut infile = MemInfile::new(&data);
    cs2.read_headers(&mut infile).unwrap();
    cs2.create(&mut infile).unwrap();
    let line = cs2.pull(0).unwrap();
    assert_eq!(line[0], 42, "1×1 roundtrip must preserve the single pixel");
}

/// 2×2 image roundtrip
#[test]
fn edge_2x2_image() {
    let mut cs = Codestream::new();
    {
        let siz = cs.access_siz_mut();
        siz.set_image_extent(Point::new(2, 2));
        siz.set_tile_size(Size::new(2, 2));
        siz.set_num_components(1);
        siz.set_comp_info(0, Point::new(1, 1), 8, false);
    }
    {
        let cod = cs.access_cod_mut();
        cod.set_reversible(true);
        cod.set_color_transform(false);
        cod.set_num_decomposition(1);
    }
    let mut outfile = MemOutfile::new();
    cs.write_headers(&mut outfile, &[]).unwrap();
    cs.exchange(&[10, 20], 0).unwrap();
    cs.exchange(&[30, 40], 0).unwrap();
    cs.flush(&mut outfile).unwrap();

    let data = outfile.get_data().to_vec();
    let mut cs2 = Codestream::new();
    let mut infile = MemInfile::new(&data);
    cs2.read_headers(&mut infile).unwrap();
    cs2.create(&mut infile).unwrap();
    let line0 = cs2.pull(0).unwrap();
    let line1 = cs2.pull(0).unwrap();
    assert_eq!(&line0, &[10, 20]);
    assert_eq!(&line1, &[30, 40]);
}

/// Very narrow image: 1×64
#[test]
#[allow(non_snake_case)]
fn edge_1xN_image() {
    let w = 1u32;
    let h = 64u32;
    let mut cs = Codestream::new();
    {
        let siz = cs.access_siz_mut();
        siz.set_image_extent(Point::new(w, h));
        siz.set_tile_size(Size::new(w, h));
        siz.set_num_components(1);
        siz.set_comp_info(0, Point::new(1, 1), 8, false);
    }
    {
        let cod = cs.access_cod_mut();
        cod.set_reversible(true);
        cod.set_color_transform(false);
        cod.set_num_decomposition(3);
    }
    let mut outfile = MemOutfile::new();
    cs.write_headers(&mut outfile, &[]).unwrap();
    for y in 0..h {
        cs.exchange(&[(y % 256) as i32], 0).unwrap();
    }
    cs.flush(&mut outfile).unwrap();

    let data = outfile.get_data().to_vec();
    let mut cs2 = Codestream::new();
    let mut infile = MemInfile::new(&data);
    cs2.read_headers(&mut infile).unwrap();
    cs2.create(&mut infile).unwrap();

    for y in 0..h {
        let line = cs2.pull(0).unwrap();
        assert_eq!(line[0], (y % 256) as i32, "line {} mismatch", y);
    }
}

/// Very wide image: 64×1
#[test]
#[allow(non_snake_case)]
fn edge_Nx1_image() {
    let w = 64u32;
    let h = 1u32;
    let pixels: Vec<i32> = (0..64).map(|x| (x * 4) % 256).collect();
    let mut cs = Codestream::new();
    {
        let siz = cs.access_siz_mut();
        siz.set_image_extent(Point::new(w, h));
        siz.set_tile_size(Size::new(w, h));
        siz.set_num_components(1);
        siz.set_comp_info(0, Point::new(1, 1), 8, false);
    }
    {
        let cod = cs.access_cod_mut();
        cod.set_reversible(true);
        cod.set_color_transform(false);
        cod.set_num_decomposition(3);
    }
    let mut outfile = MemOutfile::new();
    cs.write_headers(&mut outfile, &[]).unwrap();
    cs.exchange(&pixels, 0).unwrap();
    cs.flush(&mut outfile).unwrap();

    let data = outfile.get_data().to_vec();
    let mut cs2 = Codestream::new();
    let mut infile = MemInfile::new(&data);
    cs2.read_headers(&mut infile).unwrap();
    cs2.create(&mut infile).unwrap();
    let line = cs2.pull(0).unwrap();
    assert_eq!(line, pixels);
}

// ============================================================================
// Edge case: boundary pixel values
// ============================================================================

/// All zeros
#[test]
fn edge_all_zeros() {
    let w = 16u32;
    let h = 16u32;
    let pixels = vec![0i32; (w * h) as usize];
    let mut cs = Codestream::new();
    {
        let siz = cs.access_siz_mut();
        siz.set_image_extent(Point::new(w, h));
        siz.set_tile_size(Size::new(w, h));
        siz.set_num_components(1);
        siz.set_comp_info(0, Point::new(1, 1), 8, false);
    }
    {
        let cod = cs.access_cod_mut();
        cod.set_reversible(true);
        cod.set_color_transform(false);
        cod.set_num_decomposition(2);
    }
    let mut outfile = MemOutfile::new();
    cs.write_headers(&mut outfile, &[]).unwrap();
    for y in 0..h {
        let start = (y * w) as usize;
        let end = start + w as usize;
        cs.exchange(&pixels[start..end], 0).unwrap();
    }
    cs.flush(&mut outfile).unwrap();

    let data = outfile.get_data().to_vec();
    let mut cs2 = Codestream::new();
    let mut infile = MemInfile::new(&data);
    cs2.read_headers(&mut infile).unwrap();
    cs2.create(&mut infile).unwrap();
    for _ in 0..h {
        let line = cs2.pull(0).unwrap();
        assert!(line.iter().all(|&v| v == 0));
    }
}

/// All max value (255 for 8-bit)
#[test]
fn edge_all_max() {
    let w = 16u32;
    let h = 16u32;
    let pixels = vec![255i32; (w * h) as usize];
    let mut cs = Codestream::new();
    {
        let siz = cs.access_siz_mut();
        siz.set_image_extent(Point::new(w, h));
        siz.set_tile_size(Size::new(w, h));
        siz.set_num_components(1);
        siz.set_comp_info(0, Point::new(1, 1), 8, false);
    }
    {
        let cod = cs.access_cod_mut();
        cod.set_reversible(true);
        cod.set_color_transform(false);
        cod.set_num_decomposition(2);
    }
    let mut outfile = MemOutfile::new();
    cs.write_headers(&mut outfile, &[]).unwrap();
    for y in 0..h {
        let start = (y * w) as usize;
        let end = start + w as usize;
        cs.exchange(&pixels[start..end], 0).unwrap();
    }
    cs.flush(&mut outfile).unwrap();

    let data = outfile.get_data().to_vec();
    let mut cs2 = Codestream::new();
    let mut infile = MemInfile::new(&data);
    cs2.read_headers(&mut infile).unwrap();
    cs2.create(&mut infile).unwrap();
    for _ in 0..h {
        let line = cs2.pull(0).unwrap();
        assert!(line.iter().all(|&v| v == 255));
    }
}

/// All max value for 16-bit
#[test]
fn edge_all_max_16bit() {
    let w = 16u32;
    let h = 16u32;
    let max_val = 65535i32;
    let pixels = vec![max_val; (w * h) as usize];
    let mut cs = Codestream::new();
    {
        let siz = cs.access_siz_mut();
        siz.set_image_extent(Point::new(w, h));
        siz.set_tile_size(Size::new(w, h));
        siz.set_num_components(1);
        siz.set_comp_info(0, Point::new(1, 1), 16, false);
    }
    {
        let cod = cs.access_cod_mut();
        cod.set_reversible(true);
        cod.set_color_transform(false);
        cod.set_num_decomposition(2);
    }
    let mut outfile = MemOutfile::new();
    cs.write_headers(&mut outfile, &[]).unwrap();
    for y in 0..h {
        let start = (y * w) as usize;
        let end = start + w as usize;
        cs.exchange(&pixels[start..end], 0).unwrap();
    }
    cs.flush(&mut outfile).unwrap();

    let data = outfile.get_data().to_vec();
    let mut cs2 = Codestream::new();
    let mut infile = MemInfile::new(&data);
    cs2.read_headers(&mut infile).unwrap();
    cs2.create(&mut infile).unwrap();
    for _ in 0..h {
        let line = cs2.pull(0).unwrap();
        assert!(line.iter().all(|&v| v == max_val));
    }
}

// ============================================================================
// Edge case: codestream restart/reuse
// ============================================================================

/// Encode, then restart and encode again with different parameters
#[test]
fn edge_codestream_restart() {
    // First encoding
    let mut cs = Codestream::new();
    {
        let siz = cs.access_siz_mut();
        siz.set_image_extent(Point::new(8, 8));
        siz.set_tile_size(Size::new(8, 8));
        siz.set_num_components(1);
        siz.set_comp_info(0, Point::new(1, 1), 8, false);
    }
    {
        let cod = cs.access_cod_mut();
        cod.set_reversible(true);
        cod.set_color_transform(false);
        cod.set_num_decomposition(1);
    }
    let mut outfile = MemOutfile::new();
    cs.write_headers(&mut outfile, &[]).unwrap();
    for _ in 0..8 {
        cs.exchange(&[100; 8], 0).unwrap();
    }
    cs.flush(&mut outfile).unwrap();
    let data1 = outfile.get_data().to_vec();

    // Restart and re-encode
    cs.restart();
    {
        let siz = cs.access_siz_mut();
        siz.set_image_extent(Point::new(4, 4));
        siz.set_tile_size(Size::new(4, 4));
        siz.set_num_components(1);
        siz.set_comp_info(0, Point::new(1, 1), 8, false);
    }
    {
        let cod = cs.access_cod_mut();
        cod.set_reversible(true);
        cod.set_color_transform(false);
        cod.set_num_decomposition(0);
    }
    let mut outfile2 = MemOutfile::new();
    cs.write_headers(&mut outfile2, &[]).unwrap();
    for _ in 0..4 {
        cs.exchange(&[200; 4], 0).unwrap();
    }
    cs.flush(&mut outfile2).unwrap();
    let data2 = outfile2.get_data().to_vec();

    // Verify both are valid
    assert!(!data1.is_empty());
    assert!(!data2.is_empty());
    assert_ne!(data1, data2);

    // Decode the second one
    let mut cs3 = Codestream::new();
    let mut infile = MemInfile::new(&data2);
    cs3.read_headers(&mut infile).unwrap();
    cs3.create(&mut infile).unwrap();
    for _ in 0..4 {
        let line = cs3.pull(0).unwrap();
        assert!(line.iter().all(|&v| v == 200));
    }
}

// ============================================================================
// Edge case: multiple independent codestreams
// ============================================================================

/// Encoding and decoding multiple independent codestreams
#[test]
fn edge_multiple_independent_codestreams() {
    let values = [42, 128, 255, 0, 100];

    for &val in &values {
        let mut cs = Codestream::new();
        {
            let siz = cs.access_siz_mut();
            siz.set_image_extent(Point::new(4, 4));
            siz.set_tile_size(Size::new(4, 4));
            siz.set_num_components(1);
            siz.set_comp_info(0, Point::new(1, 1), 8, false);
        }
        {
            let cod = cs.access_cod_mut();
            cod.set_reversible(true);
            cod.set_color_transform(false);
            cod.set_num_decomposition(1);
        }
        let mut outfile = MemOutfile::new();
        cs.write_headers(&mut outfile, &[]).unwrap();
        for _ in 0..4 {
            cs.exchange(&[val; 4], 0).unwrap();
        }
        cs.flush(&mut outfile).unwrap();

        let data = outfile.get_data().to_vec();
        let mut cs2 = Codestream::new();
        let mut infile = MemInfile::new(&data);
        cs2.read_headers(&mut infile).unwrap();
        cs2.create(&mut infile).unwrap();
        for _ in 0..4 {
            let line = cs2.pull(0).unwrap();
            assert!(
                line.iter().all(|&v| v == val),
                "expected all {}, got {:?}",
                val,
                line
            );
        }
    }
}

// ============================================================================
// Edge case: progression order string validation
// ============================================================================

/// Valid progression orders should be accepted
#[test]
fn edge_valid_progression_orders() {
    for order in &["LRCP", "RLCP", "RPCL", "PCRL", "CPRL"] {
        let mut cs = Codestream::new();
        {
            let siz = cs.access_siz_mut();
            siz.set_image_extent(Point::new(8, 8));
            siz.set_tile_size(Size::new(8, 8));
            siz.set_num_components(1);
            siz.set_comp_info(0, Point::new(1, 1), 8, false);
        }
        {
            let cod = cs.access_cod_mut();
            cod.set_reversible(true);
            cod.set_color_transform(false);
            cod.set_num_decomposition(2);
            let result = cod.set_progression_order(order);
            assert!(
                result.is_ok(),
                "progression order '{}' should be valid",
                order
            );
        }
    }
}

/// Invalid progression order should fail
#[test]
fn error_invalid_progression_order() {
    let mut cs = Codestream::new();
    let cod = cs.access_cod_mut();
    let result = cod.set_progression_order("INVALID");
    assert!(result.is_err(), "invalid progression order should fail");
}

// ============================================================================
// Edge case: comment markers
// ============================================================================

/// Encode with a comment, verify it doesn't break decoding
#[test]
fn edge_comment_marker() {
    use openjph_core::params::CommentExchange;

    let mut cs = Codestream::new();
    {
        let siz = cs.access_siz_mut();
        siz.set_image_extent(Point::new(8, 8));
        siz.set_tile_size(Size::new(8, 8));
        siz.set_num_components(1);
        siz.set_comp_info(0, Point::new(1, 1), 8, false);
    }
    {
        let cod = cs.access_cod_mut();
        cod.set_reversible(true);
        cod.set_color_transform(false);
        cod.set_num_decomposition(2);
    }

    let mut comment = CommentExchange::default();
    comment.set_string("OpenJPH-RS test comment");

    let mut outfile = MemOutfile::new();
    cs.write_headers(&mut outfile, &[comment]).unwrap();
    for _ in 0..8 {
        cs.exchange(&[128; 8], 0).unwrap();
    }
    cs.flush(&mut outfile).unwrap();

    let data = outfile.get_data().to_vec();
    let mut cs2 = Codestream::new();
    let mut infile = MemInfile::new(&data);
    cs2.read_headers(&mut infile).unwrap();
    cs2.create(&mut infile).unwrap();
    for _ in 0..8 {
        let line = cs2.pull(0).unwrap();
        assert!(line.iter().all(|&v| v == 128));
    }
}

// ============================================================================
// Edge case: pull after all lines consumed
// ============================================================================

/// Pulling beyond the image height should return None
#[test]
fn edge_pull_past_end() {
    let mut cs = Codestream::new();
    {
        let siz = cs.access_siz_mut();
        siz.set_image_extent(Point::new(4, 4));
        siz.set_tile_size(Size::new(4, 4));
        siz.set_num_components(1);
        siz.set_comp_info(0, Point::new(1, 1), 8, false);
    }
    {
        let cod = cs.access_cod_mut();
        cod.set_reversible(true);
        cod.set_color_transform(false);
        cod.set_num_decomposition(1);
    }
    let mut outfile = MemOutfile::new();
    cs.write_headers(&mut outfile, &[]).unwrap();
    for _ in 0..4 {
        cs.exchange(&[100; 4], 0).unwrap();
    }
    cs.flush(&mut outfile).unwrap();

    let data = outfile.get_data().to_vec();
    let mut cs2 = Codestream::new();
    let mut infile = MemInfile::new(&data);
    cs2.read_headers(&mut infile).unwrap();
    cs2.create(&mut infile).unwrap();

    // Pull all 4 lines
    for _ in 0..4 {
        assert!(cs2.pull(0).is_some());
    }
    // 5th pull should return None
    assert!(cs2.pull(0).is_none(), "pull past end should return None");
}