AudioMixer.cpp File Reference

#include "AudioMixer.h"
#include "Async/Async.h"
#include "AudioDefines.h"
#include "AudioMixerTrace.h"
#include "DSP/BufferVectorOperations.h"
#include "DSP/FloatArrayMath.h"
#include "HAL/RunnableThread.h"
#include "HAL/ThreadSafeCounter.h"
#include "HAL/IConsoleManager.h"
#include "HAL/Event.h"
#include "HAL/LowLevelMemTracker.h"
#include "Misc/ConfigCacheIni.h"
#include "Misc/ScopeTryLock.h"
#include "ProfilingDebugging/CsvProfiler.h"
#include "ProfilingDebugging/ScopedTimers.h"
#include "Trace/Trace.h"

Namespaces
namespace	Audio
	NO_LOGGING.
namespace	Audio::Trace
namespace	Audio::Trace::EventLog
namespace	Audio::Trace::EventLog::ID

Functions
	CSV_DEFINE_CATEGORY_MODULE (AUDIOMIXERCORE_API, Audio, false)
	DEFINE_STAT (STAT_AudioMixerRenderAudio)

Variables
const FString	Audio::Trace::EventLog::ID::SoundStart = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_Playing", "Playing").ToString()
const FString	Audio::Trace::EventLog::ID::SoundStop = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_Stopped", "Stopped").ToString()
const FString	Audio::Trace::EventLog::ID::SoundVirtualized = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_Virtualize", "Virtualized").ToString()
const FString	Audio::Trace::EventLog::ID::SoundRealized = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_Realize", "Realized").ToString()
const FString	Audio::Trace::EventLog::ID::PlayRequestSoundHandle = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_PlayRequestedSoundHandle", "Play Request : Sound Handle").ToString()
const FString	Audio::Trace::EventLog::ID::StopRequestedSoundHandle = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_StopRequestedSoundHandle", "Stop Request : Sound Handle").ToString()
const FString	Audio::Trace::EventLog::ID::PlayRequestAudioComponent = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_PlayRequestedAudioComponent", "Play Request : Audio Component").ToString()
const FString	Audio::Trace::EventLog::ID::StopRequestAudioComponent = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_StopRequestedAudioComponent", "Stop Request : Audio Component").ToString()
const FString	Audio::Trace::EventLog::ID::PlayRequestOneShot = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_PlayRequestedOneShot", "Play Request : One shot").ToString()
const FString	Audio::Trace::EventLog::ID::PlayRequestSoundAtLocation = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_PlayRequestedSoundAtLocation", "Play Request : Sound at location").ToString()
const FString	Audio::Trace::EventLog::ID::PlayRequestSound2D = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_PlayRequested2DSound", "Play Request : Play Sound 2D").ToString()
const FString	Audio::Trace::EventLog::ID::PlayRequestSlateSound = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_PlayRequestedSlateSound", "Play Request : Slate Sound").ToString()
const FString	Audio::Trace::EventLog::ID::StopRequestActiveSound = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_StopRequestedActiveSound", "Stop Request : Active Sound").ToString()
const FString	Audio::Trace::EventLog::ID::StopRequestSoundsUsingResource = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_StopRequestedSoundsUsingResource", "Stop Request : Sounds using resource").ToString()
const FString	Audio::Trace::EventLog::ID::StopRequestConcurrency = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_StopRequestedConcurrency", "Stop Request : Concurrency").ToString()
const FString	Audio::Trace::EventLog::ID::PauseSoundRequested = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_PauseSoundRequested", "Paused").ToString()
const FString	Audio::Trace::EventLog::ID::ResumeSoundRequested = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_ResumeSoundRequested", "Resumed").ToString()
const FString	Audio::Trace::EventLog::ID::StopAllRequested = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_StopAllRequested", "Stop All").ToString()
const FString	Audio::Trace::EventLog::ID::FlushAudioDeviceRequested = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_FlushAudioDeviceRequested", "Flush Audio Device").ToString()
const FString	Audio::Trace::EventLog::ID::PlayFailedNotPlayable = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_PlayFailedNotPlayable", "Play Failed : Not playable").ToString()
const FString	Audio::Trace::EventLog::ID::PlayFailedOutOfRange = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_PlayFailedOutOfRange", "Play Failed : Out of range").ToString()
const FString	Audio::Trace::EventLog::ID::PlayFailedDebugFiltered = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_PlayFailedDebugFiltered", "Play Failed : Debug filtered").ToString()
const FString	Audio::Trace::EventLog::ID::PlayFailedConcurrency = NSLOCTEXT("AudioInsightsEventLog", "EventLogTraceMessage_PlayFailedConcurrency", "Play Failed : Concurrency").ToString()
FAutoConsoleVariableRef	CVarLogRenderTimes (TEXT("au.LogRenderTimes"), LogRenderTimesCVar, TEXT("0: Not Log, 1: Log"), ECVF_Default)
FAutoConsoleVariableRef	CVarMinTimeBetweenUnderrunWarningsMs (TEXT("au.MinLogTimeBetweenUnderrunWarnings"), MinTimeBetweenUnderrunWarningsMs, TEXT("Set the time between each subsequent underrun log warning globaly (defaults to 10secs)"), ECVF_Default)
FAutoConsoleVariableRef	CVarSetRenderThreadPriority (TEXT("au.RenderThreadPriority"), SetRenderThreadPriorityCVar, TEXT("0: Normal, 1: Above Normal, 2: Below Normal, 3: Highest, 4: Lowest, 5: Slightly Below Normal, 6: Time Critical"), ECVF_Default)
FAutoConsoleVariableRef	CVarRenderThreadAffinity (TEXT("au.RenderThreadAffinity"), SetRenderThreadAffinityCVar, TEXT("0: Disabled (Default), otherwise overriden thread affinity."), ECVF_Default)
FAutoConsoleVariableRef	CVarUseThreadedDeviceSwap (TEXT("au.UseThreadedDeviceSwap"), bUseThreadedDeviceSwapCVar, TEXT("0 off, 1 on"), ECVF_Default)
FAutoConsoleVariableRef	CVarUseAudioDeviceInfoCache (TEXT("au.UseCachedDeviceInfoCache"), bUseAudioDeviceInfoCacheCVar, TEXT("0 off, 1 on"), ECVF_Default)
FAutoConsoleVariableRef	CVarRecycleThreads (TEXT("au.RecycleThreads"), bRecycleThreadsCVar, TEXT("0 off, 1 on"), ECVF_Default)
FAutoConsoleVariableRef	CVarOverrunTimeout (TEXT("au.OverrunTimeoutMSec"), OverrunTimeoutCVar, TEXT("Amount of time to wait for the render thread to time out before swapping to the null device. \n"), ECVF_Default)
FAutoConsoleVariableRef	CVarUnderrunTimeout (TEXT("au.UnderrunTimeoutMSec"), UnderrunTimeoutCVar, TEXT("Amount of time to wait for the render thread to generate the next buffer before submitting an underrun buffer. \n"), ECVF_Default)
FAutoConsoleVariableRef	CVarFadeoutTimeout (TEXT("au.FadeOutTimeoutMSec"), FadeoutTimeoutCVar, TEXT("Amount of time to wait for the FadeOut Event to fire. \n"), ECVF_Default)
FAutoConsoleVariableRef	LinearGainScalarForFinalOutut (TEXT("au.LinearGainScalarForFinalOutut"), LinearGainScalarForFinalOututCVar, TEXT("Default is 1.0f \n"), ECVF_Default)
FAutoConsoleVariableRef	ExtraAudioMixerDeviceLogging (TEXT("au.ExtraAudioMixerDeviceLogging"), ExtraAudioMixerDeviceLoggingCVar, TEXT("0: no logging, 1: logging every 500 callbacks \n"), ECVF_Default)
FAutoConsoleVariableRef	CVarAudioMixerDebugForceDroppedHardwareCallback (TEXT("au.debug.ForceDroppedHardwareCallback"), AudioMixerDebugForceDroppedHardwareCallbackCVar, TEXT("N == 0 off, N < 0 (will drop all callbacks), N > 0 will drop (will drop N callbacks)"), ECVF_Cheat)
int32	Audio::sRenderInstanceIds = 0
FThreadSafeCounter	Audio::AudioMixerTaskCounter

Function Documentation

CSV_DEFINE_CATEGORY_MODULE()

CSV_DEFINE_CATEGORY_MODULE	(	AUDIOMIXERCORE_API	,
		Audio	,
		false
	)

DEFINE_STAT()

DEFINE_STAT

(

STAT_AudioMixerRenderAudio

)

Variable Documentation

CVarAudioMixerDebugForceDroppedHardwareCallback

FAutoConsoleVariableRef CVarAudioMixerDebugForceDroppedHardwareCallback(TEXT("au.debug.ForceDroppedHardwareCallback"), AudioMixerDebugForceDroppedHardwareCallbackCVar, TEXT("N == 0 off, N < 0 (will drop all callbacks), N > 0 will drop (will drop N callbacks)"), ECVF_Cheat)	(	TEXT("au.debug.ForceDroppedHardwareCallback")	,
		AudioMixerDebugForceDroppedHardwareCallbackCVar	,
		TEXT("N == 0 off, N < 0 (will drop all callbacks), N > 0 will drop (will drop N callbacks)")	,
		ECVF_Cheat
	)

CVarFadeoutTimeout

FAutoConsoleVariableRef CVarFadeoutTimeout(TEXT("au.FadeOutTimeoutMSec"), FadeoutTimeoutCVar, TEXT("Amount of time to wait for the FadeOut Event to fire. \n"), ECVF_Default)	(	TEXT("au.FadeOutTimeoutMSec")	,
		FadeoutTimeoutCVar	,
		TEXT("Amount of time to wait for the FadeOut Event to fire. \n")	,
		ECVF_Default
	)

CVarLogRenderTimes

FAutoConsoleVariableRef CVarLogRenderTimes(TEXT("au.LogRenderTimes"), LogRenderTimesCVar, TEXT("0: Not Log, 1: Log"), ECVF_Default)	(	TEXT("au.LogRenderTimes")	,
		LogRenderTimesCVar	,
		TEXT("0: Not Log, 1: Log")	,
		ECVF_Default
	)

CVarMinTimeBetweenUnderrunWarningsMs

FAutoConsoleVariableRef CVarMinTimeBetweenUnderrunWarningsMs(TEXT("au.MinLogTimeBetweenUnderrunWarnings"), MinTimeBetweenUnderrunWarningsMs, TEXT("Set the time between each subsequent underrun log warning globaly (defaults to 10secs)"), ECVF_Default)	(	TEXT("au.MinLogTimeBetweenUnderrunWarnings")	,
		MinTimeBetweenUnderrunWarningsMs	,
		TEXT("Set the time between each subsequent underrun log warning globaly (defaults to 10secs)")	,
		ECVF_Default
	)

CVarOverrunTimeout

FAutoConsoleVariableRef CVarOverrunTimeout(TEXT("au.OverrunTimeoutMSec"), OverrunTimeoutCVar, TEXT("Amount of time to wait for the render thread to time out before swapping to the null device. \n"), ECVF_Default)	(	TEXT("au.OverrunTimeoutMSec")	,
		OverrunTimeoutCVar	,
		TEXT("Amount of time to wait for the render thread to time out before swapping to the null device. \n")	,
		ECVF_Default
	)

CVarRecycleThreads

FAutoConsoleVariableRef CVarRecycleThreads(TEXT("au.RecycleThreads"), bRecycleThreadsCVar, TEXT("0 off, 1 on"), ECVF_Default)	(	TEXT("au.RecycleThreads")	,
		bRecycleThreadsCVar	,
		TEXT("0 off, 1 on")	,
		ECVF_Default
	)

CVarRenderThreadAffinity

FAutoConsoleVariableRef CVarRenderThreadAffinity(TEXT("au.RenderThreadAffinity"), SetRenderThreadAffinityCVar, TEXT("0: Disabled (Default), otherwise overriden thread affinity."), ECVF_Default)	(	TEXT("au.RenderThreadAffinity")	,
		SetRenderThreadAffinityCVar	,
		TEXT("0: Disabled (Default), otherwise overriden thread affinity.")	,
		ECVF_Default
	)

CVarSetRenderThreadPriority

FAutoConsoleVariableRef CVarSetRenderThreadPriority(TEXT("au.RenderThreadPriority"), SetRenderThreadPriorityCVar, TEXT("0: Normal, 1: Above Normal, 2: Below Normal, 3: Highest, 4: Lowest, 5: Slightly Below Normal, 6: Time Critical"), ECVF_Default)	(	TEXT("au.RenderThreadPriority")	,
		SetRenderThreadPriorityCVar	,
		TEXT("0: Normal, 1: Above Normal, 2: Below Normal, 3: Highest, 4: Lowest, 5: Slightly Below Normal, 6: Time Critical")	,
		ECVF_Default
	)

CVarUnderrunTimeout

FAutoConsoleVariableRef CVarUnderrunTimeout(TEXT("au.UnderrunTimeoutMSec"), UnderrunTimeoutCVar, TEXT("Amount of time to wait for the render thread to generate the next buffer before submitting an underrun buffer. \n"), ECVF_Default)	(	TEXT("au.UnderrunTimeoutMSec")	,
		UnderrunTimeoutCVar	,
		TEXT("Amount of time to wait for the render thread to generate the next buffer before submitting an underrun buffer. \n")	,
		ECVF_Default
	)

CVarUseAudioDeviceInfoCache

FAutoConsoleVariableRef CVarUseAudioDeviceInfoCache(TEXT("au.UseCachedDeviceInfoCache"), bUseAudioDeviceInfoCacheCVar, TEXT("0 off, 1 on"), ECVF_Default)	(	TEXT("au.UseCachedDeviceInfoCache")	,
		bUseAudioDeviceInfoCacheCVar	,
		TEXT("0 off, 1 on")	,
		ECVF_Default
	)

CVarUseThreadedDeviceSwap

FAutoConsoleVariableRef CVarUseThreadedDeviceSwap(TEXT("au.UseThreadedDeviceSwap"), bUseThreadedDeviceSwapCVar, TEXT("0 off, 1 on"), ECVF_Default)	(	TEXT("au.UseThreadedDeviceSwap")	,
		bUseThreadedDeviceSwapCVar	,
		TEXT("0 off, 1 on")	,
		ECVF_Default
	)

ExtraAudioMixerDeviceLogging

FAutoConsoleVariableRef ExtraAudioMixerDeviceLogging(TEXT("au.ExtraAudioMixerDeviceLogging"), ExtraAudioMixerDeviceLoggingCVar, TEXT("0: no logging, 1: logging every 500 callbacks \n"), ECVF_Default)	(	TEXT("au.ExtraAudioMixerDeviceLogging")	,
		ExtraAudioMixerDeviceLoggingCVar	,
		TEXT("0: no logging, 1: logging every 500 callbacks \n")	,
		ECVF_Default
	)

LinearGainScalarForFinalOutut

FAutoConsoleVariableRef LinearGainScalarForFinalOutut(TEXT("au.LinearGainScalarForFinalOutut"), LinearGainScalarForFinalOututCVar, TEXT("Default is 1.0f \n"), ECVF_Default)	(	TEXT("au.LinearGainScalarForFinalOutut")	,
		LinearGainScalarForFinalOututCVar	,
		TEXT("Default is 1.0f \n")	,
		ECVF_Default
	)