vae::EnginePimpl Class Reference

Sealed of version of vae::core::Engine. More...

#include <vae_pimpl.hpp>

Collaboration diagram for vae::EnginePimpl:

Public Member Functions
void _VAE_API_EXPORT	destroy ()
Result _VAE_API_EXPORT	init (const EngineConfig &config={})
	Initializes the engine and does most of the upfront allocations. More...
Result _VAE_API_EXPORT	start ()
	Tries to open default device and start audio thread. More...
Result _VAE_API_EXPORT	stop ()
	Stops processing and waits for audio thead to clean up. More...
void _VAE_API_EXPORT	update ()
	Update function needs to be called regularly to handle outbound events and other housekeeping. More...
Result _VAE_API_EXPORT	fireEvent (BankHandle bankHandle, EventHandle eventHandle, EmitterHandle emitterHandle, Sample gain=1.0, MixerHandle mixerHandle=InvalidMixerHandle, ListenerHandle listenerHandle=AllListeners)
	Main mechanism to start and stop sounds. More...
Result _VAE_API_EXPORT	fireGlobalEvent (GlobalEventHandle globalHandle, EmitterHandle emitterHandle, Sample gain=1.0, MixerHandle mixerHandle=InvalidMixerHandle, ListenerHandle listenerHandle=AllListeners)
	Works like fireEvent but with a global Event identifier. More...
int _VAE_API_EXPORT	getActiveVoiceCount ()
	Get the number of currently playing Voices. More...
void _VAE_API_EXPORT	setMasterVolume (Sample volume)
	Set the global output volume before the limiter. More...
bool _VAE_API_EXPORT	checkVersion (int major, int minor, int patch)
	Check if the compiled version matches. More...
EmitterHandle _VAE_API_EXPORT	createEmitter ()
	Creates an emitter and returns the handle. More...
EmitterHandle _VAE_API_EXPORT	createAutoEmitter (BankHandle bank, EventHandle event, float maxDist, const LocationDirection &locDir, float spread)
	Emitter which triggers an event once a listener is close enough. More...
Result _VAE_API_EXPORT	addEmitter (EmitterHandle h)
	Adds an emitter with a custom handle, can be an internal ID for example. More...
Result _VAE_API_EXPORT	removeEmitter (EmitterHandle h)
	Unregister a emiter an kill all its voices. More...
Result _VAE_API_EXPORT	setEmitter (EmitterHandle emitter, const LocationDirection &locDir, float spread)
	Set the Emitter position, orientation and spread. More...
Result _VAE_API_EXPORT	stopEmitter (EmitterHandle emitter)
	Stop all voices from emitter. More...
void _VAE_API_EXPORT	setVolume (EmitterHandle emitter, Sample gain)
	Sets the volume of all active voices with this emitter. More...
void _VAE_API_EXPORT	seek (EmitterHandle emitter, Size time)
	Set the current time of all voices with the emitter. More...
void _VAE_API_EXPORT	setSpeed (EmitterHandle emitter, float speed)
	Set the playback speed. More...
void _VAE_API_EXPORT	setLowpass (EmitterHandle emitter, float cutoff)
	Simple lowpass filter for the voices. More...
void _VAE_API_EXPORT	setHighpass (EmitterHandle emitter, float cutoff)
	Simple highpass filter for the voices. More...
ListenerHandle _VAE_API_EXPORT	createListener ()
	Create a Listener object. More...
Result _VAE_API_EXPORT	removeListener (ListenerHandle listener)
	Unregister listener. More...
Result _VAE_API_EXPORT	setListener (ListenerHandle listener, const LocationOrientation &locOr)
	Set the position of a listener. More...
Result _VAE_API_EXPORT	loadHRTF (const char *path, Size size=0)
Result _VAE_API_EXPORT	loadBank (const char *path, Size size=0)
	Load bank from filesystem. More...
Result _VAE_API_EXPORT	unloadBankFromId (BankHandle bankHandle)
	Unload bank from handle. More...
void _VAE_API_EXPORT	unloadAllBanks ()
	Unload every bank and data associated with it. More...

Static Public Member Functions
static EnginePimpl *_VAE_API_EXPORT	create ()

Private Member Functions
	EnginePimpl ()
	EnginePimpl (const EnginePimpl &)
	~EnginePimpl ()

Detailed Description

Sealed of version of vae::core::Engine.

There are a few function, which aren't exported due to the fact that they would pull all the dependencies like tklb::AudioBuffer back in.

See also

vae::core::Engine

Definition at line 28 of file vae_pimpl.hpp.

Constructor & Destructor Documentation

EnginePimpl() [1/2]

vae::EnginePimpl::EnginePimpl ( )

private

EnginePimpl() [2/2]

vae::EnginePimpl::EnginePimpl ( const EnginePimpl &  )

private

~EnginePimpl()

vae::EnginePimpl::~EnginePimpl ( )

inlineprivate

Definition at line 31 of file vae_pimpl.hpp.

{ };

Member Function Documentation

addEmitter()

Result EnginePimpl::addEmitter

(

EmitterHandle

h

)

Adds an emitter with a custom handle, can be an internal ID for example.

migt be desireable to make EmitterHandle the same size as a pointer so this can simply be the pointer of the entity that is associated with it.

Parameters

h

Returns

Result

Definition at line 124 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.addEmitter(
        h
    );
}

Here is the call graph for this function:

checkVersion()

bool EnginePimpl::checkVersion	(	int	major,
		int	minor,
		int	patch
	)

Check if the compiled version matches.

Definition at line 89 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.checkVersion(
        major,
        minor,
        patch
    );
}

Here is the call graph for this function:

create()

EnginePimpl * EnginePimpl::create ( )

static

Definition at line 5 of file vae_pimpl.cpp.

                                 {
    auto e = new core::Engine();
    return reinterpret_cast<EnginePimpl*>(e);
}

Here is the caller graph for this function:

createAutoEmitter()

EmitterHandle EnginePimpl::createAutoEmitter	(	BankHandle	bank,
		EventHandle	event,
		float	maxDist,
		const LocationDirection &	locDir,
		float	spread
	)

Emitter which triggers an event once a listener is close enough.

Parameters

bank
event
maxDist
locDir
spread

Returns

EmitterHandle Handle like a normal emitter

Definition at line 107 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.createAutoEmitter(
        bank,
        event,
        maxDist,
        locDir,
        spread
    );
}

Here is the call graph for this function:

createEmitter()

EmitterHandle EnginePimpl::createEmitter

(

)

Creates an emitter and returns the handle.

Returns

EmitterHandle Random handle

Definition at line 102 of file vae_pimpl.cpp.

                                          {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.createEmitter();
}

Here is the call graph for this function:

createListener()

ListenerHandle EnginePimpl::createListener

(

)

Create a Listener object.

TODO make listener 0 implicit

Returns

ListenerHandle

Definition at line 219 of file vae_pimpl.cpp.

                                            {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.createListener();
}

Here is the call graph for this function:

destroy()

void EnginePimpl::destroy

(

)

Definition at line 10 of file vae_pimpl.cpp.

                          {
    auto e = reinterpret_cast<core::Engine*>(this);
    delete e;
}

fireEvent()

Result EnginePimpl::fireEvent	(	BankHandle	bankHandle,
		EventHandle	eventHandle,
		EmitterHandle	emitterHandle,
		Sample	gain = 1.0,
		MixerHandle	mixerHandle = InvalidMixerHandle,
		ListenerHandle	listenerHandle = AllListeners
	)

Main mechanism to start and stop sounds.

See also

Event

Parameters

bankHandle	bank id where the event is provided
eventHandle	id of the event
emitterHandle	handle of the emitter, needed for spatial audio or controlling the voice
gain	optional volume factor
mixerHandle	optional id of mixer channel sound will be routed to, this will override the one set in the event
listenerHandle	For which listener this event will be adible for, default to all

Returns

Result

Definition at line 39 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.fireEvent(
        bankHandle,
        eventHandle,
        emitterHandle,
        gain,
        mixerHandle,
        listenerHandle
    );
}

Here is the call graph for this function:

fireGlobalEvent()

Result EnginePimpl::fireGlobalEvent	(	GlobalEventHandle	globalHandle,
		EmitterHandle	emitterHandle,
		Sample	gain = 1.0,
		MixerHandle	mixerHandle = InvalidMixerHandle,
		ListenerHandle	listenerHandle = AllListeners
	)

Works like fireEvent but with a global Event identifier.

See also

fireEvent

Parameters

globalHandle	The GlobalEventHandle combines both bank and event id
emitterHandle	optional handle of the emitter, needed for spatial audio
gain	optional volume factor
mixerHandle	id of mixer channel sound will be routed to, this will override the one set in the event

Returns

Result

Definition at line 58 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.fireGlobalEvent(
        globalHandle,
        emitterHandle,
        gain,
        mixerHandle,
        listenerHandle
    );
}

Here is the call graph for this function:

getActiveVoiceCount()

int EnginePimpl::getActiveVoiceCount

(

)

Get the number of currently playing Voices.

Definition at line 75 of file vae_pimpl.cpp.

                                      {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.getActiveVoiceCount();
}

Here is the call graph for this function:

init()

Result EnginePimpl::init

(

const EngineConfig &

config = {}

)

Initializes the engine and does most of the upfront allocations.

Run this before start !

Everything will be allocated according to the provided config. Loading a Bank will still cause an allocation. If there are already banks loaded, they will be reloaded to have the correct samplerate.

See also

start

Parameters

config

Optional config to setup the internals.

Returns

Result

Definition at line 15 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.init(
        config
    );
}

Here is the call graph for this function:

loadBank()

Result EnginePimpl::loadBank	(	const char *	path,
		Size	size = 0
	)

Load bank from filesystem.

This operation might take a little time but won't lock the audio thread until the bank is inserted. This should be safe to do at any time.

Parameters

path

Returns

Result

Definition at line 255 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.loadBank(
        path,
        size
    );
}

Here is the call graph for this function:

loadHRTF()

Result EnginePimpl::loadHRTF	(	const char *	path,
		Size	size = 0
	)

Definition at line 244 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.loadHRTF(
        path,
        size
    );
}

Here is the call graph for this function:

removeEmitter()

Result EnginePimpl::removeEmitter

(

EmitterHandle

h

)

Unregister a emiter an kill all its voices.

Parameters

h

Returns

Result

Definition at line 133 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.removeEmitter(
        h
    );
}

Here is the call graph for this function:

removeListener()

Result EnginePimpl::removeListener

(

ListenerHandle

listener

)

Unregister listener.

Parameters

listener

Definition at line 224 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.removeListener(
        listener
    );
}

Here is the call graph for this function:

seek()

void EnginePimpl::seek	(	EmitterHandle	emitter,
		Size	time
	)

Set the current time of all voices with the emitter.

Parameters

emitter
time	Time in samples

Definition at line 175 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.seek(
        emitter,
        time
    );
}

Here is the call graph for this function:

setEmitter()

Result EnginePimpl::setEmitter	(	EmitterHandle	emitter,
		const LocationDirection &	locDir,
		float	spread
	)

Set the Emitter position, orientation and spread.

Parameters

emitter	The emitter
locDir	The desired location
spread	The width of the panning (if it's spatial and not HRTF)

Returns

Result

Definition at line 142 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.setEmitter(
        emitter,
        locDir,
        spread
    );
}

Here is the call graph for this function:

setHighpass()

void EnginePimpl::setHighpass	(	EmitterHandle	emitter,
		float	cutoff
	)

Simple highpass filter for the voices.

Parameters

emitter
cutoff	0-1. 0 doesn't filter, 1 filter the wholespektrum

Definition at line 208 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.setHighpass(
        emitter,
        cutoff
    );
}

Here is the call graph for this function:

setListener()

Result EnginePimpl::setListener	(	ListenerHandle	listener,
		const LocationOrientation &	locOr
	)

Set the position of a listener.

Parameters

listener

Returns

Result

Definition at line 233 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.setListener(
        listener,
        locOr
    );
}

Here is the call graph for this function:

setLowpass()

void EnginePimpl::setLowpass	(	EmitterHandle	emitter,
		float	cutoff
	)

Simple lowpass filter for the voices.

Parameters

emitter
cutoff	0-1. 0 doesn't filter, 1 filter the wholespektrum

Definition at line 197 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.setLowpass(
        emitter,
        cutoff
    );
}

Here is the call graph for this function:

setMasterVolume()

void EnginePimpl::setMasterVolume

(

Sample

volume

)

Set the global output volume before the limiter.

The engine can't clip, but if the output is too load the signal will be squashed in the limiter.

Parameters

volume

1.0 is the default, not interpolated for now

Definition at line 80 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.setMasterVolume(
        volume
    );
}

Here is the call graph for this function:

setSpeed()

void EnginePimpl::setSpeed	(	EmitterHandle	emitter,
		float	speed
	)

Set the playback speed.

Parameters

emitter
speed	1.0 is the default speed, pitch will be affected as well.

Definition at line 186 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.setSpeed(
        emitter,
        speed
    );
}

Here is the call graph for this function:

setVolume()

void EnginePimpl::setVolume	(	EmitterHandle	emitter,
		Sample	gain
	)

Sets the volume of all active voices with this emitter.

Parameters

emitter
gain

Definition at line 164 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.setVolume(
        emitter,
        gain
    );
}

Here is the call graph for this function:

start()

Result EnginePimpl::start

(

)

Tries to open default device and start audio thread.

Call this after start.

See also

init

Returns

Result

Definition at line 24 of file vae_pimpl.cpp.

                           {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.start();
}

Here is the call graph for this function:

stop()

Result EnginePimpl::stop

(

)

Stops processing and waits for audio thead to clean up.

Returns

Result

Definition at line 29 of file vae_pimpl.cpp.

                          {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.stop();
}

Here is the call graph for this function:

stopEmitter()

Result EnginePimpl::stopEmitter

(

EmitterHandle

emitter

)

Stop all voices from emitter.

Parameters

emitter

Returns

Result

Definition at line 155 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.stopEmitter(
        emitter
    );
}

Here is the call graph for this function:

unloadAllBanks()

void EnginePimpl::unloadAllBanks

(

)

Unload every bank and data associated with it.

Definition at line 275 of file vae_pimpl.cpp.

                                  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.unloadAllBanks();
}

Here is the call graph for this function:

unloadBankFromId()

Result EnginePimpl::unloadBankFromId

(

BankHandle

bankHandle

)

Unload bank from handle.

Locks audio thread and stops all voices from that bank.

Parameters

bankHandle

Returns

Result

Definition at line 266 of file vae_pimpl.cpp.

  {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.unloadBankFromId(
        bankHandle
    );
}

Here is the call graph for this function:

update()

void EnginePimpl::update

(

)

Update function needs to be called regularly to handle outbound events and other housekeeping.

If this isn't called regularly events might be lost and chained events not fired. When EngineConfig::updateInAudioThread is true, this doesn't need to be called manually.

See also

EngineConfig::updateInAudioThread

Definition at line 34 of file vae_pimpl.cpp.

                          {
    auto& e = *reinterpret_cast<core::Engine*>(this);
    return e.update();
}

Here is the call graph for this function:

---

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

• vae_pimpl.hpp
• vae_pimpl.cpp