ExportTaskBuilder Class Reference

#include <Export.h>

Collaboration diagram for ExportTaskBuilder:

Public Member Functions
	ExportTaskBuilder ()
	~ExportTaskBuilder ()
ExportTaskBuilder &	SetFileName (const wxFileName &filename)
ExportTaskBuilder &	SetRange (double t0, double t1, bool selectedOnly=false) noexcept
ExportTaskBuilder &	SetParameters (ExportProcessor::Parameters parameters) noexcept
ExportTaskBuilder &	SetNumChannels (unsigned numChannels) noexcept
ExportTaskBuilder &	SetPlugin (const ExportPlugin *plugin, int format=0) noexcept
ExportTaskBuilder &	SetTags (const Tags *tags) noexcept
ExportTaskBuilder &	SetSampleRate (double sampleRate) noexcept
ExportTaskBuilder &	SetMixerSpec (MixerOptions::Downmix *mixerSpec) noexcept
ExportTask	Build (AudacityProject &project)

Private Attributes
wxFileName	mFileName
double	mT0 {}
double	mT1 {}
bool	mSelectedOnly {}
unsigned	mNumChannels {1}
double	mSampleRate {44100}
ExportProcessor::Parameters	mParameters
const ExportPlugin *	mPlugin {}
int	mFormat {}
MixerOptions::Downmix *	mMixerSpec {}
const Tags *	mTags {}

Detailed Description

Definition at line 32 of file Export.h.

Constructor & Destructor Documentation

ExportTaskBuilder()

ExportTaskBuilder::ExportTaskBuilder ( )

default

~ExportTaskBuilder()

ExportTaskBuilder::~ExportTaskBuilder ( )

default

Member Function Documentation

Build()

ExportTask ExportTaskBuilder::Build

(

AudacityProject &

project

)

Definition at line 84 of file Export.cpp.

{
   //File rename stuff should be moved out to somewhere else...
   auto filename = mFileName;
 
   //For safety, if the file already exists we use temporary filename
   //and replace original one export succeeded
   int suffix = 0;
   while (filename.FileExists()) {
      filename.SetName(mFileName.GetName() +
                        wxString::Format(wxT("%d"), suffix));
      suffix++;
   }
 
   auto processor = mPlugin->CreateProcessor(mFormat);
   if(!processor->Initialize(project,
      mParameters,
      mFileName.GetFullPath(),
      mT0, mT1, mSelectedOnly,
      mSampleRate, mMixerSpec ? mMixerSpec->GetNumChannels() : mNumChannels,
      mMixerSpec,
      mTags))
   {
      return ExportTask([](ExportProcessorDelegate&){ return ExportResult::Cancelled; });
   }
 
   return ExportTask([actualFilename = filename,
      targetFilename = mFileName,
      processor = std::shared_ptr<ExportProcessor>(processor.release())]
      (ExportProcessorDelegate& delegate)
      {
         auto result = ExportResult::Error;
         auto cleanup = finally( [&] {
            if(result == ExportResult::Success || result == ExportResult::Stopped)
            {
               if (actualFilename != targetFilename)
               {
                  //may fail...
                  ::wxRenameFile(actualFilename.GetFullPath(),
                     targetFilename.GetFullPath(),
                     true);
               }
            }
            else
               ::wxRemoveFile(actualFilename.GetFullPath());
         } );
         result = processor->Process(delegate);
         return result;
      });
}

References Cancelled, ExportPlugin::CreateProcessor(), MixerOptions::Downmix::GetNumChannels(), mFileName, mFormat, mMixerSpec, mNumChannels, mParameters, mPlugin, mSampleRate, mSelectedOnly, mT0, mT1, mTags, project, and wxT().

Referenced by ExportAudioDialog::OnExport().

Here is the call graph for this function:

Here is the caller graph for this function:

SetFileName()

ExportTaskBuilder & ExportTaskBuilder::SetFileName

(

const wxFileName &

filename

)

Definition at line 33 of file Export.cpp.

{
   mFileName = filename;
   return *this;
}

References mFileName.

Referenced by ExportCommand::Apply(), anonymous_namespace{FileMenus.cpp}::DoExport(), TimerRecordDialog::ExecutePostRecordActions(), audacity::cloud::audiocom::sync::MixdownUploader::ExportProject(), audacity::cloud::audiocom::ShareAudioDialog::ExportProject(), and ExportAudioDialog::OnExport().

Here is the caller graph for this function:

SetMixerSpec()

ExportTaskBuilder & ExportTaskBuilder::SetMixerSpec ( MixerOptions::Downmix *  mixerSpec )

noexcept

Definition at line 66 of file Export.cpp.

{
   mMixerSpec = mixerSpec;
   return *this;
}

Referenced by ExportAudioDialog::OnExport().

Here is the caller graph for this function:

SetNumChannels()

ExportTaskBuilder & ExportTaskBuilder::SetNumChannels ( unsigned  numChannels )

noexcept

Definition at line 53 of file Export.cpp.

{
   mNumChannels = numChannels;
   return *this;
}

Referenced by ExportCommand::Apply(), anonymous_namespace{FileMenus.cpp}::DoExport(), TimerRecordDialog::ExecutePostRecordActions(), audacity::cloud::audiocom::sync::MixdownUploader::ExportProject(), audacity::cloud::audiocom::ShareAudioDialog::ExportProject(), and ExportAudioDialog::OnExport().

Here is the caller graph for this function:

SetParameters()

ExportTaskBuilder & ExportTaskBuilder::SetParameters ( ExportProcessor::Parameters  parameters )

noexcept

Definition at line 47 of file Export.cpp.

{
   mParameters = std::move(parameters);
   return *this;
}

Referenced by ExportCommand::Apply(), anonymous_namespace{FileMenus.cpp}::DoExport(), TimerRecordDialog::ExecutePostRecordActions(), audacity::cloud::audiocom::sync::MixdownUploader::ExportProject(), audacity::cloud::audiocom::ShareAudioDialog::ExportProject(), and ExportAudioDialog::OnExport().

Here is the caller graph for this function:

SetPlugin()

ExportTaskBuilder & ExportTaskBuilder::SetPlugin ( const ExportPlugin *  plugin, int  format = 0  )

noexcept

Definition at line 59 of file Export.cpp.

{
   mPlugin = plugin;
   mFormat = format;
   return *this;
}

References anonymous_namespace{ExportPCM.cpp}::format.

Referenced by ExportCommand::Apply(), anonymous_namespace{FileMenus.cpp}::DoExport(), TimerRecordDialog::ExecutePostRecordActions(), audacity::cloud::audiocom::sync::MixdownUploader::ExportProject(), audacity::cloud::audiocom::ShareAudioDialog::ExportProject(), and ExportAudioDialog::OnExport().

Here is the caller graph for this function:

SetRange()

ExportTaskBuilder & ExportTaskBuilder::SetRange ( double  t0, double  t1, bool  selectedOnly = false  )

noexcept

Definition at line 39 of file Export.cpp.

{
   mT0 = t0;
   mT1 = t1;
   mSelectedOnly = selectedOnly;
   return *this;
}

Referenced by ExportCommand::Apply(), anonymous_namespace{FileMenus.cpp}::DoExport(), TimerRecordDialog::ExecutePostRecordActions(), audacity::cloud::audiocom::sync::MixdownUploader::ExportProject(), audacity::cloud::audiocom::ShareAudioDialog::ExportProject(), and ExportAudioDialog::OnExport().

Here is the caller graph for this function:

SetSampleRate()

ExportTaskBuilder & ExportTaskBuilder::SetSampleRate ( double  sampleRate )

noexcept

Definition at line 72 of file Export.cpp.

{
   mSampleRate = sampleRate;
   return *this;
}

References anonymous_namespace{ClipSegmentTest.cpp}::sampleRate.

Referenced by ExportCommand::Apply(), anonymous_namespace{FileMenus.cpp}::DoExport(), TimerRecordDialog::ExecutePostRecordActions(), audacity::cloud::audiocom::sync::MixdownUploader::ExportProject(), audacity::cloud::audiocom::ShareAudioDialog::ExportProject(), and ExportAudioDialog::OnExport().

Here is the caller graph for this function:

SetTags()

ExportTaskBuilder & ExportTaskBuilder::SetTags ( const Tags *  tags )

noexcept

Definition at line 78 of file Export.cpp.

{
   mTags = tags;
   return *this;
}

Member Data Documentation

mFileName

wxFileName ExportTaskBuilder::mFileName

private

Definition at line 51 of file Export.h.

Referenced by Build(), and SetFileName().

mFormat

int ExportTaskBuilder::mFormat {}

private

Definition at line 59 of file Export.h.

Referenced by Build().

mMixerSpec

MixerOptions::Downmix* ExportTaskBuilder::mMixerSpec {}

private

Definition at line 60 of file Export.h.

Referenced by Build().

mNumChannels

unsigned ExportTaskBuilder::mNumChannels {1}

private

Definition at line 55 of file Export.h.

Referenced by Build().

mParameters

ExportProcessor::Parameters ExportTaskBuilder::mParameters

private

Definition at line 57 of file Export.h.

Referenced by Build().

mPlugin

const ExportPlugin* ExportTaskBuilder::mPlugin {}

private

Definition at line 58 of file Export.h.

Referenced by Build().

mSampleRate

double ExportTaskBuilder::mSampleRate {44100}

private

Definition at line 56 of file Export.h.

Referenced by Build().

mSelectedOnly

bool ExportTaskBuilder::mSelectedOnly {}

private

Definition at line 54 of file Export.h.

Referenced by Build().

mT0

double ExportTaskBuilder::mT0 {}

private

Definition at line 52 of file Export.h.

Referenced by Build().

mT1

double ExportTaskBuilder::mT1 {}

private

Definition at line 53 of file Export.h.

Referenced by Build().

mTags

const Tags* ExportTaskBuilder::mTags {}

private

Definition at line 61 of file Export.h.

Referenced by Build().

---

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

• Export.h
• Export.cpp