j2k-native 0.13.1

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

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

//! Referenced HTJ2K plans whose compressed payloads remain in caller-owned input.

use crate::error::bail;
use crate::j2c;
use crate::{
    ColorSpace, DecoderContext, DecodingError, DirectPlanUnsupportedReason,
    J2kReferencedClassicPlan, J2kReferencedHtj2kPlan, Result,
};

use super::super::Image;

impl<'a> Image<'a> {
    /// Build owned execution geometry whose classic compressed payload fragments
    /// are ranges into this image's borrowed encoded input rather than copied buffers.
    #[doc(hidden)]
    pub fn build_referenced_classic_plan_region_with_context(
        &self,
        decoder_context: &mut DecoderContext<'a>,
        output_region: (u32, u32, u32, u32),
    ) -> Result<J2kReferencedClassicPlan> {
        self.with_packet_cache_retry(|| {
            validate_referenced_color_shape(&self.color_space, self.has_alpha)?;
            let retained_planning_bytes = self.retained_planning_bytes()?;
            decoder_context.set_output_region(Some(output_region));
            let result = if matches!(self.color_space, ColorSpace::Gray) {
                j2c::build_referenced_classic_grayscale_plan(
                    self.codestream,
                    self.encoded_input,
                    &self.header,
                    retained_planning_bytes,
                    decoder_context,
                )
            } else if self.has_alpha {
                j2c::build_referenced_classic_rgba_plan(
                    self.codestream,
                    self.encoded_input,
                    &self.header,
                    retained_planning_bytes,
                    decoder_context,
                )
            } else {
                j2c::build_referenced_classic_color_plan(
                    self.codestream,
                    self.encoded_input,
                    &self.header,
                    retained_planning_bytes,
                    decoder_context,
                )
            };
            decoder_context.set_output_region(None);
            result
        })
    }

    /// Build owned execution geometry whose HT compressed payloads are ranges
    /// into this image's borrowed raw codestream rather than copied buffers.
    #[doc(hidden)]
    pub fn build_referenced_htj2k_plan_region_with_context(
        &self,
        decoder_context: &mut DecoderContext<'a>,
        output_region: (u32, u32, u32, u32),
    ) -> Result<J2kReferencedHtj2kPlan> {
        self.with_packet_cache_retry(|| {
            validate_referenced_color_shape(&self.color_space, self.has_alpha)?;
            let retained_planning_bytes = self.retained_planning_bytes()?;
            decoder_context.set_output_region(Some(output_region));
            let result = if matches!(self.color_space, ColorSpace::Gray) {
                j2c::build_referenced_htj2k_grayscale_plan(
                    self.codestream,
                    self.encoded_input,
                    &self.header,
                    retained_planning_bytes,
                    decoder_context,
                )
            } else if self.has_alpha {
                j2c::build_referenced_htj2k_rgba_plan(
                    self.codestream,
                    self.encoded_input,
                    &self.header,
                    retained_planning_bytes,
                    decoder_context,
                )
            } else {
                j2c::build_referenced_htj2k_color_plan(
                    self.codestream,
                    self.encoded_input,
                    &self.header,
                    retained_planning_bytes,
                    decoder_context,
                )
            };
            decoder_context.set_output_region(None);
            result
        })
    }
}

fn validate_referenced_color_shape(color_space: &ColorSpace, has_alpha: bool) -> Result<()> {
    if matches!(
        (color_space, has_alpha),
        (ColorSpace::Gray, false) | (ColorSpace::RGB, _)
    ) {
        return Ok(());
    }
    let reason = if has_alpha {
        DirectPlanUnsupportedReason::RgbaRgbImageWithAlpha
    } else {
        DirectPlanUnsupportedReason::ColorRgbImageWithoutAlpha
    };
    bail!(DecodingError::DirectPlanUnsupported(reason));
}