File size: 11,662 Bytes
1e67697 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 | // Copyright Epic Games, Inc. All Rights Reserved.
#include "Audio/LyraAudioMixEffectsSubsystem.h"
#include "AudioMixerBlueprintLibrary.h"
#include "AudioModulationStatics.h"
#include "Engine/GameInstance.h"
#include "Engine/World.h"
#include "LoadingScreenManager.h"
#include "LyraAudioSettings.h"
#include "Settings/LyraSettingsLocal.h"
#include "Sound/SoundEffectSubmix.h"
#include "SoundControlBus.h"
#include "SoundControlBusMix.h"
#include UE_INLINE_GENERATED_CPP_BY_NAME(LyraAudioMixEffectsSubsystem)
class FSubsystemCollectionBase;
void ULyraAudioMixEffectsSubsystem::Initialize(FSubsystemCollectionBase& Collection)
{
Super::Initialize(Collection);
}
void ULyraAudioMixEffectsSubsystem::Deinitialize()
{
if (ULoadingScreenManager* LoadingScreenManager = UGameInstance::GetSubsystem<ULoadingScreenManager>(GetWorld()->GetGameInstance()))
{
LoadingScreenManager->OnLoadingScreenVisibilityChangedDelegate().RemoveAll(this);
ApplyOrRemoveLoadingScreenMix(false);
}
Super::Deinitialize();
}
bool ULyraAudioMixEffectsSubsystem::ShouldCreateSubsystem(UObject* Outer) const
{
bool bShouldCreateSubsystem = Super::ShouldCreateSubsystem(Outer);
if (Outer)
{
if (UWorld* World = Outer->GetWorld())
{
bShouldCreateSubsystem = DoesSupportWorldType(World->WorldType) && bShouldCreateSubsystem;
}
}
return bShouldCreateSubsystem;
}
void ULyraAudioMixEffectsSubsystem::PostInitialize()
{
if (const ULyraAudioSettings* LyraAudioSettings = GetDefault<ULyraAudioSettings>())
{
if (UObject* ObjPath = LyraAudioSettings->DefaultControlBusMix.TryLoad())
{
if (USoundControlBusMix* SoundControlBusMix = Cast<USoundControlBusMix>(ObjPath))
{
DefaultBaseMix = SoundControlBusMix;
}
else
{
ensureMsgf(SoundControlBusMix, TEXT("Default Control Bus Mix reference missing from Lyra Audio Settings."));
}
}
if (UObject* ObjPath = LyraAudioSettings->LoadingScreenControlBusMix.TryLoad())
{
if (USoundControlBusMix* SoundControlBusMix = Cast<USoundControlBusMix>(ObjPath))
{
LoadingScreenMix = SoundControlBusMix;
}
else
{
ensureMsgf(SoundControlBusMix, TEXT("Loading Screen Control Bus Mix reference missing from Lyra Audio Settings."));
}
}
if (UObject* ObjPath = LyraAudioSettings->UserSettingsControlBusMix.TryLoad())
{
if (USoundControlBusMix* SoundControlBusMix = Cast<USoundControlBusMix>(ObjPath))
{
UserMix = SoundControlBusMix;
}
else
{
ensureMsgf(SoundControlBusMix, TEXT("User Control Bus Mix reference missing from Lyra Audio Settings."));
}
}
if (UObject* ObjPath = LyraAudioSettings->OverallVolumeControlBus.TryLoad())
{
if (USoundControlBus* SoundControlBus = Cast<USoundControlBus>(ObjPath))
{
OverallControlBus = SoundControlBus;
}
else
{
ensureMsgf(SoundControlBus, TEXT("Overall Control Bus reference missing from Lyra Audio Settings."));
}
}
if (UObject* ObjPath = LyraAudioSettings->MusicVolumeControlBus.TryLoad())
{
if (USoundControlBus* SoundControlBus = Cast<USoundControlBus>(ObjPath))
{
MusicControlBus = SoundControlBus;
}
else
{
ensureMsgf(SoundControlBus, TEXT("Music Control Bus reference missing from Lyra Audio Settings."));
}
}
if (UObject* ObjPath = LyraAudioSettings->SoundFXVolumeControlBus.TryLoad())
{
if (USoundControlBus* SoundControlBus = Cast<USoundControlBus>(ObjPath))
{
SoundFXControlBus = SoundControlBus;
}
else
{
ensureMsgf(SoundControlBus, TEXT("SoundFX Control Bus reference missing from Lyra Audio Settings."));
}
}
if (UObject* ObjPath = LyraAudioSettings->DialogueVolumeControlBus.TryLoad())
{
if (USoundControlBus* SoundControlBus = Cast<USoundControlBus>(ObjPath))
{
DialogueControlBus = SoundControlBus;
}
else
{
ensureMsgf(SoundControlBus, TEXT("Dialogue Control Bus reference missing from Lyra Audio Settings."));
}
}
if (UObject* ObjPath = LyraAudioSettings->VoiceChatVolumeControlBus.TryLoad())
{
if (USoundControlBus* SoundControlBus = Cast<USoundControlBus>(ObjPath))
{
VoiceChatControlBus = SoundControlBus;
}
else
{
ensureMsgf(SoundControlBus, TEXT("VoiceChat Control Bus reference missing from Lyra Audio Settings."));
}
}
// Load HDR Submix Effect Chain
for (const FLyraSubmixEffectChainMap& SoftSubmixEffectChain : LyraAudioSettings->HDRAudioSubmixEffectChain)
{
FLyraAudioSubmixEffectsChain NewEffectChain;
if (UObject* SubmixObjPath = SoftSubmixEffectChain.Submix.LoadSynchronous())
{
if (USoundSubmix* Submix = Cast<USoundSubmix>(SubmixObjPath))
{
NewEffectChain.Submix = Submix;
TArray<USoundEffectSubmixPreset*> NewPresetChain;
for (const TSoftObjectPtr<USoundEffectSubmixPreset>& SoftEffect : SoftSubmixEffectChain.SubmixEffectChain)
{
if (UObject* EffectObjPath = SoftEffect.LoadSynchronous())
{
if (USoundEffectSubmixPreset* SubmixPreset = Cast<USoundEffectSubmixPreset>(EffectObjPath))
{
NewPresetChain.Add(SubmixPreset);
}
}
}
NewEffectChain.SubmixEffectChain.Append(NewPresetChain);
}
}
HDRSubmixEffectChain.Add(NewEffectChain);
}
// Load LDR Submix Effect Chain
for (const FLyraSubmixEffectChainMap& SoftSubmixEffectChain : LyraAudioSettings->LDRAudioSubmixEffectChain)
{
FLyraAudioSubmixEffectsChain NewEffectChain;
if (UObject* SubmixObjPath = SoftSubmixEffectChain.Submix.LoadSynchronous())
{
if (USoundSubmix* Submix = Cast<USoundSubmix>(SubmixObjPath))
{
NewEffectChain.Submix = Submix;
TArray<USoundEffectSubmixPreset*> NewPresetChain;
for (const TSoftObjectPtr<USoundEffectSubmixPreset>& SoftEffect : SoftSubmixEffectChain.SubmixEffectChain)
{
if (UObject* EffectObjPath = SoftEffect.LoadSynchronous())
{
if (USoundEffectSubmixPreset* SubmixPreset = Cast<USoundEffectSubmixPreset>(EffectObjPath))
{
NewPresetChain.Add(SubmixPreset);
}
}
}
NewEffectChain.SubmixEffectChain.Append(NewPresetChain);
}
}
LDRSubmixEffectChain.Add(NewEffectChain);
}
}
// Register with the loading screen manager
if (ULoadingScreenManager* LoadingScreenManager = UGameInstance::GetSubsystem<ULoadingScreenManager>(GetWorld()->GetGameInstance()))
{
LoadingScreenManager->OnLoadingScreenVisibilityChangedDelegate().AddUObject(this, &ThisClass::OnLoadingScreenStatusChanged);
ApplyOrRemoveLoadingScreenMix(LoadingScreenManager->GetLoadingScreenDisplayStatus());
}
}
void ULyraAudioMixEffectsSubsystem::OnWorldBeginPlay(UWorld& InWorld)
{
if (const UWorld* World = InWorld.GetWorld())
{
// Activate the default base mix
if (DefaultBaseMix)
{
UAudioModulationStatics::ActivateBusMix(World, DefaultBaseMix);
}
// Retrieve the user settings
if (const ULyraSettingsLocal* LyraSettingsLocal = GetDefault<ULyraSettingsLocal>())
{
// Activate the User Mix
if (UserMix)
{
UAudioModulationStatics::ActivateBusMix(World, UserMix);
if (OverallControlBus && MusicControlBus && SoundFXControlBus && DialogueControlBus && VoiceChatControlBus)
{
const FSoundControlBusMixStage OverallControlBusMixStage = UAudioModulationStatics::CreateBusMixStage(World, OverallControlBus, LyraSettingsLocal->GetOverallVolume());
const FSoundControlBusMixStage MusicControlBusMixStage = UAudioModulationStatics::CreateBusMixStage(World, MusicControlBus, LyraSettingsLocal->GetMusicVolume());
const FSoundControlBusMixStage SoundFXControlBusMixStage = UAudioModulationStatics::CreateBusMixStage(World, SoundFXControlBus, LyraSettingsLocal->GetSoundFXVolume());
const FSoundControlBusMixStage DialogueControlBusMixStage = UAudioModulationStatics::CreateBusMixStage(World, DialogueControlBus, LyraSettingsLocal->GetDialogueVolume());
const FSoundControlBusMixStage VoiceChatControlBusMixStage = UAudioModulationStatics::CreateBusMixStage(World, VoiceChatControlBus, LyraSettingsLocal->GetVoiceChatVolume());
TArray<FSoundControlBusMixStage> ControlBusMixStageArray;
ControlBusMixStageArray.Add(OverallControlBusMixStage);
ControlBusMixStageArray.Add(MusicControlBusMixStage);
ControlBusMixStageArray.Add(SoundFXControlBusMixStage);
ControlBusMixStageArray.Add(DialogueControlBusMixStage);
ControlBusMixStageArray.Add(VoiceChatControlBusMixStage);
UAudioModulationStatics::UpdateMix(World, UserMix, ControlBusMixStageArray);
}
}
ApplyDynamicRangeEffectsChains(LyraSettingsLocal->IsHDRAudioModeEnabled());
}
}
}
void ULyraAudioMixEffectsSubsystem::ApplyDynamicRangeEffectsChains(bool bHDRAudio)
{
TArray<FLyraAudioSubmixEffectsChain> AudioSubmixEffectsChainToApply;
TArray<FLyraAudioSubmixEffectsChain> AudioSubmixEffectsChainToClear;
// If HDR Audio is selected, then we clear out any existing LDR Submix Effect Chain Overrides
// otherwise the reverse is the case.
if (bHDRAudio)
{
AudioSubmixEffectsChainToApply.Append(HDRSubmixEffectChain);
AudioSubmixEffectsChainToClear.Append(LDRSubmixEffectChain);
}
else
{
AudioSubmixEffectsChainToApply.Append(LDRSubmixEffectChain);
AudioSubmixEffectsChainToClear.Append(HDRSubmixEffectChain);
}
// We want to collect just the submixes we need to actually clear, otherwise they'll be overridden by the new settings
TArray<USoundSubmix*> SubmixesLeftToClear;
// We want to get the submixes that are not being overridden by the new effect chains, so we can clear those out separately
for (const FLyraAudioSubmixEffectsChain& EffectChainToClear : AudioSubmixEffectsChainToClear)
{
bool bAddToList = true;
for (const FLyraAudioSubmixEffectsChain& SubmixEffectChain : AudioSubmixEffectsChainToApply)
{
if (SubmixEffectChain.Submix == EffectChainToClear.Submix)
{
bAddToList = false;
break;
}
}
if (bAddToList)
{
SubmixesLeftToClear.Add(EffectChainToClear.Submix);
}
}
// Override submixes
for (const FLyraAudioSubmixEffectsChain& SubmixEffectChain : AudioSubmixEffectsChainToApply)
{
if (SubmixEffectChain.Submix)
{
UAudioMixerBlueprintLibrary::SetSubmixEffectChainOverride(GetWorld(), SubmixEffectChain.Submix, SubmixEffectChain.SubmixEffectChain, 0.1f);
}
}
// Clear remaining submixes
for (USoundSubmix* Submix : SubmixesLeftToClear)
{
UAudioMixerBlueprintLibrary::ClearSubmixEffectChainOverride(GetWorld(), Submix, 0.1f);
}
}
void ULyraAudioMixEffectsSubsystem::OnLoadingScreenStatusChanged(bool bShowingLoadingScreen)
{
ApplyOrRemoveLoadingScreenMix(bShowingLoadingScreen);
}
void ULyraAudioMixEffectsSubsystem::ApplyOrRemoveLoadingScreenMix(bool bWantsLoadingScreenMix)
{
UWorld* World = GetWorld();
if (bAppliedLoadingScreenMix != bWantsLoadingScreenMix && LoadingScreenMix && World)
{
if (bWantsLoadingScreenMix)
{
// Apply the mix
UAudioModulationStatics::ActivateBusMix(World, LoadingScreenMix);
}
else
{
// Remove the mix
UAudioModulationStatics::DeactivateBusMix(World, LoadingScreenMix);
}
bAppliedLoadingScreenMix = bWantsLoadingScreenMix;
}
}
bool ULyraAudioMixEffectsSubsystem::DoesSupportWorldType(const EWorldType::Type World) const
{
// We only need this subsystem on Game worlds (PIE included)
return (World == EWorldType::Game || World == EWorldType::PIE);
}
|