ProjectAudioManager.h File Reference

#include <memory>
#include <vector>
#include "AudioIOListener.h"
#include "ClientData.h"
#include <wx/event.h>
#include <atomic>
#include "commands/CommandFlag.h"

Include dependency graph for ProjectAudioManager.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	RecordingDropoutEvent
	Notification, posted on the project, after recording has stopped, when dropouts have been detected. More...
class	ProjectAudioManager
struct	PropertiesOfSelected

Typedefs
using	WaveTrackArray = std::vector< std::shared_ptr< WaveTrack > >

Enumerations
enum class	PlayMode : int { normalPlay , oneSecondPlay , loopedPlay , cutPreviewPlay }

Functions
	wxDECLARE_EXPORTED_EVENT (AUDACITY_DLL_API, EVT_RECORDING_DROPOUT, RecordingDropoutEvent)
AUDACITY_DLL_API AudioIOStartStreamOptions	DefaultPlayOptions (AudacityProject &project, bool newDefault=false)
AudioIOStartStreamOptions	DefaultSpeedPlayOptions (AudacityProject &project)
AUDACITY_DLL_API PropertiesOfSelected	GetPropertiesOfSelected (const AudacityProject &proj)
AUDACITY_DLL_API const ReservedCommandFlag &	CanStopAudioStreamFlag ()

Variables
constexpr int	RATE_NOT_SELECTED { -1 }

Typedef Documentation

WaveTrackArray

using WaveTrackArray = std::vector < std::shared_ptr < WaveTrack > >

Definition at line 31 of file ProjectAudioManager.h.

Enumeration Type Documentation

PlayMode

enum class PlayMode : int

strong

Enumerator
normalPlay
oneSecondPlay
loopedPlay
cutPreviewPlay

Definition at line 33 of file ProjectAudioManager.h.

                    : int {
   normalPlay,
   oneSecondPlay, // Disables auto-scrolling
   loopedPlay, // Possibly looped play (not always); disables auto-scrolling
   cutPreviewPlay
};

Function Documentation

CanStopAudioStreamFlag()

AUDACITY_DLL_API const ReservedCommandFlag & CanStopAudioStreamFlag

(

)

Definition at line 1150 of file ProjectAudioManager.cpp.

                           { static ReservedCommandFlag flag{
      [](const AudacityProject &project){
         auto &projectAudioManager = ProjectAudioManager::Get( project );
         bool canStop = projectAudioManager.CanStopAudioStream();
         return canStop;
      }
   }; return flag; }

References flag, and ProjectAudioManager::Get().

Referenced by anonymous_namespace{SelectMenus.cpp}::CursorMenu(), ProjectAudioManager::DoRecord(), anonymous_namespace{TransportMenus.cpp}::ExtraTransportMenu(), and anonymous_namespace{TransportMenus.cpp}::TransportMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

DefaultPlayOptions()

AUDACITY_DLL_API AudioIOStartStreamOptions DefaultPlayOptions	(	AudacityProject &	project,
		bool	newDefault = false
	)

Parameters

newDefault

"new" default playback policy adjusts to changes of the looping region, "old" default plays once straight

Definition at line 1159 of file ProjectAudioManager.cpp.

{
   auto &projectAudioIO = 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 = ProjectAudioManager::Get( project ).shared_from_this();
   
   bool loopEnabled = ViewInfo::Get(project).playRegion.Active();
   options.loopEnabled = loopEnabled;
 
   if (newDefault) {
      const double trackEndTime = TrackList::Get(project).GetEndTime();
      const double loopEndTime = ViewInfo::Get(project).playRegion.GetEnd();
      options.policyFactory = [&project, trackEndTime, loopEndTime](
         const AudioIOStartStreamOptions &options)
            -> std::unique_ptr<PlaybackPolicy>
      {
         return std::make_unique<NewDefaultPlaybackPolicy>( project,
            trackEndTime, loopEndTime,
            options.loopEnabled, options.variableSpeed);
      };
 
      // Start play from left edge of selection
      options.pStartTime.emplace(ViewInfo::Get(project).selectedRegion.t0());
   }
 
   return options;
}

References PlayRegion::Active(), GlobalHook< DefaultWarp, const BoundedEnvelope *(const TrackList &) >::Call(), ProjectRate::Get(), ViewInfo::Get(), TrackList::Get(), ProjectAudioIO::Get(), ProjectAudioManager::Get(), PlayRegion::GetEnd(), TrackList::GetEndTime(), ProjectRate::GetRate(), and ViewInfo::playRegion.

Referenced by DefaultSpeedPlayOptions(), EffectUIHost::OnPlay(), TransportActions::Handler::OnPlayAfterSelectionEnd(), TransportActions::Handler::OnPlayAfterSelectionStart(), TransportActions::Handler::OnPlayBeforeAndAfterSelectionEnd(), TransportActions::Handler::OnPlayBeforeAndAfterSelectionStart(), TransportActions::Handler::OnPlayBeforeSelectionEnd(), TransportActions::Handler::OnPlayBeforeSelectionStart(), TransportActions::Handler::OnPlayOneSecond(), TransportActions::Handler::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:

DefaultSpeedPlayOptions()

AudioIOStartStreamOptions DefaultSpeedPlayOptions

(

AudacityProject &

project

)

Definition at line 1192 of file ProjectAudioManager.cpp.

{
   auto result = DefaultPlayOptions( project );
   auto gAudioIO = AudioIO::Get();
   auto PlayAtSpeedRate = gAudioIO->GetBestRate(
      false,     //not capturing
      true,      //is playing
      ProjectRate::Get( project ).GetRate()  //suggested rate
   );
   result.rate = PlayAtSpeedRate;
   return result;
}

References DefaultPlayOptions(), AudioIO::Get(), ProjectRate::Get(), and anonymous_namespace{TimeTrack.cpp}::GetRate().

Here is the call graph for this function:

GetPropertiesOfSelected()

AUDACITY_DLL_API PropertiesOfSelected GetPropertiesOfSelected

(

const AudacityProject &

proj

)

Definition at line 1323 of file ProjectAudioManager.cpp.

{
   double rateOfSelection{ RATE_NOT_SELECTED };
 
   PropertiesOfSelected result;
   result.allSameRate = true;
 
   const auto selectedTracks{ 
      TrackList::Get(proj).Selected< const WaveTrack >() };
 
   for (const auto & track : selectedTracks) 
   {
      if (rateOfSelection != RATE_NOT_SELECTED &&
         track->GetRate() != rateOfSelection)
         result.allSameRate = false;
      else if (rateOfSelection == RATE_NOT_SELECTED)
         rateOfSelection = track->GetRate();
   }
 
   result.numberOfSelected = selectedTracks.size();
   result.rateOfSelected = rateOfSelection;
 
   return  result;
}

References PropertiesOfSelected::allSameRate, TrackList::Get(), PropertiesOfSelected::numberOfSelected, RATE_NOT_SELECTED, PropertiesOfSelected::rateOfSelected, and TrackList::Selected().

Referenced by ProjectAudioManager::OnRecord(), and TransportActions::Handler::OnTimerRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

wxDECLARE_EXPORTED_EVENT()

wxDECLARE_EXPORTED_EVENT	(	AUDACITY_DLL_API	,
		EVT_RECORDING_DROPOUT	,
		RecordingDropoutEvent
	)

Variable Documentation

RATE_NOT_SELECTED

constexpr int RATE_NOT_SELECTED { -1 }

constexpr

Definition at line 23 of file ProjectAudioManager.h.

Referenced by ProjectAudioManager::ChooseExistingRecordingTracks(), GetPropertiesOfSelected(), and ProjectAudioManager::OnRecord().