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 "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 1186 of file ProjectAudioManager.cpp.

1186 { static ReservedCommandFlag flag{
1187 [](const AudacityProject &project){
1188 auto &projectAudioManager = ProjectAudioManager::Get( project );
1189 bool canStop = projectAudioManager.CanStopAudioStream();
1190 return canStop;
1191 }
1192 }; return flag; }
const auto project
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, 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.

1227{
1229 auto gAudioIO = AudioIO::Get();
1230 auto PlayAtSpeedRate = gAudioIO->GetBestRate(
1231 false, //not capturing
1232 true, //is playing
1233 ProjectRate::Get( project ).GetRate() //suggested rate
1234 );
1235 result.rate = PlayAtSpeedRate;
1236 return result;
1237}
static AudioIO * Get()
Definition: AudioIO.cpp:126
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:196

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.

1330{
1331 double rateOfSelection{ RATE_NOT_SELECTED };
1332
1333 PropertiesOfSelected result;
1334 result.allSameRate = true;
1335
1336 const auto selectedTracks{
1337 TrackList::Get(proj).Selected<const WaveTrack>() };
1338
1339 for (const auto & track : selectedTracks) {
1340 if (rateOfSelection != RATE_NOT_SELECTED &&
1341 track->GetRate() != rateOfSelection)
1342 result.allSameRate = false;
1343 else if (rateOfSelection == RATE_NOT_SELECTED)
1344 rateOfSelection = track->GetRate();
1345 }
1346
1347 result.anySelected = !selectedTracks.empty();
1348 result.rateOfSelected = rateOfSelection;
1349
1350 return result;
1351}
constexpr int RATE_NOT_SELECTED
static TrackList & Get(AudacityProject &project)
Definition: Track.cpp:347
auto Selected() -> TrackIterRange< TrackType >
Definition: Track.h:1096
A Track that contains audio waveform data.
Definition: WaveTrack.h:222

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