Introducing Resonate — An all-in-one audio manager (sound & music)

hugemenace · February 3, 2024, 3:29am

Introducing Resonate — an all-in-one sound and music management addon for the Godot game engine. Features:

Pooled audio stream players.
Automatic 2D and 3D space detection.
Polyphonic playback.
Stemmed music tracks.
Music crossfading.

Resonate has two core systems: the SoundManager and the MusicManager.

The SoundManager automatically pools and orchestrates AudioStreamPlayers for you and gives you control over the players when needed.

The MusicManager composes music tracks built from stems and supports the (cross)fading of tracks or stems out of the box.

For full details, visit the GitHub page.

Open to feedback and contributions.

alextheukrainian · February 4, 2024, 3:13pm

Seems pretty cool! 2 things I noted:

The ability to set per-stream volume variation in resource/config seems missing. Sure, I can call trigger_varied, but when balancing volume of individual sounds, I want to set it in config somewhere and then all calling code will use that default volume, it’s easier. For ex, in my game, most sounds do not play at 0db, but instead at -2, -4, or +3db. Fixing volume level in each sound file is just more work than using a config. Not sure if the same is true for music, didnt’ look at music stuff, but per-stream config of volume is also good for music files.
Super minor this, but noticed this code in sound_manager.gd:


	if event.streams.size() == 0:
		push_error("Resonate - The music track [%s] on bank [%s] has no stems, you'll need to add one at minimum." % [p_event_name, p_bank_label])
		return
		
	var player = get_player(p_attachment)
	
	if event.streams.size() == 0 or player == null:
		push_error("Resonate - The event [%s] on bank [%s] can't be played; no streams or players available." % [p_event_name, p_bank_label])
		return null

The “event.streams.size() == 0 or” in the second “if” seems unnecessary since the code will never get there if indeed that condition is true. Error message should be updated respectively, if you update the if statement.

Congrats on releasing an addon, cheers!

hugemenace · February 4, 2024, 10:34pm

Thanks for the feedback! I agree with both points, so I’ll action those and include them in the next release, which might be out later today.

hugemenace · February 6, 2024, 8:49am

Version 2.3.0 has just been released!

Features:

add a volume variable to sound events (bank-configured)
add enhanced return types, signals, and helper methods to the music manager
add null object pattern to the sound manager for instances and some additional helper methods and events for implementation
add pitch variable to sound event resources and fix pitch and volume behaviour across audio stream players
add play_varied, play_at_position_varied, and play_on_node_varied methods to the sound manager
add reset_volume, reset_pitch, and reset_all methods to pooled audio stream players
add the quick_instance method to the sound manager for bulk instances, or for shorter registration calls

Bug fixes:

ensure that pooled audio stream players return the player volume back to the base volume when calling trigger after trigger_varied, and that trigger_varied isn’t affected by the base volume on polyphonic playback
fix the “signal already connected” error in multiple single-script auto_released instances and ensure the connection is deferred
fix the error handling & messages for missing streams or players in the sound manager
fix the volume adjustment in the trigger_varied method on non-polyphonic pooled audio stream players
increase the volume step resolution on music stem resources to allow for fractional dBs
push a warning when instanced sound events that contain looping variations are released with “finish playing” - these will be forced to stop playback

The new version may take a little time to appear on the Godot Asset Library. However, you can always grab the latest version from the GitHub releases page if you don’t want to wait.

hugemenace · February 7, 2024, 9:47am

Version 2.3.1 has been released.

This version fixes up a couple of loose ends in the 2.3.0 release.

Bug fixes:

ensure 3D players registered as auto-released aren’t lost during scene tree exiting events
fix the project settings registration process when the addon loads