#include <ExportFilePanel.h>

Inheritance diagram for ExportFilePanel:

Collaboration diagram for ExportFilePanel:

Public Member Functions
	ExportFilePanel (AudacityProject &project, bool monoStereoMode=false, wxWindow *parent=nullptr, wxWindowID winid=wxID_ANY)

	~ExportFilePanel () override

void	PopulateOrExchange (ShuttleGui &S)

void	Init (const wxFileName &filename, int sampleRate, const wxString &format=wxEmptyString, int channels=0, const ExportProcessor::Parameters &parameters={}, const MixerOptions::Downmix *mixerSpec=nullptr)
	Initializes panel with export settings provided as arguments. Call is required. More...

void	SetInitialFocus ()

void	SetCustomMappingEnabled (bool enabled)

wxString	GetPath () const

wxString	GetFullName ()

const ExportPlugin *	GetPlugin () const

int	GetFormat () const

int	GetSampleRate () const

std::optional< ExportProcessor::Parameters >	GetParameters () const

int	GetChannels () const

MixerOptions::Downmix *	GetMixerSpec () const

Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()

	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL\|wxNO_BORDER, const TranslatableString &name=XO("Panel"))

bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL\|wxNO_BORDER, const TranslatableString &name=XO("Panel"))

void	SetLabel (const TranslatableString &label)

void	SetName (const TranslatableString &name)

void	SetToolTip (const TranslatableString &toolTip)

void	SetName ()

Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)

	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete

	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete

wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete

wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
void	ValidateAndFixExt ()

void	OnFullNameFocusKill (wxFocusEvent &event)

void	OnFormatChange (wxCommandEvent &event)

void	OnSampleRateChange (wxCommandEvent &event)

void	OnFolderBrowse (wxCommandEvent &event)

void	OnChannelsChange (wxCommandEvent &event)

void	OnChannelsConfigure (wxCommandEvent &event)

void	ChangeFormat (int index)

void	OnOptionsHandlerEvent (const ExportOptionsHandlerEvent &e)

void	UpdateSampleRateList ()

void	UpdateMaxChannels (unsigned maxChannels)

Private Attributes
AudacityProject &	mProject

bool	mMonoStereoMode {false}

wxChoice *	mFormat {}

wxChoice *	mRates {}

wxWindow *	mAudioOptionsPanel {}

wxTextCtrl *	mFolder {}

wxTextCtrl *	mFullName {}

wxRadioButton *	mMono {}

wxRadioButton *	mStereo {}

wxRadioButton *	mCustomMapping {}

wxButton *	mCustomizeChannels {}

int	mSampleRate {}

const ExportPlugin *	mSelectedPlugin {}

int	mSelectedFormatIndex {}

std::unique_ptr< ExportOptionsHandler >	mOptionsHandler

std::unique_ptr< MixerOptions::Downmix >	mMixerSpec

Observer::Subscription	mOptionsChangeSubscription

Static Private Attributes
static constexpr auto	MaxExportChannels = 32u

Detailed Description

Definition at line 27 of file ExportFilePanel.h.

Constructor & Destructor Documentation

◆ ExportFilePanel()

ExportFilePanel::ExportFilePanel	(	AudacityProject &	project,
		bool	monoStereoMode = `false`,
		wxWindow *	parent = `nullptr`,
		wxWindowID	winid = `wxID_ANY`
	)

Definition at line 132 of file ExportFilePanel.cpp.

   : wxPanelWrapper(parent, winid)
   , mMonoStereoMode(monoStereoMode)
   , mProject(project)
{
   ShuttleGui S(this, eIsCreating);
   PopulateOrExchange(S);
}

References eIsCreating, and S.

◆ ~ExportFilePanel()

ExportFilePanel::~ExportFilePanel ( )

overridedefault

Member Function Documentation

◆ ChangeFormat()

void ExportFilePanel::ChangeFormat ( int index )

private

Definition at line 496 of file ExportFilePanel.cpp.

{
   mSelectedPlugin = nullptr;
 
   wxWindowUpdateLocker wndupdlck(mAudioOptionsPanel);
 
   auto formatCounter = 0;
 
   for(auto [plugin, formatIndex] : ExportPluginRegistry::Get())
   {
      if(formatCounter != index)
      {
         ++formatCounter;
         continue;
      }
 
      mOptionsChangeSubscription.Reset();
 
      mSelectedPlugin = plugin;
      mSelectedFormatIndex = formatIndex;
 
      ValidateAndFixExt();
 
      mAudioOptionsPanel->SetSizer(nullptr);
      mAudioOptionsPanel->DestroyChildren();
      
      ShuttleGui S(mAudioOptionsPanel, eIsCreating, true, {1, 1});
      mOptionsHandler = std::make_unique<ExportOptionsHandler>(S, *plugin, formatIndex);
      mOptionsChangeSubscription = mOptionsHandler->Subscribe(*this, &ExportFilePanel::OnOptionsHandlerEvent);
 
      const auto formatInfo = plugin->GetFormatInfo(formatIndex);
      UpdateMaxChannels(formatInfo.maxChannels);
      
      UpdateSampleRateList();
      
      mAudioOptionsPanel->Layout();
      
      wxPostEvent(GetParent(), wxCommandEvent { AUDACITY_EXPORT_FORMAT_CHANGE_EVENT, GetId() });
      
      return;
   }
}

References eIsCreating, ExportPluginRegistry::Get(), mAudioOptionsPanel, mOptionsChangeSubscription, mOptionsHandler, mSelectedFormatIndex, mSelectedPlugin, OnOptionsHandlerEvent(), Observer::Subscription::Reset(), S, UpdateMaxChannels(), UpdateSampleRateList(), and ValidateAndFixExt().

Referenced by Init(), OnFolderBrowse(), and OnFormatChange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetChannels()

int ExportFilePanel::GetChannels ( ) const

Definition at line 352 of file ExportFilePanel.cpp.

{
   if(mCustomMapping != nullptr && mCustomMapping->GetValue())
      return 0;
   return mMono->GetValue() ? 1 : 2;
}

References mCustomMapping, and mMono.

Referenced by ExportAudioDialog::OnExport(), TimerRecordExportDialog::OnOK(), ExportAudioDialog::UpdateLabelExportSettings(), and ExportAudioDialog::UpdateTrackExportSettings().

Here is the caller graph for this function:

◆ GetFormat()

int ExportFilePanel::GetFormat ( ) const

Definition at line 335 of file ExportFilePanel.cpp.

{
   return mSelectedFormatIndex;
}

References mSelectedFormatIndex.

Referenced by ExportAudioDialog::OnExport(), ExportAudioDialog::OnFormatChange(), TimerRecordExportDialog::OnFormatChanged(), TimerRecordExportDialog::OnOK(), and ExportAudioDialog::UpdateExportSettings().

Here is the caller graph for this function:

◆ GetFullName()

wxString ExportFilePanel::GetFullName ( )

Definition at line 324 of file ExportFilePanel.cpp.

{
   ValidateAndFixExt();
   return mFullName->GetValue();
}

References mFullName, and ValidateAndFixExt().

Referenced by ExportAudioDialog::OnExport(), TimerRecordExportDialog::OnOK(), ExportAudioDialog::UpdateLabelExportSettings(), and ExportAudioDialog::UpdateTrackExportSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMixerSpec()

MixerOptions::Downmix * ExportFilePanel::GetMixerSpec ( ) const

Definition at line 359 of file ExportFilePanel.cpp.

{
   return mMixerSpec.get();
}

References mMixerSpec.

Referenced by ExportAudioDialog::OnExport().

Here is the caller graph for this function:

◆ GetParameters()

std::optional< ExportProcessor::Parameters > ExportFilePanel::GetParameters ( ) const

Returns: May return std::nullopt if plugin isn't properly configured

Definition at line 345 of file ExportFilePanel.cpp.

{
   if(mOptionsHandler->TransferDataFromEditor())
      return { mOptionsHandler->GetParameters() };
   return std::nullopt;
}

References mOptionsHandler.

Referenced by ExportAudioDialog::OnExport(), and TimerRecordExportDialog::OnOK().

Here is the caller graph for this function:

◆ GetPath()

wxString ExportFilePanel::GetPath ( ) const

Definition at line 319 of file ExportFilePanel.cpp.

{
   return mFolder->GetValue();
}

References mFolder.

Referenced by ExportAudioDialog::OnExport(), TimerRecordExportDialog::OnOK(), ExportAudioDialog::UpdateLabelExportSettings(), and ExportAudioDialog::UpdateTrackExportSettings().

Here is the caller graph for this function:

◆ GetPlugin()

const ExportPlugin * ExportFilePanel::GetPlugin ( ) const

Definition at line 330 of file ExportFilePanel.cpp.

{
   return mSelectedPlugin;
}

References mSelectedPlugin.

Referenced by ExportAudioDialog::OnExport(), ExportAudioDialog::OnFormatChange(), TimerRecordExportDialog::OnFormatChanged(), TimerRecordExportDialog::OnOK(), and ExportAudioDialog::UpdateExportSettings().

Here is the caller graph for this function:

◆ GetSampleRate()

int ExportFilePanel::GetSampleRate ( ) const

Definition at line 340 of file ExportFilePanel.cpp.

{
   return mSampleRate;
}

References mSampleRate.

Referenced by ExportAudioDialog::OnExport(), and TimerRecordExportDialog::OnOK().

Here is the caller graph for this function:

◆ Init()

void ExportFilePanel::Init	(	const wxFileName &	filename,
		int	sampleRate,
		const wxString &	format = `wxEmptyString`,
		int	channels = `0`,
		const ExportProcessor::Parameters &	parameters = `{}`,
		const MixerOptions::Downmix *	mixerSpec = `nullptr`
	)

Initializes panel with export settings provided as arguments. Call is required.

Parameters

filename	Default output filename
sampleRate	Export sample rate > 0
format	Export format string identifier (see FormatInfo::format)
channels	Pass 0(default) to choose automatically depending on project tracks
parameters	Pass empty(default) array to initialize with plugin defaults
mixerSpec	Try use custom channel mapping, `channels` argument will be igonred

Definition at line 228 of file ExportFilePanel.cpp.

{
   mFolder->SetValue(filename.GetPath());
   mFullName->SetValue(filename.GetFullName());
   mSampleRate = sampleRate;
 
   auto selectedFormatIndex = 0;
   if(!format.empty())
   {
      auto counter = 0;
      for(auto [plugin, formatIndex] : ExportPluginRegistry::Get())
      {
         if(plugin->GetFormatInfo(formatIndex).format.IsSameAs(format))
         {
            selectedFormatIndex = counter;
            break;
         }
         ++counter;
      }
   }
 
   if(mixerSpec != nullptr)
   {
      assert(!mMonoStereoMode);
      *mMixerSpec = *mixerSpec;
      mCustomMapping->SetValue(true);
   }
   else
   {
      int numChannels = channels;
      if(numChannels == 0)
      {
         numChannels = 1;
         const auto waveTracks =
            ExportUtils::FindExportWaveTracks(
               TrackList::Get(mProject),
               false);
         for(const auto track : waveTracks)
         {
            if(track->NChannels() >= 2 || track->GetPan() != .0f)
            {
               numChannels = 2;
               break;
            }
         }
      }
      if(numChannels == 1)
         mMono->SetValue(true);
      else
         mStereo->SetValue(true);
   }
 
   mFormat->SetSelection(selectedFormatIndex);
 
   ChangeFormat(selectedFormatIndex);
 
   if(!parameters.empty())
      mOptionsHandler->SetParameters(parameters);
 
   if(mCustomizeChannels != nullptr)
      mCustomizeChannels->Enable(mCustomMapping->GetValue());
}

References ChangeFormat(), ExportUtils::FindExportWaveTracks(), anonymous_namespace{ExportPCM.cpp}::format, ExportPluginRegistry::Get(), TrackList::Get(), mCustomizeChannels, mCustomMapping, mFolder, mFormat, mFullName, mMixerSpec, mMono, mMonoStereoMode, mOptionsHandler, mProject, mSampleRate, mStereo, and anonymous_namespace{ClipSegmentTest.cpp}::sampleRate.

Referenced by TimerRecordExportDialog::Bind().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnChannelsChange()

void ExportFilePanel::OnChannelsChange ( wxCommandEvent & event )

private

Definition at line 472 of file ExportFilePanel.cpp.

{
   if(mCustomizeChannels != nullptr)
      mCustomizeChannels->Enable(event.GetId() == AudioMixModeCustomID);
}

References anonymous_namespace{ExportFilePanel.cpp}::AudioMixModeCustomID, and mCustomizeChannels.

◆ OnChannelsConfigure()

void ExportFilePanel::OnChannelsConfigure ( wxCommandEvent & event )

private

Definition at line 478 of file ExportFilePanel.cpp.

{
   //Configure for all tracks, but some channels may turn out to be silent
   //if exported region does not contain audio samples
   auto waveTracks = TrackList::Get(mProject).Any<const WaveTrack>();
   
   auto mixerSpec = std::make_unique<MixerOptions::Downmix>(*mMixerSpec);
   
   ExportMixerDialog md(waveTracks,
                        mixerSpec.get(),
                        nullptr,
                        1,
                        XO("Advanced Mixing Options"));
   if(md.ShowModal() == wxID_OK)
      mMixerSpec.swap(mixerSpec);
}

References TrackList::Any(), TrackList::Get(), mMixerSpec, mProject, and XO().

Here is the call graph for this function:

◆ OnFolderBrowse()

void ExportFilePanel::OnFolderBrowse ( wxCommandEvent & event )

private

Definition at line 442 of file ExportFilePanel.cpp.

{
   FileNames::FileTypes fileTypes;
   
   for(auto [plugin, formatIndex] : ExportPluginRegistry::Get())
   {
      const auto formatInfo = plugin->GetFormatInfo(formatIndex);
      fileTypes.emplace_back(formatInfo.description, formatInfo.extensions);
   }
   wxFileDialog fd(this, _("Choose a location to save the exported files"),
      mFolder->GetValue(),
      mFullName->GetValue(),
      FileNames::FormatWildcard(fileTypes),
      wxFD_SAVE);
   fd.SetFilterIndex(mFormat->GetSelection());
 
   if(fd.ShowModal() == wxID_OK)
   {
      wxFileName filepath (fd.GetPath());
      mFolder->SetValue(filepath.GetPath());
      mFullName->SetValue(filepath.GetFullName());
      const auto selectedFormat = fd.GetFilterIndex();
      if(selectedFormat != mFormat->GetSelection())
      {
         mFormat->SetSelection(selectedFormat);
         ChangeFormat(selectedFormat);
      }
   }
}

References _, ChangeFormat(), FileNames::FormatWildcard(), ExportPluginRegistry::Get(), mFolder, mFormat, and mFullName.

Here is the call graph for this function:

◆ OnFormatChange()

void ExportFilePanel::OnFormatChange ( wxCommandEvent & event )

private

Definition at line 419 of file ExportFilePanel.cpp.

{
   ChangeFormat(event.GetInt());
   event.Skip();
}

References ChangeFormat().

Here is the call graph for this function:

◆ OnFullNameFocusKill()

void ExportFilePanel::OnFullNameFocusKill ( wxFocusEvent & event )

private

Definition at line 409 of file ExportFilePanel.cpp.

{
   //When user has finished typing make sure that file extension
   //is one of extensions supplied by FormatInfo
 
   event.Skip();
 
   ValidateAndFixExt();
}

References ValidateAndFixExt().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnOptionsHandlerEvent()

void ExportFilePanel::OnOptionsHandlerEvent ( const ExportOptionsHandlerEvent & e )

private

Definition at line 539 of file ExportFilePanel.cpp.

{
   switch(e.type)
   {
   case ExportOptionsHandlerEvent::SampleRateListChange:
      UpdateSampleRateList();
      break;
   case ExportOptionsHandlerEvent::FormatInfoChange:
      {
         const auto formatInfo = mSelectedPlugin->GetFormatInfo(mSelectedFormatIndex);
         ValidateAndFixExt();
         UpdateMaxChannels(formatInfo.maxChannels);
      } break;
   }
   
}

References ExportOptionsHandlerEvent::FormatInfoChange, ExportPlugin::GetFormatInfo(), mSelectedFormatIndex, mSelectedPlugin, ExportOptionsHandlerEvent::SampleRateListChange, ExportOptionsHandlerEvent::type, UpdateMaxChannels(), UpdateSampleRateList(), and ValidateAndFixExt().

Referenced by ChangeFormat().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnSampleRateChange()

void ExportFilePanel::OnSampleRateChange ( wxCommandEvent & event )

private

Definition at line 425 of file ExportFilePanel.cpp.

{
   const auto clientData = event.GetClientData();
   if(clientData == nullptr)
   {
      CustomSampleRateDialog dialog(this, mSampleRate);
      if(dialog.ShowModal() == wxID_OK &&
         dialog.GetSampleRate() > 0)
      {
         mSampleRate = dialog.GetSampleRate();
      }
      UpdateSampleRateList();
   }
   else
      mSampleRate = *reinterpret_cast<const int*>(&clientData);
}

References mSampleRate, and UpdateSampleRateList().

Here is the call graph for this function:

◆ PopulateOrExchange()

void ExportFilePanel::PopulateOrExchange ( ShuttleGui & S )

Definition at line 146 of file ExportFilePanel.cpp.

{
   TranslatableStrings formats;
   if(S.GetMode() == eIsCreating)
   {
      for(auto [plugin, formatIndex] : ExportPluginRegistry::Get())
      {
         auto formatInfo = plugin->GetFormatInfo(formatIndex);
         formats.push_back(formatInfo.description);
      }
   }
 
   S.SetBorder(5);
   S.StartMultiColumn(3, wxEXPAND);
   {
      S.SetStretchyCol(1);
      
      mFullName = S.AddTextBox(XO("File &Name:"), {}, 0);
      mFullName->Bind(wxEVT_KILL_FOCUS, &ExportFilePanel::OnFullNameFocusKill, this);
      S.AddSpace(1);
      
      mFolder = S.AddTextBox(XO("Fo&lder:"), {}, 0);
      S.Id(FolderBrowseID).AddButton(XO("&Browse..."));
      
      mFormat = S.Id(FormatID).AddChoice(XO("&Format:"), formats);
      S.AddSpace(1);
   }
   S.EndMultiColumn();
   
   S.SetBorder(5);
   S.StartStatic(XO("Audio options"));
   {
      S.StartTwoColumn();
      {
         if(auto prompt = S.AddPrompt(XO("Channels")))
            prompt->SetMinSize({140, -1});
 
         S.StartHorizontalLay(wxALIGN_LEFT);
         {
            S.SetBorder(2);
 
            const int channels = 2;
 
            mMono = S.Id(AudioMixModeMonoID).AddRadioButton(XO("M&ono"), 1, channels);
            mStereo = S.Id(AudioMixModeStereoID).AddRadioButtonToGroup(XO("&Stereo"), 2, channels);
            if(!mMonoStereoMode)
            {
               //i18n-hint refers to custom channel mapping configuration
               mCustomMapping = S.Id(AudioMixModeCustomID).AddRadioButtonToGroup(XO("Custom mappin&g"), 0, true);
               mCustomizeChannels = S.Id(AudioChannelsConfigureID)
                  //i18n-hint accessibility hint, refers to export channel configuration
                  .Name(XO("Configure custom mapping"))
                  .AddButton(XO("Configure"));
#if wxUSE_ACCESSIBILITY
                  safenew WindowAccessible(mCustomizeChannels);
#endif
            }
         }
         S.EndHorizontalLay();
 
         S.SetBorder(5);
 
         if(auto prompt = S.AddPrompt(XO("Sample &Rate")))
            prompt->SetMinSize({140, -1});
 
         S.StartHorizontalLay(wxALIGN_LEFT);
         {
            mRates = S.Id(SampleRateID).AddChoice({}, {});
         }
         S.EndHorizontalLay();
      }
      S.EndTwoColumn();
      
      mAudioOptionsPanel = S.StartPanel();
      {
         
      }
      S.EndPanel();
   }
   S.EndStatic();
}

References anonymous_namespace{ExportFilePanel.cpp}::AudioChannelsConfigureID, anonymous_namespace{ExportFilePanel.cpp}::AudioMixModeCustomID, anonymous_namespace{ExportFilePanel.cpp}::AudioMixModeMonoID, anonymous_namespace{ExportFilePanel.cpp}::AudioMixModeStereoID, eIsCreating, anonymous_namespace{ExportFilePanel.cpp}::FolderBrowseID, anonymous_namespace{ExportFilePanel.cpp}::FormatID, ExportPluginRegistry::Get(), mAudioOptionsPanel, mCustomizeChannels, mCustomMapping, mFolder, mFormat, mFullName, mMono, mMonoStereoMode, mRates, mStereo, OnFullNameFocusKill(), S, safenew, anonymous_namespace{ExportFilePanel.cpp}::SampleRateID, and XO().

Here is the call graph for this function:

◆ SetCustomMappingEnabled()

void ExportFilePanel::SetCustomMappingEnabled ( bool enabled )

Definition at line 303 of file ExportFilePanel.cpp.

{
   if(mMonoStereoMode)
      return;
 
   if(!enabled && mCustomMapping->GetValue())
   {
      if(mStereo->IsEnabled())
         mStereo->SetValue(true);
      else
         mMono->SetValue(true);
   }
   mCustomMapping->Enable(enabled);
   mCustomizeChannels->Enable(enabled);
}

References mCustomizeChannels, mCustomMapping, mMono, mMonoStereoMode, and mStereo.

Referenced by ExportAudioDialog::OnExportRangeChange().

Here is the caller graph for this function:

◆ SetInitialFocus()

void ExportFilePanel::SetInitialFocus ( )

Definition at line 297 of file ExportFilePanel.cpp.

{
   mFullName->SetFocus();
   mFullName->SelectAll();
}

References mFullName.

Referenced by ExportAudioDialog::Show().

Here is the caller graph for this function:

◆ UpdateMaxChannels()

void ExportFilePanel::UpdateMaxChannels ( unsigned maxChannels )

private

Definition at line 556 of file ExportFilePanel.cpp.

{
   if(maxChannels < 2 && mStereo->GetValue())
      mMono->SetValue(true);
   mStereo->Enable(maxChannels > 1);
   if(!mMonoStereoMode)
   {
      const auto mixerMaxChannels = std::clamp(
         maxChannels,
         // JKC: This is an attempt to fix a 'watching brief' issue, where the slider is
         // sometimes not slidable.  My suspicion is that a mixer may incorrectly
         // state the number of channels - so we assume there are always at least two.
         // The downside is that if someone is exporting to a mono device, the dialog
         // will allow them to output to two channels. Hmm.  We may need to revisit this.
         // STF (April 2016): AMR (narrowband) and MP3 may export 1 channel.
         1u,
         MaxExportChannels);
      if(!mMixerSpec || mMixerSpec->GetMaxNumChannels() != mixerMaxChannels)
      {
         auto waveTracks = TrackList::Get(mProject).Any<const WaveTrack>();
         mMixerSpec = std::make_unique<MixerOptions::Downmix>(
            waveTracks.sum([](const auto track) { return track->NChannels(); }),
            mixerMaxChannels);
      }
   }
}

References TrackList::Any(), TrackList::Get(), MaxExportChannels, mMixerSpec, mMono, mMonoStereoMode, mProject, and mStereo.

Referenced by ChangeFormat(), and OnOptionsHandlerEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateSampleRateList()

void ExportFilePanel::UpdateSampleRateList ( )

private

Definition at line 583 of file ExportFilePanel.cpp.

{
   auto availableRates = mOptionsHandler->GetSampleRateList();
   std::sort(availableRates.begin(), availableRates.end());
 
   const auto* rates = availableRates.empty() ? &DefaultRates : &availableRates;
   
   mRates->Clear();
   
   void* clientData;
   int customRate = mSampleRate;
   int selectedItemIndex = 0;
   //Prefer lowest possible sample rate that is not less than mSampleRate.
   //Initialize with highest value, so that if all available rates are less
   //than mSampleRate then we will choose highest rate
   int preferredRate = rates->back();
   int preferredItemIndex = rates->size() - 1;
   for(auto rate : *rates)
   {
      *reinterpret_cast<int*>(&clientData) = rate;
      const auto itemIndex =
         mRates->Append(
            XO("%d Hz").Format(rate).Translation(),
            clientData);
      if(rate == mSampleRate)
      {
         customRate = 0;
         selectedItemIndex = itemIndex;
      }
      if(rate >= mSampleRate && rate < preferredRate)
      {
         preferredItemIndex = itemIndex;
         preferredRate = rate;
      }
   }
   
   if(rates == &DefaultRates)
   {
      if(customRate != 0)
      {
         *reinterpret_cast<int*>(&clientData) = customRate;
         selectedItemIndex =
            mRates->Append(
               XO("%d Hz (custom)").Format(customRate).Translation(),
               clientData);
      }
      mRates->Append(_("Other..."));
   }
   else if(customRate != 0)//sample rate not in the list
   {
      auto selectedRate = (*rates)[preferredItemIndex];
      mSampleRate = selectedRate;
      selectedItemIndex = preferredItemIndex;
   }
   mRates->SetSelection(selectedItemIndex);
}

References _, anonymous_namespace{ExportFilePanel.cpp}::DefaultRates, mOptionsHandler, mRates, mSampleRate, and XO().

Referenced by ChangeFormat(), OnOptionsHandlerEvent(), and OnSampleRateChange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ValidateAndFixExt()

void ExportFilePanel::ValidateAndFixExt ( )

private

Definition at line 364 of file ExportFilePanel.cpp.

{
   if(mSelectedPlugin == nullptr)
      return;
 
   const auto formatInfo = mSelectedPlugin->GetFormatInfo(mSelectedFormatIndex);
   if(formatInfo.extensions.empty())
      return;
 
   wxFileName filename;
   filename.SetFullName(mFullName->GetValue());
   const auto desiredExt = filename.GetExt().Trim();
 
   //See https://github.com/audacity/audacity/issues/5823
   //check if extension is valid, i.e. does not contain whitespace characters.
   //Otherwise everything after '.'(if present) is considered to be a part of name.
   if(wxRegEx{R"(^[^ ]+$)"}.Matches(desiredExt))
   {
      auto it = std::find_if(
         formatInfo.extensions.begin(),
         formatInfo.extensions.end(),
         // if typed extension uses different case (e.g. MP3 instead of mp3)
         // we'll reset the file extension to one provided by FormatInfo
         [&](const auto& ext) { return desiredExt.IsSameAs(ext, false); });
 
      if(it == formatInfo.extensions.end())
         it = formatInfo.extensions.begin();
 
      if(!it->empty() && !it->IsSameAs(filename.GetExt()))
      {
         filename.SetExt(*it);
         mFullName->SetValue(filename.GetFullName());
      }
   }
   else if(!formatInfo.extensions.front().empty())
   {
      auto fullname = filename.GetFullName();
      if(!fullname.EndsWith("."))
         fullname.Append(".");
      fullname.Append(formatInfo.extensions.front());
      filename.SetFullName(fullname);
      mFullName->SetValue(filename.GetFullName());
   }
}

References ExportPlugin::GetFormatInfo(), mFullName, mSelectedFormatIndex, and mSelectedPlugin.

Referenced by ChangeFormat(), GetFullName(), OnFullNameFocusKill(), and OnOptionsHandlerEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mAudioOptionsPanel

wxWindow* ExportFilePanel::mAudioOptionsPanel {}

private

Definition at line 99 of file ExportFilePanel.h.

Referenced by ChangeFormat(), and PopulateOrExchange().

◆ MaxExportChannels

constexpr auto ExportFilePanel::MaxExportChannels = 32u

staticconstexprprivate

Definition at line 29 of file ExportFilePanel.h.

Referenced by UpdateMaxChannels().

◆ mCustomizeChannels

wxButton* ExportFilePanel::mCustomizeChannels {}

private

Definition at line 107 of file ExportFilePanel.h.

Referenced by Init(), OnChannelsChange(), PopulateOrExchange(), and SetCustomMappingEnabled().

◆ mCustomMapping

wxRadioButton* ExportFilePanel::mCustomMapping {}

private

Definition at line 106 of file ExportFilePanel.h.

Referenced by GetChannels(), Init(), PopulateOrExchange(), and SetCustomMappingEnabled().

◆ mFolder

wxTextCtrl* ExportFilePanel::mFolder {}

private

Definition at line 101 of file ExportFilePanel.h.

Referenced by GetPath(), Init(), OnFolderBrowse(), and PopulateOrExchange().

◆ mFormat

wxChoice* ExportFilePanel::mFormat {}

private

Definition at line 97 of file ExportFilePanel.h.

Referenced by Init(), OnFolderBrowse(), and PopulateOrExchange().

◆ mFullName

wxTextCtrl* ExportFilePanel::mFullName {}

private

Definition at line 102 of file ExportFilePanel.h.

Referenced by GetFullName(), Init(), OnFolderBrowse(), PopulateOrExchange(), SetInitialFocus(), and ValidateAndFixExt().

◆ mMixerSpec

std::unique_ptr<MixerOptions::Downmix> ExportFilePanel::mMixerSpec

private

Definition at line 114 of file ExportFilePanel.h.

Referenced by GetMixerSpec(), Init(), OnChannelsConfigure(), and UpdateMaxChannels().

◆ mMono

wxRadioButton* ExportFilePanel::mMono {}

private

Definition at line 104 of file ExportFilePanel.h.

Referenced by GetChannels(), Init(), PopulateOrExchange(), SetCustomMappingEnabled(), and UpdateMaxChannels().

◆ mMonoStereoMode

bool ExportFilePanel::mMonoStereoMode {false}

private

Definition at line 95 of file ExportFilePanel.h.

Referenced by Init(), PopulateOrExchange(), SetCustomMappingEnabled(), and UpdateMaxChannels().

◆ mOptionsChangeSubscription

Observer::Subscription ExportFilePanel::mOptionsChangeSubscription

private

Definition at line 116 of file ExportFilePanel.h.

Referenced by ChangeFormat().

◆ mOptionsHandler

std::unique_ptr<ExportOptionsHandler> ExportFilePanel::mOptionsHandler

private

Definition at line 113 of file ExportFilePanel.h.

Referenced by ChangeFormat(), GetParameters(), Init(), and UpdateSampleRateList().

◆ mProject

AudacityProject& ExportFilePanel::mProject

private

Definition at line 93 of file ExportFilePanel.h.

Referenced by Init(), OnChannelsConfigure(), and UpdateMaxChannels().

◆ mRates

wxChoice* ExportFilePanel::mRates {}

private

Definition at line 98 of file ExportFilePanel.h.

Referenced by PopulateOrExchange(), and UpdateSampleRateList().

◆ mSampleRate

int ExportFilePanel::mSampleRate {}

private

Definition at line 109 of file ExportFilePanel.h.

Referenced by GetSampleRate(), Init(), OnSampleRateChange(), and UpdateSampleRateList().

◆ mSelectedFormatIndex

int ExportFilePanel::mSelectedFormatIndex {}

private

Definition at line 111 of file ExportFilePanel.h.

Referenced by ChangeFormat(), GetFormat(), OnOptionsHandlerEvent(), and ValidateAndFixExt().

◆ mSelectedPlugin

const ExportPlugin* ExportFilePanel::mSelectedPlugin {}

private

Definition at line 110 of file ExportFilePanel.h.

Referenced by ChangeFormat(), GetPlugin(), OnOptionsHandlerEvent(), and ValidateAndFixExt().

◆ mStereo

wxRadioButton* ExportFilePanel::mStereo {}

private

Definition at line 105 of file ExportFilePanel.h.

Referenced by Init(), PopulateOrExchange(), SetCustomMappingEnabled(), and UpdateMaxChannels().

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

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ExportFilePanel()

◆ ~ExportFilePanel()

Member Function Documentation

◆ ChangeFormat()

◆ GetChannels()

◆ GetFormat()

◆ GetFullName()

◆ GetMixerSpec()

◆ GetParameters()

◆ GetPath()

◆ GetPlugin()

◆ GetSampleRate()

◆ Init()

◆ OnChannelsChange()

◆ OnChannelsConfigure()

◆ OnFolderBrowse()

◆ OnFormatChange()

◆ OnFullNameFocusKill()

◆ OnOptionsHandlerEvent()

◆ OnSampleRateChange()

◆ PopulateOrExchange()

◆ SetCustomMappingEnabled()

◆ SetInitialFocus()

◆ UpdateMaxChannels()

◆ UpdateSampleRateList()

◆ ValidateAndFixExt()

Member Data Documentation

◆ mAudioOptionsPanel

◆ MaxExportChannels

◆ mCustomizeChannels

◆ mCustomMapping

◆ mFolder

◆ mFormat

◆ mFullName

◆ mMixerSpec

◆ mMono

◆ mMonoStereoMode

◆ mOptionsChangeSubscription

◆ mOptionsHandler

◆ mProject

◆ mRates

◆ mSampleRate

◆ mSelectedFormatIndex

◆ mSelectedPlugin

◆ mStereo