i_slint_compiler/passes/

embed_images.rs

// Copyright © SixtyFPS GmbH <info@slint.dev>
// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-Royalty-free-2.0 OR LicenseRef-Slint-Software-3.0

use crate::EmbedResourcesKind;
use crate::diagnostics::BuildDiagnostics;
use crate::embedded_resources::*;
use crate::expression_tree::{Expression, ImageReference};
use crate::object_tree::*;
#[cfg(feature = "renderer-software")]
use image::GenericImageView;
use smol_str::SmolStr;
use std::cell::RefCell;
use std::collections::HashMap;
use typed_index_collections::TiVec;
use url::Url;

/// The fonts shared with `embed_glyphs` to rasterize SVG `<text>`. Only the
/// software renderer embeds textures, so elsewhere this is an unused placeholder.
#[cfg(feature = "renderer-software")]
pub(crate) type SharedFontCollection = super::embed_glyphs::SharedFontCollection;
#[cfg(not(feature = "renderer-software"))]
pub(crate) type SharedFontCollection = ();

pub async fn embed_images(
    doc: &Document,
    embed_files: EmbedResourcesKind,
    scale_factor: f32,
    resource_url_mapper: &Option<crate::ResourceUrlMapper>,
    font_collection: Option<&SharedFontCollection>,
    diag: &mut BuildDiagnostics,
) {
    // Slint SC always embeds: the images referenced by `@image-url()` are
    // decoded into the generated code, whatever `embed_files` says.
    if embed_files == EmbedResourcesKind::Nothing
        && resource_url_mapper.is_none()
        && !diag.is_slint_sc()
    {
        return;
    }

    let global_embedded_resources = &doc.embedded_file_resources;
    let mut path_to_id = HashMap::<SmolStr, EmbeddedResourcesIdx>::new();

    let mut all_components = Vec::new();
    doc.visit_all_used_components(|c| all_components.push(c.clone()));
    let all_components = all_components;

    let mapped_urls = {
        let mut urls = HashMap::<Url, Option<Url>>::new();

        if let Some(mapper) = resource_url_mapper {
            // Collect URLs (sync!):
            for component in &all_components {
                visit_all_expressions(component, |e, _| {
                    collect_image_urls_from_expression(e, &mut urls)
                });
            }

            // Map URLs (async -- well, not really):
            for (url, mapped) in urls.iter_mut() {
                *mapped = (*mapper)(url).await;
            }
        }

        urls
    };

    // Use URLs (sync!):
    for component in &all_components {
        visit_all_expressions(component, |e, _| {
            embed_images_from_expression(
                e,
                &mapped_urls,
                global_embedded_resources,
                &mut path_to_id,
                embed_files,
                scale_factor,
                diag,
                font_collection,
            )
        });
    }
}

/// The URL handed to the resource mapper, and the key of the mapped-resource
/// map, for a reference the mapper may rewrite. A local [`ImageReference::Path`]
/// becomes a `file://` URL; an [`ImageReference::Url`] is used as-is. Everything
/// else (`data:` URIs, already-embedded references) returns `None` and is left
/// untouched.
fn reference_mapper_url(resource_ref: &ImageReference) -> Option<Url> {
    match resource_ref {
        ImageReference::Url(url) => Some(url.clone()),
        ImageReference::Path(path) => {
            // `Url::from_file_path` is absent on `wasm32-unknown-unknown`, which
            // only ever sees URL references and so never reaches this branch.
            #[cfg(not(target_arch = "wasm32"))]
            {
                Url::from_file_path(path).ok()
            }
            #[cfg(target_arch = "wasm32")]
            {
                let _ = path;
                None
            }
        }
        _ => None,
    }
}

fn collect_image_urls_from_expression(e: &Expression, urls: &mut HashMap<Url, Option<Url>>) {
    if let Expression::ImageReference { resource_ref, .. } = e
        && let Some(url) = reference_mapper_url(resource_ref)
    {
        urls.insert(url, None);
    };

    e.visit(|e| collect_image_urls_from_expression(e, urls));
}

fn embed_images_from_expression(
    e: &mut Expression,
    urls: &HashMap<Url, Option<Url>>,
    global_embedded_resources: &RefCell<TiVec<EmbeddedResourcesIdx, EmbeddedResources>>,
    path_to_id: &mut HashMap<SmolStr, EmbeddedResourcesIdx>,
    embed_files: EmbedResourcesKind,
    scale_factor: f32,
    diag: &mut BuildDiagnostics,
    font_collection: Option<&SharedFontCollection>,
) {
    if let Expression::ImageReference { resource_ref, source_location, nine_slice: _ } = e {
        // Apply the resource mapper. A Path/Url may be replaced with the mapped
        // URL (e.g. a `data:` URL), so re-classify the reference.
        if let Some(url) = reference_mapper_url(resource_ref)
            && let Some(mapped) = urls.get(&url).cloned().flatten()
        {
            *resource_ref = ImageReference::from_mapped_url(mapped);
        }

        match resource_ref {
            ImageReference::DataUri(data) => {
                // Data URIs have no external file to track, so skip for
                // Nothing (interpreter) and ListAllResources (dependency tracking).
                // Slint SC rejected the data URI when resolving @image-url(),
                // so there is nothing left to embed.
                if !matches!(
                    embed_files,
                    EmbedResourcesKind::Nothing | EmbedResourcesKind::ListAllResources
                ) && !diag.is_slint_sc()
                {
                    let image_ref = embed_data_uri(
                        global_embedded_resources,
                        path_to_id,
                        data,
                        embed_files,
                        scale_factor,
                        diag,
                        source_location,
                        font_collection,
                    );
                    *resource_ref = image_ref;
                }
            }
            ImageReference::Path(_) | ImageReference::Url(_) => {
                let is_builtin = matches!(
                    resource_ref,
                    ImageReference::Url(url) if url.scheme() == "builtin"
                );
                // Slint SC rejected URL references when resolving @image-url(),
                // so only paths are left to embed there.
                let embed_for_slint_sc =
                    diag.is_slint_sc() && matches!(resource_ref, ImageReference::Path(_));
                if embed_for_slint_sc
                    || (embed_files != EmbedResourcesKind::Nothing
                        && (embed_files != EmbedResourcesKind::OnlyBuiltinResources || is_builtin))
                {
                    let path = resource_ref.source().expect("Path/Url have a source");
                    let image_ref = embed_image(
                        global_embedded_resources,
                        path_to_id,
                        embed_files,
                        path,
                        scale_factor,
                        diag,
                        source_location,
                        font_collection,
                    );
                    if embed_files != EmbedResourcesKind::ListAllResources {
                        *resource_ref = image_ref;
                    }
                }
            }
            ImageReference::None
            | ImageReference::EmbeddedData { .. }
            | ImageReference::EmbeddedTexture { .. } => {}
        }
    };

    e.visit_mut(|e| {
        embed_images_from_expression(
            e,
            urls,
            global_embedded_resources,
            path_to_id,
            embed_files,
            scale_factor,
            diag,
            font_collection,
        )
    });
}

fn embed_image(
    global_embedded_resources: &RefCell<TiVec<EmbeddedResourcesIdx, EmbeddedResources>>,
    path_to_id: &mut HashMap<SmolStr, EmbeddedResourcesIdx>,
    embed_files: EmbedResourcesKind,
    path: &str,
    _scale_factor: f32,
    diag: &mut BuildDiagnostics,
    source_location: &Option<crate::diagnostics::SourceLocation>,
    _font_collection: Option<&SharedFontCollection>,
) -> ImageReference {
    let extension = || {
        std::path::Path::new(path)
            .extension()
            .and_then(|e| e.to_str())
            .map(|x| x.to_string())
            .unwrap_or_default()
    };

    if let Some(&resource_id) = path_to_id.get(path) {
        return match global_embedded_resources.borrow()[resource_id].kind {
            #[cfg(feature = "renderer-software")]
            EmbeddedResourcesKind::TextureData { .. } => {
                ImageReference::EmbeddedTexture { resource_id }
            }
            #[cfg(feature = "slint-sc")]
            EmbeddedResourcesKind::StaticPixels { .. } => {
                ImageReference::EmbeddedTexture { resource_id }
            }
            _ => ImageReference::EmbeddedData { resource_id, extension: extension() },
        };
    }

    let mut resources = global_embedded_resources.borrow_mut();
    let mut push = |kind| {
        let id = resources.push_and_get_key(EmbeddedResources { path: Some(path.into()), kind });
        path_to_id.insert(path.into(), id);
        id
    };

    if embed_files == EmbedResourcesKind::ListAllResources {
        push(EmbeddedResourcesKind::ListOnly);
        return ImageReference::None;
    }

    let Some(_file) = crate::fileaccess::load_file(std::path::Path::new(path)) else {
        diag.push_error(format!("Cannot find image file {path}"), source_location);
        return ImageReference::None;
    };

    #[cfg(feature = "slint-sc")]
    if diag.slint_sc {
        // The Slint SC runtime has no image decoder: decode now and embed the
        // pixels into the generated code.
        if matches!(extension().to_ascii_lowercase().as_str(), "svg" | "svgz") {
            diag.slint_sc_error("SVG images are", source_location);
            return ImageReference::None;
        }
        return match image::load_from_memory(&_file.read()) {
            Ok(decoded) => {
                let resource_id = push(EmbeddedResourcesKind::StaticPixels(decoded.into_rgba8()));
                ImageReference::EmbeddedTexture { resource_id }
            }
            Err(err) => {
                diag.push_error(format!("Cannot load image file {path}: {err}"), source_location);
                ImageReference::None
            }
        };
    }

    #[cfg(feature = "renderer-software")]
    if embed_files == EmbedResourcesKind::EmbedTextures {
        return match load_image(_file, _scale_factor, _font_collection) {
            Ok((img, source_format, original_size)) => {
                let resource_id = push(EmbeddedResourcesKind::TextureData(generate_texture(
                    img,
                    source_format,
                    original_size,
                )));
                ImageReference::EmbeddedTexture { resource_id }
            }
            Err(err) => {
                diag.push_error(format!("Cannot load image file {path}: {err}"), source_location);
                ImageReference::None
            }
        };
    }

    let resource_id = push(EmbeddedResourcesKind::FileData);
    ImageReference::EmbeddedData { resource_id, extension: extension() }
}

#[cfg(feature = "renderer-software")]
trait Pixel {
    //fn alpha(&self) -> f32;
    //fn rgb(&self) -> (u8, u8, u8);
    fn is_transparent(&self) -> bool;
}
#[cfg(feature = "renderer-software")]
impl Pixel for image::Rgba<u8> {
    /*fn alpha(&self) -> f32 { self[3] as f32 / 255. }
    fn rgb(&self) -> (u8, u8, u8) { (self[0], self[1], self[2]) }*/
    fn is_transparent(&self) -> bool {
        self[3] <= 1
    }
}

#[cfg(feature = "renderer-software")]
fn generate_texture(
    image: image::RgbaImage,
    source_format: SourceFormat,
    original_size: Size,
) -> Texture {
    // Analyze each pixels
    let mut top = 0;
    let is_line_transparent = |y| {
        for x in 0..image.width() {
            if !image.get_pixel(x, y).is_transparent() {
                return false;
            }
        }
        true
    };
    while top < image.height() && is_line_transparent(top) {
        top += 1;
    }
    if top == image.height() {
        return Texture::new_empty();
    }
    let mut bottom = image.height() - 1;
    while is_line_transparent(bottom) {
        bottom -= 1;
        assert!(bottom > top); // otherwise we would have a transparent image
    }
    let is_column_transparent = |x| {
        for y in top..=bottom {
            if !image.get_pixel(x, y).is_transparent() {
                return false;
            }
        }
        true
    };
    let mut left = 0;
    while is_column_transparent(left) {
        left += 1;
        assert!(left < image.width()); // otherwise we would have a transparent image
    }
    let mut right = image.width() - 1;
    while is_column_transparent(right) {
        right -= 1;
        assert!(right > left); // otherwise we would have a transparent image
    }
    let mut is_opaque = true;
    enum ColorState {
        Unset,
        Different,
        Rgb([u8; 3]),
    }
    let mut color = ColorState::Unset;
    'outer: for y in top..=bottom {
        for x in left..=right {
            let p = image.get_pixel(x, y);
            let alpha = p[3];
            if alpha != 255 {
                is_opaque = false;
            }
            if alpha == 0 {
                continue;
            }
            let get_pixel = || match source_format {
                SourceFormat::RgbaPremultiplied => <[u8; 3]>::try_from(&p.0[0..3])
                    .unwrap()
                    .map(|v| (v as u16 * 255 / alpha as u16) as u8),
                SourceFormat::Rgba => p.0[0..3].try_into().unwrap(),
            };
            match color {
                ColorState::Unset => {
                    color = ColorState::Rgb(get_pixel());
                }
                ColorState::Different => {
                    if !is_opaque {
                        break 'outer;
                    }
                }
                ColorState::Rgb([a, b, c]) => {
                    let px = get_pixel();
                    if a.abs_diff(px[0]) > 2 || b.abs_diff(px[1]) > 2 || c.abs_diff(px[2]) > 2 {
                        color = ColorState::Different
                    }
                }
            }
        }
    }

    let format = if let ColorState::Rgb(c) = color {
        PixelFormat::AlphaMap(c)
    } else if is_opaque {
        PixelFormat::Rgb
    } else {
        PixelFormat::RgbaPremultiplied
    };

    let rect = Rect::from_ltrb(left as _, top as _, (right + 1) as _, (bottom + 1) as _).unwrap();
    Texture {
        total_size: Size { width: image.width(), height: image.height() },
        original_size,
        rect,
        data: convert_image(image, source_format, format, rect),
        format,
    }
}

#[cfg(feature = "renderer-software")]
fn convert_image(
    image: image::RgbaImage,
    source_format: SourceFormat,
    format: PixelFormat,
    rect: Rect,
) -> Vec<u8> {
    let i = image::SubImage::new(&image, rect.x() as _, rect.y() as _, rect.width(), rect.height());
    match (source_format, format) {
        (_, PixelFormat::Rgb) => {
            i.pixels().flat_map(|(_, _, p)| IntoIterator::into_iter(p.0).take(3)).collect()
        }
        (SourceFormat::RgbaPremultiplied, PixelFormat::RgbaPremultiplied)
        | (SourceFormat::Rgba, PixelFormat::Rgba) => {
            i.pixels().flat_map(|(_, _, p)| IntoIterator::into_iter(p.0)).collect()
        }
        (SourceFormat::Rgba, PixelFormat::RgbaPremultiplied) => i
            .pixels()
            .flat_map(|(_, _, p)| {
                let a = p.0[3] as u32;
                IntoIterator::into_iter(p.0)
                    .take(3)
                    .map(move |x| (x as u32 * a / 255) as u8)
                    .chain(std::iter::once(a as u8))
            })
            .collect(),
        (SourceFormat::RgbaPremultiplied, PixelFormat::Rgba) => i
            .pixels()
            .flat_map(|(_, _, p)| {
                let a = p.0[3] as u32;
                IntoIterator::into_iter(p.0)
                    .take(3)
                    .map(move |x| (x as u32 * 255 / a) as u8)
                    .chain(std::iter::once(a as u8))
            })
            .collect(),
        (_, PixelFormat::AlphaMap(_)) => i.pixels().map(|(_, _, p)| p[3]).collect(),
    }
}

#[cfg(feature = "renderer-software")]
enum SourceFormat {
    RgbaPremultiplied,
    Rgba,
}

/// usvg renders SVG `<text>` against its own font database. The compiler has no
/// `SlintContext`, so resolve those fonts against the collection shared with
/// `embed_glyphs` (system fonts plus imported fonts) through the shared bridge.
#[cfg(feature = "renderer-software")]
fn svg_font_options(
    font_collection: Option<&SharedFontCollection>,
) -> resvg::usvg::Options<'static> {
    use i_slint_common::sharedfontique::svg as svg_fonts;

    let Some(font_collection) = font_collection.cloned() else {
        return resvg::usvg::Options::default();
    };
    svg_fonts::options(move |families, attributes, require_char| {
        let mut fonts = font_collection.lock().ok()?;
        let collection = &mut fonts.collection;
        svg_fonts::query_font(
            &mut collection.inner,
            &mut collection.source_cache,
            families,
            attributes,
            require_char,
        )
    })
}

#[cfg(feature = "renderer-software")]
fn load_image_from_bytes(
    data: &[u8],
    extension: Option<&str>,
    scale_factor: f32,
    font_collection: Option<&SharedFontCollection>,
) -> image::ImageResult<(image::RgbaImage, SourceFormat, Size)> {
    use resvg::{tiny_skia, usvg};

    let is_svg = matches!(extension, Some("svg") | Some("svgz"));

    if is_svg {
        let tree = {
            usvg::Tree::from_data(data, &svg_font_options(font_collection)).map_err(|e| {
                image::ImageError::Decoding(image::error::DecodingError::new(
                    image::error::ImageFormatHint::Name("svg".into()),
                    e,
                ))
            })?
        };

        let original_size = tree.size();
        let width = (original_size.width() * scale_factor) as u32;
        let height = (original_size.height() * scale_factor) as u32;

        let mut buffer = vec![0u8; width as usize * height as usize * 4];

        let size_error = || {
            image::ImageError::Limits(image::error::LimitError::from_kind(
                image::error::LimitErrorKind::DimensionError,
            ))
        };

        let mut skia_buffer =
            tiny_skia::PixmapMut::from_bytes(buffer.as_mut_slice(), width, height)
                .ok_or_else(size_error)?;

        resvg::render(
            &tree,
            tiny_skia::Transform::from_scale(scale_factor, scale_factor),
            &mut skia_buffer,
        );

        return image::RgbaImage::from_raw(width, height, buffer).ok_or_else(size_error).map(
            |img| {
                (
                    img,
                    SourceFormat::RgbaPremultiplied,
                    Size { width: original_size.width() as _, height: original_size.height() as _ },
                )
            },
        );
    }

    image::load_from_memory(data).map(|mut image| {
        let (original_width, original_height) = image.dimensions();

        if scale_factor < 1.0 {
            image = image.resize_exact(
                (original_width as f32 * scale_factor) as u32,
                (original_height as f32 * scale_factor) as u32,
                image::imageops::FilterType::Gaussian,
            );
        }

        (
            image.to_rgba8(),
            SourceFormat::Rgba,
            Size { width: original_width, height: original_height },
        )
    })
}

#[cfg(feature = "renderer-software")]
fn load_image(
    file: crate::fileaccess::VirtualFile,
    scale_factor: f32,
    font_collection: Option<&SharedFontCollection>,
) -> image::ImageResult<(image::RgbaImage, SourceFormat, Size)> {
    use std::ffi::OsStr;

    let extension = file.canon_path.extension().and_then(OsStr::to_str);

    let data = if let Some(buffer) = file.builtin_contents {
        buffer.to_vec()
    } else {
        std::fs::read(&file.canon_path)?
    };

    load_image_from_bytes(&data, extension, scale_factor, font_collection)
}

fn embed_data_uri(
    global_embedded_resources: &RefCell<TiVec<EmbeddedResourcesIdx, EmbeddedResources>>,
    path_to_id: &mut HashMap<SmolStr, EmbeddedResourcesIdx>,
    data_uri: &str,
    _embed_files: EmbedResourcesKind,
    _scale_factor: f32,
    diag: &mut BuildDiagnostics,
    source_location: &Option<crate::diagnostics::SourceLocation>,
    _font_collection: Option<&SharedFontCollection>,
) -> ImageReference {
    if let Some(&resource_id) = path_to_id.get(data_uri) {
        let resources = global_embedded_resources.borrow();
        return match &resources[resource_id].kind {
            #[cfg(feature = "renderer-software")]
            EmbeddedResourcesKind::TextureData { .. } => {
                ImageReference::EmbeddedTexture { resource_id }
            }
            EmbeddedResourcesKind::DataUriPayload(_, ext) => {
                ImageReference::EmbeddedData { resource_id, extension: ext.clone() }
            }
            _ => ImageReference::None,
        };
    }

    let (decoded_data, extension) = match crate::data_uri::decode_data_uri(data_uri) {
        Ok(result) => result,
        Err(e) => {
            diag.push_error(e, source_location);
            return ImageReference::None;
        }
    };

    let mut resources = global_embedded_resources.borrow_mut();
    let mut push = |kind| {
        let id = resources.push_and_get_key(EmbeddedResources { path: None, kind });
        path_to_id.insert(data_uri.into(), id);
        id
    };

    #[cfg(feature = "renderer-software")]
    if _embed_files == EmbedResourcesKind::EmbedTextures {
        match load_image_from_bytes(
            &decoded_data,
            Some(&extension),
            _scale_factor,
            _font_collection,
        )
        .map_err(|e| e.to_string())
        {
            Ok((img, source_format, original_size)) => {
                let resource_id = push(EmbeddedResourcesKind::TextureData(generate_texture(
                    img,
                    source_format,
                    original_size,
                )));
                return ImageReference::EmbeddedTexture { resource_id };
            }
            Err(err) => {
                diag.push_error(format!("Cannot load data URI image: {err}"), source_location);
                return ImageReference::None;
            }
        }
    }

    let resource_id = push(EmbeddedResourcesKind::DataUriPayload(decoded_data, extension.clone()));

    ImageReference::EmbeddedData { resource_id, extension }
}