Merge branches 'bugfixes' and 'vapoursynth' into feature

Author: arch1t3cht

.github/workflows/ci.yml

@@ -136,6 +136,7 @@ jobs:
         with:
           name: ${{ matrix.config.name }} - installer
           path: build/Aegisub-*.exe
+          if-no-files-found: error
 
       - name: Upload artifacts - portable.zip
         uses: actions/upload-artifact@v3
@@ -157,3 +158,4 @@ jobs:
         with:
           name: ${{ matrix.config.name }} - installer
           path: build/Aegisub-*.dmg
+          if-no-files-found: error

automation/vapoursynth/aegisub_vs.py

@@ -1,14 +1,14 @@
 """
-Utility functions for loading video files into Aegisub using the Vapoursynth
+Utility functions for loading video files into Aegisub using the VapourSynth
 video provider.
 
 When encountering a file whose file extension is not .py or .vpy, the
-Vapoursynth audio and video providers will execute the respective default
+VapourSynth audio and video providers will execute the respective default
 script set in Aegisub's configuration, with the following string variables set:
 - filename: The path to the file that's being opened.
 - __aegi_data, __aegi_dictionary, __aegi_local, __aegi_script, __aegi_temp, __aegi_user:
   The values of ?data, ?dictionary, etc. respectively.
-- __aegi_vscache: The path to a directory where the Vapoursynth script can
+- __aegi_vscache: The path to a directory where the VapourSynth script can
   store cache files. This directory is cleaned by Aegisub when it gets too
   large (as defined by Aegisub's configuration).
 
@@ -34,6 +34,43 @@
 import vapoursynth as vs
 core = vs.core
 
+aegi_vscache: str = ""
+aegi_vsplugins: str = ""
+
+plugin_extension = ".dll" if os.name == "nt" else ".so"
+
+def set_paths(vars: dict):
+    """
+    Initialize the wrapper library with the given configuration directories.
+    Should usually be called at the start of the default script as
+        set_paths(globals())
+    """
+    global aegi_vscache
+    global aegi_vsplugins
+    aegi_vscache = vars["__aegi_vscache"]
+    aegi_vsplugins = vars["__aegi_vsplugins"]
+
+
+def ensure_plugin(name: str, loadname: str, errormsg: str):
+    """
+    Ensures that the VapourSynth plugin with the given name exists.
+    If it doesn't, it tries to load it from `loadname`.
+    If that fails, it raises an error with the given error message.
+    """
+    if hasattr(core, name):
+        return
+
+    if aegi_vsplugins and loadname:
+        try:
+            core.std.LoadPlugin(os.path.join(aegi_vsplugins, loadname + plugin_extension))
+            if hasattr(core, name):
+                return
+        except vs.Error:
+            pass
+
+    raise vs.Error(errormsg)
+
+
 def make_lwi_cache_filename(filename: str) -> str:
     """
     Given a path to a video, will return a file name like the one LWLibavSource
@@ -103,21 +140,23 @@ def info_from_lwindex(indexfile: str) -> Dict[str, List[int]]:
     }
 
 
-def wrap_lwlibavsource(filename: str, cachedir: str, **kwargs: Any) -> Tuple[vs.VideoNode, Dict[str, List[int]]]:
+def wrap_lwlibavsource(filename: str, cachedir: str | None = None, **kwargs: Any) -> Tuple[vs.VideoNode, Dict[str, List[int]]]:
     """
     Given a path to a video file and a directory to store index files in
     (usually __aegi_vscache), will open the video with LWLibavSource and read
     the generated .lwi file to obtain the timecodes and keyframes.
     Additional keyword arguments are passed on to LWLibavSource.
     """
+    if cachedir is None:
+        cachedir = aegi_vscache
+
     try:
         os.mkdir(cachedir)
     except FileExistsError:
         pass
     cachefile = os.path.join(cachedir, make_lwi_cache_filename(filename))
 
-    if not hasattr(core, "lsmas"):
-        raise vs.Error("To use Aegisub's LWLibavSource wrapper, the `lsmas` plugin for VapourSynth must be installed")
+    ensure_plugin("lsmas", "libvslsmashsource", "To use Aegisub's LWLibavSource wrapper, the `lsmas` plugin for VapourSynth must be installed")
 
     if b"-Dcachedir" not in core.lsmas.Version()["config"]: # type: ignore
         raise vs.Error("To use Aegisub's LWLibavSource wrapper, the `lsmas` plugin must support the `cachedir` option for LWLibavSource.")
@@ -128,7 +167,7 @@ def wrap_lwlibavsource(filename: str, cachedir: str, **kwargs: Any) -> Tuple[vs.
 
 
 def make_keyframes(clip: vs.VideoNode, use_scxvid: bool = False,
-                   resize_h: int = 360, resize_format: int = vs.YUV420P8,
+                   resize_h: int = 360, resize_format: int = vs.GRAY8,
                    **kwargs: Any) -> List[int]:
     """
     Generates a list of keyframes from a clip, using either WWXD or Scxvid.
@@ -142,12 +181,14 @@ def make_keyframes(clip: vs.VideoNode, use_scxvid: bool = False,
     The remaining keyword arguments are passed on to the respective filter.
     """
 
-    clip = core.resize.Bilinear(clip, width=resize_h * clip.width // clip.height, height=resize_h, format=resize_format);
-    try:
-        clip = core.scxvid.Scxvid(clip, **kwargs) if use_scxvid else core.wwxd.WWXD(clip, **kwargs)
-    except AttributeError:
-        raise vs.Error("To use the keyframe generation, the `{}` plugin for VapourSynth must be installed"
-                       .format("scxvid" if use_scxvid else "wwxd"))
+    clip = core.resize.Bilinear(clip, width=resize_h * clip.width // clip.height, height=resize_h, format=resize_format)
+
+    if use_scxvid:
+        ensure_plugin("scxvid", "libscxvid", "To use the keyframe generation, the scxvid plugin for VapourSynth must be installed")
+        clip = core.scxvid.Scxvid(clip, **kwargs)
+    else:
+        ensure_plugin("wwxd", "libwwxd64", "To use the keyframe generation, the wwxdplugin for VapourSynth must be installed")
+        clip = core.wwxd.WWXD(clip, **kwargs)
 
     keyframes = {}
     done = 0
@@ -175,6 +216,16 @@ def save_keyframes(filename: str, keyframes: List[int]):
         f.write("".join(f"{n}\n" for n in keyframes))
 
 
+def try_get_keyframes(filename: str, default: str | List[int]) -> str | List[int]:
+    """
+    Checks if a keyframes file for the given filename is present and, if so,
+    returns it. Otherwise, returns the given list of keyframes.
+    """
+    kffilename = make_keyframes_filename(filename)
+
+    return kffilename if os.path.exists(kffilename) else default
+
+
 def get_keyframes(filename: str, clip: vs.VideoNode, **kwargs: Any) -> str:
     """
     When not already present, creates a keyframe file for the given clip next
@@ -199,6 +250,7 @@ def check_audio(filename: str, **kwargs: Any) -> bool:
     Additional keyword arguments are passed on to BestAudioSource.
     """
     try:
+        ensure_plugin("bas", "BestAudioSource", "")
         vs.core.bas.Source(source=filename, **kwargs)
         return True
     except AttributeError:

packages/win_installer/fragment_codecs.iss

@@ -5,3 +5,8 @@ DestDir: {app}; Source: {#DEPS_DIR}\AvisynthPlus64\x64\AviSynth.dll; Flags: igno
 DestDir: {app}; Source: {#DEPS_DIR}\AvisynthPlus64\x64\plugins\DirectShowSource.dll; Flags: ignoreversion; Components: main
 ; VSFilter
 DestDir: {app}\csri; Source: {#DEPS_DIR}\VSFilter\x64\VSFilter.dll; Flags: ignoreversion; Components: main
+; VapourSynth
+DestDir: {app}\vapoursynth; Source: {#DEPS_DIR}\L-SMASH-Works\libvslsmashsource.dll; Flags: ignoreversion; Components: vapoursynth
+DestDir: {app}\vapoursynth; Source: {#DEPS_DIR}\bestaudiosource\win64\BestAudioSource.dll; Flags: ignoreversion; Components: vapoursynth
+DestDir: {app}\vapoursynth; Source: {#DEPS_DIR}\SCXVid\libscxvid.dll; Flags: ignoreversion; Components: vapoursynth
+DestDir: {app}\vapoursynth; Source: {#DEPS_DIR}\WWXD\libwwxd64.dll; Flags: ignoreversion; Components: vapoursynth

packages/win_installer/fragment_mainprogram.iss

@@ -1,5 +1,6 @@
 [Components]
 Name: "main"; Description: "Main Files"; Types: full compact custom; Flags: fixed
+Name: "vapoursynth"; Description: "Bundled VapourSynth Plugins"; Types: full
 Name: "macros"; Description: "Automation Scripts"; Types: full
 Name: "macros\bundled"; Description: "Bundled macros"; Types: full
 Name: "macros\demos"; Description: "Example macros/Demos"; Types: full

packages/win_installer/fragment_spelling.iss

@@ -1,5 +1,5 @@
 ; This file declares all installables related to spell checking and thesaurii in Aegisub
 
 [Files]
-Source: {#DEPS_DIR}\dictionaries\en_US.aff; DestDir: {app}\dictionaries; Flags: skipifsourcedoesntexist ignoreversion
-Source: {#DEPS_DIR}\dictionaries\en_US.dic; DestDir: {app}\dictionaries; Flags: skipifsourcedoesntexist ignoreversion
+Source: {#DEPS_DIR}\dictionaries\en_US.aff; DestDir: {app}\dictionaries; Flags: ignoreversion; Components: dictionaries/en_US
+Source: {#DEPS_DIR}\dictionaries\en_US.dic; DestDir: {app}\dictionaries; Flags: ignoreversion; Components: dictionaries/en_US

packages/win_installer/portable/create-portable.ps1

@@ -51,11 +51,19 @@ Copy-New-Item $InstallerDir\bin\aegisub.exe  $PortableOutputDir
 
 Write-Output 'Copying - translations'
 Copy-New-Items "$InstallerDir\share\locale\*"  "$PortableOutputDir\locale" -Recurse
+Write-Output 'Copying - dictionaries'
+Copy-New-Item $InstallerDepsDir\dictionaries\en_US.aff  $PortableOutputDir\dictionaries
+Copy-New-Item $InstallerDepsDir\dictionaries\en_US.dic  $PortableOutputDir\dictionaries
 Write-Output 'Copying - codecs'
 Write-Output 'Copying - codecs\Avisynth'
 Copy-New-Item $InstallerDepsDir\AvisynthPlus64\x64\system\DevIL.dll  $PortableOutputDir
 Copy-New-Item $InstallerDepsDir\AvisynthPlus64\x64\AviSynth.dll  $PortableOutputDir
 Copy-New-Item $InstallerDepsDir\AvisynthPlus64\x64\plugins\DirectShowSource.dll  $PortableOutputDir
+Write-Output 'Copying - codecs\VapourSynth'
+Copy-New-Item $InstallerDepsDir\L-SMASH-Works\libvslsmashsource.dll  $PortableOutputDir\vapoursynth
+Copy-New-Item $InstallerDepsDir\bestaudiosource\win64\BestAudioSource.dll  $PortableOutputDir\vapoursynth
+Copy-New-Item $InstallerDepsDir\SCXVid\libscxvid.dll  $PortableOutputDir\vapoursynth
+Copy-New-Item $InstallerDepsDir\WWXD\libwwxd64.dll  $PortableOutputDir\vapoursynth
 Write-Output 'Copying - codecs\VSFilter'
 Copy-New-Item $InstallerDepsDir\VSFilter\x64\VSFilter.dll  $PortableOutputDir\csri
 Write-Output 'Copying - runtimes\MS-CRT'

src/audio_provider_factory.cpp

@@ -32,7 +32,7 @@ using namespace agi;
 std::unique_ptr<AudioProvider> CreateAvisynthAudioProvider(fs::path const& filename, BackgroundRunner *);
 std::unique_ptr<AudioProvider> CreateFFmpegSourceAudioProvider(fs::path const& filename, BackgroundRunner *);
 std::unique_ptr<AudioProvider> CreateBSAudioProvider(fs::path const& filename, BackgroundRunner *);
-std::unique_ptr<AudioProvider> CreateVapoursynthAudioProvider(fs::path const& filename, BackgroundRunner *);
+std::unique_ptr<AudioProvider> CreateVapourSynthAudioProvider(fs::path const& filename, BackgroundRunner *);
 
 namespace {
 struct factory {
@@ -54,7 +54,7 @@ const factory providers[] = {
 	{"BestSource", CreateBSAudioProvider, false},
 #endif
 #ifdef WITH_VAPOURSYNTH
-	{"Vapoursynth", CreateVapoursynthAudioProvider, false},
+	{"VapourSynth", CreateVapourSynthAudioProvider, false},
 #endif
 };
 }

src/audio_provider_vs.cpp

@@ -15,7 +15,7 @@
 // Aegisub Project http://www.aegisub.org/
 
 /// @file audio_provider_vs.cpp
-/// @brief Vapoursynth-based audio provider
+/// @brief VapourSynth-based audio provider
 /// @ingroup audio_input
 ///
 
@@ -38,7 +38,7 @@
 #include "VSScript4.h"
 
 namespace {
-class VapoursynthAudioProvider final : public agi::AudioProvider {
+class VapourSynthAudioProvider final : public agi::AudioProvider {
 	VapourSynthWrapper vs;
 	VSScript *script = nullptr;
 	VSNode *node = nullptr;
@@ -47,36 +47,36 @@ class VapoursynthAudioProvider final : public agi::AudioProvider {
 	void FillBufferWithFrame(void *buf, int frame, int64_t start, int64_t count) const;
 	void FillBuffer(void *buf, int64_t start, int64_t count) const override;
 public:
-	VapoursynthAudioProvider(agi::fs::path const& filename);
-	~VapoursynthAudioProvider();
+	VapourSynthAudioProvider(agi::fs::path const& filename);
+	~VapourSynthAudioProvider();
 
 	bool NeedsCache() const override { return true; }
 };
 
-VapoursynthAudioProvider::VapoursynthAudioProvider(agi::fs::path const& filename) try {
+VapourSynthAudioProvider::VapourSynthAudioProvider(agi::fs::path const& filename) try {
 	std::lock_guard<std::mutex> lock(vs.GetMutex());
 
 	VSCleanCache();
 
 	script = vs.GetScriptAPI()->createScript(nullptr);
 	if (script == nullptr) {
-		throw VapoursynthError("Error creating script API");
+		throw VapourSynthError("Error creating script API");
 	}
 	vs.GetScriptAPI()->evalSetWorkingDir(script, 1);
 	if (OpenScriptOrVideo(vs.GetAPI(), vs.GetScriptAPI(), script, filename, OPT_GET("Provider/Audio/VapourSynth/Default Script")->GetString())) {
 		std::string msg = agi::format("Error executing VapourSynth script: %s", vs.GetScriptAPI()->getError(script));
 		vs.GetScriptAPI()->freeScript(script);
-		throw VapoursynthError(msg);
+		throw VapourSynthError(msg);
 	}
 	node = vs.GetScriptAPI()->getOutputNode(script, 0);
 	if (node == nullptr) {
 		vs.GetScriptAPI()->freeScript(script);
-		throw VapoursynthError("No output node set");
+		throw VapourSynthError("No output node set");
 	}
 	if (vs.GetAPI()->getNodeType(node) != mtAudio) {
 		vs.GetAPI()->freeNode(node);
 		vs.GetScriptAPI()->freeScript(script);
-		throw VapoursynthError("Output node isn't an audio node");
+		throw VapourSynthError("Output node isn't an audio node");
 	}
 	vi = vs.GetAPI()->getAudioInfo(node);
 	float_samples = vi->format.sampleType == stFloat;
@@ -85,10 +85,10 @@ VapoursynthAudioProvider::VapoursynthAudioProvider(agi::fs::path const& filename
 	channels = vi->format.numChannels;
 	num_samples = vi->numSamples;
 }
-catch (VapoursynthError const& err) {
+catch (VapourSynthError const& err) {
 	// Unlike the video provider manager, the audio provider factory catches AudioProviderErrors and picks whichever source doesn't throw one.
 	// So just rethrow the Error here with an extra label so the user will see the error message and know the audio wasn't loaded with VS
-	throw VapoursynthError(agi::format("Vapoursynth error: %s", err.GetMessage()));
+	throw VapourSynthError(agi::format("VapourSynth error: %s", err.GetMessage()));
 }
 
 template<typename T>
@@ -102,27 +102,27 @@ static void PackChannels(const uint8_t **Src, void *Dst, size_t Length, size_t C
 	}
 }
 
-void VapoursynthAudioProvider::FillBufferWithFrame(void *buf, int n, int64_t start, int64_t count) const {
+void VapourSynthAudioProvider::FillBufferWithFrame(void *buf, int n, int64_t start, int64_t count) const {
 	char errorMsg[1024];
 	const VSFrame *frame = vs.GetAPI()->getFrame(n, node, errorMsg, sizeof(errorMsg));
 	if (frame == nullptr) {
-		throw VapoursynthError(agi::format("Error getting frame: %s", errorMsg));
+		throw VapourSynthError(agi::format("Error getting frame: %s", errorMsg));
 	}
 	if (vs.GetAPI()->getFrameLength(frame) < count) {
 		vs.GetAPI()->freeFrame(frame);
-		throw VapoursynthError("Audio frame too short");
+		throw VapourSynthError("Audio frame too short");
 	}
 	if (vs.GetAPI()->getAudioFrameFormat(frame)->numChannels != channels || vs.GetAPI()->getAudioFrameFormat(frame)->bytesPerSample != bytes_per_sample) {
 		vs.GetAPI()->freeFrame(frame);
-		throw VapoursynthError("Audio format is not constant");
+		throw VapourSynthError("Audio format is not constant");
 	}
 
 	std::vector<const uint8_t *> planes(channels);
 	for (int c = 0; c < channels; c++) {
 		planes[c] = vs.GetAPI()->getReadPtr(frame, c) + bytes_per_sample * start;
 		if (planes[c] == nullptr) {
 			vs.GetAPI()->freeFrame(frame);
-			throw VapoursynthError("Failed to read audio channel");
+			throw VapourSynthError("Failed to read audio channel");
 		}
 	}
 
@@ -138,7 +138,7 @@ void VapoursynthAudioProvider::FillBufferWithFrame(void *buf, int n, int64_t sta
 	vs.GetAPI()->freeFrame(frame);
 }
 
-void VapoursynthAudioProvider::FillBuffer(void *buf, int64_t start, int64_t count) const {
+void VapourSynthAudioProvider::FillBuffer(void *buf, int64_t start, int64_t count) const {
 	int end = start + count; 	// exclusive
 	int startframe = start / VS_AUDIO_FRAME_SAMPLES;
 	int endframe = (end - 1) / VS_AUDIO_FRAME_SAMPLES;
@@ -154,7 +154,7 @@ void VapoursynthAudioProvider::FillBuffer(void *buf, int64_t start, int64_t coun
 	}
 }
 
-VapoursynthAudioProvider::~VapoursynthAudioProvider() {
+VapourSynthAudioProvider::~VapourSynthAudioProvider() {
 	if (node != nullptr) {
 		vs.GetAPI()->freeNode(node);
 	}
@@ -164,7 +164,7 @@ VapoursynthAudioProvider::~VapoursynthAudioProvider() {
 }
 }
 
-std::unique_ptr<agi::AudioProvider> CreateVapoursynthAudioProvider(agi::fs::path const& file, agi::BackgroundRunner *) {
-	return agi::make_unique<VapoursynthAudioProvider>(file);
+std::unique_ptr<agi::AudioProvider> CreateVapourSynthAudioProvider(agi::fs::path const& file, agi::BackgroundRunner *) {
+	return agi::make_unique<VapourSynthAudioProvider>(file);
 }
 #endif

src/libresrc/default_config.json

@@ -351,7 +351,7 @@
 				"Aegisub Cache" : true
 			},
 			"VapourSynth" : {
-				"Default Script" : "# This default script will load an audio file using BestAudioSource.\n# It requires the `bas` plugin.\n\nimport vapoursynth as vs\ntry:\n    vs.core.bas.Source(source=filename).set_output()\nexcept AttributeError:\n   raise vs.Error(\"To use Aegisub's default audio loader, the `bas` plugin for VapourSynth must be installed\")"
+				"Default Script" : "# This default script will load an audio file using BestAudioSource.\n# It requires the `bas` plugin.\n\nimport vapoursynth as vs\nimport aegisub_vs as a\na.set_paths(locals())\n\na.ensure_plugin(\"bas\", \"BestAudioSource\", \"To use Aegisub's default audio loader, the `bas` plugin for VapourSynth must be installed\")\nvs.core.bas.Source(source=filename).set_output()"
 			}
 		},
 		"Avisynth" : {
@@ -392,7 +392,7 @@
 			},
 			"VapourSynth" : {
 				"Log Level": "Information",
-				"Default Script" : "# This default script will load a video file using LWLibavSource.\n# It requires the `lsmas` plugin.\n# See ?data/automation/vapoursynth/aegisub_vs.py for more information.\n\nimport aegisub_vs as a\nimport vapoursynth as vs\n\nclip, videoinfo = a.wrap_lwlibavsource(filename, __aegi_vscache)\nclip.set_output()\n__aegi_timecodes = videoinfo[\"timecodes\"]\n__aegi_keyframes = videoinfo[\"keyframes\"]\n# Uncomment this to automatically generate keyframes at scene changes.\n#__aegi_keyframes = a.get_keyframes(filename, clip)\n\n# Check if the file has an audio track. This requires the `bas` plugin.\n__aegi_hasaudio = 1 if a.check_audio(filename) else 0"
+				"Default Script" : "# This default script will load a video file using LWLibavSource.\n# It requires the `lsmas` plugin.\n# See ?data/automation/vapoursynth/aegisub_vs.py for more information.\n\nimport vapoursynth as vs\nimport time\nimport aegisub_vs as a\na.set_paths(locals())\n\nclip, videoinfo = a.wrap_lwlibavsource(filename)\nclip.set_output()\n__aegi_timecodes = videoinfo[\"timecodes\"]\n__aegi_keyframes = videoinfo[\"keyframes\"]\n\n# Uncomment the first following line to read keyframes from a file when present.\n#__aegi_keyframes = a.try_get_keyframes(filename, __aegi_keyframes)\n\n# Uncomment the following line to automatically generate keyframes at scene changes. This will take some time when first loading a video.\n__aegi_keyframes = a.get_keyframes(filename, clip)\n\n# Check if the file has an audio track. This requires the `bas` plugin.\n__aegi_hasaudio = 1 if a.check_audio(filename) else 0"
 			}
 		}
 	},