#include <AudioUnitInstance.h>

Inheritance diagram for AudioUnitInstance:

Collaboration diagram for AudioUnitInstance:

Public Member Functions
	AudioUnitInstance (const PerTrackEffect &effect, AudioComponent component, Parameters &parameters, const wxString &identifier, unsigned audioIns, unsigned audioOuts, bool useLatency)

void	EventListener (const AudioUnitEvent *inEvent, AudioUnitParameterValue inParameterValue)

std::unique_ptr< Message >	MakeMessage () const override
	Called on the main thread, in which the result may be cloned. More...

std::unique_ptr< Message >	MakeMessage (AudioUnitParameterID id, AudioUnitParameterValue value) const

Public Member Functions inherited from PerTrackEffect::Instance
	Instance (const PerTrackEffect &processor)

	~Instance () override

bool	Process (EffectSettings &settings) final
	Uses the other virtual functions of this class. More...

bool	ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap) override

bool	ProcessFinalize () noexcept override

Public Member Functions inherited from EffectInstanceEx
virtual bool	Init ()
	Call once to set up state for whole list of tracks to be processed. More...

virtual bool	Process (EffectSettings &settings)=0
	Actually do the effect here. More...

	~EffectInstanceEx () override

Public Member Functions inherited from EffectInstance
virtual	~EffectInstance ()

virtual size_t	GetBlockSize () const =0

virtual size_t	SetBlockSize (size_t maxBlockSize)=0

virtual unsigned	GetAudioInCount () const =0
	How many input buffers to allocate at once. More...

virtual unsigned	GetAudioOutCount () const =0
	How many output buffers to allocate at once. More...

virtual bool	RealtimeInitialize (EffectSettings &settings, double sampleRate)

virtual bool	RealtimeAddProcessor (EffectSettings &settings, EffectOutputs *pOutputs, unsigned numChannels, float sampleRate)

virtual bool	RealtimeSuspend ()

virtual bool	RealtimeResume ()

virtual std::unique_ptr< Message >	MakeMessage () const
	Called on the main thread, in which the result may be cloned. More...

virtual bool	UsesMessages () const noexcept

virtual bool	RealtimeProcessStart (MessagePackage &package)
	settings are possibly changed, since last call, by an asynchronous dialog More...

virtual size_t	RealtimeProcess (size_t group, EffectSettings &settings, const float const inBuf, float const outBuf, size_t numSamples)

virtual void	RealtimePassThrough (size_t group, EffectSettings &settings, const float const inBuf, size_t numSamples)
	Called instead of `RealtimeProcess` when the effect is bypassed. Default implementation does nothing. More...

virtual bool	RealtimeProcessEnd (EffectSettings &settings) noexcept
	settings can be updated to let a dialog change appearance at idle More...

virtual bool	RealtimeFinalize (EffectSettings &settings) noexcept

virtual size_t	GetTailSize () const

virtual SampleCount	GetLatency (const EffectSettings &settings, double sampleRate) const

virtual bool	NeedsDither () const

virtual bool	ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap)=0

virtual bool	ProcessFinalize () noexcept=0

virtual size_t	ProcessBlock (EffectSettings &settings, const float const inBlock, float const outBlock, size_t blockLen)=0
	Called for destructive effect computation. More...

Public Member Functions inherited from AudioUnitWrapper
	AudioUnitWrapper (AudioComponent component, Parameters *pParameters)

template<typename T >
OSStatus	GetFixedSizeProperty (AudioUnitPropertyID inID, T &property, AudioUnitScope inScope=kAudioUnitScope_Global, AudioUnitElement inElement=0) const

template<typename T >
OSStatus	GetVariableSizeProperty (AudioUnitPropertyID inID, PackedArray::Ptr< T > &pObject, AudioUnitScope inScope=kAudioUnitScope_Global, AudioUnitElement inElement=0) const

template<typename T >
OSStatus	SetProperty (AudioUnitPropertyID inID, const T &property, AudioUnitScope inScope=kAudioUnitScope_Global, AudioUnitElement inElement=0) const

void	ForEachParameter (ParameterVisitor visitor) const

bool	LoadPreset (const EffectDefinitionInterface &effect, const RegistryPath &group, EffectSettings &settings) const

bool	LoadFactoryPreset (const EffectDefinitionInterface &effect, int id, EffectSettings *pSettings) const

std::pair< CF_ptr< CFDataRef >, TranslatableString >	MakeBlob (const EffectDefinitionInterface &effect, const AudioUnitEffectSettings &settings, const wxCFStringRef &cfname, bool binary) const
	Obtain dump of the setting state of an AudioUnit instance. More...

TranslatableString	InterpretBlob (AudioUnitEffectSettings &settings, const wxString &group, const wxMemoryBuffer &buf) const
	Interpret the dump made before by MakeBlob. More...

bool	FetchSettings (AudioUnitEffectSettings &settings, bool fetchValues, bool fetchPreset=false) const
	May allocate memory, so should be called only in the main thread. More...

bool	StoreSettings (const EffectDefinitionInterface &effect, const AudioUnitEffectSettings &settings) const

bool	CreateAudioUnit ()

AudioUnit	GetAudioUnit () const

AudioComponent	GetComponent () const

const Parameters &	GetParameters () const

bool	SetRateAndChannels (double sampleRate, const wxString &identifier)

Private Member Functions
size_t	InitialBlockSize () const

SampleCount	GetLatency (const EffectSettings &settings, double sampleRate) const override

size_t	GetBlockSize () const override

size_t	SetBlockSize (size_t maxBlockSize) override

unsigned	GetAudioInCount () const override
	How many input buffers to allocate at once. More...

unsigned	GetAudioOutCount () const override
	How many output buffers to allocate at once. More...

bool	ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap) override

bool	ProcessFinalize () noexcept override

size_t	ProcessBlock (EffectSettings &settings, const float const inBlock, float const outBlock, size_t blockLen) override
	Called for destructive effect computation. More...

bool	RealtimeInitialize (EffectSettings &settings, double sampleRate) override

bool	RealtimeAddProcessor (EffectSettings &settings, EffectOutputs *pOutputs, unsigned numChannels, float sampleRate) override

bool	RealtimeFinalize (EffectSettings &settings) noexcept override

bool	RealtimeSuspend () override

bool	RealtimeResume () override

bool	UsesMessages () const noexcept override

bool	RealtimeProcessStart (MessagePackage &package) override
	settings are possibly changed, since last call, by an asynchronous dialog More...

size_t	RealtimeProcess (size_t group, EffectSettings &settings, const float const inbuf, float const outbuf, size_t numSamples) override

bool	RealtimeProcessEnd (EffectSettings &settings) noexcept override
	settings can be updated to let a dialog change appearance at idle More...

OSStatus	Render (AudioUnitRenderActionFlags inActionFlags, const AudioTimeStamp inTimeStamp, UInt32 inBusNumber, UInt32 inNumFrames, AudioBufferList *ioData)

bool	BypassEffect (bool bypass)

Static Private Member Functions
static OSStatus	RenderCallback (void inRefCon, AudioUnitRenderActionFlags inActionFlags, const AudioTimeStamp inTimeStamp, UInt32 inBusNumber, UInt32 inNumFrames, AudioBufferList ioData)

Private Attributes
bool	mRecruited { false }
	Whether the master instance is now allocated to a group number. More...

std::vector< std::unique_ptr< AudioUnitInstance > >	mSlaves

AudioUnitCleanup< AudioUnit, AudioUnitUninitialize >	mInitialization

AudioTimeStamp	mTimeStamp {}

PackedArray::Ptr< AudioBufferList >	mInputList

PackedArray::Ptr< AudioBufferList >	mOutputList

const wxString &	mIdentifier

const size_t	mBlockSize

const bool	mUseLatency

Additional Inherited Members
Public Types inherited from EffectInstance
using	Message = EffectSettingsAccess::Message

using	SampleCount = uint64_t

Public Types inherited from AudioUnitWrapper
using	Parameters = PackedArray::Ptr< const AudioUnitParameterID >

using	ParameterVisitor = std::function< bool(const ParameterInfo &pi, AudioUnitParameterID ID) >
	Return value: if true, continue visiting. More...

Static Public Member Functions inherited from AudioUnitWrapper
static AudioUnitEffectSettings &	GetSettings (EffectSettings &settings)

static const AudioUnitEffectSettings &	GetSettings (const EffectSettings &settings)

static bool	MoveSettingsContents (AudioUnitEffectSettings &&src, AudioUnitEffectSettings &dst, bool merge)
	Copy, then clear the optionals in src. More...

Protected Attributes inherited from PerTrackEffect::Instance
const PerTrackEffect &	mProcessor

Protected Attributes inherited from AudioUnitWrapper
const AudioComponent	mComponent

AudioUnitCleanup< AudioUnit, AudioComponentInstanceDispose >	mUnit

Parameters	mOwnParameters

Parameters &	mParameters

unsigned	mAudioIns { 2 }

unsigned	mAudioOuts { 2 }

Detailed Description

Definition at line 19 of file AudioUnitInstance.h.

Constructor & Destructor Documentation

◆ AudioUnitInstance()

AudioUnitInstance::AudioUnitInstance	(	const PerTrackEffect &	effect,
		AudioComponent	component,
		Parameters &	parameters,
		const wxString &	identifier,
		unsigned	audioIns,
		unsigned	audioOuts,
		bool	useLatency
	)

Definition at line 58 of file AudioUnitInstance.cpp.

   : PerTrackEffect::Instance{ effect }
   , AudioUnitWrapper{ component, &parameters }
   , mIdentifier{ identifier }
   , mBlockSize{ InitialBlockSize() }
   , mUseLatency{ useLatency }
{
   mAudioIns = audioIns;
   mAudioOuts = audioOuts;
   CreateAudioUnit();
}

References AudioUnitWrapper::CreateAudioUnit(), AudioUnitWrapper::mAudioIns, and AudioUnitWrapper::mAudioOuts.

Here is the call graph for this function:

Member Function Documentation

◆ BypassEffect()

bool AudioUnitInstance::BypassEffect ( bool bypass )

private

Definition at line 422 of file AudioUnitInstance.cpp.

{
   UInt32 value = (bypass ? 1 : 0);
   if (bypass && AudioUnitReset(mUnit.get(), kAudioUnitScope_Global, 0))
      return false;
   return !SetProperty(kAudioUnitProperty_BypassEffect, value);
}

References AudioUnitWrapper::mUnit, and AudioUnitWrapper::SetProperty().

Referenced by ProcessInitialize(), RealtimeResume(), and RealtimeSuspend().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EventListener()

void AudioUnitInstance::EventListener	(	const AudioUnitEvent *	inEvent,
		AudioUnitParameterValue	inParameterValue
	)

Definition at line 388 of file AudioUnitInstance.cpp.

{
   // Handle property changes
   if (inEvent->mEventType == kAudioUnitEvent_PropertyChange) {
      // Handle latency changes
      if (inEvent->mArgument.mProperty.mPropertyID ==
          kAudioUnitProperty_Latency) {
         // Do what?
      }
      return;
   }
   
   if (inEvent->mEventType != kAudioUnitEvent_ParameterValueChange)
      return;
 
   // Only parameter changes at this point
   const auto parameterStorer = [inParameterValue,
      ID = inEvent->mArgument.mParameter.mParameterID
   ](AudioUnit pUnit){
      AudioUnitSetParameter(pUnit, ID,
         kAudioUnitScope_Global, 0, inParameterValue, 0);
   };
 
   // Save the parameter change in the instance, so it can be
   // fetched into Settings, used to initialize any new slave's state
   // This is like StoreSettings but for just one setting
   parameterStorer(GetAudioUnit());
 
   // Propagate the parameter
   for (auto &worker : mSlaves)
      parameterStorer(worker->GetAudioUnit());
}

References AudioUnitWrapper::GetAudioUnit(), and mSlaves.

Referenced by AudioUnitEditor::EventListener().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAudioInCount()

unsigned AudioUnitInstance::GetAudioInCount ( ) const

overrideprivatevirtual

How many input buffers to allocate at once.

If the instance processes channels independently, this can return 1 The result is not necessarily well defined before RealtimeInitialize

Implements EffectInstance.

Definition at line 96 of file AudioUnitInstance.cpp.

{
   return mAudioIns;
}

References AudioUnitWrapper::mAudioIns.

◆ GetAudioOutCount()

unsigned AudioUnitInstance::GetAudioOutCount ( ) const

overrideprivatevirtual

How many output buffers to allocate at once.

The result is not necessarily well defined before RealtimeInitialize

Implements EffectInstance.

Definition at line 101 of file AudioUnitInstance.cpp.

{
   return mAudioOuts;
}

References AudioUnitWrapper::mAudioOuts.

◆ GetBlockSize()

size_t AudioUnitInstance::GetBlockSize ( ) const

overrideprivatevirtual

Implements EffectInstance.

Definition at line 91 of file AudioUnitInstance.cpp.

{
   return mBlockSize;
}

References mBlockSize.

◆ GetLatency()

auto AudioUnitInstance::GetLatency	(	const EffectSettings &	settings,
		double	sampleRate
	)		const

overrideprivatevirtual

Default implementation returns 0

Reimplemented from EffectInstance.

Definition at line 106 of file AudioUnitInstance.cpp.

{
   // Retrieve the latency (can be updated via an event)
   if (mUseLatency) {
      Float64 latency = 0.0;
      if (!GetFixedSizeProperty(kAudioUnitProperty_Latency, latency))
         return latency * sampleRate;
   }
   return 0;
}

References AudioUnitUtils::GetFixedSizeProperty(), and anonymous_namespace{ClipSegmentTest.cpp}::sampleRate.

Here is the call graph for this function:

◆ InitialBlockSize()

size_t AudioUnitInstance::InitialBlockSize ( ) const

private

Definition at line 73 of file AudioUnitInstance.cpp.

{
   // Retrieve the desired number of frames per slice
   UInt32 blockSize{};
   if (GetFixedSizeProperty(
      kAudioUnitProperty_MaximumFramesPerSlice, blockSize))
      // Call failed?  Then supply a default:
      return 512;
   else
      return blockSize;
}

References AudioUnitWrapper::GetFixedSizeProperty().

Here is the call graph for this function:

◆ MakeMessage() [1/2]

auto AudioUnitInstance::MakeMessage ( ) const

overridevirtual

Called on the main thread, in which the result may be cloned.

Default implementation returns a null

Reimplemented from EffectInstance.

Definition at line 285 of file AudioUnitInstance.cpp.

{
   // Like AudioUnitEffect::MakeSettings, except it only allocates map entries
   // containing nullopt
   AudioUnitEffectSettings settings;
   FetchSettings(settings, false);
   return std::make_unique<AudioUnitMessage>(std::move(settings));
}

References AudioUnitWrapper::FetchSettings(), and settings().

Referenced by AudioUnitEditor::EventListener().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeMessage() [2/2]

auto AudioUnitInstance::MakeMessage	(	AudioUnitParameterID	id,
		AudioUnitParameterValue	value
	)		const

Definition at line 294 of file AudioUnitInstance.cpp.

{
   AudioUnitEffectSettings settings;
   settings.values[id].emplace(wxString{}, value);
   return std::make_unique<AudioUnitMessage>(std::move(settings));
}

References id, and settings().

Here is the call graph for this function:

◆ ProcessBlock()

size_t AudioUnitInstance::ProcessBlock	(	EffectSettings &	settings,
		const float const	inBlock,
		float const	outBlock,
		size_t	blockLen
	)

overrideprivatevirtual

Called for destructive effect computation.

Implements EffectInstance.

Definition at line 188 of file AudioUnitInstance.cpp.

{
   // mAudioIns and mAudioOuts don't change after plugin initialization,
   // so ProcessInitialize() made sufficient allocations
   assert(Count(mInputList) >= mAudioIns);
   for (size_t i = 0; i < mAudioIns; ++i)
      mInputList[i] = { 1, static_cast<UInt32>(sizeof(float) * blockLen),
         const_cast<float*>(inBlock[i]) };
 
   // See previous comment
   assert(Count(mOutputList) >= mAudioOuts);
   for (size_t i = 0; i < mAudioOuts; ++i)
      mOutputList[i] = { 1, static_cast<UInt32>(sizeof(float) * blockLen),
         outBlock[i] };
 
   AudioUnitRenderActionFlags flags = 0;
   OSStatus result;
 
   result = AudioUnitRender(mUnit.get(),
                            &flags,
                            &mTimeStamp,
                            0,
                            blockLen,
                            mOutputList.get());
   if (result != noErr) {
      wxLogError("Render failed: %d %4.4s\n",
         static_cast<int>(result), reinterpret_cast<char *>(&result));
      return 0;
   }
 
   mTimeStamp.mSampleTime += blockLen;
   return blockLen;
}

References PackedArray::Count(), AudioUnitWrapper::mAudioIns, AudioUnitWrapper::mAudioOuts, mInputList, mOutputList, mTimeStamp, and AudioUnitWrapper::mUnit.

Here is the call graph for this function:

◆ ProcessFinalize()

bool AudioUnitInstance::ProcessFinalize ( )

overrideprivatevirtualnoexcept

Called at end of destructive processing, for each (mono/stereo) track Default implementation does nothing, returns true This may be called during stack unwinding:

Implements EffectInstance.

Definition at line 181 of file AudioUnitInstance.cpp.

{
   mOutputList.reset();
   mInputList.reset();
   return true;
}

References mInputList, and mOutputList.

◆ ProcessInitialize()

bool AudioUnitInstance::ProcessInitialize	(	EffectSettings &	settings,
		double	sampleRate,
		ChannelNames	chanMap
	)

overrideprivatevirtual

Called at start of destructive processing, for each (mono/stereo) track Default implementation does nothing, returns true

Parameters

chanMap null or array terminated with ChannelNameEOL. Do not retain the pointer

Postcondition: GetAudioInCount() and GetAudioOutCount() are well defined

Implements EffectInstance.

Definition at line 129 of file AudioUnitInstance.cpp.

{
   if (!StoreSettings(mProcessor, GetSettings(settings)))
      return false;
 
   mInputList =
      PackedArray::AllocateCount<AudioBufferList>(mAudioIns)(mAudioIns);
   mOutputList =
      PackedArray::AllocateCount<AudioBufferList>(mAudioOuts)(mAudioOuts);
 
   memset(&mTimeStamp, 0, sizeof(AudioTimeStamp));
   mTimeStamp.mSampleTime = 0; // This is a double-precision number that should
                               // accumulate the number of frames processed so far
   mTimeStamp.mFlags = kAudioTimeStampSampleTimeValid;
 
   mInitialization.reset();
   // Redo this with the correct sample rate, not the arbirary 44100 that the
   // effect used
   auto ins = mAudioIns;
   auto outs = mAudioOuts;
   if (!SetRateAndChannels(sampleRate, mIdentifier))
      return false;
   if (AudioUnitInitialize(mUnit.get())) {
      wxLogError("Couldn't initialize audio unit\n");
      return false;
   }
   if (ins != mAudioIns || outs != mAudioOuts) {
      // A change of channels with changing rate?  This is unexpected!
      ins = mAudioIns;
      outs = mAudioOuts;
      return false;
   }
   mInitialization.reset(mUnit.get());
 
   if (SetProperty(kAudioUnitProperty_SetRenderCallback,
      AudioUnitUtils::RenderCallback{ RenderCallback, this },
      kAudioUnitScope_Input)) {
      wxLogError("Setting input render callback failed.\n");
      return false;
   }
 
   if (AudioUnitReset(mUnit.get(), kAudioUnitScope_Global, 0))
      return false;
 
   if (!BypassEffect(false))
      // Ignore bad return value.  Some (like Xfer OTT) give a bad status.
      ;
 
   return true;
}

References BypassEffect(), AudioUnitWrapper::GetSettings(), AudioUnitWrapper::mAudioIns, AudioUnitWrapper::mAudioOuts, mIdentifier, mInitialization, mInputList, mOutputList, PerTrackEffect::Instance::mProcessor, mTimeStamp, AudioUnitWrapper::mUnit, RenderCallback(), anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, AudioUnitWrapper::SetProperty(), AudioUnitWrapper::SetRateAndChannels(), settings(), and AudioUnitWrapper::StoreSettings().

Referenced by RealtimeInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RealtimeAddProcessor()

bool AudioUnitInstance::RealtimeAddProcessor	(	EffectSettings &	settings,
		EffectOutputs *	pOutputs,
		unsigned	numChannels,
		float	sampleRate
	)

overrideprivatevirtual

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 229 of file AudioUnitInstance.cpp.

{
   if (!mRecruited) {
      // Assign self to the first processor
      mRecruited = true;
      return true;
   }
 
   // Assign another instance with independent state to other processors
   auto &effect = static_cast<const PerTrackEffect&>(mProcessor);
   auto uProcessor = std::make_unique<AudioUnitInstance>(effect,
      mComponent, mParameters, mIdentifier,
      mAudioIns, mAudioOuts, mUseLatency);
   uProcessor->SetBlockSize(mBlockSize);
   if (!uProcessor->ProcessInitialize(settings, sampleRate, nullptr))
      return false;
   mSlaves.push_back(move(uProcessor));
   return true;
}

References AudioUnitWrapper::mAudioIns, AudioUnitWrapper::mAudioOuts, mBlockSize, AudioUnitWrapper::mComponent, mIdentifier, AudioUnitWrapper::mParameters, PerTrackEffect::Instance::mProcessor, mRecruited, mSlaves, mUseLatency, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, and settings().

Here is the call graph for this function:

◆ RealtimeFinalize()

bool AudioUnitInstance::RealtimeFinalize ( EffectSettings & settings )

overrideprivatevirtualnoexcept

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 250 of file AudioUnitInstance.cpp.

{
return GuardedCall<bool>([&]{
   for (auto &pSlave : mSlaves)
      pSlave->ProcessFinalize();
   mSlaves.clear();
   mRecruited = false;
   return ProcessFinalize();
});
}

◆ RealtimeInitialize()

bool AudioUnitInstance::RealtimeInitialize	(	EffectSettings &	settings,
		double	sampleRate
	)

overrideprivatevirtual

Returns: success

Postcondition: GetAudioInCount() and GetAudioOutCount() are well defined

Default implementation does nothing, returns false (so assume realtime is not supported). Other member functions related to realtime return true or zero, but will not be called, unless a derived class overrides RealtimeInitialize.

Reimplemented from EffectInstance.

Definition at line 223 of file AudioUnitInstance.cpp.

{
   return ProcessInitialize(settings, sampleRate, nullptr);
}

References ProcessInitialize(), anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, and settings().

Here is the call graph for this function:

◆ RealtimeProcess()

size_t AudioUnitInstance::RealtimeProcess	(	size_t	group,
		EffectSettings &	settings,
		const float const	inBuf,
		float const	outBuf,
		size_t	numSamples
	)

overrideprivatevirtual

Returns: success Default implementation does nothing, returns 0

Reimplemented from EffectInstance.

Definition at line 339 of file AudioUnitInstance.cpp.

{
   wxASSERT(numSamples <= mBlockSize);
   // Interpret the group number consistently with RealtimeAddProcessor
   if (!mRecruited)
      return 0;
   decltype(this) pSlave{};
   if (group == 0)
      pSlave = this;
   else if (--group < mSlaves.size())
      pSlave = mSlaves[group].get();
   if (pSlave)
      return pSlave->ProcessBlock(settings, inbuf, outbuf, numSamples);
   else
      return 0;
}

References mBlockSize, mRecruited, mSlaves, and settings().

Here is the call graph for this function:

◆ RealtimeProcessEnd()

bool AudioUnitInstance::RealtimeProcessEnd ( EffectSettings & settings )

overrideprivatevirtualnoexcept

settings can be updated to let a dialog change appearance at idle

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 357 of file AudioUnitInstance.cpp.

{
   return true;
}

◆ RealtimeProcessStart()

bool AudioUnitInstance::RealtimeProcessStart ( MessagePackage & package )

overrideprivatevirtual

settings are possibly changed, since last call, by an asynchronous dialog

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 308 of file AudioUnitInstance.cpp.

{
   if (!package.pMessage)
      return true;
   auto &values = static_cast<AudioUnitMessage*>(package.pMessage)
      ->settings.values;
   auto storeSettings = [&](AudioUnitInstance &instance){
      for (auto &[ID, oPair] : values)
         if (oPair.has_value()) {
            auto value = oPair->second;
            if (AudioUnitSetParameter(mUnit.get(), ID,
               kAudioUnitScope_Global, 0, value, 0)) {
               // Probably failed because of an invalid parameter when
               // a plug-in is in a certain mode that doesn't contain
               // the parameter.  Ignore the failure
            }
         }
   };
   storeSettings(*this);
   for (auto &pSlave : mSlaves)
      storeSettings(*pSlave);
 
   // Consume the settings change so we don't repeat setting of parameters
   // until more inter-thread messages arrive
   for (auto &[_, oPair] : values)
      oPair.reset();
 
   return true;
}

References _, mSlaves, AudioUnitWrapper::mUnit, EffectInstance::MessagePackage::pMessage, settings(), and values.

Here is the call graph for this function:

◆ RealtimeResume()

bool AudioUnitInstance::RealtimeResume ( )

overrideprivatevirtual

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 273 of file AudioUnitInstance.cpp.

{
   if (!BypassEffect(false))
      //return false
      ;
   for (auto &pSlave: mSlaves)
      if (!pSlave->BypassEffect(false))
         //return false
         ;
   return true;
}

References BypassEffect(), and mSlaves.

Here is the call graph for this function:

◆ RealtimeSuspend()

bool AudioUnitInstance::RealtimeSuspend ( )

overrideprivatevirtual

Returns: success Default implementation does nothing, returns true

Reimplemented from EffectInstance.

Definition at line 261 of file AudioUnitInstance.cpp.

{
   if (!BypassEffect(true))
      //return false
      ;
   for (auto &pSlave : mSlaves)
      if (!pSlave->BypassEffect(true))
         //return false
         ;
   return true;
}

References BypassEffect(), and mSlaves.

Here is the call graph for this function:

◆ Render()

OSStatus AudioUnitInstance::Render	(	AudioUnitRenderActionFlags *	inActionFlags,
		const AudioTimeStamp *	inTimeStamp,
		UInt32	inBusNumber,
		UInt32	inNumFrames,
		AudioBufferList *	ioData
	)

private

Definition at line 362 of file AudioUnitInstance.cpp.

{
   size_t i = 0;
   auto size = std::min<size_t>(ioData->mNumberBuffers, Count(mInputList));
   for (; i < size; ++i)
      ioData->mBuffers[i].mData = mInputList[i].mData;
   // Some defensive code here just in case SDK requests from us an unexpectedly
   // large number of buffers:
   for (; i < ioData->mNumberBuffers; ++i)
      ioData->mBuffers[i].mData = nullptr;
   return 0;
}

References PackedArray::Count(), for(), mInputList, and size.

Referenced by RenderCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RenderCallback()

OSStatus AudioUnitInstance::RenderCallback	(	void *	inRefCon,
		AudioUnitRenderActionFlags *	inActionFlags,
		const AudioTimeStamp *	inTimeStamp,
		UInt32	inBusNumber,
		UInt32	inNumFrames,
		AudioBufferList *	ioData
	)

staticprivate

Definition at line 379 of file AudioUnitInstance.cpp.

{
   return static_cast<AudioUnitInstance*>(inRefCon)->Render(inActionFlags,
      inTimeStamp, inBusNumber, inNumFrames, ioData);
}

References Render().

Referenced by ProcessInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBlockSize()

size_t AudioUnitInstance::SetBlockSize ( size_t maxBlockSize )

overrideprivatevirtual

Implements EffectInstance.

Definition at line 85 of file AudioUnitInstance.cpp.

{
   // Ignore the argument!  Too-large block sizes won't work
   return mBlockSize;
}

References mBlockSize.

◆ UsesMessages()

bool AudioUnitInstance::UsesMessages ( ) const

overrideprivatevirtualnoexcept

If true, the effect makes no use EffectSettings for inter-thread comminication

Default implementation returns false. In future, all effects should be rewritten to use messages and this function will be removed.

Reimplemented from EffectInstance.

Definition at line 303 of file AudioUnitInstance.cpp.

{
   return true;
}

Member Data Documentation

◆ mBlockSize

const size_t AudioUnitInstance::mBlockSize

private

Definition at line 95 of file AudioUnitInstance.h.

Referenced by GetBlockSize(), RealtimeAddProcessor(), RealtimeProcess(), and SetBlockSize().

◆ mIdentifier

const wxString& AudioUnitInstance::mIdentifier

private

Definition at line 94 of file AudioUnitInstance.h.

Referenced by ProcessInitialize(), and RealtimeAddProcessor().

◆ mInitialization

AudioUnitCleanup<AudioUnit, AudioUnitUninitialize> AudioUnitInstance::mInitialization

private

Definition at line 88 of file AudioUnitInstance.h.

Referenced by ProcessInitialize().

◆ mInputList

PackedArray::Ptr<AudioBufferList> AudioUnitInstance::mInputList

private

Definition at line 90 of file AudioUnitInstance.h.

Referenced by ProcessBlock(), ProcessFinalize(), ProcessInitialize(), and Render().

◆ mOutputList

PackedArray::Ptr<AudioBufferList> AudioUnitInstance::mOutputList

private

Definition at line 91 of file AudioUnitInstance.h.

Referenced by ProcessBlock(), ProcessFinalize(), and ProcessInitialize().

◆ mRecruited

bool AudioUnitInstance::mRecruited { false }

private

Whether the master instance is now allocated to a group number.

Definition at line 85 of file AudioUnitInstance.h.

Referenced by RealtimeAddProcessor(), and RealtimeProcess().

◆ mSlaves

std::vector<std::unique_ptr<AudioUnitInstance> > AudioUnitInstance::mSlaves

private

Definition at line 86 of file AudioUnitInstance.h.

Referenced by EventListener(), RealtimeAddProcessor(), RealtimeProcess(), RealtimeProcessStart(), RealtimeResume(), and RealtimeSuspend().

◆ mTimeStamp

AudioTimeStamp AudioUnitInstance::mTimeStamp {}

private

Definition at line 89 of file AudioUnitInstance.h.

Referenced by ProcessBlock(), and ProcessInitialize().

◆ mUseLatency

const bool AudioUnitInstance::mUseLatency

private

Definition at line 96 of file AudioUnitInstance.h.

Referenced by RealtimeAddProcessor().

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

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AudioUnitInstance()

Member Function Documentation

◆ BypassEffect()

◆ EventListener()

◆ GetAudioInCount()

◆ GetAudioOutCount()

◆ GetBlockSize()

◆ GetLatency()

◆ InitialBlockSize()

◆ MakeMessage() [1/2]

◆ MakeMessage() [2/2]

◆ ProcessBlock()

◆ ProcessFinalize()

◆ ProcessInitialize()

◆ RealtimeAddProcessor()

◆ RealtimeFinalize()

◆ RealtimeInitialize()

◆ RealtimeProcess()

◆ RealtimeProcessEnd()

◆ RealtimeProcessStart()

◆ RealtimeResume()

◆ RealtimeSuspend()

◆ Render()

◆ RenderCallback()

◆ SetBlockSize()

◆ UsesMessages()

Member Data Documentation

◆ mBlockSize

◆ mIdentifier

◆ mInitialization

◆ mInputList

◆ mOutputList

◆ mRecruited

◆ mSlaves

◆ mTimeStamp

◆ mUseLatency