Audacity 3.2.0
Classes | Typedefs | Enumerations | Functions | Variables
ProjectAudioManager.h File Reference
#include <memory>
#include <vector>
#include "AudioIOListener.h"
#include "ClientData.h"
#include "Observer.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, 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 ReservedCommandFlagCanStopAudioStreamFlag ()
 

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.

34 : int {
36 oneSecondPlay, // Disables auto-scrolling
37 loopedPlay, // Possibly looped play (not always); disables auto-scrolling
39};
@ cutPreviewPlay

Function Documentation

◆ CanStopAudioStreamFlag()

AUDACITY_DLL_API const ReservedCommandFlag & CanStopAudioStreamFlag ( )

Definition at line 1151 of file ProjectAudioManager.cpp.

1151 { static ReservedCommandFlag flag{
1152 [](const AudacityProject &project){
1153 auto &projectAudioManager = ProjectAudioManager::Get( project );
1154 bool canStop = projectAudioManager.CanStopAudioStream();
1155 return canStop;
1156 }
1157 }; return flag; }
static std::once_flag flag
The top-level handle to an Audacity project. It serves as a source of events that other objects can b...
Definition: Project.h:90
static ProjectAudioManager & Get(AudacityProject &project)

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:

◆ DefaultSpeedPlayOptions()

AudioIOStartStreamOptions DefaultSpeedPlayOptions ( AudacityProject project)

Definition at line 1191 of file ProjectAudioManager.cpp.

1192{
1193 auto result = ProjectAudioIO::GetDefaultOptions( project );
1194 auto gAudioIO = AudioIO::Get();
1195 auto PlayAtSpeedRate = gAudioIO->GetBestRate(
1196 false, //not capturing
1197 true, //is playing
1198 ProjectRate::Get( project ).GetRate() //suggested rate
1199 );
1200 result.rate = PlayAtSpeedRate;
1201 return result;
1202}
static AudioIO * Get()
Definition: AudioIO.cpp:123
static AudioIOStartStreamOptions GetDefaultOptions(AudacityProject &project, bool newDefaults=false)
Invoke the global hook, supplying a default argument.
static ProjectRate & Get(AudacityProject &project)
Definition: ProjectRate.cpp:28
double GetRate(const Track &track)
Definition: TimeTrack.cpp:179

References AudioIO::Get(), ProjectRate::Get(), ProjectAudioIO::GetDefaultOptions(), 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 1294 of file ProjectAudioManager.cpp.

1295{
1296 double rateOfSelection{ RATE_NOT_SELECTED };
1297
1298 PropertiesOfSelected result;
1299 result.allSameRate = true;
1300
1301 const auto selectedTracks{
1302 TrackList::Get(proj).Selected< const WaveTrack >() };
1303
1304 for (const auto & track : selectedTracks)
1305 {
1306 if (rateOfSelection != RATE_NOT_SELECTED &&
1307 track->GetRate() != rateOfSelection)
1308 result.allSameRate = false;
1309 else if (rateOfSelection == RATE_NOT_SELECTED)
1310 rateOfSelection = track->GetRate();
1311 }
1312
1313 result.numberOfSelected = selectedTracks.size();
1314 result.rateOfSelected = rateOfSelection;
1315
1316 return result;
1317}
constexpr int RATE_NOT_SELECTED
static TrackList & Get(AudacityProject &project)
Definition: Track.cpp:360
auto Selected() -> TrackIterRange< TrackType >
Definition: Track.h:1319
A Track that contains audio waveform data.
Definition: WaveTrack.h:51

References PropertiesOfSelected::allSameRate, TrackList::Get(), PropertiesOfSelected::numberOfSelected, 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