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

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

use crate::profile;

#[derive(Default, Debug, Clone, Copy, PartialEq, Eq)]
#[expect(clippy::struct_field_names, reason = "fields expose microsecond units")]
pub(crate) struct J2kBlockDecodeStats {
    pub(crate) sigprop_us: u128,
    pub(crate) magref_us: u128,
    pub(crate) cleanup_us: u128,
    pub(crate) bypass_us: u128,
}

pub(super) trait J2kDecodeObserver {
    #[expect(clippy::inline_always, reason = "hot observer hook")]
    #[inline(always)]
    fn phase_start(&self) -> Option<profile::ProfileInstant> {
        None
    }

    #[inline(always)]
    fn add_sigprop_us(&mut self, _start: Option<profile::ProfileInstant>) {}

    #[inline(always)]
    fn add_magref_us(&mut self, _start: Option<profile::ProfileInstant>) {}

    #[inline(always)]
    fn add_cleanup_us(&mut self, _start: Option<profile::ProfileInstant>) {}

    #[inline(always)]
    fn add_bypass_us(&mut self, _start: Option<profile::ProfileInstant>) {}
}

pub(super) struct NoJ2kDecodeStats;

impl J2kDecodeObserver for NoJ2kDecodeStats {}

pub(super) struct RecordingJ2kDecodeStats<'a> {
    pub(super) stats: &'a mut J2kBlockDecodeStats,
    pub(super) profile_enabled: bool,
}

impl J2kDecodeObserver for RecordingJ2kDecodeStats<'_> {
    #[expect(clippy::inline_always, reason = "hot observer hook")]
    #[inline(always)]
    fn phase_start(&self) -> Option<profile::ProfileInstant> {
        if self.profile_enabled {
            profile::profile_now(true)
        } else {
            None
        }
    }

    #[expect(clippy::inline_always, reason = "hot observer hook")]
    #[inline(always)]
    fn add_sigprop_us(&mut self, start: Option<profile::ProfileInstant>) {
        if self.profile_enabled {
            self.stats.sigprop_us += profile::elapsed_us(start);
        }
    }

    #[expect(clippy::inline_always, reason = "hot observer hook")]
    #[inline(always)]
    fn add_magref_us(&mut self, start: Option<profile::ProfileInstant>) {
        if self.profile_enabled {
            self.stats.magref_us += profile::elapsed_us(start);
        }
    }

    #[expect(clippy::inline_always, reason = "hot observer hook")]
    #[inline(always)]
    fn add_cleanup_us(&mut self, start: Option<profile::ProfileInstant>) {
        if self.profile_enabled {
            self.stats.cleanup_us += profile::elapsed_us(start);
        }
    }

    #[expect(clippy::inline_always, reason = "hot observer hook")]
    #[inline(always)]
    fn add_bypass_us(&mut self, start: Option<profile::ProfileInstant>) {
        if self.profile_enabled {
            self.stats.bypass_us += profile::elapsed_us(start);
        }
    }
}