zenbitmaps 0.1.5

PNM/PAM/PFM, BMP, farbfeld, QOI, TGA, and Radiance HDR image codec
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
use super::*;

// ══════════════════════════════════════════════════════════════════════
// BMP capabilities and descriptors
// ══════════════════════════════════════════════════════════════════════

static BMP_ENCODE_CAPS: EncodeCapabilities = EncodeCapabilities::new()
    .with_lossless(true)
    .with_native_alpha(true)
    .with_stop(true)
    .with_enforces_max_pixels(true);

static BMP_DECODE_CAPS: DecodeCapabilities = DecodeCapabilities::new()
    .with_cheap_probe(true)
    .with_native_gray(true)
    .with_native_alpha(true)
    .with_stop(true)
    .with_enforces_max_pixels(true)
    .with_enforces_max_memory(true)
    .with_enforces_max_input_bytes(true);

static BMP_ENCODE_DESCRIPTORS: &[PixelDescriptor] = &[
    PixelDescriptor::RGB8_SRGB,
    PixelDescriptor::RGBA8_SRGB,
    PixelDescriptor::BGRA8_SRGB,
];

static BMP_DECODE_DESCRIPTORS: &[PixelDescriptor] = &[
    PixelDescriptor::RGB8_SRGB,
    PixelDescriptor::RGBA8_SRGB,
    PixelDescriptor::GRAY8_SRGB,
    PixelDescriptor::BGRA8_SRGB,
];

// ══════════════════════════════════════════════════════════════════════
// BMP codec
// ══════════════════════════════════════════════════════════════════════

// ── BmpEncoderConfig ─────────────────────────────────────────────

/// Encoding configuration for BMP format.
///
/// Supports 24-bit RGB and 32-bit RGBA BMP output.
#[derive(Clone, Debug)]
pub struct BmpEncoderConfig {
    limits: ResourceLimits,
}

impl Default for BmpEncoderConfig {
    fn default() -> Self {
        Self::new()
    }
}

impl BmpEncoderConfig {
    /// Create a new BMP encoder config with default settings.
    pub fn new() -> Self {
        Self {
            limits: ResourceLimits::none(),
        }
    }
}

impl zencodec::encode::EncoderConfig for BmpEncoderConfig {
    type Error = BitmapError;
    type Job = BmpEncodeJob;

    fn format() -> ImageFormat {
        ImageFormat::Bmp
    }

    fn supported_descriptors() -> &'static [PixelDescriptor] {
        BMP_ENCODE_DESCRIPTORS
    }

    fn capabilities() -> &'static EncodeCapabilities {
        &BMP_ENCODE_CAPS
    }

    fn is_lossless(&self) -> Option<bool> {
        Some(true)
    }

    fn job(self) -> BmpEncodeJob {
        BmpEncodeJob {
            config: self,
            limits: None,
            stop: None,
        }
    }
}

// ── BmpEncodeJob ─────────────────────────────────────────────────

/// Per-operation BMP encode job.
pub struct BmpEncodeJob {
    config: BmpEncoderConfig,
    limits: Option<ResourceLimits>,
    stop: Option<zencodec::StopToken>,
}

impl zencodec::encode::EncodeJob for BmpEncodeJob {
    type Error = BitmapError;
    type Enc = BmpEncoder;
    type AnimationFrameEnc = ();

    fn with_stop(mut self, stop: zencodec::StopToken) -> Self {
        self.stop = Some(stop);
        self
    }

    fn with_metadata(self, _meta: Metadata) -> Self {
        self
    }

    fn with_limits(mut self, limits: ResourceLimits) -> Self {
        self.limits = Some(limits);
        self
    }

    fn encoder(self) -> Result<BmpEncoder, BitmapError> {
        Ok(BmpEncoder {
            config: self.config,
            limits: self.limits,
            stop: self.stop,
        })
    }

    fn animation_frame_encoder(self) -> Result<(), BitmapError> {
        Err(BitmapError::from(
            zencodec::UnsupportedOperation::AnimationEncode,
        ))
    }
}

// ── BmpEncoder ───────────────────────────────────────────────────

/// Single-image BMP encoder.
pub struct BmpEncoder {
    config: BmpEncoderConfig,
    limits: Option<ResourceLimits>,
    stop: Option<zencodec::StopToken>,
}

impl BmpEncoder {
    fn effective_limits(&self) -> Option<Limits> {
        self.limits.as_ref().map(convert_limits).or_else(|| {
            let l = &self.config.limits;
            if l.max_pixels.is_some()
                || l.max_memory_bytes.is_some()
                || l.max_width.is_some()
                || l.max_height.is_some()
            {
                Some(convert_limits(l))
            } else {
                None
            }
        })
    }
}

impl zencodec::encode::Encoder for BmpEncoder {
    type Error = BitmapError;

    fn reject(op: zencodec::UnsupportedOperation) -> BitmapError {
        BitmapError::from(op)
    }

    fn encode(self, pixels: PixelSlice<'_>) -> Result<EncodeOutput, BitmapError> {
        let stop: &dyn Stop = match &self.stop {
            Some(s) => s,
            None => &enough::Unstoppable,
        };
        let desc = pixels.descriptor();
        let w = pixels.width();
        let h = pixels.rows();

        if let Some(limits) = self.effective_limits() {
            limits.check(w, h)?;
        }

        let bytes = pixels.contiguous_bytes();
        let (layout, alpha) = match (desc.channel_type(), desc.layout()) {
            (ChannelType::U8, ChannelLayout::Rgb) => (crate::PixelLayout::Rgb8, false),
            (ChannelType::U8, ChannelLayout::Rgba) => (crate::PixelLayout::Rgba8, true),
            (ChannelType::U8, ChannelLayout::Bgra) => (crate::PixelLayout::Bgra8, true),
            _ => {
                return Err(BitmapError::UnsupportedVariant(alloc::format!(
                    "BMP encode: unsupported pixel format: {:?}",
                    desc
                )));
            }
        };

        let encoded = crate::bmp::encode(&bytes, w, h, layout, alpha, stop)?;
        Ok(EncodeOutput::new(encoded, ImageFormat::Bmp))
    }
}

// ── BmpDecoderConfig ─────────────────────────────────────────────

/// Decoding configuration for BMP format.
#[derive(Clone, Debug)]
pub struct BmpDecoderConfig {
    limits: Option<Limits>,
}

impl Default for BmpDecoderConfig {
    fn default() -> Self {
        Self::new()
    }
}

impl BmpDecoderConfig {
    /// Create a new BMP decoder config with default settings.
    pub fn new() -> Self {
        Self { limits: None }
    }
}

impl zencodec::decode::DecoderConfig for BmpDecoderConfig {
    type Error = BitmapError;
    type Job<'a> = BmpDecodeJob;

    fn formats() -> &'static [ImageFormat] {
        &[ImageFormat::Bmp]
    }

    fn supported_descriptors() -> &'static [PixelDescriptor] {
        BMP_DECODE_DESCRIPTORS
    }

    fn capabilities() -> &'static DecodeCapabilities {
        &BMP_DECODE_CAPS
    }

    fn job<'a>(self) -> Self::Job<'a> {
        BmpDecodeJob {
            config: self,
            limits: None,
            stop: None,
            max_input_bytes: None,
            policy: None,
        }
    }
}

// ── BmpDecodeJob ─────────────────────────────────────────────────

/// Per-operation BMP decode job.
pub struct BmpDecodeJob {
    config: BmpDecoderConfig,
    limits: Option<Limits>,
    stop: Option<zencodec::StopToken>,
    max_input_bytes: Option<u64>,
    policy: Option<DecodePolicy>,
}

impl<'a> zencodec::decode::DecodeJob<'a> for BmpDecodeJob {
    type Error = BitmapError;
    type Dec = BmpDecoder<'a>;
    type StreamDec = zencodec::Unsupported<BitmapError>;
    type AnimationFrameDec = zencodec::Unsupported<BitmapError>;

    fn with_stop(mut self, stop: zencodec::StopToken) -> Self {
        self.stop = Some(stop);
        self
    }

    fn with_limits(mut self, limits: ResourceLimits) -> Self {
        self.max_input_bytes = limits.max_input_bytes;
        self.limits = Some(convert_limits(&limits));
        self
    }

    fn with_policy(mut self, policy: DecodePolicy) -> Self {
        self.policy = Some(policy);
        self
    }

    fn probe(&self, data: &[u8]) -> Result<ImageInfo, BitmapError> {
        let header = crate::bmp::decode::parse_bmp_header(data)?;
        let has_alpha = matches!(
            header.layout,
            crate::PixelLayout::Rgba8 | crate::PixelLayout::Bgra8
        );
        let channel_count: u8 = match header.layout {
            crate::PixelLayout::Gray8 => 1,
            crate::PixelLayout::Rgb8 => 3,
            crate::PixelLayout::Rgba8 | crate::PixelLayout::Bgra8 => 4,
            _ => 3, // BMP decoded output is at least RGB
        };
        let mut info = ImageInfo::new(header.width, header.height, ImageFormat::Bmp)
            .with_alpha(has_alpha)
            .with_bit_depth(header.bpp as u8)
            .with_channel_count(channel_count)
            .with_cicp(zencodec::Cicp::SRGB)
            .with_source_encoding_details(BitmapSourceEncoding);
        // BMP stores resolution as pixels-per-meter
        if header.x_pels_per_meter > 0 || header.y_pels_per_meter > 0 {
            info = info.with_resolution(zencodec::Resolution {
                x: header.x_pels_per_meter as f64,
                y: header.y_pels_per_meter as f64,
                unit: zencodec::ResolutionUnit::Meter,
            });
        }
        Ok(info)
    }

    fn output_info(&self, data: &[u8]) -> Result<OutputInfo, BitmapError> {
        let header = crate::bmp::decode::parse_bmp_header(data)?;
        let has_alpha = matches!(
            header.layout,
            crate::PixelLayout::Rgba8 | crate::PixelLayout::Bgra8
        );
        let native_format = layout_to_descriptor(header.layout);
        Ok(
            OutputInfo::full_decode(header.width, header.height, native_format)
                .with_alpha(has_alpha),
        )
    }

    fn decoder(
        self,
        data: Cow<'a, [u8]>,
        _preferred: &[PixelDescriptor],
    ) -> Result<BmpDecoder<'a>, BitmapError> {
        if let Some(max) = self.max_input_bytes
            && data.len() as u64 > max
        {
            return Err(BitmapError::LimitExceeded(alloc::format!(
                "input size {} exceeds limit {max}",
                data.len()
            )));
        }
        let permissiveness = policy_to_bmp_permissiveness(self.policy.as_ref());
        Ok(BmpDecoder {
            config: self.config,
            limits: self.limits,
            data,
            stop: self.stop,
            permissiveness,
        })
    }

    fn push_decoder(
        self,
        data: Cow<'a, [u8]>,
        sink: &mut dyn zencodec::decode::DecodeRowSink,
        preferred: &[PixelDescriptor],
    ) -> Result<OutputInfo, Self::Error> {
        zencodec::helpers::copy_decode_to_sink(self, data, sink, preferred, |e| {
            BitmapError::InvalidData(e.to_string())
        })
    }

    fn streaming_decoder(
        self,
        _data: Cow<'a, [u8]>,
        _preferred: &[PixelDescriptor],
    ) -> Result<zencodec::Unsupported<BitmapError>, BitmapError> {
        Err(BitmapError::from(
            zencodec::UnsupportedOperation::RowLevelDecode,
        ))
    }

    fn animation_frame_decoder(
        self,
        _data: Cow<'a, [u8]>,
        _preferred: &[PixelDescriptor],
    ) -> Result<zencodec::Unsupported<BitmapError>, BitmapError> {
        Err(BitmapError::from(
            zencodec::UnsupportedOperation::AnimationDecode,
        ))
    }
}

// ── BmpDecoder ───────────────────────────────────────────────────

/// Single-image BMP decoder.
pub struct BmpDecoder<'a> {
    config: BmpDecoderConfig,
    limits: Option<Limits>,
    data: Cow<'a, [u8]>,
    stop: Option<zencodec::StopToken>,
    permissiveness: crate::bmp::BmpPermissiveness,
}

impl BmpDecoder<'_> {
    fn effective_limits(&self) -> Option<&Limits> {
        self.limits.as_ref().or(self.config.limits.as_ref())
    }
}

impl zencodec::decode::Decode for BmpDecoder<'_> {
    type Error = BitmapError;

    fn decode(self) -> Result<DecodeOutput, BitmapError> {
        let limits = self.effective_limits();
        let stop: &dyn Stop = match &self.stop {
            Some(s) => s,
            None => &enough::Unstoppable,
        };
        let decoded =
            crate::bmp::decode_with_permissiveness(&self.data, limits, self.permissiveness, stop)?;
        decode_output_from_internal(&decoded, ImageFormat::Bmp)
    }
}

/// Map [`DecodePolicy`] to [`BmpPermissiveness`].
///
/// - `strict == Some(true)` → `Strict`
/// - `allow_truncated == Some(true)` → `Permissive`
/// - otherwise (or no policy) → `Standard`
fn policy_to_bmp_permissiveness(policy: Option<&DecodePolicy>) -> crate::bmp::BmpPermissiveness {
    use crate::bmp::BmpPermissiveness;
    let Some(p) = policy else {
        return BmpPermissiveness::Standard;
    };
    if p.resolve_strict(false) {
        BmpPermissiveness::Strict
    } else if p.resolve_truncated(false) {
        BmpPermissiveness::Permissive
    } else {
        BmpPermissiveness::Standard
    }
}