AMD Capsaicin Framework v1.3

Author: kurbeco

.clang-format

@@ -8,26 +8,33 @@ AlignConsecutiveAssignments: Consecutive
 AlignConsecutiveBitFields: Consecutive
 AlignConsecutiveDeclarations: Consecutive
 AlignConsecutiveMacros: Consecutive
-#AlignConsecutiveShortCaseStatements: true 
+AlignConsecutiveShortCaseStatements:
+  Enabled: true
+  AcrossEmptyLines: false
+  AcrossComments: false
+  AlignCaseColons: false
 AlignEscapedNewlines: Left
 AlignOperands: AlignAfterOperator
 AlignTrailingComments: true
 AllowAllArgumentsOnNextLine: true
 AllowAllConstructorInitializersOnNextLine: true
 AllowAllParametersOfDeclarationOnNextLine: true
-#AllowBreakBeforeNoexceptSpecifier: Never
+AllowBreakBeforeNoexceptSpecifier: Never
 AllowShortBlocksOnASingleLine: Empty
+#AllowShortCaseExpressionOnASingleLine : true
 AllowShortCaseLabelsOnASingleLine: true
-#AllowShortCompoundRequirementOnASingleLine: true
+AllowShortCompoundRequirementOnASingleLine: true
 AllowShortFunctionsOnASingleLine: Inline
 AllowShortIfStatementsOnASingleLine: WithoutElse
 AllowShortLambdasOnASingleLine: Inline
 AllowShortLoopsOnASingleLine: false
+#AllowShortNamespacesOnASingleLine : false;
 AlwaysBreakAfterDefinitionReturnType: None
 AlwaysBreakAfterReturnType: None
 AlwaysBreakBeforeMultilineStrings: false
 AlwaysBreakTemplateDeclarations: Yes
 BinPackArguments: true
+#BinPackLongBracedList : true
 BinPackParameters: true
 BitFieldColonSpacing: Both
 BraceWrapping:
@@ -48,14 +55,16 @@ BraceWrapping:
   SplitEmptyFunction: false
   SplitEmptyRecord: false
   SplitEmptyNamespace: false
-#BreakAdjacentStringLiterals: true
+BreakAdjacentStringLiterals: true
 BreakAfterAttributes: Never
-#BreakAfterReturnType: Automatic
+#BreakAfterReturnType: ExceptShortType
 BreakBeforeBinaryOperators: NonAssignment
 BreakBeforeBraces: Custom
 BreakBeforeConceptDeclarations: true
+#BreakBeforeTemplateCloser: false
 BreakBeforeTernaryOperators: true
 BreakConstructorInitializers: BeforeComma
+#BreakFunctionDefinitionParameters: false
 BreakInheritanceList: BeforeComma
 BreakStringLiterals: false
 #BreakTemplateDeclarations: Yes
@@ -81,6 +90,7 @@ IncludeIsMainSourceRegex: '(.inl)$'
 IndentAccessModifiers: false
 IndentCaseBlocks: false
 IndentCaseLabels: false
+#IndentExportBlock: true
 IndentExternBlock: NoIndent
 IndentGotoLabels: false
 IndentPPDirectives: AfterHash
@@ -89,8 +99,16 @@ IndentWidth: 4
 IndentWrappedFunctionNames: false
 InsertBraces: true
 InsertNewlineAtEOF: true
+IntegerLiteralSeparator:
+  Binary: -1
+  Decimal: -1
+  Hex: -1
 KeepEmptyLinesAtEOF: true
 KeepEmptyLinesAtTheStartOfBlocks: false
+#KeepEmptyLines:
+#  AtEndOfFile: true
+#  AtStartOfBlock: false
+#  AtStartOfFile: false
 LambdaBodyIndentation: Signature
 LineEnding: LF
 #MainIncludeChar: Quote
@@ -103,13 +121,14 @@ QualifierAlignment: Custom
 QualifierOrder: ['inline', 'static', 'constexpr', 'volatile', 'type', 'restrict', 'const' ]
 ReferenceAlignment: Pointer
 ReflowComments: true
+#RemoveEmptyLinesInUnwrappedLines: true
 RemoveParentheses: Leave
 RemoveSemicolon: true
 RequiresClausePosition: OwnLine
 RequiresExpressionIndentation: OuterScope
 SeparateDefinitionBlocks: Always
 ShortNamespaceLines: 0
-#SkipMacroDefinitionBody: false
+SkipMacroDefinitionBody: false
 SortIncludes: true
 SortUsingDeclarations: true
 SpaceAfterCStyleCast: false
@@ -138,7 +157,7 @@ SpacesInParens: Never
 SpacesInParentheses: false
 SpacesInSquareBrackets: false
 TabWidth: 4
-UseCRLF: false
 UseTab: Never
+#WrapNamespaceBodyWithEmptyLines: Never
 ...
 

.gitignore

@@ -5,4 +5,8 @@ imgui.ini
 .vs
 out/
 cache/
+.cache/
 shader_cache/
+shader_pdb/
+dump/
+compile_commands.json

CMakeLists.txt

@@ -1,5 +1,6 @@
-cmake_minimum_required(VERSION 3.25.0)
+cmake_minimum_required(VERSION 3.30)
 cmake_policy(SET CMP0141 NEW)
+cmake_policy(SET CMP0168 NEW)
 
 project(Capsaicin
     LANGUAGES CXX
@@ -9,6 +10,14 @@ project(Capsaicin
 
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 
+# Check if submodules have been initialized
+if(NOT EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/third_party/gfx/CMakeLists.txt)
+    find_package(Git REQUIRED)
+    execute_process(COMMAND ${GIT_EXECUTABLE} submodule update --init --recursive
+        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+    )
+endif()
+
 # Disable unused parameters from 3rd party directories
 set(GFX_BUILD_EXAMPLES            OFF CACHE BOOL "")
 set(BUILD_TESTING                 OFF CACHE BOOL "")
@@ -26,11 +35,11 @@ set(BUILD_SHARED_LIBS OFF CACHE INTERNAL "" FORCE)
 FetchContent_Declare(
     CLI11
     GIT_REPOSITORY https://github.com/CLIUtils/CLI11.git
-    GIT_TAG        v2.4.2
+    GIT_TAG        v2.5.0
     GIT_SHALLOW    TRUE
     GIT_PROGRESS   TRUE
-    SOURCE_DIR     "${CMAKE_CURRENT_SOURCE_DIR}/third_party/cli11/"
-    FIND_PACKAGE_ARGS 2.0.0 NAMES CLI11
+    SOURCE_DIR     "${CMAKE_CURRENT_SOURCE_DIR}/third_party/cli11"
+    FIND_PACKAGE_ARGS NAMES CLI11
 )
 FetchContent_MakeAvailable(CLI11)
 if(NOT CLI11_FOUND)
@@ -40,11 +49,11 @@ endif()
 FetchContent_Declare(
     yaml-cpp
     GIT_REPOSITORY https://github.com/jbeder/yaml-cpp.git
-    GIT_TAG        0.8.0
-    GIT_SHALLOW    TRUE
+    GIT_TAG        2f86d13775d119edbb69af52e5f566fd65c6953b
+    GIT_SHALLOW    FALSE
     GIT_PROGRESS   TRUE
-    SOURCE_DIR     "${CMAKE_CURRENT_SOURCE_DIR}/third_party/yaml-cpp/"
-    FIND_PACKAGE_ARGS 0.7.0 NAMES yaml-cpp
+    SOURCE_DIR     "${CMAKE_CURRENT_SOURCE_DIR}/third_party/yaml-cpp"
+    FIND_PACKAGE_ARGS NAMES yaml-cpp
 )
 set(YAML_CPP_BUILD_TOOLS OFF CACHE BOOL "")
 FetchContent_MakeAvailable(yaml-cpp)
@@ -55,10 +64,10 @@ endif()
 FetchContent_Declare(
     nlohmann_json
     GIT_REPOSITORY https://github.com/nlohmann/json.git
-    GIT_TAG        v3.11.3
+    GIT_TAG        v3.12.0
     GIT_SHALLOW    TRUE
     GIT_PROGRESS   TRUE
-    SOURCE_DIR     "${CMAKE_CURRENT_SOURCE_DIR}/third_party/nlohmann_json/"
+    SOURCE_DIR     "${CMAKE_CURRENT_SOURCE_DIR}/third_party/nlohmann_json"
     FIND_PACKAGE_ARGS NAMES nlohmann_json
 )
 FetchContent_MakeAvailable(nlohmann_json)
@@ -69,10 +78,10 @@ endif()
 FetchContent_Declare(
     meshoptimizer
     GIT_REPOSITORY https://github.com/zeux/meshoptimizer.git
-    GIT_TAG        v0.22
+    GIT_TAG        v0.24
     GIT_SHALLOW    TRUE
     GIT_PROGRESS   TRUE
-    SOURCE_DIR     "${CMAKE_CURRENT_SOURCE_DIR}/third_party/meshoptimizer/"
+    SOURCE_DIR     "${CMAKE_CURRENT_SOURCE_DIR}/third_party/meshoptimizer"
     FIND_PACKAGE_ARGS NAMES meshoptimizer
 )
 FetchContent_MakeAvailable(meshoptimizer)
@@ -81,6 +90,36 @@ if(NOT meshoptimizer_FOUND)
     add_library(meshoptimizer::meshoptimizer ALIAS meshoptimizer)
 endif()
 
+set(CAPSAICIN_FFX_SDK_PATH "${CMAKE_CURRENT_SOURCE_DIR}/third_party/FidelityFX-SDK")
+FetchContent_Declare(
+    FidelityFXSDK
+    GIT_REPOSITORY https://github.com/GPUOpen-LibrariesAndSDKs/FidelityFX-SDK.git
+    GIT_TAG        v2.0.0
+    GIT_SHALLOW    TRUE
+    GIT_PROGRESS   TRUE
+    SOURCE_DIR     "${CAPSAICIN_FFX_SDK_PATH}"
+)
+FetchContent_MakeAvailable(FidelityFXSDK)
+
+add_library(ffx_fsr SHARED IMPORTED)
+set_target_properties(ffx_fsr PROPERTIES
+    IMPORTED_LOCATION "${CAPSAICIN_FFX_SDK_PATH}/Kits/FidelityFX/signedbin/amd_fidelityfx_upscaler_dx12.dll"
+    IMPORTED_IMPLIB "${CAPSAICIN_FFX_SDK_PATH}/Kits/FidelityFX/signedbin/amd_fidelityfx_loader_dx12.lib"
+    INTERFACE_INCLUDE_DIRECTORIES "${CAPSAICIN_FFX_SDK_PATH}/Kits/FidelityFX/upscalers/include"
+)
+add_library(ffx_fg SHARED IMPORTED)
+set_target_properties(ffx_fg PROPERTIES
+    IMPORTED_LOCATION "${CAPSAICIN_FFX_SDK_PATH}/Kits/FidelityFX/signedbin/amd_fidelityfx_framegeneration_dx12.dll"
+    IMPORTED_IMPLIB "${CAPSAICIN_FFX_SDK_PATH}/Kits/FidelityFX/signedbin/amd_fidelityfx_loader_dx12.lib"
+)
+add_library(ffx_loader SHARED IMPORTED)
+set_target_properties(ffx_loader PROPERTIES
+    IMPORTED_LOCATION "${CAPSAICIN_FFX_SDK_PATH}/Kits/FidelityFX/signedbin/amd_fidelityfx_loader_dx12.dll"
+    IMPORTED_IMPLIB "${CAPSAICIN_FFX_SDK_PATH}/Kits/FidelityFX/signedbin/amd_fidelityfx_loader_dx12.lib"
+    INTERFACE_INCLUDE_DIRECTORIES "${CAPSAICIN_FFX_SDK_PATH}/Kits/FidelityFX/api/include"
+)
+target_link_libraries(ffx_loader INTERFACE ffx_fsr ffx_fg)
+
 option(CAPSAICIN_DOWNLOAD_TEST_MEDIA "Download test media scenes" ON)
 if(CAPSAICIN_DOWNLOAD_TEST_MEDIA)
     FetchContent_Declare(
@@ -89,7 +128,7 @@ if(CAPSAICIN_DOWNLOAD_TEST_MEDIA)
         GIT_TAG        v1.2
         GIT_SHALLOW    TRUE
         GIT_PROGRESS   TRUE
-        SOURCE_DIR     "${CMAKE_CURRENT_SOURCE_DIR}/assets/CapsaicinTestMedia/"
+        SOURCE_DIR     "${CMAKE_CURRENT_SOURCE_DIR}/assets/CapsaicinTestMedia"
     )
     FetchContent_MakeAvailable(CapsaicinTestMedia)
 endif()

README.md

@@ -15,39 +15,38 @@ Features:
 
 ![Capsaicin](docs/images/scene_viewer.png)
 
-## GI-1.1
+## GI-1.2
 
-We used Capsaicin to implement our GI-1.1 technique for estimating diffuse and specular indirect illumination in real-time.
+We used Capsaicin to implement our GI-1.2 technique for estimating diffuse and specular indirect illumination in real-time.
 
 The technique uses two levels of radiance caching to allow for reduced sampling rate in order to improve performance while making the most of every ray through better sampling.
 
 Please refer to our [GI-1.0 technical report](https://gpuopen.com/download/publications/GPUOpen2022_GI1_0.pdf) and [GI-1.1 paper](https://gpuopen.com/download/publications/SA2023_RealTimeReflection.pdf) for more technical details.
 
 #### Note on light support
 
-GI-1.1 is primarily an indirect lighting solution and as such is expected to be combined with an existing direct lighting technique for integration into a rendering pipeline.
+GI-1.2 is primarily an indirect lighting solution and as such is expected to be combined with an existing direct lighting technique for integration into a rendering pipeline.
 
 All common light types are supported when evaluating the indirect lighting component (e.g., point lights, spot lights, etc.) using our grid-based light sampler and (optional) reservoir-based resampling.
 
 Furthermore the technique can estimate direct lighting through its probe system for a subset of lights; namely emissive meshes and skylights.
 
 ## Prerequisites
 
-- Direct3D12 capable hardware and OS (Windows 10 20H2 or newer)
-- [Windows 10 SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk/) or newer
-- CMake 3.24 or newer (can use Visual Studio, VSCode or any other CMake supported IDE)
-- DirectX Raytracing capable GPU and compatible drivers
+- Direct3D12 Ultimate capable hardware and OS (Windows 10 20H2 or newer)
+- [Windows 10 SDK 2004](https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk/) or newer
+- CMake 3.30 or newer (can use Visual Studio, VSCode or any other CMake supported IDE)
 
 ## Building
 
 Capsaicin uses submodules to include any essential dependencies.
 
 The following submodules are required:
-- gfx: Contains gfx D3D12 abstraction library (located in "third_party/" subfolder
+- gfx: Contains gfx D3D12 abstraction library (located in "third_party/gfx" subfolder
 
 When acquiring the code make sure to clone the repo with submodules included:
 
-`git clone --recurse-submodules https://github.com/Radeon-Pro/Capsaicin`
+`git clone --recurse-submodules https://github.com/GPUOpen-LibrariesAndSDKs/Capsaicin.git`
 
 If you have already cloned this repo without submodules, then use:
 
@@ -74,7 +73,7 @@ If Capsaicin is used in any published work, ensure to cite it using:
    title =  {The {AMD Capsaicin Framework}},
    year =   {2023},
    month =  {8},
-   url =    {https://github.com/Radeon-Pro/Capsaicin_Open},
+   url =    {https://github.com/GPUOpen-LibrariesAndSDKs/Capsaicin},
 }
 ```
 

docs/development/getting_started.md

@@ -6,7 +6,7 @@
 
 When acquiring the code make sure to clone the repo with submodules included:
 
-`git clone --recurse-submodules https://github.com/Radeon-Pro/Capsaicin`
+`git clone --recurse-submodules https://github.com/GPUOpen-LibrariesAndSDKs/Capsaicin`
 
 If you have already cloned this repo without submodules, then use:
 
@@ -36,9 +36,7 @@ The used third party dependencies and there expected names are:
 - CLI11: CLI11 is a command line parser for C++11 and beyond
 - yaml-cpp: yaml-cpp is a YAML parser and emitter in C++
 - nlohmann-json: JSON for Modern C++
-- onnxruntime-gpu: Cross-platform, high performance ML inferencing and training accelerator 
-- directml: High-performance, hardware-accelerated DirectX 12 library for machine learning
-- gtest: Google Testing and Mocking Framework (only used when testing enabled)
+- meshoptimizer: Mesh optimization library that makes meshes smaller and faster to render
 - gfx third party dependencies:
     - d3d12-memory-allocator: Easy to integrate D3d12 memory allocation library from GPUOpen
     - DirectX12-Agility: DirectX 12 Agility SDK

dump/.gitignore

@@ -15,6 +15,7 @@ file(GLOB_RECURSE CAPSAICIN_SHADER_FILES
     ${CMAKE_CURRENT_SOURCE_DIR}/src/*.task
     ${CMAKE_CURRENT_SOURCE_DIR}/src/*.comp
     ${CMAKE_CURRENT_SOURCE_DIR}/src/*.hlsl
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/*.hlsli
     ${CMAKE_CURRENT_SOURCE_DIR}/src/*.rt
     ${CMAKE_CURRENT_SOURCE_DIR}/src/*_shared.h
 )
@@ -78,11 +79,16 @@ if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
     target_compile_options(capsaicin PRIVATE $<$<COMPILE_LANGUAGE:CXX>:-Wall -Wextra -pedantic -Werror>)
 elseif("${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC")
     target_compile_options(capsaicin PRIVATE $<$<COMPILE_LANGUAGE:CXX>:/MP /W4 /WX /experimental:external /external:anglebrackets /external:W0 /analyze:external->)
+    target_compile_options(capsaicin PRIVATE $<$<COMPILE_LANGUAGE:CXX>:/wd28020>) # The expression 'expr' is not true at this call - currently bugged
 elseif("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
-    if("${CMAKE_CXX_SIMULATE_ID}" STREQUAL "MSVC")
+    if("${CMAKE_CXX_COMPILER_FRONTEND_VARIANT}" STREQUAL "MSVC")
         target_compile_options(capsaicin PRIVATE $<$<COMPILE_LANGUAGE:CXX>:/W4 /WX>)
+        target_compile_options(capsaicin PRIVATE $<$<COMPILE_LANGUAGE:CXX>:-Wno-cast-function-type-mismatch>) # cast from 'FARPROC' X to Y converts to incompatible function type
     else()
         target_compile_options(capsaicin PRIVATE $<$<COMPILE_LANGUAGE:CXX>:-Wall -Wextra -pedantic -Werror>)
+        target_compile_options(capsaicin PRIVATE $<$<COMPILE_LANGUAGE:CXX>:-Wno-microsoft-enum-value>) # enumerator value is not representable in the underlying type 'int'
+        target_compile_options(capsaicin PRIVATE $<$<COMPILE_LANGUAGE:CXX>:-Wno-language-extension-token>) # extension used
+        target_compile_options(capsaicin PRIVATE $<$<COMPILE_LANGUAGE:CXX>:-Wno-cast-function-type-mismatch>) # cast from 'FARPROC' X to Y converts to incompatible function type
     endif()
 endif()
 
@@ -92,7 +98,7 @@ if(CMAKE_SYSTEM_PROCESSOR MATCHES "(x86)|(X86)|(amd64)|(AMD64)")
     elseif("${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC")
         target_compile_options(capsaicin PRIVATE /arch:AVX2)
     elseif("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
-        if("${CMAKE_CXX_SIMULATE_ID}" STREQUAL "MSVC")
+        if("${CMAKE_CXX_COMPILER_FRONTEND_VARIANT}" STREQUAL "MSVC")
             target_compile_options(capsaicin PRIVATE /arch:AVX2)
         else()
             target_compile_options(capsaicin PRIVATE -march=x86-64-v3)
@@ -104,7 +110,9 @@ target_compile_definitions(capsaicin PRIVATE
     GLM_FORCE_XYZW_ONLY
     GLM_FORCE_DEPTH_ZERO_TO_ONE
 )
-if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC" OR "${CMAKE_CXX_SIMULATE_ID}" STREQUAL "MSVC")
+include(CheckCXXSymbolExists)
+check_cxx_symbol_exists(_MSVC_STL_VERSION version MSVCSTL)
+if(MSVCSTL)
     target_compile_definitions(capsaicin PRIVATE
         _CRT_SECURE_NO_WARNINGS
         _HAS_EXCEPTIONS=0
@@ -114,8 +122,6 @@ if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC" OR "${CMAKE_CXX_SIMULATE_ID}" STRE
     )
 endif()
 
-target_link_options(capsaicin PRIVATE "/SUBSYSTEM:WINDOWS")
-
 function(assign_source_group arg1)
     foreach(_source IN ITEMS ${ARGN})
         get_filename_component(PARENT_DIR "${_source}" DIRECTORY)
@@ -156,15 +162,15 @@ else()
 endif()
 
 if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/../../third_party/gfx/third_party/imgui")
-    target_include_directories(capsaicin PRIVATE "${CMAKE_CURRENT_SOURCE_DIR}/../../third_party/gfx/third_party/imgui"  
+    target_include_directories(capsaicin PRIVATE "${CMAKE_CURRENT_SOURCE_DIR}/../../third_party/gfx/third_party/imgui"
             "${CMAKE_CURRENT_SOURCE_DIR}/../../third_party/gfx/third_party/imgui/misc/cpp")
 else()
     find_package(imgui REQUIRED)
     target_link_libraries(capsaicin PUBLIC imgui::imgui)
 endif()
 
 target_link_libraries(capsaicin PUBLIC gfx
-    PRIVATE yaml-cpp::yaml-cpp meshoptimizer::meshoptimizer)
+    PRIVATE ffx_loader yaml-cpp::yaml-cpp meshoptimizer::meshoptimizer)
 
 set_target_properties(capsaicin PROPERTIES
     RUNTIME_OUTPUT_DIRECTORY ${CAPSAICIN_RUNTIME_OUTPUT_DIRECTORY}