Audacity 3.2.0
Classes | Namespaces | Macros | Typedefs | Functions | Variables
WaveTrack.h File Reference
#include "Prefs.h"
#include "SampleCount.h"
#include "SampleFormat.h"
#include "SampleTrack.h"
#include <vector>
#include <functional>
#include <wx/thread.h>
#include <wx/longlong.h>
#include "WaveTrackLocation.h"
#include <unordered_set>
#include "XMLMethodRegistry.h"
Include dependency graph for WaveTrack.h:

Go to the source code of this file.

Classes

class  WaveTrack
 A Track that contains audio waveform data. More...
 
struct  WaveTrack::Region
 Structure to hold region of a wavetrack and a comparison function for sortability. More...
 
class  WaveTrack::AllClipsIterator
 
class  WaveTrack::AllClipsConstIterator
 
class  WaveTrack::IntervalData
 
class  WaveTrackFactory
 Used to create or clone a WaveTrack, with appropriate context from the project that will own the track. More...
 

Namespaces

namespace  BasicUI
 

Macros

#define WAVETRACK_MERGE_POINT_TOLERANCE   0.01
 

Typedefs

using SampleBlockFactoryPtr = std::shared_ptr< SampleBlockFactory >
 
using WaveClipHolder = std::shared_ptr< WaveClip >
 
using WaveClipHolders = std::vector< WaveClipHolder >
 
using WaveClipConstHolders = std::vector< std::shared_ptr< const WaveClip > >
 
using WaveClipPointers = std::vector< WaveClip * >
 
using WaveClipConstPointers = std::vector< const WaveClip * >
 
using SampleBlockID = long long
 
using SampleBlockIDSet = std::unordered_set< SampleBlockID >
 
using BlockVisitor = std::function< void(SampleBlock &) >
 
using BlockInspector = std::function< void(const SampleBlock &) >
 
using WaveTrackIORegistry = XMLMethodRegistry< WaveTrack >
 

Functions

 ENUMERATE_TRACK_TYPE (WaveTrack)
 
void VisitBlocks (TrackList &tracks, BlockVisitor visitor, SampleBlockIDSet *pIDs=nullptr)
 
void InspectBlocks (const TrackList &tracks, BlockInspector inspector, SampleBlockIDSet *pIDs=nullptr)
 
AUDACITY_DLL_API bool GetEditClipsCanMove ()
 
 DECLARE_XML_METHOD_REGISTRY (AUDACITY_DLL_API, WaveTrackIORegistry)
 

Variables

AUDACITY_DLL_API BoolSetting EditClipsCanMove
 
AUDACITY_DLL_API StringSetting AudioTrackNameSetting
 

Macro Definition Documentation

◆ WAVETRACK_MERGE_POINT_TOLERANCE

#define WAVETRACK_MERGE_POINT_TOLERANCE   0.01

Definition at line 52 of file WaveTrack.h.

Typedef Documentation

◆ BlockInspector

using BlockInspector = std::function< void(const SampleBlock&) >

Definition at line 596 of file WaveTrack.h.

◆ BlockVisitor

using BlockVisitor = std::function< void(SampleBlock&) >

Definition at line 595 of file WaveTrack.h.

◆ SampleBlockFactoryPtr

using SampleBlockFactoryPtr = std::shared_ptr<SampleBlockFactory>

Definition at line 31 of file WaveTrack.h.

◆ SampleBlockID

using SampleBlockID = long long

Definition at line 592 of file WaveTrack.h.

◆ SampleBlockIDSet

using SampleBlockIDSet = std::unordered_set<SampleBlockID>

Definition at line 593 of file WaveTrack.h.

◆ WaveClipConstHolders

using WaveClipConstHolders = std::vector < std::shared_ptr< const WaveClip > >

Definition at line 43 of file WaveTrack.h.

◆ WaveClipConstPointers

using WaveClipConstPointers = std::vector < const WaveClip* >

Definition at line 47 of file WaveTrack.h.

◆ WaveClipHolder

using WaveClipHolder = std::shared_ptr< WaveClip >

Definition at line 41 of file WaveTrack.h.

◆ WaveClipHolders

using WaveClipHolders = std::vector < WaveClipHolder >

Definition at line 42 of file WaveTrack.h.

◆ WaveClipPointers

using WaveClipPointers = std::vector < WaveClip* >

Definition at line 46 of file WaveTrack.h.

◆ WaveTrackIORegistry

Definition at line 662 of file WaveTrack.h.

Function Documentation

◆ DECLARE_XML_METHOD_REGISTRY()

DECLARE_XML_METHOD_REGISTRY ( AUDACITY_DLL_API  ,
WaveTrackIORegistry   
)

◆ ENUMERATE_TRACK_TYPE()

ENUMERATE_TRACK_TYPE ( WaveTrack  )

◆ GetEditClipsCanMove()

AUDACITY_DLL_API bool GetEditClipsCanMove ( )

Definition at line 2860 of file WaveTrack.cpp.

2861{
2862 bool mIsSyncLocked;
2863 gPrefs->Read(wxT("/GUI/SyncLockTracks"), &mIsSyncLocked, false);
2864 if( mIsSyncLocked )
2865 return true;
2866 bool editClipsCanMove;
2867 return EditClipsCanMove.Read();
2868}
wxT("CloseDown"))
FileConfig * gPrefs
Definition: Prefs.cpp:71
BoolSetting EditClipsCanMove
Definition: WaveTrack.cpp:2870
bool Read(T *pVar) const
overload of Read returning a boolean that is true if the value was previously defined *‍/
Definition: Prefs.h:200

References EditClipsCanMove, gPrefs, Setting< T >::Read(), and wxT().

Referenced by WaveTrack::ExpandCutLine(), WaveTrack::HandleClear(), WaveTrack::PasteWaveTrack(), and Generator::Process().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ InspectBlocks()

void InspectBlocks ( const TrackList tracks,
BlockInspector  inspector,
SampleBlockIDSet pIDs = nullptr 
)

Definition at line 2791 of file WaveTrack.cpp.

2793{
2795 const_cast<TrackList &>(tracks), std::move( inspector ), pIDs );
2796}
void VisitBlocks(TrackList &tracks, BlockVisitor visitor, SampleBlockIDSet *pIDs)
Definition: WaveTrack.cpp:2770
A flat linked list of tracks supporting Add, Remove, Clear, and Contains, serialization of the list o...
Definition: Track.h:1338

References VisitBlocks().

Referenced by anonymous_namespace{HistoryWindow.cpp}::SpaceUsageCalculator::CalculateUsage(), ProjectFileIO::CopyTo(), EstimateRemovedBlocks(), ProjectFileIO::GetCurrentUsage(), ProjectFileIO::SaveProject(), and ProjectFileIO::ShouldCompact().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ VisitBlocks()

void VisitBlocks ( TrackList tracks,
BlockVisitor  visitor,
SampleBlockIDSet pIDs = nullptr 
)

Definition at line 2770 of file WaveTrack.cpp.

2772{
2773 for (auto wt : tracks.Any< const WaveTrack >()) {
2774 // Scan all clips within current track
2775 for(const auto &clip : wt->GetAllClips()) {
2776 // Scan all sample blocks within current clip
2777 auto blocks = clip->GetSequenceBlockArray();
2778 for (const auto &block : *blocks) {
2779 auto &pBlock = block.sb;
2780 if ( pBlock ) {
2781 if ( pIDs && !pIDs->insert(pBlock->GetBlockID()).second )
2782 continue;
2783 if ( visitor )
2784 visitor( *pBlock );
2785 }
2786 }
2787 }
2788 }
2789}
auto Any() -> TrackIterRange< TrackType >
Definition: Track.h:1437
A Track that contains audio waveform data.
Definition: WaveTrack.h:57

References TrackList::Any().

Referenced by InspectBlocks().

Here is the call graph for this function:
Here is the caller graph for this function:

Variable Documentation

◆ AudioTrackNameSetting

AUDACITY_DLL_API StringSetting AudioTrackNameSetting
extern

◆ EditClipsCanMove

AUDACITY_DLL_API BoolSetting EditClipsCanMove
extern