Add --keep flag to crf-search subcommand (#166)

* Add `--keep` flag to `crf-search` subcommand

* Refactor `--keep` into Args::Sample

* Revert keep_temp_files back to default match arm; add documentation of cleaning process

* Add changelog entries

* Update CHANGELOG.md

---------

Co-authored-by: Alex Butler <alexheretic@gmail.com>

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Unreleased
 * Use a single ffmpeg process to calculate VMAF replacing multi process piping.
 * Exclude subtitle tracks from samples.
+* Add `--keep` option for _crf-search_ & _auto-encode_.
 
 # v0.7.12
 * Improve eta stability.

src/command/args.rs

@@ -63,6 +63,10 @@ pub struct Sample {
     #[arg(long)]
     pub min_samples: Option<u64>,
 
+    /// Keep temporary files after exiting.
+    #[arg(long)]
+    pub keep: bool,
+
     /// Directory to store temporary sample data in.
     /// Defaults to using the input's directory.
     #[arg(long, env = "AB_AV1_TEMP_DIR")]

src/command/crf_search.rs

@@ -146,7 +146,6 @@ pub async fn run(
         args: args.clone(),
         crf: 0.0,
         sample: sample.clone(),
-        keep: false,
         cache: *cache,
         stdout_format: sample_encode::StdoutFormat::Json,
         vmaf: vmaf.clone(),

src/command/sample_encode.rs

@@ -46,10 +46,6 @@ pub struct Args {
     #[clap(flatten)]
     pub sample: args::Sample,
 
-    /// Keep temporary files after exiting.
-    #[arg(long)]
-    pub keep: bool,
-
     /// Enable sample-encode caching.
     #[arg(
         long,
@@ -87,7 +83,6 @@ pub async fn run(
         args,
         crf,
         sample: sample_args,
-        keep,
         cache,
         stdout_format,
         vmaf,
@@ -103,6 +98,7 @@ pub async fn run(
     let duration = input_probe.duration.clone()?;
     let input_fps = input_probe.fps.clone()?;
     let samples = sample_args.sample_count(duration).max(1);
+    let keep = sample_args.keep;
     let temp_dir = sample_args.temp_dir;
 
     let (samples, sample_duration, full_pass) = {

src/main.rs

@@ -50,15 +50,24 @@ async fn main() -> anyhow::Result<()> {
         _ = signal::ctrl_c() => Err(anyhow!("ctrl_c")),
     };
 
+    // Final cleanup. Samples are already deleted (if wished by the user) during `command::sample_encode::run`.
     temporary::clean(keep).await;
 
     out
 }
 
 impl Command {
+    /// This decides what commands will keep temp files.
+    ///
+    /// # Important
+    ///
+    /// Add commands using the sample sub-args here referencing the `keep` flag,
+    /// or the temp files will be removed anyways.
     fn keep_temp_files(&self) -> bool {
         match self {
-            Self::SampleEncode(args) => args.keep,
+            Self::SampleEncode(args) => args.sample.keep,
+            Self::CrfSearch(args) => args.sample.keep,
+            Self::AutoEncode(args) => args.search.sample.keep,
             _ => false,
         }
     }