Manages and interacts with an AudioUnit, providing operations on audio effects. More...

#include <AudioUnitWrapper.h>

Inheritance diagram for AudioUnitWrapper:

Collaboration diagram for AudioUnitWrapper:

Classes
class	ParameterInfo
	Encapsulates parameter information for an AudioUnit. More...

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

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

Public Member Functions
	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)

Static Public Member Functions
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
const AudioComponent	mComponent

AudioUnitCleanup< AudioUnit, AudioComponentInstanceDispose >	mUnit

Parameters	mOwnParameters

Parameters &	mParameters

unsigned	mAudioIns { 2 }

unsigned	mAudioOuts { 2 }

Detailed Description

Manages and interacts with an AudioUnit, providing operations on audio effects.

This class hosts the functionality for managing AudioUnit settings, presets, and parameters, allowing manipulation of audio processing units.

Definition at line 90 of file AudioUnitWrapper.h.

Member Typedef Documentation

◆ Parameters

using AudioUnitWrapper::Parameters = PackedArray::Ptr<const AudioUnitParameterID>

Definition at line 92 of file AudioUnitWrapper.h.

◆ ParameterVisitor

using AudioUnitWrapper::ParameterVisitor = std::function< bool(const ParameterInfo &pi, AudioUnitParameterID ID) >

Return value: if true, continue visiting.

Definition at line 142 of file AudioUnitWrapper.h.

Constructor & Destructor Documentation

◆ AudioUnitWrapper()

AudioUnitWrapper::AudioUnitWrapper	(	AudioComponent	component,
		Parameters *	pParameters
	)

inline

Parameters

pParameters if non-null, use those; else, fetch from the AudioUnit

Definition at line 101 of file AudioUnitWrapper.h.

      : mComponent{ component }
      , mParameters{ pParameters ? *pParameters : mOwnParameters }
   {
   }

Member Function Documentation

◆ CreateAudioUnit()

bool AudioUnitWrapper::CreateAudioUnit ( )

Definition at line 265 of file AudioUnitWrapper.cpp.

{
   AudioUnit unit{};
   auto result = AudioComponentInstanceNew(mComponent, &unit);
   if (!result) {
      mUnit.reset(unit);
      if (&mParameters == &mOwnParameters && !mOwnParameters)
         result = GetVariableSizeProperty(
            kAudioUnitProperty_ParameterList, mOwnParameters);
   }
 
   return (!result && unit != nullptr);
}

References GetVariableSizeProperty(), mComponent, mOwnParameters, mParameters, and mUnit.

Referenced by AudioUnitInstance::AudioUnitInstance(), and AudioUnitEffectBase::InitializePlugin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FetchSettings()

bool AudioUnitWrapper::FetchSettings	(	AudioUnitEffectSettings &	settings,
		bool	fetchValues,
		bool	fetchPreset = `false`
	)		const

May allocate memory, so should be called only in the main thread.

Definition at line 149 of file AudioUnitWrapper.cpp.

{
   settings.mPresetNumber = {};
   if (fetchPreset) {
      AUPreset preset{};
      if (!GetFixedSizeProperty(kAudioUnitProperty_PresentPreset, preset))
         // Only want factory preset number, not a user preset (<0)
         if (preset.presetNumber >= 0)
            settings.mPresetNumber = { preset.presetNumber };
   }
 
   // Fetch values from the AudioUnit into AudioUnitEffectSettings,
   // keeping the cache up-to-date␓ after state changes in the AudioUnit
   ForEachParameter(
   [this, &settings, fetchValues]
   (const ParameterInfo &pi, AudioUnitParameterID ID) {
      // Always make a slot, even for parameter IDs that are known but
      // not gettable from the instance now.  Example:  AUGraphicEQ when
      // you choose 10 bands; the values for bands 10 ... 30 are undefined
      // but the parameter IDs are known
      auto &slot = settings.values[ID];
      slot.reset();
      if (fetchValues) {
         AudioUnitParameterValue value;
         if (!pi.mName ||
            AudioUnitGetParameter(
               mUnit.get(), ID, kAudioUnitScope_Global, 0, &value)) {
               // Probably failed because of invalid parameter which can happen
               // if a plug-in is in a certain mode that doesn't contain the
               // parameter.  In any case, just ignore it.
            }
         else
            slot.emplace(settings.Intern(*pi.mName), value);
      }
      return true;
   });
   return true;
}

References ForEachParameter(), GetFixedSizeProperty(), mUnit, MIR::anonymous_namespace{MirUtils.cpp}::pi, preset, and settings().

Referenced by AudioUnitEditor::FetchSettingsFromInstance(), InterpretBlob(), LoadFactoryPreset(), AudioUnitInstance::MakeMessage(), and AudioUnitEffectBase::MakeSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ForEachParameter()

void AudioUnitWrapper::ForEachParameter ( ParameterVisitor visitor ) const

Definition at line 317 of file AudioUnitWrapper.cpp.

{
   if (!mParameters)
      return;
   for (const auto &ID : mParameters)
      if (ParameterInfo pi{ mUnit.get(), ID };
         !visitor(pi, ID))
         break;
}

References mParameters, mUnit, and MIR::anonymous_namespace{MirUtils.cpp}::pi.

Referenced by FetchSettings(), StoreSettings(), and AudioUnitEffectBase::SupportsAutomation().

Here is the caller graph for this function:

◆ GetAudioUnit()

AudioUnit AudioUnitWrapper::GetAudioUnit ( ) const

inline

Definition at line 182 of file AudioUnitWrapper.h.

182{ return mUnit.get(); }

References mUnit.

Referenced by AudioUnitInstance::EventListener(), and AudioUnitEditor::Notify().

Here is the caller graph for this function:

◆ GetComponent()

AudioComponent AudioUnitWrapper::GetComponent ( ) const

inline

Definition at line 183 of file AudioUnitWrapper.h.

183{ return mComponent; }

References mComponent.

◆ GetFixedSizeProperty()

template<typename T >

OSStatus AudioUnitWrapper::GetFixedSizeProperty	(	AudioUnitPropertyID	inID,
		T &	property,
		AudioUnitScope	inScope = `kAudioUnitScope_Global`,
		AudioUnitElement	inElement = `0`
	)		const

inline

Definition at line 109 of file AudioUnitWrapper.h.

   {
      // Supply mUnit.get() to the non-member function
      return AudioUnitUtils::GetFixedSizeProperty(mUnit.get(),
         inID, property, inScope, inElement);
   }

References AudioUnitUtils::GetFixedSizeProperty(), and mUnit.

Referenced by FetchSettings(), AudioUnitEffectBase::GetFactoryPresets(), AudioUnitInstance::InitialBlockSize(), AudioUnitEffectBase::InitializePlugin(), LoadFactoryPreset(), and MakeBlob().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetParameters()

const Parameters & AudioUnitWrapper::GetParameters ( ) const

inline

Definition at line 184 of file AudioUnitWrapper.h.

185 { return mParameters; }

References mParameters.

◆ GetSettings() [1/2]

const AudioUnitEffectSettings & AudioUnitWrapper::GetSettings ( const EffectSettings & settings )

static

Definition at line 36 of file AudioUnitWrapper.cpp.

                                                            {
   return GetSettings(const_cast<EffectSettings &>(settings));
}

References GetSettings(), and settings().

Here is the call graph for this function:

◆ GetSettings() [2/2]

AudioUnitEffectSettings & AudioUnitWrapper::GetSettings ( EffectSettings & settings )

static

Definition at line 27 of file AudioUnitWrapper.cpp.

                                                      {
   auto pSettings = settings.cast<AudioUnitEffectSettings>();
   // Assume the settings object ultimately came from AudioUnitEffect's
   // MakeSettings or copying of that
   assert(pSettings);
   return *pSettings;
}

References settings().

Referenced by AudioUnitEffectBase::ChoosePresetKey(), AudioUnitEffect::ExportPresets(), AudioUnitEditor::FetchSettingsFromInstance(), GetSettings(), AudioUnitEffect::ImportPresets(), LoadFactoryPreset(), LoadPreset(), AudioUnitEffectBase::LoadSettings(), AudioUnitEffectBase::MigrateOldConfigFile(), AudioUnitEditor::OnIdle(), AudioUnitInstance::ProcessInitialize(), AudioUnitEffectBase::SaveSettings(), AudioUnitEffectBase::SaveUserPreset(), and AudioUnitEditor::StoreSettingsToInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetVariableSizeProperty()

template<typename T >

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

inline

Definition at line 120 of file AudioUnitWrapper.h.

   {
      return AudioUnitUtils::GetVariableSizeProperty(mUnit.get(),
         inID, pObject, inScope, inElement);
   }

References AudioUnitUtils::GetVariableSizeProperty(), and mUnit.

Referenced by CreateAudioUnit(), and AudioUnitEffectBase::GetChannelCounts().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InterpretBlob()

TranslatableString AudioUnitWrapper::InterpretBlob	(	AudioUnitEffectSettings &	settings,
		const wxString &	group,
		const wxMemoryBuffer &	buf
	)		const

Interpret the dump made before by MakeBlob.

Parameters

group only for formatting error messages

Returns: an error message

Definition at line 279 of file AudioUnitWrapper.cpp.

{
   size_t bufLen = buf.GetDataLen();
   if (!bufLen)
      return XO("Failed to decode \"%s\" preset").Format(group);
 
   // Create a CFData object that references the decoded preset
   const auto bufPtr = static_cast<const uint8_t *>(buf.GetData());
   CF_ptr<CFDataRef> data{ CFDataCreateWithBytesNoCopy(kCFAllocatorDefault,
      bufPtr, bufLen, kCFAllocatorNull)
   };
   if (!data)
      return XO("Failed to convert \"%s\" preset to internal format")
         .Format(group);
 
   // Convert it back to a property list
   CF_ptr<CFPropertyListRef> content{
      CFPropertyListCreateWithData(kCFAllocatorDefault,
      data.get(), kCFPropertyListImmutable, nullptr,
      // TODO might retrieve more error information
      nullptr)
   };
   if (!content)
      return XO("Failed to create property list for \"%s\" preset")
         .Format(group);
 
   // Finally, update the properties and parameters
   if (SetProperty(kAudioUnitProperty_ClassInfo, content.get()))
      return XO("Failed to set class info for \"%s\" preset").Format(group);
 
   // Repopulate the AudioUnitEffectSettings from the change of state in
   // the AudioUnit, and include the preset
   FetchSettings(settings, true, true);
   return {};
}

References FetchSettings(), SetProperty(), settings(), and XO().

Referenced by AudioUnitEffectBase::Import(), and LoadPreset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadFactoryPreset()

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

Definition at line 351 of file AudioUnitWrapper.cpp.

{
   if (pSettings) {
      // Issue 3441: Some factory presets of some effects do not reassign all
      // controls.  So first put controls into a default state, not contaminated
      // by previous importing or other loading of settings into this wrapper.
      if (!LoadPreset(effect, FactoryDefaultsGroup(), *pSettings))
         return false;
   }
 
   // Retrieve the list of factory presets
   CF_ptr<CFArrayRef> array;
   if (GetFixedSizeProperty(kAudioUnitProperty_FactoryPresets, array) ||
       id < 0 || id >= CFArrayGetCount(array.get()))
      return false;
 
   // Mutate the scratch pad AudioUnit in this wrapper
   if (SetProperty(kAudioUnitProperty_PresentPreset,
      *static_cast<const AUPreset*>(CFArrayGetValueAtIndex(array.get(), id))))
      return false;
 
   if (pSettings) {
      // Repopulate the AudioUnitEffectSettings from the change of state in
      // the AudioUnit
      if (!FetchSettings(GetSettings(*pSettings), true, true))
         return false;
   }
 
   return true;
}

References FactoryDefaultsGroup(), FetchSettings(), GetFixedSizeProperty(), GetSettings(), LoadPreset(), and SetProperty().

Referenced by AudioUnitEffectBase::LoadFactoryPreset(), AudioUnitEffectBase::LoadSettings(), and StoreSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadPreset()

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

Definition at line 327 of file AudioUnitWrapper.cpp.

{
   // Retrieve the preset
   wxString parms;
   if (!GetConfig(effect, PluginSettings::Private, group, PRESET_KEY, parms,
      wxEmptyString)) {
      // Commented "CurrentSettings" gets tried a lot and useless messages appear
      // in the log
      //wxLogError(wxT("Preset key \"%s\" not found in group \"%s\""), PRESET_KEY, group);
      return false;
   }
 
   // Decode it, complementary to what SaveBlobToConfig did
   auto error =
      InterpretBlob(GetSettings(settings), group, wxBase64Decode(parms));
   if (!error.empty()) {
      wxLogError(error.Debug());
      return false;
   }
 
   return true;
}

References PluginSettings::GetConfig(), GetSettings(), InterpretBlob(), PRESET_KEY, PluginSettings::Private, and settings().

Referenced by LoadFactoryPreset(), and AudioUnitEffectBase::LoadPreset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeBlob()

std::pair< CF_ptr< CFDataRef >, TranslatableString > AudioUnitWrapper::MakeBlob	(	const EffectDefinitionInterface &	effect,
		const AudioUnitEffectSettings &	settings,
		const wxCFStringRef &	cfname,
		bool	binary
	)		const

Obtain dump of the setting state of an AudioUnit instance.

Parameters

binary if false, then produce XML serialization instead; but AudioUnits does not need to be told the format again to reinterpret the blob

Returns: smart pointer to data, and an error message

Definition at line 385 of file AudioUnitWrapper.cpp.

{
   // This is a const function of AudioUnitEffect, but it mutates
   // an AudioUnit object (mUnit.get()) to accomplish its work.  But that
   // should be the "scratchpad" unit only, not real instance state.
 
   // Update state of the unit from settings
   StoreSettings(effect, settings);
 
   CF_ptr<CFDataRef> data;
   TranslatableString message;
 
   // Define the preset property and set it in the audio unit
   if (SetProperty(
      kAudioUnitProperty_PresentPreset, AudioUnitUtils::UserPreset{ cfname }))
      message = XO("Failed to set preset name");
 
   // Now retrieve the preset content
   else if (CF_ptr<CFPropertyListRef> content;
      GetFixedSizeProperty(kAudioUnitProperty_ClassInfo, content))
      message = XO("Failed to retrieve preset content");
 
   // And convert it to serialized XML data
   else if (data.reset(CFPropertyListCreateData(kCFAllocatorDefault,
         content.get(),
            (binary ? PRESET_FORMAT : kCFPropertyListXMLFormat_v1_0), 0,
         // TODO might retrieve more error information
         nullptr));
      !data)
      message = XO("Failed to convert property list to XML data");
 
   // Nothing to do if we don't have any data
   else if (auto length = CFDataGetLength(data.get()); length == 0)
      // Caller might not treat this as error, becauase data is non-null
      message = XO("XML data is empty after conversion");
 
   return { move(data), message };
}

References GetFixedSizeProperty(), PRESET_FORMAT, SetProperty(), settings(), StoreSettings(), and XO().

Referenced by AudioUnitEffectBase::Export(), and AudioUnitEffectBase::SavePreset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MoveSettingsContents()

bool AudioUnitWrapper::MoveSettingsContents	(	AudioUnitEffectSettings &&	src,
		AudioUnitEffectSettings &	dst,
		bool	merge
	)

static

Copy, then clear the optionals in src.

Definition at line 240 of file AudioUnitWrapper.cpp.

{
   // Do an in-place rewrite of dst, avoiding allocations
   auto &dstMap = dst.values;
   auto dstIter = dstMap.begin(), dstEnd = dstMap.end();
   auto &srcMap = src.values;
   for (auto &[key, oValue] : srcMap) {
      while (dstIter != dstEnd && dstIter->first != key)
         ++dstIter;
      if (dstIter == dstEnd)
         break;
      auto &[dstKey, dstOValue] = *dstIter;
      assert(dstKey == key);
      if (oValue) {
         dstOValue.emplace(*oValue);
         oValue.reset();
      }
      else if (!merge)
         // Don't accumulate non-nulls only, but copy the nulls
         dstOValue.reset();
   }
   return true;
}

References key, and AudioUnitEffectSettings::values.

Referenced by anonymous_namespace{AudioUnitInstance.cpp}::AudioUnitMessage::Assign(), and anonymous_namespace{AudioUnitInstance.cpp}::AudioUnitMessage::Merge().

Here is the caller graph for this function:

◆ SetProperty()

template<typename T >

OSStatus AudioUnitWrapper::SetProperty	(	AudioUnitPropertyID	inID,
		const T &	property,
		AudioUnitScope	inScope = `kAudioUnitScope_Global`,
		AudioUnitElement	inElement = `0`
	)		const

inline

Definition at line 131 of file AudioUnitWrapper.h.

   {
      // Supply mUnit.get() to the non-member function
      return AudioUnitUtils::SetProperty(mUnit.get(),
         inID, property, inScope, inElement);
   }

References mUnit, and AudioUnitUtils::SetProperty().

Referenced by AudioUnitInstance::BypassEffect(), InterpretBlob(), LoadFactoryPreset(), MakeBlob(), AudioUnitInstance::ProcessInitialize(), and SetRateAndChannels().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetRateAndChannels()

bool AudioUnitWrapper::SetRateAndChannels	(	double	sampleRate,
		const wxString &	identifier
	)

Definition at line 426 of file AudioUnitWrapper.cpp.

{
   AudioUnitUtils::StreamBasicDescription streamFormat{
      // Float64 mSampleRate;
      sampleRate,
 
      // UInt32  mFormatID;
      kAudioFormatLinearPCM,
 
      // UInt32  mFormatFlags;
      (kAudioFormatFlagsNativeFloatPacked |
          kAudioFormatFlagIsNonInterleaved),
 
      // UInt32  mBytesPerPacket;
      sizeof(float),
 
      // UInt32  mFramesPerPacket;
      1,
 
      // UInt32  mBytesPerFrame;
      sizeof(float),
 
      // UInt32  mChannelsPerFrame;
      0,
 
      // UInt32  mBitsPerChannel;
      sizeof(float) * 8,
   };
 
   unsigned one = 1u;
   const struct Info{
      unsigned &nChannels;
      AudioUnitScope scope;
      const char *const msg; // used only in log messages
   } infos[]{
      { one, kAudioUnitScope_Global, "global" },
      { mAudioIns, kAudioUnitScope_Input, "input" },
      { mAudioOuts, kAudioUnitScope_Output, "output" },
   };
   for (const auto &[nChannels, scope, msg] : infos) {
      if (nChannels) {
         if (SetProperty(kAudioUnitProperty_SampleRate, sampleRate, scope)) {
            wxLogError("%ls Didn't accept sample rate on %s\n",
               // Exposing internal name only in logging
               identifier.wx_str(), msg);
            return false;
         }
         if (scope != kAudioUnitScope_Global) {
            bool failed = true;
            ++nChannels;
            do {
               --nChannels;
               streamFormat.mChannelsPerFrame = nChannels;
               failed = SetProperty(kAudioUnitProperty_StreamFormat,
                  streamFormat, scope);
            } while(failed && nChannels > 0);
            if (failed) {
               wxLogError("%ls didn't accept stream format on %s\n",
                  // Exposing internal name only in logging
                  identifier.wx_str(), msg);
               return false;
            }
         }
      }
   }
   return true;
}

References mAudioIns, mAudioOuts, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, anonymous_namespace{wxCommandTargets.cpp}::scope, and SetProperty().

Referenced by AudioUnitEffectBase::InitializePlugin(), and AudioUnitInstance::ProcessInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StoreSettings()

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

Definition at line 189 of file AudioUnitWrapper.cpp.

{
   // This is a const member function inherited by AudioUnitEffect, though it
   // mutates the AudioUnit object (mUnit.get()).  This is necessary for the
   // AudioUnitEffect (an EffectPlugin) to compute the "blob" of settings state
   // for export or to save settings in the config file, which the SDK later
   // reinterprets.
   // So consider mUnit a mutable scratch pad object.  This doesn't really make
   // the AudioUnitEffect stateful.
 
   // First restore factory preset if it applies
   if (settings.mPresetNumber) {
      // Mutate the scratch AudioUnit, don't pass settings
      LoadFactoryPreset(effect, *settings.mPresetNumber, nullptr);
      // Then go on to reapply some slider changes that might have been done
      // after a change of preset
   }
 
   // Update parameter values in the AudioUnit from const
   // AudioUnitEffectSettings
   // Allow two passes; because sometimes the re-assignability of one parameter
   // depends on first doing it for another parameter, but the other is later
   // in the iteration.  For instance, for AUGraphicEQ, parameter ID 10000
   // (decimal) determines 10 or 31 bands, but while the effect is still set
   // for 10, then assignment to the last 21 sliders fails.
   for (auto pass : {0, 1}) {
      ForEachParameter([ this, &settings
      ] (const ParameterInfo &pi, AudioUnitParameterID ID) {
         if (pi.mName) {
            if (auto iter = settings.values.find(ID);
               iter != settings.values.end() && iter->second.has_value()
            ){
               if (AudioUnitSetParameter(mUnit.get(), ID,
                  kAudioUnitScope_Global, 0, iter->second->second, 0)) {
                  // Probably failed because of an invalid parameter when
                  // a plug-in is in a certain mode that doesn't contain
                  // the parameter.
               }
            }
            else {
               // Leave parameters that are in the AudioUnit, but not known in
               // settings, unchanged
            }
         }
         return true;
      });
   }
   return true;
}

References ForEachParameter(), LoadFactoryPreset(), MIR::anonymous_namespace{MirUtils.cpp}::pi, and settings().

Referenced by MakeBlob(), AudioUnitInstance::ProcessInitialize(), and AudioUnitEditor::StoreSettingsToInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mAudioIns

unsigned AudioUnitWrapper::mAudioIns { 2 }

protected

Definition at line 198 of file AudioUnitWrapper.h.

Referenced by AudioUnitInstance::AudioUnitInstance(), AudioUnitInstance::GetAudioInCount(), AudioUnitEffectBase::GetChannelCounts(), AudioUnitEffectBase::GetType(), AudioUnitEffectBase::MakeInstance(), AudioUnitInstance::ProcessBlock(), AudioUnitInstance::ProcessInitialize(), AudioUnitInstance::RealtimeAddProcessor(), and SetRateAndChannels().

◆ mAudioOuts

unsigned AudioUnitWrapper::mAudioOuts { 2 }

protected

Definition at line 199 of file AudioUnitWrapper.h.

Referenced by AudioUnitInstance::AudioUnitInstance(), AudioUnitInstance::GetAudioOutCount(), AudioUnitEffectBase::GetChannelCounts(), AudioUnitEffectBase::GetType(), AudioUnitEffectBase::MakeInstance(), AudioUnitInstance::ProcessBlock(), AudioUnitInstance::ProcessInitialize(), AudioUnitInstance::RealtimeAddProcessor(), and SetRateAndChannels().

◆ mComponent

const AudioComponent AudioUnitWrapper::mComponent

protected

Definition at line 191 of file AudioUnitWrapper.h.

Referenced by CreateAudioUnit(), GetComponent(), AudioUnitEffectBase::GetVersion(), AudioUnitEffectBase::MakeInstance(), and AudioUnitInstance::RealtimeAddProcessor().

◆ mOwnParameters

Parameters AudioUnitWrapper::mOwnParameters

protected

Definition at line 194 of file AudioUnitWrapper.h.

Referenced by CreateAudioUnit().

◆ mParameters

Parameters& AudioUnitWrapper::mParameters

protected

Definition at line 195 of file AudioUnitWrapper.h.

Referenced by CreateAudioUnit(), ForEachParameter(), GetParameters(), AudioUnitEffectBase::InitializePlugin(), AudioUnitEffectBase::MakeInstance(), and AudioUnitInstance::RealtimeAddProcessor().

◆ mUnit

AudioUnitCleanup<AudioUnit, AudioComponentInstanceDispose> AudioUnitWrapper::mUnit

protected

Definition at line 192 of file AudioUnitWrapper.h.

Referenced by AudioUnitInstance::BypassEffect(), CreateAudioUnit(), FetchSettings(), ForEachParameter(), GetAudioUnit(), GetFixedSizeProperty(), GetVariableSizeProperty(), AudioUnitWrapper::ParameterInfo::ParameterInfo(), AudioUnitInstance::ProcessBlock(), AudioUnitInstance::ProcessInitialize(), AudioUnitInstance::RealtimeProcessStart(), and SetProperty().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Parameters

◆ ParameterVisitor

Constructor & Destructor Documentation

◆ AudioUnitWrapper()

Member Function Documentation

◆ CreateAudioUnit()

◆ FetchSettings()

◆ ForEachParameter()

◆ GetAudioUnit()

◆ GetComponent()

◆ GetFixedSizeProperty()

◆ GetParameters()

◆ GetSettings() [1/2]

◆ GetSettings() [2/2]

◆ GetVariableSizeProperty()

◆ InterpretBlob()

◆ LoadFactoryPreset()

◆ LoadPreset()

◆ MakeBlob()

◆ MoveSettingsContents()

◆ SetProperty()

◆ SetRateAndChannels()

◆ StoreSettings()

Member Data Documentation

◆ mAudioIns

◆ mAudioOuts

◆ mComponent

◆ mOwnParameters

◆ mParameters

◆ mUnit