chore(deps): bump image from 0.23.14 to 0.24.0 (#108)

Author: sassman

Cargo.lock

@@ -32,7 +32,7 @@ version = "3.0.14"
 features = ["cargo"]
 
 [dependencies.image]
-version = "0.23.14"
+version = "0.24.0"
 features = ["tga"]
 
 [target.'cfg(target_os = "macos")'.dependencies]

Cargo.toml

@@ -1,5 +1,6 @@
 use anyhow::{Context, Result};
 use image::save_buffer;
+use image::ColorType::Rgba8;
 use std::borrow::Borrow;
 use std::ops::{Add, Sub};
 use std::sync::mpsc::Receiver;
@@ -80,7 +81,7 @@ pub fn save_frame(
         &image.samples,
         image.layout.width,
         image.layout.height,
-        image.color_hint.unwrap(),
+        image.color_hint.unwrap_or(Rgba8),
     )
     .context("Cannot save frame")
 }

src/capture.rs

@@ -1,13 +1,13 @@
 use crate::{Image, Margin, Result};
 use image::flat::View;
-use image::{Bgra, GenericImageView};
+use image::{GenericImageView, Rgba};
 
 ///
 /// this helps to identify outer transparent regions
 /// since some backends provides transparency either from a compositor effect like drop shadow on ubuntu / GNOME
 /// or some strange right side strip on MacOS
 pub fn identify_transparency(image: Image) -> Result<Option<Margin>> {
-    let image: View<_, Bgra<u8>> = image.as_view()?;
+    let image: View<_, Rgba<u8>> = image.as_view()?;
     let (width, height) = image.dimensions();
     let half_width = width / 2;
     let half_height = height / 2;
@@ -17,7 +17,7 @@ pub fn identify_transparency(image: Image) -> Result<Option<Margin>> {
     let mut margin = Margin::zero();
     // identify top margin
     for y in 0..half_height {
-        let Bgra([_, _, _, a]) = image.get_pixel(half_width, y);
+        let Rgba([_, _, _, a]) = image.get_pixel(half_width, y);
         if a > transparency_end {
             // the end of the transparent area
             margin.top = y as u16;
@@ -26,7 +26,7 @@ pub fn identify_transparency(image: Image) -> Result<Option<Margin>> {
     }
     // identify bottom margin
     for y in (half_height..height).rev() {
-        let Bgra([_, _, _, a]) = image.get_pixel(half_width, y);
+        let Rgba([_, _, _, a]) = image.get_pixel(half_width, y);
         if a > transparency_end {
             // the end of the transparent area
             margin.bottom = (height - y - 1) as u16;
@@ -35,7 +35,7 @@ pub fn identify_transparency(image: Image) -> Result<Option<Margin>> {
     }
     // identify left margin
     for x in 0..half_width {
-        let Bgra([_, _, _, a]) = image.get_pixel(x, half_height);
+        let Rgba([_, _, _, a]) = image.get_pixel(x, half_height);
         if a > transparency_end {
             // the end of the transparent area
             margin.left = x as u16;
@@ -44,7 +44,7 @@ pub fn identify_transparency(image: Image) -> Result<Option<Margin>> {
     }
     // identify right margin
     for x in (half_width..width).rev() {
-        let Bgra([_, _, _, a]) = image.get_pixel(x, half_height);
+        let Rgba([_, _, _, a]) = image.get_pixel(x, half_height);
         if a > transparency_end {
             // the end of the transparent area
             margin.right = (width - x - 1) as u16;
@@ -63,9 +63,9 @@ mod test {
     fn should_identify_macos_right_side_issue() -> Result<()> {
         // given an screen capture with transparency on the right side
         let image_org = image::open("tests/frames/frame-macos-right-side-issue.tga")?;
-        let image = image_org.into_bgra8();
+        let image = image_org.into_rgba8();
         let (width, height) = image.dimensions();
-        let Bgra([blue, green, red, alpha]) = image.get_pixel(width - 1, height / 2);
+        let Rgba([blue, green, red, alpha]) = image.get_pixel(width - 1, height / 2);
         assert_eq!(alpha, &0, "the test image was not transparent");
         assert_eq!(red, &0, "the test image is not as expected");
         assert_eq!(green, &0, "the test image is not as expected");

src/common/identify_transparency.rs

@@ -1,14 +1,14 @@
 use crate::common::Margin;
 use crate::{Image, ImageOnHeap, Result};
 use image::flat::View;
-use image::{imageops, Bgra, GenericImageView, ImageBuffer};
+use image::{imageops, GenericImageView, ImageBuffer, Rgba};
 
 ///
 /// specialized version of crop for [`ImageOnHeap`] and [`Margin`]
 ///
 #[cfg_attr(not(macos), allow(dead_code))]
 pub fn crop(image: Image, margin: &Margin) -> Result<ImageOnHeap> {
-    let mut img2: View<_, Bgra<u8>> = image.as_view()?;
+    let mut img2: View<_, Rgba<u8>> = image.as_view()?;
     let (width, height) = (
         img2.width() - (margin.left + margin.right) as u32,
         img2.height() - (margin.top + margin.bottom) as u32,
@@ -31,6 +31,13 @@ pub fn crop(image: Image, margin: &Margin) -> Result<ImageOnHeap> {
     Ok(Box::new(buf.into_flat_samples()))
 }
 
+///
+pub fn convert_bgra_to_rgba(buffer: &mut [u8]) {
+    for chunk in buffer.chunks_exact_mut(4) {
+        chunk.swap(0, 2);
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
@@ -40,7 +47,7 @@ mod tests {
     fn should_crop() -> Result<()> {
         // given
         let image_org = open("tests/frames/frame-macos-right-side-issue.tga")?;
-        let image = image_org.into_bgra8();
+        let image = image_org.into_rgba8();
         let image_raw = ImageOnHeap::new(image.into_flat_samples());
         let (width, height) = (image_raw.layout.width, image_raw.layout.height);
 

src/common/image.rs

@@ -1,5 +1,7 @@
 use crate::common::identify_transparency::identify_transparency;
+use crate::common::image::convert_bgra_to_rgba;
 use crate::{ImageOnHeap, Margin, PlatformApi, Result, WindowId, WindowList};
+
 use anyhow::Context;
 use image::flat::SampleLayout;
 use image::{ColorType, FlatSamples};
@@ -180,8 +182,10 @@ impl PlatformApi for X11Api {
                 window_id
             ))?;
 
-        let raw_data = image.data;
-        let color = ColorType::Bgra8;
+        let mut raw_data = image.data;
+        convert_bgra_to_rgba(&mut raw_data);
+
+        let color = ColorType::Rgba8;
         let channels = 4;
         let mut buffer = FlatSamples {
             samples: raw_data,
@@ -258,23 +262,23 @@ impl PlatformApi for X11Api {
 mod test {
     use super::*;
     use image::flat::View;
-    use image::{save_buffer, Bgra, GenericImageView};
+    use image::{save_buffer, GenericImageView, Rgba};
 
     #[test]
     fn calibrate() -> Result<()> {
         let mut api = X11Api::new()?;
         let win = api.get_active_window()?;
         let image_raw = api.capture_window_screenshot(win)?;
-        let image: View<_, Bgra<u8>> = image_raw.as_view().unwrap();
+        let image: View<_, Rgba<u8>> = image_raw.as_view().unwrap();
         let (width, height) = image.dimensions();
 
         api.calibrate(win)?;
         let image_calibrated_raw = api.capture_window_screenshot(win)?;
-        let image_calibrated: View<_, Bgra<u8>> = image_calibrated_raw.as_view().unwrap();
+        let image_calibrated: View<_, Rgba<u8>> = image_calibrated_raw.as_view().unwrap();
         let (width_new, height_new) = image_calibrated.dimensions();
         dbg!(width, width_new, height, height_new);
 
-        let Bgra([_, _, _, alpha]) = image.get_pixel(width / 2, 0);
+        let Rgba([_, _, _, alpha]) = image.get_pixel(width / 2, 0);
         dbg!(alpha);
         if alpha == 0 {
             // if that pixel was full transparent, for example on ubuntu / GNOME, caused by the drop shadow
@@ -331,10 +335,10 @@ mod test {
         let api = X11Api::new()?;
         let win = api.get_active_window()?;
         let image_raw = api.capture_window_screenshot(win)?;
-        let image: View<_, Bgra<u8>> = image_raw.as_view().unwrap();
+        let image: View<_, Rgba<u8>> = image_raw.as_view().unwrap();
         let (width, height) = image.dimensions();
 
-        let Bgra([blue, green, red, alpha]) = image.get_pixel(width / 2, height / 2);
+        let Rgba([red, green, blue, alpha]) = image.get_pixel(width / 2, height / 2);
         assert_ne!(blue, 0);
         assert_ne!(green, 0);
         assert_ne!(red, 0);

src/linux/x11_api.rs

@@ -64,7 +64,7 @@ impl PlatformApi for QuartzApi {
 mod test {
     use super::*;
     use image::flat::View;
-    use image::{save_buffer, Bgra, GenericImageView};
+    use image::{save_buffer, GenericImageView, Rgba};
 
     ///
     /// for terminals with odd dimensions, like: 93x17
@@ -73,16 +73,16 @@ mod test {
         let mut api = setup()?;
         let win = api.get_active_window()?;
         let image_raw = api.capture_window_screenshot(win)?;
-        let image: View<_, Bgra<u8>> = image_raw.as_view().unwrap();
+        let image: View<_, Rgba<u8>> = image_raw.as_view().unwrap();
         let (width, height) = image.dimensions();
 
         api.calibrate(win)?;
         let image_calibrated_raw = api.capture_window_screenshot(win)?;
-        let image_calibrated: View<_, Bgra<u8>> = image_calibrated_raw.as_view().unwrap();
+        let image_calibrated: View<_, Rgba<u8>> = image_calibrated_raw.as_view().unwrap();
         let (width_new, height_new) = image_calibrated.dimensions();
         dbg!(width, width_new, height, height_new);
 
-        let Bgra([_, _, _, alpha]) = image.get_pixel(width / 2, 0);
+        let Rgba([_, _, _, alpha]) = image.get_pixel(width / 2, 0);
         dbg!(alpha);
         if alpha == 0 {
             // if that pixel was full transparent, for example on ubuntu / GNOME, caused by the drop shadow

src/macos/mod.rs

@@ -1,3 +1,4 @@
+use crate::common::image::convert_bgra_to_rgba;
 use crate::ImageOnHeap;
 
 use anyhow::{ensure, Context, Result};
@@ -7,7 +8,7 @@ use image::flat::SampleLayout;
 use image::{ColorType, FlatSamples};
 
 pub fn capture_window_screenshot(win_id: u64) -> Result<ImageOnHeap> {
-    let (w, h, channels, raw_data) = {
+    let (w, h, channels, mut raw_data) = {
         let image = unsafe {
             CGDisplay::screenshot(
                 CGRectNull,
@@ -43,7 +44,9 @@ pub fn capture_window_screenshot(win_id: u64) -> Result<ImageOnHeap> {
         (w, h, byte_per_pixel, raw_data)
     };
 
-    let color = ColorType::Bgra8;
+    convert_bgra_to_rgba(&mut raw_data);
+
+    let color = ColorType::Rgba8;
     let buffer = FlatSamples {
         samples: raw_data,
         layout: SampleLayout::row_major_packed(channels, w, h),