pdfrum-render 0.1.0

//! The two raster buffers the engine and the backends share: [`Pixmap`], a
//! premultiplied RGBA8 image, and [`AlphaMask`], an 8-bit coverage plane.
//!
//! **Part of the backend seam.** Both are in
//! [`RasterBackend`](crate::RasterBackend)'s own signatures; the alpha
//! arithmetic beside them — [`mul255`], [`alpha_merge`],
//! [`alpha_byte_truncating`] — is here because a backend must round its
//! alpha the way the oracle rounds it. The oracle's own buffers are
//! *straight* (non-premultiplied) and ours are premultiplied, and the
//! conversions that forces are owned here rather than in a backend, so the
//! engine's arithmetic stays bit-identical whichever rasterizer is in use.

use crate::color::rgb_to_gray;

/// A premultiplied RGBA8 image: four bytes per pixel, row-major, no padding.
///
/// Premultiplied means each colour byte has already been scaled by the alpha
/// byte, which is what both rasterizers produce and what makes a source-over
/// blit a plain weighted sum. [`Pixmap::to_straight_bgra`] undoes it at the
/// output boundary, because the oracle's PNGs and MD5s are taken over a
/// straight-alpha BGRA buffer.
///
/// ```
/// use pdfrum_render::Pixmap;
///
/// let red = Pixmap::filled(2, 2, peniko::Color::from_rgba8(255, 0, 0, 255));
/// assert_eq!((red.width(), red.height()), (2, 2));
///
/// // Premultiplied on the inside; straight at the output boundary.
/// assert_eq!(red.pixel(0, 0), Some([255, 0, 0, 255]));
/// assert_eq!(&red.to_straight_rgb()[..3], &[255, 0, 0]);
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Pixmap {
    width: u32,
    height: u32,
    data: Vec<u8>,
}

impl Pixmap {
    /// A fully transparent pixmap of the given size.
    ///
    /// A zero in either axis is legal and yields an empty buffer, because the
    /// engine reaches this with clipped-away geometry all the time.
    ///
    /// A size whose buffer cannot be allocated yields an **empty** pixmap
    /// rather than ending the process — see [`Pixmap::try_new`], which is this
    /// without the fallback. Check [`Pixmap::width`] rather than assuming the
    /// size you asked for.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// let empty = Pixmap::new(2, 2);
    /// assert_eq!(empty.pixel(0, 0), Some([0, 0, 0, 0]));
    /// // A zero in either axis is legal: clipped-away geometry reaches this.
    /// assert!(Pixmap::new(0, 5).data().is_empty());
    /// // So is a size no allocator can meet; it comes back empty.
    /// assert_eq!(Pixmap::new(131_071, 131_071).width(), 0);
    /// ```
    #[must_use]
    pub fn new(width: u32, height: u32) -> Self {
        Self::try_new(width, height).unwrap_or(Self {
            width: 0,
            height: 0,
            data: Vec::new(),
        })
    }

    /// A fully transparent pixmap of the given size, or `None` when the buffer
    /// it needs cannot be allocated.
    ///
    /// `width * height * 4` is the whole of the request, and both axes can
    /// come from a file: an image declares its own `/Width` and `/Height`, and
    /// the largest pair the sample unpacker accepts asks for 68 GB. Two
    /// refusals, in order: the area cap first
    /// ([`pdfrum_page::image_area_is_workable`]), because Linux overcommit
    /// lets `try_reserve_exact` succeed for tens of gigabytes and the
    /// `resize` below then zeros them; then the fallible reserve, for a size
    /// inside the cap that this allocator still cannot meet. A `Vec` that
    /// cannot be grown calls `handle_alloc_error`, which **aborts** — no
    /// unwind, so no `catch_unwind` above it helps and no `Result` can carry
    /// it.
    ///
    /// [`Pixmap::new`] is this with the answer taken as an empty pixmap, which
    /// is what a caller that has no way to report the failure wants.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// assert!(Pixmap::try_new(2, 2).is_some());
    /// // Nothing has this much memory, and asking for it must not end the
    /// // process.
    /// assert!(Pixmap::try_new(131_071, 131_071).is_none());
    /// ```
    #[must_use]
    pub fn try_new(width: u32, height: u32) -> Option<Self> {
        if !pdfrum_page::image_area_is_workable(width, height) {
            return None;
        }
        let len = (width as usize)
            .saturating_mul(height as usize)
            .saturating_mul(4);
        let mut data = Vec::new();
        data.try_reserve_exact(len).ok()?;
        data.resize(len, 0);
        Some(Self {
            width,
            height,
            data,
        })
    }

    /// A pixmap of the given size, every pixel set to `color`.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// let red = Pixmap::filled(2, 1, peniko::Color::from_rgba8(255, 0, 0, 255));
    /// assert_eq!(red.data(), &[255, 0, 0, 255, 255, 0, 0, 255]);
    /// ```
    #[must_use]
    pub fn filled(width: u32, height: u32, color: peniko::Color) -> Self {
        // Built in one pass rather than `new` + `fill`: a zeroing allocation
        // followed by a full overwrite writes every byte of a page-sized
        // buffer twice, and at A4/150 DPI that is 8.7 MB of `memset` per
        // target with nothing to show for it. The doubling `extend_from_within`
        // keeps the write bulk — a per-pixel loop here measured *slower* than
        // the two `memset`s it replaced.
        let len = (width as usize)
            .saturating_mul(height as usize)
            .saturating_mul(4);
        let px = premultiply(color);
        let mut data = Vec::new();
        if !pdfrum_page::image_area_is_workable(width, height)
            || data.try_reserve_exact(len).is_err()
        {
            // As `new`: a buffer the allocator cannot meet comes back empty
            // rather than aborting. Both axes can come from a file.
            return Self {
                width: 0,
                height: 0,
                data,
            };
        }
        if len >= 4 {
            data.extend_from_slice(&px);
            while data.len() * 2 <= len {
                data.extend_from_within(..);
            }
            let rest = len - data.len();
            data.extend_from_within(..rest);
        }
        Self {
            width,
            height,
            data,
        }
    }

    /// Wrap an existing premultiplied RGBA8 buffer.
    ///
    /// Returns `None` when `data` is not exactly `width * height * 4` bytes.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// assert!(Pixmap::from_vec(1, 1, vec![255, 0, 0, 255]).is_some());
    /// // Not exactly `width * height * 4` bytes.
    /// assert!(Pixmap::from_vec(1, 1, vec![255, 0, 0]).is_none());
    /// ```
    #[must_use]
    pub fn from_vec(width: u32, height: u32, data: Vec<u8>) -> Option<Self> {
        let len = (width as usize)
            .checked_mul(height as usize)?
            .checked_mul(4)?;
        (data.len() == len).then_some(Self {
            width,
            height,
            data,
        })
    }

    /// The pixmap's width in pixels.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// assert_eq!(Pixmap::new(3, 2).width(), 3);
    /// ```
    #[must_use]
    pub fn width(&self) -> u32 {
        self.width
    }

    /// The pixmap's height in pixels.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// assert_eq!(Pixmap::new(3, 2).height(), 2);
    /// ```
    #[must_use]
    pub fn height(&self) -> u32 {
        self.height
    }

    /// The premultiplied RGBA8 bytes, row-major.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// // Four bytes per pixel, row-major, no padding.
    /// assert_eq!(Pixmap::new(2, 2).data().len(), 16);
    /// ```
    #[must_use]
    pub fn data(&self) -> &[u8] {
        &self.data
    }

    /// The premultiplied RGBA8 bytes, mutably.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// let mut p = Pixmap::new(1, 1);
    /// p.data_mut().copy_from_slice(&[255, 0, 0, 255]);
    /// assert_eq!(p.pixel(0, 0), Some([255, 0, 0, 255]));
    /// ```
    pub fn data_mut(&mut self) -> &mut [u8] {
        &mut self.data
    }

    /// Consume the pixmap, yielding its premultiplied RGBA8 bytes.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// assert_eq!(Pixmap::filled(1, 1, peniko::Color::from_rgba8(255, 0, 0, 255)).into_data(), vec![255, 0, 0, 255]);
    /// ```
    #[must_use]
    pub fn into_data(self) -> Vec<u8> {
        self.data
    }

    /// The premultiplied RGBA bytes of one pixel, or `None` when out of range.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// let red = Pixmap::filled(2, 2, peniko::Color::from_rgba8(255, 0, 0, 255));
    /// assert_eq!(red.pixel(1, 1), Some([255, 0, 0, 255]));
    /// // Out of range, not a panic.
    /// assert_eq!(red.pixel(2, 0), None);
    /// ```
    #[must_use]
    pub fn pixel(&self, x: u32, y: u32) -> Option<[u8; 4]> {
        let i = self.index(x, y)?;
        let px = self.data.get(i..i + 4)?;
        Some([*px.first()?, *px.get(1)?, *px.get(2)?, *px.get(3)?])
    }

    /// Reshape this pixmap to `width` x `height`, keeping the allocation and
    /// **whatever bytes were already in it**.
    ///
    /// Deliberately not named for a cleared buffer, because it does not
    /// produce one: the pixels are left as they were, and only a grow past
    /// the old length appends zeroes. The one caller is the per-glyph blit,
    /// which writes all four bytes of every pixel of the new extent before
    /// anything reads them, so zeroing here would be a second pass over
    /// bytes that are about to be overwritten. **A caller that does not write
    /// every pixel would blit the previous glyph's ink**; `Pixmap::new` is
    /// the spelling that starts transparent.
    pub(crate) fn reshape_keeping_pixels(&mut self, width: u32, height: u32) {
        let len = (width as usize)
            .saturating_mul(height as usize)
            .saturating_mul(4);
        self.width = width;
        self.height = height;
        // Grow without zeroing what is already there: the caller writes every
        // byte of the new extent before reading it, so re-zeroing would be a
        // second pass over the same pixels. `resize` only fills the bytes
        // beyond the current length, and `truncate` keeps the capacity.
        if len <= self.data.len() {
            self.data.truncate(len);
        } else {
            self.data.resize(len, 0);
        }
    }

    /// Overwrite one pixel with premultiplied RGBA bytes. Out of range is a
    /// no-op — the shading rasterizers clip by construction and a stray write
    /// must not panic on a crafted file.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// let mut p = Pixmap::new(2, 2);
    /// p.set_pixel(1, 0, [255, 0, 0, 255]);
    /// assert_eq!(p.pixel(1, 0), Some([255, 0, 0, 255]));
    /// // Out of range is a no-op: a crafted file must not panic here.
    /// p.set_pixel(9, 9, [255, 255, 255, 255]);
    /// ```
    pub fn set_pixel(&mut self, x: u32, y: u32, px: [u8; 4]) {
        let Some(i) = self.index(x, y) else { return };
        if let Some(slot) = self.data.get_mut(i..i + 4) {
            slot.copy_from_slice(&px);
        }
    }

    /// Set every pixel to `color`.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// let mut p = Pixmap::new(2, 2);
    /// p.fill(peniko::Color::from_rgba8(255, 0, 0, 255));
    /// assert_eq!(p.pixel(0, 0), Some([255, 0, 0, 255]));
    /// ```
    pub fn fill(&mut self, color: peniko::Color) {
        let px = premultiply(color);
        for chunk in self.data.as_chunks_mut::<4>().0 {
            *chunk = px;
        }
    }

    /// Scale every channel by `alpha`.
    ///
    /// The scalar is **truncated** to a byte (`0.5` becomes `127`, not `128`)
    /// and the per-pixel product truncates too. On a premultiplied buffer all
    /// four channels scale, where the oracle scales only the alpha byte of a
    /// straight one — the same image either way.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// let mut p = Pixmap::filled(1, 1, peniko::Color::from_rgba8(255, 0, 0, 255));
    /// // The scalar truncates to a byte: `0.5` is 127, not 128.
    /// p.multiply_alpha(0.5);
    /// assert_eq!(p.pixel(0, 0), Some([127, 0, 0, 127]));
    /// ```
    pub fn multiply_alpha(&mut self, alpha: f32) {
        if alpha >= 1.0 {
            return;
        }
        let a = alpha_byte_truncating(alpha);
        for b in &mut self.data {
            *b = mul255(*b, a);
        }
    }

    /// `[oracle-bug]` Remove a non-isolated group's initial backdrop from its
    /// finished pixels (ISO 32000 §11.4.6, §11.6.6).
    ///
    /// The group's buffer starts as a copy of the page beneath it, so that
    /// copy would be counted a **second** time when the group is composited
    /// back. The spec's formula, per channel and premultiplied:
    ///
    /// ```text
    /// C = Cn + (Cn - C0) * (a0 / agn - a0)
    /// ```
    ///
    /// `C0`/`a0` are the backdrop's and `Cn`/`agn` the group's; at
    /// `agn == a0` this returns a transparent pixel, the same image once
    /// composited back. `backdrop` must match this pixmap's dimensions; a
    /// mismatch is a no-op, as for [`Self::multiply_alpha_mask`].
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// let backdrop = Pixmap::filled(1, 1, peniko::Color::from_rgba8(255, 0, 0, 255));
    /// let mut group = backdrop.clone();
    ///
    /// // The group painted nothing over its backdrop, so removing it
    /// // leaves a transparent pixel -- the same image once composited back.
    /// group.remove_backdrop(&backdrop);
    /// assert_eq!(group.pixel(0, 0), Some([0, 0, 0, 0]));
    /// ```
    pub fn remove_backdrop(&mut self, backdrop: &Self) {
        // The oracle never removes the backdrop: it copies the page beneath
        // into the group buffer, then composites that buffer back with no
        // removal step anywhere between, so the backdrop is counted twice.
        // The error is invisible at group alpha 1 under Normal blending and
        // grows with both.
        if backdrop.width != self.width || backdrop.height != self.height {
            return;
        }
        for (chunk, base) in self
            .data
            .as_chunks_mut::<4>()
            .0
            .iter_mut()
            .zip(backdrop.data.as_chunks::<4>().0)
        {
            let (agn, a0) = (chunk[3], base[3]);
            // Nothing was added over this pixel: it is pure backdrop, and the
            // group contributes nothing there.
            if agn <= a0 {
                for b in chunk.iter_mut() {
                    *b = 0;
                }
                continue;
            }
            // Un-premultiply, apply the formula, re-premultiply. The result's
            // alpha is the group's own contribution, `(agn - a0) / (1 - a0)`.
            let (fa0, fagn) = (f32::from(a0) / 255.0, f32::from(agn) / 255.0);
            let out_alpha = if fa0 >= 1.0 {
                0.0
            } else {
                ((fagn - fa0) / (1.0 - fa0)).clamp(0.0, 1.0)
            };
            for index in 0..3 {
                let (Some(&cn), Some(&c0)) = (chunk.get(index), base.get(index)) else {
                    continue;
                };
                let un = |v: u8, a: f32| {
                    if a > 0.0 {
                        f32::from(v) / 255.0 / a
                    } else {
                        0.0
                    }
                };
                let (ucn, uc0) = (un(cn, fagn), un(c0, fa0));
                let colour = uc0.mul_add(-(fa0 / fagn - fa0), ucn.mul_add(fa0 / fagn - fa0, ucn));
                #[expect(
                    clippy::cast_possible_truncation,
                    clippy::cast_sign_loss,
                    reason = "the clamp bounds the value to 0.0..=255.0"
                )]
                let byte = (colour.clamp(0.0, 1.0) * out_alpha * 255.0).round() as u8;
                if let Some(slot) = chunk.get_mut(index) {
                    *slot = byte;
                }
            }
            #[expect(
                clippy::cast_possible_truncation,
                clippy::cast_sign_loss,
                reason = "the clamp bounds the value to 0.0..=255.0"
            )]
            let alpha_byte = (out_alpha * 255.0).round() as u8;
            if let Some(slot) = chunk.get_mut(3) {
                *slot = alpha_byte;
            }
        }
    }

    /// `[oracle-bug]` Lay `next` over this pixmap under **knockout**
    /// composition (ISO 32000 §11.6.6): where `next` has any coverage it
    /// *replaces* what is here, rather than blending over it.
    ///
    /// That is the whole of the knockout rule stated pixel-wise. Each object
    /// in a knockout group composites against the group's initial backdrop,
    /// so an earlier object's contribution at a pixel a later one also covers
    /// never reaches the result; only the coverage-weighted mix at the edges
    /// of the later object's own antialiasing keeps any of it.
    ///
    /// A mismatch in dimensions is a no-op, on the same invariant as
    /// [`Self::multiply_alpha_mask`].
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// let mut base = Pixmap::filled(1, 1, peniko::Color::from_rgba8(0, 0, 255, 255));
    /// let next = Pixmap::filled(1, 1, peniko::Color::from_rgba8(255, 0, 0, 255));
    ///
    /// // Full coverage replaces rather than blending.
    /// base.knockout_over(&next);
    /// assert_eq!(base.pixel(0, 0), Some([255, 0, 0, 255]));
    /// ```
    pub fn knockout_over(&mut self, next: &Self) {
        if next.width != self.width || next.height != self.height {
            return;
        }
        for (chunk, over) in self
            .data
            .as_chunks_mut::<4>()
            .0
            .iter_mut()
            .zip(next.data.as_chunks::<4>().0)
        {
            let a = over[3];
            if a == 0 {
                continue;
            }
            if a == u8::MAX {
                chunk.copy_from_slice(over);
                continue;
            }
            // Partial coverage at the new object's own edge: mix toward it by
            // its alpha, which is `replace` weighted by coverage.
            for (slot, &value) in chunk.iter_mut().zip(over.iter()) {
                *slot = value.saturating_add(mul255(*slot, 255 - a));
            }
        }
    }

    /// Lay `next` over this pixmap under the **fill-and-stroke knockout**:
    /// wherever `next` has coverage it replaces what is here outright, its
    /// own alpha included.
    ///
    /// This is [`Self::knockout_over`]'s sibling, and the one place they
    /// differ is what happens to the destination's *alpha*. `knockout_over`
    /// mixes toward `next` by coverage, so a translucent `next` over an
    /// opaque `self` stays opaque — right for a knockout *group*, whose
    /// members all composite against one already-painted backdrop that is
    /// itself part of the buffer.
    ///
    /// It is wrong for `CFX_RenderDevice::DrawFillStrokePath`
    /// (`core/fxge/cfx_renderdevice.cpp:832-889`). There the buffer is seeded
    /// with a **copy of the backdrop** (`:864-871`) before being handed to a
    /// device built with `group_knockout=true` (`:873-875`), so each paint
    /// composites against the page and the stroke never sees the fill at all.
    /// Our buffer is seeded transparent instead — the engine draws into a
    /// sub-target and blits — so the equivalent is to carry the stroke's own
    /// premultiplied value out of the buffer and let the blit composite it
    /// against the page exactly once.
    ///
    /// `fx/path/transparent1.pdf` is the witness, and the arithmetic is
    /// decisive. Its stroke is red at `/CA 0.58`, premultiplied
    /// `(148, 0, 0, 148)`. Blended over the opaque black fill the alpha comes
    /// back to 255 and the colour to 148 — `#930000`, which the oracle never
    /// produces anywhere on the page. Replaced outright it stays
    /// `(148, 0, 0, 148)` and the blit over the white page gives `#ff6c6c`,
    /// the single uniform ring the oracle paints.
    ///
    /// A mismatch in dimensions is a no-op, on the same invariant as
    /// [`Self::multiply_alpha_mask`].
    pub(crate) fn knockout_replace(&mut self, next: &Self) {
        if next.width != self.width || next.height != self.height {
            return;
        }
        for (chunk, over) in self
            .data
            .as_chunks_mut::<4>()
            .0
            .iter_mut()
            .zip(next.data.as_chunks::<4>().0)
        {
            let a = over[3];
            if a == 0 {
                continue;
            }
            // Any coverage at all knocks the destination out: the stroke's
            // premultiplied value *is* the result, alpha included. There is
            // no blend term, which is exactly what separates this from
            // `knockout_over`.
            chunk.copy_from_slice(over);
        }
    }

    /// Multiply every channel by a coverage mask, PDFium's
    /// `MultiplyAlphaMask`. The mask must match the pixmap's dimensions
    /// exactly — an invariant, not a preference: a mismatched mask silently
    /// disables masking on both backends, so the engine never emits one.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// use pdfrum_render::AlphaMask;
    ///
    /// let mut p = Pixmap::filled(1, 1, peniko::Color::from_rgba8(255, 0, 0, 255));
    /// p.multiply_alpha_mask(&AlphaMask::filled(1, 1, 128));
    /// assert_eq!(p.pixel(0, 0), Some([128, 0, 0, 128]));
    ///
    /// // A mismatched mask is a no-op, which is why the engine never emits one.
    /// p.multiply_alpha_mask(&AlphaMask::filled(4, 4, 0));
    /// assert_eq!(p.pixel(0, 0), Some([128, 0, 0, 128]));
    /// ```
    pub fn multiply_alpha_mask(&mut self, mask: &AlphaMask) {
        if mask.width() != self.width || mask.height() != self.height {
            return;
        }
        for (chunk, &m) in self.data.as_chunks_mut::<4>().0.iter_mut().zip(mask.data()) {
            for b in chunk {
                *b = mul255(*b, m);
            }
        }
    }

    /// The 8-bit luminosity of every pixel under the oracle's gray weights,
    /// for a soft mask's luminosity readback (ISO 32000 §11.6.5.2).
    ///
    /// Deliberately *not* either backend's luminance helper: both use BT.709
    /// coefficients and the oracle uses NTSC ones on a 0..100 integer scale.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// // The oracle's NTSC weights on a 0..100 integer scale, not BT.709.
    /// let blue = Pixmap::filled(1, 1, peniko::Color::from_rgba8(0, 0, 255, 255));
    /// assert_eq!(blue.luminosity_mask().data(), &[28]);
    /// ```
    #[must_use]
    pub fn luminosity_mask(&self) -> AlphaMask {
        let mut out = Vec::with_capacity(self.data.len() / 4);
        for &[r, g, b, a] in self.data.as_chunks::<4>().0 {
            // The oracle's luminosity buffer is opaque (24bpp BGR cleared to
            // the /BC backdrop), so un-premultiplying is the identity there.
            // Ours can carry alpha where a group did not paint over the
            // backdrop clear, so undo the premultiplication first.
            let [r, g, b] = unpremultiply_rgb(r, g, b, a);
            out.push(rgb_to_gray(r, g, b));
        }
        AlphaMask::from_vec(self.width, self.height, out)
            .unwrap_or_else(|| AlphaMask::new(self.width, self.height))
    }

    /// The alpha channel on its own, for an alpha-type soft mask.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// let red = Pixmap::filled(1, 1, peniko::Color::from_rgba8(255, 0, 0, 255));
    /// assert_eq!(red.alpha_mask().data(), &[255]);
    /// ```
    #[must_use]
    pub fn alpha_mask(&self) -> AlphaMask {
        let out: Vec<u8> = self.data.as_chunks::<4>().0.iter().map(|c| c[3]).collect();
        AlphaMask::from_vec(self.width, self.height, out)
            .unwrap_or_else(|| AlphaMask::new(self.width, self.height))
    }

    /// The straight-alpha BGRA bytes the oracle hashes and encodes.
    ///
    /// `opaque` forces the alpha byte to `0xFF` without touching the colours.
    /// A page with no transparency is rendered into a 32bpp buffer whose
    /// fourth byte is padding, and a hash taken over these bytes sees that
    /// padding as `0xFF` rather than as whatever the render left there.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// let red = Pixmap::filled(1, 1, peniko::Color::from_rgba8(255, 0, 0, 255));
    /// // Blue, green, red, alpha.
    /// assert_eq!(red.to_straight_bgra(false), vec![0, 0, 255, 255]);
    ///
    /// // `opaque` forces the alpha byte without touching the colours, which
    /// // is what a hash over a 32bpp buffer with padding sees.
    /// let clear = Pixmap::new(1, 1);
    /// assert_eq!(clear.to_straight_bgra(true), vec![0, 0, 0, 255]);
    /// ```
    #[must_use]
    pub fn to_straight_bgra(&self, opaque: bool) -> Vec<u8> {
        let mut out = Vec::with_capacity(self.data.len());
        for &[r, g, b, a] in self.data.as_chunks::<4>().0 {
            let [r, g, b] = unpremultiply_rgb(r, g, b, a);
            out.extend_from_slice(&[b, g, r, if opaque { 0xFF } else { a }]);
        }
        out
    }

    /// The straight-alpha RGB bytes, three per pixel — the shape the oracle's
    /// PNG encoder writes for a page with no transparency.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// let red = Pixmap::filled(1, 1, peniko::Color::from_rgba8(255, 0, 0, 255));
    /// assert_eq!(red.to_straight_rgb(), vec![255, 0, 0]);
    /// ```
    #[must_use]
    pub fn to_straight_rgb(&self) -> Vec<u8> {
        let mut out = Vec::with_capacity(self.data.len() / 4 * 3);
        for &[r, g, b, a] in self.data.as_chunks::<4>().0 {
            out.extend_from_slice(&unpremultiply_rgb(r, g, b, a));
        }
        out
    }

    /// The straight-alpha RGBA bytes, four per pixel — the shape the oracle's
    /// PNG encoder writes for a page that has transparency.
    ///
    /// ```
    /// use pdfrum_render::Pixmap;
    ///
    /// let red = Pixmap::filled(1, 1, peniko::Color::from_rgba8(255, 0, 0, 255));
    /// assert_eq!(red.to_straight_rgba(), vec![255, 0, 0, 255]);
    /// ```
    #[must_use]
    pub fn to_straight_rgba(&self) -> Vec<u8> {
        let mut out = Vec::with_capacity(self.data.len());
        for &[r, g, b, a] in self.data.as_chunks::<4>().0 {
            let [r, g, b] = unpremultiply_rgb(r, g, b, a);
            out.extend_from_slice(&[r, g, b, a]);
        }
        out
    }

    fn index(&self, x: u32, y: u32) -> Option<usize> {
        (x < self.width && y < self.height)
            .then(|| (y as usize).checked_mul(self.width as usize))
            .flatten()?
            .checked_add(x as usize)?
            .checked_mul(4)
    }
}

/// An 8-bit coverage plane: one byte per pixel, `255` fully opaque.
///
/// This is both a soft mask (ISO 32000 §11.6.5) and a clip mask. It is always
/// sized and aligned to the device it applies to, because a mismatched mask
/// is silently ignored by `vello_cpu` and merely warned about by
/// `tiny-skia` — it fails *open*.
///
/// ```
/// use pdfrum_render::AlphaMask;
///
/// let mask = AlphaMask::filled(2, 2, 128);
/// assert_eq!((mask.width(), mask.height()), (2, 2));
/// // One byte per pixel; 255 is fully opaque.
/// assert_eq!(mask.data(), &[128; 4]);
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct AlphaMask {
    width: u32,
    height: u32,
    data: Vec<u8>,
}

impl AlphaMask {
    /// A fully transparent (all-zero) mask.
    ///
    /// ```
    /// use pdfrum_render::AlphaMask;
    ///
    /// // Fully transparent: all zero.
    /// assert_eq!(AlphaMask::new(2, 1).data(), &[0, 0]);
    /// ```
    #[must_use]
    pub fn new(width: u32, height: u32) -> Self {
        let len = (width as usize).saturating_mul(height as usize);
        Self {
            width,
            height,
            data: vec![0; len],
        }
    }

    /// A mask with every byte set to `value`.
    ///
    /// ```
    /// use pdfrum_render::AlphaMask;
    ///
    /// assert_eq!(AlphaMask::filled(2, 1, 255).data(), &[255, 255]);
    /// ```
    #[must_use]
    pub fn filled(width: u32, height: u32, value: u8) -> Self {
        let len = (width as usize).saturating_mul(height as usize);
        Self {
            width,
            height,
            data: vec![value; len],
        }
    }

    /// Wrap an existing coverage plane, or `None` on a size mismatch.
    ///
    /// ```
    /// use pdfrum_render::AlphaMask;
    ///
    /// assert!(AlphaMask::from_vec(2, 1, vec![0, 255]).is_some());
    /// // Not exactly `width * height` bytes.
    /// assert!(AlphaMask::from_vec(2, 1, vec![0]).is_none());
    /// ```
    #[must_use]
    pub fn from_vec(width: u32, height: u32, data: Vec<u8>) -> Option<Self> {
        let len = (width as usize).checked_mul(height as usize)?;
        (data.len() == len).then_some(Self {
            width,
            height,
            data,
        })
    }

    /// The mask's width in pixels.
    ///
    /// ```
    /// use pdfrum_render::AlphaMask;
    ///
    /// assert_eq!(AlphaMask::new(3, 2).width(), 3);
    /// ```
    #[must_use]
    pub fn width(&self) -> u32 {
        self.width
    }

    /// The mask's height in pixels.
    ///
    /// ```
    /// use pdfrum_render::AlphaMask;
    ///
    /// assert_eq!(AlphaMask::new(3, 2).height(), 2);
    /// ```
    #[must_use]
    pub fn height(&self) -> u32 {
        self.height
    }

    /// The coverage bytes, row-major.
    ///
    /// ```
    /// use pdfrum_render::AlphaMask;
    ///
    /// // One byte per pixel, row-major.
    /// assert_eq!(AlphaMask::new(2, 2).data().len(), 4);
    /// ```
    #[must_use]
    pub fn data(&self) -> &[u8] {
        &self.data
    }

    /// The coverage bytes, mutably.
    ///
    /// ```
    /// use pdfrum_render::AlphaMask;
    ///
    /// let mut mask = AlphaMask::new(1, 1);
    /// mask.data_mut()[0] = 255;
    /// assert_eq!(mask.data(), &[255]);
    /// ```
    pub fn data_mut(&mut self) -> &mut [u8] {
        &mut self.data
    }

    /// Consume the mask, yielding its coverage bytes.
    ///
    /// ```
    /// use pdfrum_render::AlphaMask;
    ///
    /// assert_eq!(AlphaMask::filled(1, 1, 200).into_data(), vec![200]);
    /// ```
    #[must_use]
    pub fn into_data(self) -> Vec<u8> {
        self.data
    }

    /// Intersect with another mask of the same size: the truncating integer
    /// product `old * new / 255`.
    ///
    /// ```
    /// use pdfrum_render::AlphaMask;
    ///
    /// let mut mask = AlphaMask::filled(1, 1, 255);
    /// // The truncating integer product `old * new / 255`.
    /// mask.intersect(&AlphaMask::filled(1, 1, 128));
    /// assert_eq!(mask.data(), &[128]);
    /// ```
    pub fn intersect(&mut self, other: &Self) {
        if other.width != self.width || other.height != self.height {
            return;
        }
        for (a, &b) in self.data.iter_mut().zip(&other.data) {
            *a = mul255(*a, b);
        }
    }

    /// Map every byte through a 256-entry lookup — a soft mask's `/TR`.
    ///
    /// ```
    /// use pdfrum_render::AlphaMask;
    ///
    /// let mut mask = AlphaMask::filled(1, 1, 10);
    /// // A soft mask's `/TR`, as a 256-entry lookup.
    /// let mut table = [0u8; 256];
    /// table[10] = 200;
    /// mask.apply_transfer(&table);
    /// assert_eq!(mask.data(), &[200]);
    /// ```
    pub fn apply_transfer(&mut self, table: &[u8; 256]) {
        for b in &mut self.data {
            *b = *table.get(*b as usize).unwrap_or(b);
        }
    }

    /// Place `src` at `(x, y)` in a device-sized mask, zero everywhere else.
    ///
    /// This is E8's padding: a soft mask is produced at the clip rect's size
    /// and must be handed to `push_layer` device-sized.
    ///
    /// ```
    /// use pdfrum_render::AlphaMask;
    ///
    /// // A mask produced at a clip rect's size, padded out to the device.
    /// let small = AlphaMask::filled(1, 1, 255);
    /// let placed = small.placed_in(2, 2, 1, 1);
    /// assert_eq!(placed.data(), &[0, 0, 0, 255]);
    /// ```
    #[must_use]
    pub fn placed_in(&self, width: u32, height: u32, x: i32, y: i32) -> Self {
        let mut out = Self::new(width, height);
        // `0 <= v < limit` with `limit: u32` puts the value inside `usize` on
        // every target, so `try_into` cannot fail once the guard has passed.
        let in_range = |v: i64, limit: u32| -> Option<usize> {
            (v >= 0 && v < i64::from(limit))
                .then(|| usize::try_from(v).ok())
                .flatten()
        };
        for row in 0..self.height {
            let Some(dy) = in_range(i64::from(row) + i64::from(y), height) else {
                continue;
            };
            for col in 0..self.width {
                let Some(dx) = in_range(i64::from(col) + i64::from(x), width) else {
                    continue;
                };
                let src = self
                    .data
                    .get((row as usize * self.width as usize) + col as usize);
                let dst = out.data.get_mut((dy * width as usize) + dx);
                if let (Some(&src), Some(dst)) = (src, dst) {
                    *dst = src;
                }
            }
        }
        out
    }
}

/// `alpha * 255` cast to an integer: **truncating**, so `ca 0.5` is `127`.
///
/// `alpha_byte_rounding` is the other conversion; the two differ on a large
/// fraction of real `ca` values.
///
/// ```
/// use pdfrum_render::pixmap::alpha_byte_truncating;
///
/// // Truncating, so a `ca 0.5` is 127 rather than 128.
/// assert_eq!(alpha_byte_truncating(0.5), 127);
/// assert_eq!(alpha_byte_truncating(1.0), 255);
/// ```
#[must_use]
pub fn alpha_byte_truncating(alpha: f32) -> u8 {
    if alpha.is_nan() {
        return 0;
    }
    #[expect(
        clippy::cast_possible_truncation,
        clippy::cast_sign_loss,
        reason = "the NaN guard and the clamp bound the product to 0.0..=255.0; \
                  the truncation *is* the ported behaviour, not an accident"
    )]
    let byte = (alpha.clamp(0.0, 1.0) * 255.0) as u8;
    byte
}

/// `round(255 * alpha)` — the *other* alpha conversion, used where a shading
/// pattern resolves its painting object's alpha. Half-away-from-zero, unlike
/// [`alpha_byte_truncating`]; the two differ on a large fraction of real `ca`
/// values.
#[must_use]
pub(crate) fn alpha_byte_rounding(alpha: f32) -> u8 {
    if alpha.is_nan() {
        return 0;
    }
    #[expect(
        clippy::cast_possible_truncation,
        clippy::cast_sign_loss,
        reason = "the NaN guard and the clamp bound the rounded product to 0..=255"
    )]
    let byte = (alpha.clamp(0.0, 1.0) * 255.0).round() as u8;
    byte
}

/// `a * b / 255`, truncating — the oracle's ubiquitous 8-bit product.
///
/// ```
/// use pdfrum_render::pixmap::mul255;
///
/// assert_eq!(mul255(255, 128), 128);
/// // Truncating: 128 * 128 / 255 is 64, not 64.25 rounded.
/// assert_eq!(mul255(128, 128), 64);
/// ```
#[must_use]
pub fn mul255(a: u8, b: u8) -> u8 {
    #[expect(
        clippy::cast_possible_truncation,
        reason = "255*255/255 == 255 is the maximum, so the quotient always fits u8"
    )]
    let byte = ((u32::from(a) * u32::from(b)) / 255) as u8;
    byte
}

/// `AlphaMerge(d, s, a) = (d*(255-a) + s*a) / 255`, truncating and unclamped.
///
/// ```
/// use pdfrum_render::pixmap::alpha_merge;
///
/// // Full alpha takes the source; none of it keeps the destination.
/// assert_eq!(alpha_merge(0, 255, 255), 255);
/// assert_eq!(alpha_merge(0, 255, 0), 0);
/// ```
#[must_use]
pub fn alpha_merge(dest: u8, src: u8, alpha: u8) -> u8 {
    let a = u32::from(alpha);
    #[expect(
        clippy::cast_possible_truncation,
        reason = "the numerator is a convex combination of two 0..=255 bytes \
                  scaled by 255, so the quotient is itself 0..=255"
    )]
    let byte = ((u32::from(dest) * (255 - a) + u32::from(src) * a) / 255) as u8;
    byte
}

/// `AlphaUnion(d, s) = d + s - d*s/255`.
///
/// The truncating product makes this *not* the exact `1-(1-d)(1-s)` a float
/// composite would give, and it never quite reaches 255 from two partial
/// alphas — `AlphaUnion(128, 128) == 192`, where the float form gives 191.75.
#[must_use]
pub(crate) fn alpha_union(dest: u8, src: u8) -> u8 {
    let merged = u32::from(dest) + u32::from(src) - (u32::from(dest) * u32::from(src)) / 255;
    // Bounded by 255 for every byte pair, but the C++'s `uint8_t` return would
    // wrap rather than saturate if it were not, so say so rather than cast.
    u8::try_from(merged).unwrap_or(u8::MAX)
}

/// A `peniko::Color` as premultiplied RGBA8.
#[must_use]
pub(crate) fn premultiply(color: peniko::Color) -> [u8; 4] {
    let [r, g, b, a] = color.to_rgba8().to_u8_array();
    [mul255(r, a), mul255(g, a), mul255(b, a), a]
}

/// Undo premultiplication on one pixel's colour channels.
///
/// Rounds the quotient rather than truncating (`+ alpha / 2`), which keeps
/// the round trip through [`premultiply`] stable for opaque pixels.
#[must_use]
pub(crate) fn unpremultiply_rgb(r: u8, g: u8, b: u8, a: u8) -> [u8; 3] {
    if a == 0 {
        return [0, 0, 0];
    }
    if a == 255 {
        return [r, g, b];
    }
    let a32 = u32::from(a);
    let up = |c: u8| -> u8 { ((u32::from(c) * 255 + a32 / 2) / a32).min(255) as u8 };
    [up(r), up(g), up(b)]
}

#[cfg(test)]
mod tests {
    use super::*;

    /// A buffer no allocator can meet is an answer, not an abort.
    ///
    /// `/Width` and `/Height` are the file's, and `ImageDict` accepts each up
    /// to 131071 — so `to_pixmap` reached `vec![0; 131071 * 131071 * 4]`, and
    /// `handle_alloc_error` ends the process without unwinding. The area cap
    /// is what turns that into `None` without touching the allocator:
    /// `try_reserve_exact` of 68 GB often succeeds on overcommit, and the
    /// `resize` that follows then zeros 68 GB.
    #[test]
    fn a_size_no_allocator_can_meet_comes_back_empty_rather_than_aborting() {
        // 68 GB at four bytes a pixel, from a dictionary that fits in 700
        // bytes of PDF.
        assert_eq!(Pixmap::try_new(131_071, 131_071), None);
        assert_eq!(Pixmap::new(131_071, 131_071).width(), 0);
        assert!(Pixmap::new(131_071, 131_071).data().is_empty());
        assert_eq!(
            Pixmap::filled(131_071, 131_071, peniko::Color::BLACK).width(),
            0
        );
        // 65536 square is inside each axis cap and is 4.3 Gpx / 17 GB of
        // pixmap — the size that would still pass a reserve-only check.
        assert_eq!(Pixmap::try_new(65_536, 65_536), None);

        // A size that *can* be met is untouched by any of it.
        assert_eq!(Pixmap::try_new(3, 2).map(|p| p.data().len()), Some(24));
        assert_eq!(Pixmap::new(3, 2).data().len(), 24);
    }

    /// Knockout composition, stated pixel-wise: where a
    /// later object has coverage it *replaces* the earlier one rather than
    /// blending over it. That is the whole of §11.6.6's rule.
    // The oracle does not implement it: SetGroupKnockout is an empty body at
    // renderdevicedriver_iface.cpp:132 that the AGG driver never overrides.
    #[test]
    fn knockout_replaces_rather_than_blending() {
        let red = peniko::Color::from_rgba8(255, 0, 0, 255);
        let blue = peniko::Color::from_rgba8(0, 0, 255, 255);

        // Full coverage replaces outright — under Normal compositing a
        // translucent blue over red would mix; here an opaque one wins whole.
        let mut base = Pixmap::filled(1, 1, red);
        base.knockout_over(&Pixmap::filled(1, 1, blue));
        assert_eq!(base.pixel(0, 0), Some([0, 0, 255, 255]));

        // No coverage leaves the earlier object alone: knockout replaces
        // where the later object *is*, not everywhere.
        let mut base = Pixmap::filled(1, 1, red);
        base.knockout_over(&Pixmap::new(1, 1));
        assert_eq!(base.pixel(0, 0), Some([255, 0, 0, 255]));
    }

    /// The fill-and-stroke knockout keeps the stroke's own alpha, which is
    /// what separates it from [`Pixmap::knockout_over`].
    ///
    /// `fx/path/transparent1.pdf`'s numbers exactly: a red stroke at
    /// `/CA 0.58` is premultiplied `(148, 0, 0, 148)`, and it lands on the
    /// opaque black fill the same path already painted. Blending returns the
    /// pixel to opaque and yields `#930000` once blitted; replacing keeps
    /// `(148, 0, 0, 148)`, which composites against the white page as
    /// `#ff6c6c` — the one colour the oracle paints there.
    #[test]
    fn the_fill_stroke_knockout_keeps_the_strokes_alpha() {
        let black_fill = Pixmap::filled(1, 1, peniko::Color::from_rgba8(0, 0, 0, 255));
        let translucent_stroke =
            Pixmap::from_vec(1, 1, vec![148, 0, 0, 148]).expect("one premultiplied pixel");

        let mut blended = black_fill.clone();
        blended.knockout_over(&translucent_stroke);
        assert_eq!(
            blended.pixel(0, 0),
            Some([148, 0, 0, 255]),
            "knockout_over promotes the overlap to opaque, which is the defect"
        );

        let mut replaced = black_fill;
        replaced.knockout_replace(&translucent_stroke);
        assert_eq!(
            replaced.pixel(0, 0),
            Some([148, 0, 0, 148]),
            "the stroke's own alpha must survive so the blit composites it once"
        );
    }

    /// A mismatched overlay is a no-op, on the same
    /// invariant `multiply_alpha_mask` keeps.
    #[test]
    fn a_mismatched_knockout_overlay_changes_nothing() {
        let mut base = Pixmap::filled(2, 2, peniko::Color::from_rgba8(7, 8, 9, 255));
        let before = base.clone();
        base.knockout_over(&Pixmap::filled(3, 3, peniko::Color::BLACK));
        assert_eq!(base, before);
    }

    /// The two properties the backdrop-removal formula
    /// has to have.
    // The oracle gives it neither: cpdf_renderstatus.cpp does not implement
    // backdrop removal at all.
    #[test]
    fn removing_the_backdrop_leaves_only_the_groups_own_contribution() {
        // 1. A pixel nothing was drawn over is pure backdrop, so the group
        //    contributes nothing there and must come back transparent —
        //    otherwise compositing draws the page over itself.
        let backdrop = Pixmap::filled(1, 1, peniko::Color::from_rgba8(90, 120, 150, 255));
        let mut group = backdrop.clone();
        group.remove_backdrop(&backdrop);
        assert_eq!(group.pixel(0, 0), Some([0, 0, 0, 0]));

        // 2. Over a *translucent* backdrop the group's own contribution is
        //    recoverable, and comes back at the alpha the group added. Here
        //    the backdrop is half-opaque and the group finished opaque, so
        //    the group's own alpha is `(1 - 0.5) / (1 - 0.5) = 1`.
        let half = Pixmap::filled(1, 1, peniko::Color::from_rgba8(45, 60, 75, 128));
        let mut group = Pixmap::filled(1, 1, peniko::Color::from_rgba8(200, 40, 10, 255));
        group.remove_backdrop(&half);
        let after = group.pixel(0, 0).expect("one pixel");
        assert_eq!(after[3], 255, "the group finished opaque over the backdrop");
        // And it is not the backdrop: the removal changed the colour.
        assert_ne!(after, [45, 60, 75, 128]);

        // 3. `[oracle-bug]` note, recorded rather than hidden: over a fully
        //    **opaque** backdrop a non-isolated group's alpha cannot rise
        //    above 255, so the alpha channel carries no record of what the
        //    group painted and the removal yields a transparent pixel. That
        //    is the correct composite — the page beneath is already those
        //    pixels — but it means this formula recovers nothing extra there,
        //    which is why the two rows it turns byte-exact are the evidence
        //    that matters and not this unit test.
        let mut group = Pixmap::filled(1, 1, peniko::Color::from_rgba8(200, 40, 10, 255));
        group.remove_backdrop(&backdrop);
        assert_eq!(group.pixel(0, 0), Some([0, 0, 0, 0]));
    }

    /// A mismatched backdrop is a no-op, on the same
    /// invariant `multiply_alpha_mask` keeps.
    #[test]
    fn removing_a_mismatched_backdrop_changes_nothing() {
        let mut group = Pixmap::filled(2, 2, peniko::Color::from_rgba8(1, 2, 3, 200));
        let before = group.clone();
        group.remove_backdrop(&Pixmap::filled(3, 3, peniko::Color::BLACK));
        assert_eq!(group, before);
    }

    #[test]
    fn multiply_alpha_truncates() {
        // cfx_dibitmap.cpp:382-410 casts, it does not round: 0.5 -> 127.
        assert_eq!(alpha_byte_truncating(0.5), 127);
        assert_eq!(alpha_byte_rounding(0.5), 128);

        let mut p = Pixmap::filled(1, 1, peniko::Color::from_rgba8(255, 255, 255, 255));
        p.multiply_alpha(0.5);
        assert_eq!(p.pixel(0, 0), Some([127, 127, 127, 127]));
    }

    #[test]
    fn multiply_alpha_one_is_exact_early_return() {
        let mut p = Pixmap::filled(2, 2, peniko::Color::from_rgba8(10, 20, 30, 200));
        let before = p.clone();
        p.multiply_alpha(1.0);
        assert_eq!(p, before);
    }

    #[test]
    fn premul_roundtrip() {
        // Ports CFXDIBitmapTest.{Pre,Un}Multiply*: a straight colour through
        // premultiply and back is itself for every alpha that can represent it.
        for a in [0u8, 1, 64, 128, 254, 255] {
            for c in [0u8, 1, 127, 128, 254, 255] {
                let color = peniko::Color::from_rgba8(c, c, c, a);
                let [pr, pg, pb, pa] = premultiply(color);
                assert_eq!(pa, a);
                let [ur, _, _] = unpremultiply_rgb(pr, pg, pb, pa);
                if a == 0 {
                    assert_eq!(ur, 0);
                } else {
                    // Premultiplication is lossy below full alpha; the round
                    // trip must stay within the quantisation step.
                    let step = 255_u32.div_ceil(u32::from(a).max(1));
                    assert!(
                        u32::from(ur).abs_diff(u32::from(c)) <= step,
                        "a={a} c={c} ur={ur}"
                    );
                }
            }
        }
    }

    #[test]
    fn alpha_merge_truncates_and_does_not_clamp() {
        assert_eq!(alpha_merge(0, 255, 128), 128);
        assert_eq!(alpha_merge(255, 0, 128), 127);
        assert_eq!(alpha_merge(100, 200, 0), 100);
        assert_eq!(alpha_merge(100, 200, 255), 200);
    }

    #[test]
    fn mask_intersect_is_truncating_product() {
        let mut a = AlphaMask::filled(2, 1, 128);
        let b = AlphaMask::filled(2, 1, 128);
        a.intersect(&b);
        // 128*128/255 = 64.25 -> 64
        assert_eq!(a.data(), &[64, 64]);
    }

    #[test]
    fn mask_placed_in_pads_with_zero() {
        let m = AlphaMask::filled(2, 2, 200);
        let placed = m.placed_in(4, 4, 1, 1);
        assert_eq!(placed.data().first().copied(), Some(0));
        assert_eq!(placed.data().get(5).copied(), Some(200));
        assert_eq!(placed.data().get(10).copied(), Some(200));
        assert_eq!(placed.data().get(15).copied(), Some(0));
    }

    #[test]
    fn opaque_output_forces_alpha_ff() {
        // pdfium_test asks for FPDFBitmap_BGRx on a page with no transparency
        // and the golden MD5 is over that buffer, padding byte included.
        let p = Pixmap::filled(1, 1, peniko::Color::from_rgba8(1, 2, 3, 255));
        assert_eq!(p.to_straight_bgra(true), vec![3, 2, 1, 0xFF]);
    }

    #[test]
    fn luminosity_uses_ntsc_not_bt709() {
        // Pure blue: FXRGB2GRAY gives 255*11/100 = 28; BT.709 would give 18.
        let p = Pixmap::filled(1, 1, peniko::Color::from_rgba8(0, 0, 255, 255));
        assert_eq!(p.luminosity_mask().data(), &[28]);
    }
}

/// Encoding to PNG, behind the `png` feature.
#[cfg(feature = "png")]
impl Pixmap {
    /// The pixmap as a PNG file's bytes: eight-bit RGBA, unpremultiplied.
    ///
    /// The alpha is undone on the way out because PNG's is *straight*
    /// (ISO 15948 §6.2) and this buffer's is premultiplied. A viewer
    /// multiplies by alpha when it composites, so writing the premultiplied
    /// bytes would darken every partly transparent pixel a second time --
    /// a 50% red would leave here as `128,0,0,128` and land as `64,0,0`.
    /// Fully opaque pixels are identical either way, which is why this is
    /// invisible on most pages.
    ///
    /// # Errors
    ///
    /// [`Error::Png`](crate::Error::Png) when the encoder refuses the dimensions.
    pub fn encode_png(&self) -> Result<Vec<u8>, crate::Error> {
        let mut out = Vec::new();
        let mut encoder = png::Encoder::new(&mut out, self.width, self.height);
        encoder.set_color(png::ColorType::Rgba);
        encoder.set_depth(png::BitDepth::Eight);
        let mut writer = encoder.write_header()?;
        writer.write_image_data(&self.to_straight_rgba())?;
        writer.finish()?;
        Ok(out)
    }

    /// Writes the pixmap to `path` as a PNG file.
    ///
    /// # Errors
    ///
    /// [`Error::Png`](crate::Error::Png) as [`Pixmap::encode_png`], and [`Error::Io`](crate::Error::Io) when the
    /// file cannot be written.
    pub fn save_png(&self, path: impl AsRef<std::path::Path>) -> Result<(), crate::Error> {
        std::fs::write(path, self.encode_png()?)?;
        Ok(())
    }
}

#[cfg(all(test, feature = "png"))]
mod png_tests {
    use super::Pixmap;

    #[test]
    fn a_pixmap_round_trips_through_png() {
        let pixmap = Pixmap::from_vec(2, 1, vec![255, 0, 0, 255, 0, 0, 255, 128]).unwrap();
        let bytes = pixmap.encode_png().unwrap();
        assert_eq!(bytes.get(..8), Some(b"\x89PNG\r\n\x1a\n".as_slice()));
        let decoder = png::Decoder::new(std::io::Cursor::new(bytes));
        let mut reader = decoder.read_info().unwrap();
        let mut out = vec![0; reader.output_buffer_size().unwrap()];
        let info = reader.next_frame(&mut out).unwrap();
        assert_eq!(
            (info.width, info.height, info.color_type),
            (2, 1, png::ColorType::Rgba)
        );
        // Straight alpha, not the buffer's own premultiplied bytes: the
        // second pixel is stored `0,0,255,128` and must land `0,0,255,128`
        // only because its colour is already at full intensity under that
        // alpha. See `unpremultiplied_alpha_is_what_reaches_the_file`.
        assert_eq!(
            out.get(..info.buffer_size()),
            Some(pixmap.to_straight_rgba().as_slice())
        );
    }

    /// PNG's alpha is straight and this buffer's is premultiplied, so the
    /// conversion has to happen on the way out.
    ///
    /// The regression: `encode_png` wrote `self.data` verbatim while its own
    /// documentation said "unpremultiplied", so every partly transparent
    /// pixel came out darkened -- a viewer multiplies by alpha again when it
    /// composites. Opaque pixels are identical either way, which is why no
    /// golden caught it.
    #[test]
    fn unpremultiplied_alpha_is_what_reaches_the_file() {
        // Half-alpha red: premultiplied storage is 128,0,0,128; the file must
        // carry 255,0,0,128.
        let pixmap = Pixmap::filled(1, 1, peniko::Color::from_rgba8(255, 0, 0, 128));
        assert_eq!(pixmap.data(), &[128, 0, 0, 128], "stored premultiplied");

        let decoder = png::Decoder::new(std::io::Cursor::new(pixmap.encode_png().unwrap()));
        let mut reader = decoder.read_info().unwrap();
        let mut out = vec![0; reader.output_buffer_size().unwrap()];
        let info = reader.next_frame(&mut out).unwrap();
        assert_eq!(
            out.get(..info.buffer_size()),
            Some([255, 0, 0, 128].as_slice()),
            "the file must carry straight alpha"
        );
    }
}