ExportCommand Class Reference

Command for exporting audio. More...

#include <ImportExportCommands.h>

Inheritance diagram for ExportCommand:

Collaboration diagram for ExportCommand:

Public Member Functions
ComponentInterfaceSymbol	GetSymbol () const override
TranslatableString	GetDescription () const override
template<bool Const>
bool	VisitSettings (SettingsVisitorBase< Const > &S)
bool	VisitSettings (SettingsVisitor &S) override
bool	VisitSettings (ConstSettingsVisitor &S) override
void	PopulateOrExchange (ShuttleGui &S) override
bool	Apply (const CommandContext &context) override
ManualPageID	ManualPage () override
Public Member Functions inherited from AudacityCommand
	AudacityCommand ()
virtual	~AudacityCommand ()
PluginPath	GetPath () const override
VendorSymbol	GetVendor () const override
wxString	GetVersion () const override
ComponentInterfaceSymbol	GetSymbol () const override=0
virtual TranslatableString	GetDescription () const override
virtual ManualPageID	ManualPage ()
virtual bool	IsBatchProcessing () const
virtual void	SetBatchProcessing (bool start)
virtual bool	Apply (const CommandContext &WXUNUSED(context))
bool	ShowInterface (wxWindow *parent, bool forceModal=false)
wxDialog *	CreateUI (wxWindow *parent, AudacityCommand *client)
bool	SaveSettingsAsString (wxString &parms)
bool	LoadSettingsFromString (const wxString &parms)
bool	DoAudacityCommand (wxWindow *parent, const CommandContext &context, bool shouldPrompt=true)
int	MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})
virtual bool	Init ()
virtual bool	PromptUser (wxWindow *parent)
virtual bool	CheckWhetherSkipAudacityCommand ()
virtual void	End ()
virtual void	PopulateOrExchange (ShuttleGui &WXUNUSED(S))
virtual bool	TransferDataToWindow ()
virtual bool	TransferDataFromWindow ()
virtual bool	VisitSettings (SettingsVisitor &)
virtual bool	VisitSettings (ConstSettingsVisitor &)
Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()
virtual PluginPath	GetPath () const =0
virtual ComponentInterfaceSymbol	GetSymbol () const =0
virtual VendorSymbol	GetVendor () const =0
virtual wxString	GetVersion () const =0
virtual TranslatableString	GetDescription () const =0
TranslatableString	GetName () const

Public Attributes
wxString	mFileName
int	mnChannels

Static Public Attributes
static const ComponentInterfaceSymbol	Symbol { XO("Export2") }

Additional Inherited Members
Public Types inherited from AudacityCommand
enum	: long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
Protected Attributes inherited from AudacityCommand
ProgressDialog *	mProgress
wxDialog *	mUIDialog
wxWindow *	mUIParent

Detailed Description

Command for exporting audio.

Definition at line 46 of file ImportExportCommands.h.

Member Function Documentation

Apply()

bool ExportCommand::Apply ( const CommandContext &  context )

override

Definition at line 113 of file ImportExportCommands.cpp.

{
   double t0, t1;
   auto &selectedRegion = ViewInfo::Get( context.project ).selectedRegion;
   t0 = selectedRegion.t0();
   t1 = selectedRegion.t1();
 
   // Find the extension and check it's valid
   int splitAt = mFileName.Find(wxUniChar('.'), true);
   if (splitAt < 0)
   {
      context.Error(wxT("Export filename must have an extension!"));
      return false;
   }
   wxString extension = mFileName.Mid(splitAt+1).MakeUpper();
 
   auto [plugin, formatIndex] = ExportPluginRegistry::Get().FindFormat(extension);
 
   if(plugin != nullptr)
   {
      auto editor = plugin->CreateOptionsEditor(formatIndex, nullptr);
      editor->Load(*gPrefs);
 
      auto builder = ExportTaskBuilder{}
         .SetParameters(ExportUtils::ParametersFromEditor(*editor))
         .SetNumChannels(std::max(0, mnChannels))
         .SetSampleRate(ProjectRate::Get(context.project).GetRate())
         .SetPlugin(plugin)
         .SetFileName(mFileName)
         .SetRange(t0, t1, true);
 
      auto result = ExportResult::Error;
      ExportProgressUI::ExceptionWrappedCall([&]
      {
         result = ExportProgressUI::Show(builder.Build(context.project));
      });
      if (result == ExportResult::Success || result == ExportResult::Stopped)
      {
         context.Status(wxString::Format(wxT("Exported to %s format: %s"),
                                         extension, mFileName));
         return true;
      }
   }
 
   context.Error(wxString::Format(wxT("Could not export to %s format!"), extension));
   return false;
}

References Error, CommandContext::Error(), ExportProgressUI::ExceptionWrappedCall(), ExportPluginRegistry::FindFormat(), ExportPluginRegistry::Get(), ProjectRate::Get(), ViewInfo::Get(), ProjectRate::GetRate(), gPrefs, mFileName, mnChannels, ExportUtils::ParametersFromEditor(), CommandContext::project, ViewInfo::selectedRegion, ExportTaskBuilder::SetFileName(), ExportTaskBuilder::SetNumChannels(), ExportTaskBuilder::SetParameters(), ExportTaskBuilder::SetPlugin(), ExportTaskBuilder::SetRange(), ExportTaskBuilder::SetSampleRate(), ExportProgressUI::Show(), CommandContext::Status(), Stopped, Success, NotifyingSelectedRegion::t0(), and wxT().

Here is the call graph for this function:

GetDescription()

TranslatableString ExportCommand::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 53 of file ImportExportCommands.h.

{return XO("Exports to a file.");};

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol ExportCommand::GetSymbol ( ) const

inlineoverridevirtual

Implements AudacityCommand.

Definition at line 52 of file ImportExportCommands.h.

{return Symbol;};

References Symbol.

ManualPage()

ManualPageID ExportCommand::ManualPage ( )

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 61 of file ImportExportCommands.h.

{return L"Extra_Menu:_Scriptables_II#export";}

PopulateOrExchange()

void ExportCommand::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 101 of file ImportExportCommands.cpp.

{
   S.AddSpace(0, 5);
 
   S.StartMultiColumn(2, wxALIGN_CENTER);
   {
      S.TieTextBox(XXO("File Name:"),mFileName);
      S.TieTextBox(XXO("Number of Channels:"),mnChannels);
   }
   S.EndMultiColumn();
}

References mFileName, mnChannels, S, and XXO().

Here is the call graph for this function:

VisitSettings() [1/3]

bool ExportCommand::VisitSettings ( ConstSettingsVisitor &  )

overridevirtual

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 93 of file ImportExportCommands.cpp.

   { return VisitSettings<true>(S); }

References S.

VisitSettings() [2/3]

bool ExportCommand::VisitSettings ( SettingsVisitor &  )

overridevirtual

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 90 of file ImportExportCommands.cpp.

   { return VisitSettings<false>(S); }

References S.

VisitSettings() [3/3]

template<bool Const>

bool ExportCommand::VisitSettings

(

SettingsVisitorBase< Const > &

S

)

Definition at line 82 of file ImportExportCommands.cpp.

                                                                 {
   wxFileName fn = FileNames::FindDefaultPath(FileNames::Operation::Export);
   fn.SetName("exported.wav");
   S.Define(mFileName, wxT("Filename"), fn.GetFullPath());
   S.Define( mnChannels, wxT("NumChannels"),  1 );
   return true;
}

References FileNames::FindDefaultPath(), fn, mFileName, mnChannels, S, and wxT().

Here is the call graph for this function:

Member Data Documentation

mFileName

wxString ExportCommand::mFileName

Definition at line 63 of file ImportExportCommands.h.

Referenced by Apply(), PopulateOrExchange(), and VisitSettings().

mnChannels

int ExportCommand::mnChannels

Definition at line 64 of file ImportExportCommands.h.

Referenced by Apply(), PopulateOrExchange(), and VisitSettings().

Symbol

const ComponentInterfaceSymbol ExportCommand::Symbol { XO("Export2") }

static

Definition at line 49 of file ImportExportCommands.h.

Referenced by GetSymbol().

---

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

• ImportExportCommands.h
• ImportExportCommands.cpp