j2k-native 0.8.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
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

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

//! Parse-free CPU execution for referenced HTJ2K plans.

mod component;
mod output;
mod payload;

pub(super) use output::{decoded_color_components, decoded_components, decoded_plane};
pub use output::{J2kDirectDecodedComponents, J2kDirectDecodedPlane};
pub(super) use payload::payload_slice;

use crate::error::{bail, DecodingError, Result};
use crate::{HtCodeBlockPayloadRanges, J2kReferencedHtj2kPlan};

use super::allocation::prepare_referenced_direct_scratch;
use super::J2kDirectCpuScratch;
use component::{execute_color_components_referenced, execute_component_plan_referenced};
use payload::{validate_payload_ranges, ReferencedPayloadCursor};

/// Execute retained per-tile Gray/RGB/RGBA HTJ2K geometry without reparsing packets.
///
/// Compressed cleanup/refinement ranges are validated against `encoded_input`
/// and combined in one retained scratch buffer. Reconstructed component owners
/// remain in `scratch` and are borrowed by the returned view.
#[doc(hidden)]
pub fn execute_referenced_htj2k_plan<'scratch>(
    plan: &J2kReferencedHtj2kPlan,
    encoded_input: &[u8],
    signed: bool,
    scratch: &'scratch mut J2kDirectCpuScratch,
) -> Result<J2kDirectDecodedComponents<'scratch>> {
    execute_referenced_htj2k_plan_with_payloads(
        plan,
        encoded_input,
        plan.payloads(),
        signed,
        scratch,
    )
}

/// Execute retained HTJ2K geometry from caller-flattened payload ranges.
///
/// `payloads` must remain in the plan's component/step/job traversal order,
/// but their ranges may point anywhere inside the shared `payload_arena`.
#[doc(hidden)]
pub fn execute_referenced_htj2k_plan_from_payloads<'scratch>(
    plan: &J2kReferencedHtj2kPlan,
    payload_arena: &[u8],
    payloads: &[HtCodeBlockPayloadRanges],
    signed: bool,
    scratch: &'scratch mut J2kDirectCpuScratch,
) -> Result<J2kDirectDecodedComponents<'scratch>> {
    execute_referenced_htj2k_plan_with_payloads(plan, payload_arena, payloads, signed, scratch)
}

fn execute_referenced_htj2k_plan_with_payloads<'scratch>(
    plan: &J2kReferencedHtj2kPlan,
    encoded_input: &[u8],
    payload_ranges: &[HtCodeBlockPayloadRanges],
    signed: bool,
    scratch: &'scratch mut J2kDirectCpuScratch,
) -> Result<J2kDirectDecodedComponents<'scratch>> {
    if payload_ranges.len() != plan.payloads().len() {
        bail!(DecodingError::CodeBlockDecodeFailure);
    }
    validate_payload_ranges(encoded_input, payload_ranges)?;
    prepare_referenced_direct_scratch(plan, scratch)?;
    {
        let J2kDirectCpuScratch {
            component_band_sets,
            component_planes,
            compressed_payload,
            classic_workspace: _,
            ht_workspace,
            staged_state: _,
        } = scratch;
        let mut payloads =
            ReferencedPayloadCursor::new(encoded_input, payload_ranges, compressed_payload);
        let mut output_initialized = [false; 4];

        for tile in plan.tiles() {
            if let Some(geometry) = tile.grayscale_geometry() {
                let bands = component_band_sets
                    .first_mut()
                    .ok_or(DecodingError::CodeBlockDecodeFailure)?;
                let output = component_planes
                    .first_mut()
                    .ok_or(DecodingError::CodeBlockDecodeFailure)?;
                execute_component_plan_referenced(
                    geometry,
                    bands,
                    output,
                    &mut payloads,
                    ht_workspace,
                    &mut output_initialized[0],
                )?;
            } else if let Some(geometry) = tile.color_geometry() {
                execute_color_components_referenced(
                    &geometry.component_plans,
                    3,
                    geometry.bit_depths,
                    geometry.mct,
                    geometry.transform,
                    signed,
                    component_band_sets,
                    component_planes,
                    &mut payloads,
                    ht_workspace,
                    &mut output_initialized,
                    tile.destination_rect(),
                )?;
            } else if let Some(geometry) = tile.rgba_geometry() {
                execute_color_components_referenced(
                    &geometry.component_plans,
                    4,
                    [
                        geometry.bit_depths[0],
                        geometry.bit_depths[1],
                        geometry.bit_depths[2],
                    ],
                    geometry.mct,
                    geometry.transform,
                    signed,
                    component_band_sets,
                    component_planes,
                    &mut payloads,
                    ht_workspace,
                    &mut output_initialized,
                    tile.destination_rect(),
                )?;
            } else {
                bail!(DecodingError::CodeBlockDecodeFailure);
            }
        }
        payloads.ensure_exhausted()?;
    }

    decoded_components(plan, scratch)
}