0.31.0

Author: atkAudioUser

CMakeLists.txt

@@ -5,14 +5,14 @@ include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/common/bootstrap.cmake")
 
 project(${_name} VERSION ${_version})
 
-# Set default build type to Debug
+# Set default build type to RelWithDebInfo for local development
+# RelWithDebInfo provides optimized code with debug symbols (PDB files on Windows)
 if(NOT CMAKE_BUILD_TYPE)
-    set(CMAKE_BUILD_TYPE "Debug" CACHE STRING "Choose the type of build (Debug or Release)" FORCE)
+    set(CMAKE_BUILD_TYPE "RelWithDebInfo" CACHE STRING "Choose the type of build (Debug, Release, or RelWithDebInfo)" FORCE)
 endif()
 message(STATUS "Build type: ${CMAKE_BUILD_TYPE}")
 
 option(ENABLE_FRONTEND_API "Use obs-frontend-api for UI functionality" ON)
-option(BUILD_TESTS "Build unit tests" OFF)
 
 include(compilerconfig)
 include(defaults)
@@ -102,7 +102,6 @@ set_target_properties(${CMAKE_PROJECT_NAME} PROPERTIES CXX_STANDARD 23)
 
 add_subdirectory(lib/atkaudio)
 
-
 string(JSON PLUGIN_DISPLAY_NAME GET ${buildspec} displayName)
 string(JSON PLUGIN_AUTHOR GET ${buildspec} author)
 string(JSON PLUGIN_OBS_VERSION_REQUIRED GET ${buildspec} dependencies obs-studio version)
@@ -113,23 +112,22 @@ configure_file(src/config.h.in config.h @ONLY)
 
 include(./lib/atkaudio/cmake/cpack.cmake)
 
-# Enable testing and add tests subdirectory
-if(BUILD_TESTS)
-    enable_testing()
-    add_subdirectory(tests)
-    message(STATUS "Building tests: Enabled")
-endif()
+
+# Build tests
+include(CTest)
+add_subdirectory(tests)
 
 # Automatically run install after build (skip in CI or when installing to system directories without permissions)
-if(NOT DEFINED ENV{CI} OR NOT CMAKE_INSTALL_PREFIX MATCHES "^/usr")
+if(NOT DEFINED ENV{CI} AND NOT DEFINED ENV{GITHUB_ACTIONS} AND NOT CMAKE_INSTALL_PREFIX MATCHES "^/usr")
     add_custom_command(TARGET ${CMAKE_PROJECT_NAME} POST_BUILD
         COMMAND ${CMAKE_COMMAND} --install ${CMAKE_BINARY_DIR} --config $<CONFIG> --component plugin
         COMMENT "Installing plugin after build..."
     )
 endif()
 
 # On non-CI Linux builds, copy plugin to user home directory after build
-if(NOT DEFINED ENV{CI} AND UNIX AND NOT APPLE)
+if(NOT DEFINED ENV{CI} AND NOT DEFINED ENV{GITHUB_ACTIONS} AND UNIX AND NOT APPLE)
+    message(STATUS "Configuring post-build copy to ~/.config/obs-studio/plugins/")
     if(CMAKE_SIZEOF_VOID_P EQUAL 8)
         set(_user_arch "64bit")
     else()

CMakePresets.json

@@ -87,7 +87,7 @@
         "lhs": "${hostSystemName}",
         "rhs": "Windows"
       },
-      "generator": "Visual Studio 17 2022",
+      "generator": "Visual Studio 18 2026",
       "architecture": "x64",
       "warnings": {
         "dev": true,
@@ -121,7 +121,7 @@
         "lhs": "${hostSystemName}",
         "rhs": "Windows"
       },
-      "generator": "Visual Studio 17 2022",
+      "generator": "Visual Studio 18 2026",
       "architecture": "ARM64",
       "warnings": {
         "dev": true,

README.md

@@ -1,35 +1,35 @@
 # atkAudio Plugin for OBS
 
-## Plugin Host
+## PluginHost
 
 - VST3 plugin host for OBS
-- Up to 8 channels
+- MIDI, e.g. for using MIDI keyboard and a sampler plugin as soundboard
 - Sidechain support
+- Optional multithreading for improved performance with multi-core CPUs
+- Direct interfacing with audio and MIDI hardware devices
 - AU plugins on Apple macOS
 - LADSPA and LV2 plugins on Linux
 
-## Plugin Host2
+## PluginHost2
 
-- Includes all features of regular Plugin Host plus:
-- MIDI, e.g. for using MIDI keyboard and a sampler plugin as soundboard
-- Direct interfacing with audio and MIDI hardware devices
+- Includes all features of regular PluginHost plus:
 - Use multiple plugins to create complex audio processing chains and graphs from OBS sources and audio devices
-- Multicore parallel audio processing for improved performance
+- Always internally multithreading (no extra latency penalty)
 - Saving and loading of graphs as files
-- Route audio and MIDI between plugins and hardware (ASIO/CoreAudio included)
+- Route audio and MIDI between sources, plugins and hardware (ASIO/CoreAudio included)
 - Sample rate converting and drift compensating internal buffering for seamless audio between OBS sources and audio devices
 - etc
 
-Plugin Host2 can interface directly with audio and MIDI hardware, OBS audio sources, and output audio as new OBS sources, allowing for complex audio processing setups. E.g. use ASIO interface as audio device, take additional audio from OBS sources, route monitoring to ASIO outputs and/or different audio drivers/hardware, use plugins and create final mix, and output the processed audio as a new OBS source for recording and streaming. Or just create a simple soundboard with a sampler plugin and a MIDI keyboard.
+PluginHost2 can interface directly with audio and MIDI hardware, OBS audio sources, and output audio as new OBS sources, allowing for complex audio processing setups. E.g. use ASIO interface as audio device, take additional audio from OBS sources, route monitoring to ASIO outputs and/or different audio drivers/hardware, use plugins and create final mix, and output the processed audio as a new OBS source for recording and streaming. Or just create a simple soundboard with a sampler plugin and a MIDI keyboard.
+
+Develop your own audio processing plugins and integrate them into `PluginHost2` using the [JUCE framework](https://juce.com/) AudioProcessor class. See `InternalPlugins.cpp` how `GainPlugin` is loaded. See `GainPlugin.h` for implementation. Optionally include OBS headers to use the [OBS API](https://docs.obsproject.com/) for more advanced integration with [OBS Studio](https://obsproject.com/)
 
-## Device I/O
+## DeviceIo(2)
 
 - Send and receive audio directly into and from audio devices
 - "Anything from/to anywhere" device routing
 - ASIO, CoreAudio and Windows Audio devices
 
-Develop your own audio processing plugins and integrate them into `Plugin Host2` using the [JUCE framework](https://juce.com/) AudioProcessor class. See `InternalPlugins.cpp` how `GainPlugin` is loaded. See `GainPlugin.h` for implementation. Optionally include OBS headers to use the [OBS API](https://docs.obsproject.com/) for more advanced integration with [OBS Studio](https://obsproject.com/)
-
 ## Audio Source Mixer (OBS Source)
 
 - Mix audio from up to 8 OBS sources into a new OBS audio source
@@ -38,7 +38,7 @@ Develop your own audio processing plugins and integrate them into `Plugin Host2`
 
 ## Build instructions
 
-Project is based on [OBS Plugin Template](https://github.com/obsproject/obs-plugintemplate) and depends on [JUCE Framework](https://github.com/juce-framework/JUCE). Install JUCE Framework [Minimum System Requirements](https://github.com/juce-framework/JUCE#minimum-system-requirements) and OBS Plugin Template [Supported Build Environment](https://github.com/obsproject/obs-plugintemplate#supported-build-environments) and follow OBS Plugin Template [Quick Start Guide](https://github.com/obsproject/obs-plugintemplate/wiki/Quick-Start-Guide).
+Project is (now loosely) based on [OBS Plugin Template](https://github.com/obsproject/obs-plugintemplate) and depends on [JUCE Framework](https://github.com/juce-framework/JUCE). Install JUCE Framework [Minimum System Requirements](https://github.com/juce-framework/JUCE#minimum-system-requirements) and OBS Plugin Template [Supported Build Environment](https://github.com/obsproject/obs-plugintemplate#supported-build-environments) and follow OBS Plugin Template [Quick Start Guide](https://github.com/obsproject/obs-plugintemplate/wiki/Quick-Start-Guide).
 
 In short, after installing all dependencies (Ubuntu example):
 
@@ -52,10 +52,6 @@ cmake --build --preset ubuntu-x86_64
 Find `atkaudio-pluginforobs.so` and copy it to OBS plugins directory.
 See `CMakePresets.json` for Windows, macOS and other build presets.
 
-### Linux Realtime Thread Support
-
-For optimal performance on Linux, see [LINUX_REALTIME.md](LINUX_REALTIME.md) for information about enabling realtime thread scheduling. The plugin works without this configuration but may have better performance with it enabled.
-
 ## Donation
 
 [![PayPal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/donate/?hosted_button_id=ERBKC76F55HZW)
@@ -64,11 +60,5 @@ If you find this project useful, please consider making [a donation](https://www
 
 ## Installation
 
-- Download and install [latest release](https://github.com/atkAudio/PluginForObsRelease/releases/latest)
-- Manual/portable installations e.g. on major Linux distros: extract `portable-Linux.zip` file and copy the directory `atkaudio-pluginforobs` into `~/.config/obs-studio/plugins/`.
-
-## Development
-
-For developers working on this project:
-
-- **Release Process**: Releases are automatically created when tags matching `x.y.z` or `x.y.z-beta.n` format are pushed
+- Download and install [latest release](https://github.com/atkAudio/PluginForObsRelease/releases/latest) using the appropriate installer for your OS.
+- Manual/portable installations e.g. on major Linux distros: extract portable `.zip` file and copy the directory `atkaudio-pluginforobs` into `~/.config/obs-studio/plugins/`.

buildspec.json

@@ -47,6 +47,6 @@
   "uuids": {
     "windowsApp": "ad885c58-5ca9-44de-8f4f-1c12676626a9"
   },
-  "version": "0.30.1",
+  "version": "0.31.0",
   "website": "https://www.atkaudio.com"
 }

cmake/linux/compilerconfig.cmake

@@ -70,4 +70,4 @@ else()
   set(ENABLE_COMPILER_TRACE OFF CACHE STRING "Enable Clang time-trace (required Clang and Ninja)" FORCE)
 endif()
 
-add_compile_definitions($<$<CONFIG:DEBUG>:DEBUG> $<$<CONFIG:DEBUG>:_DEBUG> SIMDE_ENABLE_OPENMP)
+add_compile_definitions($<$<CONFIG:DEBUG>:DEBUG> $<$<CONFIG:DEBUG>:_DEBUG>)

cmake/linux/defaults.cmake

@@ -9,6 +9,11 @@ if(CMAKE_INSTALL_LIBDIR MATCHES "(CMAKE_SYSTEM_PROCESSOR)")
   string(REPLACE "CMAKE_SYSTEM_PROCESSOR" "${CMAKE_SYSTEM_PROCESSOR}" CMAKE_INSTALL_LIBDIR "${CMAKE_INSTALL_LIBDIR}")
 endif()
 
+# Set default install prefix to /usr for Linux (where OBS looks for plugins)
+if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
+  set(CMAKE_INSTALL_PREFIX "/usr" CACHE PATH "Default install prefix" FORCE)
+endif()
+
 # Enable find_package targets to become globally available targets
 set(CMAKE_FIND_PACKAGE_TARGETS_GLOBAL TRUE)
 

cmake/linux/helpers.cmake.backup

@@ -0,0 +1,126 @@
+# CMake Linux helper functions module
+
+include_guard(GLOBAL)
+
+include(helpers_common)
+
+# set_target_properties_plugin: Set target properties for use in obs-studio
+function(set_target_properties_plugin target)
+  set(options "")
+  set(oneValueArgs "")
+  set(multiValueArgs PROPERTIES)
+  cmake_parse_arguments(PARSE_ARGV 0 _STPO "${options}" "${oneValueArgs}" "${multiValueArgs}")
+
+  message(DEBUG "Setting additional properties for target ${target}...")
+
+  while(_STPO_PROPERTIES)
+    list(POP_FRONT _STPO_PROPERTIES key value)
+    set_property(TARGET ${target} PROPERTY ${key} "${value}")
+  endwhile()
+
+  set_target_properties(
+    ${target}
+    PROPERTIES VERSION ${PLUGIN_VERSION} SOVERSION ${PLUGIN_VERSION_MAJOR} PREFIX ""
+  )
+
+  message(STATUS "Installing target ${target} to:")
+  message(STATUS "  - LIBRARY: ${CMAKE_INSTALL_LIBDIR}/obs-plugins")
+  message(STATUS "  - RUNTIME: ${CMAKE_INSTALL_BINDIR}")
+  
+  install(
+    TARGETS ${target}
+    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/obs-plugins
+  )
+
+  # Additional install for portable component with custom directory structure
+  if(CMAKE_SIZEOF_VOID_P EQUAL 8)
+    set(_portable_arch "64bit")
+  else()
+    set(_portable_arch "32bit")
+  endif()
+  
+  install(
+    TARGETS ${target}
+    RUNTIME DESTINATION obs-plugins/${_portable_arch}
+    LIBRARY DESTINATION obs-plugins/${_portable_arch}
+  )
+
+  if(TARGET plugin-support)
+    target_link_libraries(${target} PRIVATE plugin-support)
+  endif()
+
+  add_custom_command(
+    TARGET ${target}
+    POST_BUILD
+    COMMAND "${CMAKE_COMMAND}" -E make_directory "${CMAKE_CURRENT_BINARY_DIR}/rundir/$<CONFIG>"
+    COMMAND
+      "${CMAKE_COMMAND}" -E copy_if_different "$<TARGET_FILE:${target}>" "${CMAKE_CURRENT_BINARY_DIR}/rundir/$<CONFIG>"
+    COMMENT "Copy ${target} to rundir"
+    VERBATIM
+  )
+
+  target_install_resources(${target})
+
+  get_target_property(target_sources ${target} SOURCES)
+  set(target_ui_files ${target_sources})
+  list(FILTER target_ui_files INCLUDE REGEX ".+\\.(ui|qrc)")
+  source_group(TREE "${CMAKE_CURRENT_SOURCE_DIR}" PREFIX "UI Files" FILES ${target_ui_files})
+endfunction()
+
+# Helper function to add resources into bundle
+function(target_install_resources target)
+  message(DEBUG "Installing resources for target ${target}...")
+  if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/data")
+    file(GLOB_RECURSE data_files "${CMAKE_CURRENT_SOURCE_DIR}/data/*")
+    foreach(data_file IN LISTS data_files)
+      cmake_path(
+        RELATIVE_PATH
+        data_file
+        BASE_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/data/"
+        OUTPUT_VARIABLE relative_path
+      )
+      cmake_path(GET relative_path PARENT_PATH relative_path)
+      target_sources(${target} PRIVATE "${data_file}")
+      source_group("Resources/${relative_path}" FILES "${data_file}")
+    endforeach()
+
+    message(STATUS "Installing data directory for ${target} to:")
+    message(STATUS "  - DESTINATION: ${CMAKE_INSTALL_DATAROOTDIR}/obs/obs-plugins/${target}")
+    
+    install(
+      DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/data/"
+      DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/obs/obs-plugins/${target}
+      USE_SOURCE_PERMISSIONS
+    )
+
+    add_custom_command(
+      TARGET ${target}
+      POST_BUILD
+      COMMAND "${CMAKE_COMMAND}" -E make_directory "${CMAKE_CURRENT_BINARY_DIR}/rundir/$<CONFIG>/${target}"
+      COMMAND
+        "${CMAKE_COMMAND}" -E copy_directory "${CMAKE_CURRENT_SOURCE_DIR}/data"
+        "${CMAKE_CURRENT_BINARY_DIR}/rundir/$<CONFIG>/${target}"
+      COMMENT "Copy ${target} resources to rundir"
+      VERBATIM
+    )
+  endif()
+endfunction()
+
+# Helper function to add a specific resource to a bundle
+function(target_add_resource target resource)
+  message(DEBUG "Add resource '${resource}' to target ${target} at destination '${target_destination}'...")
+
+  install(FILES "${resource}" DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/obs/obs-plugins/${target})
+
+  add_custom_command(
+    TARGET ${target}
+    POST_BUILD
+    COMMAND "${CMAKE_COMMAND}" -E make_directory "${CMAKE_CURRENT_BINARY_DIR}/rundir/$<CONFIG>/${target}"
+    COMMAND "${CMAKE_COMMAND}" -E copy "${resource}" "${CMAKE_CURRENT_BINARY_DIR}/rundir/$<CONFIG>/${target}"
+    COMMENT "Copy ${target} resource ${resource} to rundir"
+    VERBATIM
+  )
+
+  source_group("Resources" FILES "${resource}")
+endfunction()

cmake/macos/compilerconfig.cmake

@@ -13,6 +13,17 @@ include(compiler_common)
 
 add_compile_options("$<$<NOT:$<COMPILE_LANGUAGE:Swift>>:-fopenmp-simd>")
 
+# Enable dSYM generator for release builds
+string(APPEND CMAKE_C_FLAGS_RELEASE " -g")
+string(APPEND CMAKE_CXX_FLAGS_RELEASE " -g")
+string(APPEND CMAKE_OBJC_FLAGS_RELEASE " -g")
+string(APPEND CMAKE_OBJCXX_FLAGS_RELEASE " -g")
+
+string(APPEND CMAKE_C_FLAGS_RELWITHDEBINFO " -g")
+string(APPEND CMAKE_CXX_FLAGS_RELWITHDEBINFO " -g")
+string(APPEND CMAKE_OBJC_FLAGS_RELWITHDEBINFO " -g")
+string(APPEND CMAKE_OBJCXX_FLAGS_RELWITHDEBINFO " -g")
+
 # Default ObjC compiler options used by Xcode:
 #
 # * -Wno-implicit-atomic-properties

cmake/macos/helpers.cmake

@@ -64,7 +64,7 @@ function(set_target_properties_plugin target)
   source_group(TREE "${CMAKE_CURRENT_SOURCE_DIR}" PREFIX "UI Files" FILES ${target_ui_files})
 
   install(TARGETS ${target} LIBRARY DESTINATION .)
-  install(FILES "$<TARGET_BUNDLE_DIR:${target}>.dsym" CONFIGURATIONS Release DESTINATION . OPTIONAL)
+  install(FILES "$<TARGET_BUNDLE_DIR:${target}>.dsym" CONFIGURATIONS Release DESTINATION .)
 
   # Additional install for portable component with custom directory structure
   if(CMAKE_SIZEOF_VOID_P EQUAL 8)

cmake/macos/xcode.cmake

@@ -58,7 +58,7 @@ set(CMAKE_XCODE_ATTRIBUTE_SWIFT_VERSION 5.0)
 #   output configuration. Report to KitWare.
 #
 set(CMAKE_XCODE_ATTRIBUTE_DEBUG_INFORMATION_FORMAT[variant=Debug] dwarf)
-set(CMAKE_XCODE_ATTRIBUTE_DEBUG_INFORMATION_FORMAT[variant=RelWithDebInfo] dwarf)
+set(CMAKE_XCODE_ATTRIBUTE_DEBUG_INFORMATION_FORMAT[variant=RelWithDebInfo] dwarf-with-dsym)
 set(CMAKE_XCODE_ATTRIBUTE_DEBUG_INFORMATION_FORMAT[variant=Release] dwarf-with-dsym)
 set(CMAKE_XCODE_ATTRIBUTE_DEBUG_INFORMATION_FORMAT[variant=MinSizeRel] dwarf-with-dsym)