RealtimeEffectPanel Class Reference

UI Panel that displays realtime effects from the effect stack of an individual track, provides controls for accessing effect settings, stack manipulation (reorder, add, remove) More...

#include <RealtimeEffectPanel.h>

Inheritance diagram for RealtimeEffectPanel:

Collaboration diagram for RealtimeEffectPanel:

Classes
struct	PrefsListenerHelper

Public Member Functions
	RealtimeEffectPanel (AudacityProject &project, wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr)
	~RealtimeEffectPanel () override
void	ShowPanel (SampleTrack *track, bool focus)
void	HidePanel ()
void	SetTrack (const std::shared_ptr< SampleTrack > &track)
	Shows effects from the effect stack of the track. More...
void	ResetTrack ()
bool	IsTopNavigationDomain (NavigationKind) const override
void	SetFocus () override

Static Public Member Functions
static RealtimeEffectPanel &	Get (AudacityProject &project)
static const RealtimeEffectPanel &	Get (const AudacityProject &project)

Private Member Functions
void	OnCharHook (wxKeyEvent &evt)

Private Attributes
AButton *	mToggleEffects {nullptr}
wxStaticText *	mTrackTitle {nullptr}
RealtimeEffectListWindow *	mEffectList {nullptr}
wxWindow *	mHeader {nullptr}
AudacityProject &	mProject
std::weak_ptr< SampleTrack >	mCurrentTrack
Observer::Subscription	mTrackListChanged
Observer::Subscription	mUndoSubscription
Observer::Subscription	mFocusChangeSubscription
std::vector< std::shared_ptr< SampleTrack > >	mPotentiallyRemovedTracks
std::unique_ptr< PrefsListenerHelper >	mPrefsListenerHelper

Detailed Description

UI Panel that displays realtime effects from the effect stack of an individual track, provides controls for accessing effect settings, stack manipulation (reorder, add, remove)

Definition at line 34 of file RealtimeEffectPanel.h.

Constructor & Destructor Documentation

RealtimeEffectPanel()

RealtimeEffectPanel::RealtimeEffectPanel	(	AudacityProject &	project,
		wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = 0,
		const wxString &	name = wxPanelNameStr
	)

Definition at line 1067 of file RealtimeEffectPanel.cpp.

      : wxPanel(parent, id, pos, size, style, name)
      , mProject(project)
      , mPrefsListenerHelper(std::make_unique<PrefsListenerHelper>(project))
{
   auto vSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
 
   auto header = safenew ThemedWindowWrapper<ListNavigationPanel>(this, wxID_ANY);
#if wxUSE_ACCESSIBILITY
   safenew WindowAccessible(header);
#endif
   header->SetBackgroundColorIndex(clrMedium);
   {
      auto hSizer = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
      auto toggleEffects = safenew ThemedAButtonWrapper<AButton>(header);
      toggleEffects->SetImageIndices(0, bmpEffectOff, bmpEffectOff, bmpEffectOn, bmpEffectOn, bmpEffectOff);
      toggleEffects->SetButtonToggles(true);
      toggleEffects->SetTranslatableLabel(XO("Power"));
      toggleEffects->SetBackgroundColorIndex(clrMedium);
      mToggleEffects = toggleEffects;
 
      toggleEffects->Bind(wxEVT_BUTTON, [this](wxCommandEvent&) {
         if (mEffectList)
         {
            mEffectList->EnableEffects(mToggleEffects->IsDown());
         
            ProjectHistory::Get(mProject).ModifyState(false);
            UndoManager::Get(mProject).MarkUnsaved();
         }
      });
 
      hSizer->Add(toggleEffects, 0, wxSTRETCH_NOT | wxALIGN_CENTER | wxLEFT, 5);
      {
         auto vSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
 
         auto headerText = safenew ThemedWindowWrapper<wxStaticText>(header, wxID_ANY, wxEmptyString);
         headerText->SetFont(wxFont(wxFontInfo().Bold()));
         headerText->SetTranslatableLabel(XO("Realtime Effects"));
         headerText->SetForegroundColorIndex(clrTrackPanelText);
 
         auto trackTitle = safenew ThemedWindowWrapper<wxStaticText>(header, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, wxST_ELLIPSIZE_END);
         trackTitle->SetForegroundColorIndex(clrTrackPanelText);
         mTrackTitle = trackTitle;
 
         vSizer->Add(headerText);
         vSizer->Add(trackTitle);
 
         hSizer->Add(vSizer.release(), 1, wxEXPAND | wxALL, 10);
      }
      auto close = safenew ThemedAButtonWrapper<AButton>(header);
      close->SetTranslatableLabel(XO("Close"));
      close->SetImageIndices(0, bmpCloseNormal, bmpCloseHover, bmpCloseDown, bmpCloseHover, bmpCloseDisabled);
      close->SetBackgroundColorIndex(clrMedium);
 
      close->Bind(wxEVT_BUTTON, [this](wxCommandEvent&) { Close(); });
 
      hSizer->Add(close, 0, wxSTRETCH_NOT | wxALIGN_CENTER | wxRIGHT, 5);
 
      header->SetSizer(hSizer.release());
   }
   vSizer->Add(header, 0, wxEXPAND);
 
   auto effectList = safenew ThemedWindowWrapper<RealtimeEffectListWindow>(this, wxID_ANY);
   effectList->SetBackgroundColorIndex(clrMedium);
   vSizer->Add(effectList, 1, wxEXPAND);
 
   mHeader = header;
   mEffectList = effectList;
 
   SetSizerAndFit(vSizer.release());
 
   Bind(wxEVT_CHAR_HOOK, &RealtimeEffectPanel::OnCharHook, this);
   mTrackListChanged =
   PendingTracks::Get(mProject).Subscribe([this](const TrackListEvent& evt) {
         auto track = evt.mpTrack.lock();
         auto waveTrack = std::dynamic_pointer_cast<WaveTrack>(track);
 
         if (waveTrack == nullptr)
            return;
         
         switch (evt.mType)
         {
         case TrackListEvent::TRACK_DATA_CHANGE:
            if (mCurrentTrack.lock() == waveTrack)
               mTrackTitle->SetLabel(track->GetName());
            UpdateRealtimeEffectUIData(*waveTrack);
            break;
         case TrackListEvent::DELETION:
            if (evt.mExtra == 0)
               mPotentiallyRemovedTracks.push_back(waveTrack);
            break;
         case TrackListEvent::ADDITION:
            // Addition can be fired as a part of "replace" event.
            // Calling UpdateRealtimeEffectUIData is mostly no-op,
            // it will just create a new State and Access for it.
            UpdateRealtimeEffectUIData(*waveTrack);
            break;
         default:
            break;
         }
   });
 
   mUndoSubscription = UndoManager::Get(mProject).Subscribe(
      [this](UndoRedoMessage message)
      {
         if (
            message.type == UndoRedoMessage::Type::Purge ||
            message.type == UndoRedoMessage::Type::BeginPurge ||
            message.type == UndoRedoMessage::Type::EndPurge)
            return;
 
         auto& trackList = TrackList::Get(mProject);
 
         // Realtime effect UI is only updated on Undo or Redo
         auto waveTracks = trackList.Any<WaveTrack>();
         
         if (
            message.type == UndoRedoMessage::Type::UndoOrRedo ||
            message.type == UndoRedoMessage::Type::Reset)
         {
            for (auto waveTrack : waveTracks)
               UpdateRealtimeEffectUIData(*waveTrack);
         }
 
         // But mPotentiallyRemovedTracks processing happens as fast as possible.
         // This event is fired right after the track is deleted, so we do not
         // hold the strong reference to the track much longer than need.
         if (mPotentiallyRemovedTracks.empty())
            return;
 
         // Collect RealtimeEffectUIs that are currently shown
         // for the potentially removed tracks
         std::vector<RealtimeEffectStateUI*> shownUIs;
         
         for (auto track : mPotentiallyRemovedTracks)
         {
            // By construction, track cannot be null
            assert(track != nullptr);
 
            VisitRealtimeEffectStateUIs(
               *track,
               [&shownUIs](auto& ui)
               {
                  if (ui.IsShown())
                     shownUIs.push_back(&ui);
               });
         }
 
         // For every UI shown - check if the corresponding state
         // is reachable from the current track list.
         for (auto effectUI : shownUIs)
         {
            bool reachable = false;
            
            for (auto track : waveTracks)
            {               
               VisitRealtimeEffectStateUIs(
                  *track,
                  [effectUI, &reachable](auto& ui)
                  {
                     if (effectUI == &ui)
                        reachable = true;
                  });
 
               if (reachable)
                  break;
            }
 
            if (!reachable)
               // Don't need to autosave for an unreachable state
               effectUI->Hide();
         }
 
         mPotentiallyRemovedTracks.clear();
      });
 
   mFocusChangeSubscription = TrackFocus::Get(project)
      .Subscribe([this](const TrackFocusChangeMessage& msg) {
         if (IsShown())
         {
            auto& trackFocus = TrackFocus::Get(mProject);
            ShowPanel(dynamic_cast<SampleTrack *>(trackFocus.Get()), false);
         }
      });
 
   Bind(wxEVT_CLOSE_WINDOW, [this](wxCloseEvent&) {
      HidePanel(); });
}

References TrackListEvent::ADDITION, TrackList::Any(), TrackListEvent::DELETION, RealtimeEffectListWindow::EnableEffects(), for(), TrackFocus::Get(), ProjectHistory::Get(), UndoManager::Get(), PendingTracks::Get(), TrackList::Get(), HidePanel(), AButton::IsDown(), UndoManager::MarkUnsaved(), mCurrentTrack, mEffectList, TrackListEvent::mExtra, mFocusChangeSubscription, mHeader, ProjectHistory::ModifyState(), mPotentiallyRemovedTracks, mProject, TrackListEvent::mpTrack, mToggleEffects, mTrackListChanged, mTrackTitle, TrackListEvent::mType, mUndoSubscription, OnCharHook(), project, safenew, ShowPanel(), Observer::Publisher< Message, NotifyAll >::Subscribe(), TrackListEvent::TRACK_DATA_CHANGE, UndoRedoMessage::type, anonymous_namespace{RealtimeEffectPanel.cpp}::UpdateRealtimeEffectUIData(), anonymous_namespace{RealtimeEffectPanel.cpp}::VisitRealtimeEffectStateUIs(), and XO().

Here is the call graph for this function:

~RealtimeEffectPanel()

RealtimeEffectPanel::~RealtimeEffectPanel ( )

override

Definition at line 1259 of file RealtimeEffectPanel.cpp.

{
}

Member Function Documentation

Get() [1/2]

RealtimeEffectPanel & RealtimeEffectPanel::Get ( AudacityProject &  project )

static

Definition at line 1056 of file RealtimeEffectPanel.cpp.

{
   return GetAttachedWindows(project).Get<RealtimeEffectPanel>(sKey);
}

References ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Get(), GetAttachedWindows(), project, and anonymous_namespace{RealtimeEffectPanel.cpp}::sKey.

Referenced by EffectsButtonHandle::CommitChanges(), anonymous_namespace{PluginMenus.cpp}::DoManageRealtimeEffectsSidePanel(), Get(), and anonymous_namespace{NavigationMenus.cpp}::NextOrPrevFrame().

Here is the call graph for this function:

Here is the caller graph for this function:

Get() [2/2]

const RealtimeEffectPanel & RealtimeEffectPanel::Get ( const AudacityProject &  project )

static

Definition at line 1062 of file RealtimeEffectPanel.cpp.

{
   return Get(const_cast<AudacityProject &>(project));
}

References Get(), and project.

Here is the call graph for this function:

HidePanel()

void RealtimeEffectPanel::HidePanel

(

)

Definition at line 1290 of file RealtimeEffectPanel.cpp.

{
   wxWindowUpdateLocker freeze(this);
 
   auto &projectWindow = ProjectWindow::Get(mProject);
   const auto pContainerWindow = projectWindow.GetContainerWindow();
   const auto pTrackListWindow = projectWindow.GetTrackListWindow();
   if (pContainerWindow->GetWindow2() == nullptr)
      //only effects panel is present, restore split positions before removing effects panel
      //Workaround: ::Replace and ::Initialize do not work here...
      pContainerWindow->SplitVertically(this, pTrackListWindow);
 
   pContainerWindow->Unsplit(this);
   pTrackListWindow->SetFocus();
   projectWindow.Layout();
}

References ProjectWindow::Get(), and mProject.

Referenced by RealtimeEffectPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

IsTopNavigationDomain()

bool RealtimeEffectPanel::IsTopNavigationDomain ( NavigationKind  ) const

inlineoverride

Definition at line 79 of file RealtimeEffectPanel.h.

{ return true; }

OnCharHook()

void RealtimeEffectPanel::OnCharHook ( wxKeyEvent &  evt )

private

Definition at line 1341 of file RealtimeEffectPanel.cpp.

{
   if(evt.GetKeyCode() == WXK_ESCAPE && IsShown() && IsDescendant(FindFocus()))
      Close();
   else
      evt.Skip();
}

References BasicUI::FindFocus().

Referenced by RealtimeEffectPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

ResetTrack()

void RealtimeEffectPanel::ResetTrack

(

)

Definition at line 1327 of file RealtimeEffectPanel.cpp.

{
   mTrackTitle->SetLabel(wxEmptyString);
   mToggleEffects->Disable();
   mEffectList->ResetTrack();
   mCurrentTrack.reset();
   mHeader->SetName(wxEmptyString);
}

References AButton::Disable(), mCurrentTrack, mEffectList, mHeader, mToggleEffects, mTrackTitle, and RealtimeEffectListWindow::ResetTrack().

Referenced by SetTrack(), and ShowPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

SetFocus()

void RealtimeEffectPanel::SetFocus ( )

override

Definition at line 1336 of file RealtimeEffectPanel.cpp.

{
   mHeader->SetFocus();
}

References mHeader.

Referenced by ShowPanel().

Here is the caller graph for this function:

SetTrack()

void RealtimeEffectPanel::SetTrack

(

const std::shared_ptr< SampleTrack > &

track

)

Shows effects from the effect stack of the track.

Parameters

track

Pointer to the existing track, or null

Definition at line 1307 of file RealtimeEffectPanel.cpp.

{
   //Avoid creation-on-demand of a useless, empty list in case the track is of non-wave type.
   if(track && dynamic_cast<WaveTrack*>(&*track) != nullptr)
   {
      mTrackTitle->SetLabel(track->GetName());
      mToggleEffects->Enable();
      track && RealtimeEffectList::Get(*track).IsActive()
         ? mToggleEffects->PushDown()
         : mToggleEffects->PopUp();
      mEffectList->SetTrack(mProject, track);
 
      mCurrentTrack = track;
      //i18n-hint: argument - track name
      mHeader->SetName(wxString::Format(_("Realtime effects for %s"), track->GetName()));
   }
   else
      ResetTrack();
}

References _, AButton::Enable(), RealtimeEffectList::Get(), RealtimeEffectList::IsActive(), mCurrentTrack, mEffectList, mHeader, mProject, mToggleEffects, mTrackTitle, AButton::PopUp(), AButton::PushDown(), ResetTrack(), and RealtimeEffectListWindow::SetTrack().

Referenced by ShowPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

ShowPanel()

void RealtimeEffectPanel::ShowPanel	(	SampleTrack *	track,
		bool	focus
	)

Definition at line 1263 of file RealtimeEffectPanel.cpp.

{
   if(track == nullptr)
   {
      ResetTrack();
      return;
   }
 
   wxWindowUpdateLocker freeze(this);
 
   SetTrack(track->SharedPointer<SampleTrack>());
 
   auto &projectWindow = ProjectWindow::Get(mProject);
   const auto pContainerWindow = projectWindow.GetContainerWindow();
   if (pContainerWindow->GetWindow1() != this)
   {
      //Restore previous effects window size
      pContainerWindow->SplitVertically(
         this,
         projectWindow.GetTrackListWindow(),
         this->GetSize().GetWidth());
   }
   if(focus)
      SetFocus();
   projectWindow.Layout();
}

References ProjectWindow::Get(), mProject, ResetTrack(), SetFocus(), SetTrack(), and Track::SharedPointer().

Referenced by EffectsButtonHandle::CommitChanges(), and RealtimeEffectPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mCurrentTrack

std::weak_ptr<SampleTrack> RealtimeEffectPanel::mCurrentTrack

private

Definition at line 42 of file RealtimeEffectPanel.h.

Referenced by RealtimeEffectPanel(), ResetTrack(), and SetTrack().

mEffectList

RealtimeEffectListWindow* RealtimeEffectPanel::mEffectList {nullptr}

private

Definition at line 38 of file RealtimeEffectPanel.h.

Referenced by RealtimeEffectPanel(), ResetTrack(), and SetTrack().

mFocusChangeSubscription

Observer::Subscription RealtimeEffectPanel::mFocusChangeSubscription

private

Definition at line 46 of file RealtimeEffectPanel.h.

Referenced by RealtimeEffectPanel().

mHeader

wxWindow* RealtimeEffectPanel::mHeader {nullptr}

private

Definition at line 39 of file RealtimeEffectPanel.h.

Referenced by RealtimeEffectPanel(), ResetTrack(), SetFocus(), and SetTrack().

mPotentiallyRemovedTracks

std::vector<std::shared_ptr<SampleTrack> > RealtimeEffectPanel::mPotentiallyRemovedTracks

private

Definition at line 48 of file RealtimeEffectPanel.h.

Referenced by RealtimeEffectPanel().

mPrefsListenerHelper

std::unique_ptr<PrefsListenerHelper> RealtimeEffectPanel::mPrefsListenerHelper

private

Definition at line 53 of file RealtimeEffectPanel.h.

mProject

AudacityProject& RealtimeEffectPanel::mProject

private

Definition at line 40 of file RealtimeEffectPanel.h.

Referenced by HidePanel(), RealtimeEffectPanel(), SetTrack(), and ShowPanel().

mToggleEffects

AButton* RealtimeEffectPanel::mToggleEffects {nullptr}

private

Definition at line 36 of file RealtimeEffectPanel.h.

Referenced by RealtimeEffectPanel(), ResetTrack(), and SetTrack().

mTrackListChanged

Observer::Subscription RealtimeEffectPanel::mTrackListChanged

private

Definition at line 44 of file RealtimeEffectPanel.h.

Referenced by RealtimeEffectPanel().

mTrackTitle

wxStaticText* RealtimeEffectPanel::mTrackTitle {nullptr}

private

Definition at line 37 of file RealtimeEffectPanel.h.

Referenced by RealtimeEffectPanel(), ResetTrack(), and SetTrack().

mUndoSubscription

Observer::Subscription RealtimeEffectPanel::mUndoSubscription

private

Definition at line 45 of file RealtimeEffectPanel.h.

Referenced by RealtimeEffectPanel().

---

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

• RealtimeEffectPanel.h
• RealtimeEffectPanel.cpp