Presents a dialog box allowing the user to export multiple files either by exporting each track as a separate file, or by exporting each label as a separate file. More...

#include <ExportMultiple.h>

Inheritance diagram for ExportMultipleDialog:

[legend]

Collaboration diagram for ExportMultipleDialog:

[legend]

Public Types
using	ProgressResult = BasicUI::ProgressResult

Public Member Functions
	ExportMultipleDialog (AudacityProject *parent)

virtual	~ExportMultipleDialog ()

int	ShowModal ()

Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()

	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))

bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))

void	SetTitle (const TranslatableString &title)

void	SetLabel (const TranslatableString &title)

void	SetName (const TranslatableString &title)

void	SetName ()

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

	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete

	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete

wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete

wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
void	CanExport ()

void	CountTracksAndLabels ()

bool	DirOk ()

ProgressResult	ExportMultipleByLabel (bool byName, const wxString &prefix, bool addNumber)
	Export multiple labeled regions of the project to separate files. More...

ProgressResult	ExportMultipleByTrack (bool byName, const wxString &prefix, bool addNumber)
	Export each track in the project to a separate file. More...

ProgressResult	DoExport (std::unique_ptr< BasicUI::ProgressDialog > &pDialog, unsigned channels, const wxFileName &name, bool selectedOnly, double t0, double t1, const Tags &tags)

wxString	MakeFileName (const wxString &input)
	Takes an arbitrary text string and converts it to a form that can be used as a file name, if necessary prompting the user to edit the file name produced. More...

void	PopulateOrExchange (ShuttleGui &S)

void	EnableControls ()

void	OnFormat (wxCommandEvent &event)

void	OnOptions (wxCommandEvent &event)

void	OnCreate (wxCommandEvent &event)

void	OnChoose (wxCommandEvent &event)

void	OnLabel (wxCommandEvent &event)

void	OnFirst (wxCommandEvent &event)

void	OnFirstFileName (wxCommandEvent &event)

void	OnTrack (wxCommandEvent &event)

void	OnByName (wxCommandEvent &event)

void	OnByNumber (wxCommandEvent &event)

void	OnPrefix (wxCommandEvent &event)

void	OnCancel (wxCommandEvent &event)

void	OnHelp (wxCommandEvent &event)

void	OnExport (wxCommandEvent &event)

Private Attributes
Exporter	mExporter

std::vector< ExportPlugin * >	mPlugins

AudacityProject *	mProject

TrackList *	mTracks

const LabelTrack *	mLabels

int	mNumLabels

int	mNumWaveTracks

int	mFilterIndex

int	mPluginIndex

int	mSubFormatIndex

bool	mInitialized

FilePaths	mExported

wxChoice *	mFormat

wxButton *	mOptions

wxTextCtrl *	mDir

wxButton *	mCreate

wxButton *	mChoose

wxRadioButton *	mLabel

wxStaticText *	mLabelLabel

wxCheckBox *	mFirst

wxStaticText *	mFirstFileLabel

wxTextCtrl *	mFirstFileName

wxRadioButton *	mTrack

wxStaticText *	mTrackLabel

wxRadioButton *	mByNumberAndName

wxRadioButton *	mByName

wxRadioButton *	mByNumber

wxStaticText *	mPrefixLabel

wxTextCtrl *	mPrefix

wxCheckBox *	mOverwrite

wxButton *	mCancel

wxButton *	mExport

wxSimplebook *	mBook

SelectionState &	mSelectionState

Detailed Description

Presents a dialog box allowing the user to export multiple files either by exporting each track as a separate file, or by exporting each label as a separate file.

Definition at line 32 of file ExportMultiple.h.

Member Typedef Documentation

◆ ProgressResult

using ExportMultipleDialog::ProgressResult = BasicUI::ProgressResult

Definition at line 35 of file ExportMultiple.h.

Constructor & Destructor Documentation

◆ ExportMultipleDialog()

ExportMultipleDialog::ExportMultipleDialog ( AudacityProject * parent )

◆ ~ExportMultipleDialog()

ExportMultipleDialog::~ExportMultipleDialog ( )

virtual

Definition at line 162 of file ExportMultiple.cpp.

163{

164}

Member Function Documentation

◆ CanExport()

void ExportMultipleDialog::CanExport ( )

private

◆ CountTracksAndLabels()

void ExportMultipleDialog::CountTracksAndLabels ( )

private

Definition at line 166 of file ExportMultiple.cpp.

{
   bool anySolo =
      !(mTracks->Leaders<const WaveTrack>() + &WaveTrack::GetSolo).empty();
 
   mNumWaveTracks =
      (mTracks->Leaders< const WaveTrack >() - 
      (anySolo ? &WaveTrack::GetNotSolo : &WaveTrack::GetMute)).size();
 
   // only the first label track
   mLabels = *mTracks->Leaders<const LabelTrack>().begin();
   mNumLabels = mLabels ? mLabels->GetNumLabels() : 0;
}

References PackedArray::begin(), WaveTrack::GetMute(), PlayableTrack::GetNotSolo(), LabelTrack::GetNumLabels(), WaveTrack::GetSolo(), TrackList::Leaders(), mLabels, mNumLabels, mNumWaveTracks, mTracks, and size.

Here is the call graph for this function:

◆ DirOk()

bool ExportMultipleDialog::DirOk ( )

private

Definition at line 677 of file ExportMultiple.cpp.

{
   wxFileName fn;
 
   fn.AssignDir(mDir->GetValue());
 
   if (fn.DirExists()) {
      return true;
   }
 
   auto prompt = XO("\"%s\" doesn't exist.\n\nWould you like to create it?")
      .Format( fn.GetFullPath() );
 
   int action = AudacityMessageBox(
      prompt,
      XO("Warning"),
      wxYES_NO | wxICON_EXCLAMATION);
   if (action != wxYES) {
      return false;
   }
 
   return fn.Mkdir(0777, wxPATH_MKDIR_FULL);
}

References AudacityMessageBox(), fn, mDir, and XO().

Referenced by OnExport().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoExport()

ProgressResult ExportMultipleDialog::DoExport	(	std::unique_ptr< BasicUI::ProgressDialog > &	pDialog,
		unsigned	channels,
		const wxFileName &	name,
		bool	selectedOnly,
		double	t0,
		double	t1,
		const Tags &	tags
	)

private

Export one file of an export multiple set

Called once for each file in the list to do a (non-interactive) export

Parameters

channels	Number of channels to export
name	The file name (and path) to export to
selectedOnly	Should we export the selected tracks only?
t0	Start time for export
t1	End time for export
tags	Metadata to include in the file (if possible).

Definition at line 1024 of file ExportMultiple.cpp.

{
   wxFileName name;
 
   wxLogDebug(wxT("Doing multiple Export: File name \"%s\""), (inName.GetFullName()));
   wxLogDebug(wxT("Channels: %i, Start: %lf, End: %lf "), channels, t0, t1);
   if (selectedOnly)
      wxLogDebug(wxT("Selected Region Only"));
   else
      wxLogDebug(wxT("Whole Project"));
 
   wxFileName backup;
   if (mOverwrite->GetValue()) {
      name = inName;
      backup.Assign(name);
 
      int suffix = 0;
      do {
         backup.SetName(name.GetName() +
                           wxString::Format(wxT("%d"), suffix));
         ++suffix;
      }
      while (backup.FileExists());
      ::wxRenameFile(inName.GetFullPath(), backup.GetFullPath());
   }
   else {
      name = inName;
      int i = 2;
      wxString base(name.GetName());
      while (name.FileExists()) {
         name.SetName(wxString::Format(wxT("%s-%d"), base, i++));
      }
   }
 
   ProgressResult success = ProgressResult::Cancelled;
   const wxString fullPath{name.GetFullPath()};
 
   auto cleanup = finally( [&] {
      bool ok =
         success == ProgressResult::Stopped ||
         success == ProgressResult::Success;
      if (backup.IsOk()) {
         if ( ok )
            // Remove backup
            ::wxRemoveFile(backup.GetFullPath());
         else {
            // Restore original
            ::wxRemoveFile(fullPath);
            ::wxRenameFile(backup.GetFullPath(), fullPath);
         }
      }
      else {
         if ( ! ok )
            // Remove any new, and only partially written, file.
            ::wxRemoveFile(fullPath);
      }
   } );
 
   // Call the format export routine
   success = mPlugins[mPluginIndex]->Export(mProject,
                                            pDialog,
                                                channels,
                                                fullPath,
                                                selectedOnly,
                                                t0,
                                                t1,
                                                NULL,
                                                &tags,
                                                mSubFormatIndex);
 
   if (success == ProgressResult::Success || success == ProgressResult::Stopped) {
      mExported.push_back(fullPath);
   }
 
   Refresh();
   Update();
 
   return success;
}

References RefreshCode::Cancelled, mOverwrite, name, BasicUI::Success, and wxT().

Referenced by ExportMultipleByLabel(), and ExportMultipleByTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EnableControls()

void ExportMultipleDialog::EnableControls ( )

private

Definition at line 449 of file ExportMultiple.cpp.

{
   bool enable;
 
   if (!mInitialized) {
      return;
   }
 
   mFirst->Enable(mLabel->GetValue());
 
   enable =  mLabel->GetValue() &&
            (mByName->GetValue() || mByNumberAndName->GetValue()) &&
             mFirst->GetValue();
   mFirstFileLabel->Enable(enable);
   mFirstFileName->Enable(enable);
 
   enable = mByNumber->GetValue();
   mPrefixLabel->Enable(enable);
   mPrefix->Enable(enable);
 
   bool ok = true;
 
   if (mLabel->GetValue() && mFirst->GetValue() &&
       mFirstFileName->GetValue().empty() &&
       mPrefix->GetValue().empty())
      ok = false;
 
   if (mByNumber->GetValue() &&
       mPrefix->GetValue().empty())
      ok = false;
 
   mExport->Enable(ok);
}

References mByName, mByNumber, mByNumberAndName, mExport, mFirst, mFirstFileLabel, mFirstFileName, mInitialized, mLabel, mPrefix, and mPrefixLabel.

Referenced by OnByName(), OnByNumber(), OnFirst(), OnFirstFileName(), OnFormat(), OnLabel(), OnPrefix(), OnTrack(), and ShowModal().

Here is the caller graph for this function:

◆ ExportMultipleByLabel()

ProgressResult ExportMultipleDialog::ExportMultipleByLabel	(	bool	byName,
		const wxString &	prefix,
		bool	addNumber
	)

private

Export multiple labeled regions of the project to separate files.

Uses a single label track in the project to split up the audio into a series of sections, each of which is exported to a separate file.

Parameters

byName	Controls whether files are named after the text in the labels that define them (true), or just numbered (false).
prefix	The string used to prefix the file number if files are being numbered rather than named

Definition at line 718 of file ExportMultiple.cpp.

{
   wxASSERT(mProject);
   int numFiles = mNumLabels;
   int l = 0;        // counter for files done
   std::vector<ExportKit> exportSettings; // dynamic array for settings.
   exportSettings.reserve(numFiles); // Allocate some guessed space to use.
 
   // Account for exporting before first label
   if( mFirst->GetValue() ) {
      l--;
      numFiles++;
   }
 
   // Figure out how many channels we should export.
   auto channels = GetNumExportChannels( *mTracks );
 
   FilePaths otherNames;  // keep track of file names we will use, so we
   // don't duplicate them
   ExportKit setting;   // the current batch of settings
   setting.destfile.SetPath(mDir->GetValue());
   setting.destfile.SetExt(mPlugins[mPluginIndex]->GetExtension(mSubFormatIndex));
   wxLogDebug(wxT("Plug-in index = %d, Sub-format = %d"), mPluginIndex, mSubFormatIndex);
   wxLogDebug(wxT("File extension is %s"), setting.destfile.GetExt());
   wxString name;    // used to hold file name whilst we mess with it
   wxString title;   // un-messed-with title of file for tagging with
 
   const LabelStruct *info = NULL;
   /* Examine all labels a first time, sort out all data but don't do any
    * exporting yet (so this run is quick but interactive) */
   while( l < mNumLabels ) {
 
      // Get file name and starting time
      if( l < 0 ) {
         // create wxFileName for output file
         name = (mFirstFileName->GetValue());
         setting.t0 = 0.0;
      } else {
         info = mLabels->GetLabel(l);
         name = (info->title);
         setting.t0 = info->selectedRegion.t0();
      }
 
      // Figure out the ending time
      if( info && !info->selectedRegion.isPoint() ) {
         setting.t1 = info->selectedRegion.t1();
      } else if( l < mNumLabels-1 ) {
         // Use start of next label as end
         const LabelStruct *info1 = mLabels->GetLabel(l+1);
         setting.t1 = info1->selectedRegion.t0();
      } else {
         setting.t1 = mTracks->GetEndTime();
      }
 
      if( name.empty() )
         name = _("untitled");
 
      // store title of label to use in tags
      title = name;
 
      // Numbering files...
      if( !byName ) {
         name.Printf(wxT("%s-%02d"), prefix, l+1);
      } else if( addNumber ) {
         // Following discussion with GA, always have 2 digits
         // for easy file-name sorting (on Windows)
         name.Prepend(wxString::Format(wxT("%02d-"), l+1));
      }
 
      // store sanitised and user checked name in object
      setting.destfile.SetName(MakeFileName(name));
      if( setting.destfile.GetName().empty() )
      {  // user cancelled dialogue, or deleted everything in field.
         // or maybe the label was empty??
         // So we ignore this one and keep going.
      } 
      else
      {
         // FIXME: TRAP_ERR User could have given an illegal filename prefix.
         // in that case we should tell them, not fail silently.
         wxASSERT(setting.destfile.IsOk());     // burp if file name is broke
 
         // Make sure the (final) file name is unique within the set of exports
         FileNames::MakeNameUnique(otherNames, setting.destfile);
 
         /* do the metadata for this file */
         // copy project metadata to start with
         setting.filetags = Tags::Get( *mProject );
         setting.filetags.LoadDefaults();
         if (exportSettings.size()) {
            setting.filetags = exportSettings.back().filetags;
         }
         // over-ride with values
         setting.filetags.SetTag(TAG_TITLE, title);
         setting.filetags.SetTag(TAG_TRACK, l+1);
         // let the user have a crack at editing it, exit if cancelled
         auto &settings = ProjectSettings::Get( *mProject );
         bool bShowTagsDialog = settings.GetShowId3Dialog();
 
         bShowTagsDialog = bShowTagsDialog && mPlugins[mPluginIndex]->GetCanMetaData(mSubFormatIndex);
 
         if( bShowTagsDialog ){
            bool bCancelled = !TagsEditorDialog::ShowEditDialog(setting.filetags,
               ProjectWindow::Find( mProject ),
               XO("Edit Metadata Tags"), bShowTagsDialog);
            gPrefs->Read(wxT("/AudioFiles/ShowId3Dialog"), &bShowTagsDialog, true);
            settings.SetShowId3Dialog( bShowTagsDialog );
            if( bCancelled )
               return ProgressResult::Cancelled;
         }
      }
 
      /* add the settings to the array of settings to be used for export */
      exportSettings.push_back(setting);
 
      l++;  // next label, count up one
   }
 
   auto ok = ProgressResult::Success;   // did it work?
   int count = 0; // count the number of successful runs
   ExportKit activeSetting;  // pointer to the settings in use for this export
   /* Go round again and do the exporting (so this run is slow but
    * non-interactive) */
   std::unique_ptr<BasicUI::ProgressDialog> pDialog;
   for (count = 0; count < numFiles; count++) {
      /* get the settings to use for the export from the array */
      activeSetting = exportSettings[count];
      // Bug 1440 fix.
      if( activeSetting.destfile.GetName().empty() )
         continue;
 
      // Export it
      ok = DoExport(pDialog, channels, activeSetting.destfile, false,
         activeSetting.t0, activeSetting.t1, activeSetting.filetags);
      if (ok == ProgressResult::Stopped) {
         AudacityMessageDialog dlgMessage(
            nullptr,
            XO("Continue to export remaining files?"),
            XO("Export"),
            wxYES_NO | wxNO_DEFAULT | wxICON_WARNING);
         if (dlgMessage.ShowModal() != wxID_YES ) {
            // User decided not to continue - bail out!
            break;
         }
      }
      else if (ok != ProgressResult::Success) {
         break;
      }
   }
 
   return ok;
}

References _, RefreshCode::Cancelled, DoExport(), TranslatableString::empty(), ProjectWindow::Find(), Tags::Get(), ProjectSettings::Get(), TrackList::GetEndTime(), LabelTrack::GetLabel(), GetNumExportChannels(), gPrefs, SelectedRegion::isPoint(), MakeFileName(), FileNames::MakeNameUnique(), mDir, mFirst, mFirstFileName, mLabels, mNumLabels, mPluginIndex, mPlugins, mProject, mSubFormatIndex, mTracks, name, LabelStruct::selectedRegion, settings(), TagsEditorDialog::ShowEditDialog(), BasicUI::Success, SelectedRegion::t0(), SelectedRegion::t1(), TAG_TITLE, TAG_TRACK, LabelStruct::title, title, wxT(), and XO().

Referenced by OnExport().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ExportMultipleByTrack()

ProgressResult ExportMultipleDialog::ExportMultipleByTrack	(	bool	byName,
		const wxString &	prefix,
		bool	addNumber
	)

private

Export each track in the project to a separate file.

Parameters

byName	Controls whether files are named after the track names (true), or just numbered (false).
prefix	The string used to prefix the file number if files are being numbered rather than named

Definition at line 872 of file ExportMultiple.cpp.

{
   wxASSERT(mProject);
   int l = 0;     // track counter
   auto ok = ProgressResult::Success;
   FilePaths otherNames;
   std::vector<ExportKit> exportSettings; // dynamic array we will use to store the
                                  // settings needed to do the exports with in
   exportSettings.reserve(mNumWaveTracks);   // Allocate some guessed space to use.
   ExportKit setting;   // the current batch of settings
   setting.destfile.SetPath(mDir->GetValue());
   setting.destfile.SetExt(mPlugins[mPluginIndex]->GetExtension(mSubFormatIndex));
 
   wxString name;    // used to hold file name whilst we mess with it
   wxString title;   // un-messed-with title of file for tagging with
 
   /* Remember which tracks were selected, and set them to deselected */
   SelectionStateChanger changer{ mSelectionState, *mTracks };
   for (auto tr : mTracks->SelectedLeaders<WaveTrack>())
      tr->SetSelected(false);
 
   bool anySolo =
      !(mTracks->Leaders<const WaveTrack>() + &WaveTrack::GetSolo).empty();
 
   bool skipSilenceAtBeginning;
   gPrefs->Read(wxT("/AudioFiles/SkipSilenceAtBeginning"), &skipSilenceAtBeginning, false);
 
   /* Examine all tracks in turn, collecting export information */
   for (auto tr : mTracks->Leaders<WaveTrack>() - 
      (anySolo ? &WaveTrack::GetNotSolo : &WaveTrack::GetMute)) {
 
      // Get the times for the track
      auto channels = TrackList::Channels(tr);
      setting.t0 = skipSilenceAtBeginning ? channels.min(&Track::GetStartTime) : 0;
      setting.t1 = channels.max( &Track::GetEndTime );
 
      // number of export channels?
      // It's 1 only for a center-panned mono track
      setting.channels = (IsMono(*tr) && tr->GetPan() == 0.0) ? 1 : 2;
 
      // Get name and title
      title = tr->GetName();
      if( title.empty() )
         title = _("untitled");
 
      if (byName) {
         name = title;
         if (addNumber) {
            name.Prepend(
               wxString::Format(wxT("%02d-"), l+1));
         }
      }
      else {
         name = (wxString::Format(wxT("%s-%02d"), prefix, l+1));
      }
 
      // store sanitised and user checked name in object
      setting.destfile.SetName(MakeFileName(name));
 
      if (setting.destfile.GetName().empty())
      {  // user cancelled dialogue, or deleted everything in field.
         // So we ignore this one and keep going.
      }
      else 
      {
 
         // FIXME: TRAP_ERR User could have given an illegal track name.
         // in that case we should tell them, not fail silently.
         wxASSERT(setting.destfile.IsOk());     // burp if file name is broke
 
         // Make sure the (final) file name is unique within the set of exports
         FileNames::MakeNameUnique(otherNames, setting.destfile);
 
         /* do the metadata for this file */
         // copy project metadata to start with
         setting.filetags = Tags::Get( *mProject );
         setting.filetags.LoadDefaults();
         if (exportSettings.size()) {
            setting.filetags = exportSettings.back().filetags;
         }
         // over-ride with values
         setting.filetags.SetTag(TAG_TITLE, title);
         setting.filetags.SetTag(TAG_TRACK, l+1);
         // let the user have a crack at editing it, exit if cancelled
         auto &settings = ProjectSettings::Get( *mProject );
         bool bShowTagsDialog = settings.GetShowId3Dialog();
 
         bShowTagsDialog = bShowTagsDialog && mPlugins[mPluginIndex]->GetCanMetaData(mSubFormatIndex);
 
         if( bShowTagsDialog ){
            bool bCancelled = !TagsEditorDialog::ShowEditDialog(setting.filetags,
               ProjectWindow::Find( mProject ),
               XO("Edit Metadata Tags"), bShowTagsDialog);
            gPrefs->Read(wxT("/AudioFiles/ShowId3Dialog"), &bShowTagsDialog, true);
            settings.SetShowId3Dialog( bShowTagsDialog );
            if( bCancelled )
               return ProgressResult::Cancelled;
         }
      }
      /* add the settings to the array of settings to be used for export */
      exportSettings.push_back(setting);
 
      l++;  // next track, count up one
   }
   // end of user-interactive data gathering loop, start of export processing
   // loop
   int count = 0; // count the number of successful runs
   ExportKit activeSetting;  // pointer to the settings in use for this export
   std::unique_ptr<BasicUI::ProgressDialog> pDialog;
 
   for (auto tr : mTracks->Leaders<WaveTrack>() - 
      (anySolo ? &WaveTrack::GetNotSolo : &WaveTrack::GetMute)) {
 
      wxLogDebug( "Get setting %i", count );
      /* get the settings to use for the export from the array */
      activeSetting = exportSettings[count];
      if( activeSetting.destfile.GetName().empty() ){
         count++;
         continue;
      }
 
      /* Select the track */
      SelectionStateChanger changer2{ mSelectionState, *mTracks };
      tr->SetSelected(true);
 
      // Export the data. "channels" are per track.
      ok = DoExport(pDialog,
         activeSetting.channels, activeSetting.destfile, true,
         activeSetting.t0, activeSetting.t1, activeSetting.filetags);
      if (ok == ProgressResult::Stopped) {
         AudacityMessageDialog dlgMessage(
            nullptr,
            XO("Continue to export remaining files?"),
            XO("Export"),
            wxYES_NO | wxNO_DEFAULT | wxICON_WARNING);
         if (dlgMessage.ShowModal() != wxID_YES ) {
            // User decided not to continue - bail out!
            break;
         }
      }
      else if (ok != ProgressResult::Success) {
         break;
      }
      // increment export counter
      count++;
 
   }
 
   return ok ;
}

References _, RefreshCode::Cancelled, TrackList::Channels(), DoExport(), TrackList::empty(), ProjectWindow::Find(), Tags::Get(), ProjectSettings::Get(), Track::GetEndTime(), WaveTrack::GetMute(), PlayableTrack::GetNotSolo(), WaveTrack::GetSolo(), Track::GetStartTime(), gPrefs, AudioGraph::IsMono(), TrackList::Leaders(), MakeFileName(), FileNames::MakeNameUnique(), mDir, mNumWaveTracks, mPluginIndex, mPlugins, mProject, mSelectionState, mSubFormatIndex, mTracks, name, TrackList::SelectedLeaders(), settings(), TagsEditorDialog::ShowEditDialog(), BasicUI::Success, TAG_TITLE, TAG_TRACK, title, wxT(), and XO().

Referenced by OnExport().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeFileName()

wxString ExportMultipleDialog::MakeFileName ( const wxString & input )

private

Takes an arbitrary text string and converts it to a form that can be used as a file name, if necessary prompting the user to edit the file name produced.

Definition at line 1110 of file ExportMultiple.cpp.

{
   wxString newname = input; // name we are generating
 
   // strip out anything that isn't allowed in file names on this platform
   auto changed = Internat::SanitiseFilename(newname, wxT("_"));
 
   if(changed)
   {  // need to get user to fix file name
      // build the dialog
      TranslatableString msg;
      wxString excluded = ::wxJoin( Internat::GetExcludedCharacters(), wxT(' '), wxT('\0') );
      // TODO: For Russian language we should have separate cases for 2 and more than 2 letters.
      if( excluded.length() > 1 ){
         msg = XO(
// i18n-hint: The second %s gives some letters that can't be used.
"Label or track \"%s\" is not a legal file name.\nYou cannot use any of these characters:\n\n%s\n\nSuggested replacement:")
            .Format( input, excluded );
      } else {
         msg = XO(
// i18n-hint: The second %s gives a letter that can't be used.
"Label or track \"%s\" is not a legal file name. You cannot use \"%s\".\n\nSuggested replacement:")
            .Format( input, excluded );
      }
 
      AudacityTextEntryDialog dlg( this, msg, XO("Save As..."), newname );
 
 
      // And tell the validator about excluded chars
      dlg.SetTextValidator( wxFILTER_EXCLUDE_CHAR_LIST );
      wxTextValidator *tv = dlg.GetTextValidator();
      tv->SetExcludes(Internat::GetExcludedCharacters());
 
      // Show the dialog and bail if the user cancels
      if( dlg.ShowModal() == wxID_CANCEL )
      {
          return wxEmptyString;
      }
      // Extract the name from the dialog
      newname = dlg.GetValue();
   }  // phew - end of file name sanitisation procedure
   return newname;
}

References Internat::GetExcludedCharacters(), Internat::SanitiseFilename(), wxT(), and XO().

Referenced by ExportMultipleByLabel(), and ExportMultipleByTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnByName()

void ExportMultipleDialog::OnByName ( wxCommandEvent & event )

private

Definition at line 564 of file ExportMultiple.cpp.

{
   EnableControls();
}

References EnableControls().

Here is the call graph for this function:

◆ OnByNumber()

void ExportMultipleDialog::OnByNumber ( wxCommandEvent & event )

private

Definition at line 569 of file ExportMultiple.cpp.

{
   EnableControls();
}

References EnableControls().

Here is the call graph for this function:

◆ OnCancel()

void ExportMultipleDialog::OnCancel ( wxCommandEvent & event )

private

Definition at line 579 of file ExportMultiple.cpp.

{
   EndModal(0);
}

◆ OnChoose()

void ExportMultipleDialog::OnChoose ( wxCommandEvent & event )

private

Definition at line 534 of file ExportMultiple.cpp.

{
   wxDirDialogWrapper dlog(this,
      XO("Choose a location to save the exported files"),
      mDir->GetValue());
   dlog.ShowModal();
   if (!dlog.GetPath().empty())
      mDir->SetValue(dlog.GetPath());
}

References mDir, and XO().

Here is the call graph for this function:

◆ OnCreate()

void ExportMultipleDialog::OnCreate ( wxCommandEvent & event )

private

Definition at line 514 of file ExportMultiple.cpp.

{
   wxFileName fn;
 
   fn.AssignDir(mDir->GetValue());
 
   bool ok = fn.Mkdir(0777, wxPATH_MKDIR_FULL);
 
   if (!ok) {
      // Mkdir will produce an error dialog
      return;
   }
 
   ::AudacityMessageBox(
      XO("\"%s\" successfully created.").Format( fn.GetPath() ),
      XO("Export Multiple"),
      wxOK | wxCENTRE,
      this);
}

References AudacityMessageBox(), fn, mDir, and XO().

Here is the call graph for this function:

◆ OnExport()

void ExportMultipleDialog::OnExport ( wxCommandEvent & event )

private

Definition at line 589 of file ExportMultiple.cpp.

{
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
 
   gPrefs->Flush();
 
   FileNames::UpdateDefaultPath(FileNames::Operation::Export, mDir->GetValue());
 
   // Make sure the output directory is in good shape
   if (!DirOk()) {
      return;
   }
 
   mFilterIndex = mFormat->GetSelection();
   if (mFilterIndex != wxNOT_FOUND)
   {
      size_t c = 0;
      int i = -1;
      for (const auto &pPlugin : mPlugins)
      {
         ++i;
         for (int j = 0; j < pPlugin->GetFormatCount(); j++, c++)
         {
            if ((size_t)mFilterIndex == c)
            {  // this is the selected format. Store the plug-in and sub-format
               // needed to achieve it.
               mPluginIndex = i;
               mSubFormatIndex = j;
               mBook->GetPage(mFilterIndex)->TransferDataFromWindow();
            }
         }
      }
   }
 
//   bool overwrite = mOverwrite->GetValue();
   ProgressResult ok = ProgressResult::Failed;
   mExported.clear();
 
   // Give 'em the result
   auto cleanup = finally( [&]
   {
      auto msg = (ok == ProgressResult::Success
         ? XO("Successfully exported the following %lld file(s).")
         : ok == ProgressResult::Failed
            ? XO("Something went wrong after exporting the following %lld file(s).")
            : ok == ProgressResult::Cancelled
               ? XO("Export canceled after exporting the following %lld file(s).")
               : ok == ProgressResult::Stopped
                  ? XO("Export stopped after exporting the following %lld file(s).")
                  : XO("Something went really wrong after exporting the following %lld file(s).")
         ).Format((long long) mExported.size());
 
      wxString FileList;
      for (size_t i = 0; i < mExported.size(); i++) {
         FileList += mExported[i];
         FileList += '\n';
      }
 
      // TODO: give some warning dialog first, when only some files exported
      // successfully.
 
      GuardedCall( [&] {
         // This results dialog is a child of this dialog.
         HelpSystem::ShowInfoDialog( this,
                                    XO("Export Multiple"),
                                    msg,
                                    FileList,
                                    450,400);
      } );
   } );
 
   if (mLabel->GetValue()) {
      ok = ExportMultipleByLabel(mByName->GetValue() || mByNumberAndName->GetValue(),
                                 mPrefix->GetValue(),
                                 mByNumberAndName->GetValue());
   }
   else {
      ok = ExportMultipleByTrack(mByName->GetValue() || mByNumberAndName->GetValue(),
                                 mPrefix->GetValue(),
                                 mByNumberAndName->GetValue());
   }
 
   if (ok == ProgressResult::Success || ok == ProgressResult::Stopped) {
      EndModal(1);
   }
}

References RefreshCode::Cancelled, DirOk(), eIsSavingToPrefs, ExportMultipleByLabel(), ExportMultipleByTrack(), FileConfig::Flush(), gPrefs, GuardedCall(), mBook, mByName, mByNumberAndName, mDir, mExported, mFilterIndex, mFormat, mLabel, mPluginIndex, mPlugins, mPrefix, mSubFormatIndex, PopulateOrExchange(), S, HelpSystem::ShowInfoDialog(), BasicUI::Success, FileNames::UpdateDefaultPath(), and XO().

Here is the call graph for this function:

◆ OnFirst()

void ExportMultipleDialog::OnFirst ( wxCommandEvent & event )

private

Definition at line 549 of file ExportMultiple.cpp.

{
   EnableControls();
}

References EnableControls().

Here is the call graph for this function:

◆ OnFirstFileName()

void ExportMultipleDialog::OnFirstFileName ( wxCommandEvent & event )

private

Definition at line 554 of file ExportMultiple.cpp.

{
   EnableControls();
}

References EnableControls().

Here is the call graph for this function:

◆ OnFormat()

void ExportMultipleDialog::OnFormat ( wxCommandEvent & event )

private

Definition at line 483 of file ExportMultiple.cpp.

{
   mBook->ChangeSelection(mFormat->GetSelection());
 
   EnableControls();
}

References EnableControls(), mBook, and mFormat.

Here is the call graph for this function:

◆ OnHelp()

void ExportMultipleDialog::OnHelp ( wxCommandEvent & event )

private

Definition at line 584 of file ExportMultiple.cpp.

{
   HelpSystem::ShowHelp(this, L"Export_Multiple", true);
}

References HelpSystem::ShowHelp().

Here is the call graph for this function:

◆ OnLabel()

void ExportMultipleDialog::OnLabel ( wxCommandEvent & event )

private

Definition at line 544 of file ExportMultiple.cpp.

{
   EnableControls();
}

References EnableControls().

Here is the call graph for this function:

◆ OnOptions()

void ExportMultipleDialog::OnOptions ( wxCommandEvent & event )

private

Definition at line 490 of file ExportMultiple.cpp.

{
   const int sel = mFormat->GetSelection();
   if (sel != wxNOT_FOUND)
   {
     size_t c = 0;
     int i = -1;
     for (const auto &pPlugin : mPlugins)
     {
       ++i;
       for (int j = 0; j < pPlugin->GetFormatCount(); j++)
       {
         if ((size_t)sel == c)
         {
            mPluginIndex = i;
            mSubFormatIndex = j;
         }
         c++;
       }
     }
   }
   mPlugins[mPluginIndex]->DisplayOptions(this,mSubFormatIndex);
}

References mFormat, mPluginIndex, mPlugins, and mSubFormatIndex.

◆ OnPrefix()

void ExportMultipleDialog::OnPrefix ( wxCommandEvent & event )

private

Definition at line 574 of file ExportMultiple.cpp.

{
   EnableControls();
}

References EnableControls().

Here is the call graph for this function:

◆ OnTrack()

void ExportMultipleDialog::OnTrack ( wxCommandEvent & event )

private

Definition at line 559 of file ExportMultiple.cpp.

{
   EnableControls();
}

References EnableControls().

Here is the call graph for this function:

◆ PopulateOrExchange()

void ExportMultipleDialog::PopulateOrExchange ( ShuttleGui & S )

private

Definition at line 230 of file ExportMultiple.cpp.

{
   ChoiceSetting NumberingSetting{
      wxT("/Export/TrackNameWithOrWithoutNumbers"),
      {
         { wxT("labelTrack"), XXO("Using Label/Track Name") },
         { wxT("numberBefore"), XXO("Numbering before Label/Track Name") },
         { wxT("numberAfter"), XXO("Numbering after File name prefix") },
      },
      0 // labelTrack
   };
 
   wxString name = mProject->GetProjectName();
   wxString defaultFormat = gPrefs->Read(wxT("/Export/Format"), wxT("WAV"));
 
   TranslatableStrings visibleFormats;
   wxArrayStringEx formats;
   mPluginIndex = -1;
   mFilterIndex = 0;
 
   {
      int i = -1;
      for (const auto &pPlugin : mPlugins)
      {
         ++i;
         for (int j = 0; j < pPlugin->GetFormatCount(); j++)
         {
            auto format = mPlugins[i]->GetDescription(j);
            visibleFormats.push_back( format );
            // use MSGID of description as a value too, written into config file
            // This is questionable.  A change in the msgid can make the
            // preference stored in old config files inapplicable
            formats.push_back( format.MSGID().GET() );
            if (mPlugins[i]->GetFormat(j) == defaultFormat) {
               mPluginIndex = i;
               mSubFormatIndex = j;
            }
            if (mPluginIndex == -1) mFilterIndex++;
         }
      }
   }
 
   ChoiceSetting FormatSetting{ wxT("/Export/MultipleFormat"),
      {
         ByColumns,
         visibleFormats,
         formats
      },
      mFilterIndex
   };
 
   // Bug 1304: Set the default file path.  It's used if none stored in config.
   auto DefaultPath = FileNames::FindDefaultPath(FileNames::Operation::Export);
 
   if (mPluginIndex == -1)
   {
      mPluginIndex = 0;
      mFilterIndex = 0;
      mSubFormatIndex = 0;
   }
 
   S.SetBorder(5);
   S.StartHorizontalLay(wxEXPAND, true);
   {
      S.SetBorder(5);
      S.StartStatic(XO("Export files to:"), true);
      {
         S.StartMultiColumn(4, true);
         {
            mDir = S.Id(DirID)
               .AddTextBox(XXO("Folder:"),
                           DefaultPath,
                           64);
            S.Id(ChooseID).AddButton(XXO("Choose..."));
            S.Id(CreateID).AddButton(XXO("Create"));
 
            mFormat = S.Id(FormatID)
               .TieChoice( XXO("Format:"),
               FormatSetting
            );
            S.AddVariableText( {}, false);
            S.AddVariableText( {}, false);
 
            S.AddPrompt(XXO("Options:"));
 
            mBook = S.Id(OptionsID)
               .Style(wxBORDER_STATIC)
               .StartSimplebook();
            if (S.GetMode() == eIsCreating)
            {
               for (const auto &pPlugin : mPlugins)
               {
                  for (int j = 0; j < pPlugin->GetFormatCount(); j++)
                  {
                     // Name of simple book page is not displayed
                     S.StartNotebookPage( {} );
                     pPlugin->OptionsCreate(S, j);
                     S.EndNotebookPage();
                  }
               }
               mBook->ChangeSelection(mFormat->GetSelection());
            }
            S.EndSimplebook();
            S.AddVariableText( {}, false);
            S.AddVariableText( {}, false);
         }
         S.EndMultiColumn();
      }
      S.EndStatic();
   }
   S.EndHorizontalLay();
 
   S.StartHorizontalLay(wxEXPAND, false);
   {
      S.SetBorder(5);
      S.StartStatic(XO("Split files based on:"), 1);
      {
         // Row 1
         S.SetBorder(1);
 
         // Bug 2692: Place button group in panel so tabbing will work and,
         // on the Mac, VoiceOver will announce as radio buttons.
         S.StartPanel();
         {
            mTrack = S.Id(TrackID)
               .AddRadioButton(XXO("Tracks"));
 
            // Row 2
            S.SetBorder(1);
            mLabel = S.Id(LabelID)
               .AddRadioButtonToGroup(XXO("Labels"));
         }
         S.EndPanel();
 
         S.SetBorder(3);
         S.StartMultiColumn(2, wxEXPAND);
         S.SetStretchyCol(1);
         {
            // Row 3 (indented)
            S.AddVariableText(Verbatim("   "), false);
            mFirst = S.Id(FirstID)
               .AddCheckBox(XXO("Include audio before first label"), false);
 
            // Row 4
            S.AddVariableText( {}, false);
            S.StartMultiColumn(2, wxEXPAND);
            S.SetStretchyCol(1);
            {
               mFirstFileLabel =
                  S.AddVariableText(XO("First file name:"), false);
               mFirstFileName = S.Id(FirstFileNameID)
                  .Prop(1)
                  .Name(XO("First file name"))
                  .TieTextBox( {},
                              name,
                              30);
            }
            S.EndMultiColumn();
         }
         S.EndMultiColumn();
 
         S.SetBorder(3);
      }
      S.EndStatic();
 
      S.SetBorder(5);
      S.StartStatic(XO("Name files:"), 1);
      {
         S.SetBorder(2);
 
         // Bug 2692: Place button group in panel so tabbing will work and,
         // on the Mac, VoiceOver will announce as radio buttons.
         S.StartPanel();
         {
            S.StartRadioButtonGroup(NumberingSetting);
            {
               mByName = S.Id(ByNameID).TieRadioButton();
 
               mByNumberAndName = S.Id(ByNameAndNumberID).TieRadioButton();
 
               mByNumber = S.Id(ByNumberID).TieRadioButton();
            }
            S.EndRadioButtonGroup();
         }
         S.EndPanel();
 
         S.StartMultiColumn(3, wxEXPAND);
         S.SetStretchyCol(2);
         {
            // Row 3 (indented)
            S.AddVariableText(Verbatim("   "), false);
            mPrefixLabel = S.AddVariableText(XO("File name prefix:"), false);
            mPrefix = S.Id(PrefixID)
               .Name(XO("File name prefix"))
               .TieTextBox( {},
                           name,
                           30);
         }
         S.EndMultiColumn();
      }
      S.EndStatic();
   }
   S.EndHorizontalLay();
 
   S.SetBorder(5);
   S.StartHorizontalLay(wxEXPAND, false);
   {
      mOverwrite = S.Id(OverwriteID).TieCheckBox(XXO("Overwrite existing files"),
                                                 {wxT("/Export/OverwriteExisting"),
                                                  false});
   }
   S.EndHorizontalLay();
 
   S.AddStandardButtons(eOkButton | eCancelButton | eHelpButton);
   mExport = (wxButton *)wxWindow::FindWindowById(wxID_OK, this);
   mExport->SetLabel(_("Export"));
 
}

References _, ByColumns, ByNameAndNumberID, ByNameID, ByNumberID, ChooseID, CreateID, DirID, eCancelButton, eHelpButton, eIsCreating, eOkButton, FileNames::FindDefaultPath(), FirstFileNameID, FirstID, format, FormatID, AudacityProject::GetProjectName(), gPrefs, LabelID, mBook, mByName, mByNumber, mByNumberAndName, mDir, mExport, mFilterIndex, mFirst, mFirstFileLabel, mFirstFileName, mFormat, mLabel, mOverwrite, mPluginIndex, mPlugins, mPrefix, mPrefixLabel, mProject, mSubFormatIndex, mTrack, name, OptionsID, OverwriteID, PrefixID, S, TrackID, Verbatim(), wxT(), XO(), and XXO().

Referenced by OnExport().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ShowModal()

int ExportMultipleDialog::ShowModal ( )

Definition at line 180 of file ExportMultiple.cpp.

{
   // Cannot export if all audio tracks are muted.
   if (mNumWaveTracks == 0)
   {
      ::AudacityMessageBox(
         XO("All audio is muted."),
         XO("Cannot Export Multiple"),
         wxOK | wxCENTRE,
         this);
      return wxID_CANCEL;
   }
 
   if ((mNumWaveTracks < 1) && (mNumLabels < 1))
   {
      ::AudacityMessageBox(
         XO(
"You have no unmuted Audio Tracks and no applicable \
\nlabels, so you cannot export to separate audio files."),
         XO("Cannot Export Multiple"),
         wxOK | wxCENTRE,
         this);
      return wxID_CANCEL;
   }
 
   bool bHasLabels = (mNumLabels > 0);
   bool bHasTracks = (mNumWaveTracks > 0);
   
   mLabel->Enable(bHasLabels && bHasTracks);
   mTrack->Enable(bHasTracks);
 
   // If you have 2 or more tracks, then it is export by tracks.
   // If you have no labels, then it is export by tracks.
   // Otherwise it is export by labels, by default.
   bool bPreferByLabels = bHasLabels && (mNumWaveTracks < 2);
   mLabel->SetValue(bPreferByLabels);
   mTrack->SetValue(!bPreferByLabels);
 
   EnableControls();
 
   // This is a work around for issue #2909, and ensures that
   // when the dialog opens, the first control is the focus.
   // The work around is only needed on Windows.
#if defined(__WXMSW__)
   mDir->SetFocus();
#endif
 
   return wxDialogWrapper::ShowModal();
}

References AudacityMessageBox(), EnableControls(), mDir, mLabel, mNumLabels, mNumWaveTracks, mTrack, and XO().

Referenced by anonymous_namespace{FileMenus.cpp}::OnExportMultiple().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mBook

wxSimplebook* ExportMultipleDialog::mBook

private

Definition at line 162 of file ExportMultiple.h.

Referenced by OnExport(), OnFormat(), and PopulateOrExchange().

◆ mByName

wxRadioButton* ExportMultipleDialog::mByName

private

button to choose naming exported file from label text

Definition at line 151 of file ExportMultiple.h.

Referenced by EnableControls(), OnExport(), and PopulateOrExchange().

◆ mByNumber

wxRadioButton* ExportMultipleDialog::mByNumber

private

button to choose numbering exported files

Definition at line 152 of file ExportMultiple.h.

Referenced by EnableControls(), and PopulateOrExchange().

◆ mByNumberAndName

wxRadioButton* ExportMultipleDialog::mByNumberAndName

private

button to choose number AND name for exported files

Definition at line 150 of file ExportMultiple.h.

Referenced by EnableControls(), OnExport(), and PopulateOrExchange().

◆ mCancel

wxButton* ExportMultipleDialog::mCancel

private

Definition at line 159 of file ExportMultiple.h.

◆ mChoose

wxButton* ExportMultipleDialog::mChoose

private

Definition at line 137 of file ExportMultiple.h.

◆ mCreate

wxButton* ExportMultipleDialog::mCreate

private

Definition at line 136 of file ExportMultiple.h.

◆ mDir

wxTextCtrl* ExportMultipleDialog::mDir

private

The directory all the exported files will end up in

Definition at line 134 of file ExportMultiple.h.

Referenced by DirOk(), ExportMultipleByLabel(), ExportMultipleByTrack(), OnChoose(), OnCreate(), OnExport(), PopulateOrExchange(), and ShowModal().

◆ mExport

wxButton* ExportMultipleDialog::mExport

private

Definition at line 160 of file ExportMultiple.h.

Referenced by EnableControls(), and PopulateOrExchange().

◆ mExported

FilePaths ExportMultipleDialog::mExported

private

Definition at line 128 of file ExportMultiple.h.

Referenced by OnExport().

◆ mExporter

Exporter ExportMultipleDialog::mExporter

private

Definition at line 107 of file ExportMultiple.h.

◆ mFilterIndex

int ExportMultipleDialog::mFilterIndex

private

The index in the drop-down list of export formats (mFormat) of the selected export format. This list includes all possible plug-in - subformat combinations.

Definition at line 117 of file ExportMultiple.h.

Referenced by OnExport(), and PopulateOrExchange().

◆ mFirst

wxCheckBox* ExportMultipleDialog::mFirst

private

Check box to export audio before first label

Definition at line 142 of file ExportMultiple.h.

Referenced by EnableControls(), ExportMultipleByLabel(), and PopulateOrExchange().

◆ mFirstFileLabel

wxStaticText* ExportMultipleDialog::mFirstFileLabel

private

description text for mFirstFileName

Definition at line 143 of file ExportMultiple.h.

Referenced by EnableControls(), and PopulateOrExchange().

◆ mFirstFileName

wxTextCtrl* ExportMultipleDialog::mFirstFileName

private

Name to use for exporting audio before the first label in the file

Definition at line 144 of file ExportMultiple.h.

Referenced by EnableControls(), ExportMultipleByLabel(), and PopulateOrExchange().

◆ mFormat

wxChoice* ExportMultipleDialog::mFormat

private

Drop-down list of export formats (combinations of plug-in and subformat)

Definition at line 130 of file ExportMultiple.h.

Referenced by OnExport(), OnFormat(), OnOptions(), and PopulateOrExchange().

◆ mInitialized

bool ExportMultipleDialog::mInitialized

private

Definition at line 125 of file ExportMultiple.h.

Referenced by EnableControls().

◆ mLabel

wxRadioButton* ExportMultipleDialog::mLabel

private

button to choose export based on Labels

Definition at line 139 of file ExportMultiple.h.

Referenced by EnableControls(), OnExport(), PopulateOrExchange(), and ShowModal().

◆ mLabelLabel

wxStaticText* ExportMultipleDialog::mLabelLabel

private

description text for mLabel

Definition at line 140 of file ExportMultiple.h.

◆ mLabels

const LabelTrack* ExportMultipleDialog::mLabels

private

Definition at line 113 of file ExportMultiple.h.

Referenced by CountTracksAndLabels(), and ExportMultipleByLabel().

◆ mNumLabels

int ExportMultipleDialog::mNumLabels

private

Definition at line 114 of file ExportMultiple.h.

Referenced by CountTracksAndLabels(), ExportMultipleByLabel(), and ShowModal().

◆ mNumWaveTracks

int ExportMultipleDialog::mNumWaveTracks

private

Definition at line 115 of file ExportMultiple.h.

Referenced by CountTracksAndLabels(), ExportMultipleByTrack(), and ShowModal().

◆ mOptions

wxButton* ExportMultipleDialog::mOptions

private

Definition at line 132 of file ExportMultiple.h.

◆ mOverwrite

wxCheckBox* ExportMultipleDialog::mOverwrite

private

Definition at line 157 of file ExportMultiple.h.

Referenced by DoExport(), and PopulateOrExchange().

◆ mPluginIndex

int ExportMultipleDialog::mPluginIndex

private

The index in mPlugins of the selected export plug-in

Definition at line 121 of file ExportMultiple.h.

Referenced by ExportMultipleByLabel(), ExportMultipleByTrack(), OnExport(), OnOptions(), and PopulateOrExchange().

◆ mPlugins

std::vector<ExportPlugin*> ExportMultipleDialog::mPlugins

private

Array of references to available exporter plug-ins

Definition at line 108 of file ExportMultiple.h.

Referenced by ExportMultipleByLabel(), ExportMultipleByTrack(), OnExport(), OnOptions(), and PopulateOrExchange().

◆ mPrefix

wxTextCtrl* ExportMultipleDialog::mPrefix

private

Definition at line 155 of file ExportMultiple.h.

Referenced by EnableControls(), OnExport(), and PopulateOrExchange().

◆ mPrefixLabel

wxStaticText* ExportMultipleDialog::mPrefixLabel

private

Definition at line 154 of file ExportMultiple.h.

Referenced by EnableControls(), and PopulateOrExchange().

◆ mProject

AudacityProject* ExportMultipleDialog::mProject

private

Definition at line 110 of file ExportMultiple.h.

Referenced by ExportMultipleByLabel(), ExportMultipleByTrack(), and PopulateOrExchange().

◆ mSelectionState

SelectionState& ExportMultipleDialog::mSelectionState

private

Definition at line 164 of file ExportMultiple.h.

Referenced by ExportMultipleByTrack().

◆ mSubFormatIndex

int ExportMultipleDialog::mSubFormatIndex

private

The selected subformat number within the selected export plug-in set by mPluginIndex

Definition at line 123 of file ExportMultiple.h.

Referenced by ExportMultipleByLabel(), ExportMultipleByTrack(), OnExport(), OnOptions(), and PopulateOrExchange().

◆ mTrack

wxRadioButton* ExportMultipleDialog::mTrack

private

button to choose export based on tracks

Definition at line 147 of file ExportMultiple.h.

Referenced by PopulateOrExchange(), and ShowModal().

◆ mTrackLabel

wxStaticText* ExportMultipleDialog::mTrackLabel

private

Definition at line 148 of file ExportMultiple.h.

◆ mTracks

TrackList* ExportMultipleDialog::mTracks

private

The list of tracks in the project that is being exported

Definition at line 111 of file ExportMultiple.h.

Referenced by CountTracksAndLabels(), ExportMultipleByLabel(), and ExportMultipleByTrack().

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ProgressResult

Constructor & Destructor Documentation

◆ ExportMultipleDialog()

◆ ~ExportMultipleDialog()

Member Function Documentation

◆ CanExport()

◆ CountTracksAndLabels()

◆ DirOk()

◆ DoExport()

◆ EnableControls()

◆ ExportMultipleByLabel()

◆ ExportMultipleByTrack()

◆ MakeFileName()

◆ OnByName()

◆ OnByNumber()

◆ OnCancel()

◆ OnChoose()

◆ OnCreate()

◆ OnExport()

◆ OnFirst()

◆ OnFirstFileName()

◆ OnFormat()

◆ OnHelp()

◆ OnLabel()

◆ OnOptions()

◆ OnPrefix()

◆ OnTrack()

◆ PopulateOrExchange()

◆ ShowModal()

Member Data Documentation

◆ mBook

◆ mByName

◆ mByNumber

◆ mByNumberAndName

◆ mCancel

◆ mChoose

◆ mCreate

◆ mDir

◆ mExport

◆ mExported

◆ mExporter

◆ mFilterIndex

◆ mFirst

◆ mFirstFileLabel

◆ mFirstFileName

◆ mFormat

◆ mInitialized

◆ mLabel

◆ mLabelLabel

◆ mLabels

◆ mNumLabels

◆ mNumWaveTracks

◆ mOptions

◆ mOverwrite

◆ mPluginIndex

◆ mPlugins

◆ mPrefix

◆ mPrefixLabel

◆ mProject

◆ mSelectionState

◆ mSubFormatIndex

◆ mTrack

◆ mTrackLabel

◆ mTracks