WaveTrack.h File Reference

#include "ClipInterface.h"
#include "PlaybackDirection.h"
#include "Prefs.h"
#include "SampleCount.h"
#include "SampleFormat.h"
#include "SampleTrack.h"
#include "WideSampleSequence.h"
#include <vector>
#include <functional>
#include <wx/thread.h>
#include <wx/longlong.h>
#include <unordered_set>
#include "XMLMethodRegistry.h"

Include dependency graph for WaveTrack.h:

Go to the source code of this file.

Classes
class	WaveChannelInterval
class	WaveChannel
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::Interval
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 >
	Clips are held by shared_ptr, not for sharing, but to allow weak_ptr. More...
using	WaveClipHolders = std::vector< WaveClipHolder >
using	WaveClipConstHolders = std::vector< std::shared_ptr< const WaveClip > >
using	ClipConstHolders = std::vector< std::shared_ptr< const ClipInterface > >
using	WaveClipPointers = std::vector< WaveClip * >
using	WaveClipConstPointers = std::vector< const WaveClip * >
using	ChannelSampleView = std::vector< AudioSegmentSampleView >
using	ChannelGroupSampleView = std::vector< ChannelSampleView >
using	TimeInterval = std::pair< double, double >
using	ProgressReporter = std::function< void(double)>
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)
WAVE_TRACK_API void	InspectBlocks (const TrackList &tracks, BlockInspector inspector, SampleBlockIDSet *pIDs=nullptr)
WAVE_TRACK_API bool	GetEditClipsCanMove ()
	DECLARE_XML_METHOD_REGISTRY (WAVE_TRACK_API, WaveTrackIORegistry)

Variables
WAVE_TRACK_API BoolSetting	EditClipsCanMove
WAVE_TRACK_API StringSetting	AudioTrackNameSetting

Macro Definition Documentation

WAVETRACK_MERGE_POINT_TOLERANCE

#define WAVETRACK_MERGE_POINT_TOLERANCE   0.01

Definition at line 59 of file WaveTrack.h.

Typedef Documentation

BlockInspector

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

Definition at line 1149 of file WaveTrack.h.

BlockVisitor

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

Definition at line 1148 of file WaveTrack.h.

ChannelGroupSampleView

using ChannelGroupSampleView = std::vector<ChannelSampleView>

Definition at line 51 of file WaveTrack.h.

ChannelSampleView

using ChannelSampleView = std::vector<AudioSegmentSampleView>

Definition at line 50 of file WaveTrack.h.

ClipConstHolders

using ClipConstHolders = std::vector<std::shared_ptr<const ClipInterface> >

Definition at line 44 of file WaveTrack.h.

ProgressReporter

using ProgressReporter = std::function<void(double)>

Definition at line 54 of file WaveTrack.h.

SampleBlockFactoryPtr

using SampleBlockFactoryPtr = std::shared_ptr<SampleBlockFactory>

Definition at line 30 of file WaveTrack.h.

SampleBlockID

using SampleBlockID = long long

Definition at line 1145 of file WaveTrack.h.

SampleBlockIDSet

using SampleBlockIDSet = std::unordered_set<SampleBlockID>

Definition at line 1146 of file WaveTrack.h.

TimeInterval

using TimeInterval = std::pair<double, double>

Definition at line 53 of file WaveTrack.h.

WaveClipConstHolders

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

Definition at line 42 of file WaveTrack.h.

WaveClipConstPointers

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

Definition at line 48 of file WaveTrack.h.

WaveClipHolder

using WaveClipHolder = std::shared_ptr<WaveClip>

Clips are held by shared_ptr, not for sharing, but to allow weak_ptr.

Definition at line 40 of file WaveTrack.h.

WaveClipHolders

using WaveClipHolders = std::vector<WaveClipHolder>

Definition at line 41 of file WaveTrack.h.

WaveClipPointers

using WaveClipPointers = std::vector < WaveClip* >

Definition at line 47 of file WaveTrack.h.

WaveTrackIORegistry

using WaveTrackIORegistry = XMLMethodRegistry<WaveTrack>

Definition at line 1237 of file WaveTrack.h.

Function Documentation

DECLARE_XML_METHOD_REGISTRY()

DECLARE_XML_METHOD_REGISTRY	(	WAVE_TRACK_API	,
		WaveTrackIORegistry
	)

ENUMERATE_TRACK_TYPE()

ENUMERATE_TRACK_TYPE

(

WaveTrack

)

GetEditClipsCanMove()

WAVE_TRACK_API bool GetEditClipsCanMove

(

)

Definition at line 4141 of file WaveTrack.cpp.

{
   bool mIsSyncLocked = SyncLockTracks.Read();
   if( mIsSyncLocked )
      return true;
   bool editClipsCanMove;
   return EditClipsCanMove.Read();
}

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

Referenced by WaveTrack::ExpandOneCutLine(), WaveTrack::HandleClear(), WaveTrack::PasteOne(), and Generator::Process().

Here is the call graph for this function:

Here is the caller graph for this function:

InspectBlocks()

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

Definition at line 4062 of file WaveTrack.cpp.

{
   VisitBlocks(
      const_cast<TrackList &>(tracks), std::move( inspector ), pIDs );
}

References tracks, and 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 4040 of file WaveTrack.cpp.

{
   for (auto wt : tracks.Any<const WaveTrack>())
      for (const auto pChannel : TrackList::Channels(wt))
         // Scan all clips within current track
         for (const auto &clip : pChannel->GetAllClips())
            // Scan all sample blocks within current clip
            for (size_t ii = 0, width = clip->GetWidth(); ii < width; ++ii) {
               auto blocks = clip->GetSequenceBlockArray(ii);
               for (const auto &block : *blocks) {
                  auto &pBlock = block.sb;
                  if (pBlock) {
                     if (pIDs && !pIDs->insert(pBlock->GetBlockID()).second)
                        continue;
                     if (visitor)
                        visitor(*pBlock);
                  }
               }
            }
}

References TrackList::Channels(), and tracks.

Referenced by InspectBlocks().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

AudioTrackNameSetting

WAVE_TRACK_API StringSetting AudioTrackNameSetting

extern

Definition at line 4131 of file WaveTrack.cpp.

Referenced by TracksPrefs::Commit(), WaveTrack::GetDefaultAudioTrackNamePreference(), and TracksPrefs::PopulateOrExchange().

EditClipsCanMove

WAVE_TRACK_API BoolSetting EditClipsCanMove

extern

Definition at line 4150 of file WaveTrack.cpp.

Referenced by TracksBehaviorsPrefs::Commit(), GetEditClipsCanMove(), BenchmarkDialog::OnRun(), TracksBehaviorsPrefs::PopulateOrExchange(), and WaveTrack::SyncLockAdjust().