Merge branch 'feat/dynamic-downsampling' of goldy.github.com:cloudy-org/roseate into feat/dynamic-downsampling

Author: THEGOLDENPRO

Cargo.toml

@@ -27,13 +27,15 @@ re_format = "0.20.0"
 cap = "0.1.2"
 clap = {version = "4.5.21", features = ["derive"]}
 rand = "0.8.5"
-display-info = "0.5.2"
 egui-notify = "0.17.0"
 svg_metadata = "0.5.1"
 textwrap = "0.16.1"
 dirs = "5.0.1"
 rayon = "1.10.0"
 serde_derive = "1.0.215"
+serde_json = "1.0"
+fs2 = "0.4.3"
+
 toml = {workspace = true}
 serde = {workspace = true, features = ["derive"]}
 
@@ -46,5 +48,12 @@ egui = "0.29.1"
 toml = "0.8.19"
 serde = {version = "1.0.215", features = ["derive"]}
 
-[profile.dev.package."*"]
-opt-level = 3
+# I've now disabled compiling release builds of dependices to speed up dev compile time.
+# 
+# THIS MEANS IMAGE PROCESSING WILL BE MUCH MUCH 
+# SLOWER ON DEV BUILDS COMPARED TO RELEASE BUILDS
+# 
+# So with that said ALWAYS compile release unless you are developing Roseate.
+# 
+#[profile.dev.package."*"]
+#opt-level = 3

README.md

@@ -26,10 +26,14 @@ As Roseate is in heavy development I won't offer packages and binaries yet so yo
 ### Prerequisites:
 - [Rust](https://www.rust-lang.org/tools/install) and Cargo (Rust **`1.80.0`**+ is required!).
 
-- Linux dependecies for [eframe](https://crates.io/crates/eframe):
+- Linux dependencies required by [eframe](https://crates.io/crates/eframe):
   - [libxcb](https://archlinux.org/packages/extra/x86_64/libxcb/)
   - [libxkbcommon](https://archlinux.org/packages/extra/x86_64/libxkbcommon/)
   - [openssl](https://archlinux.org/packages/core/x86_64/openssl/)
+- [libxrandr](https://archlinux.org/packages/extra/x86_64/libxrandr/) (required by [display-info](https://crates.io/crates/display-info) for smart downsampling)
+- [xdg-desktop-portal](https://github.com/flatpak/xdg-desktop-portal) (required by [rfd](https://docs.rs/rfd/latest/rfd/) for file dialog)
+
+All of these deps are required on Linux. However they are *common* x11 / wayland dependencies so you most likely already have them installed.
 
 1. Clone the repo.
 ```sh
@@ -41,10 +45,37 @@ cd roseate
 git submodule update --init --recursive
 ```
 
+#### 🎀 Install into your system.
+Installing it to your system I advise you use GNU Make or else copy the commands from the "[Makefile](./Makefile)" (you will need to install Make if you haven't already).
+If you would like to run roseate for development continue ahead to the [next section](#%EF%B8%8F-for-development).
+
+3. Build the release binary.
+```sh
+make
+```
+4. Install to your system.
+```sh
+sudo make install
+```
+5. Then the `roseate` binary will be available in your terminal.
+```sh
+roseate
+```
+
+Open an image by passing its path.
+```sh
+roseate ./anime_girls.png
+```
+You might want to also set the binary at ``/usr/bin/roseate`` as your default image viewer so double clicking on images calls it. 
+You can look up how to perform that for your desktop environment or operating system but on many popular Linux desktop environments, the [`roseate.desktop`](https://github.com/cloudy-org/roseate/blob/main/assets/roseate.desktop) file that is now installed on your system is your friend. 😉
+
 #### ⚙️ For Development
-At this stage, for development, you would just run ``cargo run``. If you would like to install it to your system continue ahead to the [next section](#-install-into-your-system).
+> [!WARNING]
+> Building a development build WILL SIGNIFICANTLY KILL performance! Read more [here](https://github.com/cloudy-org/roseate/blob/6e7e638997110af0149f06ceadb87c3ec088cf84/Cargo.toml#L48-L53).
 
-4. Run dev binary.
+Now for development, you would just run ``cargo run``.
+
+3. Run dev binary.
 ```sh
 cargo run
 ```
@@ -68,28 +99,6 @@ RUST_LOG=DEBUG cargo run -- ./anime_girl.png
 ... (truncated for the sanity of this readme)
 ```
 
-#### 🎀 Install into your system.
-Installing it to your system I advise you use GNU Make or else copy the commands from the "[Makefile](./Makefile)" (you will need to install Make if you haven't already).
-
-4. Build the release binary.
-```sh
-make
-```
-5. Install to your system.
-```sh
-sudo make install
-```
-6. Then the `roseate` binary will be available in your terminal.
-```sh
-roseate
-```
-
-Open an image by passing its path.
-```sh
-roseate ./anime_girls.png
-```
-You might want to also set the binary at ``/usr/bin/roseate`` as your default image viewer so double clicking on images calls it. You can look up how to perform that for your desktop environment or OS.
-
 <br>
 
 <div align="center">

assets/config.template.toml

@@ -37,11 +37,15 @@ ui_controls.toggle = "C"
 [misc]
 # All other configs that don't yet have a specific place or are experimental.
 
+# override_monitor_size = {width = 1920, height = 1080}
+
 [misc.experimental]
-# Settings to toggle experimental features that aren't yet ready to be
+# Settings to toggle experimental features that aren't yet ready yet to be 
 # used by the wider user audience. This exists for the sole purpose of testing.
 # 
 # Remember these are EXPERIMENTAL, bugs WILL be present.
 
-use_fast_roseate_backend = false
-# Setting this to true will enable the experimental roseate image processing backend.
+# Setting this to true will enable the experimental lanczos roseate image processing backend
+# which is faster than the image-rs backend but may result in buggy/blocky images. 
+# Disable this if the image looks weird.
+use_fast_roseate_backend = false

cirrus

@@ -1,34 +1,32 @@
 use std::time::Duration;
 
 use cirrus_theming::v1::{Colour, Theme};
-use eframe::egui::{self, Align, Color32, Context, CursorIcon, Frame, Layout, Margin, Rect, Shadow, Stroke, Style, TextStyle, Vec2};
+use eframe::egui::{self, Align, Color32, Context, CursorIcon, Frame, Layout, Margin, Rect, Stroke, Vec2};
 use egui_notify::ToastLevel;
 
-use crate::{config::config::Config, files, image::image::Image, image_loader::ImageLoader, windows::info::InfoWindow, magnification_panel::MagnificationPanel, notifier::NotifierAPI, window_scaling::WindowScaling, windows::about::AboutWindow, zoom_pan::ZoomPan};
+use crate::{config::config::Config, files, image_handler::ImageHandler, magnification_panel::MagnificationPanel, monitor_size::MonitorSize, notifier::{self, NotifierAPI}, window_scaling::WindowScaling, windows::{about::AboutWindow, info::InfoWindow}, zoom_pan::ZoomPan};
 
 pub struct Roseate<'a> {
     theme: Theme,
-    image: Option<Image>,
     zoom_pan: ZoomPan,
     info_box: InfoWindow,
     about_box: AboutWindow<'a>,
     notifier: NotifierAPI,
     magnification_panel: MagnificationPanel,
     window_scaling: WindowScaling,
     last_window_rect: Rect,
-    image_loader: ImageLoader,
+    image_handler: ImageHandler,
+    monitor_size: MonitorSize,
     config: Config,
 }
 
 impl<'a> Roseate<'a> {
-    pub fn new(image: Option<Image>, theme: Theme, mut notifier: NotifierAPI, config: Config) -> Self {
-        let mut image_loader = ImageLoader::new();
-
-        if image.is_some() {
-            image_loader.load_image(
-                &mut image.clone().unwrap(), 
+    pub fn new(mut image_handler: ImageHandler, monitor_size: MonitorSize, mut notifier: NotifierAPI, theme: Theme, config: Config) -> Self {
+        if image_handler.image.is_some() {
+            image_handler.load_image(
                 config.image.loading.initial.lazy_loading, 
                 &mut notifier,
+                &monitor_size,
                 config.misc.experimental.use_fast_roseate_backend
             );
         }
@@ -39,7 +37,6 @@ impl<'a> Roseate<'a> {
         let magnification_panel = MagnificationPanel::new(&config, &mut notifier);
 
         Self {
-            image,
             theme,
             notifier,
             zoom_pan,
@@ -48,52 +45,12 @@ impl<'a> Roseate<'a> {
             magnification_panel,
             window_scaling: WindowScaling::new(&config),
             last_window_rect: Rect::NOTHING,
-            image_loader: image_loader,
+            monitor_size,
+            image_handler,
             config,
         }
     }
 
-    fn set_app_style(&self, ctx: &Context) {
-        let mut custom_style = Style {
-            override_text_style: Some(TextStyle::Monospace),
-            ..Default::default()
-        };
-
-        // TODO: override more default   
-        // colours here with colours from our theme.
-
-        // Background colour styling.
-        custom_style.visuals.panel_fill = Color32::from_hex(
-            &self.theme.primary_colour.hex_code
-        ).unwrap();
-
-        // Window styling.
-        custom_style.visuals.window_highlight_topmost = false;
-
-        custom_style.visuals.window_fill = Color32::from_hex(
-            &self.theme.secondary_colour.hex_code
-        ).unwrap();
-        custom_style.visuals.window_stroke = Stroke::new(
-            1.0,
-            Color32::from_hex(&self.theme.third_colour.hex_code).unwrap()
-        );
-        custom_style.visuals.window_shadow = Shadow::NONE;
-
-        custom_style.visuals.widgets.inactive.bg_fill =
-            Color32::from_hex(
-                &self.theme.primary_colour.hex_code
-            ).unwrap();
-
-        // Text styling.
-        custom_style.visuals.override_text_color = Some(
-            Color32::from_hex(
-                &self.theme.text_colour.hex_code
-            ).unwrap()
-        );
-
-        ctx.set_style(custom_style);
-    }
-
     fn draw_dotted_line(&self, ui: &egui::Painter, pos: &[egui::Pos2]) {
         ui.add(
             egui::Shape::dashed_line(
@@ -115,9 +72,7 @@ impl<'a> Roseate<'a> {
 impl eframe::App for Roseate<'_> {
 
     fn update(&mut self, ctx: &Context, _frame: &mut eframe::Frame) {
-        self.set_app_style(ctx);
-
-        self.info_box.init(&self.image);
+        self.info_box.init(&self.image_handler.image);
         self.info_box.handle_input(ctx);
 
         self.zoom_pan.handle_reset_input(ctx);
@@ -135,10 +90,11 @@ impl eframe::App for Roseate<'_> {
             }
 
             self.notifier.update(ctx);
+            self.monitor_size.update(ctx, &mut self.notifier);
             self.about_box.update(ctx); // we update this box here because we want 
             // the about box is to be toggleable even without an image.
 
-            if self.image.is_none() {
+            if self.image_handler.image.is_none() {
                 // Collect dropped files.
                 ctx.input(|i| {
                     let dropped_files = &i.raw.dropped_files;
@@ -149,21 +105,19 @@ impl eframe::App for Roseate<'_> {
                             .as_ref()
                             .unwrap(); // gotta love rust ~ ananas
 
-                        let mut image = match Image::from_path(path) {
-                            Ok(value) => value,
-                            Err(error) => {
-                                self.notifier.toasts.lock().unwrap().toast_and_log(
-                                    error.into(), ToastLevel::Error
-                                );
-                                return;
-                            }
-                        };
+                        let result = self.image_handler.init_image(path, &self.monitor_size);
 
-                        self.image = Some(image.clone());
-                        self.image_loader.load_image(
-                            &mut image, 
+                        if let Err(error) = result {
+                            self.notifier.toasts.lock().unwrap().toast_and_log(
+                                error.into(), ToastLevel::Error
+                            );
+                            return;
+                        }
+
+                        self.image_handler.load_image(
                             true, 
                             &mut self.notifier,
+                            &self.monitor_size,
                             self.config.misc.experimental.use_fast_roseate_backend
                         );
                     }
@@ -201,16 +155,14 @@ impl eframe::App for Roseate<'_> {
                             rose_response.clone().on_hover_cursor(CursorIcon::PointingHand);
 
                             if rose_response.clicked() {
-                                let image_result = files::select_image();
-
-                                match image_result {
-                                    Ok(mut image) => {
-                                        self.image = Some(image.clone());
+                                let result = self.image_handler.select_image(&self.monitor_size);
 
-                                        self.image_loader.load_image(
-                                            &mut image,
+                                match result {
+                                    Ok(_) => {
+                                        self.image_handler.load_image(
                                             self.config.image.loading.gui.lazy_loading,
                                             &mut self.notifier,
+                                            &self.monitor_size,
                                             self.config.misc.experimental.use_fast_roseate_backend
                                         );
                                     },
@@ -246,19 +198,25 @@ impl eframe::App for Roseate<'_> {
 
             self.info_box.update(ctx);
             self.zoom_pan.update(ctx);
-            self.image_loader.update();
+            self.image_handler.update(&self.zoom_pan, &self.monitor_size);
             self.magnification_panel.update(ctx, &mut self.zoom_pan);
 
-            let image = self.image.clone().unwrap();
+            let image = self.image_handler.image.clone().unwrap();
 
-            if self.image_loader.image_loaded {
+            if self.image_handler.image_loaded {
                 ui.centered_and_justified(|ui| {
                     let scaled_image_size = self.window_scaling.relative_image_size(
                         Vec2::new(image.image_size.width as f32, image.image_size.height as f32)
                     );
-    
+
+                    // TODO: umm I think we should move this to self.zoom_pan.update() 
+                    // and then move that function in here as we need `scaled_image_size`.
                     if self.zoom_pan.is_pan_out_of_bounds(scaled_image_size) {
                         self.zoom_pan.schedule_pan_reset(Duration::from_millis(300));
+
+                        // As resetting the pan will just snap us back to the center 
+                        // of the image we might as well schedule a reset for image scale too.
+                        self.zoom_pan.schedule_scale_reset(Duration::from_millis(300));
                     };
 
                     // NOTE: umm do we move this to window scaling... *probably* if we 
@@ -330,5 +288,4 @@ impl eframe::App for Roseate<'_> {
         );
 
     }
-
 }

src/app.rs

@@ -31,6 +31,9 @@ impl Config {
 
         let roseate_config_dir_path = local_config_dir.join("cloudy").join("roseate");
 
+        // TODO: switch to get_local_config_path function.
+        // let roseate_config_path = files::get_local_config_path()?;
+
         if !roseate_config_dir_path.exists() {
             debug!("Creating config directory for roseate...");
             if let Err(err) = fs::create_dir_all(&roseate_config_dir_path) {

src/config/config.rs

@@ -2,6 +2,8 @@ use serde::{Serialize, Deserialize};
 
 #[derive(Serialize, Deserialize, Default)]
 pub struct Misc {
+    #[serde(default = "super::none_default")]
+    pub override_monitor_size: Option<OverrideMonitorSize>,
     pub experimental: Experimental,
 }
 
@@ -18,4 +20,11 @@ impl Default for Experimental {
             use_fast_roseate_backend: false
         }
     }
+}
+
+
+#[derive(Serialize, Deserialize)]
+pub struct OverrideMonitorSize {
+    pub width: u32,
+    pub height: u32
 }