RealtimeEffects::ProcessingScope Class Reference

Brackets one block of processing in one thread. More...

#include <RealtimeEffectManager.h>

Collaboration diagram for RealtimeEffects::ProcessingScope:

Public Member Functions
	ProcessingScope ()
	ProcessingScope (InitializationScope &, std::weak_ptr< AudacityProject > wProject)
	Require a prior InializationScope to ensure correct nesting. More...
	ProcessingScope (ProcessingScope &&other)=default
ProcessingScope &	operator= (ProcessingScope &&other)=default
	~ProcessingScope ()
size_t	Process (const ChannelGroup &group, float *const *buffers, float *const *scratch, float *dummy, unsigned nBuffers, size_t numSamples)

Private Attributes
RealtimeEffectManager::AllListsLock	mLocks
std::weak_ptr< AudacityProject >	mwProject
bool	mSuspended {}

Detailed Description

Brackets one block of processing in one thread.

Definition at line 258 of file RealtimeEffectManager.h.

Constructor & Destructor Documentation

ProcessingScope() [1/3]

RealtimeEffects::ProcessingScope::ProcessingScope ( )

inline

Definition at line 260 of file RealtimeEffectManager.h.

   {
      if (auto pProject = mwProject.lock()) {
         auto &manager = RealtimeEffectManager::Get(*pProject);
         mLocks = { &manager };
         mSuspended = manager.GetSuspended();
      }
   }

References RealtimeEffectManager::Get(), manager, mLocks, mSuspended, and mwProject.

Here is the call graph for this function:

ProcessingScope() [2/3]

RealtimeEffects::ProcessingScope::ProcessingScope ( InitializationScope &  , std::weak_ptr< AudacityProject >  wProject  )

inlineexplicit

Require a prior InializationScope to ensure correct nesting.

Definition at line 269 of file RealtimeEffectManager.h.

      : mwProject{ move(wProject) }
   {
      if (auto pProject = mwProject.lock())
         RealtimeEffectManager::Get(*pProject).ProcessStart(mSuspended);
   }

References RealtimeEffectManager::Get(), mSuspended, mwProject, and RealtimeEffectManager::ProcessStart().

Here is the call graph for this function:

ProcessingScope() [3/3]

RealtimeEffects::ProcessingScope::ProcessingScope ( ProcessingScope &&  other )

default

~ProcessingScope()

RealtimeEffects::ProcessingScope::~ProcessingScope ( )

inline

Definition at line 278 of file RealtimeEffectManager.h.

   {
      if (auto pProject = mwProject.lock())
         RealtimeEffectManager::Get(*pProject).ProcessEnd(mSuspended);
   }

References RealtimeEffectManager::Get(), mSuspended, mwProject, and RealtimeEffectManager::ProcessEnd().

Here is the call graph for this function:

Member Function Documentation

operator=()

ProcessingScope & RealtimeEffects::ProcessingScope::operator= ( ProcessingScope &&  other )

default

Process()

size_t RealtimeEffects::ProcessingScope::Process ( const ChannelGroup &  group, float *const *  buffers, float *const *  scratch, float *  dummy, unsigned  nBuffers, size_t  numSamples  )

inline

Returns

how many samples to discard for latency

Parameters

nBuffers	how many buffers; equal number of scratches
numSamples	length of each buffer

Definition at line 285 of file RealtimeEffectManager.h.

   {
      if (auto pProject = mwProject.lock())
         return RealtimeEffectManager::Get(*pProject)
            .Process(mSuspended, group, buffers, scratch, dummy,
               nBuffers, numSamples);
      else
         return 0; // consider them trivially processed
   }

References RealtimeEffectManager::Get(), mSuspended, mwProject, and RealtimeEffectManager::Process().

Here is the call graph for this function:

Member Data Documentation

mLocks

RealtimeEffectManager::AllListsLock RealtimeEffects::ProcessingScope::mLocks

private

Definition at line 302 of file RealtimeEffectManager.h.

Referenced by ProcessingScope().

mSuspended

bool RealtimeEffects::ProcessingScope::mSuspended {}

private

Definition at line 304 of file RealtimeEffectManager.h.

Referenced by Process(), ProcessingScope(), and ~ProcessingScope().

mwProject

std::weak_ptr<AudacityProject> RealtimeEffects::ProcessingScope::mwProject

private

Definition at line 303 of file RealtimeEffectManager.h.

Referenced by Process(), ProcessingScope(), and ~ProcessingScope().

---

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

• RealtimeEffectManager.h