Fix Ubuntu packaging

Author: Tabby

.github/scripts/.build.zsh

@@ -65,7 +65,12 @@ build() {
     linux-aarch64
   )
   local target
-  local config='RelWithDebInfo'
+  if [[ "${+ACCELERATION}" == "amd" ]]
+  then
+    local config='Release'
+  else
+    local config='RelWithDebInfo'
+  fi
   local -r -a _valid_configs=(Debug RelWithDebInfo Release MinSizeRel)
   local -i codesign=0
 
@@ -250,7 +255,7 @@ ${_usage_host:-}"
           -G "${generator}"
           -DQT_VERSION=${QT_VERSION:-6}
           -DCMAKE_BUILD_TYPE=${config}
-          -DCMAKE_INSTALL_PREFIX=${project_root}/release/${config}
+          -DCMAKE_INSTALL_PREFIX=/usr
         )
 
         local cmake_version

.github/workflows/build-project.yaml

@@ -211,6 +211,23 @@ jobs:
     env:
       CI: 1
     steps:
+      - name: Free Disk Space (Ubuntu)
+        if: ${{ matrix.acceleration == 'amd' || matrix.acceleration == 'nvidia' }}
+        uses: jlumbroso/free-disk-space@main
+        with:
+          # this might remove tools that are actually needed,
+          # if set to "true" but frees about 6 GB
+          tool-cache: false
+          # Needs to be false to prevent running out of memory
+          swap-storage: false
+          # large-packages takes a long time so don't remove them unless we need to
+          large-packages: false
+
+          android: true
+          dotnet: true
+          haskell: true
+          docker-images: true
+
       - uses: actions/checkout@v4
         with:
           submodules: recursive
@@ -263,6 +280,29 @@ jobs:
 
       - uses: actions-rust-lang/setup-rust-toolchain@v1
 
+      # CUDA toolkit needed for linking against so it can be found when looking up package dependencies
+      - name: "Install CUDA toolkit 12.8"
+        if: ${{ matrix.acceleration == 'nvidia' }}
+        run: |
+          wget https://developer.download.nvidia.com/compute/cuda/repos/ubuntu2204/x86_64/cuda-keyring_1.1-1_all.deb
+          sudo dpkg -i cuda-keyring_1.1-1_all.deb
+          sudo apt update
+          sudo apt -y install cuda-12-8
+          export PATH=/usr/local/cuda-12.8/bin${PATH:+:${PATH}}
+          export LD_LIBRARY_PATH=/usr/local/cuda-12.8/lib ${LD_LIBRARY_PATH:+:${LD_LIBRARY_PATH}}
+
+      # hip SDK needed for linking against so it can be found when looking up package dependencies
+      - name: "Install AMD hip SDK v6.4.2"
+        if: ${{ matrix.acceleration == 'amd' }}
+        run: |
+          wget https://repo.radeon.com/amdgpu-install/6.4.2/ubuntu/jammy/amdgpu-install_6.4.60402-1_all.deb
+          sudo apt install ./amdgpu-install_6.4.60402-1_all.deb
+          sudo apt update
+          sudo apt install python3-setuptools python3-wheel
+          sudo usermod -a -G render,video $LOGNAME # Add the current user to the render and video groups
+          sudo apt install rocm
+          sudo apt update && sudo apt install hipblas
+
       - uses: actions/cache@v4
         id: ccache-cache
         with:
@@ -292,20 +332,20 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: ${{ steps.setup.outputs.pluginName }}-${{ steps.setup.outputs.pluginVersion }}-${{ matrix.acceleration }}-sources-${{ needs.check-event.outputs.commitHash }}
-          path: ${{ github.workspace }}/release/${{ steps.setup.outputs.pluginName }}-${{ steps.setup.outputs.pluginVersion }}-source.*
+          path: ${{ github.workspace }}/release/${{ steps.setup.outputs.pluginName }}-${{ steps.setup.outputs.pluginVersion }}-${{ matrix.acceleration }}-source.*
 
       - name: Upload Artifacts 📡
         uses: actions/upload-artifact@v4
         with:
           name: ${{ steps.setup.outputs.pluginName }}-${{ steps.setup.outputs.pluginVersion }}-${{ matrix.acceleration }}-ubuntu-22.04-x86_64-${{ needs.check-event.outputs.commitHash }}
-          path: ${{ github.workspace }}/release/${{ steps.setup.outputs.pluginName }}-${{ steps.setup.outputs.pluginVersion }}-x86_64*.*
+          path: ${{ github.workspace }}/release/${{ steps.setup.outputs.pluginName }}-${{ steps.setup.outputs.pluginVersion }}-${{ matrix.acceleration }}-x86_64*.*
 
       - name: Upload debug symbol artifacts 🪲
         uses: actions/upload-artifact@v4
-        if: ${{ fromJSON(needs.check-event.outputs.package) }}
+        if: ${{ fromJSON(needs.check-event.outputs.package) && (matrix.acceleration != 'amd') }}
         with:
           name: ${{ steps.setup.outputs.pluginName }}-${{ steps.setup.outputs.pluginVersion }}-${{ matrix.acceleration }}-ubuntu-22.04-x86_64-${{ needs.check-event.outputs.commitHash }}-dbgsym
-          path: ${{ github.workspace }}/release/${{ steps.setup.outputs.pluginName }}-${{ steps.setup.outputs.pluginVersion }}-x86_64*-dbgsym.ddeb
+          path: ${{ github.workspace }}/release/${{ steps.setup.outputs.pluginName }}-${{ steps.setup.outputs.pluginVersion }}-${{ matrix.acceleration }}-x86_64*-dbgsym.ddeb
 
   windows-build:
     name: Build for Windows 🪟

CMakeLists.txt

@@ -64,25 +64,19 @@ else()
   target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE libcurl)
 endif()
 
-if(WIN32
-   OR (UNIX
-       AND NOT APPLE
-       AND CI))
-  if(DEFINED ENV{ACCELERATION})
-    set(ACCELERATION
-        $ENV{ACCELERATION}
-        CACHE STRING "Acceleration to use" FORCE)
-  endif()
-  if(NOT DEFINED ACCELERATION)
-    set(ACCELERATION
-        "generic"
-        CACHE STRING "Acceleration to use")
-  endif()
-  set_property(CACHE ACCELERATION PROPERTY STRINGS "generic" "nvidia" "amd")
-elseif(
-  UNIX
-  AND NOT APPLE
-  AND NOT CI)
+if(DEFINED ENV{ACCELERATION})
+  set(ACCELERATION
+      $ENV{ACCELERATION}
+      CACHE STRING "Acceleration to use" FORCE)
+endif()
+if(NOT DEFINED ACCELERATION)
+  set(ACCELERATION
+      "generic"
+      CACHE STRING "Acceleration to use")
+endif()
+set_property(CACHE ACCELERATION PROPERTY STRINGS "generic" "nvidia" "amd")
+
+if(UNIX AND NOT APPLE)
   set(BLA_VENDOR OpenBLAS)
   find_package(BLAS REQUIRED)
 endif()

cmake/BuildWhispercpp.cmake

@@ -36,12 +36,10 @@ function(WHISPER_LIB_PATHS COMPONENT SOURCE_DIR WHISPER_STATIC_LIB_PATH WHISPER_
          WHISPER_SHARED_MODULE_PATH)
   lib_name(${COMPONENT} WHISPER_COMPONENT_IMPORT_LIB)
 
-  if(UNIX
-     AND NOT APPLE
-     AND NOT CI)
-    set(STATIC_PATH ${SOURCE_DIR})
-    set(SHARED_PATH ${SOURCE_DIR})
-    set(SHARED_BIN_PATH ${SOURCE_DIR})
+  if(UNIX AND NOT APPLE)
+    set(STATIC_PATH ${SOURCE_DIR}/lib)
+    set(SHARED_PATH ${SOURCE_DIR}/lib)
+    set(SHARED_BIN_PATH ${SOURCE_DIR}/bin)
   else()
     set(STATIC_PATH ${SOURCE_DIR}/${CMAKE_INSTALL_LIBDIR})
     set(SHARED_PATH ${SOURCE_DIR}/${CMAKE_INSTALL_LIBDIR})
@@ -161,7 +159,6 @@ if(APPLE)
       "${PREBUILT_WHISPERCPP_URL_BASE}/whispercpp-macos-$ENV{MACOS_ARCH}-${PREBUILT_WHISPERCPP_VERSION}.tar.gz")
 
   set(WHISPER_LIBRARIES Whisper WhisperCoreML GGML GGMLBase)
-  # list(APPEND WHISPER_RUNTIME_MODULES WhisperCoreML GGMLMetal GGMLBlas)
   list(APPEND WHISPER_RUNTIME_MODULES GGMLMetal GGMLBlas)
   set(WHISPER_DEPENDENCY_LIBRARIES "-framework Accelerate" "-framework CoreML" "-framework Metal" ${BLAS_LIBRARIES})
   set(WHISPER_LIBRARY_TYPE SHARED)
@@ -180,7 +177,7 @@ if(APPLE)
   install(FILES ${WHISPER_DYLIBS} DESTINATION "${CMAKE_PROJECT_NAME}.plugin/Contents/Frameworks")
 elseif(WIN32)
   if(NOT DEFINED ACCELERATION)
-    message(FATAL_ERROR "ACCELERATION is not set. Please set it to either `cpu`, `cuda`, `vulkan` or `hipblas`")
+    message(FATAL_ERROR "ACCELERATION is not set. Please set it to either `generic`, `nvidia`, or `amd`")
   endif()
 
   set(WHISPER_LIBRARIES Whisper GGML GGMLBase)
@@ -244,10 +241,17 @@ else()
     set(CMAKE_CXX_COMPILER_LAUNCHER ${CCACHE_PROGRAM})
   endif()
 
+  set(BLA_VENDOR OpenBLAS)
+  find_package(BLAS REQUIRED)
+
   if(CI)
     set(WHISPER_LIBRARY_TYPE SHARED)
     set(WHISPER_LIBRARIES Whisper GGML GGMLBase)
-    # list(APPEND WHISPER_DEPENDENCY_LIBRARIES Vulkan::Vulkan ${BLAS_LIBRARIES} OpenCL::OpenCL)
+    list(APPEND WHISPER_DEPENDENCY_LIBRARIES Vulkan::Vulkan BLAS::BLAS)
+    if(NOT ${ACCELERATION} STREQUAL "nvidia")
+      # NVidia CUDA has its own OpenCL library
+      list(APPEND WHISPER_DEPENDENCY_LIBRARIES OpenCL::OpenCL)
+    endif()
     list(
       APPEND
       WHISPER_RUNTIME_MODULES
@@ -262,6 +266,14 @@ else()
       GGMLBlas
       GGMLVulkan
       GGMLOpenCL)
+    add_compile_definitions(WHISPER_DYNAMIC_BACKENDS)
+
+    find_package(
+      Vulkan
+      COMPONENTS glslc
+      REQUIRED)
+    find_package(OpenCL REQUIRED)
+    find_package(Python3 REQUIRED)
 
     set(ARCH_PREFIX "-x86_64")
     set(ACCELERATION_PREFIX "-${ACCELERATION}")
@@ -272,9 +284,39 @@ else()
     elseif(${ACCELERATION} STREQUAL "nvidia")
       set(WHISPER_CPP_HASH "a43dc8a44577e965caf9b0baaae74f30a9e00d99a296768021e7ccf0b9217878")
       list(APPEND WHISPER_RUNTIME_MODULES GGMLCUDA)
+
+      # Find CUDA libraries and link against them
+      set(CUDAToolkit_ROOT /usr/local/cuda-12.8/)
+      find_package(CUDAToolkit REQUIRED)
+      list(
+        APPEND
+        WHISPER_DEPENDENCY_LIBRARIES
+        CUDA::cudart
+        CUDA::cublas
+        CUDA::cublasLt
+        CUDA::cuda_driver
+        CUDA::OpenCL)
+      set(CUDART_LIB ${CUDAToolkit_LIBRARY_DIR}/libcuda.so.1)
+      if(NOT EXISTS ${CUDART_LIB})
+        message(
+          STATUS
+            "Creating symlink from ${CUDAToolkit_LIBRARY_DIR}/libcuda.so to ${CUDAToolkit_LIBRARY_DIR}/libcuda.so.1")
+        execute_process(COMMAND sudo ${CMAKE_COMMAND} -E create_symlink ${CUDAToolkit_LIBRARY_DIR}/libcuda.so
+                                ${CUDAToolkit_LIBRARY_DIR}/libcuda.so.1)
+      endif()
     elseif(${ACCELERATION} STREQUAL "amd")
       set(WHISPER_CPP_HASH "1a7592da41493e57ead23c97a420f2db11a4fe31049c9b01cdb310bff05fdca1")
       list(APPEND WHISPER_RUNTIME_MODULES GGMLHip)
+
+      # Find hip libraries and link against them
+      set(CMAKE_PREFIX_PATH /opt/rocm-6.4.2/lib/cmake)
+      set(HIP_PLATFORM amd)
+      set(CMAKE_HIP_PLATFORM amd)
+      set(CMAKE_HIP_ARCHITECTURES OFF)
+      find_package(hip REQUIRED)
+      find_package(hipblas REQUIRED)
+      find_package(rocblas REQUIRED)
+      list(APPEND WHISPER_DEPENDENCY_LIBRARIES hip::host roc::rocblas roc::hipblas)
     else()
       message(
         FATAL_ERROR
@@ -294,10 +336,15 @@ else()
 
     set(WHISPER_SOURCE_DIR ${whispercpp_fetch_SOURCE_DIR})
     set(WHISPER_LIB_DIR ${whispercpp_fetch_SOURCE_DIR})
+
+    file(GLOB WHISPER_SOS ${whispercpp_fetch_SOURCE_DIR}/lib/*${CMAKE_SHARED_LIBRARY_SUFFIX}*)
+    install(FILES ${WHISPER_SOS} DESTINATION "${CMAKE_INSTALL_LIBDIR}/obs-plugins/obs-localvocal")
+    file(GLOB WHISPER_BIN_SOS ${whispercpp_fetch_SOURCE_DIR}/bin/*${CMAKE_SHARED_LIBRARY_SUFFIX}*)
+    install(FILES ${WHISPER_BIN_SOS} DESTINATION "${CMAKE_INSTALL_LIBDIR}/obs-plugins/obs-localvocal")
   else()
     # Source build
     if(${CMAKE_BUILD_TYPE} STREQUAL Release OR ${CMAKE_BUILD_TYPE} STREQUAL RelWithDebInfo)
-      set(Whispercpp_BUILD_TYPE Release)
+      set(Whispercpp_BUILD_TYPE RelWithDebInfo)
     else()
       set(Whispercpp_BUILD_TYPE Debug)
     endif()
@@ -329,9 +376,35 @@ else()
       list(APPEND WHISPER_LIBRARIES GGMLBlas GGMLCPU)
     endif()
 
-    # TODO: Add SYCL support
+    find_package(
+      Vulkan
+      COMPONENTS glslc
+      QUIET)
+    if(Vulkan_FOUND)
+      message(STATUS "Vulkan found, Libraries: ${Vulkan_LIBRARIES}")
+      list(APPEND WHISPER_ADDITIONAL_CMAKE_ARGS -DGGML_VULKAN=ON)
+      if(WHISPER_DYNAMIC_BACKENDS)
+        list(APPEND WHISPER_RUNTIME_MODULES GGMLVulkan)
+      else()
+        list(APPEND WHISPER_LIBRARIES GGMLVulkan)
+      endif()
+      list(APPEND WHISPER_DEPENDENCY_LIBRARIES Vulkan::Vulkan)
+    endif()
+
+    find_package(OpenCL QUIET)
+    find_package(Python3 QUIET)
+    if(OpenCL_FOUND AND Python3_FOUND)
+      message(STATUS "OpenCL found, Libraries: ${OpenCL_LIBRARIES}")
+      list(APPEND WHISPER_ADDITIONAL_CMAKE_ARGS -DGGML_OPENCL=ON -DGGML_OPENCL_EMBED_KERNELS=ON
+           -DGGML_OPENCL_USE_ADRENO_KERNELS=OFF)
+      if(WHISPER_DYNAMIC_BACKENDS)
+        list(APPEND WHISPER_RUNTIME_MODULES GGMLOpenCL)
+      else()
+        list(APPEND WHISPER_LIBRARIES GGMLOpenCL)
+      endif()
+      list(APPEND WHISPER_DEPENDENCY_LIBRARIES OpenCL::OpenCL)
+    endif()
 
-    # set(CMAKE_PREFIX_PATH "C:/Program Files/AMD/ROCm/6.1;$ENV{VULKAN_SDK}")
     set(HIP_PLATFORM amd)
     set(CMAKE_HIP_PLATFORM amd)
     set(CMAKE_HIP_ARCHITECTURES OFF)
@@ -342,7 +415,7 @@ else()
        AND hipblas_FOUND
        AND rocblas_FOUND)
       message(STATUS "hipblas found, Libraries: ${hipblas_LIBRARIES}")
-      set(WHISPER_ADDITIONAL_ENV "CMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH};HIP_PLATFORM=${HIP_PLATFORM}")
+      list(APPEND WHISPER_ADDITIONAL_ENV "CMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH};HIP_PLATFORM=${HIP_PLATFORM}")
       list(APPEND WHISPER_ADDITIONAL_CMAKE_ARGS -DGGML_HIP=ON -DGGML_HIP_ROCWMMA_FATTN=ON)
       if(WHISPER_DYNAMIC_BACKENDS)
         list(APPEND WHISPER_RUNTIME_MODULES GGMLHip)
@@ -364,35 +437,6 @@ else()
       list(APPEND WHISPER_DEPENDENCY_LIBRARIES CUDA::cudart CUDA::cublas CUDA::cublasLt CUDA::cuda_driver)
     endif()
 
-    find_package(
-      Vulkan
-      COMPONENTS glslc
-      QUIET)
-    if(Vulkan_FOUND)
-      message(STATUS "Vulkan found, Libraries: ${Vulkan_LIBRARIES}")
-      list(APPEND WHISPER_ADDITIONAL_CMAKE_ARGS -DGGML_VULKAN=ON)
-      if(WHISPER_DYNAMIC_BACKENDS)
-        list(APPEND WHISPER_RUNTIME_MODULES GGMLVulkan)
-      else()
-        list(APPEND WHISPER_LIBRARIES GGMLVulkan)
-      endif()
-      list(APPEND WHISPER_DEPENDENCY_LIBRARIES Vulkan::Vulkan)
-    endif()
-
-    find_package(OpenCL QUIET)
-    find_package(Python3 QUIET)
-    if(OpenCL_FOUND AND Python3_FOUND)
-      message(STATUS "OpenCL found, Libraries: ${OpenCL_LIBRARIES}")
-      list(APPEND WHISPER_ADDITIONAL_CMAKE_ARGS -DGGML_OPENCL=ON -DGGML_OPENCL_EMBED_KERNELS=ON
-           -DGGML_OPENCL_USE_ADRENO_KERNELS=OFF)
-      if(WHISPER_DYNAMIC_BACKENDS)
-        list(APPEND WHISPER_RUNTIME_MODULES GGMLOpenCL)
-      else()
-        list(APPEND WHISPER_LIBRARIES GGMLOpenCL)
-      endif()
-      list(APPEND WHISPER_DEPENDENCY_LIBRARIES OpenCL::OpenCL)
-    endif()
-
     foreach(component ${WHISPER_LIBRARIES})
       whisper_lib_paths(${component} ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/obs-plugins/${CMAKE_PROJECT_NAME}
                         WHISPER_STATIC_LIB_PATH WHISPER_SHARED_LIB_PATH WHISPER_SHARED_MODULE_PATH)

cmake/linux/defaults.cmake

@@ -14,14 +14,15 @@ set(CMAKE_FIND_PACKAGE_TARGETS_GLOBAL TRUE)
 
 set(CPACK_PACKAGE_NAME "${CMAKE_PROJECT_NAME}")
 set(CPACK_PACKAGE_VERSION "${CMAKE_PROJECT_VERSION}")
-set(CPACK_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}-${CMAKE_C_LIBRARY_ARCHITECTURE}")
+set(CPACK_PACKAGE_FILE_NAME
+    "${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}-$ENV{ACCELERATION}-${CMAKE_C_LIBRARY_ARCHITECTURE}")
 
 set(CPACK_GENERATOR "DEB")
 set(CPACK_DEBIAN_PACKAGE_SHLIBDEPS ON)
 set(CPACK_DEBIAN_PACKAGE_MAINTAINER "${PLUGIN_EMAIL}")
 set(CPACK_SET_DESTDIR ON)
 
-if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.25.0 OR NOT CMAKE_CROSSCOMPILING)
+if((CMAKE_VERSION VERSION_GREATER_EQUAL 3.25.0 OR NOT CMAKE_CROSSCOMPILING) AND NOT (ACCELERATION STREQUAL amd))
   set(CPACK_DEBIAN_DEBUGINFO_PACKAGE ON)
 endif()
 
@@ -39,7 +40,7 @@ set(CPACK_SOURCE_IGNORE_FILES
     release/)
 
 set(CPACK_VERBATIM_VARIABLES YES)
-set(CPACK_SOURCE_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}-$ENV{ACCELERATION}source")
+set(CPACK_SOURCE_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}-$ENV{ACCELERATION}-source")
 set(CPACK_ARCHIVE_THREADS 0)
 
 include(CPack)