ProjectAudioManager.h File Reference

#include <memory>
#include <vector>
#include "AudioIOListener.h"
#include "ClientData.h"
#include "Observer.h"
#include <atomic>
#include "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, after recording has stopped, when dropouts have been detected. More...
class	ProjectAudioManager
struct	PropertiesOfSelected

Typedefs
using	WritableSampleTrackArray = std::vector< std::shared_ptr< WritableSampleTrack > >

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

Functions
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

WritableSampleTrackArray

using WritableSampleTrackArray = std::vector< std::shared_ptr< WritableSampleTrack > >

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 34 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 1186 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, ProjectAudioManager::Get(), and project.

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:

DefaultSpeedPlayOptions()

AudioIOStartStreamOptions DefaultSpeedPlayOptions

(

AudacityProject &

project

)

Definition at line 1226 of file ProjectAudioManager.cpp.

{
   auto result = ProjectAudioIO::GetDefaultOptions( 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 AudioIO::Get(), ProjectRate::Get(), ProjectAudioIO::GetDefaultOptions(), anonymous_namespace{TimeTrack.cpp}::GetRate(), and project.

Here is the call graph for this function:

GetPropertiesOfSelected()

AUDACITY_DLL_API PropertiesOfSelected GetPropertiesOfSelected

(

const AudacityProject &

proj

)

Definition at line 1329 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.anySelected = !selectedTracks.empty();
   result.rateOfSelected = rateOfSelection;
 
   return  result;
}

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

Referenced by ProjectAudioManager::OnRecord(), and anonymous_namespace{TimerRecordDialog.cpp}::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 24 of file ProjectAudioManager.h.

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