Add some useful methods in SteamAudioPlayer.

Author: stechyo

src/config.cpp

@@ -18,7 +18,7 @@ IPLSceneType SteamAudioConfig::scene_type = IPL_SCENETYPE_EMBREE; // TODO: suppo
 void SteamAudioConfig::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("get_global_log_level"), &SteamAudioConfig::get_global_log_level);
 	ClassDB::bind_method(D_METHOD("set_global_log_level", "p_global_log_level"), &SteamAudioConfig::set_global_log_level);
-	ADD_PROPERTY(PropertyInfo(Variant::INT, "global_log_level", PROPERTY_HINT_ENUM, "Debug,Info,Error"), "set_global_log_level", "get_global_log_level");
+	ADD_PROPERTY(PropertyInfo(Variant::INT, "global_log_level", PROPERTY_HINT_ENUM, "Debug,Info,Warning,Error"), "set_global_log_level", "get_global_log_level");
 
 	ADD_GROUP("Performance", "");
 	ClassDB::bind_method(D_METHOD("get_scene_type"), &SteamAudioConfig::get_scene_type);

src/player.cpp

@@ -5,9 +5,13 @@
 #include "godot_cpp/variant/utility_functions.hpp"
 #include "server.hpp"
 #include "server_init.hpp"
+#include "steam_audio.hpp"
 #include "stream.hpp"
 
 void SteamAudioPlayer::_bind_methods() {
+	ClassDB::bind_method(D_METHOD("play_stream", "stream", "from_offset", "volume_db", "pitch_scale"), &SteamAudioPlayer::play_stream, DEFVAL(0), DEFVAL(0), DEFVAL(1.0));
+	ClassDB::bind_method(D_METHOD("get_inner_stream"), &SteamAudioPlayer::get_inner_stream);
+
 	ClassDB::bind_method(D_METHOD("is_dist_attn_on"), &SteamAudioPlayer::is_dist_attn_on);
 	ClassDB::bind_method(D_METHOD("set_dist_attn_on", "p_dist_attn_on"), &SteamAudioPlayer::set_dist_attn_on);
 	ClassDB::bind_method(D_METHOD("get_min_attenuation_distance"), &SteamAudioPlayer::get_min_attenuation_dist);
@@ -217,6 +221,48 @@ void SteamAudioPlayer::process_internal(double delta) {
 	}
 }
 
+void SteamAudioPlayer::play_stream(const Ref<AudioStream> &p_stream, float p_from_offset, float p_volume_db, float p_pitch_scale) {
+	if (p_stream.is_null()) {
+		SteamAudio::log(SteamAudio::log_warn, "Tried to play a null stream, won't play anything.");
+		return;
+	}
+
+	if (this->is_playing()) {
+		this->stop();
+	}
+	this->play();
+
+	auto str = dynamic_cast<SteamAudioStream *>(get_stream().ptr());
+	if (str == nullptr) {
+		SteamAudio::log(SteamAudio::log_warn,
+				"Tried to get an inner stream from a SteamAudioPlayer, but its outer stream is not a SteamAudioStream. Returning null.");
+		return;
+	}
+	str->set_stream(p_stream);
+
+	auto playback_ptr = dynamic_cast<SteamAudioStreamPlayback *>(get_stream_playback().ptr());
+	if (playback_ptr == nullptr) {
+		SteamAudio::log(SteamAudio::log_warn,
+				"Tried to play a new stream on SteamAudioPlayer, but this player's outer stream was not a SteamAudioStream. Will not play anything.");
+		this->stop();
+		return;
+	}
+
+	playback_ptr->play_stream(p_stream, p_from_offset, p_volume_db, p_pitch_scale);
+}
+
+Ref<AudioStream> SteamAudioPlayer::get_inner_stream() {
+	auto str = dynamic_cast<SteamAudioStream *>(get_stream().ptr());
+	if (str == nullptr) {
+		SteamAudio::log(SteamAudio::log_warn,
+				"Tried to get an inner stream from a SteamAudioPlayer, but its outer stream is not a SteamAudioStream. Returning null.");
+		Ref<AudioStream> null_str;
+		return null_str;
+	}
+
+	return str->get_stream();
+}
+
 float SteamAudioPlayer::get_occlusion_radius() { return cfg.occ_radius; }
 void SteamAudioPlayer::set_occlusion_radius(float p_occlusion_radius) { cfg.occ_radius = p_occlusion_radius; }
 int SteamAudioPlayer::get_occlusion_samples() { return cfg.occ_samples; }

src/player.hpp

@@ -71,6 +71,9 @@ class SteamAudioPlayer : public AudioStreamPlayer3D {
 	bool is_occlusion_on();
 	void set_occlusion_on(bool p_occlusion_on);
 
+	void play_stream(const Ref<AudioStream> &p_stream, float p_from_offset, float p_volume_db, float p_pitch_scale);
+	Ref<AudioStream> get_inner_stream();
+
 	PackedStringArray _get_configuration_warnings() const override;
 };
 

src/server.cpp

@@ -163,13 +163,6 @@ void SteamAudioServer::tick() {
 	SteamAudio::log(SteamAudio::log_debug, "tick: done");
 }
 
-void SteamAudioServer::init_scene(IPLSceneSettings *scene_cfg) {
-	SteamAudio::log(SteamAudio::log_info, "Initializing SteamAudioServer scene");
-	IPLerror err = iplSceneCreate(global_state.ctx, scene_cfg, &global_state.scene);
-	handleErr(err);
-	global_state.scene = iplSceneRetain(global_state.scene);
-}
-
 GlobalSteamAudioState *SteamAudioServer::get_global_state(bool should_init) {
 	self->init_mux.lock();
 	if (self->is_global_state_init.load()) {
@@ -188,7 +181,10 @@ GlobalSteamAudioState *SteamAudioServer::get_global_state(bool should_init) {
 	global_state.ctx = create_ctx();
 
 	IPLSceneSettings scene_cfg = create_scene_cfg(global_state.ctx);
-	init_scene(&scene_cfg);
+	SteamAudio::log(SteamAudio::log_info, "Initializing SteamAudioServer scene");
+	IPLerror err = iplSceneCreate(global_state.ctx, &scene_cfg, &global_state.scene);
+	handleErr(err);
+	global_state.scene = iplSceneRetain(global_state.scene);
 	for (auto m : meshes_to_add) {
 		iplStaticMeshAdd(m, global_state.scene);
 	}

src/server_init.cpp

@@ -72,7 +72,7 @@ IPLSimulator create_simulator(IPLContext ctx, IPLAudioSettings audio_cfg, IPLSce
 }
 
 IPLSceneSettings create_scene_cfg(IPLContext ctx) {
-	IPLSceneSettings scene_cfg;
+	IPLSceneSettings scene_cfg = {};
 	scene_cfg.type = SteamAudioConfig::scene_type;
 	if (scene_cfg.type == IPL_SCENETYPE_EMBREE) {
 		IPLEmbreeDeviceSettings embree_cfg{};
@@ -81,12 +81,6 @@ IPLSceneSettings create_scene_cfg(IPLContext ctx) {
 		handleErr(err);
 		scene_cfg.embreeDevice = embree_dev;
 	}
-	scene_cfg.closestHitCallback = nullptr;
-	scene_cfg.anyHitCallback = nullptr;
-	scene_cfg.batchedClosestHitCallback = nullptr;
-	scene_cfg.batchedAnyHitCallback = nullptr;
-	scene_cfg.userData = nullptr;
-	scene_cfg.radeonRaysDevice = nullptr;
 	return scene_cfg;
 }
 

src/steam_audio.cpp

@@ -7,9 +7,15 @@ void SteamAudio::log(GodotSteamAudioLogLevel lvl, const char *str) {
 		return;
 	}
 
-	if (lvl < log_error) {
-		UtilityFunctions::print("[godot-steam-audio] ", str);
-	} else {
-		UtilityFunctions::push_error("[godot-steam-audio] ", str);
+	switch (lvl) {
+		case log_error:
+			UtilityFunctions::push_error("[godot-steam-audio] ", str);
+			return;
+		case log_warn:
+			UtilityFunctions::push_warning("[godot-steam-audio] ", str);
+			return;
+		default:
+			UtilityFunctions::print("[godot-steam-audio] ", str);
+			return;
 	}
 }

src/steam_audio.hpp

@@ -15,6 +15,7 @@ class SteamAudio {
 	typedef enum {
 		log_debug,
 		log_info,
+		log_warn,
 		log_error
 	} GodotSteamAudioLogLevel;
 

src/stream.cpp

@@ -24,6 +24,7 @@ Ref<AudioStreamPlayback> SteamAudioStream::_instantiate_playback() const {
 }
 
 void SteamAudioStream::set_stream(Ref<AudioStream> p_stream) { stream = p_stream; }
+Ref<AudioStream> SteamAudioStream::get_stream() { return this->stream; }
 
 // ----------------------------------------------------
 // SteamAudioStreamPlayback

src/stream.hpp

@@ -29,6 +29,7 @@ class SteamAudioStream : public AudioStream {
 
 	Ref<AudioStreamPlayback> _instantiate_playback() const override;
 	void set_stream(Ref<AudioStream> p_stream);
+	Ref<AudioStream> get_stream();
 
 	SteamAudioPlayer *parent;
 };