UST_AudioIOBase Class Reference

Base class for Audio IO functionality in ShaderTech. More...

#include <ST_AudioIOBase.h>

Public Member Functions
	UST_AudioIOBase ()
	~UST_AudioIOBase ()
bool	Activate ()
void	Deactivate ()
virtual EAudioIOType	GetAudioIOType () const
FAudioIOConfig	GetAudioIOConfig () const
FFFTIOData	GetFFTIOData () const
bool	RegisterSampler (UObject *Sampler, bool bSamplerActivates=false)
void	DeregisterSampler (UObject *Sampler, bool bZeroSamplersDeactivates=false)
bool	MA_IsDataAvailable (uint64 PeriodSizeInFrames)
void	MA_ReadRealtimePcmRB (uint64 PeriodSizeInFrames, ma_format Format, uint32 Channels)
void	MA_DataOrganiser (void *pSamples, uint64 PeriodSizeInFrames, ma_format Format, uint32 Channels)
template<typename InterfaceType>
bool	ContainsInterface () const
FIntPoint	GetIOId () const
virtual EST_SampleFormat	GetAudioFormat () const
	Returns the current audio format.

Static Public Member Functions
static void	MA_DataAvailable (ma_device *pDevice)

Public Attributes
FCriticalSection	AudioBufferLock
void *	SampledAudioBuffers [BufferCount] = { nullptr, nullptr }
void *	CurrentAudioBuffer = nullptr
std::atomic< uint32 >	ReadIndex
std::atomic< uint32 >	WriteIndex
FOnAudioIOStatusChanged	OnAudioIOStatusChanged
FOnRawMagnitudesReady	OnRawMagnitudesReady
FOnFrequencyBandsReady	OnFrequencyBandsReady
FOnAmplitudesReady	OnAmplitudesReady
FOnPitchesReady	OnPitchesReady
FOnBeatDetected	OnBeatDetected

Static Public Attributes
static constexpr uint32	BufferCount = 2

Protected Member Functions
virtual void	Initialize (FSubsystemCollectionBase &Collection) override
virtual void	Deinitialize () override
virtual bool	InitializeAudioIO ()
virtual void	DeinitializeAudioIO ()
void	BuildFFTIOData (uint32 PeriodSizeInFrames, ma_format Format, uint32 SampleRate, uint32 Channels)
void	DeinitializeFFT ()
virtual ma_decoder *	GetPlaybackDecoder () const
virtual ma_encoder *	GetCaptureEncoder () const
void	GetDeviceInfo (EAudioIOType AudioIOType, FString FindDeviceName)

Protected Attributes
bool	bActivated = false
bool	bIsProcessingFFT = false
FCriticalSection	SamplerRegistrationMutex
TArray< UObject * >	RegisteredSamplers
ma_device_id *	pDeviceID = NULL
	Pointer to the selected device ID.
ma_device_info *	pPlaybackDeviceInfos = nullptr
	Playback device information.
ma_device_info *	pCaptureDeviceInfos = nullptr
	Capture device information.
ma_uint32	playbackDeviceCount = 0
	Number of playback devices found.
ma_uint32	captureDeviceCount = 0
	Number of capture devices found.
FFFTIOData	CachedFFTIOData
	Cached FFT IO data.
FAudioIOConfig	CachedAudioIOConfig
	Cached audio IO configuration.
ma_pcm_rb	RealtimePcmRingBuffer
	Lock-free PCM ring buffer for passing audio from the realtime callback to the FFT worker thread.
ma_uint32	RealtimePcmRBFrameCapacity = 0
	Fixed maximum number of audio frames the ring buffer can hold.
TArray< uint8 >	RealtimePcmRBBackingMemory
	Preallocated backing memory used by the ring buffer (no runtime allocations).

Detailed Description

Base class for Audio IO functionality in ShaderTech.

Base class for Audio IO functionality in ShaderTech.

Constructor & Destructor Documentation

UST_AudioIOBase()

UST_AudioIOBase::UST_AudioIOBase

(

)

Sets default values for this actor's properties.

~UST_AudioIOBase()

UST_AudioIOBase::~UST_AudioIOBase

(

)

Default destructor.

Member Function Documentation

Activate()

bool UST_AudioIOBase::Activate

(

)

Activates the audio IO.

BuildFFTIOData()

void UST_AudioIOBase::BuildFFTIOData ( uint32 PeriodSizeInFrames, ma_format Format, uint32 SampleRate, uint32 Channels )

protected

Builds FFT IO data from device parameters.

Parameters

PeriodSizeInFrames	Size of a period in frames.
Format	Audio data format.
SampleRate	Sample rate of the audio.
Channels	Number of audio channels.

ContainsInterface()

template<typename InterfaceType>

bool UST_AudioIOBase::ContainsInterface ( ) const

inline

Checks if a registered interface type exists.

Returns

true if the interface exists, false otherwise.

Deactivate()

void UST_AudioIOBase::Deactivate

(

)

Deactivates the audio IO.

DeinitializeAudioIO()

void UST_AudioIOBase::DeinitializeAudioIO ( )

protectedvirtual

Deinitializes the audio IO.

Reimplemented in UST_AudioIOCaptureBase, UST_AudioIOPlaybackBase, UST_AudioPlaybackEnginePlayer, UST_AudioPlaybackNoise, and UST_AudioPlaybackWaveform.

DeinitializeFFT()

void UST_AudioIOBase::DeinitializeFFT ( )

protected

Deinitializes FFT data and processing.

DeregisterSampler()

void UST_AudioIOBase::DeregisterSampler	(	UObject *	Sampler,
		bool	bZeroSamplersDeactivates = false )

Deregisters a sampler from the audio IO system.

Parameters

Sampler	The sampler object to deregister.
bZeroSamplersDeactivates	Whether deactivation should occur when no samplers remain.

GetAudioFormat()

EST_SampleFormat UST_AudioIOBase::GetAudioFormat ( ) const

inlinevirtual

Returns the current audio format.

Returns

the current audio format.

Reimplemented in UST_AudioIOCaptureBase, and UST_AudioIOPlaybackBase.

GetAudioIOConfig()

FAudioIOConfig UST_AudioIOBase::GetAudioIOConfig ( ) const

inline

Returns the current Audio IO configuration.

GetAudioIOType()

EAudioIOType UST_AudioIOBase::GetAudioIOType ( ) const

inlinevirtual

Returns the type of Audio IO.

Reimplemented in UST_AudioCaptureLoopback, UST_AudioCaptureMicrophone, UST_AudioPlaybackEnginePlayer, UST_AudioPlaybackNoise, UST_AudioPlaybackPlayer, and UST_AudioPlaybackWaveform.

GetCaptureEncoder()

ma_encoder * UST_AudioIOBase::GetCaptureEncoder ( ) const

inlineprotectedvirtual

Returns a pointer to the capture encoder, if any.

Reimplemented in UST_AudioIOCaptureBase.

GetDeviceInfo()

void UST_AudioIOBase::GetDeviceInfo ( EAudioIOType AudioIOType, FString FindDeviceName )

protected

Retrieves device information for a given Audio IO type.

Parameters

AudioIOType	The type of audio IO device.
FindDeviceName	The device name to search for.

GetFFTIOData()

FFFTIOData UST_AudioIOBase::GetFFTIOData ( ) const

inline

Returns the current FFT IO data.

GetIOId()

FIntPoint UST_AudioIOBase::GetIOId ( ) const

inline

Returns the IO Id used for identification purposes.

GetPlaybackDecoder()

ma_decoder * UST_AudioIOBase::GetPlaybackDecoder ( ) const

inlineprotectedvirtual

Returns a pointer to the playback decoder, if any.

Reimplemented in UST_AudioIOPlaybackBase.

InitializeAudioIO()

bool UST_AudioIOBase::InitializeAudioIO ( )

protectedvirtual

Initializes the audio IO.

Returns

true if successful, false otherwise.

Reimplemented in UST_AudioCaptureLoopback, UST_AudioCaptureMicrophone, UST_AudioPlaybackEnginePlayer, UST_AudioPlaybackNoise, UST_AudioPlaybackPlayer, and UST_AudioPlaybackWaveform.

MA_DataAvailable()

void UST_AudioIOBase::MA_DataAvailable ( ma_device * pDevice )

static

Signals the FFT worker thread that sufficient audio data is available for processing.

Parameters

pDevice

The audio device.

MA_DataOrganiser()

void UST_AudioIOBase::MA_DataOrganiser	(	void *	pSamples,
		uint64	PeriodSizeInFrames,
		ma_format	Format,
		uint32	Channels )

Miniaudio callback function to organize audio data.

Parameters

pSamples	The buffer of samples.
PeriodSizeInFrames	The size of the period in frames.
Format	The sample format.
Channels	The number of audio channels.

MA_IsDataAvailable()

bool UST_AudioIOBase::MA_IsDataAvailable

(

uint64

PeriodSizeInFrames

)

Returns true if at least one full processing period of PCM data is available in the realtime ring buffer.

Parameters

PeriodSizeInFrames

The size of the period in frames.

MA_ReadRealtimePcmRB()

void UST_AudioIOBase::MA_ReadRealtimePcmRB	(	uint64	PeriodSizeInFrames,
		ma_format	Format,
		uint32	Channels )

Reads one period of PCM data from the realtime ring buffer and forwards it for processing.

Parameters

PeriodSizeInFrames	The size of the period in frames.
Format	The sample format.
Channels	The number of audio channels.

RegisterSampler()

bool UST_AudioIOBase::RegisterSampler	(	UObject *	Sampler,
		bool	bSamplerActivates = false )

Registers a sampler for the audio IO system.

Parameters

Sampler	The sampler object to register.
bSamplerActivates	Whether the sampler should cause activation.

Member Data Documentation

AudioBufferLock

FCriticalSection UST_AudioIOBase::AudioBufferLock

Critical section for thread-safe audio buffer operations.

bActivated

bool UST_AudioIOBase::bActivated = false

protected

Whether the audio IO system is activated.

bIsProcessingFFT

bool UST_AudioIOBase::bIsProcessingFFT = false

protected

Whether the FFT processing is currently running.

BufferCount

uint32 UST_AudioIOBase::BufferCount = 2

staticconstexpr

Number of buffers for double buffering.

CurrentAudioBuffer

void* UST_AudioIOBase::CurrentAudioBuffer = nullptr

Pointer to the currently active audio buffer.

OnAmplitudesReady

FOnAmplitudesReady UST_AudioIOBase::OnAmplitudesReady

Event triggered when amplitudes are ready.

OnAudioIOStatusChanged

FOnAudioIOStatusChanged UST_AudioIOBase::OnAudioIOStatusChanged

Event triggered when audio IO activation status changes.

OnBeatDetected

FOnBeatDetected UST_AudioIOBase::OnBeatDetected

Event triggered when beats are detected.

OnFrequencyBandsReady

FOnFrequencyBandsReady UST_AudioIOBase::OnFrequencyBandsReady

Event triggered when frequency bands are ready.

OnPitchesReady

FOnPitchesReady UST_AudioIOBase::OnPitchesReady

Event triggered when pitches are ready.

OnRawMagnitudesReady

FOnRawMagnitudesReady UST_AudioIOBase::OnRawMagnitudesReady

Event triggered when raw magnitudes are ready.

ReadIndex

std::atomic<uint32> UST_AudioIOBase::ReadIndex

Index to indicate which buffer the FFT thread reads.

RegisteredSamplers

TArray<UObject*> UST_AudioIOBase::RegisteredSamplers

protected

Array of registered sampler objects.

SampledAudioBuffers

void* UST_AudioIOBase::SampledAudioBuffers[BufferCount] = { nullptr, nullptr }

Array of sampled audio buffers.

SamplerRegistrationMutex

FCriticalSection UST_AudioIOBase::SamplerRegistrationMutex

protected

Ensure the registration and deregistration of samplers is thread safe.

WriteIndex

std::atomic<uint32> UST_AudioIOBase::WriteIndex

Index to indicate which buffer miniaudio writes to.

---

The documentation for this class was generated from the following files:

• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioProcessing/Public/IO/Base/ST_AudioIOBase.h
• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioProcessing/Private/IO/Base/ST_AudioIOBase.cpp