856f865cf98d
render.rs
//! Rasterizes a [`TextLayout`] into a document-space [`Surface`] of any pixel format.
use photocraft_color::{Color, ColorMode, PixelFormat, SampleType};
use photocraft_doc::text::AntiAlias;
use photocraft_geom::{Affine, Rect, TILE_SIZE};
use photocraft_raster::Surface;
use skrifa::instance::{LocationRef, NormalizedCoord, Size};
use skrifa::outline::DrawSettings;
use skrifa::{GlyphId, MetadataProvider};
use crate::color_glyphs::{Ink, Limits, NoPaint, OutlineBounds, Painter, Shape};
use crate::layout::{DecorationRect, GlyphOrient, PlacedGlyph, TextLayout};
use crate::raster::{Bounds, Coverage, LineSink, Pen, Xform, rect_to};
use crate::warp::{Placement, Warp};
#[cfg(not(target_arch = "wasm32"))]
use rayon::prelude::*;
/// Faux-italic slant in degrees (Photoshop-like).
pub const FAUX_ITALIC_DEG: f32 = 12.0;
/// How far faux bold grows the outline on every side, in pixels (`crate::embolden`): stems get
/// twice this heavier. Photoshop thickens by about `size/72`; the flat 3.6% of the size used
/// before overshot its ink by 1.3–1.5× from 50 px up. So the ring follows the size, with a pixel
/// floor that fades in below ~32 px (Photoshop's small type reads heavier than `size/72`) and a
/// cap so a sub-pixel glyph does not grow into a blob.
pub fn faux_bold_radius(size_px: f32) -> f32 {
(size_px / 72.0).max((size_px / 40.0).min(0.45))
}
/// Largest raster we produce (pixels), as a guard against absurd sizes.
const MAX_PIXELS: u64 = 256 * 1024 * 1024;
/// Cumulative coverage-pixel work budget across the colour passes of one render.
const MAX_PASS_PIXELS: u64 = MAX_PIXELS * 4;
/// Peak working bytes one rasterization may keep live. [`MAX_PIXELS`] does not bound them: the
/// accumulator and the output surface are both `stride` deep, so a CMYK render reserves several
/// times what a plain grey one does for the same pixels.
const MAX_RASTER_BYTES: u64 = if cfg!(target_pointer_width = "64") { 4 << 30 } else { 1 << 30 };
/// Whether a `w` x `h` render's peak working bytes fit `max_bytes`: the f32 accumulator and the
/// output surface (both `stride` deep), plus the coverage buffers live at the peak. A pass peaks
/// inside `Coverage::finish`, which holds its accumulator and the vector it builds beside it.
/// Faux bold draws its thickened outlines in that same pass; a `bold` render is still budgeted
/// one buffer higher, as when it was stamped into a buffer of its own, which leaves it headroom.
/// `false` when the arithmetic overflows, so an absurd size is refused rather than wrapping.
fn fits_raster_budget(w: usize, h: usize, stride: usize, sample: SampleType, bold: bool, max_bytes: u64) -> bool {
let f32s = size_of::<f32>() as u64;
let peak = (w as u64).checked_mul(h as u64).and_then(|px| {
let deep = px.checked_mul(stride as u64)?.checked_mul(f32s + sample.bytes() as u64)?;
let coverage = px.checked_mul(if bold { 3 } else { 2 })?.checked_mul(f32s)?;
deep.checked_add(coverage)
});
peak.is_some_and(|b| b <= max_bytes)
}
/// Whether the whole tiles the output surface stores for `rect` fit `max_bytes`. A thin rectangle
/// (an extreme transform of short text) crosses many tiles while holding few pixels, so the pixel
/// budget alone doesn't bound them. `held` is what the accumulator keeps alive meanwhile: the
/// tiles are allocated while it is still in use.
fn fits_tile_budget(rect: Rect, format: PixelFormat, held: u64, max_bytes: u64) -> bool {
let tile_px = (TILE_SIZE as u64).pow(2);
rect.tile_count()
.checked_mul(tile_px)
.and_then(|px| px.checked_mul(format.bytes_per_pixel() as u64))
.and_then(|b| b.checked_add(held))
.is_some_and(|b| b <= max_bytes)
}
/// A zeroed buffer, or `None` when its bytes cannot be reserved.
fn zeroed(len: usize) -> Option<Vec<f32>> {
let mut v = Vec::new();
v.try_reserve_exact(len).ok()?;
v.resize(len, 0.0);
Some(v)
}
/// What a refused or unrenderable layout returns.
fn nothing(format: PixelFormat) -> Rendered {
Rendered { surface: Surface::new(format), rect: Rect::new(0, 0, 0, 0) }
}
/// Maps raw area-coverage to the opacity Photoshop's anti-alias modes imply. Exponents above 1 thin
/// the fringe (sharper); below 1 widen it (stronger smoothing).
pub(crate) fn shape_antialias_coverage(cv: f32, mode: AntiAlias) -> f32 {
if !cv.is_finite() {
return 0.0;
}
let cv = cv.clamp(0.0, 1.0);
match mode {
AntiAlias::None => {
if cv >= 0.5 {
1.0
} else {
0.0
}
}
AntiAlias::Smooth => cv,
AntiAlias::Strong => cv.powf(0.55),
AntiAlias::Crisp => cv.powf(1.35),
AntiAlias::Sharp | AntiAlias::Windows | AntiAlias::WindowsLcd => cv.powf(2.2),
}
}
/// Rendered text: pixels in document space plus the covered rectangle.
pub struct Rendered {
pub surface: Surface,
pub rect: Rect,
}
/// Bends text-space lines with a [`Warp`], then maps them through `post` into `inner`.
struct WarpSink<'a, S: LineSink> {
inner: &'a mut S,
warp: &'a Warp,
post: Xform,
}
impl<S: LineSink> LineSink for WarpSink<'_, S> {
fn line(&mut self, p0: (f64, f64), p1: (f64, f64)) {
let len = ((p1.0 - p0.0).powi(2) + (p1.1 - p0.1).powi(2)).sqrt();
let n = ((len / self.warp.max_segment()).ceil() as usize).clamp(1, 256);
let map = |t: f64| {
let (x, y) = self.warp.apply(p0.0 + (p1.0 - p0.0) * t, p0.1 + (p1.1 - p0.1) * t);
self.post.apply(x, y)
};
let mut a = map(0.0);
for i in 1..=n {
let b = map(i as f64 / n as f64);
self.inner.line(a, b);
a = b;
}
}
}
fn is_bold(layout: &TextLayout, g: &PlacedGlyph) -> bool {
let face_bold = layout.faces.get(g.face as usize).is_some_and(|f| f.embolden);
layout.styles.get(g.style as usize).is_some_and(|s| s.faux_bold) || face_bold
}
/// Whether a path boundary hides any glyph with a drawable outline.
/// Uses the same glyph centers and placement rules as rasterization.
pub fn path_overflows(layout: &TextLayout, shape: &photocraft_doc::text::TextShape) -> bool {
let left = layout.line_bounds().map_or(0.0, |bounds| f64::from(bounds[0]));
let Some(warp) = Warp::on_path_oriented(shape, left, layout.vertical) else { return false };
layout.glyphs.iter().any(|glyph| glyph_is_placed(layout, glyph, None) && !glyph_is_placed(layout, glyph, Some(&warp)))
}
fn glyph_is_placed(layout: &TextLayout, g: &PlacedGlyph, warp: Option<&Warp>) -> bool {
let Some(face) = layout.faces.get(g.face as usize) else {
return false;
};
let Ok(font) = skrifa::FontRef::from_index(face.font.data.as_ref(), face.font.index) else {
return false;
};
let coords: Vec<NormalizedCoord> = face.coords.iter().map(|&c| NormalizedCoord::from_bits(c)).collect();
// A colour glyph paints its layers, so it counts even when its base glyph has no outline.
if font.outline_glyphs().get(GlyphId::new(g.id)).is_none() && color_glyph(&font, GlyphId::new(g.id), &coords).is_none() {
return false;
}
if let Some(w) = warp
&& matches!(w.place_glyph(glyph_center(layout, g, &font, face.size_px, &coords)), Placement::Hidden)
{
return false;
}
true
}
/// The glyphs and decorations one colour pass draws, as indices into the layout's lists.
#[derive(Default)]
pub(crate) struct Pass {
pub(crate) glyphs: Vec<usize>,
pub(crate) decorations: Vec<usize>,
}
/// Distinct visible colours (`alpha > 0.0`) used by placed glyphs or decorations, each paired with
/// whether any placed glyph of that colour uses faux/synthetic bold and the items it draws. Built
/// in one pass with a hash of the colour: a linear search per glyph, and then a walk of every
/// glyph per colour, made text with many coloured runs quadratic.
pub(crate) fn visible_color_passes(layout: &TextLayout, warp: Option<&Warp>) -> Vec<(Color, bool, Pass)> {
type Key = (std::mem::Discriminant<photocraft_color::ColorMode>, [u32; 4], u32);
fn slot<'a>(colors: &'a mut Vec<(Color, bool, Pass)>, index: &mut std::collections::HashMap<Key, usize>, c: Color, bold: bool) -> Option<&'a mut Pass> {
if !(c.alpha.is_finite() && c.alpha > 0.0) {
return None;
}
// `+ 0.0` folds -0.0 into 0.0, which compare equal.
let key = (std::mem::discriminant(&c.mode), c.c.map(|v| (v + 0.0).to_bits()), c.alpha.to_bits());
let i = *index.entry(key).or_insert_with(|| {
colors.push((c, false, Pass::default()));
colors.len() - 1
});
colors[i].1 |= bold;
Some(&mut colors[i].2)
}
let mut colors: Vec<(Color, bool, Pass)> = Vec::new();
let mut index = std::collections::HashMap::new();
for (i, g) in layout.glyphs.iter().enumerate() {
let Some(st) = layout.styles.get(g.style as usize) else { continue };
if !(st.color.alpha.is_finite() && st.color.alpha > 0.0) {
continue;
}
if glyph_is_placed(layout, g, warp)
&& let Some(pass) = slot(&mut colors, &mut index, st.color, is_bold(layout, g))
{
pass.glyphs.push(i);
}
}
for (i, d) in layout.decorations.iter().enumerate() {
let Some(st) = layout.styles.get(d.style as usize) else { continue };
if let Some(pass) = slot(&mut colors, &mut index, st.color, false) {
pass.decorations.push(i);
}
}
colors
}
/// Draws the glyphs and decorations of `layout` in `only` (or all of them when it is `None`) into `sink`, through `transform` (text space → sink space), bending
/// the outlines with `warp` first (in text space). Faux bold glyphs are drawn from their outline
/// thickened by [`faux_bold_radius`] ([`crate::embolden`]).
fn draw(layout: &TextLayout, transform: &Xform, sink: &mut impl LineSink, only: Option<&Pass>, warp: Option<&Warp>) {
let glyphs: Box<dyn Iterator<Item = &PlacedGlyph>> = match only {
Some(p) => Box::new(p.glyphs.iter().filter_map(|&i| layout.glyphs.get(i))),
None => Box::new(layout.glyphs.iter()),
};
for g in glyphs {
let st = &layout.styles[g.style as usize];
let face = &layout.faces[g.face as usize];
let Ok(font) = skrifa::FontRef::from_index(face.font.data.as_ref(), face.font.index) else {
continue;
};
let coords: Vec<NormalizedCoord> = face.coords.iter().map(|&c| NormalizedCoord::from_bits(c)).collect();
// Colour glyphs paint in their own colours ([`paint_color_glyphs`]); only their extent
// counts here.
if let Some(color) = color_glyph(&font, GlyphId::new(g.id), &coords) {
if only.is_none()
&& let Some((glyph, bend)) = place(layout, g, &font, face.size_px, &coords, warp)
{
let unit = font_units(&font, face.size_px, &coords, glyph);
let outline = |shape: Shape, m: &Xform, s: &mut Bounds| shape_into(&font, &coords, shape, unit.mul(m), transform, bend, s);
let mut b = Bounds::default();
let _ = color.paint(LocationRef::new(&coords), &mut OutlineBounds::new(&mut b, outline));
if let Some([x0, y0, x1, y1]) = b.rect {
rect_to(sink, &Xform::IDENTITY, x0, y0, x1, y1);
}
}
continue;
}
let Some(outline) = font.outline_glyphs().get(GlyphId::new(g.id)) else {
continue;
};
let Some((glyph, bend)) = place(layout, g, &font, face.size_px, &coords, warp) else {
continue;
};
let settings = || DrawSettings::unhinted(Size::new(face.size_px), LocationRef::new(&coords));
// Faux bold thickens the outline in font units, before faux italic and scaling, so the
// slant and proportions apply to the bold shape as they do to a real bold face. Other
// glyphs draw straight into the pen.
let mut bold = None;
if st.faux_bold || face.embolden {
let mut shape = crate::embolden::Outline::default();
if outline.draw(settings(), &mut shape).is_err() {
continue;
}
shape.embolden(f64::from(faux_bold_radius(face.size_px)));
bold = Some(shape);
}
let settings = settings();
match bend {
Some(w) => {
let mut ws = WarpSink { inner: &mut *sink, warp: w, post: *transform };
draw_glyph(&outline, settings, bold.as_ref(), &mut Pen::new(&mut ws, glyph));
}
None => draw_glyph(&outline, settings, bold.as_ref(), &mut Pen::new(&mut *sink, transform.mul(&glyph))),
}
}
let decorations: Box<dyn Iterator<Item = &DecorationRect>> = match only {
Some(p) => Box::new(p.decorations.iter().filter_map(|&i| layout.decorations.get(i))),
None => Box::new(layout.decorations.iter()),
};
for d in decorations {
match warp {
Some(w) => {
let (x0, y0, x1, y1) = if layout.vertical {
let Some((y0, y1)) = w.clip_decoration(d.y0 as f64, d.y1 as f64) else { continue };
(d.x0 as f64, y0, d.x1 as f64, y1)
} else {
let Some((x0, x1)) = w.clip_decoration(d.x0 as f64, d.x1 as f64) else { continue };
(x0, d.y0 as f64, x1, d.y1 as f64)
};
let mut ws = WarpSink { inner: &mut *sink, warp: w, post: *transform };
rect_to(&mut ws, &Xform::IDENTITY, x0, y0, x1, y1);
}
None => rect_to(sink, transform, d.x0 as f64, d.y0 as f64, d.x1 as f64, d.y1 as f64),
}
}
}
/// Where a placed glyph goes: its outline map (px-scaled font units, y up → text space) and the
/// warp still to bend it with. `None` when type on a path hides it.
fn place<'w>(
layout: &TextLayout,
g: &PlacedGlyph,
font: &skrifa::FontRef,
size_px: f32,
coords: &[NormalizedCoord],
warp: Option<&'w Warp>,
) -> Option<(Xform, Option<&'w Warp>)> {
let face_skew = layout.faces.get(g.face as usize).map_or(0.0, |f| f.skew_deg);
let glyph = glyph_xform(layout, g, face_skew);
// Type on a path moves each glyph rigidly: turned to the curve at its centre.
match warp.map(|w| w.place_glyph(glyph_center(layout, g, font, size_px, coords))) {
None | Some(Placement::Bend) => Some((glyph, warp)),
Some(Placement::Hidden) => None,
Some(Placement::Frame(m)) => Some((Xform(m).mul(&glyph), None)),
}
}
/// `glyph` (see [`place`]) for unscaled font units, as colour glyphs paint in.
fn font_units(font: &skrifa::FontRef, size_px: f32, coords: &[NormalizedCoord], glyph: Xform) -> Xform {
let upem = font.metrics(Size::unscaled(), LocationRef::new(coords)).units_per_em;
let k = if upem > 0 { f64::from(size_px) / f64::from(upem) } else { 0.0 };
glyph.mul(&Xform([k, 0.0, 0.0, k, 0.0, 0.0]))
}
/// Draws `outline` through `local` (font space → text space), bent by `bend`, then mapped by
/// `transform` into `sink`.
fn draw_outline(
outline: &skrifa::outline::OutlineGlyph,
settings: DrawSettings,
local: Xform,
transform: &Xform,
bend: Option<&Warp>,
sink: &mut impl LineSink,
) {
match bend {
Some(w) => {
let mut ws = WarpSink { inner: sink, warp: w, post: *transform };
let mut pen = Pen::new(&mut ws, local);
if outline.draw(settings, &mut pen).is_ok() {
skrifa::outline::OutlinePen::close(&mut pen);
}
}
None => {
let mut pen = Pen::new(sink, transform.mul(&local));
if outline.draw(settings, &mut pen).is_ok() {
skrifa::outline::OutlinePen::close(&mut pen);
}
}
}
}
/// The colour glyph `id` paints as, when the font has one and skrifa can walk its paint graph.
/// A graph it cannot walk (too deep, a cycle, a broken offset) leaves the glyph to its plain
/// outline in the text colour instead of dropping it.
fn color_glyph<'a>(font: &skrifa::FontRef<'a>, id: GlyphId, coords: &[NormalizedCoord]) -> Option<skrifa::color::ColorGlyph<'a>> {
let color = font.color_glyphs().get(id)?;
color.paint(LocationRef::new(coords), &mut NoPaint).is_ok().then_some(color)
}
/// A colour glyph's clip [`Shape`], unscaled font units through `local` (font units → text
/// space), into `sink`: a glyph's outline, or a clip box, bent by `bend` like the outlines so it
/// still crops what it was meant to.
fn shape_into(
font: &skrifa::FontRef,
coords: &[NormalizedCoord],
shape: Shape,
local: Xform,
transform: &Xform,
bend: Option<&Warp>,
sink: &mut impl LineSink,
) {
match shape {
Shape::Glyph(id) => {
if let Some(outline) = font.outline_glyphs().get(id) {
draw_outline(&outline, DrawSettings::unhinted(Size::unscaled(), LocationRef::new(coords)), local, transform, bend, sink);
}
}
Shape::Box(b) => {
let (x0, y0, x1, y1) = (f64::from(b.x_min), f64::from(b.y_min), f64::from(b.x_max), f64::from(b.y_max));
match bend {
Some(w) => rect_to(&mut WarpSink { inner: sink, warp: w, post: *transform }, &local, x0, y0, x1, y1),
None => rect_to(sink, &transform.mul(&local), x0, y0, x1, y1),
}
}
}
}
/// Paints the colour glyphs of `layout` in their own colours over the premultiplied accumulator
/// (`w × h`, `format`'s colour channels then alpha): their palette's sRGB converted to the
/// document's colour model, times the text colour's opacity. `None` when a glyph's buffers could
/// not be reserved or `limits` ran out (see [`Limits`]).
#[allow(clippy::too_many_arguments)]
fn paint_color_glyphs(
layout: &TextLayout,
xf: &Xform,
warp: Option<&Warp>,
format: &PixelFormat,
antialias: AntiAlias,
acc: &mut [f32],
(w, h): (usize, usize),
mut limits: Limits,
) -> Option<()> {
let n = format.mode.color_channels();
let stride = n + 1;
let opaque = PixelFormat { alpha: false, ..*format };
// Float documents keep extended (HDR, signed) colours, as the plain passes do.
let keep_range = |v: f32| if format.sample == SampleType::F32 && v.is_finite() { v } else { v.clamp(0.0, 1.0) };
for g in &layout.glyphs {
let (Some(st), Some(face)) = (layout.styles.get(g.style as usize), layout.faces.get(g.face as usize)) else { continue };
// A glyph the text colour's opacity hides paints nothing; walking it would only spend the
// budget the visible text needs (as the plain passes skip it, `visible_color_passes`).
let opacity = st.color.alpha.clamp(0.0, 1.0);
if opacity.is_nan() || opacity <= 0.0 {
continue;
}
let Ok(font) = skrifa::FontRef::from_index(face.font.data.as_ref(), face.font.index) else { continue };
let coords: Vec<NormalizedCoord> = face.coords.iter().map(|&c| NormalizedCoord::from_bits(c)).collect();
let Some(color) = color_glyph(&font, GlyphId::new(g.id), &coords) else { continue };
let Some((glyph, bend)) = place(layout, g, &font, face.size_px, &coords, warp) else { continue };
let unit = font_units(&font, face.size_px, &coords, glyph);
// The window the glyph can paint: its fills within their clips.
let mut b = Bounds::default();
let outline = |shape: Shape, m: &Xform, s: &mut Bounds| shape_into(&font, &coords, shape, unit.mul(m), xf, bend, s);
if color.paint(LocationRef::new(&coords), &mut OutlineBounds::new(&mut b, outline)).is_err() {
continue;
}
let Some([x0, y0, x1, y1]) = b.rect else { continue };
let clamp = |v: f64, hi: usize| v.clamp(0.0, hi as f64) as usize;
let (wx0, wy0, wx1, wy1) = (clamp(x0.floor() - 1.0, w), clamp(y0.floor() - 1.0, h), clamp(x1.ceil() + 1.0, w), clamp(y1.ceil() + 1.0, h));
if wx1 <= wx0 || wy1 <= wy0 {
continue;
}
let (ww, wh) = (wx1 - wx0, wy1 - wy0);
let to_window = Xform([1.0, 0.0, 0.0, 1.0, -(wx0 as f64), -(wy0 as f64)]).mul(xf);
let palettes = font.color_palettes();
let palette = palettes.get(0);
let [r, gr, bl] = st.color.to_rgb();
// Pixels in the text colour alone keep its own components, as plain glyphs do (a CMYK
// black stays K only instead of coming back from sRGB as a four-colour black).
let native = (format.mode != ColorMode::Rgb).then(|| color_in(format, &st.color));
let outline = |shape: Shape, m: &Xform, s: &mut Coverage| shape_into(&font, &coords, shape, unit.mul(m), &to_window, bend, s);
let ink = Ink { palette: palette.as_ref().map_or(&[][..], |p| p.colors()), foreground: [r, gr, bl, 1.0] };
let mut painter = Painter::new(ww, wh, outline, to_window.mul(&unit), ink, antialias, limits);
if color.paint(LocationRef::new(&coords), &mut painter).is_err() {
continue;
}
// Compositing the window into the text is one more pass over it.
limits.work = painter.work_left().checked_sub((ww as u64).checked_mul(wh as u64)?)?;
for (i, s) in painter.finish()?.iter().enumerate() {
let a = s[3] * opacity;
let o = ((wy0 + i / ww) * w + wx0 + i % ww) * stride;
let (true, Some(px)) = (a > 0.0, acc.get_mut(o..o + stride)) else { continue };
let straight = [s[0] / s[3], s[1] / s[3], s[2] / s[3]];
let rgb = straight.map(keep_range);
let comps = match &native {
None => rgb.to_vec(),
Some(c) if straight.iter().zip([r, gr, bl]).all(|(v, f)| (v - f).abs() < 1e-5) => c.iter().copied().map(keep_range).collect(),
Some(_) => photocraft_raster::from_rgba(&opaque, [rgb[0], rgb[1], rgb[2], 1.0]),
};
let keep = 1.0 - a;
for (p, c) in px.iter_mut().zip(&comps).take(n) {
*p = c * a + *p * keep;
}
px[n] = a + px[n] * keep;
}
}
Some(())
}
/// One glyph into `pen`: its thickened `bold` outline when there is one, else the font's own.
fn draw_glyph(
outline: &skrifa::outline::OutlineGlyph,
settings: DrawSettings,
bold: Option<&crate::embolden::Outline>,
pen: &mut impl skrifa::outline::OutlinePen,
) {
match bold {
Some(shape) => shape.replay(pen),
None => {
if outline.draw(settings, &mut *pen).is_ok() {
pen.close();
}
}
}
}
/// Font units (scaled to px, y up) → text space for a placed glyph: scales, faux italic,
/// baseline shift, and the vertical-type orientation.
fn glyph_xform(layout: &TextLayout, g: &PlacedGlyph, face_skew_deg: f32) -> Xform {
let Some(st) = layout.styles.get(g.style as usize) else { return Xform([1.0, 0.0, 0.0, -1.0, g.x as f64, g.y as f64]) };
let hs = if st.horizontal_scale > 0.0 { st.horizontal_scale } else { 1.0 } as f64;
let vs = if st.vertical_scale > 0.0 { st.vertical_scale } else { 1.0 } as f64;
let skew_deg = if st.faux_italic { FAUX_ITALIC_DEG } else { 0.0 } + face_skew_deg;
let skew = (skew_deg as f64).to_radians().tan() * vs;
let shift = (st.baseline_shift_pt * layout.px_per_pt) as f64;
let (x, y) = (g.x as f64, g.y as f64);
match g.orient {
GlyphOrient::Horizontal => Xform([hs, 0.0, skew, -vs, x, y - shift]),
// Baseline shift moves upright glyphs in vertical type to the right.
GlyphOrient::Upright => Xform([hs, 0.0, skew, -vs, x + shift, y]),
// 90° clockwise: the glyph's up direction (and its baseline shift) points right.
GlyphOrient::Rotated => Xform([0.0, 1.0, -1.0, 0.0, x, y]).mul(&Xform([hs, 0.0, skew, -vs, 0.0, -shift])),
}
}
/// The horizontal centre (text space) of a placed glyph: the pen position plus half its advance.
fn glyph_center(layout: &TextLayout, g: &PlacedGlyph, font: &skrifa::FontRef, size_px: f32, coords: &[NormalizedCoord]) -> f64 {
if let Some(lc) = g.line_center {
return f64::from(lc);
}
let hs = layout.styles.get(g.style as usize).map_or(1.0, |st| if st.horizontal_scale > 0.0 { st.horizontal_scale } else { 1.0 });
let advance = match g.orient {
GlyphOrient::Horizontal => font.glyph_metrics(Size::new(size_px), LocationRef::new(coords)).advance_width(GlyphId::new(g.id)).unwrap_or(0.0),
_ => 0.0,
};
f64::from(g.x) + f64::from(advance * hs) / 2.0
}
/// The deformation of a type layer: the path it runs along, or its Warp Text settings (None
/// when neither applies).
pub fn layout_deform(layout: &TextLayout, layer: &photocraft_doc::TextLayer) -> Option<Warp> {
let text_start = layout.line_bounds().map_or(0.0, |bounds| f64::from(bounds[0]));
Warp::on_path_oriented(&layer.shape, text_start, layout.vertical).or_else(|| layout_warp(layout, layer.warp.as_ref()))
}
/// The warp to apply to `layout` (None when `warp` is absent, `warpNone` or flat).
pub fn layout_warp(layout: &TextLayout, warp: Option<&photocraft_doc::text::TextWarp>) -> Option<Warp> {
Warp::new(warp?, layout.bounds()?)
}
/// Colour components in `format`'s model (without alpha).
fn color_in(format: &PixelFormat, c: &Color) -> Vec<f32> {
let n = format.mode.color_channels();
if c.mode == format.mode {
c.c[..n].to_vec()
} else {
let [r, g, b] = c.to_rgb();
let mut v = photocraft_raster::from_rgba(&PixelFormat { alpha: false, ..*format }, [r, g, b, 1.0]);
v.truncate(n);
v
}
}
/// Document-space bounds of the drawn text (integer pixel rectangle).
pub fn ink_rect(layout: &TextLayout, transform: &Affine) -> Rect {
ink_rect_warped(layout, transform, None)
}
fn rect_from_bounds([x0, y0, x1, y1]: [f64; 4]) -> Rect {
if ![x0, y0, x1, y1].into_iter().all(f64::is_finite) {
return Rect::EMPTY;
}
let min = f64::from(i32::MIN);
let max = f64::from(i32::MAX);
let (x0, y0, x1, y1) =
((x0.floor() - 1.0).clamp(min, max), (y0.floor() - 1.0).clamp(min, max), (x1.ceil() + 1.0).clamp(min, max), (y1.ceil() + 1.0).clamp(min, max));
if x1 <= x0 || y1 <= y0 || x1 - x0 > MAX_PIXELS as f64 || y1 - y0 > MAX_PIXELS as f64 {
return Rect::EMPTY;
}
Rect::new(x0 as i32, y0 as i32, x1 as i32, y1 as i32)
}
/// Text-space bounds of the drawn glyph outlines and decorations, unrounded (`[x0, y0, x1, y1]`),
/// or `None` when nothing is drawn.
pub fn ink_bounds(layout: &TextLayout) -> Option<[f64; 4]> {
let mut b = Bounds::default();
draw(layout, &Xform::IDENTITY, &mut b, None, None);
b.rect
}
/// [`ink_rect`] of warped text.
pub fn ink_rect_warped(layout: &TextLayout, transform: &Affine, warp: Option<&Warp>) -> Rect {
let mut b = Bounds::default();
draw(layout, &Xform(transform.m), &mut b, None, warp);
b.rect.map(rect_from_bounds).unwrap_or(Rect::EMPTY)
}
/// Rasterizes `layout` through `transform` (text space → document pixels). The result always
/// has an alpha channel; colour is written in `format`'s colour model and sample depth.
pub fn rasterize(layout: &TextLayout, transform: &Affine, format: PixelFormat, antialias: AntiAlias) -> Rendered {
rasterize_warped(layout, transform, format, antialias, None)
}
/// [`rasterize`] with the glyph outlines bent by `warp` (Type › Warp Text).
pub fn rasterize_warped(layout: &TextLayout, transform: &Affine, format: PixelFormat, antialias: AntiAlias, warp: Option<&Warp>) -> Rendered {
rasterize_passes(layout, transform, format, antialias, warp, true)
}
/// [`rasterize_warped`] with every colour's coverage either confined to that colour's own ink
/// (`per_colour`) or spanning the whole text, the oracle the tests compare it with (#8602).
pub(crate) fn rasterize_passes(
layout: &TextLayout,
transform: &Affine,
format: PixelFormat,
antialias: AntiAlias,
warp: Option<&Warp>,
per_colour: bool,
) -> Rendered {
let format = PixelFormat { alpha: true, ..format };
let rect = ink_rect_warped(layout, transform, warp);
let (w, h) = (rect.width() as usize, rect.height() as usize);
let mut surface = Surface::new(format);
if w == 0 || h == 0 || (w as u64) * (h as u64) > MAX_PIXELS {
return Rendered { surface, rect: Rect::new(0, 0, 0, 0) };
}
let colors = visible_color_passes(layout, warp);
if colors.is_empty() {
return Rendered { surface, rect: Rect::new(0, 0, 0, 0) };
}
let n = format.mode.color_channels();
let stride = n + 1;
let any_bold = colors.iter().any(|(_, b, _)| *b);
// The accumulator (f32 per sample) is live while the output tiles are allocated.
// u64 arithmetic: on a 32-bit target the usize product overflows before the budget check.
let Some(acc_bytes) = (w as u64).checked_mul(h as u64).and_then(|n| n.checked_mul((stride * size_of::<f32>()) as u64)) else {
return nothing(format);
};
if !fits_raster_budget(w, h, stride, format.sample, any_bold, MAX_RASTER_BYTES) || !fits_tile_budget(rect, format, acc_bytes, MAX_RASTER_BYTES) {
return nothing(format);
}
// Premultiplied accumulation.
let Some(mut acc) = zeroed(w * h * stride) else {
return nothing(format);
};
let xf = Xform([1.0, 0.0, 0.0, 1.0, -rect.x0 as f64, -rect.y0 as f64]).mul(&Xform(transform.m));
let whole = Rect::new(0, 0, w as i32, h as i32);
let mut pass_pixels = 0u64;
for (c, _, pass) in &colors {
// Rasterise each colour only over its own glyphs (faux bold's thickened outlines included):
// a full-size pass per colour made text with many coloured runs cost colours x area
// (#8602). Outside its ink a colour's coverage is zero, so the result is the same.
let sub = if per_colour {
let mut b = Bounds::default();
draw(layout, &xf, &mut b, Some(pass), warp);
b.rect.map(rect_from_bounds).unwrap_or(Rect::EMPTY).intersect(&whole)
} else {
whole
};
if sub.is_empty() {
continue;
}
let (sw, sh) = (sub.width() as usize, sub.height() as usize);
// One pass per colour: faux bold draws thickened outlines in it (`draw`).
let Some(cost) = (sw as u64).checked_mul(sh as u64) else {
return nothing(format);
};
let Some(total) = pass_pixels.checked_add(cost).filter(|&t| t <= MAX_PASS_PIXELS) else {
return nothing(format);
};
pass_pixels = total;
let xf = Xform([1.0, 0.0, 0.0, 1.0, -sub.x0 as f64, -sub.y0 as f64]).mul(&xf);
let Some(mut cov) = Coverage::try_new(sw, sh) else {
return nothing(format);
};
draw(layout, &xf, &mut cov, Some(pass), warp);
let Some(cov) = cov.finish() else {
return nothing(format);
};
let comps = color_in(&format, c);
let a = c.alpha.clamp(0.0, 1.0);
composite(&mut acc, w, sub, &cov, stride, &comps, a, antialias);
}
// Colour glyphs get what the plain passes left of both budgets: the bytes beside the
// accumulator and the output surface ([`fits_raster_budget`]), and the pixel work.
let deep = (w as u64).saturating_mul(h as u64).saturating_mul(stride as u64).saturating_mul(size_of::<f32>() as u64 + format.sample.bytes() as u64);
let limits = Limits { bytes: MAX_RASTER_BYTES.saturating_sub(deep), work: MAX_PASS_PIXELS.saturating_sub(pass_pixels) };
if paint_color_glyphs(layout, &xf, warp, &format, antialias, &mut acc, (w, h), limits).is_none() {
return nothing(format);
}
// Unpremultiply.
unpremultiply(&mut acc, n, stride, format.sample);
surface.write_region_par(rect, &acc);
surface.prune();
Rendered { surface, rect }
}
/// Composites one colour's coverage, covering `sub` of a `width`-pixel-wide premultiplied
/// accumulator, after [`shape_antialias_coverage`]. A pixel's maths reads and writes only its own
/// slots, so the rows are done in any order — one per thread — for exactly the same bytes.
#[allow(clippy::too_many_arguments)]
fn composite(acc: &mut [f32], width: usize, sub: Rect, cov: &[f32], stride: usize, comps: &[f32], a: f32, antialias: AntiAlias) {
let n = comps.len();
let (x0, x1) = (sub.x0.max(0) as usize * stride, sub.x1.max(0) as usize * stride);
let (y0, sw, sh) = (sub.y0.max(0) as usize, sub.width() as usize, sub.height() as usize);
if sw == 0 || sh == 0 {
return;
}
let row = |acc: &mut [f32], cov: &[f32]| {
let Some(acc) = acc.get_mut(x0..x1) else { return };
for (cv, px) in cov.iter().zip(acc.chunks_exact_mut(stride)) {
let cv = shape_antialias_coverage(*cv, antialias);
let s = cv * a;
if s <= 0.0 {
continue;
}
let keep = 1.0 - s;
for j in 0..n {
px[j] = comps[j] * s + px[j] * keep;
}
px[n] = s + px[n] * keep;
}
};
#[cfg(not(target_arch = "wasm32"))]
acc.par_chunks_mut(width * stride).skip(y0).take(sh).zip(cov.par_chunks(sw)).for_each(|(a, c)| row(a, c));
#[cfg(target_arch = "wasm32")]
acc.chunks_mut(width * stride).skip(y0).take(sh).zip(cov.chunks(sw)).for_each(|(a, c)| row(a, c));
}
/// Divides the premultiplied accumulator back to straight colour. Each pixel stands alone.
fn unpremultiply(acc: &mut [f32], n: usize, stride: usize, sample: SampleType) {
let one = |px: &mut [f32]| {
let a = px[n];
if a > 0.0 {
for v in &mut px[..n] {
let straight = *v / a;
// Float text can carry HDR and signed colours. Keep integer output bounded
// and retain the old handling of non-finite intermediate values.
*v = if sample == SampleType::F32 && straight.is_finite() { straight } else { straight.clamp(0.0, 1.0) };
}
}
};
#[cfg(not(target_arch = "wasm32"))]
acc.par_chunks_exact_mut(stride).for_each(one);
#[cfg(target_arch = "wasm32")]
acc.chunks_exact_mut(stride).for_each(one);
}
/// One element of a glyph outline in document space (see [`outlines`]).
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum PathEl {
MoveTo([f64; 2]),
LineTo([f64; 2]),
QuadTo([f64; 2], [f64; 2]),
CurveTo([f64; 2], [f64; 2], [f64; 2]),
Close,
}
/// Records outline commands through a text→document map (and an optional warp).
struct Recorder<'a> {
glyph: Xform,
post: Xform,
warp: Option<&'a Warp>,
out: Vec<PathEl>,
}
impl Recorder<'_> {
fn map(&self, x: f32, y: f32) -> [f64; 2] {
let (tx, ty) = self.glyph.apply(f64::from(x), f64::from(y));
let (tx, ty) = match self.warp {
Some(w) => w.apply(tx, ty),
None => (tx, ty),
};
let (dx, dy) = self.post.apply(tx, ty);
[dx, dy]
}
}
impl skrifa::outline::OutlinePen for Recorder<'_> {
fn move_to(&mut self, x: f32, y: f32) {
let p = self.map(x, y);
self.out.push(PathEl::MoveTo(p));
}
fn line_to(&mut self, x: f32, y: f32) {
let p = self.map(x, y);
self.out.push(PathEl::LineTo(p));
}
fn quad_to(&mut self, cx0: f32, cy0: f32, x: f32, y: f32) {
let (c, p) = (self.map(cx0, cy0), self.map(x, y));
self.out.push(PathEl::QuadTo(c, p));
}
fn curve_to(&mut self, cx0: f32, cy0: f32, cx1: f32, cy1: f32, x: f32, y: f32) {
let (a, b, p) = (self.map(cx0, cy0), self.map(cx1, cy1), self.map(x, y));
self.out.push(PathEl::CurveTo(a, b, p));
}
fn close(&mut self) {
self.out.push(PathEl::Close);
}
}
/// Positioned glyph outline with its style and character run information.
#[derive(Clone, Debug, PartialEq)]
pub struct GlyphOutline {
pub glyph_index: usize,
pub style: u32,
pub elements: Vec<PathEl>,
}
/// Glyph outlines of `layout` preserving the style index of each glyph.
pub fn glyph_outlines(layout: &TextLayout, transform: &Affine, warp: Option<&Warp>) -> Vec<GlyphOutline> {
let mut glyphs = Vec::new();
for (i, g) in layout.glyphs.iter().enumerate() {
let face = &layout.faces[g.face as usize];
let Ok(font) = skrifa::FontRef::from_index(face.font.data.as_ref(), face.font.index) else {
continue;
};
let Some(outline) = font.outline_glyphs().get(GlyphId::new(g.id)) else {
continue;
};
let coords: Vec<NormalizedCoord> = face.coords.iter().map(|&c| NormalizedCoord::from_bits(c)).collect();
let mut glyph = glyph_xform(layout, g, face.skew_deg);
let mut bend = warp;
if let Some(w) = warp {
match w.place_glyph(glyph_center(layout, g, &font, face.size_px, &coords)) {
Placement::Bend => {}
Placement::Hidden => continue,
Placement::Frame(m) => {
glyph = Xform(m).mul(&glyph);
bend = None;
}
}
}
let mut rec = Recorder { glyph, post: Xform(transform.m), warp: bend, out: Vec::new() };
let settings = DrawSettings::unhinted(Size::new(face.size_px), LocationRef::new(&coords));
if outline.draw(settings, &mut rec).is_ok() && !rec.out.is_empty() {
glyphs.push(GlyphOutline { glyph_index: i, style: g.style, elements: rec.out });
}
}
glyphs
}
/// Glyph outlines of `layout` in document space (through `transform`, bent by `warp`), one
/// element list per glyph, for Type › Create Work Path and Convert to Shape. Faux bold is not
/// applied (the regular outline is converted); faux italic and scaling are. Under a
/// warp, control points are mapped directly, which is exact for straight segments and a close
/// approximation for curves.
pub fn outlines(layout: &TextLayout, transform: &Affine, warp: Option<&Warp>) -> Vec<Vec<PathEl>> {
glyph_outlines(layout, transform, warp).into_iter().map(|g| g.elements).collect()
}
#[cfg(test)]
mod tests {
use super::{MAX_PIXELS, fits_raster_budget, fits_tile_budget, rect_from_bounds, zeroed};
use photocraft_color::{PixelFormat, SampleType};
use photocraft_geom::Rect;
/// Verifies underline and strikethrough decoration drawing bounds clip strictly to the text shape's explicit path span.
#[test]
fn path_decorations_respect_explicit_range() {
use super::{Bounds, DecorationRect, TextLayout, Warp, Xform, draw};
use photocraft_doc::text::TextShape;
use photocraft_doc::vector::Subpath;
let path = Subpath::polyline(&[(0.0, 0.0), (100.0, 0.0)]);
// Underline and strikethrough occupy separate bands but share the draw path.
for y in [2.0, -4.0] {
let layout = TextLayout { decorations: vec![DecorationRect { x0: 0.0, y0: y, x1: 40.0, y1: y + 1.0, style: 0 }], ..Default::default() };
for flip in [false, true] {
for (end, expected) in [(Some(30.0), Some((20.0, 30.0))), (Some(20.0), None), (None, Some((20.0, 60.0)))] {
let shape = TextShape::Path { path: path.clone(), start: 20.0, end, flip };
let warp = Warp::on_path(&shape).unwrap();
let mut bounds = Bounds::default();
draw(&layout, &Xform::IDENTITY, &mut bounds, None, Some(&warp));
match (bounds.rect, expected) {
(None, None) => {}
(Some(r), Some((a, b))) => {
let (a, b) = if flip { (100.0 - b, 100.0 - a) } else { (a, b) };
assert!((r[0] - a).abs() < 1e-6 && (r[2] - b).abs() < 1e-6, "{r:?}");
}
other => panic!("unexpected bounds: {other:?}"),
}
}
}
}
}
#[test]
fn a_thin_rectangle_is_charged_for_the_tiles_it_crosses() {
let format = PixelFormat::RGBA8;
// One pixel high, 2^24 wide: 16 Mi pixels, but 65536 tiles of 256 KiB (16 GiB).
let thin = Rect::new(0, 0, 1 << 24, 1);
assert!(!fits_tile_budget(thin, format, 0, 4 << 30));
// The same pixels in a square fit in 16 MiB of tiles.
let square = Rect::new(0, 0, 4096, 4096);
assert!(fits_tile_budget(square, format, 0, 64 << 20));
assert!(!fits_tile_budget(square, format, 0, (64 << 20) - 1), "the allowance is exact");
assert!(!fits_tile_budget(square, format, 1, 64 << 20), "the accumulator is charged with the tiles");
}
#[test]
fn bounds_are_clipped_without_overflow_and_oversized_rectangles_rejected() {
let min = f64::from(i32::MIN);
let max = f64::from(i32::MAX);
let cases = [
([min, 0.0, min + 8.0, 8.0], Rect::new(i32::MIN, -1, i32::MIN + 9, 9)),
([max - 8.0, 0.0, max, 8.0], Rect::new(i32::MAX - 9, -1, i32::MAX, 9)),
([-f64::MAX, 0.0, f64::MAX, 8.0], Rect::EMPTY),
([0.0, 0.0, MAX_PIXELS as f64, 8.0], Rect::EMPTY),
([0.25, -3.25, 10.1, 8.8], Rect::new(-1, -5, 12, 10)),
];
for (bounds, expected) in cases {
let first = rect_from_bounds(bounds);
assert_eq!(first, expected, "bounds: {bounds:?}");
assert_eq!(rect_from_bounds(bounds), first, "bounds: {bounds:?}");
}
}
/// #4979: the pixel cap says nothing about bytes, so the peak is admitted from the channel
/// depth of the accumulator and surface, the sample size and the faux-bold coverage buffers.
/// A 100 x 100 grey+alpha render at 8-bit keeps 2 x (4 + 1) + 2 x 4 = 18 bytes a pixel live.
#[test]
fn the_byte_budget_follows_channels_depth_and_faux_bold() {
let px = 100 * 100;
assert!(fits_raster_budget(100, 100, 2, SampleType::U8, false, px * 18));
assert!(!fits_raster_budget(100, 100, 2, SampleType::U8, false, px * 18 - 1), "the allowance is exact");
// The same pixels cost more with more channels, a wider sample, or a bold pass.
assert!(!fits_raster_budget(100, 100, 5, SampleType::U8, false, px * 18), "CMYK is deeper");
assert!(!fits_raster_budget(100, 100, 2, SampleType::F32, false, px * 18), "f32 output is wider");
assert!(!fits_raster_budget(100, 100, 2, SampleType::U8, true, px * 18), "bold holds one more buffer");
assert!(fits_raster_budget(100, 100, 2, SampleType::U8, true, px * 22), "2 x 5 + 3 x 4 bytes a pixel");
// A size whose peak overflows is refused rather than wrapping to a small number.
assert!(!fits_raster_budget(usize::MAX, usize::MAX, 5, SampleType::F32, true, u64::MAX));
// Nothing is reserved for a buffer that cannot be served.
assert!(zeroed(usize::MAX).is_none());
}
}
No file is open. Choose one in the tree, or press Ctrl+O (⌘O on a Mac) to find one by name.
Syntax highlighting could not load. The unmodified read-only text remains available above.