fix(#109): on ubuntu 20.04 for arm the recording is upside down (#113)

- fixes #109
- the issue is apparently a tga / imagemagick specific one
- now a switch to bmp as intermediate format seems reasonable

Author: sassman

Cargo.toml

@@ -33,7 +33,7 @@ features = ["cargo"]
 
 [dependencies.image]
 version = "0.24.0"
-features = ["tga"]
+features = ["bmp"]
 
 [target.'cfg(target_os = "macos")'.dependencies]
 objc_id = "0.1.1"

src/capture.rs

@@ -8,7 +8,7 @@ use std::sync::{Arc, Mutex};
 use std::time::{Duration, Instant};
 use tempfile::TempDir;
 
-use crate::utils::file_name_for;
+use crate::utils::{file_name_for, IMG_EXT};
 use crate::{ImageOnHeap, PlatformApi, WindowId};
 
 /// captures screenshots as file on disk
@@ -77,7 +77,7 @@ pub fn save_frame(
     file_name_for: fn(&u128, &str) -> String,
 ) -> Result<()> {
     save_buffer(
-        tempdir.path().join(file_name_for(&time_code, "tga")),
+        tempdir.path().join(file_name_for(&time_code, IMG_EXT)),
         &image.samples,
         image.layout.width,
         image.layout.height,

src/decor_effect.rs

@@ -5,6 +5,7 @@ use anyhow::Context;
 use rayon::prelude::*;
 use tempfile::TempDir;
 
+use crate::utils::IMG_EXT;
 use crate::Result;
 
 ///
@@ -100,7 +101,9 @@ fn apply_effect(
     effect: Box<dyn Fn(PathBuf) -> Result<()> + Send + Sync>,
 ) {
     time_codes.into_par_iter().for_each(|tc| {
-        let file = tempdir.path().join(crate::utils::file_name_for(tc, "tga"));
+        let file = tempdir
+            .path()
+            .join(crate::utils::file_name_for(tc, IMG_EXT));
         if let Err(e) = effect(file) {
             eprintln!("{}", e);
         }

src/generators/gif.rs

@@ -1,4 +1,4 @@
-use crate::utils::file_name_for;
+use crate::utils::{file_name_for, IMG_EXT};
 
 use anyhow::{Context, Result};
 use std::ops::Div;
@@ -20,10 +20,7 @@ pub fn check_for_imagemagick() -> Result<Output> {
         .arg("--version")
         .output()
         .with_context(|| {
-            format!(
-                "There is an issue with '{}', please install: `{}`",
-                PROGRAM, INST_CMD,
-            )
+            format!("There is an issue with '{PROGRAM}', please install: `{INST_CMD}`")
         })
 }
 
@@ -36,14 +33,18 @@ pub fn generate_gif_with_convert(
     start_pause: Option<Duration>,
     end_pause: Option<Duration>,
 ) -> Result<()> {
-    println!("🎉 🚀 Generating {}", target);
+    println!("🎉 🚀 Generating {target}");
     let mut cmd = Command::new(PROGRAM);
     cmd.arg("-loop").arg("0");
     let mut delay = 0;
+    let temp = tempdir.path();
     let last_frame_i = time_codes.len() - 1;
     for (i, tc) in time_codes.iter().enumerate() {
         delay = *tc - delay;
-        let frame = tempdir.path().join(file_name_for(tc, "tga"));
+        let frame = temp.join(file_name_for(tc, IMG_EXT));
+        if !frame.exists() {
+            continue;
+        }
         let mut frame_delay = (delay as f64 * 0.1) as u64;
         match (i, start_pause, end_pause) {
             (0, Some(delay), _) => {

src/generators/mp4.rs

@@ -3,22 +3,26 @@ use std::process::Command;
 use anyhow::{Context, Result};
 use tempfile::TempDir;
 
+use crate::utils::IMG_EXT;
+
 const PROGRAM: &str = "ffmpeg";
 
+#[cfg(target_os = "macos")]
+const INST_CMD: &str = "brew install ffmpeg";
+#[cfg(not(target_os = "macos"))]
+const INST_CMD: &str = "apt-get install ffmpeg";
+
 /// checks if ffmpeg is available
 pub fn check_for_ffmpeg() -> Result<()> {
     let out = Command::new(PROGRAM)
         .arg("-version")
         .output()
         .with_context(|| {
-            format!(
-                "There is an issue with '{}', please install: `brew install {}`",
-                PROGRAM, PROGRAM
-            )
+            format!("There is an issue with '{PROGRAM}', please install: `{INST_CMD}`")
         })?;
 
     if !String::from_utf8(out.stdout.to_vec())
-        .with_context(|| format!("Unable to parse the `{} -version`", PROGRAM))
+        .with_context(|| format!("Unable to parse the `{PROGRAM} -version`"))
         .unwrap()
         .contains("--enable-libx264")
     {
@@ -37,7 +41,7 @@ pub fn generate_mp4_with_ffmpeg(
     tempdir: &TempDir,
     target: &str,
 ) -> Result<()> {
-    println!("🎉 🎬 Generating {}", &target);
+    println!("🎉 🎬 Generating {target}");
     Command::new(PROGRAM)
         .arg("-y")
         .arg("-r")
@@ -48,7 +52,7 @@ pub fn generate_mp4_with_ffmpeg(
         .arg("-pattern_type")
         .arg("glob")
         .arg("-i")
-        .arg(tempdir.path().join("*.tga"))
+        .arg(tempdir.path().join(format!("*.{IMG_EXT}")))
         .arg("-vcodec")
         .arg("libx264")
         .arg("-pix_fmt")
@@ -59,6 +63,6 @@ pub fn generate_mp4_with_ffmpeg(
         // end of fix
         .arg(target)
         .output()
-        .with_context(|| format!("Cannot start '{}' to generate the final video", PROGRAM))
+        .with_context(|| format!("Cannot start '{PROGRAM}' to generate the final video"))
         .map(|_| ())
 }

src/linux/x11_api.rs

@@ -261,6 +261,7 @@ impl PlatformApi for X11Api {
 #[cfg(test)]
 mod test {
     use super::*;
+    use crate::utils::IMG_EXT;
     use image::flat::View;
     use image::{save_buffer, GenericImageView, Rgba};
 
@@ -345,7 +346,7 @@ mod test {
         assert_ne!(alpha, 0, "alpha is unexpected");
 
         // Note: visual validation is sometimes helpful:
-        let file = format!("frame-{}.tga", win);
+        let file = format!("frame-{win}.{IMG_EXT}");
         save_buffer(
             file,
             &image_raw.samples,

src/macos/mod.rs

@@ -2,11 +2,11 @@ mod core_foundation_sys_patches;
 mod screenshot;
 mod window_id;
 
+use crate::common::identify_transparency::identify_transparency;
+use crate::common::image::crop;
 use crate::PlatformApi;
 use crate::{ImageOnHeap, Margin, Result, WindowList};
 
-use crate::common::identify_transparency::identify_transparency;
-use crate::common::image::crop;
 use anyhow::Context;
 use screenshot::capture_window_screenshot;
 use std::env;
@@ -63,6 +63,7 @@ impl PlatformApi for QuartzApi {
 #[cfg(test)]
 mod test {
     use super::*;
+    use crate::utils::IMG_EXT;
     use image::flat::View;
     use image::{save_buffer, GenericImageView, Rgba};
 
@@ -99,7 +100,7 @@ mod test {
 
         // Note: visual validation is sometimes helpful:
         save_buffer(
-            format!("frame-raw-{}.tga", win),
+            format!("frame-raw-{win}.{IMG_EXT}"),
             &image_raw.samples,
             image_raw.layout.width,
             image_raw.layout.height,

src/macos/screenshot.rs

@@ -74,6 +74,7 @@ mod tests {
     #[cfg(feature = "e2e_tests")]
     fn should_capture_with_cropped_transparent_area() -> Result<()> {
         use crate::common::PlatformApi;
+        use crate::utils::IMG_EXT;
 
         let mut api = setup()?;
         let win = 5308;
@@ -83,7 +84,7 @@ mod tests {
 
         // Note: visual validation is sometimes helpful:
         save_buffer(
-            format!("frame-org-{}.tga", win),
+            format!("frame-org-{win}.{IMG_EXT}"),
             &image.samples,
             image.layout.width,
             image.layout.height,
@@ -97,7 +98,7 @@ mod tests {
         assert!(width > image_cropped.layout.width);
         // Note: visual validation is sometimes helpful:
         save_buffer(
-            format!("frame-cropped-{}.tga", win),
+            format!("frame-cropped-{win}.{IMG_EXT}"),
             &image_cropped.samples,
             image_cropped.layout.width,
             image_cropped.layout.height,

src/utils.rs

@@ -4,6 +4,7 @@ use std::process::{Command, ExitStatus};
 
 pub const DEFAULT_EXT: &str = "gif";
 pub const MOVIE_EXT: &str = "mp4";
+pub const IMG_EXT: &str = "bmp";
 
 /// encapsulate the file naming convention
 pub fn file_name_for(tc: &u128, ext: &str) -> String {