AudioUnitEditor Class Reference

#include <AudioUnitEditor.h>

Inheritance diagram for AudioUnitEditor:

Collaboration diagram for AudioUnitEditor:

Classes
struct	CreateToken

Public Member Functions
	AudioUnitEditor (CreateToken, const EffectUIServices &effect, EffectSettingsAccess &access, AudioUnitInstance &instance, AUControl *pControl, bool isGraphical)
	~AudioUnitEditor () override
bool	UpdateUI () override
	Update appearance of the panel for changes in settings. More...
bool	ValidateUI () override
	Get settings data from the panel; may make error dialogs and return false. More...
bool	IsGraphicalUI () override
Public Member Functions inherited from EffectEditor
	EffectEditor (const EffectUIServices &services, EffectSettingsAccess &access)
virtual	~EffectEditor ()
virtual bool	ValidateUI ()=0
	Get settings data from the panel; may make error dialogs and return false. More...
virtual bool	UpdateUI ()
	Update appearance of the panel for changes in settings. More...
virtual bool	IsGraphicalUI ()
virtual void	Disconnect ()
	On the first call only, may disconnect from further event handling. More...
virtual void	OnClose ()
Public Member Functions inherited from Observer::Publisher< EffectSettingChanged >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Static Public Member Functions
static std::unique_ptr< EffectEditor >	Create (const EffectUIServices &effect, ShuttleGui &S, const wxString &uiType, EffectInstance &instance, EffectSettingsAccess &access)
Static Public Member Functions inherited from EffectEditor
static bool	EnableApply (wxWindow *parent, bool enable=true)
	Enable or disable the Apply button of the dialog that contains parent. More...
static bool	EnablePreview (wxWindow *parent, bool enable=true)

Private Types
using	EventListenerPtr = AudioUnitCleanup< AUEventListenerRef, AUListenerDispose >

Private Member Functions
void	EventListener (const AudioUnitEvent *inEvent, AudioUnitParameterValue inParameterValue)
void	OnIdle (wxIdleEvent &evt)
bool	FetchSettingsFromInstance (EffectSettings &settings)
bool	StoreSettingsToInstance (const EffectSettings &settings)
void	Notify ()
EventListenerPtr	MakeListener ()

Static Private Member Functions
static void	EventListenerCallback (void *inCallbackRefCon, void *inObject, const AudioUnitEvent *inEvent, UInt64 inEventHostTime, AudioUnitParameterValue inParameterValue)

Private Attributes
AudioUnitInstance &	mInstance
const EventListenerPtr	mEventListenerRef
AUControl *const	mpControl {}
std::vector< std::pair< AudioUnitParameterID, AudioUnitParameterValue > >	mToUpdate
const bool	mIsGraphical
std::unordered_map< AudioUnitParameterID, AudioUnitParameterValue >	mParameterValues

Additional Inherited Members
Public Types inherited from Observer::Publisher< EffectSettingChanged >
using	message_type = EffectSettingChanged
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const EffectSettingChanged &) >
	Type of functions that can be connected to the Publisher. More...
Static Public Attributes inherited from EffectEditor
static constexpr int	kPlayID = 20102
Static Public Attributes inherited from Observer::Publisher< EffectSettingChanged >
static constexpr bool	notifies_all
Protected Member Functions inherited from EffectEditor
template<typename EventTag , typename Class , typename Event >
void	BindTo (wxEvtHandler &src, const EventTag &eventType, void(Class::*pmf)(Event &))
Protected Member Functions inherited from Observer::Publisher< EffectSettingChanged >
CallbackReturn	Publish (const EffectSettingChanged &message)
	Send a message to connected callbacks. More...
Protected Attributes inherited from EffectEditor
const EffectUIServices &	mUIServices
EffectSettingsAccess &	mAccess
bool	mUIClosed { false }

Detailed Description

Definition at line 29 of file AudioUnitEditor.h.

Member Typedef Documentation

EventListenerPtr

using AudioUnitEditor::EventListenerPtr = AudioUnitCleanup<AUEventListenerRef, AUListenerDispose>

private

Definition at line 59 of file AudioUnitEditor.h.

Constructor & Destructor Documentation

AudioUnitEditor()

AudioUnitEditor::AudioUnitEditor	(	CreateToken	,
		const EffectUIServices &	effect,
		EffectSettingsAccess &	access,
		AudioUnitInstance &	instance,
		AUControl *	pControl,
		bool	isGraphical
	)

Definition at line 24 of file AudioUnitEditor.cpp.

   : EffectEditor{ effect, access }
   , mInstance{ instance }
   , mEventListenerRef{ MakeListener() }
   , mpControl{ pControl }
   , mIsGraphical{ isGraphical }
{
   // Make the settings of the instance up to date before using it to
   // build a UI
   StoreSettingsToInstance(mAccess.Get());
 
   wxTheApp->Bind(wxEVT_IDLE, &AudioUnitEditor::OnIdle, this);
}

References EffectSettingsAccess::Get(), EffectEditor::mAccess, OnIdle(), and StoreSettingsToInstance().

Here is the call graph for this function:

~AudioUnitEditor()

AudioUnitEditor::~AudioUnitEditor ( )

override

Definition at line 41 of file AudioUnitEditor.cpp.

{
   if (mpControl)
      mpControl->Close();
}

References AUControl::Close(), and mpControl.

Here is the call graph for this function:

Member Function Documentation

Create()

std::unique_ptr< EffectEditor > AudioUnitEditor::Create ( const EffectUIServices &  effect, ShuttleGui &  S, const wxString &  uiType, EffectInstance &  instance, EffectSettingsAccess &  access  )

static

Definition at line 141 of file AudioUnitEditor.cpp.

{
   const auto parent = S.GetParent();
   bool isGraphical = (uiType == FullValue.MSGID().GET());
   // Cast is assumed to succeed because only this effect's own instances
   // are passed back by the framework
   auto &myInstance = dynamic_cast<AudioUnitInstance&>(instance);
 
   AUControl *pControl{};
   wxPanel *container{};
   {
      auto mainSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
      wxASSERT(parent); // To justify safenew
      container = safenew wxPanelWrapper(parent, wxID_ANY);
      mainSizer->Add(container, 1, wxEXPAND);
      parent->SetSizer(mainSizer.release());
   }
 
#if defined(HAVE_AUDIOUNIT_BASIC_SUPPORT)
   if (uiType == BasicValue.MSGID().GET()) {
      if (!CreatePlain(mParent))
         return nullptr;
   }
   else
#endif
   {
      auto uControl = Destroy_ptr<AUControl>(safenew AUControl);
      if (!uControl)
         return nullptr;
      pControl = uControl.get();
 
      if (!pControl->Create(container, myInstance.GetComponent(),
         myInstance.GetAudioUnit(), isGraphical))
         return nullptr;
 
      {
         auto innerSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
 
         innerSizer->Add(uControl.release(), 1, wxEXPAND);
         container->SetSizer(innerSizer.release());
      }
 
      parent->SetMinSize(wxDefaultSize);
 
#ifdef __WXMAC__
#ifdef __WX_EVTLOOP_BUSY_WAITING__
      wxEventLoop::SetBusyWaiting(true);
#endif
#endif
   }
 
   return std::make_unique<AudioUnitEditor>(
      CreateToken{}, effect, access, myInstance, pControl, isGraphical);
}

References BasicValue, FullValue, S, and safenew.

Referenced by AudioUnitEffect::PopulateUI().

Here is the caller graph for this function:

EventListener()

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

private

Definition at line 209 of file AudioUnitEditor.cpp.

{
   // Modify the instance and its workers
   mInstance.EventListener(inEvent, inParameterValue);
 
   if (inEvent->mEventType == kAudioUnitEvent_ParameterValueChange) {
      constexpr AudioUnitParameterValue epsilon = 1e-6;
 
      auto it = mParameterValues.find(inEvent->mArgument.mParameter.mParameterID);
 
      // When the UI is opened - EventListener is called for each parameter
      // with the current value.
      if (it == mParameterValues.end())
         mParameterValues.insert(std::make_pair(inEvent->mArgument.mParameter.mParameterID, inParameterValue));
      else if (std::abs(it->second - inParameterValue) > epsilon)
      {
        it->second = inParameterValue;
        Publish({inEvent->mArgument.mParameter.mParameterID, inParameterValue});
      }
 
      const auto ID = inEvent->mArgument.mParameter.mParameterID;
      mToUpdate.emplace_back(ID, inParameterValue);
      mAccess.Set(mInstance.MakeMessage(ID, inParameterValue));
   }
   else if (inEvent->mEventType == kAudioUnitEvent_PropertyChange &&
      inEvent->mArgument.mProperty.mPropertyID ==
         kAudioUnitProperty_PresentPreset
   ) {
      ValidateUI();
   }
}

References AudioUnitInstance::EventListener(), EffectEditor::mAccess, AudioUnitInstance::MakeMessage(), mInstance, mParameterValues, mToUpdate, Observer::Publisher< EffectSettingChanged >::Publish(), EffectSettingsAccess::Set(), and ValidateUI().

Referenced by EventListenerCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

EventListenerCallback()

void AudioUnitEditor::EventListenerCallback ( void *  inCallbackRefCon, void *  inObject, const AudioUnitEvent *  inEvent, UInt64  inEventHostTime, AudioUnitParameterValue  inParameterValue  )

staticprivate

Definition at line 243 of file AudioUnitEditor.cpp.

{
   static_cast<AudioUnitEditor *>(inCallbackRefCon)
      ->EventListener(inEvent, inParameterValue);
}

References EventListener().

Referenced by MakeListener().

Here is the call graph for this function:

Here is the caller graph for this function:

FetchSettingsFromInstance()

bool AudioUnitEditor::FetchSettingsFromInstance ( EffectSettings &  settings )

private

Definition at line 129 of file AudioUnitEditor.cpp.

{
   return mInstance
      .FetchSettings(AudioUnitInstance::GetSettings(settings), true, true);
}

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

Referenced by ValidateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

IsGraphicalUI()

bool AudioUnitEditor::IsGraphicalUI ( )

overridevirtual

Default implementation returns false

Returns

true if using a native plug-in UI, not widgets

Reimplemented from EffectEditor.

Definition at line 124 of file AudioUnitEditor.cpp.

{
   return mIsGraphical;
}

References mIsGraphical.

MakeListener()

auto AudioUnitEditor::MakeListener ( )

private

Definition at line 47 of file AudioUnitEditor.cpp.

{
   const auto unit = mInstance.GetAudioUnit();
   EventListenerPtr result;
 
   // Register a callback with the audio unit
   AUEventListenerRef eventListenerRef{};
   if (AUEventListenerCreate(AudioUnitEditor::EventListenerCallback,
      this,
      static_cast<CFRunLoopRef>( const_cast<void*>(
         GetCFRunLoopFromEventLoop(GetCurrentEventLoop()))),
      kCFRunLoopDefaultMode, 0.0, 0.0, &eventListenerRef))
      return nullptr;
   result.reset(eventListenerRef);
 
   // AudioUnitEvent is a struct with a discriminator field and a union
   AudioUnitEvent event{ kAudioUnitEvent_ParameterValueChange };
   // Initialize union member -- the ID (second field) reassigned later
   auto &parameter = event.mArgument.mParameter;
   parameter = AudioUnitUtils::Parameter{ unit, kAudioUnitScope_Global };
 
   // Register each parameter as something we're interested in
   if (auto &parameters = mInstance.GetParameters())
      for (const auto &ID : parameters) {
         parameter.mParameterID = ID;
         if (AUEventListenerAddEventType(result.get(), this, &event))
            return nullptr;
      }
 
   // Now set up the other union member
   event = { kAudioUnitEvent_PropertyChange };
   // And bind the listener function to certain property changes
   for (auto type : {
      kAudioUnitProperty_Latency,
      kAudioUnitProperty_PresentPreset,
   }) {
      event.mArgument.mProperty = AudioUnitUtils::Property{
         unit, type, kAudioUnitScope_Global };
      if (AUEventListenerAddEventType(result.get(), this, &event))
         return nullptr;
   }
 
   return result;
}

References EventListenerCallback().

Here is the call graph for this function:

Notify()

void AudioUnitEditor::Notify ( )

private

Definition at line 199 of file AudioUnitEditor.cpp.

{
   AudioUnitParameter aup = {};
   aup.mAudioUnit = mInstance.GetAudioUnit();
   aup.mParameterID = kAUParameterListener_AnyParameter;
   aup.mScope = kAudioUnitScope_Global;
   aup.mElement = 0;
   AUParameterListenerNotify(NULL, NULL, &aup);
}

References AudioUnitWrapper::GetAudioUnit(), and mInstance.

Referenced by UpdateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

OnIdle()

void AudioUnitEditor::OnIdle ( wxIdleEvent &  evt )

private

Definition at line 251 of file AudioUnitEditor.cpp.

{
   evt.Skip();
   if (mToUpdate.size()) {
      mAccess.ModifySettings([&](EffectSettings &settings){
         // Reassign settings, so that there is "stickiness" when dialog is
         // closed and opened again
         auto &mySettings = AudioUnitInstance::GetSettings(settings);
         for (auto [ID, value] : mToUpdate)
            if (auto &pair = mySettings.values[ID]; pair.has_value())
               pair->second = value;
         return nullptr;
      });
      mToUpdate.clear();
   }
}

References AudioUnitWrapper::GetSettings(), EffectEditor::mAccess, EffectSettingsAccess::ModifySettings(), mToUpdate, and settings().

Referenced by AudioUnitEditor().

Here is the call graph for this function:

Here is the caller graph for this function:

StoreSettingsToInstance()

bool AudioUnitEditor::StoreSettingsToInstance ( const EffectSettings &  settings )

private

Definition at line 135 of file AudioUnitEditor.cpp.

{
   return mInstance.StoreSettings(mInstance.mProcessor,
      AudioUnitInstance::GetSettings(settings));
}

References AudioUnitWrapper::GetSettings(), mInstance, PerTrackEffect::Instance::mProcessor, settings(), and AudioUnitWrapper::StoreSettings().

Referenced by AudioUnitEditor(), and UpdateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateUI()

bool AudioUnitEditor::UpdateUI ( )

overridevirtual

Update appearance of the panel for changes in settings.

Default implementation does nothing, returns true

Returns

true if successful

Reimplemented from EffectEditor.

Definition at line 93 of file AudioUnitEditor.cpp.

{
   // Update parameter values in AudioUnit, and propagate to any listeners
   if (StoreSettingsToInstance(mAccess.Get())) {
      // See AUView::viewWillDraw
      if (mpControl)
         mpControl->ForceRedraw();
   
      // This will be the AudioUnit of a stateful instance, not of the effect
      Notify();
 
      return true;
   }
   return false;
}

References AUControl::ForceRedraw(), EffectSettingsAccess::Get(), EffectEditor::mAccess, mpControl, Notify(), and StoreSettingsToInstance().

Here is the call graph for this function:

ValidateUI()

bool AudioUnitEditor::ValidateUI ( )

overridevirtual

Get settings data from the panel; may make error dialogs and return false.

Returns

true only if panel settings are acceptable

Implements EffectEditor.

Definition at line 109 of file AudioUnitEditor.cpp.

{
   mAccess.ModifySettings([this](EffectSettings &settings){
#if 0
      // This analogy with other generators doesn't seem to fit AudioUnits
      // How can we define the control mDuration?
      if (GetType() == EffectTypeGenerate)
         settings.extra.SetDuration(mDuration->GetValue());
#endif
      FetchSettingsFromInstance(settings);
      return nullptr;
   });
   return true;
}

References EffectTypeGenerate, FetchSettingsFromInstance(), EffectEditor::mAccess, EffectSettingsAccess::ModifySettings(), and settings().

Referenced by EventListener().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mEventListenerRef

const EventListenerPtr AudioUnitEditor::mEventListenerRef

private

Definition at line 67 of file AudioUnitEditor.h.

mInstance

AudioUnitInstance& AudioUnitEditor::mInstance

private

Definition at line 66 of file AudioUnitEditor.h.

Referenced by EventListener(), FetchSettingsFromInstance(), Notify(), and StoreSettingsToInstance().

mIsGraphical

const bool AudioUnitEditor::mIsGraphical

private

Definition at line 71 of file AudioUnitEditor.h.

Referenced by IsGraphicalUI().

mParameterValues

std::unordered_map<AudioUnitParameterID, AudioUnitParameterValue> AudioUnitEditor::mParameterValues

private

Definition at line 75 of file AudioUnitEditor.h.

Referenced by EventListener().

mpControl

AUControl* const AudioUnitEditor::mpControl {}

private

Definition at line 68 of file AudioUnitEditor.h.

Referenced by UpdateUI(), and ~AudioUnitEditor().

mToUpdate

std::vector< std::pair<AudioUnitParameterID, AudioUnitParameterValue> > AudioUnitEditor::mToUpdate

private

Definition at line 70 of file AudioUnitEditor.h.

Referenced by EventListener(), and OnIdle().

---

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

• AudioUnitEditor.h
• AudioUnitEditor.cpp