Merge branch 'main' into vmaf_pts_sync

CHANGELOG.md

@@ -1,3 +1,11 @@
+# Unreleased
+* Improve failing ffmpeg stderr printing: 
+  - Don't allow many '\r'-ending updates to cause all other stored info to be truncated. 
+  - Increase max heap storage of output ~4k->32k to allow more complete output in some cases.
+* Fix caching unaffected by `--reference-vfilter` usage.
+* Improve `--vfilter` docs. Describe VMAF usage & mention `--reference-vfilter`.
+* Improve `--vmaf-scale` docs.
+
 # v0.7.16
 * Fix VMAF score parse failure of certain successful ffmpeg outputs.
 

Dockerfile

@@ -5,7 +5,7 @@ WORKDIR /build
 COPY Cargo.toml Cargo.lock ./
 COPY src ./src
 
-RUN cargo fetch
+RUN rustup default stable
 RUN cargo build --release
 
 FROM debian:bookworm-slim as runtime

README.md

@@ -90,5 +90,12 @@ cargo install --git https://github.com/alexheretic/ab-av1
 
 `ffmpeg` should be in `$PATH`.
 
+## Debug
+Enable debug logs by setting env var `RUST_LOG=ab_av1=debug`. This includes all ffmpeg calls.
+
+```
+$ RUST_LOG=ab_av1=debug ab-av1 auto-encode -i vid.mkv
+```
+
 ## Minimum supported rust compiler
 Maintained with [latest stable rust](https://gist.github.com/alexheretic/d1e98d8433b602e57f5d0a9637927e0c).

src/command/args/encode.rs

@@ -26,10 +26,14 @@ pub struct Encode {
     #[arg(short, long, value_hint = ValueHint::FilePath)]
     pub input: PathBuf,
 
-    /// Ffmpeg video filter applied to the input before av1 encoding.
+    /// Ffmpeg video filter applied to the input before encoding.
     /// E.g. --vfilter "scale=1280:-1,fps=24".
     ///
     /// See https://ffmpeg.org/ffmpeg-filters.html#Video-Filters
+    ///
+    /// For VMAF calculations this is also applied to the reference video meaning VMAF
+    /// scores represent the quality of original+vfilters compared to the encoded result.
+    /// To override this behaviour set --reference-vfilter.
     #[arg(long)]
     pub vfilter: Option<String>,