#include <EffectUI.h>

Inheritance diagram for EffectUIHost:

Collaboration diagram for EffectUIHost:

Public Member Functions
	EffectUIHost (wxWindow *parent, AudacityProject &project, EffectPlugin &effect, EffectUIClientInterface &client, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, const std::shared_ptr< RealtimeEffectState > &pPriorState={})

virtual	~EffectUIHost ()

bool	TransferDataToWindow () override

bool	TransferDataFromWindow () override

int	ShowModal () override

bool	Initialize ()

EffectUIValidator *	GetValidator () const

bool	HandleCommandKeystrokes () override

void	SetClosed ()

Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()

	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))

bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))

void	SetTitle (const TranslatableString &title)

void	SetLabel (const TranslatableString &title)

void	SetName (const TranslatableString &title)

void	SetName ()

Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)

	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete

	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete

wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete

wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Public Member Functions inherited from TopLevelKeystrokeHandlingWindow
virtual	~TopLevelKeystrokeHandlingWindow ()

virtual bool	HandleCommandKeystrokes ()

Private Member Functions
std::shared_ptr< EffectInstance >	InitializeInstance ()

wxPanel *	BuildButtonBar (wxWindow *parent, bool graphicalUI)

void	BuildButtonBar (ShuttleGui &S, bool graphicalUI)

void	OnInitDialog (wxInitDialogEvent &evt)

void	OnErase (wxEraseEvent &evt)

void	OnPaint (wxPaintEvent &evt)

void	OnClose (wxCloseEvent &evt)

void	OnApply (wxCommandEvent &evt)

void	DoCancel ()

void	OnCancel (wxCommandEvent &evt)

void	OnDebug (wxCommandEvent &evt)

void	OnMenu (wxCommandEvent &evt)

void	OnEnable (wxCommandEvent &evt)

void	OnPlay (wxCommandEvent &evt)

void	OnPlayback (AudioIOEvent)

void	OnCapture (AudioIOEvent)

void	OnUserPreset (wxCommandEvent &evt)

void	OnFactoryPreset (wxCommandEvent &evt)

void	OnDeletePreset (wxCommandEvent &evt)

void	OnSaveAs (wxCommandEvent &evt)

void	OnImport (wxCommandEvent &evt)

void	OnExport (wxCommandEvent &evt)

void	OnOptions (wxCommandEvent &evt)

void	OnDefaults (wxCommandEvent &evt)

void	OnIdle (wxIdleEvent &evt)

void	OnCharHook (wxKeyEvent &evt)

bool	IsOpenedFromEffectPanel () const

void	UpdateControls ()

wxBitmap	CreateBitmap (const char *const xpm[], bool up, bool pusher)

void	LoadUserPresets ()

void	CleanupRealtime ()

void	StopPlayback ()

Private Attributes
Observer::Subscription	mAudioIOSubscription

Observer::Subscription	mEffectStateSubscription

AudacityProject &	mProject

wxWindow *const	mParent

EffectPlugin &	mEffectUIHost

EffectUIClientInterface &	mClient

const EffectPlugin::EffectSettingsAccessPtr	mpGivenAccess

EffectPlugin::EffectSettingsAccessPtr	mpAccess

EffectPlugin::EffectSettingsAccessPtr	mpAccess2

std::weak_ptr< RealtimeEffectState >	mwState {}

std::shared_ptr< RealtimeEffectState >	mpTempProjectState {}

RegistryPaths	mUserPresets

bool	mInitialized { false }

const bool	mSupportsRealtime

bool	mIsGUI {}

bool	mIsBatch {}

wxButton *	mApplyBtn {}

wxButton *	mMenuBtn {}

wxButton *	mEnableBtn {}

wxButton *	mDebugBtn {}

wxButton *	mPlayToggleBtn {}

wxBitmap	mRealtimeEnabledBM

wxBitmap	mRealtimeDisabledBM

bool	mEnabled { true }

bool	mDisableTransport { true }

bool	mPlaying {}

bool	mCapturing {}

SelectedRegion	mRegion

double	mPlayPos { 0.0 }

bool	mDismissed {}

const bool	mHadPriorState

const std::shared_ptr< EffectInstance >	mpInstance

const EffectOutputs *const	mpOutputs

std::unique_ptr< EffectUIValidator >	mpValidator

Detailed Description

Definition at line 42 of file EffectUI.h.

Constructor & Destructor Documentation

◆ EffectUIHost()

EffectUIHost::EffectUIHost	(	wxWindow *	parent,
		AudacityProject &	project,
		EffectPlugin &	effect,
		EffectUIClientInterface &	client,
		std::shared_ptr< EffectInstance > &	pInstance,
		EffectSettingsAccess &	access,
		const std::shared_ptr< RealtimeEffectState > &	pPriorState = `{}`
	)

Definition at line 227 of file EffectUI.cpp.

:  wxDialogWrapper(parent, wxID_ANY, effect.GetDefinition().GetName(),
                   wxDefaultPosition, wxDefaultSize,
                   wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxMINIMIZE_BOX | wxMAXIMIZE_BOX)
, mEffectUIHost{ effect }
, mClient{ client }
// Grab a pointer to the access object,
// extending its lifetime while this remains:
, mpGivenAccess{ access.shared_from_this() }
, mpAccess{ mpGivenAccess }
, mwState{ pPriorState }
, mProject{ project }
, mParent{ parent }
, mSupportsRealtime{ mEffectUIHost.GetDefinition().SupportsRealtime() }
, mHadPriorState{ (pPriorState != nullptr) }
, mpInstance{ InitializeInstance() }
, mpOutputs{ pPriorState ? pPriorState->GetOutputs() : nullptr }
{
   // Assign the out parameter
   pInstance = mpInstance;
#if defined(__WXMAC__)
   // Make sure the effect window actually floats above the main window
   [ [((NSView *)GetHandle()) window] setLevel:NSFloatingWindowLevel];
#endif
   
   SetName( effect.GetDefinition().GetName() );
 
   // This style causes Validate() and TransferDataFromWindow() to visit
   // sub-windows recursively, applying any wxValidators
   SetExtraStyle(GetExtraStyle() | wxWS_EX_VALIDATE_RECURSIVELY);
}

References EffectPlugin::GetDefinition(), ComponentInterface::GetName(), mpInstance, and wxDialogWrapper::SetName().

Here is the call graph for this function:

◆ ~EffectUIHost()

EffectUIHost::~EffectUIHost ( )

virtual

Definition at line 263 of file EffectUI.cpp.

{
   if (mpValidator)
      mpValidator->Disconnect();
   DestroyChildren();
   wxASSERT(mClosed);
}

References mpValidator.

Member Function Documentation

◆ BuildButtonBar() [1/2]

void EffectUIHost::BuildButtonBar	(	ShuttleGui &	S,
		bool	graphicalUI
	)

private

Definition at line 340 of file EffectUI.cpp.

{
   mIsGUI = graphicalUI;
   mIsBatch = mEffectUIHost.IsBatchProcessing();
 
   constexpr int margin = 3;
 
   S.StartPanel();
   {
      S.SetBorder( margin );
 
      S.StartHorizontalLay(wxEXPAND, 0);
      {
         if (IsOpenedFromEffectPanel())
         {
            mEnableBtn = S.Id(kEnableID)
               .Position(wxALIGN_CENTER | wxTOP | wxBOTTOM)
               .Name(XO("Enable"))
               .AddBitmapButton(mEnabled ? mRealtimeEnabledBM : mRealtimeDisabledBM);
         }
 
         mMenuBtn = S.Id( kMenuID )
            .ToolTip(XO("Manage presets and options"))
            .AddButton( XO("Presets && settings"), wxALIGN_CENTER | wxTOP | wxBOTTOM );
 
         S.AddSpace(1, 0, 1);
 
         if (!mIsBatch)
         {
            if (mSupportsRealtime)
            {
               if (mpTempProjectState)
               {
                  mPlayToggleBtn = S.Id(kPlayID)
                     .ToolTip(XO("Start and stop preview"))
                     .AddButton( { },
                                 wxALIGN_CENTER | wxTOP | wxBOTTOM );
               }
            }
            else if (
               (mEffectUIHost.GetDefinition().GetType() != EffectTypeAnalyze) &&
               (mEffectUIHost.GetDefinition().GetType() != EffectTypeTool) )
            {
               mPlayToggleBtn = S.Id(kPlayID)
                  .ToolTip(XO("Preview effect"))
                  .AddButton( { },
                              wxALIGN_CENTER | wxTOP | wxBOTTOM );
            }
            if(mPlayToggleBtn != nullptr)
            {
               //wxButton does not implement GetSizeFromText
               //set button minimum size so that largest text fits
               mPlayToggleBtn->SetLabel(_("Stop &Preview"));
               auto a = mPlayToggleBtn->GetBestSize();
               mPlayToggleBtn->SetLabel(_("&Preview"));
               auto b = mPlayToggleBtn->GetBestSize();
               mPlayToggleBtn->SetMinSize(a.x > b.x ? a : b);
            }
         }
 
         if (!IsOpenedFromEffectPanel())
         {
            mApplyBtn = S.Id(wxID_APPLY)
               .AddButton( XXO("&Apply"),
                           wxALIGN_CENTER | wxTOP | wxBOTTOM );
            mApplyBtn->SetDefault();
         }
 
         if (mEffectUIHost.GetDefinition().EnablesDebug())
         {
            mDebugBtn = S.Id(eDebugID)
               .AddButton( XXO("Debu&g"),
                           wxALIGN_CENTER | wxTOP | wxBOTTOM );
         }
      }
      S.EndHorizontalLay();
   }
   S.EndPanel();
}

References _, eDebugID, EffectTypeAnalyze, EffectTypeTool, EffectDefinitionInterface::EnablesDebug(), EffectPlugin::GetDefinition(), EffectDefinitionInterface::GetType(), EffectPlugin::IsBatchProcessing(), IsOpenedFromEffectPanel(), kEnableID, kMenuID, kPlayID, mApplyBtn, mDebugBtn, mEffectUIHost, mEnableBtn, mEnabled, mIsBatch, mIsGUI, mMenuBtn, mPlayToggleBtn, mpTempProjectState, mRealtimeDisabledBM, mRealtimeEnabledBM, mSupportsRealtime, S, XO(), and XXO().

Here is the call graph for this function:

◆ BuildButtonBar() [2/2]

wxPanel * EffectUIHost::BuildButtonBar	(	wxWindow *	parent,
		bool	graphicalUI
	)

private

Referenced by Initialize().

Here is the caller graph for this function:

◆ CleanupRealtime()

void EffectUIHost::CleanupRealtime ( )

private

Definition at line 1170 of file EffectUI.cpp.

{
   mAudioIOSubscription.Reset();
 
   if (mSupportsRealtime && mInitialized) {
      if (!IsOpenedFromEffectPanel()) {
         AudioIO::Get()->RemoveState(mProject, nullptr, mpTempProjectState);
         mEffectStateSubscription.Reset();
         mpTempProjectState.reset();
      /*
         ProjectHistory::Get(mProject).PushState(
            XO("Removed %s effect").Format(mpState->GetEffect()->GetName()),
            XO("Removed Effect"),
            UndoPush::NONE
         );
       */
      }
      mInitialized = false;
   }
}

References AudioIO::Get(), IsOpenedFromEffectPanel(), mAudioIOSubscription, mEffectStateSubscription, mInitialized, mProject, mpTempProjectState, mSupportsRealtime, AudioIO::RemoveState(), and Observer::Subscription::Reset().

Referenced by OnClose().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateBitmap()

wxBitmap EffectUIHost::CreateBitmap	(	const char *const	xpm[],
		bool	up,
		bool	pusher
	)

private

Definition at line 1025 of file EffectUI.cpp.

{
   wxMemoryDC dc;
   wxBitmap pic(xpm);
   
   wxBitmap mod(pic.GetWidth() + 6, pic.GetHeight() + 6, 24);
   dc.SelectObject(mod);
   
#if defined(__WXGTK__)
   wxColour newColour = wxSystemSettings::GetColour(wxSYS_COLOUR_BACKGROUND);
#else
   wxColour newColour = wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE);
#endif
   
   dc.SetBackground(wxBrush(newColour));
   dc.Clear();
   
   int offset = 3;
   if (pusher)
   {
      if (!up)
      {
         offset += 1;
      }
   }
   
   dc.DrawBitmap(pic, offset, offset, true);
   
   dc.SelectObject(wxNullBitmap);
   
   return mod;
}

◆ DoCancel()

void EffectUIHost::DoCancel ( )

private

Definition at line 605 of file EffectUI.cpp.

{
   if (!mDismissed) {
      if (!mHadPriorState) {
         // For the destructive effect dialog only
         // Restore effect state from last updated preferences
         mpAccess->ModifySettings([&](EffectSettings &settings) {
            // ignore failure
            return mEffectUIHost.GetDefinition().LoadUserPreset(
               CurrentSettingsGroup(), settings).value_or(nullptr);
         });
      }
      if (IsModal())
         EndModal(0);
      else
         Hide();
      
      mDismissed = true;
   }
}

References CurrentSettingsGroup(), EffectPlugin::GetDefinition(), mDismissed, mEffectUIHost, mHadPriorState, mpAccess, and settings().

Referenced by OnCancel(), and OnClose().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetValidator()

EffectUIValidator * EffectUIHost::GetValidator ( ) const

inline

Definition at line 65 of file EffectUI.h.

65{ return mpValidator.get(); }

References mpValidator.

◆ HandleCommandKeystrokes()

bool EffectUIHost::HandleCommandKeystrokes ( )

overridevirtual

By default returns true, meaning that keystrokes should be handled by associated CommandManager.

Reimplemented from TopLevelKeystrokeHandlingWindow.

Definition at line 480 of file EffectUI.cpp.

{
   return !IsModal();
}

◆ Initialize()

bool EffectUIHost::Initialize ( )

Definition at line 420 of file EffectUI.cpp.

{
   mEnabled = mpAccess->Get().extra.GetActive();
 
   mRealtimeEnabledBM = theTheme.Bitmap(bmpEffectOn);
   mRealtimeDisabledBM = theTheme.Bitmap(bmpEffectOff);
 
   // Build a "host" dialog, framing a panel that the client fills in.
   // The frame includes buttons to preview, apply, load and save presets, etc.
   EffectPanel *w {};
   ShuttleGui S{ this, eIsCreating };
   {
      // Make the panel for the client
      Destroy_ptr<EffectPanel> uw{ safenew EffectPanel( S.GetParent() ) };
      RTL_WORKAROUND(uw.get());
 
      // Try to give the window a sensible default/minimum size
      uw->SetMinSize(wxSize(wxMax(600, mParent->GetSize().GetWidth() * 2 / 3),
         mParent->GetSize().GetHeight() / 2));
 
      // Let the client add things to the panel
      ShuttleGui S1{ uw.get(), eIsCreating };
      mpValidator = mClient.PopulateUI(S1, *mpInstance, *mpAccess, mpOutputs);
      if (!mpValidator)
         return false;
 
      BuildButtonBar(S, mpValidator->IsGraphicalUI());
 
      S.StartHorizontalLay( wxEXPAND );
      {
         S.Prop( 1 )
            .Position(wxEXPAND)
            .AddWindow((w = uw.release()));
      }
      S.EndHorizontalLay();
   }
 
   Layout();
   Fit();
   Center();
 
   UpdateControls();
 
   w->SetAccept(!mIsGUI);
 
   if (!mIsGUI)
   {
      w->SetFocus();
   }
   else if (!IsOpenedFromEffectPanel())
   {
      mApplyBtn->SetFocus();
   }
 
   LoadUserPresets();
 
   SetMinSize(GetSize());
   return true;
}

References ThemeBase::Bitmap(), BuildButtonBar(), eIsCreating, IsOpenedFromEffectPanel(), LoadUserPresets(), mApplyBtn, mClient, mEnabled, mIsGUI, mpAccess, mParent, mpInstance, mpOutputs, mpValidator, mRealtimeDisabledBM, mRealtimeEnabledBM, EffectUIClientInterface::PopulateUI(), RTL_WORKAROUND, S, safenew, theTheme, and UpdateControls().

Here is the call graph for this function:

◆ InitializeInstance()

std::shared_ptr< EffectInstance > EffectUIHost::InitializeInstance ( )

private

Definition at line 1106 of file EffectUI.cpp.

{
   // We are still constructing and the return initializes a const member
   std::shared_ptr<EffectInstance> result;
 
   auto mpState = mwState.lock();
 
   bool priorState = (mpState != nullptr);
   if (!priorState) {
      auto gAudioIO = AudioIO::Get();
      mDisableTransport = !gAudioIO->IsAvailable(mProject);
      mPlaying = gAudioIO->IsStreamActive(); // not exactly right, but will suffice
      mCapturing = gAudioIO->IsStreamActive() && gAudioIO->GetNumCaptureChannels() > 0 && !gAudioIO->IsMonitoring();
   }
 
   if (mSupportsRealtime && !mInitialized) {
      if (!priorState)
         mwState = mpState = mpTempProjectState =
            AudioIO::Get()->AddState(mProject, nullptr, GetID(mEffectUIHost));
      if (mpState) {
         // Find the right instance to connect to the dialog
         if (!result)
            result = mpState->GetInstance();
 
         mpAccess2 = mpState->GetAccess();
         if (!(mpAccess2->IsSameAs(*mpAccess)))
            // Decorate the given access object
            mpAccess = std::make_shared<EffectSettingsAccessTee>(
               *mpAccess, mpAccess2);
 
         mEffectStateSubscription = mpState->Subscribe([this](RealtimeEffectStateChange state) {
            mEnabled = (state == RealtimeEffectStateChange::EffectOn);
            mEnableBtn->SetBitmapLabel(mEnabled ? mRealtimeEnabledBM : mRealtimeDisabledBM);
 
            UpdateControls();
         });
      }
 
      if (!priorState) {
         mAudioIOSubscription = AudioIO::Get()->Subscribe([this](AudioIOEvent event){
            switch (event.type) {
            case AudioIOEvent::PLAYBACK:
               OnPlayback(event); break;
            case AudioIOEvent::CAPTURE:
               OnCapture(event); break;
            default:
               break;
            }
         });
      }
      
      mInitialized = true;
   }
   else {
      result = mEffectUIHost.MakeInstance();
      if (auto pInstanceEx =
         std::dynamic_pointer_cast<EffectInstanceEx>(result)
         ; pInstanceEx && !pInstanceEx->Init())
         result.reset();
   }
 
   return result;
}

References AudioIO::AddState(), EffectOn, AudioIO::Get(), GetID(), EffectInstanceFactory::MakeInstance(), mAudioIOSubscription, mCapturing, mDisableTransport, mEffectStateSubscription, mEffectUIHost, mEnableBtn, mEnabled, mInitialized, mpAccess, mpAccess2, mPlaying, mProject, mpTempProjectState, mRealtimeDisabledBM, mRealtimeEnabledBM, mSupportsRealtime, mwState, Observer::Publisher< Message, NotifyAll >::Subscribe(), AudioIOEvent::type, and UpdateControls().

Here is the call graph for this function:

◆ IsOpenedFromEffectPanel()

bool EffectUIHost::IsOpenedFromEffectPanel ( ) const

private

Definition at line 1020 of file EffectUI.cpp.

{
   return (mpTempProjectState == nullptr && mSupportsRealtime);
}

References mpTempProjectState, and mSupportsRealtime.

Referenced by BuildButtonBar(), CleanupRealtime(), Initialize(), OnCharHook(), and UpdateControls().

Here is the caller graph for this function:

◆ LoadUserPresets()

void EffectUIHost::LoadUserPresets ( )

private

Definition at line 1094 of file EffectUI.cpp.

{
   mUserPresets.clear();
   
   GetConfigSubgroups(mEffectUIHost.GetDefinition(),
      PluginSettings::Private, UserPresetsGroup(wxEmptyString), mUserPresets);
   
   std::sort( mUserPresets.begin(), mUserPresets.end() );
   
   return;
}

References PluginSettings::GetConfigSubgroups(), EffectPlugin::GetDefinition(), mEffectUIHost, mUserPresets, PluginSettings::Private, and UserPresetsGroup().

Referenced by Initialize(), OnDeletePreset(), OnImport(), OnMenu(), and OnSaveAs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnApply()

void EffectUIHost::OnApply ( wxCommandEvent & evt )

private

Definition at line 540 of file EffectUI.cpp.

{
   auto &project = mProject;
 
   // On wxGTK (wx2.8.12), the default action is still executed even if
   // the button is disabled.  This appears to affect all wxDialogs, not
   // just our Effects dialogs.  So, this is a only temporary workaround
   // for legacy effects that disable the OK button.  Hopefully this has
   // been corrected in wx3.
   if (!mApplyBtn->IsEnabled())
   {
      return;
   }
 
   if (mPlaying)
      StopPlayback();
   
   // Honor the "select all if none" preference...a little hackish, but whatcha gonna do...
   if (!mIsBatch &&
       mEffectUIHost.GetDefinition().GetType() != EffectTypeGenerate &&
       mEffectUIHost.GetDefinition().GetType() != EffectTypeTool &&
       ViewInfo::Get( project ).selectedRegion.isPoint())
   {
      auto flags = AlwaysEnabledFlag;
      bool allowed =
      MenuManager::Get( project ).ReportIfActionNotAllowed(
         mEffectUIHost.GetDefinition().GetName(),
         flags,
         WaveTracksSelectedFlag() | TimeSelectedFlag());
      if (!allowed)
         return;
   }
   
   if (!TransferDataFromWindow() ||
       // This is the main place where there is a side-effect on the config
       // file to remember the last-used settings of an effect, just before
       // applying the effect destructively.
       !mEffectUIHost.GetDefinition()
         .SaveUserPreset(CurrentSettingsGroup(), mpAccess->Get()))
      return;
 
   if (IsModal())
   {
      mDismissed = true;
      
      EndModal(evt.GetId());
      
      Close();
      
      return;
   }
   
   // Progress dialog no longer yields, so this "shouldn't" be necessary (yet to be proven
   // for sure), but it is a nice visual cue that something is going on.
   mApplyBtn->Disable();
   auto cleanup = finally( [&] { mApplyBtn->Enable(); } );
 
   CommandContext context( project );
   // This is absolute hackage...but easy and I can't think of another way just now.
   //
   // It should callback to the EffectManager to kick off the processing
   EffectUI::DoEffect(GetID(mEffectUIHost), context,
      EffectManager::kConfigured);
}

References AlwaysEnabledFlag, CurrentSettingsGroup(), EffectUI::DoEffect(), EffectTypeGenerate, EffectTypeTool, ViewInfo::Get(), MenuManager::Get(), EffectPlugin::GetDefinition(), GetID(), ComponentInterface::GetName(), EffectDefinitionInterface::GetType(), NotifyingSelectedRegion::isPoint(), EffectManager::kConfigured, mApplyBtn, mDismissed, mEffectUIHost, mIsBatch, mpAccess, mPlaying, mProject, MenuManager::ReportIfActionNotAllowed(), EffectSettingsManager::SaveUserPreset(), ViewInfo::selectedRegion, StopPlayback(), TimeSelectedFlag(), TransferDataFromWindow(), and WaveTracksSelectedFlag().

Referenced by OnDebug().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnCancel()

void EffectUIHost::OnCancel ( wxCommandEvent & evt )

private

Definition at line 626 of file EffectUI.cpp.

{
   DoCancel();
   Close();
}

References DoCancel().

Referenced by OnCharHook().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnCapture()

void EffectUIHost::OnCapture ( AudioIOEvent evt )

private

Definition at line 817 of file EffectUI.cpp.

{
   if (evt.on) {
      if (evt.pProject != &mProject)
         mDisableTransport = true;
      else
         mCapturing = true;
   }
   else {
      mDisableTransport = false;
      mCapturing = false;
   }
   UpdateControls();
}

References mCapturing, mDisableTransport, mProject, AudioIOEvent::on, AudioIOEvent::pProject, and UpdateControls().

Here is the call graph for this function:

◆ OnCharHook()

void EffectUIHost::OnCharHook ( wxKeyEvent & evt )

private

Definition at line 1002 of file EffectUI.cpp.

{
   if (!IsEscapeKey(evt))
   {
      evt.Skip();
      return;
   }
   
   if (IsOpenedFromEffectPanel())
      Close();
   else
   {
      wxCommandEvent cancelEvt { wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL };
 
      OnCancel(cancelEvt);
   }
}

References IsOpenedFromEffectPanel(), OnCancel(), and wxEVT_COMMAND_BUTTON_CLICKED.

Here is the call graph for this function:

◆ OnClose()

void EffectUIHost::OnClose ( wxCloseEvent & evt )

private

Definition at line 521 of file EffectUI.cpp.

{
   if (mPlaying)
      StopPlayback();
 
   DoCancel();
   CleanupRealtime();
 
   if (mpValidator)
      mpValidator->OnClose();
   
   Hide();
   Destroy();
   
#if wxDEBUG_LEVEL
   mClosed = true;
#endif
}

References CleanupRealtime(), DoCancel(), mPlaying, mpValidator, and StopPlayback().

Here is the call graph for this function:

◆ OnDebug()

void EffectUIHost::OnDebug ( wxCommandEvent & evt )

private

Definition at line 632 of file EffectUI.cpp.

{
   OnApply(evt);
}

References OnApply().

Here is the call graph for this function:

◆ OnDefaults()

void EffectUIHost::OnDefaults ( wxCommandEvent & evt )

private

Definition at line 984 of file EffectUI.cpp.

{
   mpAccess->ModifySettings([&](EffectSettings &settings){
      // ignore failure
      return mEffectUIHost.GetDefinition().LoadFactoryDefaults(settings)
         .value_or(nullptr);
   });
   TransferDataToWindow();
   return;
}

References EffectPlugin::GetDefinition(), mEffectUIHost, mpAccess, settings(), and TransferDataToWindow().

Here is the call graph for this function:

◆ OnDeletePreset()

void EffectUIHost::OnDeletePreset ( wxCommandEvent & evt )

private

Definition at line 856 of file EffectUI.cpp.

{
   auto preset = mUserPresets[evt.GetId() - kDeletePresetID];
   
   int res = AudacityMessageBox(
                                XO("Are you sure you want to delete \"%s\"?").Format( preset ),
                                XO("Delete Preset"),
                                wxICON_QUESTION | wxYES_NO);
   if (res == wxYES)
   {
      RemoveConfigSubgroup(mEffectUIHost.GetDefinition(),
         PluginSettings::Private, UserPresetsGroup(preset));
   }
   
   LoadUserPresets();
   
   return;
}

References AudacityMessageBox(), EffectPlugin::GetDefinition(), kDeletePresetID, LoadUserPresets(), mEffectUIHost, mUserPresets, preset, PluginSettings::Private, PluginSettings::RemoveConfigSubgroup(), UserPresetsGroup(), and XO().

Here is the call graph for this function:

◆ OnEnable()

void EffectUIHost::OnEnable ( wxCommandEvent & evt )

private

Definition at line 740 of file EffectUI.cpp.

{
   mEnabled = !mEnabled;
 
   auto mpState = mwState.lock();
   if (mpState)
      mpState->SetActive(mEnabled);
 
   UpdateControls();
}

References mEnabled, mwState, and UpdateControls().

Here is the call graph for this function:

◆ OnErase()

void EffectUIHost::OnErase ( wxEraseEvent & evt )

private

Definition at line 509 of file EffectUI.cpp.

{
   // Ignore it
}

◆ OnExport()

void EffectUIHost::OnExport ( wxCommandEvent & evt )

private

Definition at line 967 of file EffectUI.cpp.

{
   // may throw
   // exceptions are handled in AudacityApp::OnExceptionInMainLoop
   if (TransferDataFromWindow())
     mClient.ExportPresets(mpAccess->Get());
   
   return;
}

References EffectUIClientInterface::ExportPresets(), mClient, mpAccess, and TransferDataFromWindow().

Here is the call graph for this function:

◆ OnFactoryPreset()

void EffectUIHost::OnFactoryPreset ( wxCommandEvent & evt )

private

ignore failure

Definition at line 845 of file EffectUI.cpp.

{
   mpAccess->ModifySettings([&](EffectSettings &settings){
      return mEffectUIHost.GetDefinition().LoadFactoryPreset(
         evt.GetId() - kFactoryPresetsID, settings).value_or(nullptr);
   });
   TransferDataToWindow();
   return;
}

References EffectPlugin::GetDefinition(), kFactoryPresetsID, mEffectUIHost, mpAccess, settings(), and TransferDataToWindow().

Here is the call graph for this function:

◆ OnIdle()

void EffectUIHost::OnIdle ( wxIdleEvent & evt )

private

Definition at line 995 of file EffectUI.cpp.

{
   evt.Skip();
   if (mpAccess)
      mpAccess->Flush();
}

References mpAccess.

◆ OnImport()

void EffectUIHost::OnImport ( wxCommandEvent & evt )

private

Definition at line 955 of file EffectUI.cpp.

{
   mpAccess->ModifySettings([&](EffectSettings &settings){
      // ignore failure
      return mClient.ImportPresets(settings).value_or(nullptr);
   });
   TransferDataToWindow();
   LoadUserPresets();
 
   return;
}

References EffectUIClientInterface::ImportPresets(), LoadUserPresets(), mClient, mpAccess, settings(), and TransferDataToWindow().

Here is the call graph for this function:

◆ OnInitDialog()

void EffectUIHost::OnInitDialog ( wxInitDialogEvent & evt )

private

Definition at line 486 of file EffectUI.cpp.

{
   // Do default handling
   wxDialogWrapper::OnInitDialog(evt);
   
#if wxCHECK_VERSION(3, 0, 0)
   //#warning "check to see if this still needed in wx3"
#endif
   
   // Pure hackage coming down the pike...
   //
   // I have no idea why, but if a wxTextCtrl is the first control in the
   // panel, then its contents will not be automatically selected when the
   // dialog is displayed.
   //
   // So, we do the selection manually.
   wxTextCtrl *focused = wxDynamicCast(FindFocus(), wxTextCtrl);
   if (focused)
   {
      focused->SelectAll();
   }
}

◆ OnMenu()

void EffectUIHost::OnMenu ( wxCommandEvent & evt )

private

Definition at line 648 of file EffectUI.cpp.

{
   wxMenu menu;
   menu.Bind(wxEVT_MENU, [](auto&){}, kUserPresetsDummyID);
   menu.Bind(wxEVT_MENU, [](auto&){}, kDeletePresetDummyID);
   LoadUserPresets();
   
   if (mUserPresets.size() == 0)
   {
      menu.Append(kUserPresetsDummyID, _("User Presets"))->Enable(false);
   }
   else
   {
      auto sub = std::make_unique<wxMenu>();
      for (size_t i = 0, cnt = mUserPresets.size(); i < cnt; i++)
      {
         sub->Append(kUserPresetsID + i, mUserPresets[i]);
      }
      menu.Append(0, _("User Presets"), sub.release());
   }
   
   menu.Append(kSaveAsID, _("Save Preset..."));
   
   if (mUserPresets.size() == 0)
   {
      menu.Append(kDeletePresetDummyID, _("Delete Preset"))->Enable(false);
   }
   else
   {
      auto sub = std::make_unique<wxMenu>();
      for (size_t i = 0, cnt = mUserPresets.size(); i < cnt; i++)
      {
         sub->Append(kDeletePresetID + i, mUserPresets[i]);
      }
      menu.Append(0, _("Delete Preset"), sub.release());
   }
   
   menu.AppendSeparator();
   
   auto factory = mEffectUIHost.GetDefinition().GetFactoryPresets();
   
   {
      auto sub = std::make_unique<wxMenu>();
      sub->Append(kDefaultsID, _("Defaults"));
      if (factory.size() > 0)
      {
         sub->AppendSeparator();
         for (size_t i = 0, cnt = factory.size(); i < cnt; i++)
         {
            auto label = factory[i];
            if (label.empty())
            {
               label = _("None");
            }
            
            sub->Append(kFactoryPresetsID + i, label);
         }
      }
      menu.Append(0, _("Factory Presets"), sub.release());
   }
   
   menu.AppendSeparator();
   menu.Append(kImportID, _("Import..."))->Enable(mClient.CanExportPresets());
   menu.Append(kExportID, _("Export..."))->Enable(mClient.CanExportPresets());
   menu.AppendSeparator();
   menu.Append(kOptionsID, _("Options..."))->Enable(mClient.HasOptions());
   menu.AppendSeparator();
   
   {
      auto sub = std::make_unique<wxMenu>();
      
      auto &definition = mEffectUIHost.GetDefinition();
      sub->Append(kDummyID, wxString::Format(_("Type: %s"),
         ::wxGetTranslation( definition.GetFamily().Translation() )));
      sub->Append(kDummyID, wxString::Format(_("Name: %s"), definition.GetName().Translation()));
      sub->Append(kDummyID, wxString::Format(_("Version: %s"),
         GetVersionForDisplay(definition)));
      sub->Append(kDummyID, wxString::Format(_("Vendor: %s"), definition.GetVendor().Translation()));
      sub->Append(kDummyID, wxString::Format(_("Description: %s"), definition.GetDescription().Translation()));
      sub->Bind(wxEVT_MENU, [](auto&){}, kDummyID);
 
      menu.Append(0, _("About"), sub.release());
   }
   
   wxWindow *btn = FindWindow(kMenuID);
   wxRect r = btn->GetRect();
   BasicMenu::Handle{ &menu }.Popup(
      wxWidgetsWindowPlacement{ btn },
      { r.GetLeft(), r.GetBottom() }
   );
}

References _, EffectUIClientInterface::CanExportPresets(), TranslatableString::empty(), cloud::factory, EffectPlugin::GetDefinition(), EffectSettingsManager::GetFactoryPresets(), anonymous_namespace{EffectUI.cpp}::GetVersionForDisplay(), EffectUIClientInterface::HasOptions(), kDefaultsID, kDeletePresetDummyID, kDeletePresetID, kDummyID, kExportID, kFactoryPresetsID, kImportID, kMenuID, kOptionsID, kSaveAsID, kUserPresetsDummyID, kUserPresetsID, label, LoadUserPresets(), mClient, mEffectUIHost, mUserPresets, and BasicMenu::Handle::Popup().

Here is the call graph for this function:

◆ OnOptions()

void EffectUIHost::OnOptions ( wxCommandEvent & evt )

private

Definition at line 977 of file EffectUI.cpp.

{
   mClient.ShowOptions();
   
   return;
}

References mClient, and EffectUIClientInterface::ShowOptions().

Here is the call graph for this function:

◆ OnPaint()

void EffectUIHost::OnPaint ( wxPaintEvent & evt )

private

Definition at line 514 of file EffectUI.cpp.

{
   wxPaintDC dc(this);
   
   dc.Clear();
}

◆ OnPlay()

void EffectUIHost::OnPlay ( wxCommandEvent & evt )

private

Definition at line 751 of file EffectUI.cpp.

{
   if (!mSupportsRealtime)
   {
      if (!TransferDataFromWindow())
         return;
      
      mEffectUIHost.Preview(*mpAccess, false);
      
      return;
   }
   
   if (mPlaying)
   {
      StopPlayback();
   }
   else
   {
      auto &viewInfo = ViewInfo::Get( mProject );
      const auto &selectedRegion = viewInfo.selectedRegion;
      const auto &playRegion = viewInfo.playRegion;
      if ( playRegion.Active() )
      {
         mRegion.setTimes(playRegion.GetStart(), playRegion.GetEnd());
         mPlayPos = mRegion.t0();
      }
      else if (selectedRegion.t0() != mRegion.t0() ||
               selectedRegion.t1() != mRegion.t1())
      {
         mRegion = selectedRegion;
         mPlayPos = mRegion.t0();
      }
      
      if (mPlayPos > mRegion.t1())
      {
         mPlayPos = mRegion.t1();
      }
      
      auto &projectAudioManager = ProjectAudioManager::Get( mProject );
      projectAudioManager.PlayPlayRegion(
         SelectedRegion{ mPlayPos, mRegion.t1() },
         ProjectAudioIO::GetDefaultOptions(mProject),
         PlayMode::normalPlay);
   }
}

References ViewInfo::Get(), ProjectAudioManager::Get(), ProjectAudioIO::GetDefaultOptions(), mEffectUIHost, mpAccess, mPlaying, mPlayPos, mProject, mRegion, mSupportsRealtime, normalPlay, EffectPlugin::Preview(), SelectedRegion::setTimes(), StopPlayback(), SelectedRegion::t0(), SelectedRegion::t1(), and TransferDataFromWindow().

Here is the call graph for this function:

◆ OnPlayback()

void EffectUIHost::OnPlayback ( AudioIOEvent evt )

private

Definition at line 797 of file EffectUI.cpp.

{
   if (evt.on) {
      if (evt.pProject != &mProject)
         mDisableTransport = true;
      else
         mPlaying = true;
   }
   else {
      mDisableTransport = false;
      mPlaying = false;
   }
   
   if (mPlaying) {
      mRegion = ViewInfo::Get( mProject ).selectedRegion;
      mPlayPos = mRegion.t0();
   }
   UpdateControls();
}

References ViewInfo::Get(), mDisableTransport, mPlaying, mPlayPos, mProject, mRegion, AudioIOEvent::on, AudioIOEvent::pProject, ViewInfo::selectedRegion, SelectedRegion::t0(), and UpdateControls().

Here is the call graph for this function:

◆ OnSaveAs()

void EffectUIHost::OnSaveAs ( wxCommandEvent & evt )

private

Definition at line 875 of file EffectUI.cpp.

{
   wxTextCtrl *text;
   wxString name;
   wxDialogWrapper dlg(this, wxID_ANY, XO("Save Preset"));
   
   ShuttleGui S(&dlg, eIsCreating);
   
   S.StartPanel();
   {
      S.StartVerticalLay(1);
      {
         S.StartHorizontalLay(wxALIGN_LEFT, 0);
         {
            text = S.AddTextBox(XXO("Preset name:"), name, 30);
         }
         S.EndHorizontalLay();
         S.SetBorder(10);
         S.AddStandardButtons();
      }
      S.EndVerticalLay();
   }
   S.EndPanel();
   
   dlg.SetSize(dlg.GetSizer()->GetMinSize());
   dlg.Center();
   dlg.Fit();
   
   while (true)
   {
      int rc = dlg.ShowModal();
      
      if (rc != wxID_OK)
      {
         break;
      }
      
      name = text->GetValue();
      if (name.empty())
      {
         AudacityMessageDialog md(
                                  this,
                                  XO("You must specify a name"),
                                  XO("Save Preset") );
         md.Center();
         md.ShowModal();
         continue;
      }
      
      if ( make_iterator_range( mUserPresets ).contains( name ) )
      {
         AudacityMessageDialog md(
                                  this,
                                  XO("Preset already exists.\n\nReplace?"),
                                  XO("Save Preset"),
                                  wxYES_NO | wxCANCEL | wxICON_EXCLAMATION );
         md.Center();
         int choice = md.ShowModal();
         if (choice == wxID_CANCEL)
         {
            break;
         }
         
         if (choice == wxID_NO)
         {
            continue;
         }
      }
      
      if (TransferDataFromWindow())
         mEffectUIHost.GetDefinition()
            .SaveUserPreset(UserPresetsGroup(name), mpAccess->Get());
      LoadUserPresets();
      
      break;
   }
   
   return;
}

References eIsCreating, TranslatableString::empty(), EffectPlugin::GetDefinition(), LoadUserPresets(), make_iterator_range(), mEffectUIHost, mpAccess, mUserPresets, name, S, EffectSettingsManager::SaveUserPreset(), TransferDataFromWindow(), UserPresetsGroup(), XO(), and XXO().

Here is the call graph for this function:

◆ OnUserPreset()

void EffectUIHost::OnUserPreset ( wxCommandEvent & evt )

private

Definition at line 832 of file EffectUI.cpp.

{
   int preset = evt.GetId() - kUserPresetsID;
   
   mpAccess->ModifySettings([&](EffectSettings &settings){
      // ignore failure
      return mEffectUIHost.GetDefinition().LoadUserPreset(
         UserPresetsGroup(mUserPresets[preset]), settings).value_or(nullptr);
   });
   TransferDataToWindow();
   return;
}

References EffectPlugin::GetDefinition(), kUserPresetsID, mEffectUIHost, mpAccess, mUserPresets, preset, settings(), TransferDataToWindow(), and UserPresetsGroup().

Here is the call graph for this function:

◆ SetClosed()

void EffectUIHost::SetClosed ( )

inline

Definition at line 69 of file EffectUI.h.

                    {
#if wxDEBUG_LEVEL
      mClosed = true;
#endif
   }

◆ ShowModal()

int EffectUIHost::ShowModal ( )

override

Definition at line 324 of file EffectUI.cpp.

{
   if (mEffectUIHost.GetDefinition().GetType() == EffectTypeGenerate)
   {
      mApplyBtn->SetLabel(XXO("&Generate").Translation());
   }
 
   Layout();
 
   return wxDialogWrapper::ShowModal();
}

References EffectTypeGenerate, EffectPlugin::GetDefinition(), EffectDefinitionInterface::GetType(), mApplyBtn, mEffectUIHost, and XXO().

Here is the call graph for this function:

◆ StopPlayback()

void EffectUIHost::StopPlayback ( )

private

Definition at line 1191 of file EffectUI.cpp.

{
   if (!mPlaying)
      return;
   
   auto gAudioIO = AudioIO::Get();
   mPlayPos = gAudioIO->GetStreamTime();
   auto& projectAudioManager = ProjectAudioManager::Get(mProject);
   projectAudioManager.Stop();
}

References AudioIO::Get(), ProjectAudioManager::Get(), mPlaying, mPlayPos, and mProject.

Referenced by OnApply(), OnClose(), and OnPlay().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TransferDataFromWindow()

bool EffectUIHost::TransferDataFromWindow ( )

override

Do validations of any wxValidator objects

Do transfers of any wxValidator objects

Do other custom validation and transfer actions

Definition at line 285 of file EffectUI.cpp.

{
   if (!wxDialogWrapper::Validate())
      return false;
 
   if (!wxDialogWrapper::TransferDataFromWindow())
      return false;
 
   if (!mpValidator->ValidateUI())
      return false;
   
   // Transfer-from takes non-const reference to settings
   bool result = true;
   mpAccess->ModifySettings([&](EffectSettings &settings){
      // Allow other transfers, and reassignment of settings
      result = mEffectUIHost.TransferDataFromWindow(settings);
      if (result) {
         auto &definition = mEffectUIHost.GetDefinition();
         if (definition.GetType() == EffectTypeGenerate) {
            const auto seconds = settings.extra.GetDuration();
            // Updating of the last-used generator duration in the config
            SetConfig(definition, PluginSettings::Private,
               CurrentSettingsGroup(), EffectSettingsExtra::DurationKey(),
               seconds);
         }
      }
      return nullptr;
   });
   mpAccess->Flush();
   return result;
}

References EffectTypeGenerate, EffectPlugin::GetDefinition(), mEffectUIHost, mpAccess, mpValidator, settings(), and EffectPlugin::TransferDataFromWindow().

Referenced by OnApply(), OnExport(), OnPlay(), and OnSaveAs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TransferDataToWindow()

bool EffectUIHost::TransferDataToWindow ( )

override

Do other appearance updates

Do validators

Definition at line 275 of file EffectUI.cpp.

{
   // Transfer-to takes const reference to settings
   return mEffectUIHost.TransferDataToWindow(mpAccess->Get()) &&
      mpValidator->UpdateUI() &&
      wxDialogWrapper::TransferDataToWindow();
}

References mEffectUIHost, mpAccess, mpValidator, and EffectPlugin::TransferDataToWindow().

Referenced by OnDefaults(), OnFactoryPreset(), OnImport(), and OnUserPreset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateControls()

void EffectUIHost::UpdateControls ( )

private

Definition at line 1058 of file EffectUI.cpp.

{
   if (mIsBatch)
   {
      return;
   }
 
   if (IsOpenedFromEffectPanel())
   {
      mEnableBtn->SetBitmapLabel(mEnabled ? mRealtimeEnabledBM : mRealtimeDisabledBM);
      return;
   }
 
   mApplyBtn->Enable(!mCapturing);
 
   if (mSupportsRealtime)
   {
      mPlayToggleBtn->Enable(!(mCapturing || mDisableTransport));
 
      if (mPlaying)
      {
         /* i18n-hint: The access key "&P" should be the same in
          "Stop &Preview" and "Start &Preview" */
         mPlayToggleBtn->SetLabel(_("Stop &Preview"));
         mPlayToggleBtn->Refresh();
      }
      else
      {
         /* i18n-hint: The access key "&P" should be the same in
          "Stop &Preview" and "Start &Preview" */
         mPlayToggleBtn->SetLabel(_("&Preview"));
         mPlayToggleBtn->Refresh();
      }
   }
}

References _, IsOpenedFromEffectPanel(), mApplyBtn, mCapturing, mDisableTransport, mEnableBtn, mEnabled, mIsBatch, mPlaying, mPlayToggleBtn, mRealtimeDisabledBM, mRealtimeEnabledBM, and mSupportsRealtime.

Referenced by Initialize(), InitializeInstance(), OnCapture(), OnEnable(), and OnPlayback().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mApplyBtn

wxButton* EffectUIHost::mApplyBtn {}

private

Definition at line 136 of file EffectUI.h.

Referenced by BuildButtonBar(), Initialize(), OnApply(), ShowModal(), and UpdateControls().

◆ mAudioIOSubscription

Observer::Subscription EffectUIHost::mAudioIOSubscription

private

Definition at line 116 of file EffectUI.h.

Referenced by CleanupRealtime(), and InitializeInstance().

◆ mCapturing

bool EffectUIHost::mCapturing {}

private

Definition at line 149 of file EffectUI.h.

Referenced by InitializeInstance(), OnCapture(), and UpdateControls().

◆ mClient

EffectUIClientInterface& EffectUIHost::mClient

private

Definition at line 121 of file EffectUI.h.

Referenced by Initialize(), OnExport(), OnImport(), OnMenu(), and OnOptions().

◆ mDebugBtn

wxButton* EffectUIHost::mDebugBtn {}

private

Definition at line 139 of file EffectUI.h.

Referenced by BuildButtonBar().

◆ mDisableTransport

bool EffectUIHost::mDisableTransport { true }

private

Definition at line 147 of file EffectUI.h.

Referenced by InitializeInstance(), OnCapture(), OnPlayback(), and UpdateControls().

◆ mDismissed

bool EffectUIHost::mDismissed {}

private

Definition at line 154 of file EffectUI.h.

Referenced by DoCancel(), and OnApply().

◆ mEffectStateSubscription

Observer::Subscription EffectUIHost::mEffectStateSubscription

private

Definition at line 116 of file EffectUI.h.

Referenced by CleanupRealtime(), and InitializeInstance().

◆ mEffectUIHost

EffectPlugin& EffectUIHost::mEffectUIHost

private

Definition at line 120 of file EffectUI.h.

Referenced by BuildButtonBar(), DoCancel(), InitializeInstance(), LoadUserPresets(), OnApply(), OnDefaults(), OnDeletePreset(), OnFactoryPreset(), OnMenu(), OnPlay(), OnSaveAs(), OnUserPreset(), ShowModal(), TransferDataFromWindow(), and TransferDataToWindow().

◆ mEnableBtn

wxButton* EffectUIHost::mEnableBtn {}

private

Definition at line 138 of file EffectUI.h.

Referenced by BuildButtonBar(), InitializeInstance(), and UpdateControls().

◆ mEnabled

bool EffectUIHost::mEnabled { true }

private

Definition at line 145 of file EffectUI.h.

Referenced by BuildButtonBar(), Initialize(), InitializeInstance(), OnEnable(), and UpdateControls().

◆ mHadPriorState

const bool EffectUIHost::mHadPriorState

private

Definition at line 155 of file EffectUI.h.

Referenced by DoCancel().

◆ mInitialized

bool EffectUIHost::mInitialized { false }

private

Definition at line 131 of file EffectUI.h.

Referenced by CleanupRealtime(), and InitializeInstance().

◆ mIsBatch

bool EffectUIHost::mIsBatch {}

private

Definition at line 134 of file EffectUI.h.

Referenced by BuildButtonBar(), OnApply(), and UpdateControls().

◆ mIsGUI

bool EffectUIHost::mIsGUI {}

private

Definition at line 133 of file EffectUI.h.

Referenced by BuildButtonBar(), and Initialize().

◆ mMenuBtn

wxButton* EffectUIHost::mMenuBtn {}

private

Definition at line 137 of file EffectUI.h.

Referenced by BuildButtonBar().

◆ mpAccess

EffectPlugin::EffectSettingsAccessPtr EffectUIHost::mpAccess

private

Definition at line 124 of file EffectUI.h.

Referenced by DoCancel(), Initialize(), InitializeInstance(), OnApply(), OnDefaults(), OnExport(), OnFactoryPreset(), OnIdle(), OnImport(), OnPlay(), OnSaveAs(), OnUserPreset(), TransferDataFromWindow(), and TransferDataToWindow().

◆ mpAccess2

EffectPlugin::EffectSettingsAccessPtr EffectUIHost::mpAccess2

private

Definition at line 125 of file EffectUI.h.

Referenced by InitializeInstance().

◆ mParent

wxWindow* const EffectUIHost::mParent

private

Definition at line 119 of file EffectUI.h.

Referenced by Initialize().

◆ mpGivenAccess

const EffectPlugin::EffectSettingsAccessPtr EffectUIHost::mpGivenAccess

private

Invariant: not null

Definition at line 123 of file EffectUI.h.

◆ mpInstance

const std::shared_ptr<EffectInstance> EffectUIHost::mpInstance

private

Definition at line 162 of file EffectUI.h.

Referenced by EffectUIHost(), and Initialize().

◆ mPlaying

bool EffectUIHost::mPlaying {}

private

Definition at line 148 of file EffectUI.h.

Referenced by InitializeInstance(), OnApply(), OnClose(), OnPlay(), OnPlayback(), StopPlayback(), and UpdateControls().

◆ mPlayPos

double EffectUIHost::mPlayPos { 0.0 }

private

Definition at line 152 of file EffectUI.h.

Referenced by OnPlay(), OnPlayback(), and StopPlayback().

◆ mPlayToggleBtn

wxButton* EffectUIHost::mPlayToggleBtn {}

private

Definition at line 140 of file EffectUI.h.

Referenced by BuildButtonBar(), and UpdateControls().

◆ mpOutputs

const EffectOutputs* const EffectUIHost::mpOutputs

private

Definition at line 163 of file EffectUI.h.

Referenced by Initialize().

◆ mProject

AudacityProject& EffectUIHost::mProject

private

Definition at line 118 of file EffectUI.h.

Referenced by CleanupRealtime(), InitializeInstance(), OnApply(), OnCapture(), OnPlay(), OnPlayback(), and StopPlayback().

◆ mpTempProjectState

std::shared_ptr<RealtimeEffectState> EffectUIHost::mpTempProjectState {}

private

Definition at line 128 of file EffectUI.h.

Referenced by BuildButtonBar(), CleanupRealtime(), InitializeInstance(), and IsOpenedFromEffectPanel().

◆ mpValidator

std::unique_ptr<EffectUIValidator> EffectUIHost::mpValidator

private

Definition at line 165 of file EffectUI.h.

Referenced by GetValidator(), Initialize(), OnClose(), TransferDataFromWindow(), TransferDataToWindow(), and ~EffectUIHost().

◆ mRealtimeDisabledBM

wxBitmap EffectUIHost::mRealtimeDisabledBM

private

Definition at line 143 of file EffectUI.h.

Referenced by BuildButtonBar(), Initialize(), InitializeInstance(), and UpdateControls().

◆ mRealtimeEnabledBM

wxBitmap EffectUIHost::mRealtimeEnabledBM

private

Definition at line 142 of file EffectUI.h.

Referenced by BuildButtonBar(), Initialize(), InitializeInstance(), and UpdateControls().

◆ mRegion

SelectedRegion EffectUIHost::mRegion

private

Definition at line 151 of file EffectUI.h.

Referenced by OnPlay(), and OnPlayback().

◆ mSupportsRealtime

const bool EffectUIHost::mSupportsRealtime

private

Definition at line 132 of file EffectUI.h.

Referenced by BuildButtonBar(), CleanupRealtime(), InitializeInstance(), IsOpenedFromEffectPanel(), OnPlay(), and UpdateControls().

◆ mUserPresets

RegistryPaths EffectUIHost::mUserPresets

private

Definition at line 130 of file EffectUI.h.

Referenced by LoadUserPresets(), OnDeletePreset(), OnMenu(), OnSaveAs(), and OnUserPreset().

◆ mwState

std::weak_ptr<RealtimeEffectState> EffectUIHost::mwState {}

private

Definition at line 126 of file EffectUI.h.

Referenced by InitializeInstance(), and OnEnable().

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EffectUIHost()

◆ ~EffectUIHost()

Member Function Documentation

◆ BuildButtonBar() [1/2]

◆ BuildButtonBar() [2/2]

◆ CleanupRealtime()

◆ CreateBitmap()

◆ DoCancel()

◆ GetValidator()

◆ HandleCommandKeystrokes()

◆ Initialize()

◆ InitializeInstance()

◆ IsOpenedFromEffectPanel()

◆ LoadUserPresets()

◆ OnApply()

◆ OnCancel()

◆ OnCapture()

◆ OnCharHook()

◆ OnClose()

◆ OnDebug()

◆ OnDefaults()

◆ OnDeletePreset()

◆ OnEnable()

◆ OnErase()

◆ OnExport()

◆ OnFactoryPreset()

◆ OnIdle()

◆ OnImport()

◆ OnInitDialog()

◆ OnMenu()

◆ OnOptions()

◆ OnPaint()

◆ OnPlay()

◆ OnPlayback()

◆ OnSaveAs()

◆ OnUserPreset()

◆ SetClosed()

◆ ShowModal()

◆ StopPlayback()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

◆ UpdateControls()

Member Data Documentation

◆ mApplyBtn

◆ mAudioIOSubscription

◆ mCapturing

◆ mClient

◆ mDebugBtn

◆ mDisableTransport

◆ mDismissed

◆ mEffectStateSubscription

◆ mEffectUIHost

◆ mEnableBtn

◆ mEnabled

◆ mHadPriorState

◆ mInitialized

◆ mIsBatch

◆ mIsGUI

◆ mMenuBtn

◆ mpAccess

◆ mpAccess2

◆ mParent

◆ mpGivenAccess

◆ mpInstance

◆ mPlaying

◆ mPlayPos

◆ mPlayToggleBtn

◆ mpOutputs

◆ mProject

◆ mpTempProjectState

◆ mpValidator

◆ mRealtimeDisabledBM

◆ mRealtimeEnabledBM

◆ mRegion

◆ mSupportsRealtime