Skip to content

Commit

Permalink
fix_telecined_fades: clarify & expand docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
astiob committed Feb 7, 2024
1 parent 3e9f4c7 commit 645b9e9
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions vsdeinterlace/combing.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,12 @@ def fix_telecined_fades(
planes: PlanesT = None, func: FuncExceptT | None = None
) -> vs.VideoNode:
"""
Give a mathematically perfect solution to fades made *after* telecining (which made perfect IVTC impossible).
Give a mathematically perfect solution to decombing fades made *after* telecining (which made perfect IVTC impossible)
that start or end in a solid color.
Steps between the frames are not adjusted, so they will remain uneven depending on the telecining pattern,
but the decombing is blur-free, ensuring minimum information loss. However, this may cause small amounts
of combing to remain due to error amplification, especially near the solid-color end of the fade.
This is an improved version of the Fix-Telecined-Fades plugin.
Expand All @@ -33,9 +38,10 @@ def fix_telecined_fades(
:param clip: Clip to process.
:param tff: This parameter is deprecated and unused. It will be removed in
the future, so prefer keyword arguments and avoid passing `tff`.
:param colors: Color offset for the plane average.
:param colors: Fade source/target color (floating-point plane averages).
:return: Clip with fades (and only fades) accurately deinterlaced.
:return: Clip with fades to/from `colors` accurately deinterlaced.
Frames that don't contain such fades may be damaged.
"""
func = func or fix_telecined_fades

Expand Down

0 comments on commit 645b9e9

Please sign in to comment.