Merge pull request #12 from royshil/roy.add_openblas

Add OpenBLAS acceleration on Windows
2024-11-07 18:57:14 +00:00 · 2023-09-12 01:27:28 -04:00 · 2023-09-12 01:27:28 -04:00 · 845710ea6b
commit 845710ea6b
parent 16b5a17f26 91b259e643
6 changed files with 139 additions and 28 deletions
--- a/.github/scripts/Build-Windows.ps1
+++ b/.github/scripts/Build-Windows.ps1
@ -6,7 +6,8 @@ param(
    [string] $Configuration = 'RelWithDebInfo',
    [switch] $SkipAll,
    [switch] $SkipBuild,
-    [switch] $SkipDeps
+    [switch] $SkipDeps,
+    [string] $ExtraCmakeArgs
 )

 $ErrorActionPreference = 'Stop'
@ -56,7 +57,8 @@ function Build {
    if ( ! ( ( $SkipAll ) -or ( $SkipBuild ) ) ) {
        Ensure-Location $ProjectRoot

-        $CmakeArgs = @()
+        # take cmake args from $ExtraCmakeArgs
+        $CmakeArgs = @($ExtraCmakeArgs)
        $CmakeBuildArgs = @()
        $CmakeInstallArgs = @()

--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@ -7,6 +7,8 @@ project(${_name} VERSION ${_version})
 option(ENABLE_FRONTEND_API "Use obs-frontend-api for UI functionality" ON)
 option(ENABLE_QT "Use Qt functionality" ON)

+option(LOCALVOCAL_WITH_CUDA "Build with CUDA support. (Windows, CUDA toolkit required)" OFF)
+
 include(compilerconfig)
 include(defaults)
 include(helpers)
--- a/README.md
+++ b/README.md
@ -77,3 +77,22 @@ Use the CI scripts again, for example:
 ```

 The build should exist in the `./release` folder off the root. You can manually install the files in the OBS directory.
+
+#### Building with CUDA support on Windows
+
+To build with CUDA support on Windows, you need to install the CUDA toolkit from NVIDIA. The CUDA toolkit is available for download from [here](https://developer.nvidia.com/cuda-downloads).
+
+After installing the CUDA toolkit, you need to set variables to point CMake to the CUDA toolkit installation directory. For example, if you have installed the CUDA toolkit in `C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v11.4`, you need to set `CUDA_TOOLKIT_ROOT_DIR` to `C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v11.4` and `LOCALVOCAL_WITH_CUDA` to `ON` when running `.github/scripts/Build-Windows.ps1`.
+
+For example
+```powershell
+> .github/scripts/Build-Windows.ps1 -Target x64 -ExtraCmakeFlags "-D LOCALVOCAL_WITH_CUDA=ON -D CUDA_TOOLKIT_ROOT_DIR='C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v11.4'"
+```
+
+You will need to copy a few CUDA .dll files to the location of the plugin .dll for it to run. The required .dll files from CUDA (which are located in the `bin` folder of the CUDA toolkit installation directory) are:
+
+- `cudart64_NN.dll`
+- `cublas64_NN.dll`
+- `cublasLt64_NN.dll`
+
+where `NN` is the CUDA version number. For example, if you have installed CUDA 11.4 then `NN` is likely `11`.
--- a/cmake/BuildMyCurl.cmake
+++ b/cmake/BuildMyCurl.cmake
@ -18,8 +18,18 @@ elseif(OS_LINUX)
 endif()
 set(BUILD_CURL_EXE OFF)
 set(BUILD_SHARED_LIBS OFF)
-set(HTTP_ONLY OFF)
+set(HTTP_ONLY ON)
 set(CURL_USE_LIBSSH2 OFF)
+set(CURL_DISABLE_FTP ON)
+set(CURL_DISABLE_LDAP ON)
+set(CURL_DISABLE_LDAPS ON)
+set(CURL_DISABLE_TELNET ON)
+set(CURL_DISABLE_MQTT ON)
+set(CURL_DISABLE_POP3 ON)
+set(CURL_DISABLE_RTMP ON)
+set(CURL_DISABLE_SMTP ON)
+set(CURL_DISABLE_GOPHER ON)
+
 add_subdirectory(${LIBCURL_SOURCE_DIR} EXCLUDE_FROM_ALL)
 if(OS_MACOS)
  target_compile_options(
--- a/cmake/BuildWhispercpp.cmake
+++ b/cmake/BuildWhispercpp.cmake
@ -13,38 +13,115 @@ if(UNIX AND NOT APPLE)
  set(WHISPER_EXTRA_CXX_FLAGS "-fPIC")
 endif()

-ExternalProject_Add(
-  Whispercpp_Build
-  DOWNLOAD_EXTRACT_TIMESTAMP true
-  GIT_REPOSITORY https://github.com/ggerganov/whisper.cpp.git
-  GIT_TAG 7b374c9ac9b9861bb737eec060e4dfa29d229259
-  BUILD_COMMAND ${CMAKE_COMMAND} --build <BINARY_DIR> --config ${Whispercpp_BUILD_TYPE}
-  BUILD_BYPRODUCTS <INSTALL_DIR>/lib/static/${CMAKE_STATIC_LIBRARY_PREFIX}whisper${CMAKE_STATIC_LIBRARY_SUFFIX}
-  CMAKE_GENERATOR ${CMAKE_GENERATOR}
-  INSTALL_COMMAND ${CMAKE_COMMAND} --install <BINARY_DIR> --config ${Whispercpp_BUILD_TYPE}
-  CMAKE_ARGS -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>
-             -DCMAKE_BUILD_TYPE=${Whispercpp_BUILD_TYPE}
-             -DCMAKE_GENERATOR_PLATFORM=${CMAKE_GENERATOR_PLATFORM}
-             -DCMAKE_OSX_DEPLOYMENT_TARGET=10.13
-             -DCMAKE_OSX_ARCHITECTURES=${CMAKE_OSX_ARCHITECTURES_}
-             -DCMAKE_CXX_FLAGS=${WHISPER_EXTRA_CXX_FLAGS}
-             -DCMAKE_C_FLAGS=${WHISPER_EXTRA_CXX_FLAGS}
-             -DBUILD_SHARED_LIBS=OFF
-             -DWHISPER_BUILD_TESTS=OFF
-             -DWHISPER_BUILD_EXAMPLES=OFF
-             -DWHISPER_OPENBLAS=ON)
+# if on Windows - download OpenBLAS prebuilt binaries
+if(WIN32)
+  if(LOCALVOCAL_WITH_CUDA)
+    # Build with CUDA Check that CUDA_TOOLKIT_ROOT_DIR is set
+    if(NOT DEFINED CUDA_TOOLKIT_ROOT_DIR)
+      message(FATAL_ERROR "CUDA_TOOLKIT_ROOT_DIR is not set. Please set it to the root directory of your CUDA "
+                          "installation.")
+    endif(NOT DEFINED CUDA_TOOLKIT_ROOT_DIR)
+
+    set(WHISPER_ADDITIONAL_ENV "CUDAToolkit_ROOT=${CUDA_TOOLKIT_ROOT_DIR}")
+    set(WHISPER_ADDITIONAL_CMAKE_ARGS -DWHISPER_CUBLAS=ON -DCMAKE_GENERATOR_TOOLSET=cuda=${CUDA_TOOLKIT_ROOT_DIR})
+  else(LOCALVOCAL_WITH_CUDA)
+    # Build with OpenBLAS
+    set(OpenBLAS_URL "https://github.com/xianyi/OpenBLAS/releases/download/v0.3.24/OpenBLAS-0.3.24-x64.zip")
+    set(OpenBLAS_SHA256 "8E777E406BA7030D21ADB18683D6175E4FA5ADACFBC09982C01E81245B348132")
+    ExternalProject_Add(
+      OpenBLAS
+      URL ${OpenBLAS_URL}
+      URL_HASH SHA256=${OpenBLAS_SHA256}
+      DOWNLOAD_NO_PROGRESS true
+      CONFIGURE_COMMAND ""
+      BUILD_COMMAND ""
+      INSTALL_COMMAND ${CMAKE_COMMAND} -E copy_directory <SOURCE_DIR> <INSTALL_DIR>)
+    ExternalProject_Get_Property(OpenBLAS INSTALL_DIR)
+    set(OpenBLAS_DIR ${INSTALL_DIR})
+    set(WHISPER_ADDITIONAL_ENV "OPENBLAS_PATH=${OpenBLAS_DIR}")
+    set(WHISPER_ADDITIONAL_CMAKE_ARGS -DWHISPER_BLAS=ON -DWHISPER_CUBLAS=OFF)
+  endif(LOCALVOCAL_WITH_CUDA)
+
+  ExternalProject_Add(
+    Whispercpp_Build
+    DOWNLOAD_EXTRACT_TIMESTAMP true
+    GIT_REPOSITORY https://github.com/ggerganov/whisper.cpp.git
+    GIT_TAG 7b374c9ac9b9861bb737eec060e4dfa29d229259
+    BUILD_COMMAND ${CMAKE_COMMAND} --build <BINARY_DIR> --config ${Whispercpp_BUILD_TYPE}
+    BUILD_BYPRODUCTS
+      <INSTALL_DIR>/lib/static/${CMAKE_STATIC_LIBRARY_PREFIX}whisper${CMAKE_STATIC_LIBRARY_SUFFIX}
+      <INSTALL_DIR>/bin/${CMAKE_SHARED_LIBRARY_PREFIX}whisper${CMAKE_SHARED_LIBRARY_SUFFIX}
+      <INSTALL_DIR>/lib/${CMAKE_IMPORT_LIBRARY_PREFIX}whisper${CMAKE_IMPORT_LIBRARY_SUFFIX}
+    CMAKE_GENERATOR ${CMAKE_GENERATOR}
+    INSTALL_COMMAND ${CMAKE_COMMAND} --install <BINARY_DIR> --config ${Whispercpp_BUILD_TYPE} && ${CMAKE_COMMAND} -E
+                    copy <BINARY_DIR>/${Whispercpp_BUILD_TYPE}/whisper.lib <INSTALL_DIR>/lib
+    CONFIGURE_COMMAND
+      ${CMAKE_COMMAND} -E env ${WHISPER_ADDITIONAL_ENV} ${CMAKE_COMMAND} <SOURCE_DIR> -B <BINARY_DIR> -G
+      ${CMAKE_GENERATOR} -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR> -DCMAKE_BUILD_TYPE=${Whispercpp_BUILD_TYPE}
+      -DCMAKE_GENERATOR_PLATFORM=${CMAKE_GENERATOR_PLATFORM} -DCMAKE_OSX_DEPLOYMENT_TARGET=10.13
+      -DCMAKE_OSX_ARCHITECTURES=${CMAKE_OSX_ARCHITECTURES_} -DCMAKE_CXX_FLAGS=${WHISPER_EXTRA_CXX_FLAGS}
+      -DCMAKE_C_FLAGS=${WHISPER_EXTRA_CXX_FLAGS} -DBUILD_SHARED_LIBS=ON -DWHISPER_BUILD_TESTS=OFF
+      -DWHISPER_BUILD_EXAMPLES=OFF ${WHISPER_ADDITIONAL_CMAKE_ARGS})
+
+  if(NOT LOCALVOCAL_WITH_CUDA)
+    add_dependencies(Whispercpp_Build OpenBLAS)
+  endif(NOT LOCALVOCAL_WITH_CUDA)
+else()
+  # On Linux and MacOS build a static Whisper library
+  ExternalProject_Add(
+    Whispercpp_Build
+    DOWNLOAD_EXTRACT_TIMESTAMP true
+    GIT_REPOSITORY https://github.com/ggerganov/whisper.cpp.git
+    GIT_TAG 7b374c9ac9b9861bb737eec060e4dfa29d229259
+    BUILD_COMMAND ${CMAKE_COMMAND} --build <BINARY_DIR> --config ${Whispercpp_BUILD_TYPE}
+    BUILD_BYPRODUCTS <INSTALL_DIR>/lib/static/${CMAKE_STATIC_LIBRARY_PREFIX}whisper${CMAKE_STATIC_LIBRARY_SUFFIX}
+    CMAKE_GENERATOR ${CMAKE_GENERATOR}
+    INSTALL_COMMAND ${CMAKE_COMMAND} --install <BINARY_DIR> --config ${Whispercpp_BUILD_TYPE}
+    CONFIGURE_COMMAND
+      ${CMAKE_COMMAND} -E env OPENBLAS_PATH=${OpenBLAS_DIR} ${CMAKE_COMMAND} <SOURCE_DIR> -B <BINARY_DIR> -G
+      ${CMAKE_GENERATOR} -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR> -DCMAKE_BUILD_TYPE=${Whispercpp_BUILD_TYPE}
+      -DCMAKE_GENERATOR_PLATFORM=${CMAKE_GENERATOR_PLATFORM} -DCMAKE_OSX_DEPLOYMENT_TARGET=10.13
+      -DCMAKE_OSX_ARCHITECTURES=${CMAKE_OSX_ARCHITECTURES_} -DCMAKE_CXX_FLAGS=${WHISPER_EXTRA_CXX_FLAGS}
+      -DCMAKE_C_FLAGS=${WHISPER_EXTRA_CXX_FLAGS} -DBUILD_SHARED_LIBS=OFF -DWHISPER_BUILD_TESTS=OFF
+      -DWHISPER_BUILD_EXAMPLES=OFF -DWHISPER_BLAS=OFF)
+endif(WIN32)

 ExternalProject_Get_Property(Whispercpp_Build INSTALL_DIR)

-add_library(Whispercpp::Whisper STATIC IMPORTED)
-set_target_properties(
-  Whispercpp::Whisper
-  PROPERTIES IMPORTED_LOCATION
-             ${INSTALL_DIR}/lib/static/${CMAKE_STATIC_LIBRARY_PREFIX}whisper${CMAKE_STATIC_LIBRARY_SUFFIX})
+# add the Whisper library to the link line
+if(WIN32)
+  add_library(Whispercpp::Whisper SHARED IMPORTED)
+  set_target_properties(
+    Whispercpp::Whisper
+    PROPERTIES IMPORTED_LOCATION ${INSTALL_DIR}/bin/${CMAKE_SHARED_LIBRARY_PREFIX}whisper${CMAKE_SHARED_LIBRARY_SUFFIX})
+  set_target_properties(
+    Whispercpp::Whisper
+    PROPERTIES IMPORTED_IMPLIB ${INSTALL_DIR}/lib/${CMAKE_STATIC_LIBRARY_PREFIX}whisper${CMAKE_STATIC_LIBRARY_SUFFIX})
+
+  install(FILES ${INSTALL_DIR}/bin/${CMAKE_SHARED_LIBRARY_PREFIX}whisper${CMAKE_SHARED_LIBRARY_SUFFIX}
+          DESTINATION "obs-plugins/64bit")
+
+  if(NOT LOCALVOCAL_WITH_CUDA)
+    # add openblas to the link line
+    add_library(Whispercpp::OpenBLAS STATIC IMPORTED)
+    set_target_properties(Whispercpp::OpenBLAS PROPERTIES IMPORTED_LOCATION ${OpenBLAS_DIR}/lib/libopenblas.dll.a)
+    install(FILES ${OpenBLAS_DIR}/bin/libopenblas.dll DESTINATION "obs-plugins/64bit")
+  endif(NOT LOCALVOCAL_WITH_CUDA)
+else()
+  # on Linux and MacOS add the static Whisper library to the link line
+  add_library(Whispercpp::Whisper STATIC IMPORTED)
+  set_target_properties(
+    Whispercpp::Whisper
+    PROPERTIES IMPORTED_LOCATION
+               ${INSTALL_DIR}/lib/static/${CMAKE_STATIC_LIBRARY_PREFIX}whisper${CMAKE_STATIC_LIBRARY_SUFFIX})
+endif(WIN32)

 add_library(Whispercpp INTERFACE)
 add_dependencies(Whispercpp Whispercpp_Build)
 target_link_libraries(Whispercpp INTERFACE Whispercpp::Whisper)
+if(WIN32 AND NOT LOCALVOCAL_WITH_CUDA)
+  target_link_libraries(Whispercpp INTERFACE Whispercpp::OpenBLAS)
+endif()
 set_target_properties(Whispercpp::Whisper PROPERTIES INTERFACE_INCLUDE_DIRECTORIES ${INSTALL_DIR}/include)
 if(APPLE)
  target_link_libraries(Whispercpp INTERFACE "-framework Accelerate")
--- a/src/whisper-processing.cpp
+++ b/src/whisper-processing.cpp
@ -78,6 +78,7 @@ struct whisper_context *init_whisper_context(const std::string &model_path)
 		obs_log(LOG_ERROR, "Failed to load whisper model");
 		return nullptr;
 	}
+	obs_log(LOG_INFO, "Whisper model loaded: %s", whisper_print_system_info());
 	return ctx;
 }