/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at https://mozilla.org/MPL/2.0/. */ use std::cell::{Cell, RefCell}; use std::collections::HashMap; use canvas_traits::canvas::*; use compositing_traits::SerializableImageData; use cssparser::color::clamp_unit_f32; use euclid::default::{Point2D, Rect, Size2D, Transform2D}; use font_kit::font::Font; use fonts::{ByteIndex, FontIdentifier, FontTemplateRefMethods}; use ipc_channel::ipc::IpcSharedMemory; use log::warn; use pixels::{Snapshot, SnapshotAlphaMode, SnapshotPixelFormat}; use range::Range; use raqote::{DrawOptions, PathBuilder, StrokeStyle}; use style::color::AbsoluteColor; use webrender_api::{ImageDescriptor, ImageDescriptorFlags, ImageFormat}; use crate::backend::GenericDrawTarget; use crate::canvas_data::{Filter, TextRun}; thread_local! { /// The shared font cache used by all canvases that render on a thread. It would be nicer /// to have a global cache, but it looks like font-kit uses a per-thread FreeType, so /// in order to ensure that fonts are particular to a thread we have to make our own /// cache thread local as well. static SHARED_FONT_CACHE: RefCell> = RefCell::default(); } #[derive(Clone)] pub enum Pattern { // argb Color(u8, u8, u8, u8), LinearGradient(LinearGradientPattern), RadialGradient(RadialGradientPattern), Surface(SurfacePattern), } #[derive(Clone)] pub struct LinearGradientPattern { gradient: raqote::Gradient, start: Point2D, end: Point2D, } impl LinearGradientPattern { fn new(start: Point2D, end: Point2D, stops: Vec) -> Self { LinearGradientPattern { gradient: raqote::Gradient { stops }, start, end, } } } #[derive(Clone)] pub struct RadialGradientPattern { gradient: raqote::Gradient, center1: Point2D, radius1: f32, center2: Point2D, radius2: f32, } impl RadialGradientPattern { fn new( center1: Point2D, radius1: f32, center2: Point2D, radius2: f32, stops: Vec, ) -> Self { RadialGradientPattern { gradient: raqote::Gradient { stops }, center1, radius1, center2, radius2, } } } #[derive(Clone)] pub struct SurfacePattern { image: Snapshot, filter: raqote::FilterMode, extend: raqote::ExtendMode, transform: Transform2D, } impl SurfacePattern { fn new( image: Snapshot, filter: raqote::FilterMode, repeat: Repetition, transform: Transform2D, ) -> Self { let extend = match repeat { Repetition::NoRepeat => raqote::ExtendMode::Pad, Repetition::RepeatX | Repetition::RepeatY | Repetition::Repeat => { raqote::ExtendMode::Repeat }, }; SurfacePattern { image, filter, extend, transform, } } } #[derive(Clone, Copy, Debug)] pub enum Repetition { Repeat, RepeatX, RepeatY, NoRepeat, } impl Repetition { fn from_xy(repeat_x: bool, repeat_y: bool) -> Self { if repeat_x && repeat_y { Repetition::Repeat } else if repeat_x { Repetition::RepeatX } else if repeat_y { Repetition::RepeatY } else { Repetition::NoRepeat } } } pub fn source(pattern: &Pattern) -> raqote::Source { match pattern { Pattern::Color(a, r, g, b) => raqote::Source::Solid( raqote::SolidSource::from_unpremultiplied_argb(*a, *r, *g, *b), ), Pattern::LinearGradient(pattern) => raqote::Source::new_linear_gradient( pattern.gradient.clone(), pattern.start, pattern.end, raqote::Spread::Pad, ), Pattern::RadialGradient(pattern) => raqote::Source::new_two_circle_radial_gradient( pattern.gradient.clone(), pattern.center1, pattern.radius1, pattern.center2, pattern.radius2, raqote::Spread::Pad, ), Pattern::Surface(pattern) => raqote::Source::Image( raqote::Image { width: pattern.image.size().width as i32, height: pattern.image.size().height as i32, data: bytemuck::cast_slice(pattern.image.as_raw_bytes()), }, pattern.extend, pattern.filter, pattern.transform, ), } } fn create_gradient_stops(gradient_stops: Vec) -> Vec { let mut stops = gradient_stops .into_iter() .map(|item| item.to_raqote()) .collect::>(); // https://www.w3.org/html/test/results/2dcontext/annotated-spec/canvas.html#testrefs.2d.gradient.interpolate.overlap stops.sort_by(|a, b| a.position.partial_cmp(&b.position).unwrap()); stops } impl GenericDrawTarget for raqote::DrawTarget { type SourceSurface = Vec; // TODO: See if we can avoid the alloc (probably?) fn new(size: Size2D) -> Self { raqote::DrawTarget::new(size.width as i32, size.height as i32) } fn clear_rect(&mut self, rect: &Rect, transform: Transform2D) { ::fill_rect( self, rect, FillOrStrokeStyle::Color(AbsoluteColor::TRANSPARENT_BLACK), CompositionOptions { alpha: 1.0, composition_operation: CompositionOrBlending::Composition(CompositionStyle::Clear), }, transform, ); } fn copy_surface( &mut self, surface: Self::SourceSurface, source: Rect, destination: Point2D, ) { let dt = raqote::DrawTarget::from_vec(source.size.width, source.size.height, surface); raqote::DrawTarget::copy_surface(self, &dt, source.to_box2d(), destination); } fn create_similar_draw_target(&self, size: &Size2D) -> Self { raqote::DrawTarget::new(size.width, size.height) } fn create_source_surface_from_data(&self, data: Snapshot) -> Option { Some( bytemuck::try_cast_vec( data.to_vec( Some(SnapshotAlphaMode::Transparent { premultiplied: true, }), Some(SnapshotPixelFormat::BGRA), ) .0, ) .unwrap_or_else(|(_, surface)| bytemuck::pod_collect_to_vec(&surface)), ) } fn draw_surface( &mut self, surface: Self::SourceSurface, dest: Rect, src: Rect, filter: Filter, composition_options: CompositionOptions, transform: Transform2D, ) { let paint_transform = raqote::Transform::translation(-dest.origin.x as f32, -dest.origin.y as f32) .then_scale( src.size.width as f32 / dest.size.width as f32, src.size.height as f32 / dest.size.height as f32, ); self.set_transform(&transform); let dest = dest.cast(); let mut pb = raqote::PathBuilder::new(); pb.rect( dest.origin.x, dest.origin.y, dest.size.width, dest.size.height, ); let size = src.size.cast(); fill_draw_target( self, draw_options(composition_options), &raqote::Source::Image( raqote::Image { width: size.width, height: size.height, data: &surface, }, raqote::ExtendMode::Pad, filter.to_raqote(), paint_transform, ), pb.finish(), ); } fn draw_surface_with_shadow( &self, _surface: Self::SourceSurface, _dest: &Point2D, _shadow_options: ShadowOptions, _composition_options: CompositionOptions, ) { warn!("no support for drawing shadows"); } fn fill( &mut self, path: &canvas_traits::canvas::Path, fill_rule: FillRule, style: FillOrStrokeStyle, composition_options: CompositionOptions, transform: Transform2D, ) { self.set_transform(&transform); let draw_options = draw_options(composition_options); let pattern = style.to_raqote_pattern(); let mut path = to_path(path); path.winding = match fill_rule { FillRule::Nonzero => raqote::Winding::NonZero, FillRule::Evenodd => raqote::Winding::EvenOdd, }; fill_draw_target(self, draw_options, &source(&pattern), path); } fn fill_text( &mut self, text_runs: Vec, start: Point2D, style: FillOrStrokeStyle, composition_options: CompositionOptions, transform: Transform2D, ) { self.set_transform(&transform); let draw_options = draw_options(composition_options); let pattern = style.to_raqote_pattern(); let mut advance = 0.; for run in text_runs.iter() { let mut positions = Vec::new(); let glyphs = &run.glyphs; let ids: Vec<_> = glyphs .iter_glyphs_for_byte_range(&Range::new(ByteIndex(0), glyphs.len())) .map(|glyph| { let glyph_offset = glyph.offset().unwrap_or(Point2D::zero()); positions.push(Point2D::new( advance + start.x + glyph_offset.x.to_f32_px(), start.y + glyph_offset.y.to_f32_px(), )); advance += glyph.advance().to_f32_px(); glyph.id() }) .collect(); // TODO: raqote uses font-kit to rasterize glyphs, but font-kit fails an assertion when // using color bitmap fonts in the FreeType backend. For now, simply do not render these // type of fonts. if run.font.has_color_bitmap_or_colr_table() { continue; } let template = &run.font.template; SHARED_FONT_CACHE.with(|font_cache| { let identifier = template.identifier(); if !font_cache.borrow().contains_key(&identifier) { let data = std::sync::Arc::new(run.font.data().as_ref().to_vec()); let Ok(font) = Font::from_bytes(data, identifier.index()) else { return; }; font_cache.borrow_mut().insert(identifier.clone(), font); } let font_cache = font_cache.borrow(); let Some(font) = font_cache.get(&identifier) else { return; }; self.draw_glyphs( font, run.font.descriptor.pt_size.to_f32_px(), &ids, &positions, &source(&pattern), &draw_options, ); }) } } fn fill_rect( &mut self, rect: &Rect, style: FillOrStrokeStyle, composition_options: CompositionOptions, transform: Transform2D, ) { let rect = rect.cast(); let mut pb = canvas_traits::canvas::Path::new(); pb.rect( rect.origin.x, rect.origin.y, rect.size.width, rect.size.height, ); ::fill( self, &pb, FillRule::Nonzero, style, composition_options, transform, ); } fn get_size(&self) -> Size2D { Size2D::new(self.width(), self.height()) } fn pop_clip(&mut self) { self.pop_clip(); } fn push_clip( &mut self, path: &canvas_traits::canvas::Path, fill_rule: FillRule, transform: Transform2D, ) { self.set_transform(&transform); let mut path = to_path(path); path.winding = match fill_rule { FillRule::Nonzero => raqote::Winding::NonZero, FillRule::Evenodd => raqote::Winding::EvenOdd, }; self.push_clip(&path); } fn push_clip_rect(&mut self, rect: &Rect) { self.push_clip_rect(rect.to_box2d()); } fn surface(&mut self) -> Self::SourceSurface { self.get_data().to_vec() } fn stroke( &mut self, path: &canvas_traits::canvas::Path, style: FillOrStrokeStyle, line_options: LineOptions, composition_options: CompositionOptions, transform: Transform2D, ) { let pattern = style.to_raqote_pattern(); let options = draw_options(composition_options); self.set_transform(&transform); self.stroke( &to_path(path), &source(&pattern), &line_options.to_raqote_style(), &options, ); } fn stroke_rect( &mut self, rect: &Rect, style: FillOrStrokeStyle, line_options: LineOptions, composition_options: CompositionOptions, transform: Transform2D, ) { self.set_transform(&transform); let pattern = style.to_raqote_pattern(); let options = draw_options(composition_options); let mut pb = raqote::PathBuilder::new(); pb.rect( rect.origin.x, rect.origin.y, rect.size.width, rect.size.height, ); self.stroke( &pb.finish(), &source(&pattern), &line_options.to_raqote_style(), &options, ); } fn image_descriptor_and_serializable_data( &mut self, ) -> ( webrender_api::ImageDescriptor, compositing_traits::SerializableImageData, ) { let descriptor = ImageDescriptor { size: self.get_size().cast_unit(), stride: None, format: ImageFormat::BGRA8, offset: 0, flags: ImageDescriptorFlags::empty(), }; let data = SerializableImageData::Raw(IpcSharedMemory::from_bytes(self.get_data_u8())); (descriptor, data) } fn snapshot(&mut self) -> Snapshot { Snapshot::from_vec( self.get_size().cast(), SnapshotPixelFormat::BGRA, SnapshotAlphaMode::Transparent { premultiplied: true, }, self.get_data_u8().to_vec(), ) } } fn fill_draw_target( draw_target: &mut raqote::DrawTarget, draw_options: DrawOptions, source: &raqote::Source<'_>, path: raqote::Path, ) { match draw_options.blend_mode { raqote::BlendMode::Src => { draw_target.clear(raqote::SolidSource::from_unpremultiplied_argb(0, 0, 0, 0)); draw_target.fill(&path, source, &draw_options); }, raqote::BlendMode::Clear | raqote::BlendMode::SrcAtop | raqote::BlendMode::DstOut | raqote::BlendMode::Add | raqote::BlendMode::Xor | raqote::BlendMode::DstOver | raqote::BlendMode::SrcOver => { draw_target.fill(&path, source, &draw_options); }, raqote::BlendMode::SrcIn | raqote::BlendMode::SrcOut | raqote::BlendMode::DstIn | raqote::BlendMode::DstAtop => { let mut options = draw_options; draw_target.push_layer_with_blend(1., options.blend_mode); options.blend_mode = raqote::BlendMode::SrcOver; draw_target.fill(&path, source, &options); draw_target.pop_layer(); }, _ => warn!("unrecognized blend mode: {:?}", draw_options.blend_mode), } } impl Filter { fn to_raqote(self) -> raqote::FilterMode { match self { Filter::Bilinear => raqote::FilterMode::Bilinear, Filter::Nearest => raqote::FilterMode::Nearest, } } } pub(crate) struct Path(Cell); impl From for Path { fn from(path_builder: raqote::PathBuilder) -> Self { Self(Cell::new(path_builder)) } } impl From<&Path> for raqote::Path { fn from(path: &Path) -> Self { path.clone().0.into_inner().finish() } } impl Clone for Path { fn clone(&self) -> Self { let path_builder = self.0.replace(raqote::PathBuilder::new()); let path = path_builder.finish(); self.0.set(path.clone().into()); Self(Cell::new(path.into())) } } pub trait ToRaqoteStyle { type Target; fn to_raqote_style(self) -> Self::Target; } impl ToRaqoteStyle for LineOptions { type Target = StrokeStyle; fn to_raqote_style(self) -> Self::Target { let LineOptions { width, cap_style, join_style, miter_limit, dash, dash_offset, } = self; StrokeStyle { width: width as f32, cap: cap_style.to_raqote_style(), join: join_style.to_raqote_style(), miter_limit: miter_limit as f32, dash_array: dash, dash_offset: dash_offset as f32, } } } impl ToRaqoteStyle for LineJoinStyle { type Target = raqote::LineJoin; fn to_raqote_style(self) -> raqote::LineJoin { match self { LineJoinStyle::Round => raqote::LineJoin::Round, LineJoinStyle::Bevel => raqote::LineJoin::Bevel, LineJoinStyle::Miter => raqote::LineJoin::Miter, } } } impl ToRaqoteStyle for LineCapStyle { type Target = raqote::LineCap; fn to_raqote_style(self) -> raqote::LineCap { match self { LineCapStyle::Butt => raqote::LineCap::Butt, LineCapStyle::Round => raqote::LineCap::Round, LineCapStyle::Square => raqote::LineCap::Square, } } } pub trait ToRaqotePattern { fn to_raqote_pattern(self) -> Pattern; } pub trait ToRaqoteGradientStop { fn to_raqote(self) -> raqote::GradientStop; } impl ToRaqoteGradientStop for CanvasGradientStop { fn to_raqote(self) -> raqote::GradientStop { let srgb = self.color.into_srgb_legacy(); let color = raqote::Color::new( clamp_unit_f32(srgb.alpha), clamp_unit_f32(srgb.components.0), clamp_unit_f32(srgb.components.1), clamp_unit_f32(srgb.components.2), ); let position = self.offset as f32; raqote::GradientStop { position, color } } } impl ToRaqotePattern for FillOrStrokeStyle { fn to_raqote_pattern(self) -> Pattern { use canvas_traits::canvas::FillOrStrokeStyle::*; match self { Color(color) => { let srgb = color.into_srgb_legacy(); Pattern::Color( clamp_unit_f32(srgb.alpha), clamp_unit_f32(srgb.components.0), clamp_unit_f32(srgb.components.1), clamp_unit_f32(srgb.components.2), ) }, LinearGradient(style) => { let start = Point2D::new(style.x0 as f32, style.y0 as f32); let end = Point2D::new(style.x1 as f32, style.y1 as f32); let stops = create_gradient_stops(style.stops); Pattern::LinearGradient(LinearGradientPattern::new(start, end, stops)) }, RadialGradient(style) => { let center1 = Point2D::new(style.x0 as f32, style.y0 as f32); let center2 = Point2D::new(style.x1 as f32, style.y1 as f32); let stops = create_gradient_stops(style.stops); Pattern::RadialGradient(RadialGradientPattern::new( center1, style.r0 as f32, center2, style.r1 as f32, stops, )) }, Surface(style) => { let repeat = Repetition::from_xy(style.repeat_x, style.repeat_y); let mut snapshot = style.surface_data.to_owned(); snapshot.transform( SnapshotAlphaMode::Transparent { premultiplied: true, }, SnapshotPixelFormat::BGRA, ); Pattern::Surface(SurfacePattern::new( snapshot, raqote::FilterMode::Nearest, repeat, style.transform, )) }, } } } impl ToRaqoteStyle for AbsoluteColor { type Target = raqote::SolidSource; fn to_raqote_style(self) -> Self::Target { let srgb = self.into_srgb_legacy(); raqote::SolidSource::from_unpremultiplied_argb( clamp_unit_f32(srgb.alpha), clamp_unit_f32(srgb.components.0), clamp_unit_f32(srgb.components.1), clamp_unit_f32(srgb.components.2), ) } } impl ToRaqoteStyle for CompositionOrBlending { type Target = raqote::BlendMode; fn to_raqote_style(self) -> Self::Target { match self { CompositionOrBlending::Composition(op) => op.to_raqote_style(), CompositionOrBlending::Blending(op) => op.to_raqote_style(), } } } impl ToRaqoteStyle for BlendingStyle { type Target = raqote::BlendMode; fn to_raqote_style(self) -> Self::Target { match self { BlendingStyle::Multiply => raqote::BlendMode::Multiply, BlendingStyle::Screen => raqote::BlendMode::Screen, BlendingStyle::Overlay => raqote::BlendMode::Overlay, BlendingStyle::Darken => raqote::BlendMode::Darken, BlendingStyle::Lighten => raqote::BlendMode::Lighten, BlendingStyle::ColorDodge => raqote::BlendMode::ColorDodge, BlendingStyle::HardLight => raqote::BlendMode::HardLight, BlendingStyle::SoftLight => raqote::BlendMode::SoftLight, BlendingStyle::Difference => raqote::BlendMode::Difference, BlendingStyle::Exclusion => raqote::BlendMode::Exclusion, BlendingStyle::Hue => raqote::BlendMode::Hue, BlendingStyle::Saturation => raqote::BlendMode::Saturation, BlendingStyle::Color => raqote::BlendMode::Color, BlendingStyle::Luminosity => raqote::BlendMode::Luminosity, BlendingStyle::ColorBurn => raqote::BlendMode::ColorBurn, } } } impl ToRaqoteStyle for CompositionStyle { type Target = raqote::BlendMode; fn to_raqote_style(self) -> Self::Target { match self { CompositionStyle::SourceIn => raqote::BlendMode::SrcIn, CompositionStyle::SourceOut => raqote::BlendMode::SrcOut, CompositionStyle::SourceOver => raqote::BlendMode::SrcOver, CompositionStyle::SourceAtop => raqote::BlendMode::SrcAtop, CompositionStyle::DestinationIn => raqote::BlendMode::DstIn, CompositionStyle::DestinationOut => raqote::BlendMode::DstOut, CompositionStyle::DestinationOver => raqote::BlendMode::DstOver, CompositionStyle::DestinationAtop => raqote::BlendMode::DstAtop, CompositionStyle::Copy => raqote::BlendMode::Src, CompositionStyle::Lighter => raqote::BlendMode::Add, CompositionStyle::Xor => raqote::BlendMode::Xor, CompositionStyle::Clear => raqote::BlendMode::Clear, } } } fn to_path(path: &canvas_traits::canvas::Path) -> raqote::Path { let mut pb = PathBuilder::new(); for cmd in &path.0 { match cmd { kurbo::PathEl::MoveTo(kurbo::Point { x, y }) => pb.move_to(x as f32, y as f32), kurbo::PathEl::LineTo(kurbo::Point { x, y }) => pb.line_to(x as f32, y as f32), kurbo::PathEl::QuadTo(cp, p) => { pb.quad_to(cp.x as f32, cp.y as f32, p.x as f32, p.y as f32) }, kurbo::PathEl::CurveTo(cp1, cp2, p) => pb.cubic_to( cp1.x as f32, cp1.y as f32, cp2.x as f32, cp2.y as f32, p.x as f32, p.y as f32, ), kurbo::PathEl::ClosePath => pb.close(), } } pb.finish() } fn draw_options(composition_options: CompositionOptions) -> DrawOptions { DrawOptions { blend_mode: composition_options.composition_operation.to_raqote_style(), alpha: composition_options.alpha as f32, ..Default::default() } }