ProjectAudioManager.h File Reference

#include <memory>
#include <vector>
#include "AudioIOListener.h"
#include "ClientData.h"
#include <wx/event.h>
#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
class	ProjectAudioManager
struct	PropertiesOfSelected

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

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

Functions
AUDACITY_DLL_API AudioIOStartStreamOptions	DefaultPlayOptions (AudacityProject &project, bool looped=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 29 of file ProjectAudioManager.h.

Enumeration Type Documentation

PlayMode

enum PlayMode : int

strong

Enumerator
normalPlay
oneSecondPlay
loopedPlay
cutPreviewPlay

Definition at line 31 of file ProjectAudioManager.h.

                    : int {
   normalPlay,
   oneSecondPlay, // Disables auto-scrolling
   loopedPlay, // Disables auto-scrolling
   cutPreviewPlay
};

Function Documentation

CanStopAudioStreamFlag()

AUDACITY_DLL_API const ReservedCommandFlag& CanStopAudioStreamFlag

(

)

Definition at line 1153 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	looped = false
	)

Definition at line 1162 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();
   auto timeTrack = *TrackList::Get( project ).Any<TimeTrack>().begin();
   options.envelope = timeTrack ? timeTrack->GetEnvelope() : nullptr;
   options.listener = ProjectAudioManager::Get( project ).shared_from_this();
   
   if (looped)
      options.policyFactory = []() -> std::unique_ptr<PlaybackPolicy> {
         return std::make_unique<LoopingPlaybackPolicy>(); };
   return options;
}

References TrackList::Any(), ProjectRate::Get(), ProjectAudioIO::Get(), ProjectAudioManager::Get(), TrackList::Get(), and ProjectRate::GetRate().

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(), Effect::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 1180 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 1311 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:

Variable Documentation

RATE_NOT_SELECTED

constexpr int RATE_NOT_SELECTED { -1 }

constexpr

Definition at line 21 of file ProjectAudioManager.h.

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