j2k-jpeg 0.7.2

JPEG inspect/decode and fallback encode support 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

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

//! Structured decode profiling kept out of output dispatch.

use super::super::{
    downscale_profile_name, emit_jpeg_profile_fields, output_format_profile_name, DecodeOutcome,
    DownscaleFactor, Instant, OutputFormat, ProfileField, Rect,
};

pub(super) struct DecodeProfileRecord {
    pub(super) total_start: Instant,
    pub(super) decode_start: Instant,
    pub(super) source_dimensions: (u32, u32),
    pub(super) output_rect: Rect,
    pub(super) stride: usize,
    pub(super) bytes_per_pixel: usize,
    pub(super) scratch_bytes: usize,
    pub(super) fmt: OutputFormat,
    pub(super) downscale: DownscaleFactor,
    pub(super) source_roi: Option<Rect>,
}

impl DecodeProfileRecord {
    pub(super) fn emit(self, outcome: &DecodeOutcome) {
        match self.source_roi {
            Some(roi) => self.emit_region(roi, outcome),
            None => self.emit_full(outcome),
        }
    }

    fn emit_full(self, outcome: &DecodeOutcome) {
        let output_bytes = self.stride.saturating_mul(self.output_rect.h as usize);
        emit_decode_profile_fields("jpeg_decode_full_fields", "decode", "cpu", || {
            Ok([
                ProfileField::label("mode", "full")?,
                ProfileField::label("fmt", output_format_profile_name(self.fmt))?,
                ProfileField::label("downscale", downscale_profile_name(self.downscale))?,
                ProfileField::metric_with_summary("source_width", self.source_dimensions.0, false)?,
                ProfileField::metric_with_summary(
                    "source_height",
                    self.source_dimensions.1,
                    false,
                )?,
                ProfileField::metric_with_summary("output_width", self.output_rect.w, false)?,
                ProfileField::metric_with_summary("output_height", self.output_rect.h, false)?,
                ProfileField::metric_with_summary("stride", self.stride, false)?,
                ProfileField::metric_with_summary("bpp", self.bytes_per_pixel, false)?,
                ProfileField::metric_with_summary("scratch_bytes", self.scratch_bytes, false)?,
                ProfileField::metric_with_summary("output_bytes", output_bytes, false)?,
                ProfileField::metric("decode_us", self.decode_start.elapsed().as_micros())?,
                ProfileField::metric("total_us", self.total_start.elapsed().as_micros())?,
                ProfileField::metric_with_summary("warnings", outcome.warnings.len(), false)?,
            ])
        });
    }

    fn emit_region(self, roi: Rect, outcome: &DecodeOutcome) {
        let output_bytes = self.stride.saturating_mul(self.output_rect.h as usize);
        let mode = if self.downscale == DownscaleFactor::Full {
            "region"
        } else {
            "region_scaled"
        };
        emit_decode_profile_fields("jpeg_decode_region_fields", "decode", "cpu", || {
            Ok([
                ProfileField::label("mode", mode)?,
                ProfileField::label("fmt", output_format_profile_name(self.fmt))?,
                ProfileField::label("downscale", downscale_profile_name(self.downscale))?,
                ProfileField::metric_with_summary("source_width", self.source_dimensions.0, false)?,
                ProfileField::metric_with_summary(
                    "source_height",
                    self.source_dimensions.1,
                    false,
                )?,
                ProfileField::metric_with_summary("roi_x", roi.x, false)?,
                ProfileField::metric_with_summary("roi_y", roi.y, false)?,
                ProfileField::metric_with_summary("roi_w", roi.w, false)?,
                ProfileField::metric_with_summary("roi_h", roi.h, false)?,
                ProfileField::metric_with_summary("output_width", self.output_rect.w, false)?,
                ProfileField::metric_with_summary("output_height", self.output_rect.h, false)?,
                ProfileField::metric_with_summary("stride", self.stride, false)?,
                ProfileField::metric_with_summary("bpp", self.bytes_per_pixel, false)?,
                ProfileField::metric_with_summary("scratch_bytes", self.scratch_bytes, false)?,
                ProfileField::metric_with_summary("output_bytes", output_bytes, false)?,
                ProfileField::metric("decode_us", self.decode_start.elapsed().as_micros())?,
                ProfileField::metric("total_us", self.total_start.elapsed().as_micros())?,
                ProfileField::metric_with_summary("warnings", outcome.warnings.len(), false)?,
            ])
        });
    }
}

fn emit_decode_profile_fields<const N: usize>(
    operation: &'static str,
    op: &str,
    path: &str,
    build: impl FnOnce() -> j2k_profile::ProfileResult<[ProfileField; N]>,
) {
    #[cfg(test)]
    let build = match test_support::try_capture(operation, op, path, build) {
        Ok(()) => return,
        Err(build) => build,
    };

    emit_jpeg_profile_fields(operation, op, path, build);
}

#[cfg(test)]
mod test_support;

#[cfg(test)]
mod tests;