Unreal Audio DSP Template (UE5)

[Current main branch version: UE5.7, for other versions check repo branches]

A simple Unreal 5 plugin with demo content that shows how audio DSP processing can be done implementing a Metasound Node, SourceEffect and SubmixEffect.

A volume effect with its amplitude parameter is used to demonstrate how to do basic DSP processing.

The intention of this project is to use it as a start point to create more complex audio DSP effects.

The most relevant parts of the code are located in:

• Plugins/AudioDSPTemplate/Source/AudioDSPTemplate/Private
• Plugins/AudioDSPTemplate/Source/AudioDSPTemplate/Public

Build steps

• Clone repository
• Right click UEAudioDSPTemplate.uproject > Generate Visual Studio projects files
• Open UEAudioDSPTemplate.sln
• Build Solution

Testing the plugin

• Open UEAudioDSPTemplate.uproject (or start it from Visual Studio)
• DemoMap will be automatically loaded
• Metasound:
  • Open VolumeNode_Metasound asset
  • Click Play button to start the Metasound
• SourceEffect and SubmixEffect:
  • Go to Blueprints > Open Level Blueprint
  • You will see that there is Blueprint logic to trigger a sound at the Sphere location and a Timeline that will drive the Amplitude parameter of the SourceEffect
  • If you want to test the Submix effect simply connect the Update port from Timeline to the Set Settings node of the SubmixEffect
  • Click Play button to start the Level

Note for Metasounds:

• If you plan to create new Metasound nodes in your own plugin/project use the Metasound registration macros in the same way as they are used in AudioDSPTemplate.cpp, otherwise your custom MetaSound(s) node(s) will not be available in the Metasound editor.

Showcase

Metasound:

SourceEffect and SubmixEffect: