WaveTrackFactory Class Reference

Used to create or clone a WaveTrack, with appropriate context from the project that will own the track. More...

#include <WaveTrack.h>

Inheritance diagram for WaveTrackFactory:

Collaboration diagram for WaveTrackFactory:

Public Member Functions
	WaveTrackFactory (const ProjectRate &rate, const SampleBlockFactoryPtr &pFactory)
	WaveTrackFactory (const WaveTrackFactory &)=delete
WaveTrackFactory &	operator= (const WaveTrackFactory &)=delete
const SampleBlockFactoryPtr &	GetSampleBlockFactory () const
std::shared_ptr< WaveTrack >	Create ()
	Creates an unnamed empty WaveTrack with default sample format and default rate. More...
std::shared_ptr< WaveTrack >	Create (sampleFormat format, double rate)
	Creates an unnamed empty WaveTrack with custom sample format and custom rate. More...
WaveTrack::Holder	Create (size_t nChannels)
	Creates a new track with project's default rate and format and the given number of channels. More...
TrackListHolder	CreateMany (size_t nChannels)
	Creates tracks with project's default rate and format and the given number of channels. More...
WaveTrack::Holder	Create (size_t nChannels, sampleFormat format, double rate)
	Creates a new track with specified format and rate and number of channels. More...
TrackListHolder	CreateMany (size_t nChannels, sampleFormat format, double rate)
	Creates tracks with specified format and rate and number of channels. More...
WaveTrack::Holder	Create (size_t nChannels, const WaveTrack &proto)
	Creates an empty copy of proto with the specified number of channels. More...
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static WaveTrackFactory &	Get (AudacityProject &project)
static const WaveTrackFactory &	Get (const AudacityProject &project)
static WaveTrackFactory &	Reset (AudacityProject &project)
static void	Destroy (AudacityProject &project)

Private Member Functions
std::shared_ptr< WaveTrack >	DoCreate (size_t nChannels, sampleFormat format, double rate)

Private Attributes
const ProjectRate &	mRate
SampleBlockFactoryPtr	mpFactory

Detailed Description

Used to create or clone a WaveTrack, with appropriate context from the project that will own the track.

Definition at line 868 of file WaveTrack.h.

Constructor & Destructor Documentation

WaveTrackFactory() [1/2]

WaveTrackFactory::WaveTrackFactory ( const ProjectRate &  rate, const SampleBlockFactoryPtr &  pFactory  )

inline

Definition at line 877 of file WaveTrack.h.

       : mRate{ rate }
       , mpFactory(pFactory)
   {
   }

WaveTrackFactory() [2/2]

WaveTrackFactory::WaveTrackFactory ( const WaveTrackFactory &  )

delete

Member Function Documentation

Create() [1/5]

std::shared_ptr< WaveTrack > WaveTrackFactory::Create

(

)

Creates an unnamed empty WaveTrack with default sample format and default rate.

Returns

Orphaned WaveTrack

Definition at line 393 of file WaveTrack.cpp.

{
   return Create(QualitySettings::SampleFormatChoice(), mRate.GetRate());
}

References Create(), ProjectRate::GetRate(), mRate, and QualitySettings::SampleFormatChoice().

Referenced by Create(), EffectBase::DoEffect(), MixAndRender(), and ImportUtils::NewWaveTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

Create() [2/5]

std::shared_ptr< WaveTrack > WaveTrackFactory::Create	(	sampleFormat	format,
		double	rate
	)

Creates an unnamed empty WaveTrack with custom sample format and custom rate.

Parameters

format	Desired sample format
rate	Desired sample rate

Returns

Orphaned WaveTrack

Definition at line 413 of file WaveTrack.cpp.

{
   return DoCreate(1, format, rate);
}

References DoCreate(), and anonymous_namespace{ExportPCM.cpp}::format.

Here is the call graph for this function:

Create() [3/5]

WaveTrack::Holder WaveTrackFactory::Create

(

size_t

nChannels

)

Creates a new track with project's default rate and format and the given number of channels.

Precondition

nChannels > 0

nChannels <= 2

Definition at line 418 of file WaveTrack.cpp.

{
   assert(nChannels > 0);
   assert(nChannels <= 2);
   return Create(nChannels, QualitySettings::SampleFormatChoice(), mRate.GetRate());
}

References Create(), ProjectRate::GetRate(), mRate, and QualitySettings::SampleFormatChoice().

Here is the call graph for this function:

Create() [4/5]

WaveTrack::Holder WaveTrackFactory::Create	(	size_t	nChannels,
		const WaveTrack &	proto
	)

Creates an empty copy of proto with the specified number of channels.

Definition at line 483 of file WaveTrack.cpp.

{
   return proto.EmptyCopy(nChannels, mpFactory);
}

References WaveTrack::EmptyCopy(), and mpFactory.

Here is the call graph for this function:

Create() [5/5]

WaveTrack::Holder WaveTrackFactory::Create	(	size_t	nChannels,
		sampleFormat	format,
		double	rate
	)

Creates a new track with specified format and rate and number of channels.

Precondition

nChannels > 0

nChannels <= 2

Definition at line 464 of file WaveTrack.cpp.

{
   assert(nChannels > 0);
   assert(nChannels <= 2);
   return CreateMany(nChannels, format, rate)->DetachFirst()
      ->SharedPointer<WaveTrack>();
}

References CreateMany(), and anonymous_namespace{ExportPCM.cpp}::format.

Here is the call graph for this function:

CreateMany() [1/2]

TrackListHolder WaveTrackFactory::CreateMany

(

size_t

nChannels

)

Creates tracks with project's default rate and format and the given number of channels.

Definition at line 425 of file WaveTrack.cpp.

{
   return CreateMany(nChannels,
      QualitySettings::SampleFormatChoice(), mRate.GetRate());
}

References CreateMany(), ProjectRate::GetRate(), mRate, and QualitySettings::SampleFormatChoice().

Referenced by Create(), CreateMany(), ProjectAudioManager::DoRecord(), and ImportRaw().

Here is the call graph for this function:

Here is the caller graph for this function:

CreateMany() [2/2]

TrackListHolder WaveTrackFactory::CreateMany	(	size_t	nChannels,
		sampleFormat	format,
		double	rate
	)

Creates tracks with specified format and rate and number of channels.

Definition at line 472 of file WaveTrack.cpp.

{
   // There are some cases where more than two channels are requested
   if (nChannels == 2)
      return TrackList::Temporary(nullptr, DoCreate(nChannels, format, rate));
   auto result = TrackList::Temporary(nullptr);
   while (nChannels--)
      result->Add(DoCreate(1, format, rate));
   return result;
}

References DoCreate(), anonymous_namespace{ExportPCM.cpp}::format, and TrackList::Temporary().

Here is the call graph for this function:

Destroy()

void WaveTrackFactory::Destroy ( AudacityProject &  project )

static

Definition at line 3366 of file WaveTrack.cpp.

{
   project.AttachedObjects::Assign( key2, nullptr );
}

References key2, and project.

Referenced by ProjectManager::OnCloseWindow().

Here is the caller graph for this function:

DoCreate()

std::shared_ptr< WaveTrack > WaveTrackFactory::DoCreate ( size_t  nChannels, sampleFormat  format, double  rate  )

private

Definition at line 398 of file WaveTrack.cpp.

{
   auto result = std::make_shared<WaveTrack>(
      WaveTrack::CreateToken{}, mpFactory, format, rate);
   // Set the number of channels correctly before building all channel
   // attachments
   if (nChannels > 1)
      result->CreateRight();
   // Only after make_shared returns, can weak_from_this be used, which
   // attached object factories may need
   result->AttachedTrackObjects::BuildAll();
   return result;
}

References anonymous_namespace{ExportPCM.cpp}::format, and mpFactory.

Referenced by Create(), and CreateMany().

Here is the caller graph for this function:

Get() [1/2]

WaveTrackFactory & WaveTrackFactory::Get ( AudacityProject &  project )

static

Definition at line 3349 of file WaveTrack.cpp.

{
   return project.AttachedObjects::Get< WaveTrackFactory >( key2 );
}

References key2, and project.

Referenced by EffectUI::DoEffect(), anonymous_namespace{FileMenus.cpp}::DoImport(), anonymous_namespace{TrackMenus.cpp}::DoMixAndRender(), ProjectAudioManager::DoRecord(), Get(), AUPImportFileHandle::HandleWaveTrack(), ProjectFileManager::Import(), ProjectFileIO::LoadProject(), WaveTrack::New(), anonymous_namespace{EditMenus.cpp}::NotificationScope(), WaveTrackMenuTable::OnMergeStereo(), anonymous_namespace{WaveTrackMenuItems.cpp}::OnNewStereoTrack(), anonymous_namespace{WaveTrackMenuItems.cpp}::OnNewWaveTrack(), WaveTrack::PasteInto(), and audacity::cloud::audiocom::sync::anonymous_namespace{ResumedSnaphotUploadOperation.cpp}::ResumedSnaphotUploadOperation::UploadBlocks().

Here is the caller graph for this function:

Get() [2/2]

const WaveTrackFactory & WaveTrackFactory::Get ( const AudacityProject &  project )

static

Definition at line 3354 of file WaveTrack.cpp.

{
   return Get( const_cast< AudacityProject & >( project ) );
}

References Get(), and project.

Here is the call graph for this function:

GetSampleBlockFactory()

const SampleBlockFactoryPtr & WaveTrackFactory::GetSampleBlockFactory ( ) const

inline

Definition at line 887 of file WaveTrack.h.

   { return mpFactory; }

Referenced by ProjectFileIO::LoadProject().

Here is the caller graph for this function:

operator=()

WaveTrackFactory & WaveTrackFactory::operator= ( const WaveTrackFactory &  )

delete

Reset()

WaveTrackFactory & WaveTrackFactory::Reset ( AudacityProject &  project )

static

Definition at line 3359 of file WaveTrack.cpp.

{
   auto result = TrackFactoryFactory( project );
   project.AttachedObjects::Assign( key2, result );
   return *result;
}

References key2, project, and TrackFactoryFactory.

Referenced by ProjectManager::ResetProjectToEmpty().

Here is the caller graph for this function:

Member Data Documentation

mpFactory

SampleBlockFactoryPtr WaveTrackFactory::mpFactory

private

Definition at line 943 of file WaveTrack.h.

Referenced by Create(), and DoCreate().

mRate

const ProjectRate& WaveTrackFactory::mRate

private

Definition at line 942 of file WaveTrack.h.

Referenced by Create(), and CreateMany().

---

The documentation for this class was generated from the following files:

• WaveTrack.h
• WaveTrack.cpp