RealtimeEffectList Class Reference

#include <RealtimeEffectList.h>

Inheritance diagram for RealtimeEffectList:

Collaboration diagram for RealtimeEffectList:

Public Types
using	Lock = spinlock
using	States = std::vector< std::shared_ptr< RealtimeEffectState > >
Public Types inherited from ClientData::Cloneable< Owner >
using	Base = Cloneable
using	PointerType = Owner< Base >
Public Types inherited from Observer::Publisher< RealtimeEffectListMessage >
using	message_type = RealtimeEffectListMessage
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const RealtimeEffectListMessage &) >
	Type of functions that can be connected to the Publisher. More...

Public Member Functions
	RealtimeEffectList ()
virtual	~RealtimeEffectList ()
Lock &	GetLock () const
std::unique_ptr< ClientData::Cloneable<> >	Clone () const override
template<typename StateVisitor >
void	Visit (const StateVisitor &func)
	Apply the function to all states sequentially. More...
template<typename StateVisitor >
void	Visit (const StateVisitor &func) const
	Apply the function to all states sequentially. More...
bool	AddState (std::shared_ptr< RealtimeEffectState > pState)
bool	ReplaceState (size_t index, std::shared_ptr< RealtimeEffectState > pState)
void	RemoveState (std::shared_ptr< RealtimeEffectState > pState)
void	Clear ()
	Use only in the main thread. Sends Remove messages. More...
std::optional< size_t >	FindState (const std::shared_ptr< RealtimeEffectState > &pState) const
	Report the position of a state in the list. More...
size_t	GetStatesCount () const noexcept
std::shared_ptr< RealtimeEffectState >	GetStateAt (size_t index) noexcept
std::shared_ptr< const RealtimeEffectState >	GetStateAt (size_t index) const noexcept
void	MoveEffect (size_t fromIndex, size_t toIndex)
	Use only in the main thread. Changes effect order in the stack. Does nothing if fromIndex equals toIndex. Otherwise effects between fromIndex (exclusive) and toIndex are shifted towards fromIndex. Sends Move event. More...
bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs) override
XMLTagHandler *	HandleXMLChild (const std::string_view &tag) override
	Use only in the main thread. May add a state while deserializing. More...
void	WriteXML (XMLWriter &xmlFile) const
	Use only in the main thread, to avoid races. More...
void	RestoreUndoRedoState (AudacityProject &project) noexcept override
	Modify the project when undoing or redoing to some state in history. More...
bool	IsActive () const
	Non-blocking atomic boolean load. More...
void	SetActive (bool value)
	Done by main thread only, under a lock guard. More...
Public Member Functions inherited from ClientData::Base
virtual	~Base ()
Public Member Functions inherited from ClientData::Cloneable< Owner >
virtual	~Cloneable ()
virtual PointerType	Clone () const =0
Public Member Functions inherited from UndoStateExtension
virtual	~UndoStateExtension ()
virtual void	RestoreUndoRedoState (AudacityProject &project)=0
	Modify the project when undoing or redoing to some state in history. More...
virtual bool	CanUndoOrRedo (const AudacityProject &project)
	Whether undo or redo is now permitted; default returns true. More...
Public Member Functions inherited from XMLTagHandler
	XMLTagHandler ()
virtual	~XMLTagHandler ()
virtual bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs)=0
virtual void	HandleXMLEndTag (const std::string_view &WXUNUSED(tag))
virtual void	HandleXMLContent (const std::string_view &WXUNUSED(content))
virtual XMLTagHandler *	HandleXMLChild (const std::string_view &tag)=0
void	ReadXMLEndTag (const char *tag)
void	ReadXMLContent (const char *s, int len)
XMLTagHandler *	ReadXMLChild (const char *tag)
Public Member Functions inherited from Observer::Publisher< RealtimeEffectListMessage >
	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 RealtimeEffectList &	Get (AudacityProject &project)
static const RealtimeEffectList &	Get (const AudacityProject &project)
static RealtimeEffectList &	Set (AudacityProject &project, const std::shared_ptr< RealtimeEffectList > &list)
static RealtimeEffectList &	Get (Track &track)
static const RealtimeEffectList &	Get (const Track &track)
static const std::string &	XMLTag ()

Private Types
using	LockGuard = std::lock_guard< Lock >

Private Member Functions
	RealtimeEffectList (const RealtimeEffectList &)=delete
RealtimeEffectList &	operator= (const RealtimeEffectList &)=delete

Private Attributes
States	mStates
Lock	mLock
std::atomic< bool >	mActive { true }

Additional Inherited Members
Static Public Attributes inherited from Observer::Publisher< RealtimeEffectListMessage >
static constexpr bool	notifies_all
Protected Member Functions inherited from Observer::Publisher< RealtimeEffectListMessage >
CallbackReturn	Publish (const RealtimeEffectListMessage &message)
	Send a message to connected callbacks. More...

Detailed Description

Definition at line 44 of file RealtimeEffectList.h.

Member Typedef Documentation

Lock

using RealtimeEffectList::Lock = spinlock

Definition at line 58 of file RealtimeEffectList.h.

LockGuard

using RealtimeEffectList::LockGuard = std::lock_guard<Lock>

private

Definition at line 169 of file RealtimeEffectList.h.

States

using RealtimeEffectList::States = std::vector<std::shared_ptr<RealtimeEffectState> >

Definition at line 59 of file RealtimeEffectList.h.

Constructor & Destructor Documentation

RealtimeEffectList() [1/2]

RealtimeEffectList::RealtimeEffectList ( const RealtimeEffectList &  )

privatedelete

RealtimeEffectList() [2/2]

RealtimeEffectList::RealtimeEffectList

(

)

Definition at line 15 of file RealtimeEffectList.cpp.

{
}

~RealtimeEffectList()

RealtimeEffectList::~RealtimeEffectList ( )

virtual

Definition at line 19 of file RealtimeEffectList.cpp.

{
}

Member Function Documentation

AddState()

bool RealtimeEffectList::AddState

(

std::shared_ptr< RealtimeEffectState >

pState

)

Use only in the main thread Returns true for success. Sends Insert message on success.

Postcondition

result: !result || pState->GetEffect() != nullptr

Definition at line 81 of file RealtimeEffectList.cpp.

{
   const auto &id = pState->GetID();
   if (pState->GetEffect() != nullptr) {
      auto shallowCopy = mStates;
      shallowCopy.emplace_back(pState);
      // Lock for only a short time
      (LockGuard{ mLock }, swap(shallowCopy, mStates));
 
      Publisher<RealtimeEffectListMessage>::Publish({
         RealtimeEffectListMessage::Type::Insert,
         mStates.size() - 1,
         { },
         pState
      });
 
      return true;
   }
   else
      // Effect initialization failed for the id
      return false;
}

References RealtimeEffectListMessage::Insert, mLock, mStates, Observer::Publisher< RealtimeEffectListMessage >::Publish(), and anonymous_namespace{NoteTrack.cpp}::swap().

Here is the call graph for this function:

Clear()

void RealtimeEffectList::Clear

(

)

Use only in the main thread. Sends Remove messages.

Definition at line 162 of file RealtimeEffectList.cpp.

{
   decltype(mStates) temp;
   
   // Swap an empty list in as a whole, not removing one at a time
   // Lock for only a short time
   (LockGuard{ mLock }, swap(temp, mStates));
 
   for (auto index = temp.size(); index--;)
      Publisher<RealtimeEffectListMessage>::Publish(
         { RealtimeEffectListMessage::Type::Remove, index, {}, temp[index] });
}

References mLock, mStates, Observer::Publisher< RealtimeEffectListMessage >::Publish(), RealtimeEffectListMessage::Remove, and anonymous_namespace{NoteTrack.cpp}::swap().

Referenced by MixAndRender(), and EffectStereoToMono::ProcessOne().

Here is the call graph for this function:

Here is the caller graph for this function:

Clone()

std::unique_ptr< ClientData::Cloneable<> > RealtimeEffectList::Clone ( ) const

overridevirtual

Should be called (for pushing undo states) only from main thread, to avoid races

Implements ClientData::Cloneable< Owner >.

Definition at line 24 of file RealtimeEffectList.cpp.

{
   auto result = std::make_unique<RealtimeEffectList>();
   for (auto &pState : mStates)
      result->mStates.push_back(pState);
   result->SetActive(this->IsActive());
   return result;
}

References IsActive(), and mStates.

Here is the call graph for this function:

FindState()

std::optional< size_t > RealtimeEffectList::FindState

(

const std::shared_ptr< RealtimeEffectState > &

pState

)

const

Report the position of a state in the list.

Definition at line 175 of file RealtimeEffectList.cpp.

{
   const auto begin = mStates.begin()
      , end = mStates.end()
      , iter = std::find(begin, end, pState);
   if (iter == end)
      return {};
   return std::distance(begin, iter);
}

References PackedArray::begin(), PackedArray::end(), and mStates.

Here is the call graph for this function:

Get() [1/4]

RealtimeEffectList & RealtimeEffectList::Get ( AudacityProject &  project )

static

Definition at line 42 of file RealtimeEffectList.cpp.

{
   return project.AttachedObjects::Get<RealtimeEffectList>(masterEffects);
}

References masterEffects.

Referenced by RealtimeEffectManager::AllListsLock::AllListsLock(), RealtimeEffectListWindow::EnableEffects(), anonymous_namespace{RealtimeEffectManager.cpp}::FindStates(), Get(), GetEffectStages(), MixAndRender(), RealtimeEffectListWindow::OnEffectListItemChange(), anonymous_namespace{FileMenus.cpp}::OnOpen(), EffectStereoToMono::ProcessOne(), RealtimeEffectListWindow::RealtimeEffectListWindow(), RealtimeEffectListWindow::ReloadEffectsList(), RealtimeEffectManager::AllListsLock::Reset(), RealtimeEffectListWindow::SetTrack(), RealtimeEffectPanel::SetTrack(), RealtimeEffectManager::VisitAll(), RealtimeEffectManager::VisitGroup(), and anonymous_namespace{RealtimeEffectPanel.cpp}::VisitRealtimeEffectStateUIs().

Here is the caller graph for this function:

Get() [2/4]

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

static

Definition at line 55 of file RealtimeEffectList.cpp.

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

References Get().

Here is the call graph for this function:

Get() [3/4]

const RealtimeEffectList & RealtimeEffectList::Get ( const Track &  track )

static

Definition at line 75 of file RealtimeEffectList.cpp.

{
   return Get(const_cast<Track &>(track));
}

References Get().

Referenced by Get().

Here is the call graph for this function:

Here is the caller graph for this function:

Get() [4/4]

RealtimeEffectList & RealtimeEffectList::Get ( Track &  track )

static

Definition at line 69 of file RealtimeEffectList.cpp.

{
   return track.GetGroupData()
      .Track::ChannelGroupAttachments::Get<RealtimeEffectList>(trackEffects);
}

References Track::GetGroupData(), and trackEffects.

Here is the call graph for this function:

GetLock()

Lock & RealtimeEffectList::GetLock ( ) const

inline

Definition at line 64 of file RealtimeEffectList.h.

{ return mLock; }

Referenced by RealtimeEffectManager::AllListsLock::AllListsLock(), and RealtimeEffectManager::AllListsLock::Reset().

Here is the caller graph for this function:

GetStateAt() [1/2]

std::shared_ptr< const RealtimeEffectState > RealtimeEffectList::GetStateAt ( size_t  index ) const

noexcept

Returns effect state at given position Use only in the main thread, to avoid races

Definition at line 200 of file RealtimeEffectList.cpp.

{
   return const_cast<RealtimeEffectList*>(this)->GetStateAt(index);
}

GetStateAt() [2/2]

std::shared_ptr< RealtimeEffectState > RealtimeEffectList::GetStateAt ( size_t  index )

noexcept

Returns effect state at given position Use only in the main thread, to avoid races

Definition at line 192 of file RealtimeEffectList.cpp.

{
   if (index < mStates.size())
      return mStates[index];
   return nullptr;
}

GetStatesCount()

size_t RealtimeEffectList::GetStatesCount ( ) const

noexcept

Use only in the main thread, to avoid races Returns total number of effects in this list

Definition at line 186 of file RealtimeEffectList.cpp.

{
   return mStates.size();
}

References mStates.

Referenced by RealtimeEffectListWindow::ReloadEffectsList().

Here is the caller graph for this function:

HandleXMLChild()

XMLTagHandler * RealtimeEffectList::HandleXMLChild ( const std::string_view &  tag )

overridevirtual

Use only in the main thread. May add a state while deserializing.

Implements XMLTagHandler.

Definition at line 257 of file RealtimeEffectList.cpp.

{
   if (tag == RealtimeEffectState::XMLTag()) {
      mStates.push_back(RealtimeEffectState::make_shared(PluginID{}));
      return mStates.back().get();
   }
   return nullptr;
}

References SharedNonInterfering< RealtimeEffectState >::make_shared(), mStates, and RealtimeEffectState::XMLTag().

Here is the call graph for this function:

HandleXMLTag()

bool RealtimeEffectList::HandleXMLTag ( const std::string_view &  tag, const AttributesList &  attrs  )

overridevirtual

Implements XMLTagHandler.

Definition at line 244 of file RealtimeEffectList.cpp.

{
   if (tag == XMLTag()) {
      for (auto &[attr, value] : attrs) {
         if (attr == activeAttribute)
            SetActive(value.Get<bool>());
      }
      return true;
   }
   return false;
}

References activeAttribute, SetActive(), and XMLTag().

Here is the call graph for this function:

IsActive()

bool RealtimeEffectList::IsActive

(

)

const

Non-blocking atomic boolean load.

Definition at line 281 of file RealtimeEffectList.cpp.

{
   return mActive.load(std::memory_order_relaxed);
}

References mActive.

Referenced by Clone(), RealtimeEffectPanel::SetTrack(), and WriteXML().

Here is the caller graph for this function:

MoveEffect()

void RealtimeEffectList::MoveEffect	(	size_t	fromIndex,
		size_t	toIndex
	)

Use only in the main thread. Changes effect order in the stack. Does nothing if fromIndex equals toIndex. Otherwise effects between fromIndex (exclusive) and toIndex are shifted towards fromIndex. Sends Move event.

Parameters

fromIndex	Index of the moved effect
toIndex	Final position of the moved effect

Definition at line 205 of file RealtimeEffectList.cpp.

{
   assert(fromIndex < mStates.size());
   assert(toIndex < mStates.size());
 
   auto shallowCopy = mStates;
   if(fromIndex == toIndex)
      return;
   if(fromIndex < toIndex)
   {
      const auto first = shallowCopy.begin() + fromIndex;
      const auto last = shallowCopy.begin() + toIndex + 1;
      std::rotate(first, first + 1, last);
   }
   else
   {
      const auto first = shallowCopy.rbegin() + (shallowCopy.size() - (fromIndex + 1));
      const auto last = shallowCopy.rbegin() + (shallowCopy.size() - toIndex);
      std::rotate(first, first + 1, last);
   }
   // Lock for only a short time
   (LockGuard{ mLock }, swap(shallowCopy, mStates));
 
   Publisher<RealtimeEffectListMessage>::Publish({
      RealtimeEffectListMessage::Type::Move,
      fromIndex,
      toIndex,
      mStates[toIndex]
   });
}

References mLock, RealtimeEffectListMessage::Move, mStates, Observer::Publisher< RealtimeEffectListMessage >::Publish(), and anonymous_namespace{NoteTrack.cpp}::swap().

Here is the call graph for this function:

operator=()

RealtimeEffectList & RealtimeEffectList::operator= ( const RealtimeEffectList &  )

privatedelete

RemoveState()

void RealtimeEffectList::RemoveState

(

std::shared_ptr< RealtimeEffectState >

pState

)

Use only in the main thread On success sends Remove message.

Definition at line 139 of file RealtimeEffectList.cpp.

{
   auto shallowCopy = mStates;
   auto end = shallowCopy.end(),
      found = std::find(shallowCopy.begin(), end, pState);
   if (found != end)
   {      
      const auto index = std::distance(shallowCopy.begin(), found);
      shallowCopy.erase(found);
 
      // Lock for only a short time
      (LockGuard{ mLock }, swap(shallowCopy, mStates));
 
      Publisher<RealtimeEffectListMessage>::Publish({
         RealtimeEffectListMessage::Type::Remove,
         static_cast<size_t>(index),
         { },
         pState
      });
   }
}

References PackedArray::end(), mLock, mStates, Observer::Publisher< RealtimeEffectListMessage >::Publish(), RealtimeEffectListMessage::Remove, and anonymous_namespace{NoteTrack.cpp}::swap().

Here is the call graph for this function:

ReplaceState()

bool RealtimeEffectList::ReplaceState	(	size_t	index,
		std::shared_ptr< RealtimeEffectState >	pState
	)

Use only in the main thread Returns true for success. Sends Insert message on success.

Postcondition

result: !result || pState->GetEffect() != nullptr

Definition at line 105 of file RealtimeEffectList.cpp.

{
   if (index >= mStates.size())
      return false;
   const auto &id = pState->GetID();
   if (pState->GetEffect() != nullptr) {     
      auto shallowCopy = mStates;
 
      Publisher<RealtimeEffectListMessage>::Publish({
         RealtimeEffectListMessage::Type::WillReplace,
         index,
         { },
         shallowCopy[index]
      });
 
      swap(pState, shallowCopy[index]);
      // Lock for only a short time
      (LockGuard{ mLock }, swap(shallowCopy, mStates));
 
      Publisher<RealtimeEffectListMessage>::Publish({
         RealtimeEffectListMessage::Type::DidReplace,
         index,
         { },
         pState
      });
 
      return true;
   }
   else
      // Effect initialization failed for the id
      return false;
}

References RealtimeEffectListMessage::DidReplace, mLock, mStates, Observer::Publisher< RealtimeEffectListMessage >::Publish(), anonymous_namespace{NoteTrack.cpp}::swap(), and RealtimeEffectListMessage::WillReplace.

Here is the call graph for this function:

RestoreUndoRedoState()

void RealtimeEffectList::RestoreUndoRedoState ( AudacityProject &  project )

overridevirtualnoexcept

Modify the project when undoing or redoing to some state in history.

Implements UndoStateExtension.

Definition at line 275 of file RealtimeEffectList.cpp.

{
   // Restore per-project states
   Set(project, shared_from_this());
}

Set()

RealtimeEffectList & RealtimeEffectList::Set ( AudacityProject &  project, const std::shared_ptr< RealtimeEffectList > &  list  )

static

Definition at line 47 of file RealtimeEffectList.cpp.

{
   auto &result = *list;
   project.AttachedObjects::Assign(masterEffects, list);
   return result;
}

References masterEffects.

SetActive()

void RealtimeEffectList::SetActive

(

bool

value

)

Done by main thread only, under a lock guard.

Definition at line 286 of file RealtimeEffectList.cpp.

{
   (LockGuard{ mLock }, mActive.store(value, std::memory_order_relaxed));
}

References mActive, and mLock.

Referenced by RealtimeEffectListWindow::EnableEffects(), and HandleXMLTag().

Here is the caller graph for this function:

Visit() [1/2]

template<typename StateVisitor >

void RealtimeEffectList::Visit ( const StateVisitor &  func )

inline

Apply the function to all states sequentially.

Definition at line 86 of file RealtimeEffectList.h.

   {
      for (auto &state : mStates)
         func(*state, IsActive());
   }

Referenced by RealtimeEffectManager::VisitAll(), and RealtimeEffectManager::VisitGroup().

Here is the caller graph for this function:

Visit() [2/2]

template<typename StateVisitor >

void RealtimeEffectList::Visit ( const StateVisitor &  func ) const

inline

Apply the function to all states sequentially.

Definition at line 94 of file RealtimeEffectList.h.

   {
      for (const auto &state : mStates)
         func(*state, IsActive());
   }

WriteXML()

void RealtimeEffectList::WriteXML

(

XMLWriter &

xmlFile

)

const

Use only in the main thread, to avoid races.

Definition at line 266 of file RealtimeEffectList.cpp.

{
   xmlFile.StartTag(XMLTag());
   xmlFile.WriteAttr(activeAttribute, IsActive());
   for (const auto & state : mStates)
      state->WriteXML(xmlFile);
   xmlFile.EndTag(XMLTag());
}

References activeAttribute, XMLWriter::EndTag(), IsActive(), mStates, XMLWriter::StartTag(), XMLWriter::WriteAttr(), and XMLTag().

Here is the call graph for this function:

XMLTag()

const std::string & RealtimeEffectList::XMLTag ( )

static

Definition at line 236 of file RealtimeEffectList.cpp.

{
   static const std::string result{"effects"};
   return result;
}

Referenced by HandleXMLTag(), and WriteXML().

Here is the caller graph for this function:

Member Data Documentation

mActive

std::atomic<bool> RealtimeEffectList::mActive { true }

private

Definition at line 172 of file RealtimeEffectList.h.

Referenced by IsActive(), and SetActive().

mLock

Lock RealtimeEffectList::mLock

mutableprivate

Definition at line 170 of file RealtimeEffectList.h.

Referenced by AddState(), Clear(), MoveEffect(), RemoveState(), ReplaceState(), and SetActive().

mStates

States RealtimeEffectList::mStates

private

Definition at line 167 of file RealtimeEffectList.h.

Referenced by AddState(), Clear(), Clone(), FindState(), GetStatesCount(), HandleXMLChild(), MoveEffect(), RemoveState(), ReplaceState(), and WriteXML().

---

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

• RealtimeEffectList.h
• RealtimeEffectList.cpp