There is only one voice pool and VAE and it's managed here. More...

#include <vae_voice_manager.hpp>

Collaboration diagram for vae::core::VoiceManger:

Public Member Functions
Result	init (const EngineConfig &config)

HeapBuffer< Voice > &	all ()

HeapBuffer< Voice > &	finished ()

Size	getActiveVoiceCount () const

template<class Func >
void	forEachVoice (const Func &&func)
	Callback provided to iterate voices, needs to return a bool to indicate when a voice needs to be stopped. More...

template<class Func >
void	forEachFinishedVoice (const Func &&func)

VoicePan &	getVoicePan (Size index)

VoiceFilter &	getVoiceFilter (Size index)

Result	play (Event &event, const BankHandle bank, const Sample gain, const EmitterHandle emitter, const ListenerHandle listener, const MixerHandle mixer)

Result	makeVirtual (Voice &v)
	makes provided voice virtual More...

Result	stop (Voice &v)
	Stops a voice. More...

template<typename T >
Result	stop (T handle, T Voice::*member, const EmitterHandle emitter=InvalidEmitterHandle)
	Stop voice based on a member value and optionally an emitter. More...

template<typename T >
void	setVoiceProperty (EmitterHandle emitter, T Voice::*member, const T &value)

template<typename T >
void	setVoiceProperty (EmitterHandle emitter, T VoiceFilter::*member, const T &value)

Private Attributes
HeapBuffer< Voice >	mFinishedVoiceQueue
	voices that finished playing are queued here More...

HeapBuffer< Voice >	mVoices
	Currently playing voice are here. More...

HeapBuffer< Voice >	mVirtualVoices

HeapBuffer< VoicePan >	mVoicePans
	Interpolation data for the panning algorithm or manual panning data. More...

HeapBuffer< VoiceFilter >	mVoiceFiltered
	Data needed for filtering is here. More...

Size	mActiveVoices = 0
	Number of currently playing voices. More...

Size	mInactiveVoices = 0
	Number of currenly virtual voices. More...

Size	mActiveHRTFVoices = 0
	Number of ative hrtf voices. More...

Size	mHRTFVoiceCount = 0
	Number of voices reserved for hrtf. More...

Size	mHighestVoice = 0
	TODO bad. More...

Size	mFinishedPending = 0
	Voices in mFinishedVoiceQueue. More...

Size	mHighestFinishedVoice = 0
	TODO bad as well. More...

Size	mStarvedVoices = 0
	Voices which could not play since no other voice could be killed and are lost forever. More...

Size	mStoppedQueueOverflow = 0
	Voice which did not fit mFinishedVoiceQueue and could not triggered chained events. More...

Detailed Description

There is only one voice pool and VAE and it's managed here.

This class handles starting and stopping voices as well as virtualization

Definition at line 34 of file vae_voice_manager.hpp.

Member Function Documentation

◆ all()

HeapBuffer< Voice > & vae::core::VoiceManger::all ( )

inline

Definition at line 62 of file vae_voice_manager.hpp.

                                 {
            return mVoices;
        }

◆ finished()

HeapBuffer< Voice > & vae::core::VoiceManger::finished ( )

inline

Definition at line 66 of file vae_voice_manager.hpp.

                                      {
            return mFinishedVoiceQueue;
        }

Here is the caller graph for this function:

◆ forEachFinishedVoice()

template<class Func >

void vae::core::VoiceManger::forEachFinishedVoice ( const Func && func )

inline

Definition at line 96 of file vae_voice_manager.hpp.

                                                     {
            VAE_PROFILER_SCOPE_NAMED("Foreach Finished Voice")
            for (Size i = 0; i <= mHighestFinishedVoice; i++) {
                auto& v = mFinishedVoiceQueue[i];
                if (v.source == InvalidSourceHandle) { continue; }
                if (!func(v)) { continue; };
                mFinishedPending--;
                v.source = InvalidSourceHandle; // now the finished voice is handled
            }
            VAE_PROFILER_PLOT(profiler::voiceCount, int64_t(mActiveVoices));
            VAE_PROFILER_PLOT(profiler::voiceHRTFCount, int64_t(mActiveHRTFVoices));
            VAE_PROFILER_PLOT(profiler::voiceVirtualCount, int64_t(mInactiveVoices));
            VAE_PROFILER_PLOT(profiler::voiceFinishedCount, int64_t(mFinishedPending));
        }

Here is the caller graph for this function:

◆ forEachVoice()

template<class Func >

void vae::core::VoiceManger::forEachVoice ( const Func && func )

inline

Callback provided to iterate voices, needs to return a bool to indicate when a voice needs to be stopped.

Template Parameters

Func

Parameters

func

Definition at line 81 of file vae_voice_manager.hpp.

                                             {
            VAE_PROFILER_SCOPE_NAMED("Foreach Voice")
            for (Size index = 0; index <= mHighestVoice; index++) {
                auto& i = mVoices[index];
                if (i.source == InvalidSourceHandle) { continue; }
                if (!func(i, index)) {
                    stop(i); // stop the voice if callback returns false
                }
            }
            VAE_PROFILER_PLOT(profiler::voiceCount, int64_t(mActiveVoices));
            VAE_PROFILER_PLOT(profiler::voiceHRTFCount, int64_t(mActiveHRTFVoices));
            VAE_PROFILER_PLOT(profiler::voiceVirtualCount, int64_t(mInactiveVoices));
        }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActiveVoiceCount()

Size vae::core::VoiceManger::getActiveVoiceCount ( ) const

inline

Definition at line 70 of file vae_voice_manager.hpp.

                                         {
            return mActiveVoices;
        }

Here is the caller graph for this function:

◆ getVoiceFilter()

VoiceFilter & vae::core::VoiceManger::getVoiceFilter ( Size index )

inline

Definition at line 115 of file vae_voice_manager.hpp.

                                                {
            return mVoiceFiltered[index];
        }

◆ getVoicePan()

VoicePan & vae::core::VoiceManger::getVoicePan ( Size index )

inline

Definition at line 111 of file vae_voice_manager.hpp.

                                          {
            return mVoicePans[index];
        }

Here is the caller graph for this function:

◆ init()

Result vae::core::VoiceManger::init ( const EngineConfig & config )

inline

Definition at line 51 of file vae_voice_manager.hpp.

                                                {
            VAE_PROFILER_SCOPE_NAMED("Voicemanager Init")
            mVoices.resize(config.voices);
            mFinishedVoiceQueue.resize(config.finishedVoiceQueueSize);
            mVoicePans.resize(config.voices);
            mVoiceFiltered.resize(config.voices);
            mVirtualVoices.resize(config.virtualVoices);
            mHRTFVoiceCount = config.hrtfVoices;
            return Result::Success;
        }

◆ makeVirtual()

Result vae::core::VoiceManger::makeVirtual ( Voice & v )

inline

makes provided voice virtual

Parameters

v

Returns: Result

Definition at line 244 of file vae_voice_manager.hpp.

                                     {
            VAE_PROFILER_SCOPE()
            for (Size i = 0; i < mVirtualVoices.size(); i++) {
                auto& slot = mVirtualVoices[i];
                if (slot.source != InvalidSourceHandle) { continue; }
                slot = v;
                v.source = InvalidSourceHandle;
                mInactiveVoices++;
                if (slot.HRTF) {
                    mActiveHRTFVoices--;
                } else {
                    mActiveVoices--;
                }
                VAE_PROFILER_PLOT(profiler::voiceCount, int64_t(mActiveVoices));
                VAE_PROFILER_PLOT(profiler::voiceHRTFCount, int64_t(mActiveHRTFVoices));
                VAE_PROFILER_PLOT(profiler::voiceVirtualCount, int64_t(mInactiveVoices));
 
                VAE_DEBUG_VOICES("Virtualized voice from event %i:%i\tactive: %i\tincative: %i",
                    v.event, v.bank, mActiveVoices, mInactiveVoices
                )
                return Result::Success;
            }
            return Result::GenericFailure;
        }

Here is the caller graph for this function:

◆ play()

Result vae::core::VoiceManger::play	(	Event &	event,
		const BankHandle	bank,
		const Sample	gain,
		const EmitterHandle	emitter,
		const ListenerHandle	listener,
		const MixerHandle	mixer
	)

inline

Parameters

event
bank
emitter
mixer

Returns: Result

Definition at line 128 of file vae_voice_manager.hpp.

          {
            VAE_PROFILER_SCOPE()
 
            Size searchStartIndex;
            Size searchEndIndex;
            bool starved;
 
            if (event.HRTF) {
                searchStartIndex = 0;
                searchEndIndex = mHRTFVoiceCount;
                starved = mActiveHRTFVoices == mHRTFVoiceCount;
            } else {
                searchStartIndex = mHRTFVoiceCount;
                searchEndIndex = (Size) mVoices.size();
                starved = mActiveVoices == (mVoices.size() - mHRTFVoiceCount);
            }
 
            // No voices left, find one to virtualize
            if(starved) {
                VAE_PROFILER_SCOPE_NAMED("Search killable Voice")
                Size potentialVirtual = ~0;
                Sample lowestGain = 10;
                for (Size i = searchStartIndex; i < searchEndIndex; i++) {
                    auto& v = mVoices[i];
                    if (v.critical) { continue; } // Don't kill important voices
 
                    if (!v.audible) {
                        if (makeVirtual(v) == Result::Success) {
                            searchStartIndex = i;
                            break;
                        }
                    }
 
                    if (v.gain <= lowestGain) {
                        lowestGain = v.gain;
                        potentialVirtual = i;
                    }
                }
 
                if (potentialVirtual < searchEndIndex) {
                    makeVirtual(mVoices[potentialVirtual]);
                    searchStartIndex = potentialVirtual;
                }
            }
 
            // Find a free voice
            for (Size i = searchStartIndex; i < searchEndIndex; i++) {
                VAE_PROFILER_SCOPE_NAMED("Search Free Voice")
                auto& v = mVoices[i];
                if(v.source == InvalidSourceHandle) {
                    v = { }; // re init object resets time and so on
                    v.source = event.source;
                    v.event = event.id;
                    v.listener = listener;
 
                    // find out if voice should trigger events on end
                    // if not killing the voice is easier so this gets a flag
                    v.chainedEvents = v.chainedEvents || (event.on_end != InvalidEventHandle);
 
                    if (mixer != InvalidMixerHandle && !event.force_mixer) {
                        // Only use the mixer provided if it's valid
                        // and the event allows overriding it
                        v.mixer = mixer;
                    } else {
                        // Otherwise use the mixer from the event
                        v.mixer = event.mixer;
                    }
 
                    v.gain = event.gain * gain;
                    v.loop = event.loop;
                    v.attenuate = event.attenuate;
                    // v.filtered = true; // todo provide way to init the filter settings
                    if (v.filtered) {
                        mVoiceFiltered[i] = { };
                    }
 
                    v.emitter = emitter;
                    v.spatialized = event.spatial;
                    mVoicePans[i] = { };    // Always clear this since non spatial use this for manual panning
                    v.HRTF = event.HRTF;
                    v.bank = bank;
                    if (v.HRTF) {
                        mActiveHRTFVoices++;
                    } else {
                        mActiveVoices++;
                    }
                    VAE_PROFILER_PLOT(profiler::voiceCount, int64_t(mActiveVoices));
                    VAE_PROFILER_PLOT(profiler::voiceHRTFCount, int64_t(mActiveHRTFVoices));
                    VAE_PROFILER_PLOT(profiler::voiceVirtualCount, int64_t(mInactiveVoices));
                    mHighestVoice = std::max(i, mHighestVoice);
                    VAE_DEBUG_VOICES("Started voice slot %i from event %i:%i\tactive: %i",
                        i, event.id, bank, mActiveVoices
                    )
                    return Result::Success;
                }
            }
 
            mHighestVoice = (Size) mVoices.size() - 1;
 
            mStarvedVoices++;
            VAE_PROFILER_PLOT(profiler::starvedVoiceCount, int64_t(mStarvedVoices));
 
            VAE_DEBUG_VOICES("Voice starvation. Can't start voice from event %i:%i", event.id, bank)
 
            return Result::VoiceStarvation;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setVoiceProperty() [1/2]

template<typename T >

void vae::core::VoiceManger::setVoiceProperty	(	EmitterHandle	emitter,
		T Voice::*	member,
		const T &	value
	)

inline

Definition at line 393 of file vae_voice_manager.hpp.

                                                                                     {
            VAE_PROFILER_SCOPE()
            for (auto& v : mVoices) {
                if(v.emitter == emitter) {
                    (&v)->*member = value;
                }
            }
        }

Here is the caller graph for this function:

◆ setVoiceProperty() [2/2]

template<typename T >

void vae::core::VoiceManger::setVoiceProperty	(	EmitterHandle	emitter,
		T VoiceFilter::*	member,
		const T &	value
	)

inline

Definition at line 403 of file vae_voice_manager.hpp.

                                                                                           {
            VAE_PROFILER_SCOPE()
            for (Size i = 0; i < mVoices.size(); i++) {
                auto& v = mVoices[i];
                if(v.emitter == emitter) {
                    (&mVoiceFiltered[i])->*member = value;
                    v.filtered = true;
                }
            }
        }

◆ stop() [1/2]

template<typename T >

Result vae::core::VoiceManger::stop	(	T	handle,
		T Voice::*	member,
		const EmitterHandle	emitter = `InvalidEmitterHandle`
	)

inline

Stop voice based on a member value and optionally an emitter.

Can kill multiple voices if they match. Alco affects virtual voices

Template Parameters

T	Handle type like MixerHandle

Parameters

handle	Handle to use to look for voice
member	Pointer to member variable of Voice
emitter	Optional emitter which also needs to match if provided

Returns: Result Alsoways a success

Definition at line 371 of file vae_voice_manager.hpp.

                                                                                                  {
            VAE_PROFILER_SCOPE()
            // Kill all the virtual voices first
            for (auto& v : mVirtualVoices) {
                if (v.source == InvalidSourceHandle) { continue; }
                // only consider active voices
                if ((&v)->*member != handle) { continue; }
                // If we got an emitter it has to match too
                if (emitter != InvalidEmitterHandle && v.emitter == emitter) { continue; }
                v.source = InvalidSourceHandle;
            }
 
            for (auto& v : mVoices) {
                if (v.source == InvalidSourceHandle) { continue; }
                if ((&v)->*member != handle) { continue; }
                if (emitter != InvalidEmitterHandle && v.emitter == emitter) { continue; }
                stop(v);
            }
            return Result::Success;
        }

Here is the call graph for this function:

◆ stop() [2/2]

Result vae::core::VoiceManger::stop ( Voice & v )

inline

Stops a voice.

Mostly used internally since other stop function provide better usage also revives virtual voices

Parameters

v	Voice to stop

Returns: Result

If the event triggers something on_end it needs to be added to the finishedVoiceQueue array in the voice manager. The update() function on the engine will handle it

Definition at line 276 of file vae_voice_manager.hpp.

                              {
            VAE_PROFILER_SCOPE()
            if (v.source == InvalidSourceHandle) { return Result::Success; }
 
            if (!v.chainedEvents) {
                if (0 < mInactiveVoices) {
                    // If we have inactive voices, revive one
                    for (Size i = 0; i < mVirtualVoices.size(); i++) {
                        auto virt = mVirtualVoices[i];
                        if (virt.source == InvalidSourceHandle) { continue; }
                        if (virt.HRTF == v.HRTF) {
                            virt.started = false;   // marks filter buffers for clearing
                            v = virt;
                            virt.source = InvalidSourceHandle;
                            mInactiveVoices--;
                            VAE_DEBUG_VOICES("Revived voice from event %i:%i\tactive: %i\tincative: %i",
                                v.event, v.bank, mActiveVoices, mInactiveVoices
                            )
                            VAE_PROFILER_PLOT(profiler::voiceCount, int64_t(mActiveVoices));
                            VAE_PROFILER_PLOT(profiler::voiceHRTFCount, int64_t(mActiveHRTFVoices));
                            VAE_PROFILER_PLOT(profiler::voiceVirtualCount, int64_t(mInactiveVoices));
                            return Result::Success;
                        }
                    }
                }
                v.source = InvalidSourceHandle; // Mark voice as free
                if (v.HRTF) {
                    mActiveHRTFVoices--;
                } else {
                    mActiveVoices--;
                }
                VAE_PROFILER_PLOT(profiler::voiceCount, int64_t(mActiveVoices));
                VAE_PROFILER_PLOT(profiler::voiceHRTFCount, int64_t(mActiveHRTFVoices));
                VAE_PROFILER_PLOT(profiler::voiceVirtualCount, int64_t(mInactiveVoices));
                return Result::Success;
            }
 
            /**
             * If the event triggers something on_end
             * it needs to be added to the finishedVoiceQueue
             * array in the voice manager.
             * The update() function on the engine will handle it
             */
 
            // TODO VAE PERF
            bool finished = false;
            for (Size i = 0; i < mFinishedVoiceQueue.size(); i++) {
                auto& f = mFinishedVoiceQueue[i];
                if (f.source == InvalidSourceHandle) {
                    mHighestFinishedVoice = std::max(mHighestFinishedVoice, i);
                    finished = true;
                    f = v;
                    // // This is set last since it marks the
                    // // finished voice for other threads
                    // f.source = v.source;
                    VAE_DEBUG_VOICES("Stopped voice from event %i:%i\tactive: %i",
                        f.event, f.bank, mActiveVoices
                    )
                    break;
                }
            }
            if (v.HRTF) {
                mActiveHRTFVoices--;
            } else {
                mActiveVoices--;
            }
            v.source = InvalidSourceHandle; // Mark voice as free
 
            if (!finished) {
                mHighestFinishedVoice = (Size) mFinishedVoiceQueue.size() - 1;
                // Failed to find a free spot in finished voices array
                // Event will be discarded
                VAE_DEBUG_VOICES("finishedVoiceQueue is full. Stop Event %i in bank %i discarded", v.event, v.bank)
                mStoppedQueueOverflow++;
                VAE_PROFILER_PLOT(profiler::stoppedVoiceOverflow, int64_t(mStoppedQueueOverflow));
            } else {
                mFinishedPending++;
            }
            VAE_PROFILER_PLOT(profiler::voiceCount, int64_t(mActiveVoices));
            VAE_PROFILER_PLOT(profiler::voiceHRTFCount, int64_t(mActiveHRTFVoices));
            VAE_PROFILER_PLOT(profiler::voiceVirtualCount, int64_t(mInactiveVoices));
            VAE_PROFILER_PLOT(profiler::voiceFinishedCount, int64_t(mFinishedPending));
            return Result::Success;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mActiveHRTFVoices

Size vae::core::VoiceManger::mActiveHRTFVoices = 0

private

Number of ative hrtf voices.

Definition at line 43 of file vae_voice_manager.hpp.

◆ mActiveVoices

Size vae::core::VoiceManger::mActiveVoices = 0

private

Number of currently playing voices.

Definition at line 41 of file vae_voice_manager.hpp.

◆ mFinishedPending

Size vae::core::VoiceManger::mFinishedPending = 0

private

Voices in mFinishedVoiceQueue.

Definition at line 46 of file vae_voice_manager.hpp.

◆ mFinishedVoiceQueue

HeapBuffer<Voice> vae::core::VoiceManger::mFinishedVoiceQueue

private

voices that finished playing are queued here

Definition at line 35 of file vae_voice_manager.hpp.

◆ mHighestFinishedVoice

Size vae::core::VoiceManger::mHighestFinishedVoice = 0

private

TODO bad as well.

Definition at line 47 of file vae_voice_manager.hpp.

◆ mHighestVoice

Size vae::core::VoiceManger::mHighestVoice = 0

private

TODO bad.

Definition at line 45 of file vae_voice_manager.hpp.

◆ mHRTFVoiceCount

Size vae::core::VoiceManger::mHRTFVoiceCount = 0

private

Number of voices reserved for hrtf.

Definition at line 44 of file vae_voice_manager.hpp.

◆ mInactiveVoices

Size vae::core::VoiceManger::mInactiveVoices = 0

private

Number of currenly virtual voices.

Definition at line 42 of file vae_voice_manager.hpp.

◆ mStarvedVoices

Size vae::core::VoiceManger::mStarvedVoices = 0

private

Voices which could not play since no other voice could be killed and are lost forever.

Definition at line 48 of file vae_voice_manager.hpp.

◆ mStoppedQueueOverflow

Size vae::core::VoiceManger::mStoppedQueueOverflow = 0

private

Voice which did not fit mFinishedVoiceQueue and could not triggered chained events.

Definition at line 49 of file vae_voice_manager.hpp.

◆ mVirtualVoices

HeapBuffer<Voice> vae::core::VoiceManger::mVirtualVoices

private

Definition at line 37 of file vae_voice_manager.hpp.

◆ mVoiceFiltered

HeapBuffer<VoiceFilter> vae::core::VoiceManger::mVoiceFiltered

private

Data needed for filtering is here.

Definition at line 39 of file vae_voice_manager.hpp.

◆ mVoicePans

HeapBuffer<VoicePan> vae::core::VoiceManger::mVoicePans

private

Interpolation data for the panning algorithm or manual panning data.

Definition at line 38 of file vae_voice_manager.hpp.

◆ mVoices

HeapBuffer<Voice> vae::core::VoiceManger::mVoices

private

Currently playing voice are here.

Definition at line 36 of file vae_voice_manager.hpp.

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

vae_voice_manager.hpp

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ all()

◆ finished()

◆ forEachFinishedVoice()

◆ forEachVoice()

◆ getActiveVoiceCount()

◆ getVoiceFilter()

◆ getVoicePan()

◆ init()

◆ makeVirtual()

◆ play()

◆ setVoiceProperty() [1/2]

◆ setVoiceProperty() [2/2]

◆ stop() [1/2]

◆ stop() [2/2]

Member Data Documentation

◆ mActiveHRTFVoices

◆ mActiveVoices

◆ mFinishedPending

◆ mFinishedVoiceQueue

◆ mHighestFinishedVoice

◆ mHighestVoice

◆ mHRTFVoiceCount

◆ mInactiveVoices

◆ mStarvedVoices

◆ mStoppedQueueOverflow

◆ mVirtualVoices

◆ mVoiceFiltered

◆ mVoicePans

◆ mVoices