Merge pull request #928 from bjornbytes/phonon-v4

Super Audio Upgrade!

Author: bjornbytes

.gitmodules

@@ -34,3 +34,6 @@
 [submodule "deps/luau"]
 	path = deps/luau
 	url = https://github.com/bjornbytes/luau.git
+[submodule "deps/phonon"]
+	path = deps/phonon
+	url = https://github.com/bjornbytes/steam-audio

CHANGES.md

@@ -42,6 +42,21 @@ dev
 - Add support for non-uniform scale in `ConvexShape` and `MeshShape`.
 - Add `VertexUV2` builtin vertex attribute and `UV2` shader variable.
 - Add support for two sets of UVs in `ModelData`.
+- Add `t.audio.debug` and `t.audio.reverb` settings to `lovr.conf`.
+- Add `lovr.audio.update`.
+- Add `lovr.audio.setHRTF`.
+- Add `lovr.audio.get/setReverb`.
+- Add `Source:get/setAbsorption`.
+- Add `Source:get/setCone`.
+- Add `Source:get/setFalloff`.
+- Add `Source:get/setOcclusion`.
+- Add `Source:get/setReverb`.
+- Add `Source:get/setSpatialization`.
+- Add support for ambisonic source playback.
+- Add `AudioMesh`.
+- Add `lovr.audio.getStream`.
+- Add `AudioStream`.
+- Add `Sound:get/setFrame`.
 
 ### Change
 
@@ -63,6 +78,12 @@ dev
 - Change `Mat4` to be a regular object instead of a vector type.
 - Change `lovr.graphics.submit` to have better performance when called multiple times per frame.
 - Change `Pass:text` and Font methods to also take nested tables of multicolor strings.
+- Change `lovr.audio.start` sink parameter to be a `boolean` or an `AudioStream`.
+- Change `lovr.audio.start/stop` to return error messages if they fail.
+- Change `lovr.audio.newSource` to create non-spatial sources by default.
+- Change `lovr.audio.newSource` to also accept and `AudioStream`.
+- Change audio device to start when playing a Source for the first time, instead of immediately.
+- Change `lovr.data.newSound` to take a channel count instead of a channel layout.
 
 ### Fix
 
@@ -118,6 +139,12 @@ dev
 - Remove `Model:getData` (create and keep a `ModelData` around as needed).
 - Remove userdata vector types (use tables, and the `vector` and `quaternion` modules).
 - Remove `lovr.headset.getHandles` (use FFI).
+- Remove `lovr.audio.getSpatializer` (SteamAudio is always active).
+- Remove `lovr.audio.setGeometry` (use `AudioMesh`).
+- Remove `lovr.audio.get/setAbsorption` (use `Source:get/setAbsorption`).
+- Remove `Source:get/setDirectivity` (use `Source:get/setCone`).
+- Remove `Source:is/setEffectEnabled` (use new effect getters/setters).
+- Remove "stream" `Sound`s, `Sound:getCapacity`, and `Sound:isStream` (use `AudioStream`).
 
 v0.18.0 - 2025-02-14
 ---

CMakeLists.txt

@@ -26,7 +26,7 @@ option(LOVR_USE_LUAU "Use Luau instead of Lua" OFF)
 option(LOVR_USE_GLSLANG "Use glslang to compile GLSL shaders" ON)
 option(LOVR_USE_VULKAN "Use the Vulkan renderer" ON)
 option(LOVR_USE_WEBGPU "Use the WebGPU renderer" OFF)
-option(LOVR_USE_STEAM_AUDIO "Enable the Steam Audio spatializer (be sure to also set LOVR_STEAM_AUDIO_PATH)" OFF)
+option(LOVR_USE_STEAM_AUDIO "Use Steam Audio for audio spatialization" ON)
 
 option(LOVR_SANITIZE "Enable Address Sanitizer" OFF)
 option(LOVR_PROFILE "Enable Tracy integration" OFF)
@@ -195,6 +195,29 @@ if(LOVR_ENABLE_PHYSICS)
   set(LOVR_JOLT joltc)
 endif()
 
+# Steam Audio (aka phonon)
+if(LOVR_USE_STEAM_AUDIO AND LOVR_ENABLE_AUDIO)
+  set(BUILD_SHARED_LIBS ON)
+  set(STEAMAUDIO_ENABLE_SERIALIZATION OFF CACHE BOOL "")
+  set(STEAMAUDIO_ENABLE_DEFAULT_HRTF OFF CACHE BOOL "")
+  set(STEAMAUDIO_ENABLE_VALIDATION OFF CACHE BOOL "")
+  set(STEAMAUDIO_BUILD_TESTS OFF CACHE BOOL "")
+  set(STEAMAUDIO_BUILD_BENCHMARKS OFF CACHE BOOL "")
+  set(STEAMAUDIO_BUILD_SAMPLES OFF CACHE BOOL "")
+  set(STEAMAUDIO_BUILD_ITESTS OFF CACHE BOOL "")
+  set(STEAMAUDIO_BUILD_DOCS OFF CACHE BOOL "")
+  set(STEAMAUDIO_STATIC_RUNTIME OFF CACHE BOOL "")
+  set(STEAMAUDIO_ENABLE_IPP OFF CACHE BOOL "")
+  set(STEAMAUDIO_ENABLE_MKL OFF CACHE BOOL "")
+  set(STEAMAUDIO_ENABLE_EMBREE OFF CACHE BOOL "")
+  set(STEAMAUDIO_ENABLE_FFTS OFF CACHE BOOL "")
+  set(STEAMAUDIO_ENABLE_RADEONRAYS OFF CACHE BOOL "")
+  set(STEAMAUDIO_ENABLE_TRUEAUDIONEXT OFF CACHE BOOL "")
+  add_subdirectory(deps/phonon/core phonon)
+  set(LOVR_PHONON phonon)
+  set(BUILD_SHARED_LIBS OFF)
+endif()
+
 # glslang
 if(LOVR_USE_GLSLANG)
   set(ENABLE_HLSL OFF CACHE BOOL "")
@@ -239,28 +262,6 @@ if(LOVR_ENABLE_THREAD AND NOT (WIN32 OR EMSCRIPTEN))
   set(LOVR_PTHREADS Threads::Threads)
 endif()
 
-# Steam Audio (aka Phonon)
-if(LOVR_USE_STEAM_AUDIO)
-  if(NOT LOVR_STEAM_AUDIO_PATH)
-    message(FATAL_ERROR "LOVR_USE_STEAM_AUDIO requires the LOVR_STEAM_AUDIO_PATH to be set to the location of the Steam Audio folder")
-  endif()
-  add_library(Phonon SHARED IMPORTED)
-  target_include_directories(Phonon INTERFACE "${LOVR_STEAM_AUDIO_PATH}/include")
-  if(ANDROID)
-    set_target_properties(Phonon PROPERTIES IMPORTED_LOCATION "${LOVR_STEAM_AUDIO_PATH}/lib/Android/arm64/libphonon.so")
-  elseif(WIN32)
-    set_target_properties(Phonon PROPERTIES IMPORTED_IMPLIB "${LOVR_STEAM_AUDIO_PATH}/lib/Windows/x64/phonon.lib")
-    set_target_properties(Phonon PROPERTIES IMPORTED_LOCATION "${LOVR_STEAM_AUDIO_PATH}/bin/Windows/x64/phonon.dll")
-  elseif(APPLE)
-    set_target_properties(Phonon PROPERTIES IMPORTED_LOCATION "${LOVR_STEAM_AUDIO_PATH}/lib/OSX/libphonon.dylib"
-                                            IMPORTED_SONAME "@rpath/libphonon.dylib")  # It doesn't make sense this line is required, but it is
-  else() # Assume Linux. Note: This has *not* been tested. FIXME: When is the .so copied?
-    set_target_properties(Phonon PROPERTIES IMPORTED_LOCATION "${LOVR_STEAM_AUDIO_PATH}/lib/Linux/x64/libphonon.so")
-  endif()
-
-  set(LOVR_PHONON Phonon)
-endif()
-
 # LÖVR
 
 set(LOVR_SRC
@@ -309,6 +310,7 @@ target_link_libraries(lovr
   ${LOVR_LUA}
   ${LOVR_MSDF}
   ${LOVR_JOLT}
+  ${LOVR_PHONON}
   ${LOVR_GLSLANG}
   ${LOVR_OPENXR}
   ${LOVR_PTHREADS}
@@ -341,25 +343,19 @@ if(LOVR_USE_LUAU)
   target_compile_definitions(lovr PRIVATE LOVR_USE_LUAU)
 endif()
 
-if(LOVR_ENABLE_AUDIO OR LOVR_ENABLE_DATA)
-  target_sources(lovr PRIVATE
-    src/lib/miniaudio/miniaudio.c
-  )
-endif()
-
 if(LOVR_ENABLE_AUDIO)
   target_sources(lovr PRIVATE
     src/modules/audio/audio.c
-    src/modules/audio/spatializer_simple.c
     src/api/l_audio.c
     src/api/l_audio_source.c
+    src/api/l_audio_audioMesh.c
+    src/lib/miniaudio/miniaudio.c
   )
 
   if(LOVR_USE_STEAM_AUDIO)
-    target_compile_definitions(lovr PRIVATE LOVR_ENABLE_PHONON_SPATIALIZER)
-    target_sources(lovr PRIVATE src/modules/audio/spatializer_phonon.c)
-    # Dynamically linked at runtime, so this is not otherwise a dependency
-    add_dependencies(lovr ${LOVR_PHONON})
+    target_include_directories(lovr PRIVATE deps/phonon/core/src/core)
+    target_include_directories(lovr PRIVATE "${PROJECT_BINARY_DIR}/phonon/src/core")
+    target_compile_definitions(lovr PRIVATE LOVR_USE_PHONON)
   endif()
 else()
   target_compile_definitions(lovr PRIVATE LOVR_DISABLE_AUDIO)
@@ -376,6 +372,7 @@ if(LOVR_ENABLE_DATA)
     src/modules/data/rasterizer.c
     src/modules/data/sound.c
     src/api/l_data.c
+    src/api/l_data_audioStream.c
     src/api/l_data_blob.c
     src/api/l_data_image.c
     src/api/l_data_modelData.c
@@ -771,6 +768,7 @@ elseif(ANDROID)
     ${LOVR_MSDF}
     ${LOVR_LUA}
     ${LOVR_GLSLANG}
+    ${LOVR_PHONON}
     PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/raw/lib/${ANDROID_ABI}"
   )
 
@@ -792,11 +790,6 @@ elseif(ANDROID)
 
     configure_file("${ANDROID_NDK}/toolchains/llvm/prebuilt/${ANDROID_HOST_TAG}/sysroot/usr/lib/aarch64-linux-android/libc++_shared.so" "raw/lib/${ANDROID_ABI}/libc++_shared.so" COPYONLY)
 
-    if(LOVR_USE_STEAM_AUDIO)
-      get_target_property(PHONON_LIB ${LOVR_PHONON} IMPORTED_LOCATION)
-      file(COPY ${PHONON_LIB} DESTINATION raw/lib/${ANDROID_ABI})
-    endif()
-
     # Make an apk
     add_custom_target(
       buildAPK ALL
@@ -896,6 +889,7 @@ elseif(UNIX)
   move_lib(${LOVR_JOLT})
   move_lib(${LOVR_GLSLANG})
   move_lib(${LOVR_OPENXR})
+  move_lib(${LOVR_PHONON})
   foreach(target ${ALL_PLUGIN_TARGETS})
     move_lib(${target})
   endforeach()

deps/phonon

@@ -19,8 +19,15 @@ local conf = {
     timer = true
   },
   audio = {
+    debug = false,
     start = true,
-    spatializer = nil
+    reverb = {
+      type = 'convolution',
+      rays = 4096,
+      bounces = 16,
+      duration = 2,
+      rate = .1
+    }
   },
   graphics = {
     debug = false,
@@ -195,6 +202,7 @@ function lovr.run()
       if not lovr.headset.isActive() then lovr.simulate(dt) end
     end
     if lovr.update then lovr.update(dt) end
+    if lovr.audio then lovr.audio.update(dt) end
     if lovr.graphics then
       local window = lovr.graphics.getWindowPass()
       local headset = lovr.headset and lovr.headset.getPass()

etc/boot.lua

@@ -72,6 +72,7 @@ function lovr.arg(arg)
 
   return function(conf)
     if arg.debug then
+      conf.audio.debug = true
       conf.graphics.debug = true
       conf.headset.debug = true
     end

etc/nogame/arg.lua

@@ -344,6 +344,8 @@ void luax_vlog(void* context, int level, const char* tag, const char* format, va
     lua_pushstring(L, levels[level]);
     lua_pushstring(L, tag);
     lua_call(L, 3, 0);
+  } else {
+    lua_pop(L, 1);
   }
   lua_pop(L, 1);
 }

src/api/api.c

@@ -57,6 +57,8 @@ extern StringEntry lovrOpenMode[];
 extern StringEntry lovrOriginType[];
 extern StringEntry lovrPassType[];
 extern StringEntry lovrPermission[];
+extern StringEntry lovrReverbMode[];
+extern StringEntry lovrReverbType[];
 extern StringEntry lovrSampleFormat[];
 extern StringEntry lovrShaderStage[];
 extern StringEntry lovrShaderType[];