ExportPluginHelpers Class Reference

Utility class that provides helper functions for ExportPlugin. More...

#include <ExportPluginHelpers.h>

Static Public Member Functions
static std::unique_ptr< Mixer >	CreateMixer (const AudacityProject &project, bool selectionOnly, double startTime, double stopTime, unsigned numOutChannels, size_t outBufferSize, bool outInterleaved, double outRate, sampleFormat outFormat, MixerOptions::Downmix *mixerSpec)
static ExportResult	UpdateProgress (ExportProcessorDelegate &delegate, Mixer &mixer, double t0, double t1)
	Sends progress update to delegate and retrieves state update from it. Typically used inside each export iteration. More...
template<typename T >
static T	GetParameterValue (const ExportProcessor::Parameters &parameters, int id, T defaultValue=T())

Detailed Description

Utility class that provides helper functions for ExportPlugin.

Definition at line 31 of file ExportPluginHelpers.h.

Member Function Documentation

CreateMixer()

std::unique_ptr< Mixer > ExportPluginHelpers::CreateMixer ( const AudacityProject &  project, bool  selectionOnly, double  startTime, double  stopTime, unsigned  numOutChannels, size_t  outBufferSize, bool  outInterleaved, double  outRate, sampleFormat  outFormat, MixerOptions::Downmix *  mixerSpec  )

static

Definition at line 23 of file ExportPluginHelpers.cpp.

{
   Mixer::Inputs inputs;
   const auto& tracks = TrackList::Get(project);
   for (auto pTrack: ExportUtils::FindExportWaveTracks(tracks, selectionOnly))
      inputs.emplace_back(
         StretchingSequence::Create(*pTrack, pTrack->GetClipInterfaces()),
         GetEffectStages(*pTrack));
   auto masterEffectStages = GetMasterEffectStages(project);
   //custom channel mapping isn't support with master effects on
   assert(masterEffectStages.empty() || (numOutChannels <= 2 && mixerSpec == nullptr));
   // MB: the stop time should not be warped, this was a bug.
   return std::make_unique<Mixer>(
      std::move(inputs), std::move(masterEffectStages),
      // Throw, to stop exporting, if read fails:
      true, Mixer::WarpOptions { tracks.GetOwner() }, startTime, stopTime,
      numOutChannels, outBufferSize, outInterleaved, outRate, outFormat, true,
      mixerSpec,
      mixerSpec ? Mixer::ApplyVolume::MapChannels : Mixer::ApplyVolume::Mixdown);
}

References StretchingSequence::Create(), ExportUtils::FindExportWaveTracks(), TrackList::Get(), GetEffectStages(), GetMasterEffectStages(), DownmixStage::MapChannels, DownmixStage::Mixdown, project, and tracks.

Referenced by FFmpegExporter::CreateMixer(), CLExportProcessor::Initialize(), FLACExportProcessor::Initialize(), MP2ExportProcessor::Initialize(), MP3ExportProcessor::Initialize(), OGGExportProcessor::Initialize(), OpusExportProcessor::Initialize(), PCMExportProcessor::Initialize(), and WavPackExportProcessor::Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

GetParameterValue()

template<typename T >

static T ExportPluginHelpers::GetParameterValue ( const ExportProcessor::Parameters &  parameters, int  id, T  defaultValue = T()  )

inlinestatic

Definition at line 45 of file ExportPluginHelpers.h.

   {
      auto it = std::find_if(
         parameters.begin(),
         parameters.end(),
         [=](const auto& t) { return std::get<0>(t) == id; });
      if(it != parameters.end())
      {
         if(auto value = std::get_if<T>(&std::get<1>(*it)))
            return *value;
      }
      return defaultValue;
   }

Referenced by FFmpegExporter::InitCodecs(), CLExportProcessor::Initialize(), MP2ExportProcessor::Initialize(), MP3ExportProcessor::Initialize(), OGGExportProcessor::Initialize(), and PCMExportProcessor::Initialize().

Here is the caller graph for this function:

UpdateProgress()

ExportResult ExportPluginHelpers::UpdateProgress ( ExportProcessorDelegate &  delegate, Mixer &  mixer, double  t0, double  t1  )

static

Sends progress update to delegate and retrieves state update from it. Typically used inside each export iteration.

Definition at line 59 of file ExportPluginHelpers.cpp.

{
   delegate.OnProgress(EvalExportProgress(mixer, t0, t1));
   if(delegate.IsStopped())
      return ExportResult::Stopped;
   if(delegate.IsCancelled())
      return ExportResult::Cancelled;
   return ExportResult::Success;
}

References Cancelled, anonymous_namespace{ExportPluginHelpers.cpp}::EvalExportProgress(), ExportProcessorDelegate::IsCancelled(), ExportProcessorDelegate::IsStopped(), ExportProcessorDelegate::OnProgress(), Stopped, and Success.

Referenced by CLExportProcessor::Process(), FFmpegExportProcessor::Process(), FLACExportProcessor::Process(), MP2ExportProcessor::Process(), MP3ExportProcessor::Process(), OGGExportProcessor::Process(), OpusExportProcessor::Process(), PCMExportProcessor::Process(), and WavPackExportProcessor::Process().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• ExportPluginHelpers.h
• ExportPluginHelpers.cpp