Interface for audio devices. More...

#include <vae_device.hpp>

Inheritance diagram for vae::core::Device:

Collaboration diagram for vae::core::Device:

Classes
struct	AudioThreadWorker
	Data shared with audio thread. More...

Public Types
using	Resampler = tklb::ResamplerTpl< Sample, ScratchBuffer >

Public Member Functions
	Device (Backend &backend, const EngineConfig &config)
	Only a Backend can construct a Device. More...

virtual	~Device ()

void	setCallback (Callback callback)

virtual bool	openDevice (DeviceInfo &device)=0
	Opens a specific audio device. More...

virtual bool	openDevice (bool input=false)
	Tries to open the default audio device whith desired in out channels. More...

virtual bool	closeDevice ()=0
	Closes the currently open device. More...

Size	push (const ScratchBuffer &buffer)
	Push samples to the audio device. More...

Size	canPush () const
	Return amount of audio frames which can be pushed in buffer ! this is an estimate when resampling ! More...

void	pop (ScratchBuffer &buffer)
	Get samples form audio device. More...

Size	canPop () const

Size	getChannelsOut () const

Size	getChannelsIn () const

Size	getSampleRate () const
	Get the sample rate. More...

Size	getRealSampleRate () const
	Get the Real Sample Rate before resampling. More...

size_t	getStreamTime () const

Size	getOverruns () const

Size	getUnderruns () const

Protected Types
using	Callback = tklb::Delegate< void(Device *)>

Protected Member Functions
void	init (Size sampleRate, Uchar channelsIn, Uchar channelsOut, Size bufferSize)
	initializes buffers, queues and resamplers if needed Has to be called in openDevice once the samplerate and channel config is known More...

void	postInit ()

Protected Attributes
Backend &	mBackend

const EngineConfig &	mConfig

Size	mSampleRate = 0

Size	mRealSampleRate = 0

Size	mOverruns = 0

Size	mUnderruns = 0

Resampler	mResamplerToDevice

ScratchBuffer	mResamplerBufferToDevice

AudioThreadWorker	mWorker

Static Protected Attributes
static constexpr int	_VAE_WORKER_SIZE = sizeof(AudioThreadWorker)

Detailed Description

Interface for audio devices.

Default implementation for resampling already provided.

Definition at line 18 of file vae_device.hpp.

Member Typedef Documentation

◆ Callback

using vae::core::Device::Callback = tklb::Delegate<void(Device*)>

protected

Definition at line 25 of file vae_device.hpp.

◆ Resampler

using vae::core::Device::Resampler = tklb::ResamplerTpl<Sample, ScratchBuffer>

Definition at line 20 of file vae_device.hpp.

Constructor & Destructor Documentation

◆ Device()

vae::core::Device::Device	(	Backend &	backend,
		const EngineConfig &	config
	)

inline

Only a Backend can construct a Device.

Definition at line 184 of file vae_device.hpp.

186 : mBackend(backend), mConfig(config) { }

vae::core::Device::mConfig

const EngineConfig & mConfig

Definition: vae_device.hpp:24

vae::core::Device::mBackend

Backend & mBackend

Definition: vae_device.hpp:23

◆ ~Device()

virtual vae::core::Device::~Device ( )

inlinevirtual

Definition at line 188 of file vae_device.hpp.

                          {
            VAE_DEBUG(
                "Device destructed. Underruns: %i %i Overruns:%i %i",
                mWorker.underruns, mUnderruns,
                mWorker.overruns, mOverruns
            )
        }

Member Function Documentation

◆ canPop()

Size vae::core::Device::canPop ( ) const

inline

Definition at line 278 of file vae_device.hpp.

                            {
            return mWorker.queueFromDevice.filled();
        }

Here is the call graph for this function:

◆ canPush()

Size vae::core::Device::canPush ( ) const

inline

Return amount of audio frames which can be pushed in buffer ! this is an estimate when resampling !

Returns: Size

Definition at line 254 of file vae_device.hpp.

                             {
            VAE_PROFILER_SCOPE()
            auto remaining = mWorker.queueToDevice.remaining();
            if (mResamplerToDevice.isInitialized()) {
                return mResamplerToDevice.estimateNeed(remaining);
            }
            return remaining;
        }

Here is the call graph for this function:

◆ closeDevice()

virtual bool vae::core::Device::closeDevice ( )

pure virtual

Closes the currently open device.

Otherwise does nothing.

Implemented in vae::core::DeviceDummy, vae::core::DevicePortaudio, and vae::core::DeviceRtaudio.

◆ getChannelsIn()

Size vae::core::Device::getChannelsIn ( ) const

inline

Definition at line 284 of file vae_device.hpp.

284{ return mWorker.channelsIn; }

vae::core::Device::AudioThreadWorker::channelsIn

Uchar channelsIn

Definition: vae_device.hpp:52

◆ getChannelsOut()

Size vae::core::Device::getChannelsOut ( ) const

inline

Definition at line 282 of file vae_device.hpp.

282{ return mWorker.channelsOut; }

◆ getOverruns()

Size vae::core::Device::getOverruns ( ) const

inline

Definition at line 301 of file vae_device.hpp.

301{ return mWorker.overruns; }

◆ getRealSampleRate()

Size vae::core::Device::getRealSampleRate ( ) const

inline

Get the Real Sample Rate before resampling.

Returns: Size

Definition at line 297 of file vae_device.hpp.

297{ return mRealSampleRate; }

vae::core::Device::mRealSampleRate

Size mRealSampleRate

Definition: vae_device.hpp:27

◆ getSampleRate()

Size vae::core::Device::getSampleRate ( ) const

inline

Get the sample rate.

Returns: samplerate after resampling

Definition at line 290 of file vae_device.hpp.

290{ return mSampleRate; }

vae::core::Device::mSampleRate

Size mSampleRate

Definition: vae_device.hpp:26

◆ getStreamTime()

size_t vae::core::Device::getStreamTime ( ) const

inline

Definition at line 299 of file vae_device.hpp.

299{ return mWorker.streamTime; }

vae::core::Device::AudioThreadWorker::streamTime

size_t streamTime

Definition: vae_device.hpp:47

◆ getUnderruns()

Size vae::core::Device::getUnderruns ( ) const

inline

Definition at line 302 of file vae_device.hpp.

302{ return mWorker.underruns; }

◆ init()

void vae::core::Device::init	(	Size	sampleRate,
		Uchar	channelsIn,
		Uchar	channelsOut,
		Size	bufferSize
	)

inlineprotected

initializes buffers, queues and resamplers if needed Has to be called in openDevice once the samplerate and channel config is known

Parameters

sampleRate	The actual samplerate the device has, might not match requested rate
channelsIn	The real channelcount, might not match requested
channelsOut	The real channelcount, might not match requested
bufferSize	The amount of frames a callback will provide/request

Definition at line 114 of file vae_device.hpp.

                                                                                         {
            VAE_PROFILER_SCOPE_NAMED("Init Device")
            mWorker.channelsIn  = channelsIn;
            mWorker.channelsOut = channelsOut;
            mRealSampleRate  = sampleRate;
 
            if (sampleRate != mConfig.internalSampleRate) {
                if (0 < channelsIn) {
                    // we get full device buffersize for these buffers
                    mWorker.resamplerFromDevice.init(
                        sampleRate, mConfig.internalSampleRate, bufferSize
                    );
                    mWorker.resampleBufferFromdevice.resize(
                        mWorker.resamplerFromDevice.calculateBufferSize(bufferSize),
                        channelsIn
                    );
                    mWorker.resampleBufferFromdevice.sampleRate =
                        mConfig.internalSampleRate;
                    mSampleRate = mConfig.internalSampleRate;
                }
                if (0 < channelsOut) {
                    // But only DSP max block size in this direction
                    mResamplerToDevice.init(
                        mConfig.internalSampleRate, sampleRate, StaticConfig::MaxBlock
                    );
                    mResamplerBufferToDevice.resize(
                        mResamplerToDevice.calculateBufferSize(StaticConfig::MaxBlock),
                        channelsOut
                    );
                    mResamplerBufferToDevice.sampleRate = sampleRate;
                    mSampleRate = mConfig.internalSampleRate;
                }
            } else {
                mSampleRate = mConfig.internalSampleRate;
            }
 
            if (0 < channelsIn) {
                mWorker.queueFromDevice.resize(
                    bufferSize * mConfig.bufferPeriods,
                    channelsIn
                );
            }
            if (0 < channelsOut) {
                mWorker.queueToDevice.resize(
                    bufferSize * mConfig.bufferPeriods,
                    channelsOut
                );
                mWorker.queueToDevice.set(0);
            }
 
            mWorker.convertBuffer.sampleRate = sampleRate;
            mWorker.convertBuffer.resize(
                bufferSize,
                std::max(channelsOut, channelsIn) // buffer is shared for in and out, so make sure it has space for both
            );
        }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ openDevice() [1/2]

virtual bool vae::core::Device::openDevice ( bool input = false )

inlinevirtual

Tries to open the default audio device whith desired in out channels.

Reimplemented in vae::core::DeviceDummy.

Definition at line 212 of file vae_device.hpp.

                                                    {
            DeviceInfo device =
                input ? mBackend.getDefaultInputDevice() : mBackend.getDefaultOutputDevice();
            return openDevice(device);
        };

Here is the call graph for this function:

◆ openDevice() [2/2]

virtual bool vae::core::Device::openDevice ( DeviceInfo & device )

pure virtual

Opens a specific audio device.

The device struct may be altered to match the actual hardware. (sampleRate, bufferSize and channel count)

Implemented in vae::core::DeviceDummy, vae::core::DevicePortaudio, and vae::core::DeviceRtaudio.

Here is the caller graph for this function:

◆ pop()

void vae::core::Device::pop ( ScratchBuffer & buffer )

inline

Get samples form audio device.

Parameters

buffer Gets the amount of valid samples, might actualy get less

Definition at line 267 of file vae_device.hpp.

                                        {
            VAE_PROFILER_SCOPE()
            VAE_ASSERT(0 < mWorker.channelsIn)
            auto frames = buffer.validSize();
            VAE_ASSERT(frames != 0) // need to have valid frames
            Lock lock(mWorker.mutex);
            const auto popped = mWorker.queueFromDevice.pop(buffer, frames);
            mUnderruns += (frames - popped);
            VAE_PROFILER_PLOT(profiler::engineUnderruns, int64_t(mOverruns));
        }

Here is the call graph for this function:

◆ postInit()

void vae::core::Device::postInit ( )

inlineprotected

Definition at line 171 of file vae_device.hpp.

                        {
            VAE_DEBUG("Opened Audio Device on %s with samplerate %i", mBackend.getName(), mRealSampleRate)
            if (mRealSampleRate != mSampleRate) {
                VAE_DEBUG("Audio Device resamples to %i", mSampleRate)
            }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ push()

Size vae::core::Device::push ( const ScratchBuffer & buffer )

inline

Push samples to the audio device.

Parameters

buffer Pushes the amount of valid samples

Definition at line 228 of file vae_device.hpp.

                                               {
            VAE_PROFILER_SCOPE()
            VAE_ASSERT(0 < mWorker.channelsOut)
            const auto frames = buffer.validSize();
            VAE_ASSERT(frames != 0) // need to have valid frames
            if (mResamplerToDevice.isInitialized()) {
                mResamplerToDevice.process(buffer, mResamplerBufferToDevice);
                Lock lock(mWorker.mutex);
                const auto pushed = mWorker.queueToDevice.push(mResamplerBufferToDevice);
                mOverruns += (mResamplerBufferToDevice.validSize() - pushed);
                return pushed;
            } else {
                Lock lock(mWorker.mutex);
                const auto pushed = mWorker.queueToDevice.push(buffer);
                mOverruns += (frames - pushed);
                return pushed;
            }
            VAE_PROFILER_PLOT(profiler::engineOverruns, int64_t(mOverruns));
            return 0;
        }

Here is the call graph for this function:

◆ setCallback()

void vae::core::Device::setCallback ( Callback callback )

inline

Definition at line 196 of file vae_device.hpp.

                                            {
            mWorker.device = this;
            mWorker.callback = callback;
            VAE_DEBUG("Device uses sync callback")
        }

Here is the caller graph for this function:

Member Data Documentation

◆ _VAE_WORKER_SIZE

constexpr int vae::core::Device::_VAE_WORKER_SIZE = sizeof(AudioThreadWorker)

staticconstexprprotected

Definition at line 100 of file vae_device.hpp.

◆ mBackend

Backend& vae::core::Device::mBackend

protected

Definition at line 23 of file vae_device.hpp.

◆ mConfig

const EngineConfig& vae::core::Device::mConfig

protected

Definition at line 24 of file vae_device.hpp.

◆ mOverruns

Size vae::core::Device::mOverruns = 0

protected

Definition at line 28 of file vae_device.hpp.

◆ mRealSampleRate

Size vae::core::Device::mRealSampleRate = 0

protected

Definition at line 27 of file vae_device.hpp.

◆ mResamplerBufferToDevice

ScratchBuffer vae::core::Device::mResamplerBufferToDevice

protected

Definition at line 32 of file vae_device.hpp.

◆ mResamplerToDevice

Resampler vae::core::Device::mResamplerToDevice

protected

Definition at line 31 of file vae_device.hpp.

◆ mSampleRate

Size vae::core::Device::mSampleRate = 0

protected

Definition at line 26 of file vae_device.hpp.

◆ mUnderruns

Size vae::core::Device::mUnderruns = 0

protected

Definition at line 29 of file vae_device.hpp.

◆ mWorker

AudioThreadWorker vae::core::Device::mWorker

protected

Definition at line 102 of file vae_device.hpp.

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

vae_device.hpp

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Callback

◆ Resampler

Constructor & Destructor Documentation

◆ Device()

◆ ~Device()

Member Function Documentation

◆ canPop()

◆ canPush()

◆ closeDevice()

◆ getChannelsIn()

◆ getChannelsOut()

◆ getOverruns()

◆ getRealSampleRate()

◆ getSampleRate()

◆ getStreamTime()

◆ getUnderruns()

◆ init()

◆ openDevice() [1/2]

◆ openDevice() [2/2]

◆ pop()

◆ postInit()

◆ push()

◆ setCallback()

Member Data Documentation

◆ _VAE_WORKER_SIZE

◆ mBackend

◆ mConfig

◆ mOverruns

◆ mRealSampleRate

◆ mResamplerBufferToDevice

◆ mResamplerToDevice

◆ mSampleRate

◆ mUnderruns

◆ mWorker