Add zones support

Currently implemented:
- Overriding the selected encoder & number of passes
- Overriding or adding video params
- Overriding photon noise setting
- Overriding min/max scene length

Closes #267

Author: shssoichiro

Cargo.lock

@@ -48,6 +48,6 @@ overflow-checks = true
 
 [patch.crates-io]
 rav1e = { git = "https://github.com/xiph/rav1e", rev = "de97f3bbcc0336e1e4195ebaeb2c74fda2018dc5" }
-av-scenechange = { git = "https://github.com/rust-av/av-scenechange", rev = "9425e3597b27c79cd970756b7cdb9c24cb2c4d03" }
+av-scenechange = { git = "https://github.com/rust-av/av-scenechange", rev = "0c63f493200eeccc21193d129fc63cb1265e40fa" }
 # TODO: switch to release version once the fix for av_get_best_stream is published on crates.io.
 ffmpeg-next = { git = "https://github.com/zmwangx/rust-ffmpeg", rev = "0054b0e51b35ed240b193c7a93455714b4d75726" }

Cargo.toml

@@ -353,6 +353,47 @@ pub struct CliOpts {
   #[clap(long, default_value = "yuv420p10le", help_heading = "ENCODING")]
   pub pix_format: Pixel,
 
+  /// Path to a file specifying zones within the video with differing encoder settings.
+  ///
+  /// The zones file should include one zone per line, with each arg within a zone space-separated.
+  /// No quotes or escaping are needed around the encoder args, as these are assumed to be the last argument.
+  /// The zone args on each line should be in this order:
+  ///
+  /// start_frame end_frame encoder reset(opt) video_params
+  ///
+  /// For example:
+  ///
+  /// ```ignore
+  /// 136 169 aom --photon-noise 4 --cq-level=32
+  /// 169 1330 rav1e reset -s 3 -q 42
+  /// ```
+  ///
+  /// Example line 1 will encode frames 136-168 using aomenc with the argument `--cq-level=32`
+  /// and enable av1an's `--photon-noise` option.
+  /// Note that the end frame number is *exclusive*. The start and end frame will both be forced
+  /// to be scenecuts. Additional scene detection will still be applied within the zones.
+  /// `-1` can be used to refer to the last frame in the video.
+  ///
+  /// The default behavior as shown on line 1 is to preserve any options passed to
+  /// `--video-params` or `--photon-noise` in av1an, and append or overwrite
+  /// the additional zone settings.
+  ///
+  /// Example line 2 will encode frames 169-1329 using rav1e. The `reset` keyword instructs
+  /// av1an to ignore any settings which affect the encoder, and use only the
+  /// parameters from this zone.
+  ///
+  /// For segments where no zone is specified, the settings passed to av1an itself will be used.
+  ///
+  /// The video params which may be specified include any parameters that are allowed by
+  /// the encoder, as well as the following av1an options:
+  ///
+  /// - `-x`/`--extra-split`
+  /// - `--min-scene-len`
+  /// - `--passes`
+  /// - `--photon-noise` (aomenc only)
+  #[clap(long, parse(from_os_str), help_heading = "ENCODING")]
+  pub zones: Option<PathBuf>,
+
   /// Plot an SVG of the VMAF for the encode
   ///
   /// This option is independent of --target-quality, i.e. it can be used with or without it.
@@ -605,6 +646,7 @@ pub fn parse_cli(args: CliOpts) -> anyhow::Result<Vec<EncodeArgs>> {
       workers: args.workers,
       set_thread_affinity: args.set_thread_affinity,
       vs_script: None,
+      zones: args.zones.clone(),
     };
 
     arg.startup_check()?;

av1an-cli/src/lib.rs

@@ -44,6 +44,7 @@ paste = "1.0.5"
 simdutf8 = "0.1.3"
 parking_lot = "0.12.0"
 cfg-if = "1.0.0"
+nom = "7.1.1"
 # TODO: move all of this CLI stuff to av1an-cli
 ansi_term = "0.12.1"
 

av1an-core/Cargo.toml

@@ -218,11 +218,21 @@ impl<'a> Broker<'a> {
     let padding = printable_base10_digits(self.total_chunks - 1) as usize;
 
     // Run all passes for this chunk
+    let encoder = chunk
+      .overrides
+      .as_ref()
+      .map_or(self.project.encoder, |ovr| ovr.encoder);
+    let passes = chunk
+      .overrides
+      .as_ref()
+      .map_or(self.project.passes, |ovr| ovr.passes);
     let mut tpl_crash_workaround = false;
     for current_pass in 1..=self.project.passes {
       for r#try in 1..=self.max_tries {
         let res = self.project.create_pipes(
           chunk,
+          encoder,
+          passes,
           current_pass,
           worker_id,
           padding,
@@ -246,7 +256,7 @@ impl<'a> Broker<'a> {
           // since `Broker::encoding_loop` will print the error message as well
           warn!("Encoder failed (on chunk {}):\n{}", chunk.index, e);
 
-          if self.project.encoder == Encoder::aom
+          if encoder == Encoder::aom
             && !tpl_crash_workaround
             && memmem::rfind(e.stderr.as_bytes(), b"av1_tpl_stats_ready").is_some()
           {

av1an-core/src/broker.rs

@@ -1,3 +1,4 @@
+use crate::scenes::ZoneOptions;
 use serde::{Deserialize, Serialize};
 use std::{ffi::OsString, path::Path};
 
@@ -8,31 +9,14 @@ pub struct Chunk {
   pub source: Vec<OsString>,
   pub output_ext: String,
   pub frames: usize,
+  pub overrides: Option<ZoneOptions>,
   // do not break compatibility with output produced by older versions of av1an
   /// Optional target quality CQ level
   #[serde(rename = "per_shot_target_quality_cq")]
   pub tq_cq: Option<u32>,
 }
 
 impl Chunk {
-  pub fn new(
-    temp: String,
-    index: usize,
-    source: Vec<OsString>,
-    output_ext: &'static str,
-    frames: usize,
-    per_shot_target_quality_cq: Option<u32>,
-  ) -> Result<Self, anyhow::Error> {
-    Ok(Self {
-      temp,
-      index,
-      source,
-      output_ext: output_ext.to_owned(),
-      frames,
-      tq_cq: per_shot_target_quality_cq,
-    })
-  }
-
   /// Returns numeric name of chunk `00001`
   pub fn name(&self) -> String {
     format!("{:05}", self.index)
@@ -62,6 +46,7 @@ mod tests {
       output_ext: "ivf".to_owned(),
       frames: 5,
       tq_cq: None,
+      overrides: None,
     };
     assert_eq!("00001", ch.name());
   }
@@ -74,6 +59,7 @@ mod tests {
       output_ext: "ivf".to_owned(),
       frames: 5,
       tq_cq: None,
+      overrides: None,
     };
     assert_eq!("10000", ch.name());
   }
@@ -87,6 +73,7 @@ mod tests {
       output_ext: "ivf".to_owned(),
       frames: 5,
       tq_cq: None,
+      overrides: None,
     };
     assert_eq!("d/encode/00001.ivf", ch.output());
   }

av1an-core/src/chunk.rs

@@ -435,6 +435,15 @@ impl Encoder {
     }
   }
 
+  pub const fn format(self) -> &'static str {
+    match self {
+      Self::aom | Self::rav1e | Self::svt_av1 => "av1",
+      Self::vpx => "vpx",
+      Self::x264 => "h264",
+      Self::x265 => "h265",
+    }
+  }
+
   /// Get the default output extension for the encoder
   pub const fn output_extension(&self) -> &'static str {
     match &self {

av1an-core/src/encoder.rs

@@ -57,6 +57,7 @@ mod grain;
 pub(crate) mod parse;
 pub mod progress_bar;
 pub mod scene_detect;
+mod scenes;
 pub mod settings;
 pub mod split;
 pub mod target_quality;