Skip to content

Commit

Permalink
Clarify --vfilter doc further (#223)
Browse files Browse the repository at this point in the history
* Clarify --vfilter doc further

* clarify
  • Loading branch information
alexheretic authored Sep 16, 2024
1 parent b852719 commit 859999b
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 29 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Unreleased (v0.7.18)
* Improve `--vfilter` docs, clarify VMAF usage.

# v0.7.17
* Improve failing ffmpeg stderr printing:
- Don't allow many '\r'-ending updates to cause all other stored info to be truncated.
Expand Down
54 changes: 27 additions & 27 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 9 additions & 2 deletions src/command/args/encode.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,15 @@ pub struct Encode {
/// 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.
/// scores represent the quality of input stream *after* applying filters compared
/// to the encoded result.
/// This allows filters like cropping to work with VMAF, as it would be the
/// cropped stream that is VMAF compared to a cropped-then-encoded stream. Such filters
/// would not otherwise generally be comparable.
///
/// A consequence is the VMAF score will not reflect any quality lost
/// by the vfilter itself, only the encode.
/// To override the VMAF vfilter set --reference-vfilter.
#[arg(long)]
pub vfilter: Option<String>,

Expand Down

0 comments on commit 859999b

Please sign in to comment.