Embed multiple sizes into ICO icons (closes #705)

Author: filips123

native/Cargo.lock

@@ -52,6 +52,7 @@ urlencoding = "2.1.3"
 web_app_manifest = { git = "https://github.com/filips123/WebAppManifestRS", branch = "main" }
 
 [target.'cfg(target_os = "windows")'.dependencies]
+ico = "0.4.0"
 windows-registry = "0.6.0"
 sanitize-filename = "0.6.0"
 phf = { version = "0.13.1", features = ["macros"], optional = true }

native/Cargo.toml

@@ -16,7 +16,7 @@ use web_app_manifest::types::{ImagePurpose, ImageSize};
 
 use crate::components::site::Site;
 use crate::integrations::categories::XDG_CATEGORIES;
-use crate::integrations::utils::{download_icon, normalize_category_name, process_icons};
+use crate::integrations::utils::{download_icon, normalize_category_name, store_icon};
 use crate::integrations::{IntegrationInstallArgs, IntegrationUninstallArgs};
 use crate::utils::sanitize_string;
 
@@ -72,14 +72,14 @@ impl SiteIds {
 /// Obtain and process icons from the icon list.
 ///
 /// All supported icons from the icon list are downloaded and stored to
-/// the correct locations the comply with the Icon Theme Specification.
+/// the correct locations to comply with the Icon Theme Specification.
 ///
 /// All SVG icons are directly stored as `scalable` or `symbolic` icons,
 /// and other supported icons are converted to PNG and then stored.
 ///
 /// The 48x48 icon has to exist as required by the Icon Theme Specification.
-/// In case it is not provided by the icon list, is is obtained using
-/// the [`process_icons`] function.
+/// In case it is not provided by the icon list, it is obtained using
+/// the [`store_icon`] function.
 ///
 /// # Parameters
 ///
@@ -179,7 +179,7 @@ fn store_icons(
         warn!("No required 48x48 icon is provided");
         warn!("Generating it from other available icons");
         let size = &ImageSize::Fixed(48, 48);
-        return process_icons(icons, name, size, &filename, client);
+        return store_icon(icons, name, size, &filename, client);
     }
 
     Ok(())

native/src/integrations/implementation/linux.rs

@@ -7,7 +7,7 @@ use std::process::{Child, Command, Stdio};
 
 use anyhow::{Context, Result, bail};
 use icns::{IconFamily, IconType, Image, PixelFormat};
-use image::imageops::FilterType::Gaussian;
+use image::imageops::FilterType::Lanczos3;
 use image::imageops::resize;
 use image::{DynamicImage, Rgba, RgbaImage};
 use log::{debug, error, warn};
@@ -21,7 +21,7 @@ use crate::components::site::Site;
 use crate::integrations::categories::MACOS_CATEGORIES;
 use crate::integrations::utils::{
     download_icon,
-    generate_icon,
+    generate_fallback_icon,
     normalize_category_name,
     sanitize_name,
 };
@@ -44,7 +44,7 @@ const STORE_ICONS_ERROR: &str = "Failed to store icons";
 const LAUNCH_APPLICATION_BUNDLE: &str = "Failed to launch web app via system integration";
 const APP_BUNDLE_NAME_ERROR: &str = "Failed to get name of app bundle";
 const APP_BUNDLE_UNICODE_ERROR: &str = "Failed to check name of app bundle for Unicode validity";
-const GENERATE_ICON_ERROR: &str = "Failed to generate icon";
+const GENERATE_FALLBACK_ICON_ERROR: &str = "Failed to generate fallback icon";
 const GET_LETTER_ERROR: &str = "Failed to get first letter";
 
 const ICON_SAFE_ZONE_FACTOR: f64 = 0.697265625;
@@ -221,7 +221,8 @@ fn store_icons(target: &Path, name: &str, icons: &[IconResource], client: &Clien
 
         for size in &icon_sizes {
             let image_size = ImageSize::Fixed(size.size(), size.size());
-            let image_data = generate_icon(letter, &image_size).context(GENERATE_ICON_ERROR)?;
+            let image_data = generate_fallback_icon(letter, &image_size)
+                .context(GENERATE_FALLBACK_ICON_ERROR)?;
 
             let mut img = DynamicImage::ImageRgb8(image_data).into_rgba8();
             mask_icon(&mut img, true).context(MASK_ICON_ERROR)?;
@@ -270,7 +271,7 @@ fn load_icon(content: &[u8], content_type: &str, size: u32) -> Result<RgbaImage>
     // Parse raster icons using the `image` crate and resize it to the correct size
     debug!("Processing as raster icon");
     let img = image::load_from_memory(content).context("Failed to load raster icon")?;
-    let img = img.resize_to_fill(size, size, Gaussian).into_rgba8();
+    let img = img.resize_to_fill(size, size, Lanczos3).into_rgba8();
     Ok(img)
 }
 
@@ -286,8 +287,8 @@ fn mask_icon(icon: &mut RgbaImage, maskable: bool) -> Result<()> {
     let icon_size = Point { x: icon.width(), y: icon.height() };
     let mask = image::load_from_memory(include_bytes!("../../../assets/icon-mask-macos.png"))?;
     let shadow = image::load_from_memory(include_bytes!("../../../assets/icon-shadow-macos.png"))?;
-    let scaled_mask = mask.resize(icon_size.x, icon_size.y, Gaussian); // This is really slow in debug builds, up to ~1s
-    let scaled_shadow = shadow.resize(icon_size.x, icon_size.y, Gaussian); // This is really slow in debug builds, up to ~1s
+    let scaled_mask = mask.resize(icon_size.x, icon_size.y, Lanczos3); // This is really slow in debug builds, up to ~1s
+    let scaled_shadow = shadow.resize(icon_size.x, icon_size.y, Lanczos3); // This is really slow in debug builds, up to ~1s
     let mask_data = scaled_mask.into_rgba8();
     let shadow_data = scaled_shadow.into_rgba8();
 
@@ -308,7 +309,7 @@ fn mask_icon(icon: &mut RgbaImage, maskable: bool) -> Result<()> {
     let scaled_icon_data: RgbaImage = if maskable {
         icon.clone()
     } else {
-        resize(icon, scaled_icon_size.x, scaled_icon_size.y, Gaussian)
+        resize(icon, scaled_icon_size.x, scaled_icon_size.y, Lanczos3)
     };
 
     let background = RgbaImage::from_pixel(icon_size.x, icon_size.y, Rgba([255, 255, 255, 255]));

native/src/integrations/implementation/macos.rs

@@ -9,7 +9,7 @@ use log::warn;
 use web_app_manifest::types::ImageSize;
 
 use crate::integrations::categories::PORTABLEAPPS_CATEGORIES;
-use crate::integrations::utils::{normalize_category_name, process_icons};
+use crate::integrations::utils::{normalize_category_name, store_icon, store_multisize_icon};
 use crate::integrations::{IntegrationInstallArgs, IntegrationUninstallArgs};
 use crate::utils::sanitize_string;
 
@@ -95,17 +95,20 @@ fn store_icons(args: &IntegrationInstallArgs, path: &Path) -> Result<()> {
         PortableAppIcon { size: 75, format: "png" },
         PortableAppIcon { size: 128, format: "png" },
         PortableAppIcon { size: 256, format: "png" },
-        PortableAppIcon { size: 256, format: "ico" },
     ];
 
     let icons = &args.site.icons();
     let fallback = &args.site.name();
     let client = args.client.unwrap();
 
     for icon in required {
-        process_icons(icons, fallback, &icon.size(), &path.join(icon.filename()), client)?;
+        store_icon(icons, fallback, &icon.size(), &path.join(icon.filename()), client)?;
     }
 
+    // Skip sizes 32 and smaller as that causes bad rendering
+    let sizes = [48, 64, 128, 256];
+    store_multisize_icon(icons, fallback, &sizes, &path.join("appicon.ico"), client)?;
+
     Ok(())
 }
 

native/src/integrations/implementation/portableapps.rs

@@ -6,7 +6,6 @@ use log::warn;
 use reqwest::blocking::Client;
 use url::Url;
 use web_app_manifest::resources::IconResource;
-use web_app_manifest::types::ImageSize;
 use windows::Win32::Storage::EnhancedStorage::{PKEY_AppUserModel_ID, PKEY_Title};
 use windows::Win32::System::Com::StructuredStorage::InitPropVariantFromStringVector;
 use windows::Win32::System::Com::{
@@ -31,7 +30,7 @@ use windows::core::{GUID, HSTRING, Interface, PCWSTR, Result as WindowsResult};
 use windows_registry::{CURRENT_USER, Key};
 
 use crate::components::site::Site;
-use crate::integrations::utils::{process_icons, sanitize_name};
+use crate::integrations::utils::{sanitize_name, store_multisize_icon};
 use crate::integrations::{IntegrationInstallArgs, IntegrationUninstallArgs};
 use crate::utils::sanitize_string;
 
@@ -86,7 +85,7 @@ impl SiteIds {
 /// the next icons are tried. If no provided icons are working, the icon is generated
 /// from the first letter of the name.
 ///
-/// See [`process_icons`] for more details.
+/// See [`store_multisize_icon`] for more details.
 ///
 /// # Parameters
 ///
@@ -96,10 +95,8 @@ impl SiteIds {
 /// - `client`: An instance of a blocking HTTP client.
 ///
 fn store_icon(name: &str, icons: &[IconResource], path: &Path, client: &Client) -> Result<()> {
-    // Currently only one embedded image per ICO is supported: https://github.com/image-rs/image/issues/884
-    // Until more embedded images are supported, use the max ICO size (256x256)
-    let size = &ImageSize::Fixed(256, 256);
-    process_icons(icons, name, size, path, client)
+    let sizes = [16, 24, 32, 48, 64, 128, 256];
+    store_multisize_icon(icons, name, &sizes, path, client)
 }
 
 fn create_arp_entry(