Add --xpsnr-fps arg (#262)

Default xpsnr-fps 60, see #258 (comment)

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Unreleased (v0.9.1)
 * Fix xpsnr inf score parsing.
+* Add `--xpsnr-fps`: Frame rate override used to analyse both reference & distorted videos. Default 60.
 
 # v0.9.0
 * Add XPSNR support as a VMAF alternative.

src/command/args.rs

@@ -114,3 +114,26 @@ pub struct ScoreArgs {
     #[arg(long)]
     pub reference_vfilter: Option<Arc<str>>,
 }
+
+/// Common xpsnr options.
+#[derive(Debug, Parser, Clone, Copy)]
+pub struct Xpsnr {
+    /// Frame rate override used to analyse both reference & distorted videos.
+    /// Maps to ffmpeg `-r` input arg.
+    ///
+    /// Setting to 0 disables use.
+    #[arg(long, default_value_t = 60.0)]
+    pub xpsnr_fps: f32,
+}
+
+impl Xpsnr {
+    pub fn fps(&self) -> Option<f32> {
+        Some(self.xpsnr_fps).filter(|r| *r > 0.0)
+    }
+}
+
+impl std::hash::Hash for Xpsnr {
+    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
+        self.xpsnr_fps.to_ne_bytes().hash(state);
+    }
+}

src/command/crf_search.rs

@@ -104,6 +104,9 @@ pub struct Args {
     #[clap(flatten)]
     pub score: args::ScoreArgs,
 
+    #[clap(flatten)]
+    pub xpsnr: args::Xpsnr,
+
     #[command(flatten)]
     pub verbose: clap_verbosity_flag::Verbosity,
 }
@@ -212,6 +215,7 @@ pub fn run(
         cache,
         vmaf,
         score,
+        xpsnr,
         verbose: _,
     }: Args,
     input_probe: Arc<Ffprobe>,
@@ -252,6 +256,7 @@ pub fn run(
             vmaf: vmaf.clone(),
             score: score.clone(),
             xpsnr: min_xpsnr.is_some(),
+            xpsnr_opts: xpsnr,
         };
 
         let mut crf_attempts = Vec::new();

src/command/sample_encode.rs

@@ -72,6 +72,9 @@ pub struct Args {
     #[clap(flatten)]
     pub score: args::ScoreArgs,
 
+    #[clap(flatten)]
+    pub xpsnr_opts: args::Xpsnr,
+
     /// Calculate a XPSNR score instead of VMAF.
     #[arg(long)]
     pub xpsnr: bool,
@@ -147,6 +150,7 @@ pub fn run(
         vmaf,
         score,
         xpsnr,
+        xpsnr_opts,
     }: Args,
     input_probe: Arc<Ffprobe>,
 ) -> impl Stream<Item = anyhow::Result<Update>> {
@@ -162,7 +166,7 @@ pub fn run(
         let keep = sample_args.keep;
         let temp_dir = sample_args.temp_dir;
         let scoring = match xpsnr {
-            true => ScoringInfo::Xpsnr(&score),
+            true => ScoringInfo::Xpsnr(&xpsnr_opts, &score),
             _ => ScoringInfo::Vmaf(&vmaf, &score),
         };
 
@@ -358,7 +362,7 @@ pub fn run(
                             let lavfi = super::xpsnr::lavfi(
                                 score.reference_vfilter.as_deref().or(args.vfilter.as_deref())
                             );
-                            let xpsnr_out = xpsnr::run(&sample, &encoded_sample, &lavfi)?;
+                            let xpsnr_out = xpsnr::run(&sample, &encoded_sample, &lavfi, xpsnr_opts.fps())?;
                             let mut xpsnr_out = pin!(xpsnr_out);
                             let mut logger = ProgressLogger::new("ab_av1::xpsnr", Instant::now());
                             let mut score = None;

src/command/sample_encode/cache.rs

@@ -1,6 +1,6 @@
 //! _sample-encode_ file system caching logic.
 use crate::{
-    command::args::{ScoreArgs, Vmaf},
+    command::args::{ScoreArgs, Vmaf, Xpsnr},
     ffmpeg::FfmpegEncodeArgs,
 };
 use anyhow::Context;
@@ -71,7 +71,7 @@ pub async fn cached_encode(
 #[derive(Debug, Hash, Clone, Copy)]
 pub enum ScoringInfo<'a> {
     Vmaf(&'a Vmaf, &'a ScoreArgs),
-    Xpsnr(&'a ScoreArgs),
+    Xpsnr(&'a Xpsnr, &'a ScoreArgs),
 }
 
 pub async fn cache_result(key: Key, result: &super::EncodeResult) -> anyhow::Result<()> {

src/command/xpsnr.rs

@@ -33,13 +33,17 @@ pub struct Args {
 
     #[clap(flatten)]
     pub score: args::ScoreArgs,
+
+    #[clap(flatten)]
+    pub xpsnr: args::Xpsnr,
 }
 
 pub async fn xpsnr(
     Args {
         reference,
         distorted,
         score,
+        xpsnr,
     }: Args,
 ) -> anyhow::Result<()> {
     let bar = ProgressBar::new(1).with_style(
@@ -65,6 +69,7 @@ pub async fn xpsnr(
         &reference,
         &distorted,
         &lavfi(score.reference_vfilter.as_deref()),
+        xpsnr.fps(),
     )?);
     let mut logger = ProgressLogger::new(module_path!(), Instant::now());
     let mut score = None;

src/xpsnr.rs

@@ -12,6 +12,7 @@ pub fn run(
     reference: &Path,
     distorted: &Path,
     filter_complex: &str,
+    fps: Option<f32>,
 ) -> anyhow::Result<impl Stream<Item = XpsnrOut>> {
     info!(
         "xpsnr {} vs reference {}",
@@ -20,7 +21,9 @@ pub fn run(
     );
 
     let mut cmd = Command::new("ffmpeg");
-    cmd.arg2("-i", reference)
+    cmd.arg2_opt("-r", fps)
+        .arg2("-i", reference)
+        .arg2_opt("-r", fps)
         .arg2("-i", distorted)
         .arg2("-filter_complex", filter_complex)
         .arg2("-f", "null")