AudioDevice.cpp File Reference

#include "AudioDevice.h"
#include "ActiveSoundUpdateInterface.h"
#include "AudioCompressionSettingsUtils.h"
#include "AudioDecompress.h"
#include "AudioEffect.h"
#include "AudioPluginUtilities.h"
#include "Audio/AudioDebug.h"
#include "Audio/AudioTraceUtil.h"
#include "GameFramework/GameUserSettings.h"
#include "GameFramework/WorldSettings.h"
#include "GeneralProjectSettings.h"
#include "HAL/FileManager.h"
#include "IAudioParameterTransmitter.h"
#include "Misc/ConfigCacheIni.h"
#include "Misc/CoreStats.h"
#include "Misc/OutputDeviceArchiveWrapper.h"
#include "Misc/PackageName.h"
#include "PhysicsEngine/BodyInstance.h"
#include "ProfilingDebugging/ProfilingHelpers.h"
#include "Sound/SoundEffectSubmix.h"
#include "Sound/SoundGroups.h"
#include "Sound/SoundCue.h"
#include "Sound/SoundNodeWavePlayer.h"
#include "Sound/SoundSourceBus.h"
#include "Sound/SoundSubmix.h"
#include "Stats/StatsTrace.h"
#include "UnrealEngine.h"
#include "UObject/UObjectIterator.h"
#include "StereoRendering.h"
#include "UObject/Package.h"

Namespaces
namespace	Audio
	NO_LOGGING.
namespace	AudioDeviceUtils

Typedefs
using	AudioDeviceUtils::FVirtualLoopPair = TPair< FActiveSound *, FAudioVirtualLoop >

Functions
ICompressedAudioInfo *	Audio::CreateSoundAssetDecoder (const FName &InRuntimeFormat)
uint64	Audio::GetTransmitterID (uint64 ComponentID, UPTRINT WaveInstanceHash, uint32 PlayOrder)

Variables
FAutoConsoleVariableRef	CVarSetAudioChannelCount (TEXT("au.SetAudioChannelCount"), AudioChannelCountCVar, TEXT("0: Disable, >0: Enable"), ECVF_Default)
FAutoConsoleVariableRef	CVarSetAudioChannelScaleCount (TEXT("au.SetAudioChannelScaleCount"), AudioChannelCountScaleCVar, TEXT("Changes the audio channel count by percentage.\n"), ECVF_Default)
FAutoConsoleVariableRef	CVarDisableStoppingVoices (TEXT("au.DisableStoppingVoices"), DisableStoppingVoicesCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)
FAutoConsoleVariableRef	CVarDisableAppVolume (TEXT("au.DisableAppVolume"), DisableAppVolumeCvar, TEXT("0: App volume enabled, 1: App volume disabled"), ECVF_Default)
FAutoConsoleVariableRef	CVarDisableAutomaticPrecache (TEXT("au.DisableAutomaticPrecache"), DisableAutomaticPrecacheCvar, TEXT("0: Use normal precaching logic, 1: disables all precaching except for synchronous calls."), ECVF_Default)
FAutoConsoleVariableRef	CVarWaitForSoundWaveToLoad (TEXT("au.WaitForSoundWaveToLoad"), WaitForSoundWaveToLoadCvar, TEXT("0: Attempt to play back, 1: Wait for load."), ECVF_Default)
FAutoConsoleVariableRef	CVarBakedAnalysisEnabledCVar (TEXT("au.BakedAnalysisEnabled"), BakedAnalysisEnabledCVar, TEXT("Enables or disables queries to baked analysis from audio component.\n"), ECVF_Default)
FAutoConsoleVariableRef	CVarNumPrecacheFrames (TEXT("au.NumPrecacheFrames"), NumPrecacheFramesCvar, TEXT("0: Use default value for precache frames, >0: Number of frames to precache."), ECVF_Default)
FAutoConsoleVariableRef	CVarDisableLegacyReverb (TEXT("au.DisableLegacyReverb"), DisableLegacyReverb, TEXT("0: Enabled, 1: Disabled"), ECVF_Default)
FAutoConsoleVariableRef	CVarSoundDistanceOptimizationLength (TEXT("au.SoundDistanceOptimizationLength"), SoundDistanceOptimizationLengthCVar, TEXT("The maximum duration a sound must be in order to be a candidate to be culled due to one-shot distance optimization.\n"), ECVF_Default)
FAutoConsoleVariableRef	CVarEnableBinauralAudioForAllSpatialSounds (TEXT("au.EnableBinauralAudioForAllSpatialSounds"), EnableBinauralAudioForAllSpatialSoundsCVar, TEXT("Toggles binaural audio rendering for all spatial sounds if binaural rendering is available.\n"), ECVF_Default)
FAutoConsoleVariableRef	CVarDisableBinauralSpatialization (TEXT("au.DisableBinauralSpatialization"), DisableBinauralSpatializationCVar, TEXT("Disables binaural spatialization.\n"), ECVF_Default)
FAutoConsoleVariableRef	CVarFlushAudioRenderThreadOnGC (TEXT("au.FlushAudioRenderThreadOnGC"), FlushAudioRenderThreadOnGCCVar, TEXT("When set to 1, every time the GC runs, we flush all pending audio render thread commands.\n"), ECVF_Default)
FAutoConsoleVariableRef	CVarSetAudioMaxDistance (TEXT("au.MaxWorldDistance"), MaxWorldDistanceCVar, TEXT("Maximum world distance used in audio-related calculations (eg. attenuation).\n"), ECVF_Default)
FAutoConsoleVariableRef	CVarEnableRelativeRenderCostVoiceLimit (TEXT("au.EnableRelativeRenderCostVoiceLimit"), EnableRelativeRenderCostVoiceLimitCVar, TEXT("Enables or disables using the relative render cost of rendering sources to count toward max channels culling."), ECVF_Default)
int32	AudioDeviceUtils::PrecachedRealtime = 0
int32	AudioDeviceUtils::PrecachedNative = 0
int32	AudioDeviceUtils::TotalNativeSize = 0
float	AudioDeviceUtils::AverageNativeLength = 0.f
TMap< int32, int32 >	AudioDeviceUtils::NativeChannelCount
TMap< int32, int32 >	AudioDeviceUtils::NativeSampleRateCount

Variable Documentation

CVarBakedAnalysisEnabledCVar

FAutoConsoleVariableRef CVarBakedAnalysisEnabledCVar(TEXT("au.BakedAnalysisEnabled"), BakedAnalysisEnabledCVar, TEXT("Enables or disables queries to baked analysis from audio component.\n"), ECVF_Default)	(	TEXT("au.BakedAnalysisEnabled")	,
		BakedAnalysisEnabledCVar	,
		TEXT("Enables or disables queries to baked analysis from audio component.\n")	,
		ECVF_Default
	)

CVarDisableAppVolume

FAutoConsoleVariableRef CVarDisableAppVolume(TEXT("au.DisableAppVolume"), DisableAppVolumeCvar, TEXT("0: App volume enabled, 1: App volume disabled"), ECVF_Default)	(	TEXT("au.DisableAppVolume")	,
		DisableAppVolumeCvar	,
		TEXT("0: App volume enabled, 1: App volume disabled")	,
		ECVF_Default
	)

CVarDisableAutomaticPrecache

FAutoConsoleVariableRef CVarDisableAutomaticPrecache(TEXT("au.DisableAutomaticPrecache"), DisableAutomaticPrecacheCvar, TEXT("0: Use normal precaching logic, 1: disables all precaching except for synchronous calls."), ECVF_Default)	(	TEXT("au.DisableAutomaticPrecache")	,
		DisableAutomaticPrecacheCvar	,
		TEXT("0: Use normal precaching logic, 1: disables all precaching except for synchronous calls.")	,
		ECVF_Default
	)

CVarDisableBinauralSpatialization

FAutoConsoleVariableRef CVarDisableBinauralSpatialization(TEXT("au.DisableBinauralSpatialization"), DisableBinauralSpatializationCVar, TEXT("Disables binaural spatialization.\n"), ECVF_Default)	(	TEXT("au.DisableBinauralSpatialization")	,
		DisableBinauralSpatializationCVar	,
		TEXT("Disables binaural spatialization.\n")	,
		ECVF_Default
	)

CVarDisableLegacyReverb

FAutoConsoleVariableRef CVarDisableLegacyReverb(TEXT("au.DisableLegacyReverb"), DisableLegacyReverb, TEXT("0: Enabled, 1: Disabled"), ECVF_Default)	(	TEXT("au.DisableLegacyReverb")	,
		DisableLegacyReverb	,
		TEXT("0: Enabled, 1: Disabled")	,
		ECVF_Default
	)

CVarDisableStoppingVoices

FAutoConsoleVariableRef CVarDisableStoppingVoices(TEXT("au.DisableStoppingVoices"), DisableStoppingVoicesCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)	(	TEXT("au.DisableStoppingVoices")	,
		DisableStoppingVoicesCvar	,
		TEXT("0: Not Disabled, 1: Disabled")	,
		ECVF_Default
	)

CVarEnableBinauralAudioForAllSpatialSounds

FAutoConsoleVariableRef CVarEnableBinauralAudioForAllSpatialSounds(TEXT("au.EnableBinauralAudioForAllSpatialSounds"), EnableBinauralAudioForAllSpatialSoundsCVar, TEXT("Toggles binaural audio rendering for all spatial sounds if binaural rendering is available.\n"), ECVF_Default)	(	TEXT("au.EnableBinauralAudioForAllSpatialSounds")	,
		EnableBinauralAudioForAllSpatialSoundsCVar	,
		TEXT("Toggles binaural audio rendering for all spatial sounds if binaural rendering is available.\n")	,
		ECVF_Default
	)

CVarEnableRelativeRenderCostVoiceLimit

FAutoConsoleVariableRef CVarEnableRelativeRenderCostVoiceLimit(TEXT("au.EnableRelativeRenderCostVoiceLimit"), EnableRelativeRenderCostVoiceLimitCVar, TEXT("Enables or disables using the relative render cost of rendering sources to count toward max channels culling."), ECVF_Default)	(	TEXT("au.EnableRelativeRenderCostVoiceLimit")	,
		EnableRelativeRenderCostVoiceLimitCVar	,
		TEXT("Enables or disables using the relative render cost of rendering sources to count toward max channels culling.")	,
		ECVF_Default
	)

CVarFlushAudioRenderThreadOnGC

FAutoConsoleVariableRef CVarFlushAudioRenderThreadOnGC(TEXT("au.FlushAudioRenderThreadOnGC"), FlushAudioRenderThreadOnGCCVar, TEXT("When set to 1, every time the GC runs, we flush all pending audio render thread commands.\n"), ECVF_Default)	(	TEXT("au.FlushAudioRenderThreadOnGC")	,
		FlushAudioRenderThreadOnGCCVar	,
		TEXT("When set to 1, every time the GC runs, we flush all pending audio render thread commands.\n")	,
		ECVF_Default
	)

CVarNumPrecacheFrames

FAutoConsoleVariableRef CVarNumPrecacheFrames(TEXT("au.NumPrecacheFrames"), NumPrecacheFramesCvar, TEXT("0: Use default value for precache frames, >0: Number of frames to precache."), ECVF_Default)	(	TEXT("au.NumPrecacheFrames")	,
		NumPrecacheFramesCvar	,
		TEXT("0: Use default value for precache frames, >0: Number of frames to precache.")	,
		ECVF_Default
	)

CVarSetAudioChannelCount

FAutoConsoleVariableRef CVarSetAudioChannelCount(TEXT("au.SetAudioChannelCount"), AudioChannelCountCVar, TEXT("0: Disable, >0: Enable"), ECVF_Default)	(	TEXT("au.SetAudioChannelCount")	,
		AudioChannelCountCVar	,
		TEXT("0: Disable, >0: Enable")	,
		ECVF_Default
	)

CVarSetAudioChannelScaleCount

FAutoConsoleVariableRef CVarSetAudioChannelScaleCount(TEXT("au.SetAudioChannelScaleCount"), AudioChannelCountScaleCVar, TEXT("Changes the audio channel count by percentage.\n"), ECVF_Default)	(	TEXT("au.SetAudioChannelScaleCount")	,
		AudioChannelCountScaleCVar	,
		TEXT("Changes the audio channel count by percentage.\n")	,
		ECVF_Default
	)

CVarSetAudioMaxDistance

FAutoConsoleVariableRef CVarSetAudioMaxDistance(TEXT("au.MaxWorldDistance"), MaxWorldDistanceCVar, TEXT("Maximum world distance used in audio-related calculations (eg. attenuation).\n"), ECVF_Default)	(	TEXT("au.MaxWorldDistance")	,
		MaxWorldDistanceCVar	,
		TEXT("Maximum world distance used in audio-related calculations (eg. attenuation).\n")	,
		ECVF_Default
	)

CVarSoundDistanceOptimizationLength

FAutoConsoleVariableRef CVarSoundDistanceOptimizationLength(TEXT("au.SoundDistanceOptimizationLength"), SoundDistanceOptimizationLengthCVar, TEXT("The maximum duration a sound must be in order to be a candidate to be culled due to one-shot distance optimization.\n"), ECVF_Default)	(	TEXT("au.SoundDistanceOptimizationLength")	,
		SoundDistanceOptimizationLengthCVar	,
		TEXT("The maximum duration a sound must be in order to be a candidate to be culled due to one-shot distance optimization.\n")	,
		ECVF_Default
	)

CVarWaitForSoundWaveToLoad

FAutoConsoleVariableRef CVarWaitForSoundWaveToLoad(TEXT("au.WaitForSoundWaveToLoad"), WaitForSoundWaveToLoadCvar, TEXT("0: Attempt to play back, 1: Wait for load."), ECVF_Default)	(	TEXT("au.WaitForSoundWaveToLoad")	,
		WaitForSoundWaveToLoadCvar	,
		TEXT("0: Attempt to play back, 1: Wait for load.")	,
		ECVF_Default
	)