ProjectAudioIO Class Reference

#include <ProjectAudioIO.h>

Inheritance diagram for ProjectAudioIO:

Collaboration diagram for ProjectAudioIO:

Classes
struct	DefaultOptions

Public Types
using	OptionsFactory = AudioIOStartStreamOptions(AudacityProject &project, bool newDefaults)
	Type of function constructing AudioIOStartStreamOptions. More...
Public Types inherited from Observer::Publisher< SpeedChangeMessage >
using	message_type = SpeedChangeMessage
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const SpeedChangeMessage &) >
	Type of functions that can be connected to the Publisher. More...

Public Member Functions
	ProjectAudioIO (AudacityProject &project)
	ProjectAudioIO (const ProjectAudioIO &)=delete
ProjectAudioIO &	operator= (const ProjectAudioIO &)=delete
	~ProjectAudioIO ()
int	GetAudioIOToken () const
bool	IsAudioActive () const
void	SetAudioIOToken (int token)
const std::shared_ptr< Meter > &	GetPlaybackMeter () const
void	SetPlaybackMeter (const std::shared_ptr< Meter > &playback)
const std::shared_ptr< Meter > &	GetCaptureMeter () const
void	SetCaptureMeter (const std::shared_ptr< Meter > &capture)
double	GetPlaySpeed () const
void	SetPlaySpeed (double value)
Public Member Functions inherited from ClientData::Base
virtual	~Base ()
Public Member Functions inherited from Observer::Publisher< SpeedChangeMessage >
	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 const std::function< OptionsFactory >	DefaultOptionsFactory ()
static AudioIOStartStreamOptions	GetDefaultOptions (AudacityProject &project, bool newDefaults=false)
	Invoke the global hook, supplying a default argument. More...
static ProjectAudioIO &	Get (AudacityProject &project)
static const ProjectAudioIO &	Get (const AudacityProject &project)

Private Attributes
AudacityProject &	mProject
std::shared_ptr< Meter >	mPlaybackMeter
std::shared_ptr< Meter >	mCaptureMeter
std::atomic< double >	mPlaySpeed {}
int	mAudioIOToken { -1 }

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

Detailed Description

\ brief Holds per-project state needed for interaction with AudioIO, including the audio stream token and pointers to meters

Definition at line 29 of file ProjectAudioIO.h.

Member Typedef Documentation

OptionsFactory

using ProjectAudioIO::OptionsFactory = AudioIOStartStreamOptions( AudacityProject &project, bool newDefaults)

Type of function constructing AudioIOStartStreamOptions.

Definition at line 35 of file ProjectAudioIO.h.

Constructor & Destructor Documentation

ProjectAudioIO() [1/2]

ProjectAudioIO::ProjectAudioIO ( AudacityProject &  project )

explicit

Definition at line 57 of file ProjectAudioIO.cpp.

: mProject{ project }
{
}

ProjectAudioIO() [2/2]

ProjectAudioIO::ProjectAudioIO ( const ProjectAudioIO &  )

delete

~ProjectAudioIO()

ProjectAudioIO::~ProjectAudioIO

(

)

Definition at line 62 of file ProjectAudioIO.cpp.

{
}

Member Function Documentation

DefaultOptionsFactory()

const std::function< ProjectAudioIO::OptionsFactory > ProjectAudioIO::DefaultOptionsFactory ( )

static

Function returning a default factory function, which ignores the second argument

Definition at line 20 of file ProjectAudioIO.cpp.

{ return [] (AudacityProject &project, bool) {
   auto &projectAudioIO = Get(project);
   AudioIOStartStreamOptions options{
      project.shared_from_this(), ProjectRate::Get(project).GetRate()
   };
   options.captureMeter = projectAudioIO.GetCaptureMeter();
   options.playbackMeter = projectAudioIO.GetPlaybackMeter();
   options.envelope =
      Mixer::WarpOptions::DefaultWarp::Call(TrackList::Get(project));
   // options.listener remains null
   // boolean argument is ignored
   return options;
}; }

References GlobalHook< DefaultWarp, const BoundedEnvelope *(const TrackList &) >::Call(), Get(), ProjectRate::Get(), TrackList::Get(), and ProjectRate::GetRate().

Here is the call graph for this function:

Get() [1/2]

ProjectAudioIO & ProjectAudioIO::Get ( AudacityProject &  project )

static

Definition at line 47 of file ProjectAudioIO.cpp.

{
   return project.AttachedObjects::Get< ProjectAudioIO >( sAudioIOKey );
}

References sAudioIOKey.

Referenced by AudioIOBusyPred(), StretchHandle::Click(), CutlineHandle::Click(), SampleHandle::Click(), WaveClipTrimHandle::Click(), EnvelopeHandle::Click(), SelectHandle::Click(), TimeShiftHandle::Click(), TrackSelectHandle::Click(), SelectButtonHandle::CommitChanges(), CloseButtonHandle::CommitChanges(), DefaultOptionsFactory(), anonymous_namespace{SelectMenus.cpp}::DoBoundaryMove(), anonymous_namespace{SelectMenus.cpp}::DoCursorMove(), anonymous_namespace{TransportMenus.cpp}::DoMoveToLabel(), ProjectAudioManager::DoPlayStopSelect(), ProjectAudioManager::DoRecord(), TransportUtilities::DoStopPlaying(), StretchHandle::Drag(), SampleHandle::Drag(), EnvelopeHandle::Drag(), TimeShiftHandle::Drag(), TrackSelectHandle::Drag(), MeterToolBar::Expose(), Get(), DefaultPlaybackPolicy::GetPlaySpeed(), LabelGlyphHandle::HandleGlyphDragRelease(), anonymous_namespace{AdornedRulerPanel.cpp}::PlayheadHandle::HitTest(), anonymous_namespace{WaveTrackControls.cpp}::initFn(), DefaultPlaybackPolicy::Initialize(), TrackPanel::IsAudioActive(), anonymous_namespace{TransportMenus.cpp}::MakeReadyToPlay(), Scrubber::MarkScrubStart(), ProjectWindow::MayScrollBeyondZero(), anonymous_namespace{LabelMenus.cpp}::OnAddLabelPlaying(), ProjectAudioManager::OnAudioIOStopRecording(), ProjectManager::OnCloseWindow(), SelectActions::Handler::OnCursorPositionStore(), SelectionBar::OnIdle(), TimeToolBar::OnIdle(), AudacityApp::OnKeyDown(), anonymous_namespace{SelectMenus.cpp}::OnlyHandleKeyUp(), SelectActions::Handler::OnSelectCursorStoredCursor(), SelectUtilities::OnSetRegion(), ProjectWindow::PlaybackScroller::OnTimer(), LyricsWindow::OnTimer(), MixerBoard::OnTimer(), PlayIndicatorOverlay::OnTimer(), ProjectManager::OnTimer(), TrackPanel::OnTimer(), anonymous_namespace{TrackMenus.cpp}::OnTrackClose(), ProjectAudioManager::PlayPlayRegion(), WaveClipTrimHandle::Preview(), AffordanceHandle::Preview(), StretchHandle::Preview(), CutlineHandle::Preview(), SampleHandle::Preview(), EnvelopeHandle::Preview(), TimeShiftHandle::Preview(), TrackSelectHandle::Preview(), MeterToolBar::ReCreateButtons(), StretchHandle::Release(), SampleHandle::Release(), EnvelopeHandle::Release(), TimeShiftHandle::Release(), anonymous_namespace{SelectMenus.cpp}::SeekLeftOrRight(), TranscriptionToolBar::SetPlaySpeed(), ProjectAudioManager::Stop(), AdornedRulerPanel::ScrubbingRulerOverlay::Update(), and ProjectWindow::ZoomInByFactor().

Get() [2/2]

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

static

Definition at line 52 of file ProjectAudioIO.cpp.

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

References Get().

Here is the call graph for this function:

GetAudioIOToken()

int ProjectAudioIO::GetAudioIOToken

(

)

const

Definition at line 66 of file ProjectAudioIO.cpp.

{
   return mAudioIOToken;
}

References mAudioIOToken.

Referenced by ProjectAudioManager::DoPlayStopSelect(), TransportUtilities::DoStopPlaying(), IsAudioActive(), anonymous_namespace{TransportMenus.cpp}::MakeReadyToPlay(), anonymous_namespace{LabelMenus.cpp}::OnAddLabelPlaying(), AudacityApp::OnKeyDown(), SelectUtilities::OnSetRegion(), and ProjectWindow::ZoomInByFactor().

Here is the caller graph for this function:

GetCaptureMeter()

const std::shared_ptr< Meter > & ProjectAudioIO::GetCaptureMeter

(

)

const

Definition at line 100 of file ProjectAudioIO.cpp.

{
   return mCaptureMeter;
}

References mCaptureMeter.

GetDefaultOptions()

AudioIOStartStreamOptions ProjectAudioIO::GetDefaultOptions ( AudacityProject &  project, bool  newDefaults = false  )

static

Invoke the global hook, supplying a default argument.

Parameters

newDefaults

if true, policy is meant to respond to looping region; but specifying that is outside this library's scope

Definition at line 35 of file ProjectAudioIO.cpp.

{
   return DefaultOptions::Call(project, newDefaults);
}

References GlobalHook< DefaultOptions, OptionsFactory, DefaultOptionsFactory >::Call().

Referenced by DefaultSpeedPlayOptions(), EffectUIHost::OnPlay(), anonymous_namespace{TransportMenus.cpp}::OnPlayAfterSelectionEnd(), anonymous_namespace{TransportMenus.cpp}::OnPlayAfterSelectionStart(), anonymous_namespace{TransportMenus.cpp}::OnPlayBeforeAndAfterSelectionEnd(), anonymous_namespace{TransportMenus.cpp}::OnPlayBeforeAndAfterSelectionStart(), anonymous_namespace{TransportMenus.cpp}::OnPlayBeforeSelectionEnd(), anonymous_namespace{TransportMenus.cpp}::OnPlayBeforeSelectionStart(), anonymous_namespace{TransportMenus.cpp}::OnPlayOneSecond(), anonymous_namespace{TransportMenus.cpp}::OnPlayToSelection(), ProjectAudioManager::OnRecord(), TranscriptionToolBar::PlayAtSpeed(), ProjectAudioManager::PlayCurrentRegion(), EffectBase::Preview(), MeterPanel::StartMonitoring(), and AdornedRulerPanel::StartQPPlay().

Here is the call graph for this function:

Here is the caller graph for this function:

GetPlaybackMeter()

const std::shared_ptr< Meter > & ProjectAudioIO::GetPlaybackMeter

(

)

const

Definition at line 83 of file ProjectAudioIO.cpp.

{
   return mPlaybackMeter;
}

References mPlaybackMeter.

GetPlaySpeed()

double ProjectAudioIO::GetPlaySpeed ( ) const

inline

Definition at line 78 of file ProjectAudioIO.h.

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

Referenced by DefaultPlaybackPolicy::GetPlaySpeed(), and SetPlaySpeed().

Here is the caller graph for this function:

IsAudioActive()

bool ProjectAudioIO::IsAudioActive

(

)

const

Definition at line 76 of file ProjectAudioIO.cpp.

{
   auto gAudioIO = AudioIOBase::Get();
   return GetAudioIOToken() > 0 &&
      gAudioIO->IsStreamActive(GetAudioIOToken());
}

References AudioIOBase::Get(), and GetAudioIOToken().

Referenced by StretchHandle::Click(), CutlineHandle::Click(), SampleHandle::Click(), WaveClipTrimHandle::Click(), EnvelopeHandle::Click(), SelectHandle::Click(), TimeShiftHandle::Click(), TrackSelectHandle::Click(), SelectButtonHandle::CommitChanges(), CloseButtonHandle::CommitChanges(), anonymous_namespace{SelectMenus.cpp}::DoBoundaryMove(), StretchHandle::Drag(), SampleHandle::Drag(), EnvelopeHandle::Drag(), TimeShiftHandle::Drag(), TrackSelectHandle::Drag(), LabelGlyphHandle::HandleGlyphDragRelease(), anonymous_namespace{AdornedRulerPanel.cpp}::PlayheadHandle::HitTest(), anonymous_namespace{WaveTrackControls.cpp}::initFn(), TrackPanel::IsAudioActive(), ProjectWindow::MayScrollBeyondZero(), SelectActions::Handler::OnCursorPositionStore(), anonymous_namespace{SelectMenus.cpp}::OnlyHandleKeyUp(), SelectActions::Handler::OnSelectCursorStoredCursor(), ProjectWindow::PlaybackScroller::OnTimer(), LyricsWindow::OnTimer(), MixerBoard::OnTimer(), PlayIndicatorOverlay::OnTimer(), anonymous_namespace{TrackMenus.cpp}::OnTrackClose(), WaveClipTrimHandle::Preview(), AffordanceHandle::Preview(), StretchHandle::Preview(), CutlineHandle::Preview(), SampleHandle::Preview(), EnvelopeHandle::Preview(), TimeShiftHandle::Preview(), TrackSelectHandle::Preview(), StretchHandle::Release(), SampleHandle::Release(), EnvelopeHandle::Release(), TimeShiftHandle::Release(), and AdornedRulerPanel::ScrubbingRulerOverlay::Update().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

ProjectAudioIO & ProjectAudioIO::operator= ( const ProjectAudioIO &  )

delete

SetAudioIOToken()

void ProjectAudioIO::SetAudioIOToken

(

int

token

)

Definition at line 71 of file ProjectAudioIO.cpp.

{
   mAudioIOToken = token;
}

References mAudioIOToken.

Referenced by ProjectAudioManager::DoRecord(), Scrubber::MarkScrubStart(), and ProjectAudioManager::PlayPlayRegion().

Here is the caller graph for this function:

SetCaptureMeter()

void ProjectAudioIO::SetCaptureMeter

(

const std::shared_ptr< Meter > &

capture

)

Definition at line 105 of file ProjectAudioIO.cpp.

{
   auto &project = mProject;
   mCaptureMeter = capture;
 
   auto gAudioIO = AudioIOBase::Get();
   if (gAudioIO)
   {
      gAudioIO->SetCaptureMeter( project.shared_from_this(), mCaptureMeter );
   }
}

References AudioIOBase::Get(), mCaptureMeter, and mProject.

Here is the call graph for this function:

SetPlaybackMeter()

void ProjectAudioIO::SetPlaybackMeter

(

const std::shared_ptr< Meter > &

playback

)

Definition at line 88 of file ProjectAudioIO.cpp.

{
   auto &project = mProject;
   mPlaybackMeter = playback;
   auto gAudioIO = AudioIOBase::Get();
   if (gAudioIO)
   {
      gAudioIO->SetPlaybackMeter( project.shared_from_this() , mPlaybackMeter );
   }
}

References AudioIOBase::Get(), mPlaybackMeter, and mProject.

Here is the call graph for this function:

SetPlaySpeed()

void ProjectAudioIO::SetPlaySpeed

(

double

value

)

Definition at line 118 of file ProjectAudioIO.cpp.

{
   if (auto oldValue = GetPlaySpeed(); value != oldValue) {
      mPlaySpeed.store( value, std::memory_order_relaxed );
      Publish({});
   }
}

References GetPlaySpeed(), mPlaySpeed, and Observer::Publisher< SpeedChangeMessage >::Publish().

Referenced by TranscriptionToolBar::SetPlaySpeed().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mAudioIOToken

int ProjectAudioIO::mAudioIOToken { -1 }

private

Definition at line 93 of file ProjectAudioIO.h.

Referenced by GetAudioIOToken(), and SetAudioIOToken().

mCaptureMeter

std::shared_ptr<Meter> ProjectAudioIO::mCaptureMeter

private

Definition at line 87 of file ProjectAudioIO.h.

Referenced by GetCaptureMeter(), and SetCaptureMeter().

mPlaybackMeter

std::shared_ptr<Meter> ProjectAudioIO::mPlaybackMeter

private

Definition at line 86 of file ProjectAudioIO.h.

Referenced by GetPlaybackMeter(), and SetPlaybackMeter().

mPlaySpeed

std::atomic<double> ProjectAudioIO::mPlaySpeed {}

private

Definition at line 91 of file ProjectAudioIO.h.

Referenced by SetPlaySpeed().

mProject

AudacityProject& ProjectAudioIO::mProject

private

Definition at line 83 of file ProjectAudioIO.h.

Referenced by SetCaptureMeter(), and SetPlaybackMeter().

---

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

• ProjectAudioIO.h
• ProjectAudioIO.cpp