Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify --vfilter doc further #223

Merged
merged 2 commits into from
Sep 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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