mirror of
https://github.com/valentderah/totk-pc-recomp.git
synced 2026-11-21 04:55:56 +00:00
FidelityFX SDK 1.1.4 frame interpolation and optical flow built into totk.exe behind frame_gen, contexts created and destroyed only, no frame-path change
The SDK subset, its compat header and the SPIR-V shader header come from Savage Wind (MIT); tools/ffx_shaders.py regenerates the header with glslangValidator, build_game.py compiles the SDK sources with ffx_compat.h force-included, and runtime/vk_fg.cpp makes the backend, optical flow and frame interpolation contexts after the device exists when frame_gen = 1 (default 0, read at start). Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Co-Authored-By: Revivedx <82332536+Revivedx@users.noreply.github.com>
This commit is contained in:
1 parent
25a53e5ef2
commit
4e48669c86
114 files changed
+46877
-6
No files matched your search
+16
-3
@@ -360,7 +360,8 @@ def runtime_sources(skip=()):
|
||||
"""Every runtime/*.c, *.cpp, platform/*.c, *.rc, the in-game menu (ui/*.cpp) and Dear ImGui of this OS except the
|
||||
names in skip, so a task adds a file without editing this script."""
|
||||
pats = ('*.c', '*.cpp', 'platform/*.c', '*.rc', 'ui/*.cpp', 'third_party/imgui/*.cpp',
|
||||
'third_party/imgui/backends/*.cpp')
|
||||
'third_party/imgui/backends/*.cpp', 'third_party/FidelityFX/sdk/src/shared/*.cpp', 'third_party/FidelityFX/sdk/src/backends/vk/*.cpp',
|
||||
'third_party/FidelityFX/sdk/src/components/*/*.cpp')
|
||||
return sorted(p for pat in pats for p in RUNTIME.glob(pat) if p.name not in skip and not other_os(p.name))
|
||||
|
||||
|
||||
@@ -485,7 +486,10 @@ def ninja_file(gen, out, mods, pool_depth, skip=(), prebuilt=(), runtime_lib=Non
|
||||
inc = f'-I {cmd_path(RUNTIME)} -I {cmd_path(gen)}'
|
||||
vma = f'{cmd_path(DEPS / "include")} -I {cmd_path(DEPS / "include" / "vma")}' if DEPS else cmd_path(vma_include())
|
||||
imgui = cmd_path(RUNTIME / 'third_party' / 'imgui')
|
||||
rt_inc = f'{inc} -I {cmd_path(out)} -I {vma} -I {imgui}' # romfs_config.h, vk_mem_alloc.h (+ deps headers), imgui.h
|
||||
ffx = RUNTIME / 'third_party' / 'FidelityFX'
|
||||
ffx_inc = ' '.join(f'-I {cmd_path(d)}' for d in (ffx / 'sdk' / 'include', ffx / 'sdk' / 'src' / 'backends' / 'shared',
|
||||
ffx / 'spirv')) # FidelityFX/host headers, ffx_shader_blobs.h, ffx_shaders_vk.h
|
||||
rt_inc = f'{inc} -I {cmd_path(out)} -I {vma} -I {imgui} {ffx_inc}' # romfs_config.h, vk_mem_alloc.h (+ deps headers), imgui.h
|
||||
libs = [f'-L {cmd_path(DEPS / "lib")}'] + (LLVM_LINK_LIBS if WIN else LINK_LIBS) if DEPS else LINK_LIBS
|
||||
lines = [
|
||||
'# Written by tools/build_game.py; do not edit.',
|
||||
@@ -508,6 +512,14 @@ def ninja_file(gen, out, mods, pool_depth, skip=(), prebuilt=(), runtime_lib=Non
|
||||
' depfile = $out.d',
|
||||
' description = CC $in',
|
||||
'',
|
||||
# AMD's FidelityFX SDK sources (runtime/third_party/FidelityFX/sdk/src): ffx_compat.h is force-included so they
|
||||
# build with clang (what MSVC's headers bring in on their own, the _s string functions); -w: AMD's code is not ours to fix
|
||||
'rule cc_ffx',
|
||||
f' command = $cc $rtflags -include ffx_compat.h -I {cmd_path(ffx)} -I {cmd_path(ffx / "sdk" / "src" / "shared")} -w -MD -MF $out.d -c $in -o $out',
|
||||
' deps = gcc',
|
||||
' depfile = $out.d',
|
||||
' description = CC $in',
|
||||
'',
|
||||
'rule rc',
|
||||
f' command = {tool_arg(WINDRES)} -I {cmd_path(RUNTIME)} -O coff $in -o $out',
|
||||
' description = RC $in',
|
||||
@@ -544,7 +556,8 @@ def ninja_file(gen, out, mods, pool_depth, skip=(), prebuilt=(), runtime_lib=Non
|
||||
f'{ninja_path(RUNTIME / "totk.ico")}')
|
||||
else:
|
||||
stamp_dep = (' | ' if not pgo else ' ') + ninja_path(stamp) if stamp else ''
|
||||
lines.append(f'build {ninja_path(o)}: cc_rt {ninja_path(src)}{pgo}{stamp_dep}')
|
||||
rule = 'cc_ffx' if src.is_relative_to(ffx / 'sdk') else 'cc_rt'
|
||||
lines.append(f'build {ninja_path(o)}: {rule} {ninja_path(src)}{pgo}{stamp_dep}')
|
||||
rt.append(o)
|
||||
objs['runtime'] = rt
|
||||
every = [o for v in objs.values() for o in v]
|
||||
|
||||
@@ -0,0 +1,201 @@
|
||||
#!/usr/bin/env python3
|
||||
"""FidelityFX frame interpolation and optical flow shaders -> one C header (runtime/vk_fg.cpp).
|
||||
|
||||
Ported from Savage Wind (https://github.com/Revivedx/SavageWindRecomp, MIT), tools/ffx_shaders.py, without its FSR 3
|
||||
upscaler effect.
|
||||
|
||||
The SDK builds its shader "permutation" headers with FidelityFX_SC.exe (a Windows-only wrapper around glslang that
|
||||
also writes each shader's resource bindings). This does the same with glslangValidator and a small SPIR-V reader,
|
||||
for the permutations used here only: wave32, 32-bit floats, low-resolution motion vectors without jitter, and both
|
||||
depth directions (frame interpolation); SDR luma (optical flow). The backend (ffx_vk.cpp) takes each blob with its
|
||||
bindings by name, as FidelityFX_SC writes them. The header is committed (AMD shader builds, no game data), so building
|
||||
totk.exe needs no shader compiler; run this after changing the GLSL or this script:
|
||||
|
||||
python tools/ffx_shaders.py [<output header>] [<glslangValidator>]
|
||||
|
||||
The defaults are runtime/third_party/FidelityFX/spirv/ffx_shaders_vk.h and glslangValidator from MSYS2 UCRT64
|
||||
(C:/msys64/ucrt64/bin) or PATH; the Vulkan SDK's works too.
|
||||
"""
|
||||
import os
|
||||
import struct
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
|
||||
ROOT = Path(__file__).resolve().parent.parent
|
||||
|
||||
FI_PASSES = [ # FfxFrameInterpolationPass order
|
||||
'reconstruct_and_dilate_pass', 'setup_pass', 'reconstruct_previous_depth_pass', 'game_motion_vector_field_pass',
|
||||
'optical_flow_vector_field_pass', 'disocclusion_mask_pass', 'pass', 'compute_inpainting_pyramid_pass',
|
||||
'inpainting_pass', 'compute_game_vector_field_inpainting_pyramid_pass', 'debug_view_pass']
|
||||
OF_PASSES = [ # FfxOpticalflowPass order
|
||||
'prepare_luma_pass', 'compute_luminance_pyramid_pass', 'generate_scd_histogram_pass', 'compute_scd_divergence_pass',
|
||||
'compute_optical_flow_advanced_pass_v5', 'filter_optical_flow_pass_v5', 'scale_optical_flow_advanced_pass_v5']
|
||||
|
||||
FI_DEFS = ['-DFFX_FRAMEINTERPOLATION_OPTION_UPSAMPLE_SAMPLERS_USE_DATA_HALF=0',
|
||||
'-DFFX_FRAMEINTERPOLATION_OPTION_ACCUMULATE_SAMPLERS_USE_DATA_HALF=0',
|
||||
'-DFFX_FRAMEINTERPOLATION_OPTION_REPROJECT_SAMPLERS_USE_DATA_HALF=1',
|
||||
'-DFFX_FRAMEINTERPOLATION_OPTION_POSTPROCESSLOCKSTATUS_SAMPLERS_USE_DATA_HALF=0',
|
||||
'-DFFX_FRAMEINTERPOLATION_OPTION_UPSAMPLE_USE_LANCZOS_TYPE=2',
|
||||
'-DFFX_FRAMEINTERPOLATION_OPTION_LOW_RES_MOTION_VECTORS=1',
|
||||
'-DFFX_FRAMEINTERPOLATION_OPTION_JITTER_MOTION_VECTORS=0']
|
||||
OF_DEFS = ['-DFFX_OPTICALFLOW_OPTION_HDR_COLOR_INPUT=0']
|
||||
|
||||
# SPIR-V opcodes / enums used below
|
||||
OP_NAME, OP_ENTRY, OP_CONSTANT, OP_DECORATE, OP_MEMBER_DECORATE = 5, 15, 43, 71, 72
|
||||
OP_TYPE_IMAGE, OP_TYPE_SAMPLER, OP_TYPE_ARRAY, OP_TYPE_RUNTIME_ARRAY, OP_TYPE_STRUCT, OP_TYPE_POINTER, OP_VARIABLE = \
|
||||
25, 26, 28, 29, 30, 32, 59
|
||||
DEC_BLOCK, DEC_BUFFER_BLOCK, DEC_NON_WRITABLE, DEC_BINDING, DEC_SET = 2, 3, 24, 33, 34
|
||||
SC_UNIFORM_CONSTANT, SC_UNIFORM, SC_STORAGE_BUFFER = 0, 2, 12
|
||||
KINDS = ['cb', 'srv_tex', 'uav_tex', 'srv_buf', 'uav_buf', 'sampler']
|
||||
|
||||
|
||||
def spirv_string(words):
|
||||
b = struct.pack('<%dI' % len(words), *words)
|
||||
return b[:b.index(0)].decode()
|
||||
|
||||
|
||||
def reflect(spv):
|
||||
"""{kind: [(name, binding, count, set)]} for the resources the entry point uses"""
|
||||
w = struct.unpack('<%dI' % (len(spv) // 4), spv)
|
||||
names, deco, mdeco, types, consts, ptrs, vars_, iface = {}, {}, {}, {}, {}, {}, [], set()
|
||||
i = 5
|
||||
while i < len(w):
|
||||
op, n = w[i] & 0xffff, w[i] >> 16
|
||||
a = w[i + 1:i + n]
|
||||
if op == OP_NAME:
|
||||
names[a[0]] = spirv_string(a[1:])
|
||||
elif op == OP_ENTRY:
|
||||
s = spirv_string(a[2:])
|
||||
iface.update(a[2 + (len(s) + 4) // 4:])
|
||||
elif op == OP_DECORATE:
|
||||
deco.setdefault(a[0], {})[a[1]] = a[2] if len(a) > 2 else True
|
||||
elif op == OP_MEMBER_DECORATE:
|
||||
mdeco.setdefault(a[0], {}).setdefault(a[1], set()).add(a[2])
|
||||
elif op == OP_CONSTANT:
|
||||
consts[a[1]] = a[2]
|
||||
elif op in (OP_TYPE_IMAGE, OP_TYPE_SAMPLER, OP_TYPE_ARRAY, OP_TYPE_RUNTIME_ARRAY, OP_TYPE_STRUCT):
|
||||
types[a[0]] = (op, a[1:])
|
||||
elif op == OP_TYPE_POINTER:
|
||||
ptrs[a[0]] = a[2]
|
||||
elif op == OP_VARIABLE:
|
||||
vars_.append((a[1], a[0], a[2]))
|
||||
i += n
|
||||
out = {k: [] for k in KINDS}
|
||||
for v, ptype, sc in vars_:
|
||||
d = deco.get(v, {})
|
||||
if v not in iface or DEC_BINDING not in d:
|
||||
continue
|
||||
t, count = ptrs[ptype], 1
|
||||
while types.get(t, (0,))[0] == OP_TYPE_ARRAY:
|
||||
count *= consts[types[t][1][1]]
|
||||
t = types[t][1][0]
|
||||
op, args = types[t]
|
||||
name = names.get(v) or names.get(t)
|
||||
if op == OP_TYPE_STRUCT:
|
||||
td = deco.get(t, {})
|
||||
members = mdeco.get(t, {})
|
||||
ro = len(members) == len(args) and all(DEC_NON_WRITABLE in m for m in members.values())
|
||||
if sc == SC_UNIFORM and DEC_BLOCK in td:
|
||||
kind = 'cb'
|
||||
else:
|
||||
kind = 'srv_buf' if ro else 'uav_buf'
|
||||
elif op == OP_TYPE_IMAGE:
|
||||
kind = 'uav_tex' if args[5] == 2 else 'srv_tex'
|
||||
elif op == OP_TYPE_SAMPLER:
|
||||
kind = 'sampler'
|
||||
else:
|
||||
raise SystemExit('unknown resource type for %s' % name)
|
||||
out[kind].append((name, d[DEC_BINDING], count, d.get(DEC_SET, 0)))
|
||||
for k in KINDS:
|
||||
out[k].sort(key=lambda r: r[1])
|
||||
return out
|
||||
|
||||
|
||||
def compile_glsl(glslang, src, incs, defs, half=0):
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
o = os.path.join(td, 'out.spv')
|
||||
cmd = [glslang, '-V', '--target-env', 'vulkan1.2', '-S', 'comp', '-Os', '-DFFX_GLSL=1', '-DFFX_GPU=1',
|
||||
'-DFFX_HALF=%d' % half] + defs + ['-I' + i for i in incs] + ['-o', o, src]
|
||||
r = subprocess.run(cmd, capture_output=True, text=True)
|
||||
if r.returncode:
|
||||
raise SystemExit('%s\n%s%s' % (' '.join(cmd), r.stdout, r.stderr))
|
||||
with open(o, 'rb') as f:
|
||||
return f.read()
|
||||
|
||||
|
||||
def default_glslang():
|
||||
"""glslangValidator from MSYS2 UCRT64 (the toolchain tools/build_shaders.py uses), else PATH."""
|
||||
msys = Path('C:/msys64/ucrt64/bin/glslangValidator.exe')
|
||||
return str(msys) if msys.is_file() else 'glslangValidator'
|
||||
|
||||
|
||||
def main():
|
||||
args = sys.argv[1:]
|
||||
effects = {'fi', 'of'}
|
||||
sdk = str(ROOT / 'runtime' / 'third_party' / 'FidelityFX' / 'sdk')
|
||||
out = args[0] if args else str(ROOT / 'runtime' / 'third_party' / 'FidelityFX' / 'spirv' / 'ffx_shaders_vk.h')
|
||||
glslang = args[1] if len(args) > 1 else default_glslang()
|
||||
gpu = os.path.join(sdk, 'include', 'FidelityFX', 'gpu')
|
||||
shaders = os.path.join(sdk, 'src', 'backends', 'vk', 'shaders')
|
||||
blobs = [] # (c name, spv, reflection)
|
||||
for inv in (0, 1) if 'fi' in effects else ():
|
||||
for p in FI_PASSES:
|
||||
src = os.path.join(shaders, 'frameinterpolation', 'ffx_frameinterpolation_%s.glsl' % p)
|
||||
spv = compile_glsl(glslang, src, [gpu, os.path.join(gpu, 'frameinterpolation')],
|
||||
FI_DEFS + ['-DFFX_FRAMEINTERPOLATION_OPTION_INVERTED_DEPTH=%d' % inv])
|
||||
blobs.append(('fi_%s_%d' % (p, inv), spv, reflect(spv)))
|
||||
for p in OF_PASSES if 'of' in effects else ():
|
||||
src = os.path.join(shaders, 'opticalflow', 'ffx_opticalflow_%s.glsl' % p)
|
||||
spv = compile_glsl(glslang, src, [gpu, os.path.join(gpu, 'opticalflow')], OF_DEFS)
|
||||
blobs.append(('of_%s' % p, spv, reflect(spv)))
|
||||
L = ['// Generated by tools/ffx_shaders.py from the AMD FidelityFX SDK (MIT, see runtime/third_party/FidelityFX/LICENSE.txt).',
|
||||
'// Do not edit.', '#pragma once', '#include <stdint.h>', '']
|
||||
for cname, spv, refl in blobs:
|
||||
words = struct.unpack('<%dI' % (len(spv) // 4), spv)
|
||||
L.append('static const uint32_t %s_spv[%d] = {' % (cname, len(words)))
|
||||
for j in range(0, len(words), 12):
|
||||
L.append(' ' + ','.join('0x%x' % x for x in words[j:j + 12]) + ',')
|
||||
L.append('};')
|
||||
for k in KINDS:
|
||||
r = refl[k]
|
||||
if not r:
|
||||
continue
|
||||
L.append('static const char *%s_%s_names[] = {%s};' % (cname, k, ', '.join('"%s"' % x[0] for x in r)))
|
||||
for f, idx in (('bind', 1), ('count', 2), ('space', 3)):
|
||||
L.append('static const uint32_t %s_%s_%s[] = {%s};' % (cname, k, f, ', '.join(str(x[idx]) for x in r)))
|
||||
L.append('')
|
||||
|
||||
def blob(cname, refl): # FfxShaderBlob's fields in order
|
||||
f = ['(const uint8_t *)%s_spv' % cname, 'sizeof %s_spv' % cname]
|
||||
f += [str(len(refl[k])) for k in KINDS[:5]] + [str(len(refl['sampler'])), '0']
|
||||
for k in ['cb', 'srv_tex', 'uav_tex', 'srv_buf', 'uav_buf', 'sampler']:
|
||||
if refl[k]:
|
||||
f += ['%s_%s_names' % (cname, k)] + ['%s_%s_%s' % (cname, k, x) for x in ('bind', 'count', 'space')]
|
||||
else:
|
||||
f += ['0'] * 4
|
||||
f += ['0'] * 4 # (ray tracing acceleration structures)
|
||||
return ' {' + ', '.join(f) + '},'
|
||||
|
||||
if 'fi' in effects:
|
||||
L.append('// [inverted depth][FfxFrameInterpolationPass]')
|
||||
L.append('static const FfxShaderBlob ffx_fi_blobs[2][%d] = {' % len(FI_PASSES))
|
||||
for inv in (0, 1):
|
||||
L.append(' {')
|
||||
L += [blob(c, r) for c, _, r in blobs if c.startswith('fi_') and c.endswith('_%d' % inv)]
|
||||
L.append(' },')
|
||||
L.append('};')
|
||||
if 'of' in effects:
|
||||
L.append('// [FfxOpticalflowPass]')
|
||||
L.append('static const FfxShaderBlob ffx_of_blobs[%d] = {' % len(OF_PASSES))
|
||||
L += [blob(c, r) for c, _, r in blobs if c.startswith('of_')]
|
||||
L.append('};')
|
||||
with open(out, 'w', newline='\n') as f:
|
||||
f.write('\n'.join(L) + '\n')
|
||||
total = sum(len(s) for _, s, _ in blobs)
|
||||
print('%s: %d shaders, %d KB of SPIR-V' % (out, len(blobs), total // 1024))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@@ -366,6 +366,7 @@ def collect_licenses(out):
|
||||
(unpack('sdl3-dll') / 'LICENSE.txt', 'SDL3-LICENSE.txt'),
|
||||
(unpack('zstd') / 'ucrt64' / 'share' / 'licenses' / 'zstd' / 'LICENSE', 'zstd-LICENSE.txt'),
|
||||
(ROOT / 'runtime' / 'shaders' / 'ffx' / 'LICENSE.txt', 'FidelityFX-FSR-LICENSE.txt'),
|
||||
(ROOT / 'runtime' / 'third_party' / 'FidelityFX' / 'LICENSE.txt', 'FidelityFX-SDK-LICENSE.txt'),
|
||||
(MAIN_ROOT / 'toolchain' / 'hactool' / 'LICENSE', 'hactool-LICENSE.txt'),
|
||||
(MAIN_ROOT / 'refs' / 'MacNativeGames' / 'LICENSE', 'MacNativeGames-LICENSE.txt'),
|
||||
]
|
||||
|
||||
@@ -408,6 +408,7 @@ def collect_licenses(out, sysroot):
|
||||
(WORK / 'zstd' / 'LICENSE', 'zstd-LICENSE.txt'),
|
||||
(out / 'python' / 'lib' / f'python{sys_version(out)}' / 'LICENSE.txt', 'python-LICENSE.txt'),
|
||||
(ROOT / 'runtime' / 'shaders' / 'ffx' / 'LICENSE.txt', 'FidelityFX-FSR-LICENSE.txt'),
|
||||
(ROOT / 'runtime' / 'third_party' / 'FidelityFX' / 'LICENSE.txt', 'FidelityFX-SDK-LICENSE.txt'),
|
||||
(WORK / 'hactool-linux' / 'LICENSE', 'hactool-LICENSE.txt'),
|
||||
(MAIN_ROOT / 'refs' / 'MacNativeGames' / 'LICENSE', 'MacNativeGames-LICENSE.txt'),
|
||||
]
|
||||
|
||||
Reference in new issue
Block a user