feat[closes #3977]: add lsfg-vk frame generation

Author: mirkobrombin

bottles/backend/globals.py

@@ -90,6 +90,31 @@ def is_vkbasalt_available():
                 return True
         return False
 
+    @staticmethod
+    def get_lsfg_vk_version():
+        layer_dirs = [
+            path
+            for path in os.environ.get("VK_ADD_LAYER_PATH", "").split(os.pathsep)
+            if path
+        ]
+        layer_dirs += [
+            "/usr/lib/extensions/vulkan/lsfgvk/share/vulkan/implicit_layer.d",
+            f"{Paths.xdg_data_home}/vulkan/implicit_layer.d",
+            "/usr/local/share/vulkan/implicit_layer.d",
+            "/usr/share/vulkan/implicit_layer.d",
+            "/etc/vulkan/implicit_layer.d",
+        ]
+        for version, manifest in (
+            (2, "VkLayer_LSFGVK_frame_generation.json"),
+            (1, "VkLayer_LS_frame_generation.json"),
+        ):
+            if any(
+                os.path.isfile(os.path.join(layer_dir, manifest))
+                for layer_dir in layer_dirs
+            ):
+                return version
+        return 0
+
 
 class TrdyPaths:
     # External managers paths
@@ -123,6 +148,8 @@ def check_flatpak_extension(cmd: str, path: str):
     "/usr/lib/extensions/vulkan/HdrWsi/lib/libVkLayer_hdr_wsi.so"
 )
 vkbasalt_available = Paths.is_vkbasalt_available()
+lsfg_vk_version = Paths.get_lsfg_vk_version()
+lsfg_vk_available = bool(lsfg_vk_version)
 mangohud_available = check_flatpak_extension("mangohud", "/usr/lib/extensions/vulkan/MangoHud/bin/mangohud")
 obs_vkc_available = check_flatpak_extension("obs-vkcapture", "/usr/lib/extensions/vulkan/OBSVkCapture/bin/obs-vkcapture")
 vmtouch_available = shutil.which("vmtouch") or False

bottles/backend/managers/backup.py

@@ -328,6 +328,8 @@ def exclude_filter(tarinfo: tarfile.TarInfo) -> tarfile.TarInfo | None:
         """
         if "dosdevices" in tarinfo.name:
             return None
+        if "lsfg-vk" in tarinfo.name.split("/"):
+            return None
         return tarinfo
 
     @staticmethod

bottles/backend/models/config.py

@@ -105,6 +105,10 @@ class BottleParams(DictCompatMixIn):
     mangohud_display_on_game_start: bool = True
     obsvkc: bool = False
     vkbasalt: bool = False
+    lsfg_vk: bool = False
+    lsfg_vk_multiplier: int = 2
+    lsfg_vk_flow_scale: float = 1.0
+    lsfg_vk_performance_mode: bool = False
     gamemode: bool = False
     gamescope: bool = False
     gamescope_game_width: int = 0

bottles/backend/utils/lsfgvk.py

@@ -0,0 +1,59 @@
+# lsfgvk.py
+#
+# Copyright 2026 Bottles Developers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, in version 3 of the License.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import contextlib
+import os
+import shutil
+import tempfile
+
+
+def get_lsfg_vk_dll_path(bottle_path):
+    return os.path.join(bottle_path, "lsfg-vk", "Lossless.dll")
+
+
+def store_lsfg_vk_dll(source, bottle_path):
+    if os.path.basename(source).casefold() != "lossless.dll":
+        raise ValueError("Unexpected DLL name")
+
+    with open(source, "rb") as file:
+        if file.read(2) != b"MZ":
+            raise ValueError("Invalid DLL")
+
+    target = get_lsfg_vk_dll_path(bottle_path)
+    target_dir = os.path.dirname(target)
+    os.makedirs(target_dir, exist_ok=True)
+    if os.path.exists(target) and os.path.samefile(source, target):
+        return target
+
+    fd, temporary = tempfile.mkstemp(dir=target_dir, prefix=".Lossless-", suffix=".dll")
+    os.close(fd)
+    try:
+        shutil.copy2(source, temporary)
+        os.replace(temporary, target)
+    except BaseException:
+        with contextlib.suppress(OSError):
+            os.remove(temporary)
+        raise
+
+    return target
+
+
+def remove_lsfg_vk_dll(bottle_path):
+    target = get_lsfg_vk_dll_path(bottle_path)
+    with contextlib.suppress(FileNotFoundError):
+        os.remove(target)
+    with contextlib.suppress(OSError):
+        os.rmdir(os.path.dirname(target))

bottles/backend/utils/meson.build

@@ -24,6 +24,7 @@ bottles_sources = [
   'connection.py',
   'gsettings_stub.py',
   'json.py',
+  'lsfgvk.py',
   'singleton.py'
 ]
 

bottles/backend/wine/winecommand.py

@@ -11,6 +11,7 @@
     Paths,
     gamemode_available,
     gamescope_available,
+    lsfg_vk_version,
     mangohud_available,
     obs_vkc_available,
     vmtouch_available,
@@ -23,6 +24,7 @@
 from bottles.backend.utils.display import DisplayUtils
 from bottles.backend.utils.generic import detect_encoding, is_ntsync_available
 from bottles.backend.utils.gpu import GPUUtils
+from bottles.backend.utils.lsfgvk import get_lsfg_vk_dll_path
 from bottles.backend.utils.manager import ManagerUtils
 from bottles.backend.utils.steam import SteamUtils
 from bottles.backend.utils.terminal import TerminalUtils
@@ -180,6 +182,57 @@ def apply_hdr_preferences(env: "WineEnv", params, gamescope_activated: bool) ->
         env.add("ENABLE_GAMESCOPE_WSI", "1", override=True)
 
 
+def apply_lsfg_vk_preferences(
+    env: "WineEnv", params, bottle_path: str, version: Optional[int] = None
+) -> None:
+    if version is None:
+        version = lsfg_vk_version
+
+    if not getattr(params, "lsfg_vk", False):
+        return
+
+    dll = get_lsfg_vk_dll_path(bottle_path)
+    try:
+        multiplier = int(getattr(params, "lsfg_vk_multiplier", 2))
+        flow_scale = float(getattr(params, "lsfg_vk_flow_scale", 1.0))
+    except (TypeError, ValueError):
+        multiplier = 0
+        flow_scale = 0
+    enabled = (
+        version in (1, 2)
+        and os.path.isfile(dll)
+        and os.access(dll, os.R_OK)
+        and 2 <= multiplier <= 4
+        and 0.25 <= flow_scale <= 1.0
+    )
+    if not enabled:
+        env.add("DISABLE_LSFG", "1", override=True)
+        env.add("DISABLE_LSFGVK", "1", override=True)
+        return
+
+    multiplier = str(multiplier)
+    flow_scale = str(flow_scale)
+    performance = "1" if getattr(params, "lsfg_vk_performance_mode", False) else "0"
+
+    if version == 2:
+        env.add("DISABLE_LSFG", "1", override=True)
+        env.remove("DISABLE_LSFGVK")
+        env.add("LSFGVK_ENV", "1", override=True)
+        env.add("LSFGVK_DLL_PATH", dll, override=True)
+        env.add("LSFGVK_MULTIPLIER", multiplier, override=True)
+        env.add("LSFGVK_FLOW_SCALE", flow_scale, override=True)
+        env.add("LSFGVK_PERFORMANCE_MODE", performance, override=True)
+        return
+
+    env.remove("DISABLE_LSFG")
+    env.add("DISABLE_LSFGVK", "1", override=True)
+    env.add("LSFG_LEGACY", "1", override=True)
+    env.add("LSFG_DLL_PATH", dll, override=True)
+    env.add("LSFG_MULTIPLIER", multiplier, override=True)
+    env.add("LSFG_FLOW_SCALE", flow_scale, override=True)
+    env.add("LSFG_PERFORMANCE_MODE", performance, override=True)
+
+
 def _needs_steam_virtual_gamepad_workaround(runner_name: Optional[str]) -> bool:
     """Return True if the runner should force SteamVirtualGamepadInfo."""
 
@@ -505,6 +558,13 @@ def get_env(
                 env.add("VKBASALT_CONFIG_FILE", vkbasalt_conf_path)
             env.add("ENABLE_VKBASALT", "1")
 
+        apply_lsfg_vk_preferences(
+            env,
+            params,
+            bottle,
+            version=lsfg_vk_version if arch != "win32" and not self.minimal else 0,
+        )
+
         # OBS Vulkan Capture environment variables
         if params.obsvkc and not self.minimal:
             env.add("OBS_VKCAPTURE", "1")

bottles/frontend/main.py

@@ -414,6 +414,12 @@ def __show_about_dialog(self, *_args):
                 "winetricks data: LGPL-2.1-or-later."
             ),
         )
+        about_dialog.add_legal_section(
+            _("lsfg-vk"),
+            _("Vulkan frame generation layer"),
+            Gtk.License.CUSTOM,
+            _("lsfg-vk 1.x: MIT.\nlsfg-vk 2.x: GPL-3.0-or-later."),
+        )
         about_dialog.set_copyright(
             _("Copyright © 2017 {developer_name}").format(
                 developer_name=about_dialog.get_developer_name()
@@ -432,6 +438,7 @@ def __show_about_dialog(self, *_args):
                 "vkbasalt-cli https://gitlab.com/TheEvilSkeleton/vkbasalt-cli",
                 "GameMode https://github.com/FeralInteractive/gamemode",
                 "Gamescope https://github.com/Plagman/gamescope",
+                "lsfg-vk https://github.com/PancakeTAS/lsfg-vk",
                 "OBS Vulkan/OpenGL capture https://github.com/nowrep/obs-vkcapture",
                 "Wine-TKG https://github.com/Frogging-Family/wine-tkg-git",
                 "Proton https://github.com/ValveSoftware/proton",

bottles/frontend/ui/bottles.gresource.xml

@@ -38,6 +38,7 @@
     <file preprocess="xml-stripblanks">importer.ui</file>
     <file preprocess="xml-stripblanks">library.ui</file>
     <file preprocess="xml-stripblanks">dialog-launch-options.ui</file>
+    <file preprocess="xml-stripblanks">dialog-lsfg-vk.ui</file>
     <file preprocess="xml-stripblanks">dialog-playtime-graph.ui</file>
     <file preprocess="xml-stripblanks">dialog-dll-overrides.ui</file>
     <file preprocess="xml-stripblanks">dialog-env-vars.ui</file>

bottles/frontend/ui/details-preferences.blp

@@ -159,6 +159,26 @@ template $DetailsPreferences: Adw.PreferencesPage {
       }
     }
 
+    Adw.ActionRow row_lsfg_vk {
+      activatable-widget: switch_lsfg_vk;
+      title: _("Frame Generation (Experimental)");
+      subtitle: _("Generate additional frames with lsfg-vk. Only works with 64-bit Vulkan applications.");
+
+      Button btn_manage_lsfg_vk {
+        tooltip-text: _("Manage lsfg-vk settings");
+        valign: center;
+        icon-name: "applications-system-symbolic";
+
+        styles [
+          "flat",
+        ]
+      }
+
+      Switch switch_lsfg_vk {
+        valign: center;
+      }
+    }
+
     Adw.ActionRow row_gamescope {
       activatable-widget: switch_gamescope;
       title: "Gamescope";