j2k-native 0.11.0

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

// SPDX-License-Identifier: MIT OR Apache-2.0

//! Validated HT cleanup/refinement layout shared by contribution builders.

use super::super::super::super::{
    bitplane_encode, NativeEncodePipelineError, NativeEncodePipelineResult,
};
use super::super::ht_segment_count;

#[derive(Debug, Clone, Copy)]
pub(super) struct HtContributionLayout {
    pub(super) layer_count: usize,
    pub(super) cleanup_len: usize,
    pub(super) sigprop_len: usize,
    pub(super) magref_len: usize,
    pub(super) sigprop_end: usize,
    pub(super) refinement_end: usize,
    pub(super) split_refinement: bool,
}

pub(super) fn ht_contribution_layout(
    encoded: &bitplane_encode::EncodedCodeBlock,
    num_layers: u8,
    segment_layers: &[usize],
) -> NativeEncodePipelineResult<HtContributionLayout> {
    let layer_count = usize::from(num_layers);
    if segment_layers.len() != ht_segment_count(encoded) {
        return Err(NativeEncodePipelineError::internal_invariant(
            "HTJ2K segment assignment count mismatch",
        ));
    }
    if segment_layers.iter().any(|&layer| layer >= layer_count) {
        return Err(NativeEncodePipelineError::internal_invariant(
            "HTJ2K segment layer exceeds layer count",
        ));
    }
    if segment_layers
        .windows(2)
        .any(|layers| layers[1] < layers[0])
    {
        return Err(NativeEncodePipelineError::internal_invariant(
            "HTJ2K segment layers must be monotonic",
        ));
    }

    let cleanup_len = usize::try_from(encoded.ht_cleanup_length).map_err(|_| {
        NativeEncodePipelineError::arithmetic_overflow("HTJ2K cleanup segment length overflow")
    })?;
    let refinement_len = usize::try_from(encoded.ht_refinement_length).map_err(|_| {
        NativeEncodePipelineError::arithmetic_overflow("HTJ2K refinement segment length overflow")
    })?;
    let sigprop_len = usize::try_from(encoded.ht_sigprop_length).map_err(|_| {
        NativeEncodePipelineError::arithmetic_overflow("HTJ2K SigProp pass length overflow")
    })?;
    let magref_len = usize::try_from(encoded.ht_magref_length).map_err(|_| {
        NativeEncodePipelineError::arithmetic_overflow("HTJ2K MagRef pass length overflow")
    })?;
    if sigprop_len.checked_add(magref_len) != Some(refinement_len) {
        return Err(NativeEncodePipelineError::internal_invariant(
            "HTJ2K refinement pass lengths do not match the segment length",
        ));
    }
    let split_refinement = ht_segment_count(encoded) == 3;
    let sigprop_end = cleanup_len.checked_add(sigprop_len).ok_or_else(|| {
        NativeEncodePipelineError::arithmetic_overflow("HTJ2K SigProp pass range overflow")
    })?;
    let refinement_end = cleanup_len.checked_add(refinement_len).ok_or_else(|| {
        NativeEncodePipelineError::arithmetic_overflow("HTJ2K refinement segment range overflow")
    })?;
    if encoded.num_coding_passes > 0 && cleanup_len == 0 {
        return Err(NativeEncodePipelineError::internal_invariant(
            "HTJ2K cleanup segment is missing",
        ));
    }
    if encoded.num_coding_passes > 1 && refinement_len == 0 {
        return Err(NativeEncodePipelineError::internal_invariant(
            "HTJ2K refinement segment is missing",
        ));
    }
    if refinement_end > encoded.data.len() {
        return Err(NativeEncodePipelineError::internal_invariant(
            "HTJ2K segment range invalid",
        ));
    }
    Ok(HtContributionLayout {
        layer_count,
        cleanup_len,
        sigprop_len,
        magref_len,
        sigprop_end,
        refinement_end,
        split_refinement,
    })
}