AudioMixerSourceManager.cpp File Reference

#include "AudioMixerSourceManager.h"
#include "Audio/AudioTimingLog.h"
#include "AudioDefines.h"
#include "AudioMixer.h"
#include "AudioMixerCVars.h"
#include "AudioMixerDevice.h"
#include "AudioMixerSourceBuffer.h"
#include "AudioMixerSourceVoice.h"
#include "AudioMixerSubmix.h"
#include "AudioMixerTrace.h"
#include "AudioRenderScheduler.h"
#include "AudioThread.h"
#include "DSP/FloatArrayMath.h"
#include "IAudioExtensionPlugin.h"
#include "Sound/SoundModulationDestination.h"
#include "SoundFieldRendering.h"
#include "ProfilingDebugging/CsvProfiler.h"
#include "Async/Async.h"
#include "ProfilingDebugging/CountersTrace.h"
#include "HAL/PlatformStackWalk.h"
#include "Stats/Stats.h"
#include "Tasks/Task.h"
#include "Trace/Trace.h"

Namespaces
namespace	Audio
	NO_LOGGING.

Macros
#define	AUDIO_MIXER_THREAD_COMMAND_STRING(X)   (X)
#define	ENVELOPE_TAIL_THRESHOLD   (1.58489e-5f)
#define	VALIDATE_SOURCE_MIXER_STATE   1
#define	AUDIO_MIXER_DEBUG_LOG(SourceId, Message)
#define	CASE_ENUM_TO_TEXT(TXT)   case TXT: return TEXT(#TXT);

Functions
	CSV_DECLARE_CATEGORY_MODULE_EXTERN (AUDIOMIXERCORE_API, Audio)
	TRACE_DECLARE_ATOMIC_INT_COUNTER (AudioMixerSourceManager_TotalQdCmds, TEXT("AudioSourceManager Qd Cmds"))
	DEFINE_STAT (STAT_AudioMixerHRTF)
	DEFINE_STAT (STAT_AudioMixerSourceBuffers)
	DEFINE_STAT (STAT_AudioMixerSourceEffectBuffers)
	DEFINE_STAT (STAT_AudioMixerSourceManagerUpdate)
	DEFINE_STAT (STAT_AudioMixerSourceOutputBuffers)
const TCHAR *	LexToString (ESourceManagerRenderThreadPhase InPhase)
int32	Audio::GetCommandBufferInitialCapacity ()
bool	Audio::IsAudioBufferSilent (const float *AudioBuffer, const int32 NumSamples)

Variables
FAutoConsoleVariableRef	CVarDisableParallelSourceProcessing (TEXT("au.DisableParallelSourceProcessing"), DisableParallelSourceProcessingCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)
FAutoConsoleVariableRef	CVarDisableFiltering (TEXT("au.DisableFiltering"), DisableFilteringCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)
FAutoConsoleVariableRef	CVarDisableHPFiltering (TEXT("au.DisableHPFiltering"), DisableHPFilteringCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)
FAutoConsoleVariableRef	CVarDisableEnvelopeFollowing (TEXT("au.DisableEnvelopeFollowing"), DisableEnvelopeFollowingCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)
FAutoConsoleVariableRef	CVarDisableSourceEffects (TEXT("au.DisableSourceEffects"), DisableSourceEffectsCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)
FAutoConsoleVariableRef	CVarDisableDistanceAttenuation (TEXT("au.DisableDistanceAttenuation"), DisableDistanceAttenuationCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)
FAutoConsoleVariableRef	CVarBypassAudioPlugins (TEXT("au.BypassAudioPlugins"), BypassAudioPluginsCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)
FAutoConsoleVariableRef	CVarFlushCommandBufferOnTimeout (TEXT("au.FlushCommandBufferOnTimeout"), FlushCommandBufferOnTimeoutCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)
FAutoConsoleVariableRef	CVarCommandBufferFlushWaitTimeMs (TEXT("au.CommandBufferFlushWaitTimeMs"), CommandBufferFlushWaitTimeMsCvar, TEXT("How long to wait for the command buffer flush to complete.\n"), ECVF_Default)
FAutoConsoleVariableRef	CVarCommandBufferMaxSizeMb (TEXT("au.CommandBufferMaxSizeInMb"), CommandBufferMaxSizeInMbCvar, TEXT("How big to allow the command buffer to grow before ignoring more commands"), ECVF_Default)
FAutoConsoleVariableRef	CVarCommandBufferInitialCapacity (TEXT("au.CommandBufferInitialCapacity"), CommandBufferInitialCapacityCvar, TEXT("How many elements to initialize the command buffer capacity with"), ECVF_Default)
FAutoConsoleVariableRef	CVarAudioCommandExecTimeMsWarningThreshold (TEXT("au.AudioThreadCommand.ExecutionTimeWarningThresholdInMs"), AudioCommandExecTimeMsWarningThresholdCvar, TEXT("If a command took longer to execute than this number (in milliseconds) then we log a warning"), ECVF_Default)
FAutoConsoleVariableRef	LogEveryAudioThreadCommand (TEXT("au.AudioThreadCommand.LogEveryExecution"), LogEveryAudioThreadCommandCvar, TEXT("Extremely verbose logging of each Audio Thread command caller and it's execution time"), ECVF_Default)
FAutoConsoleVariableRef	CVarLogCmdQueueWhenNumberReached (TEXT("au.debug.LogCmdQueueWhenReached"), LogCmdQueueWhenNumberReachedCVar, TEXT("When number of commands in queue is reached, it will dump the command list to the log."), ECVF_Cheat)
FAutoConsoleVariableRef	CVarNumCmdsConsideredFullCVar (TEXT("au.NumCmdsConsideredFullCVar"), NumCmdsConsideredFullCVar, TEXT("Num of commands in the queue is considered full"), ECVF_Default)
FAutoConsoleVariableRef	CVarFloatCompareMinScale (TEXT("au.FloatCompareMinScale"), FloatCompareMinScaleCVar, TEXT("Minimum parameter float compare tolerance"), ECVF_Default)
FAutoConsoleVariableRef	CVarFloatCompareMaxScale (TEXT("au.FloatCompareMaxScale"), FloatCompareMaxScaleCVar, TEXT("Maximum parameter float compare tolerance"), ECVF_Default)
FAutoConsoleVariableRef	CVarDumpCallstackOnStallDiagnostics (TEXT("au.DumpCallstackOnStallDiagnostics"), bDumpCallstackOnStallDiagnostics, TEXT("Whether to dump the callstack to the log as part of stall diagnostics (default = true)"), ECVF_Default)
FAutoConsoleVariableRef	CVarAudioMixerPerSourceResampling (TEXT("au.PerSourceResampling"), PerSourceResampling, TEXT("0: Disabled, 1: Enabled"), ECVF_Default)

Macro Definition Documentation

AUDIO_MIXER_DEBUG_LOG

#define AUDIO_MIXER_DEBUG_LOG	(		SourceId,
			Message
	)

AUDIO_MIXER_THREAD_COMMAND_STRING

#define AUDIO_MIXER_THREAD_COMMAND_STRING

(

X

)

(X)

CASE_ENUM_TO_TEXT

#define CASE_ENUM_TO_TEXT

(

TXT

)

case TXT: return TEXT(#TXT);

ENVELOPE_TAIL_THRESHOLD

#define ENVELOPE_TAIL_THRESHOLD   (1.58489e-5f)

VALIDATE_SOURCE_MIXER_STATE

#define VALIDATE_SOURCE_MIXER_STATE   1

Function Documentation

CSV_DECLARE_CATEGORY_MODULE_EXTERN()

CSV_DECLARE_CATEGORY_MODULE_EXTERN	(	AUDIOMIXERCORE_API	,
		Audio
	)

DEFINE_STAT() [1/5]

DEFINE_STAT

(

STAT_AudioMixerHRTF

)

DEFINE_STAT() [2/5]

DEFINE_STAT

(

STAT_AudioMixerSourceBuffers

)

DEFINE_STAT() [3/5]

DEFINE_STAT

(

STAT_AudioMixerSourceEffectBuffers

)

DEFINE_STAT() [4/5]

DEFINE_STAT

(

STAT_AudioMixerSourceManagerUpdate

)

DEFINE_STAT() [5/5]

DEFINE_STAT

(

STAT_AudioMixerSourceOutputBuffers

)

LexToString()

const TCHAR * LexToString

(

ESourceManagerRenderThreadPhase

InPhase

)

TRACE_DECLARE_ATOMIC_INT_COUNTER()

TRACE_DECLARE_ATOMIC_INT_COUNTER	(	AudioMixerSourceManager_TotalQdCmds	,
		TEXT("AudioSourceManager Qd Cmds")
	)

Variable Documentation

CVarAudioCommandExecTimeMsWarningThreshold

FAutoConsoleVariableRef CVarAudioCommandExecTimeMsWarningThreshold(TEXT("au.AudioThreadCommand.ExecutionTimeWarningThresholdInMs"), AudioCommandExecTimeMsWarningThresholdCvar, TEXT("If a command took longer to execute than this number (in milliseconds) then we log a warning"), ECVF_Default)	(	TEXT("au.AudioThreadCommand.ExecutionTimeWarningThresholdInMs")	,
		AudioCommandExecTimeMsWarningThresholdCvar	,
		TEXT("If a command took longer to execute than this number (in milliseconds) then we log a warning")	,
		ECVF_Default
	)

CVarAudioMixerPerSourceResampling

FAutoConsoleVariableRef CVarAudioMixerPerSourceResampling(TEXT("au.PerSourceResampling"), PerSourceResampling, TEXT("0: Disabled, 1: Enabled"), ECVF_Default)	(	TEXT("au.PerSourceResampling")	,
		PerSourceResampling	,
		TEXT("0: Disabled, 1: Enabled")	,
		ECVF_Default
	)

CVarBypassAudioPlugins

FAutoConsoleVariableRef CVarBypassAudioPlugins(TEXT("au.BypassAudioPlugins"), BypassAudioPluginsCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)	(	TEXT("au.BypassAudioPlugins")	,
		BypassAudioPluginsCvar	,
		TEXT("0: Not Disabled, 1: Disabled")	,
		ECVF_Default
	)

CVarCommandBufferFlushWaitTimeMs

FAutoConsoleVariableRef CVarCommandBufferFlushWaitTimeMs(TEXT("au.CommandBufferFlushWaitTimeMs"), CommandBufferFlushWaitTimeMsCvar, TEXT("How long to wait for the command buffer flush to complete.\n"), ECVF_Default)	(	TEXT("au.CommandBufferFlushWaitTimeMs")	,
		CommandBufferFlushWaitTimeMsCvar	,
		TEXT("How long to wait for the command buffer flush to complete.\n")	,
		ECVF_Default
	)

CVarCommandBufferInitialCapacity

FAutoConsoleVariableRef CVarCommandBufferInitialCapacity(TEXT("au.CommandBufferInitialCapacity"), CommandBufferInitialCapacityCvar, TEXT("How many elements to initialize the command buffer capacity with"), ECVF_Default)	(	TEXT("au.CommandBufferInitialCapacity")	,
		CommandBufferInitialCapacityCvar	,
		TEXT("How many elements to initialize the command buffer capacity with")	,
		ECVF_Default
	)

CVarCommandBufferMaxSizeMb

FAutoConsoleVariableRef CVarCommandBufferMaxSizeMb(TEXT("au.CommandBufferMaxSizeInMb"), CommandBufferMaxSizeInMbCvar, TEXT("How big to allow the command buffer to grow before ignoring more commands"), ECVF_Default)	(	TEXT("au.CommandBufferMaxSizeInMb")	,
		CommandBufferMaxSizeInMbCvar	,
		TEXT("How big to allow the command buffer to grow before ignoring more commands")	,
		ECVF_Default
	)

CVarDisableDistanceAttenuation

FAutoConsoleVariableRef CVarDisableDistanceAttenuation(TEXT("au.DisableDistanceAttenuation"), DisableDistanceAttenuationCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)	(	TEXT("au.DisableDistanceAttenuation")	,
		DisableDistanceAttenuationCvar	,
		TEXT("0: Not Disabled, 1: Disabled")	,
		ECVF_Default
	)

CVarDisableEnvelopeFollowing

FAutoConsoleVariableRef CVarDisableEnvelopeFollowing(TEXT("au.DisableEnvelopeFollowing"), DisableEnvelopeFollowingCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)	(	TEXT("au.DisableEnvelopeFollowing")	,
		DisableEnvelopeFollowingCvar	,
		TEXT("0: Not Disabled, 1: Disabled")	,
		ECVF_Default
	)

CVarDisableFiltering

FAutoConsoleVariableRef CVarDisableFiltering(TEXT("au.DisableFiltering"), DisableFilteringCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)	(	TEXT("au.DisableFiltering")	,
		DisableFilteringCvar	,
		TEXT("0: Not Disabled, 1: Disabled")	,
		ECVF_Default
	)

CVarDisableHPFiltering

FAutoConsoleVariableRef CVarDisableHPFiltering(TEXT("au.DisableHPFiltering"), DisableHPFilteringCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)	(	TEXT("au.DisableHPFiltering")	,
		DisableHPFilteringCvar	,
		TEXT("0: Not Disabled, 1: Disabled")	,
		ECVF_Default
	)

CVarDisableParallelSourceProcessing

FAutoConsoleVariableRef CVarDisableParallelSourceProcessing(TEXT("au.DisableParallelSourceProcessing"), DisableParallelSourceProcessingCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)	(	TEXT("au.DisableParallelSourceProcessing")	,
		DisableParallelSourceProcessingCvar	,
		TEXT("0: Not Disabled, 1: Disabled")	,
		ECVF_Default
	)

CVarDisableSourceEffects

FAutoConsoleVariableRef CVarDisableSourceEffects(TEXT("au.DisableSourceEffects"), DisableSourceEffectsCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)	(	TEXT("au.DisableSourceEffects")	,
		DisableSourceEffectsCvar	,
		TEXT("0: Not Disabled, 1: Disabled")	,
		ECVF_Default
	)

CVarDumpCallstackOnStallDiagnostics

FAutoConsoleVariableRef CVarDumpCallstackOnStallDiagnostics(TEXT("au.DumpCallstackOnStallDiagnostics"), bDumpCallstackOnStallDiagnostics, TEXT("Whether to dump the callstack to the log as part of stall diagnostics (default = true)"), ECVF_Default)	(	TEXT("au.DumpCallstackOnStallDiagnostics")	,
		bDumpCallstackOnStallDiagnostics	,
		TEXT("Whether to dump the callstack to the log as part of stall diagnostics (default = true)")	,
		ECVF_Default
	)

CVarFloatCompareMaxScale

FAutoConsoleVariableRef CVarFloatCompareMaxScale(TEXT("au.FloatCompareMaxScale"), FloatCompareMaxScaleCVar, TEXT("Maximum parameter float compare tolerance"), ECVF_Default)	(	TEXT("au.FloatCompareMaxScale")	,
		FloatCompareMaxScaleCVar	,
		TEXT("Maximum parameter float compare tolerance")	,
		ECVF_Default
	)

CVarFloatCompareMinScale

FAutoConsoleVariableRef CVarFloatCompareMinScale(TEXT("au.FloatCompareMinScale"), FloatCompareMinScaleCVar, TEXT("Minimum parameter float compare tolerance"), ECVF_Default)	(	TEXT("au.FloatCompareMinScale")	,
		FloatCompareMinScaleCVar	,
		TEXT("Minimum parameter float compare tolerance")	,
		ECVF_Default
	)

CVarFlushCommandBufferOnTimeout

FAutoConsoleVariableRef CVarFlushCommandBufferOnTimeout(TEXT("au.FlushCommandBufferOnTimeout"), FlushCommandBufferOnTimeoutCvar, TEXT("0: Not Disabled, 1: Disabled"), ECVF_Default)	(	TEXT("au.FlushCommandBufferOnTimeout")	,
		FlushCommandBufferOnTimeoutCvar	,
		TEXT("0: Not Disabled, 1: Disabled")	,
		ECVF_Default
	)

CVarLogCmdQueueWhenNumberReached

FAutoConsoleVariableRef CVarLogCmdQueueWhenNumberReached(TEXT("au.debug.LogCmdQueueWhenReached"), LogCmdQueueWhenNumberReachedCVar, TEXT("When number of commands in queue is reached, it will dump the command list to the log."), ECVF_Cheat)	(	TEXT("au.debug.LogCmdQueueWhenReached")	,
		LogCmdQueueWhenNumberReachedCVar	,
		TEXT("When number of commands in queue is reached, it will dump the command list to the log.")	,
		ECVF_Cheat
	)

CVarNumCmdsConsideredFullCVar

FAutoConsoleVariableRef CVarNumCmdsConsideredFullCVar(TEXT("au.NumCmdsConsideredFullCVar"), NumCmdsConsideredFullCVar, TEXT("Num of commands in the queue is considered full"), ECVF_Default)	(	TEXT("au.NumCmdsConsideredFullCVar")	,
		NumCmdsConsideredFullCVar	,
		TEXT("Num of commands in the queue is considered full")	,
		ECVF_Default
	)

LogEveryAudioThreadCommand

FAutoConsoleVariableRef LogEveryAudioThreadCommand(TEXT("au.AudioThreadCommand.LogEveryExecution"), LogEveryAudioThreadCommandCvar, TEXT("Extremely verbose logging of each Audio Thread command caller and it's execution time"), ECVF_Default)	(	TEXT("au.AudioThreadCommand.LogEveryExecution")	,
		LogEveryAudioThreadCommandCvar	,
		TEXT("Extremely verbose logging of each Audio Thread command caller and it's execution time")	,
		ECVF_Default
	)