// Copyright © SixtyFPS GmbH // SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-Royalty-free-2.0 OR LicenseRef-Slint-Software-3.0 /*! This module contains image and caching related types for the run-time library. */ #[cfg(not(target_arch = "wasm32"))] use super::CachedPath; use super::{Image, ImageCacheKey, ImageInner, SharedImageBuffer}; use crate::{SharedString, slice::Slice}; struct ImageWeightInBytes; impl clru::WeightScale for ImageWeightInBytes { fn weight(&self, _key: &ImageCacheKey, value: &ImageInner) -> usize { match value { ImageInner::None => 0, ImageInner::EmbeddedImage { buffer, .. } => match buffer { SharedImageBuffer::RGB8(pixels) => pixels.as_bytes().len(), SharedImageBuffer::RGBA8(pixels) => pixels.as_bytes().len(), SharedImageBuffer::RGBA8Premultiplied(pixels) => pixels.as_bytes().len(), }, #[cfg(feature = "svg")] ImageInner::Svg(svg) => svg.weight_in_bytes(), #[cfg(target_arch = "wasm32")] ImageInner::HTMLImage(_) => 512, // Something... the web browser maintainers its own cache. The purpose of this cache is to reduce the amount of DOM elements. ImageInner::StaticTextures(_) => 0, ImageInner::BackendStorage(x) => vtable::VRc::borrow(x).size().area() as usize, #[cfg(not(target_arch = "wasm32"))] ImageInner::BorrowedOpenGLTexture(..) => 0, // Assume storage in GPU memory ImageInner::NineSlice(nine) => self.weight(_key, &nine.0), #[cfg(any(feature = "unstable-wgpu-29", feature = "unstable-wgpu-30"))] ImageInner::WGPUTexture(..) => 0, // The texture is imported from the application and will never reside in our cache. } } } /// Cache used to avoid repeatedly decoding images from disk. pub(crate) struct ImageCache( clru::CLruCache< ImageCacheKey, ImageInner, std::collections::hash_map::RandomState, ImageWeightInBytes, >, ); crate::thread_local!(pub(crate) static IMAGE_CACHE: core::cell::RefCell = core::cell::RefCell::new( ImageCache( clru::CLruCache::with_config( clru::CLruCacheConfig::new(core::num::NonZeroUsize::new(5 * 1024 * 1024).unwrap()) .with_scale(ImageWeightInBytes) ) ) ) ); impl ImageCache { // Look up the given image cache key in the image cache and upgrade the weak reference to a strong one if found, // otherwise a new image is created/loaded from the given callback. fn lookup_image_in_cache_or_create( &mut self, cache_key: ImageCacheKey, image_create_fn: impl Fn(ImageCacheKey) -> Option, ) -> Option { Some(Image(if let Some(entry) = self.0.get(&cache_key) { entry.clone() } else { let new_image = image_create_fn(cache_key.clone())?; self.0.put_with_weight(cache_key, new_image.clone()).ok(); new_image })) } #[cfg(target_arch = "wasm32")] pub(crate) fn load_image_from_path(&mut self, _path: &SharedString) -> Option { None } #[cfg(not(target_arch = "wasm32"))] pub(crate) fn load_image_from_path(&mut self, path: &SharedString) -> Option { if path.is_empty() { return None; } let cache_key = ImageCacheKey::Path(CachedPath::new(path.as_str())); self.lookup_image_in_cache_or_create(cache_key, |cache_key| { #[cfg(feature = "svg")] if path.ends_with(".svg") || path.ends_with(".svgz") { return Some(ImageInner::Svg(vtable::VRc::new( super::svg::load_from_path(path, cache_key).map_or_else( |err| { crate::debug_log!("Error loading SVG from {}: {}", &path, err); None }, Some, )?, ))); } image::open(std::path::Path::new(&path.as_str())).map_or_else( |decode_err| { crate::debug_log!("Error loading image from {}: {}", &path, decode_err); None }, |image| { Some(ImageInner::EmbeddedImage { cache_key, buffer: super::dynamic_image_to_shared_image_buffer(image), }) }, ) }) } /// Load an image by handing its URL to an `` element for the browser to /// fetch. This is a web-only slintpad mechanism, not general network loading. #[cfg(target_arch = "wasm32")] pub(crate) fn load_as_html_image(&mut self, url: &str) -> Option { if url.is_empty() { return None; } let cache_key = ImageCacheKey::URL(url.into()); self.lookup_image_in_cache_or_create(cache_key, |_| { Some(ImageInner::HTMLImage(vtable::VRc::new(super::htmlimage::HTMLImage::new(url)))) }) } pub(crate) fn load_image_from_embedded_data( &mut self, data: Slice<'static, u8>, format: Slice<'_, u8>, ) -> Option { let cache_key = ImageCacheKey::from_embedded_image_data(data.as_slice()); self.lookup_image_in_cache_or_create(cache_key, |cache_key| { ImageInner::load_from_data_with_cache_key(cache_key, data, format) }) } #[cfg(target_arch = "wasm32")] pub(crate) fn load_image_from_data_uri( &mut self, uri: &str, data: &[u8], format: &str, ) -> Option { let cache_key = ImageCacheKey::URL(uri.into()); self.lookup_image_in_cache_or_create(cache_key, |cache_key| { ImageInner::load_from_data_with_cache_key( cache_key, data.into(), format.as_bytes().into(), ) }) } } /// Replace the cached image key with the given value pub fn replace_cached_image(key: ImageCacheKey, value: ImageInner) { if key == ImageCacheKey::Invalid { return; } let _ = IMAGE_CACHE.with(|global_cache| global_cache.borrow_mut().0.put_with_weight(key, value)); } #[cfg(all(test, feature = "image-decoders"))] mod tests { use crate::graphics::Rgba8Pixel; #[test] fn test_path_cache_invalidation() { let temp_dir = tempfile::tempdir().unwrap(); let test_path = [temp_dir.path(), std::path::Path::new("testfile.png")] .iter() .collect::(); let red_image = image::RgbImage::from_pixel(10, 10, image::Rgb([255, 0, 0])); red_image.save(&test_path).unwrap(); let red_slint_image = crate::graphics::Image::load_from_path(&test_path).unwrap(); let buffer = red_slint_image.to_rgba8().unwrap(); assert!( buffer .as_slice() .iter() .all(|pixel| *pixel == Rgba8Pixel { r: 255, g: 0, b: 0, a: 255 }) ); let green_image = image::RgbImage::from_pixel(10, 10, image::Rgb([0, 255, 0])); std::thread::sleep(std::time::Duration::from_secs(2)); green_image.save(&test_path).unwrap(); /* Can't use this until we use Rust 1.78 let mod_time = std::fs::metadata(&test_path).unwrap().modified().unwrap(); std::fs::File::options() .write(true) .open(&test_path) .unwrap() .set_modified(mod_time.checked_add(std::time::Duration::from_secs(2)).unwrap()) .unwrap(); */ let green_slint_image = crate::graphics::Image::load_from_path(&test_path).unwrap(); let buffer = green_slint_image.to_rgba8().unwrap(); assert!( buffer .as_slice() .iter() .all(|pixel| *pixel == Rgba8Pixel { r: 0, g: 255, b: 0, a: 255 }) ); } }