ExportUtils Class Reference

#include <ExportUtils.h>

Public Types
enum class	ExportHookResult { Handled , Continue , Cancel }
using	ExportHook = std::function< ExportHookResult(AudacityProject &, const FileExtension &, AudiocomTrace, bool)>
using	Priority = unsigned

Static Public Member Functions
static TrackIterRange< const WaveTrack >	FindExportWaveTracks (const TrackList &tracks, bool selectedOnly)
static bool	HasSelectedAudio (const AudacityProject &project)
static ExportProcessor::Parameters	ParametersFromEditor (const ExportOptionsEditor &editor)
static void	RegisterExportHook (ExportHook hook, Priority=DEFAULT_EXPORT_HOOK_PRIORITY)
static void	PerformInteractiveExport (AudacityProject &project, const FileExtension &format, AudiocomTrace trace, bool selectedOnly)

Static Public Attributes
static constexpr Priority	DEFAULT_EXPORT_HOOK_PRIORITY = 0

Detailed Description

Definition at line 43 of file ExportUtils.h.

Member Typedef Documentation

ExportHook

using ExportUtils::ExportHook = std::function<ExportHookResult( AudacityProject&, const FileExtension&, AudiocomTrace, bool)>

Definition at line 60 of file ExportUtils.h.

Priority

using ExportUtils::Priority = unsigned

Definition at line 64 of file ExportUtils.h.

Member Enumeration Documentation

ExportHookResult

enum class ExportUtils::ExportHookResult

strong

Enumerator
Handled
Continue
Cancel

Definition at line 53 of file ExportUtils.h.

   {
      Handled,
      Continue,
      Cancel,
   };

Member Function Documentation

FindExportWaveTracks()

TrackIterRange< const WaveTrack > ExportUtils::FindExportWaveTracks ( const TrackList &  tracks, bool  selectedOnly  )

static

Definition at line 23 of file ExportUtils.cpp.

{
   bool anySolo =
      !(tracks.Any<const WaveTrack>() + &WaveTrack::GetSolo).empty();
 
   return tracks.Any<const WaveTrack>()
      + (selectedOnly ? &Track::IsSelected : &Track::Any)
      - (anySolo ? &WaveTrack::GetNotSolo : &WaveTrack::GetMute);
}

References Track::Any(), WaveTrack::GetMute(), PlayableTrack::GetNotSolo(), WaveTrack::GetSolo(), Track::IsSelected(), and tracks.

Referenced by ExportPluginHelpers::CreateMixer(), anonymous_namespace{FileMenus.cpp}::DoExport(), TimerRecordDialog::ExecutePostRecordActions(), ExportAudioDialog::ExportAudioDialog(), HasSelectedAudio(), ExportFilePanel::Init(), and ExportAudioDialog::OnExport().

Here is the call graph for this function:

Here is the caller graph for this function:

HasSelectedAudio()

bool ExportUtils::HasSelectedAudio ( const AudacityProject &  project )

static

Definition at line 33 of file ExportUtils.cpp.

{
   return !FindExportWaveTracks(TrackList::Get(project), true).empty() &&
      !ViewInfo::Get(project).selectedRegion.isPoint();
}

References FindExportWaveTracks(), ViewInfo::Get(), TrackList::Get(), NotifyingSelectedRegion::isPoint(), project, and ViewInfo::selectedRegion.

Referenced by ExportAudioDialog::ExportAudioDialog(), and anonymous_namespace{FileMenus.cpp}::OnExportSelectedAudio().

Here is the call graph for this function:

Here is the caller graph for this function:

ParametersFromEditor()

ExportProcessor::Parameters ExportUtils::ParametersFromEditor ( const ExportOptionsEditor &  editor )

static

Definition at line 39 of file ExportUtils.cpp.

{
   ExportProcessor::Parameters parameters;
   for(int i = 0, count = editor.GetOptionsCount(); i < count; ++i)
   {
      ExportOption option;
      ExportValue value;
      if(editor.GetOption(i, option) && editor.GetValue(option.id, value))
         parameters.emplace_back(option.id, value);
   }
   return parameters;
}

References ExportOptionsEditor::GetOption(), ExportOptionsEditor::GetOptionsCount(), ExportOptionsEditor::GetValue(), and ExportOption::id.

Referenced by ExportCommand::Apply(), anonymous_namespace{FileMenus.cpp}::DoExport(), and ExportOptionsHandler::GetParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

PerformInteractiveExport()

void ExportUtils::PerformInteractiveExport ( AudacityProject &  project, const FileExtension &  format, AudiocomTrace  trace, bool  selectedOnly  )

static

Definition at line 78 of file ExportUtils.cpp.

{
   auto& hooks = ExportHooks();
   for (auto& hook : hooks)
   {
      if (
         hook.hook(project, format, trace, selectedOnly) !=
         ExportHookResult::Continue)
         return;
   }
}

References Continue, anonymous_namespace{ExportUtils.cpp}::ExportHooks(), anonymous_namespace{ExportPCM.cpp}::format, and project.

Referenced by anonymous_namespace{FileMenus.cpp}::DoExport(), and anonymous_namespace{FileMenus.cpp}::OnExportSelectedAudio().

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterExportHook()

void ExportUtils::RegisterExportHook ( ExportHook  hook, Priority  priority = DEFAULT_EXPORT_HOOK_PRIORITY  )

static

Definition at line 67 of file ExportUtils.cpp.

{
   auto& hooks = ExportHooks();
   hooks.insert(
      std::upper_bound(
         hooks.begin(), hooks.end(), priority,
         [](Priority priority, const ExportHookElement& element)
         { return priority > element.priority; }),
      { hook, priority });
}

References anonymous_namespace{ExportUtils.cpp}::ExportHooks().

Here is the call graph for this function:

Member Data Documentation

DEFAULT_EXPORT_HOOK_PRIORITY

constexpr Priority ExportUtils::DEFAULT_EXPORT_HOOK_PRIORITY = 0

staticconstexpr

Definition at line 65 of file ExportUtils.h.

---

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

• ExportUtils.h
• ExportUtils.cpp