IVTC DN is a GUI tool to manually perform Inverse Telecine (IVTC) of Vapoursynth scripts. It uses Walnut, which uses Dear ImGui, to render the UI.
The intended outcome is similar to that of other manual IVTC tools such as Wobbly and Yatta, but the approach taken by IVTC DN is different.
What IVTC DN does:
- Does clearly display every input field to the user
- Does allow the user to make field matching and decimation decisions at the same time
- Does limit required prerequisite plugins
- Does output a single project file; can be used for one-line IVTC in scripts
- Does (optionally) provide some feedback on combed matches (requires dmetrics)
What IVTC DN doesn't do:
- Doesn't support anything other than constant 10 input field -> 4 output frame cycles (not a priority)
- Doesn't handle all errors gracefully (medium priority)
- Doesn't provide any automated pattern guessing (low priority)
While moused over an input field these keys will operate on that field:
A, B, C, DChanges the "note" of the field to the respective letter.1, 2, 3, 4Changes the "action" of the field to indicate that it should used for the respective output frame (note: the output frames are internally numbered [0, 3] but the0key is far away on a qwerty keyboard).SMarks that this field starts a new scene.
While moused over an output frame these keys will operate on that frame:
FToggles which frame (Previous/Next) should be frozen if no input fields are used for the output frame.
Keys that apply generally:
RReload the output frames to reflect any changes. (This is not generally necessary unless you turn off auto-reloading)TApply the actions and notes of the fields in the current cycle to all other cycles in the same scene (note: this is not extensively tested and may have unhandled edge cases).Ctrl+SSave the current project file.Ctrl+OOpen an existing project file.Ctrl+NStart a new project.
Users are expected to have a working Vapoursynth installation (portable is fine). See the Vapoursynth Docs for details on what it is and how to install it.
Additionally the IVTC DN plugin is required and must be placed somewhere that Vapoursynth will autoload. Similarly for combing detection the dmetrics plugin is required.
IVTC DN projects are based on input Vapoursynth scripts, so you must have such a script to use the tool. The script must output a YUV or RGB clip with the _FieldBased property set to 1 (bottom field first) or 2 (top field first). The property may be set the source filter (e.g. d2v.Source()) or it can be set manually (e.g. std.SetFieldBased(vs.FIELD_TOP)). Example input script:
import vapoursynth as vs
clip = vs.core.lsmas.LWLibavSource("example.mkv") # Load telecined source video
clip = clip.std.SetFieldBased(vs.FIELD_TOP) # Manually set TFF
clip.set_output() # Output is field-based telecined contentThe first time you open IVTC DN you should be greeted with several panels. You can re-arrange and resize these as you see fit, drag them out of the window, or dock them onto various points of the window. Their position will be remembered for subsequent use by the imgui.ini file which should be created alongside the ITVC DN binary.
Once you have the panels arranged to your liking you can load the input script. To do so you can simply drag and drop your .vpy file onto the IVTC DN window, or you can select File > New project... and navigate to the input script.
Once you can see input fields and output frames you can choose which fields should be used for each output frame by adjusting the actions of each input field. See the Keybindings section for more details.
The A|B|C|D notes displayed on fields are purely informational, and are simply intended to help a user keep track of the cycle. The idea is that it is easier for a user to select the "best" version of a "duplicate" field if the fields are annotated.
If you select only a single field for an output frame that field will be line-doubled naively. You can override the line-doubling behavior when you use the project file in an output script, but within the GUI the behavior will always be naive.
If you deselect all fields for an output frame it will be replaced with the previous available output frame by default. You can toggle this behavior to use the next available output frame by pressing F on the output frame.
Once you are happy with your result (or if you just want to save progress) you can save the project file by pressing Ctrl+S or selecting File > Save project. If it's the first time you saved you will be prompted to select a destintation for the project file (which uses .ivtc as the extension).
Using the project file in an output script is straightforward. The IVTC DN plugin README has more details, but as a simple example:
import vapoursynth as vs
clip = vs.core.lsmas.LWLibavSource("example.mkv") # Load telecined source video
clip = clip.std.SetFieldBased(vs.FIELD_TOP) # Manually set TFF
clip = clip.std.SeparateFields() # IVTC DN requires separated fields as input
clip = clip.ivtcdn.IVTC("example.ivtc") # Use the IVTC DN project file
clip.set_output() # Output is progressive and IVTC'd contentI haven't spent much time testing builds on different systems, so this section is sparse. Broadly most dependencies should be bundled, so hopefully if you are familiar with C++ builds you can build it.
premake5 vs2022 should generate a visual studio 2022 project file for windows builds.
premake5 gmake2 should generate a gnu makefile for linux builds.
Windows & Linux builds should be auto-generated by github actions, see https://github.com/Mikewando/IVTC-DN/actions.