ExportOptionsCLEditor Class Reference

Inheritance diagram for ExportOptionsCLEditor:

Collaboration diagram for ExportOptionsCLEditor:

Public Member Functions
	ExportOptionsCLEditor ()=default
void	PopulateUI (ShuttleGui &S) override
bool	TransferDataFromWindow () override
SampleRateList	GetSampleRateList () const override
int	GetOptionsCount () const override
bool	GetOption (int index, ExportOption &option) const override
bool	GetValue (int id, ExportValue &value) const override
bool	SetValue (int id, const ExportValue &value) override
void	Load (const audacity::BasicSettings &config) override
void	Store (audacity::BasicSettings &config) const override
Public Member Functions inherited from ExportOptionsEditor
virtual	~ExportOptionsEditor ()
virtual int	GetOptionsCount () const =0
virtual bool	GetOption (int index, ExportOption &option) const =0
virtual bool	GetValue (ExportOptionID id, ExportValue &value) const =0
virtual bool	SetValue (ExportOptionID id, const ExportValue &value)=0
virtual SampleRateList	GetSampleRateList () const =0
virtual void	Store (audacity::BasicSettings &settings) const =0
virtual void	Load (const audacity::BasicSettings &config)=0
Public Member Functions inherited from ExportOptionsUIServices
virtual	~ExportOptionsUIServices ()
virtual void	PopulateUI (ShuttleGui &)=0
virtual bool	TransferDataFromWindow ()=0

Static Public Member Functions
static bool	IsValidCommand (const wxString &command)

Private Member Functions
void	OnBrowse (const wxCommandEvent &)

Private Attributes
wxString	mCommand {wxT("lame - \"%f\"")}
bool	mShowOutput {false}
bool	mInitialized {false}
wxWindow *	mParent {nullptr}
wxComboBox *	mCommandBox {nullptr}
wxString	mLastCommand
FileHistory	mHistory

Additional Inherited Members
Public Types inherited from ExportOptionsEditor
using	SampleRateList = std::vector< int >

Detailed Description

Definition at line 170 of file ExportCL.cpp.

Constructor & Destructor Documentation

ExportOptionsCLEditor()

ExportOptionsCLEditor::ExportOptionsCLEditor ( )

default

Member Function Documentation

GetOption()

bool ExportOptionsCLEditor::GetOption ( int  index, ExportOption &  option  ) const

inlineoverridevirtual

Implements ExportOptionsEditor.

Definition at line 322 of file ExportCL.cpp.

   {
      if(index >= 0 && index < static_cast<int>(CLOptions.size()))
      {
         option = CLOptions[index];
         return true;
      }
      return false;
   }

References CLOptions.

GetOptionsCount()

int ExportOptionsCLEditor::GetOptionsCount ( ) const

inlineoverridevirtual

Implements ExportOptionsEditor.

Definition at line 317 of file ExportCL.cpp.

   {
      return static_cast<int>(CLOptions.size());
   }

References CLOptions.

GetSampleRateList()

SampleRateList ExportOptionsCLEditor::GetSampleRateList ( ) const

inlineoverridevirtual

Implements ExportOptionsEditor.

Definition at line 312 of file ExportCL.cpp.

   {
      return {};
   }

GetValue()

bool ExportOptionsCLEditor::GetValue ( int  id, ExportValue &  value  ) const

inlineoverridevirtual

Implements ExportOptionsEditor.

Definition at line 332 of file ExportCL.cpp.

   {
      if(id == CLOptionIDCommand)
      {
         value = std::string(mCommand.ToUTF8());
         return true;
      }
      if(id == CLOptionIDShowOutput)
      {
         value = mShowOutput;
         return true;
      }
      return false;
   }

References CLOptionIDCommand, CLOptionIDShowOutput, mCommand, and mShowOutput.

IsValidCommand()

static bool ExportOptionsCLEditor::IsValidCommand ( const wxString &  command )

inlinestatic

Definition at line 243 of file ExportCL.cpp.

   {
      wxArrayString argv = wxCmdLineParser::ConvertStringToArgs(command,
#if defined(__WXMSW__)
         wxCMD_LINE_SPLIT_DOS
#else
         wxCMD_LINE_SPLIT_UNIX
#endif
      );
 
      if (argv.empty()) {
         ShowExportErrorDialog(
            XO("Warning"),
            XO("Program name appears to be missing."),//":745"
            true);
         return false;
      }
         
      // Normalize the path (makes absolute and resolves variables)   
      wxFileName cmd(argv[0]);
      cmd.Normalize(wxPATH_NORM_ALL & ~wxPATH_NORM_ABSOLUTE);
 
      // Just verify the given path exists if it is absolute.
      if (cmd.IsAbsolute()) {
         if (!cmd.Exists()) {
            BasicUI::ShowMessageBox(XO("\"%s\" couldn't be found.").Format(cmd.GetFullPath()),
                                    BasicUI::MessageBoxOptions()
                                       .IconStyle(BasicUI::Icon::Warning)
                                       .Caption(XO("Warning")));
            return false;
         }
 
         return true;
      }
    
      // Search for the command in the PATH list
      wxPathList pathlist;
      pathlist.AddEnvList(wxT("PATH"));
      wxString path = pathlist.FindAbsoluteValidPath(argv[0]);
 
   #if defined(__WXMSW__)
      if (path.empty()) {
         path = pathlist.FindAbsoluteValidPath(argv[0] + wxT(".exe"));
      }
   #endif
 
      if (path.empty()) {
         BasicUI::ShowMessageBox(XO("Unable to locate \"%s\" in your path.").Format(cmd.GetFullPath()),
                                 BasicUI::MessageBoxOptions()
                                    .IconStyle(BasicUI::Icon::Warning)
                                    .Caption(XO("Warning")));
         return false;
      }
 
      return true;
   }

References CommandLineArgs::argv, BasicUI::MessageBoxOptions::Caption(), BasicUI::MessageBoxOptions::IconStyle(), ShowExportErrorDialog(), BasicUI::ShowMessageBox(), BasicUI::Warning, wxT(), and XO().

Referenced by TransferDataFromWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

Load()

void ExportOptionsCLEditor::Load ( const audacity::BasicSettings &  config )

inlineoverridevirtual

Implements ExportOptionsEditor.

Definition at line 362 of file ExportCL.cpp.

   {
      mCommand = config.Read(wxT("/FileFormats/ExternalProgramExportCommand"), mCommand);
      mShowOutput = config.Read(wxT("/FileFormats/ExternalProgramShowOutput"), mShowOutput);
   }

References mCommand, mShowOutput, audacity::BasicSettings::Read(), and wxT().

Here is the call graph for this function:

OnBrowse()

void ExportOptionsCLEditor::OnBrowse ( const wxCommandEvent &  )

inlineprivate

Definition at line 376 of file ExportCL.cpp.

   {
      wxString path;
      FileExtension ext;
      FileNames::FileType type = FileNames::AllFiles;
 
   #if defined(__WXMSW__)
      ext = wxT("exe");
      /* i18n-hint files that can be run as programs */
      type = { XO("Executables"), { ext } };
   #endif
 
      path = SelectFile(FileNames::Operation::Open,
         XO("Find path to command"),
         wxEmptyString,
         wxEmptyString,
         ext,
         { type },
         wxFD_OPEN | wxRESIZE_BORDER,
         mParent);
      if (path.empty()) {
         return;
      }
 
      if (path.Find(wxT(' ')) != wxNOT_FOUND)
         path = wxT('"') + path + wxT('"');
 
      mCommandBox->SetValue(path);
      mCommandBox->SetInsertionPointEnd();
   }

References FileNames::AllFiles, mCommandBox, mParent, SelectFile(), wxT(), and XO().

Referenced by PopulateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateUI()

void ExportOptionsCLEditor::PopulateUI ( ShuttleGui &  S )

inlineoverridevirtual

Implements ExportOptionsUIServices.

Definition at line 181 of file ExportCL.cpp.

   {
      if(!mInitialized)
      {
         mHistory.Load(*gPrefs, wxT("/FileFormats/ExternalProgramHistory"));
 
         if (mHistory.empty()) {
            mHistory.Append(wxT("ffmpeg -i - \"%f.opus\""));
            mHistory.Append(wxT("ffmpeg -i - \"%f.wav\""));
            mHistory.Append(wxT("ffmpeg -i - \"%f\""));
            mHistory.Append(wxT("lame - \"%f\""));
         }
 
         if(!mCommand.empty())
            mHistory.Append(mCommand);
 
         mInitialized = true;
      }
 
      mParent = wxGetTopLevelParent(S.GetParent());
 
      wxArrayStringEx cmds( mHistory.begin(), mHistory.end() );
      auto cmd = cmds[0];
      
      S.StartVerticalLay();
      {
         S.StartHorizontalLay(wxEXPAND);
         {
            S.SetSizerProportion(1);
            S.StartMultiColumn(3, wxEXPAND);
            {
               S.SetStretchyCol(1);
               mCommandBox = S.AddCombo(XXO("Command:"),
                                 cmd,
                                 cmds);
               mCommandBox->Bind(wxEVT_TEXT, [this](wxCommandEvent& event) {
                  mLastCommand = event.GetString();
               });
               mLastCommand = mCommandBox->GetValue();
               mCommandBox->SetMaxSize(wxSize(50,400));
 
               S.AddButton(XXO("Browse..."), wxALIGN_CENTER_VERTICAL)
                  ->Bind(wxEVT_BUTTON, &ExportOptionsCLEditor::OnBrowse, this);
 
               S.AddFixedText( {} );
               S.TieCheckBox(XXO("Show output"), mShowOutput);
            }
            S.EndMultiColumn();
         }
         S.EndHorizontalLay();
 
         S.AddTitle(XO(
   /* i18n-hint: Some programmer-oriented terminology here:
      "Data" refers to the sound to be exported, "piped" means sent,
      and "standard in" means the default input stream that the external program,
      named by %f, will read.  And yes, it's %f, not %s -- this isn't actually used
      in the program as a format string.  Keep %f unchanged. */
   "Data will be piped to standard in. \"%f\" uses the file name in the export window."), 250);
      }
      S.EndVerticalLay();
   }

References FileHistory::Append(), FileHistory::begin(), FileHistory::empty(), FileHistory::end(), gPrefs, FileHistory::Load(), mCommand, mCommandBox, mHistory, mInitialized, mLastCommand, mParent, mShowOutput, OnBrowse(), S, wxT(), XO(), and XXO().

Here is the call graph for this function:

SetValue()

bool ExportOptionsCLEditor::SetValue ( int  id, const ExportValue &  value  )

inlineoverridevirtual

Implements ExportOptionsEditor.

Definition at line 347 of file ExportCL.cpp.

   {
      if(id == CLOptionIDCommand && std::holds_alternative<std::string>(value))
      {
         mCommand = wxString::FromUTF8(*std::get_if<std::string>(&value));
         return true;
      }
      if(id == CLOptionIDShowOutput && std::holds_alternative<bool>(value))
      {
         mShowOutput = *std::get_if<bool>(&value);
         return true;
      }
      return false;
   }

References CLOptionIDCommand, CLOptionIDShowOutput, mCommand, and mShowOutput.

Store()

void ExportOptionsCLEditor::Store ( audacity::BasicSettings &  config ) const

inlineoverridevirtual

Implements ExportOptionsEditor.

Definition at line 368 of file ExportCL.cpp.

   {
      config.Write(wxT("/FileFormats/ExternalProgramExportCommand"), mCommand);
      config.Write(wxT("/FileFormats/ExternalProgramShowOutput"), mShowOutput);
   }

References mCommand, mShowOutput, audacity::BasicSettings::Write(), and wxT().

Here is the call graph for this function:

TransferDataFromWindow()

bool ExportOptionsCLEditor::TransferDataFromWindow ( )

inlineoverridevirtual

Implements ExportOptionsUIServices.

Definition at line 300 of file ExportCL.cpp.

   {
      if(IsValidCommand(mLastCommand))
      {
         mCommand = mLastCommand;
         mHistory.Append(mCommand);
         mHistory.Save(*gPrefs);
         return true;
      }
      return false;
   }

References FileHistory::Append(), gPrefs, IsValidCommand(), mCommand, mHistory, mLastCommand, and FileHistory::Save().

Here is the call graph for this function:

Member Data Documentation

mCommand

wxString ExportOptionsCLEditor::mCommand {wxT("lame - \"%f\"")}

private

Definition at line 174 of file ExportCL.cpp.

Referenced by GetValue(), Load(), PopulateUI(), SetValue(), Store(), and TransferDataFromWindow().

mCommandBox

wxComboBox* ExportOptionsCLEditor::mCommandBox {nullptr}

private

Definition at line 408 of file ExportCL.cpp.

Referenced by OnBrowse(), and PopulateUI().

mHistory

FileHistory ExportOptionsCLEditor::mHistory

private

Definition at line 415 of file ExportCL.cpp.

Referenced by PopulateUI(), and TransferDataFromWindow().

mInitialized

bool ExportOptionsCLEditor::mInitialized {false}

private

Definition at line 176 of file ExportCL.cpp.

Referenced by PopulateUI().

mLastCommand

wxString ExportOptionsCLEditor::mLastCommand

private

Definition at line 413 of file ExportCL.cpp.

Referenced by PopulateUI(), and TransferDataFromWindow().

mParent

wxWindow* ExportOptionsCLEditor::mParent {nullptr}

private

Definition at line 407 of file ExportCL.cpp.

Referenced by OnBrowse(), and PopulateUI().

mShowOutput

bool ExportOptionsCLEditor::mShowOutput {false}

private

Definition at line 175 of file ExportCL.cpp.

Referenced by GetValue(), Load(), PopulateUI(), SetValue(), and Store().

---

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

• ExportCL.cpp