Fix Windows build with ONNX Runtime (#664)

umireon · web-flow · commit 387733c4f6a0 · 2025-11-07T05:58:59.000+09:00
* Refactor ONNX Runtime integration for platform support

Updated CMakeLists.txt to improve ONNX Runtime linking for Apple and MSVC platforms, including explicit handling of shared libraries and provider dependencies. Commented out DML provider code in ort-session-utils.cpp for Windows, likely due to build or compatibility issues.

* Update CMakeLists.txt

* Update CMakeLists.txt

* Update CMakeLists.txt

* Add Module.cpp for plugin lifecycle and DLL loading

Introduces src/Module.cpp to handle plugin load/unload events and custom DLL delay loading on Windows. Updates CMakeLists.txt to include the new source file and removes 'delayimp' from link libraries. Modifies plugin-main.c to call PluginLoaded and PluginUnloaded during module load/unload.

* Rename Module.cpp to DelayLoad.cpp and update references

Renamed src/Module.cpp to src/DelayLoad.cpp and updated CMakeLists.txt to reference the new filename. Removed PluginLoaded and PluginUnloaded calls from plugin-main.c to streamline plugin load/unload logic.

* Update DLL install and delay load handling for Windows

Adds installation of ONNX Runtime DLLs and PDBs to the Windows build in CMakeLists.txt. Refactors DelayLoad.cpp to resolve and load onnxruntime.dll from a specific plugin directory, improving reliability of DLL loading for the plugin.

* Update DelayLoad.cpp

* Refactor DelayLoad.cpp formatting and CMake install block

Reformatted DelayLoad.cpp for consistent indentation and style. Updated CMakeLists.txt to improve readability of the install() command by reformatting the file list.

* Remove DirectML support and related files

Deleted CMake scripts for ONNX Runtime integration and removed DirectML (DML) support from code, localization files, and documentation. This simplifies GPU provider options and cleans up unused Windows-specific code paths.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -105,25 +105,60 @@ if(USE_SYSTEM_ONNXRUNTIME)
   else()
     message(FATAL_ERROR "System ONNX Runtime is only supported on Linux!")
   endif()
+  target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE onnxruntime::onnxruntime)
+elseif(APPLE)
+  list(PREPEND CMAKE_PREFIX_PATH "${CMAKE_SOURCE_DIR}/onnxruntime")
+  find_package(onnxruntime CONFIG REQUIRED)
+  get_target_property(ONNXRUNTIME_DYLIB_PATH onnxruntime::onnxruntime IMPORTED_LOCATION_RELEASE)
+  target_sources(${CMAKE_PROJECT_NAME} PRIVATE "${ONNXRUNTIME_DYLIB_PATH}")
+  set_property(SOURCE "${ONNXRUNTIME_DYLIB_PATH}" PROPERTY MACOSX_PACKAGE_LOCATION Frameworks)
+  set_target_properties(
+    ${CMAKE_PROJECT_NAME}
+    PROPERTIES XCODE_ATTRIBUTE_LD_RUNPATH_SEARCH_PATHS "@loader_path/../Frameworks"
+  )
+  target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE onnxruntime::onnxruntime)
+elseif(MSVC)
+  set(ONNXRUNTIME_ROOT "${CMAKE_SOURCE_DIR}/onnxruntime")
+
+  add_library(onnxruntime::onnxruntime_provider_shared SHARED IMPORTED)
+  set_target_properties(
+    onnxruntime::onnxruntime_provider_shared
+    PROPERTIES
+      IMPORTED_IMPLIB "${ONNXRUNTIME_ROOT}/lib/onnxruntime_providers_shared.lib"
+      IMPORTED_LOCATION "${ONNXRUNTIME_ROOT}/lib/onnxruntime_providers_shared.dll"
+      INTERFACE_INCLUDE_DIRECTORIES "${ONNXRUNTIME_ROOT}/include"
+  )
+
+  add_library(onnxruntime::onnxruntime SHARED IMPORTED)
+  set_target_properties(
+    onnxruntime::onnxruntime
+    PROPERTIES
+      IMPORTED_IMPLIB "${ONNXRUNTIME_ROOT}/lib/onnxruntime.lib"
+      IMPORTED_LOCATION "${ONNXRUNTIME_ROOT}/lib/onnxruntime.dll"
+      INTERFACE_INCLUDE_DIRECTORIES "${ONNXRUNTIME_ROOT}/include"
+      INTERFACE_LINK_OPTIONS "/DELAYLOAD:onnxruntime.dll"
+  )
+  target_link_libraries(onnxruntime::onnxruntime INTERFACE onnxruntime::onnxruntime_provider_shared)
+
+  target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE onnxruntime::onnxruntime)
+  target_sources(${CMAKE_PROJECT_NAME} PRIVATE src/DelayLoad.cpp)
+
+  install(
+    FILES
+      "${ONNXRUNTIME_ROOT}/lib/onnxruntime.dll"
+      "${ONNXRUNTIME_ROOT}/lib/onnxruntime.pdb"
+      "${ONNXRUNTIME_ROOT}/lib/onnxruntime_providers_shared.dll"
+      "${ONNXRUNTIME_ROOT}/lib/onnxruntime_providers_shared.pdb"
+    DESTINATION "${CMAKE_PROJECT_NAME}/bin/64bit/obs-backgroundremoval"
+  )
 else()
   list(PREPEND CMAKE_PREFIX_PATH "${CMAKE_SOURCE_DIR}/onnxruntime")
   find_package(onnxruntime CONFIG REQUIRED)
-  if(APPLE)
-    get_target_property(ONNXRUNTIME_DYLIB_PATH onnxruntime::onnxruntime IMPORTED_LOCATION_RELEASE)
-    target_sources(${CMAKE_PROJECT_NAME} PRIVATE "${ONNXRUNTIME_DYLIB_PATH}")
-    set_property(SOURCE "${ONNXRUNTIME_DYLIB_PATH}" PROPERTY MACOSX_PACKAGE_LOCATION Frameworks)
-    set_target_properties(
-      ${CMAKE_PROJECT_NAME}
-      PROPERTIES XCODE_ATTRIBUTE_LD_RUNPATH_SEARCH_PATHS "@loader_path/../Frameworks"
-    )
-  endif()
+  target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE onnxruntime::onnxruntime)
 endif()
 
 add_subdirectory(src/update-checker/CurlClient)
-target_link_libraries(
-  ${CMAKE_PROJECT_NAME}
-  PRIVATE CurlClient OpenCV::opencv_core OpenCV::opencv_imgproc onnxruntime::onnxruntime
-)
+target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE CurlClient OpenCV::opencv_core OpenCV::opencv_imgproc)
 
 target_sources(
   ${CMAKE_PROJECT_NAME}
diff --git a/cmake/FetchOnnxruntime.cmake b/cmake/FetchOnnxruntime.cmake
diff --git a/cmake/FindOnnxruntime.cmake b/cmake/FindOnnxruntime.cmake
diff --git a/data/locale/ar-EG.ini b/data/locale/ar-EG.ini
@@ -9,7 +9,6 @@ InferenceDevice="جهاز الإستدلال"
 CPU="وحدة المعالجة المركزية"
 GPUCUDA="الوحدة المركزية - CUDA"
 GPUTensorRT="GPU - TensorRT"
-GPUDirectML="GPU - DirectML"
 CoreML="CoreML"
 SegmentationModel="نموذج التقسيم"
 SINet="SINet"
diff --git a/data/locale/bn-IN.ini b/data/locale/bn-IN.ini
@@ -9,7 +9,6 @@ InferenceDevice="নিখরচনা ডিভাইস"
 CPU="সিপিইউ"
 GPUCUDA="জিপিইউ - কুড়া"
 GPUTensorRT="জিপিইউ - টেনসরআরটি"
-GPUDirectML="জিপিইউ - ডিরেক্টএমএল"
 CoreML="কোরএমএল"
 SegmentationModel="সেগমেন্টেশন মডেল"
 SINet="এসআইনেট"
diff --git a/data/locale/en-US.ini b/data/locale/en-US.ini
@@ -9,7 +9,6 @@ InferenceDevice="Inference device"
 CPU="CPU"
 GPUCUDA="GPU - CUDA"
 GPUTensorRT="GPU - TensorRT"
-GPUDirectML="GPU - DirectML"
 CoreML="CoreML"
 SegmentationModel="Segmentation model"
 SINet="SINet"
diff --git a/data/locale/es-SP.ini b/data/locale/es-SP.ini
@@ -9,7 +9,6 @@ InferenceDevice="Dispositivo de inferencia"
 CPU="CPU"
 GPUCUDA="GPU - CUDA"
 GPUTensorRT="GPU - TensorRT"
-GPUDirectML="GPU - DirectML"
 CoreML="CoreML"
 SegmentationModel="Modelo de segmentación"
 SINet="SINet"
diff --git a/data/locale/fr-FR.ini b/data/locale/fr-FR.ini
@@ -9,7 +9,6 @@ InferenceDevice="Dispositif d'inférence"
 CPU="CPU"
 GPUCUDA="GPU - CUDA"
 GPUTensorRT="GPU - TensorRT"
-GPUDirectML="GPU - DirectML"
 CoreML="CoreML"
 SegmentationModel="Modèle de segmentation"
 SINet="SINet"
diff --git a/data/locale/hi-IN.ini b/data/locale/hi-IN.ini
@@ -9,7 +9,6 @@ InferenceDevice="संदर्भ डिवाइस"
 CPU="सीपीयू"
 GPUCUDA="जीपीयू - क्यूडा"
 GPUTensorRT="जीपीयू - टेंसरआरटी"
-GPUDirectML="जीपीयू - डायरेक्टएमएल"
 CoreML="कोरएमएल"
 SegmentationModel="सेगमेंटेशन मॉडल"
 SINet="ऐसआईनेट"
diff --git a/data/locale/it-IT.ini b/data/locale/it-IT.ini
@@ -9,7 +9,6 @@ InferenceDevice="Dispositivo di inferenza"
 CPU="CPU"
 GPUCUDA="GPU - CUDA"
 GPUTensorRT="GPU - TensorRT"
-GPUDirectML="GPU - DirectML"
 CoreML="CoreML"
 SegmentationModel="Modello di segmentazione".
 SINet="SINet"
diff --git a/data/locale/ja-JP.ini b/data/locale/ja-JP.ini
@@ -9,7 +9,6 @@ InferenceDevice="推論デバイス"
 CPU="CPU"
 GPUCUDA="GPU - CUDA"
 GPUTensorRT="GPU - TensorRT"
-GPUDirectML="GPU - DirectML"
 CoreML="CoreML"
 SegmentationModel="セグメンテーションモデル"
 SINet="SINet"
diff --git a/data/locale/ko-KR.ini b/data/locale/ko-KR.ini
@@ -9,7 +9,6 @@ InferenceDevice="추론 장치"
 CPU="CPU"
 GPUCUDA="GPU - CUDA"
 GPUTensorRT="GPU - TensorRT"
-GPUDirectML="GPU - DirectML"
 CoreML="CoreML"
 SegmentationModel="세분화 모델"
 SINet="SINet"
diff --git a/data/locale/pt-BR.ini b/data/locale/pt-BR.ini
@@ -9,7 +9,6 @@ InferenceDevice="Dispositivo de Inferência"
 CPU="CPU"
 GPUCUDA="GPU - CUDA"
 GPUTensorRT="GPU - TensorRT"
-GPUDirectML="GPU - DirectML"
 CoreML="CoreML"
 SegmentationModel="Modelo de segmentação"
 SINet="SINet"
diff --git a/data/locale/ru-RU.ini b/data/locale/ru-RU.ini
@@ -9,7 +9,6 @@ InferenceDevice="Устройство вывода"
 CPU="ЦПУ"
 GPUCUDA="ГПУ - CUDA"
 GPUTensorRT="ГПУ - TensorRT"
-GPUDirectML="ГПУ - DirectML"
 CoreML="CoreML"
 SegmentationModel="Модель сегментации"
 SINet="SINet"
diff --git a/data/locale/ta-IN.ini b/data/locale/ta-IN.ini
@@ -9,7 +9,6 @@ InferenceDevice="பரிமாற்ற சாதனம்"
 CPU="சிபியூ"
 GPUCUDA="GPU-CUDA"
 GPUTensorRT="GPU-TensorRT"
-GPUDirectML="GPU-DirectML"
 CoreML="CoreML"
 SegmentationModel="பிரிவு மாதிரி"
 SINet="SINet"
diff --git a/data/locale/tr-TR.ini b/data/locale/tr-TR.ini
@@ -9,7 +9,6 @@ InferenceDevice="Tahmin Cihazı"
 CPU="CPU"
 GPUCUDA="GPU - CUDA"
 GPUTensorRT="GPU - TensorRT"
-GPUDirectML="GPU - DirectML"
 CoreML="CoreML"
 SegmentationModel="Segmentasyon Modeli"
 SINet="SINet"
diff --git a/data/locale/zh-CN.ini b/data/locale/zh-CN.ini
@@ -9,7 +9,6 @@ InferenceDevice="推断设备"
 CPU="CPU"
 GPUCUDA="GPU-CUDA"
 GPUTensorRT="GPU-TensorRT"
-GPUDirectML="GPU-DirectML"
 CoreML="CoreML"
 SegmentationModel="分割模型"
 SINet="SINet"
diff --git a/docs/UNINSTALL.md b/docs/UNINSTALL.md
@@ -21,5 +21,5 @@ Uninstall obs-backgroundremoval on Apps and Programs.
 Remove the following files and directory under the OBS directory.
 
 - `data\obs-plugins\obs-backgroundremoval`
-- `obs-plugins\64bit\DirectML.dll`
 - `obs-plugins\64bit\obs-backgroundremoval.dll`
+- `obs-plugins\64bit\obs-backgroundremoval`
diff --git a/src/DelayLoad.cpp b/src/DelayLoad.cpp
diff --git a/src/background-filter.cpp b/src/background-filter.cpp
diff --git a/src/consts.h b/src/consts.h
diff --git a/src/enhance-filter.cpp b/src/enhance-filter.cpp
diff --git a/src/ort-utils/ort-session-utils.cpp b/src/ort-utils/ort-session-utils.cpp
