ExportPlugin Class Reference

#include <Export.h>

Inheritance diagram for ExportPlugin:

Collaboration diagram for ExportPlugin:

Public Types
using	ProgressResult = BasicUI::ProgressResult

Public Member Functions
	ExportPlugin ()
virtual	~ExportPlugin ()
int	AddFormat ()
	Add a NEW entry to the list of formats this plug-in can export. More...
void	SetFormat (const wxString &format, int index)
void	SetDescription (const TranslatableString &description, int index)
void	AddExtension (const FileExtension &extension, int index)
void	SetExtensions (FileExtensions extensions, int index)
void	SetMask (FileNames::FileTypes mask, int index)
void	SetMaxChannels (unsigned maxchannels, unsigned index)
void	SetCanMetaData (bool canmetadata, int index)
virtual int	GetFormatCount ()
virtual wxString	GetFormat (int index)
TranslatableString	GetDescription (int index)
virtual FileExtension	GetExtension (int index=0)
	Return the (first) file name extension for the sub-format. More...
virtual FileExtensions	GetExtensions (int index=0)
	Return all the file name extensions used for the sub-format. More...
FileNames::FileTypes	GetMask (int index)
virtual unsigned	GetMaxChannels (int index)
virtual bool	GetCanMetaData (int index)
virtual bool	IsExtension (const FileExtension &ext, int index)
virtual bool	DisplayOptions (wxWindow *parent, int format=0)
virtual void	OptionsCreate (ShuttleGui &S, int format)=0
virtual bool	CheckFileName (wxFileName &filename, int format=0)
virtual int	SetNumExportChannels ()
	Exporter plug-ins may override this to specify the number of channels in exported file. -1 for unspecified. More...
virtual ProgressResult	Export (AudacityProject *project, std::unique_ptr< BasicUI::ProgressDialog > &pDialog, unsigned channels, const wxFileNameWrapper &fName, bool selectedOnly, double t0, double t1, MixerSpec *mixerSpec=NULL, const Tags *metadata=NULL, int subformat=0)=0
	called to export audio into a file. More...

Protected Member Functions
std::unique_ptr< Mixer >	CreateMixer (const TrackList &tracks, bool selectionOnly, double startTime, double stopTime, unsigned numOutChannels, size_t outBufferSize, bool outInterleaved, double outRate, sampleFormat outFormat, MixerSpec *mixerSpec)

Static Protected Member Functions
static void	InitProgress (std::unique_ptr< BasicUI::ProgressDialog > &pDialog, const TranslatableString &title, const TranslatableString &message)
static void	InitProgress (std::unique_ptr< BasicUI::ProgressDialog > &pDialog, const wxFileNameWrapper &title, const TranslatableString &message)

Private Attributes
std::vector< FormatInfo >	mFormatInfos

Detailed Description

Definition at line 70 of file Export.h.

Member Typedef Documentation

ProgressResult

using ExportPlugin::ProgressResult = BasicUI::ProgressResult

Definition at line 73 of file Export.h.

Constructor & Destructor Documentation

ExportPlugin()

ExportPlugin::ExportPlugin

(

)

Definition at line 80 of file Export.cpp.

{
}

~ExportPlugin()

ExportPlugin::~ExportPlugin ( )

virtual

Definition at line 84 of file Export.cpp.

{
}

Member Function Documentation

AddExtension()

void ExportPlugin::AddExtension	(	const FileExtension &	extension,
		int	index
	)

Definition at line 126 of file Export.cpp.

{
   mFormatInfos[index].mExtensions.push_back(extension);
}

References mFormatInfos.

Referenced by ExportCL::ExportCL(), ExportFFmpeg::ExportFFmpeg(), ExportFLAC::ExportFLAC(), ExportMP3::ExportMP3(), ExportOGG::ExportOGG(), ExportPCM::ExportPCM(), and ExportWavPack::ExportWavPack().

Here is the caller graph for this function:

AddFormat()

int ExportPlugin::AddFormat

(

)

Add a NEW entry to the list of formats this plug-in can export.

To configure the format use SetFormat, SetCanMetaData etc with the index of the format.

Returns

The number of formats currently set up. This is one more than the index of the newly added format.

Definition at line 100 of file Export.cpp.

{
   FormatInfo nf;
   mFormatInfos.push_back(nf);
   return mFormatInfos.size();
}

References mFormatInfos.

Referenced by ExportCL::ExportCL(), ExportFFmpeg::ExportFFmpeg(), ExportFLAC::ExportFLAC(), ExportMP3::ExportMP3(), ExportOGG::ExportOGG(), ExportPCM::ExportPCM(), and ExportWavPack::ExportWavPack().

Here is the caller graph for this function:

CheckFileName()

bool ExportPlugin::CheckFileName ( wxFileName &  filename, int  format = 0  )

virtual

Reimplemented in ExportMP3, ExportCL, and ExportFFmpeg.

Definition at line 88 of file Export.cpp.

{
  return true;
}

CreateMixer()

std::unique_ptr< Mixer > ExportPlugin::CreateMixer ( const TrackList &  tracks, bool  selectionOnly, double  startTime, double  stopTime, unsigned  numOutChannels, size_t  outBufferSize, bool  outInterleaved, double  outRate, sampleFormat  outFormat, MixerSpec *  mixerSpec  )

protected

Definition at line 222 of file Export.cpp.

{
   Mixer::Inputs inputs;
 
   bool anySolo = !(( tracks.Any<const WaveTrack>() + &WaveTrack::GetSolo ).empty());
 
   auto range = tracks.Any< const WaveTrack >()
      + (selectionOnly ? &Track::IsSelected : &Track::Any )
      - ( anySolo ? &WaveTrack::GetNotSolo : &WaveTrack::GetMute);
   for (auto pTrack: range)
      inputs.emplace_back(
         pTrack->SharedPointer<const SampleTrack>(), GetEffectStages(*pTrack));
   // MB: the stop time should not be warped, this was a bug.
   return std::make_unique<Mixer>(move(inputs),
                  // Throw, to stop exporting, if read fails:
                  true,
                  Mixer::WarpOptions{tracks},
                  startTime, stopTime,
                  numOutChannels, outBufferSize, outInterleaved,
                  outRate, outFormat,
                  true, mixerSpec);
}

References TrackList::Any(), Track::Any(), GetEffectStages(), PlayableTrack::GetMute(), PlayableTrack::GetNotSolo(), PlayableTrack::GetSolo(), and Track::IsSelected().

Referenced by ExportCL::Export(), ExportFFmpeg::Export(), ExportFLAC::Export(), ExportMP3::Export(), ExportOGG::Export(), ExportPCM::Export(), and ExportWavPack::Export().

Here is the call graph for this function:

Here is the caller graph for this function:

DisplayOptions()

bool ExportPlugin::DisplayOptions ( wxWindow *  parent, int  format = 0  )

virtual

Definition at line 203 of file Export.cpp.

{
   return false;
}

Export()

virtual ProgressResult ExportPlugin::Export ( AudacityProject *  project, std::unique_ptr< BasicUI::ProgressDialog > &  pDialog, unsigned  channels, const wxFileNameWrapper &  fName, bool  selectedOnly, double  t0, double  t1, MixerSpec *  mixerSpec = NULL, const Tags *  metadata = NULL, int  subformat = 0  )

pure virtual

called to export audio into a file.

Parameters

pDialog	To be initialized with pointer to a NEW ProgressDialog if it was null, otherwise gives an existing dialog to be reused (working around a problem in wxWidgets for Mac; see bug 1600)
selectedOnly	Set to true if all tracks should be mixed, to false if only the selected tracks should be mixed and exported.
metadata	A Tags object that will over-ride the one in *project and be used to tag the file that is exported.
subformat	Control which of the multiple formats this exporter is capable of exporting should be used. Used where a single export plug-in handles a number of related formats, but they have separate entries in the Format drop-down list box. For example, the options to export to "Other PCM", "AIFF 16 Bit" and "WAV 16 Bit" are all the same libsndfile export plug-in, but with subformat set to 0, 1, and 2 respectively.

Returns

ProgressResult::Failed or ProgressResult::Cancelled if export fails to complete for any reason, in which case this function is responsible for alerting the user. Otherwise ProgressResult::Success or ProgressResult::Stopped

Implemented in ExportCL, ExportFFmpeg, ExportFLAC, ExportMP3, ExportOGG, ExportPCM, and ExportWavPack.

GetCanMetaData()

bool ExportPlugin::GetCanMetaData ( int  index )

virtual

Definition at line 184 of file Export.cpp.

{
   return mFormatInfos[index].mCanMetaData;
}

References mFormatInfos.

Referenced by ExportFFmpeg::Init().

Here is the caller graph for this function:

GetDescription()

TranslatableString ExportPlugin::GetDescription

(

int

index

)

Definition at line 156 of file Export.cpp.

{
   return mFormatInfos[index].mDescription;
}

References mFormatInfos.

Referenced by GetMask().

Here is the caller graph for this function:

GetExtension()

FileExtension ExportPlugin::GetExtension ( int  index = 0 )

virtual

Return the (first) file name extension for the sub-format.

Parameters

index

The sub-format for which the extension is wanted

Reimplemented in ExportPCM.

Definition at line 161 of file Export.cpp.

{
   return mFormatInfos[index].mExtensions[0];
}

References mFormatInfos.

Referenced by ExportPCM::GetExtension(), and IsExtension().

Here is the caller graph for this function:

GetExtensions()

FileExtensions ExportPlugin::GetExtensions ( int  index = 0 )

virtual

Return all the file name extensions used for the sub-format.

Parameters

index

the sub-format for which the extension is required

Definition at line 166 of file Export.cpp.

{
   return mFormatInfos[index].mExtensions;
}

References mFormatInfos.

Referenced by GetMask(), and IsExtension().

Here is the caller graph for this function:

GetFormat()

wxString ExportPlugin::GetFormat ( int  index )

virtual

Reimplemented in ExportPCM.

Definition at line 151 of file Export.cpp.

{
   return mFormatInfos[index].mFormat;
}

References mFormatInfos.

Referenced by ExportPCM::GetFormat().

Here is the caller graph for this function:

GetFormatCount()

int ExportPlugin::GetFormatCount ( )

virtual

Definition at line 107 of file Export.cpp.

{
   return mFormatInfos.size();
}

References mFormatInfos.

Referenced by IsExtension().

Here is the caller graph for this function:

GetMask()

FileNames::FileTypes ExportPlugin::GetMask

(

int

index

)

Definition at line 171 of file Export.cpp.

{
   if (!mFormatInfos[index].mMask.empty())
      return mFormatInfos[index].mMask;
 
   return { { GetDescription(index), GetExtensions(index) } };
}

References GetDescription(), GetExtensions(), and mFormatInfos.

Here is the call graph for this function:

GetMaxChannels()

unsigned ExportPlugin::GetMaxChannels ( int  index )

virtual

Reimplemented in ExportPCM.

Definition at line 179 of file Export.cpp.

{
   return mFormatInfos[index].mMaxChannels;
}

References mFormatInfos.

InitProgress() [1/2]

void ExportPlugin::InitProgress ( std::unique_ptr< BasicUI::ProgressDialog > &  pDialog, const TranslatableString &  title, const TranslatableString &  message  )

staticprotected

Definition at line 250 of file Export.cpp.

{
   if (!pDialog)
      pDialog = std::make_unique<ProgressDialog>( title, message );
   else
   {
      if (auto pd = dynamic_cast<ProgressDialog*>(pDialog.get()))
      {
         pd->SetTitle(title);
         pd->Reinit();
      }
 
      pDialog->SetMessage(message);
   }
}

References title.

Referenced by ExportCL::Export(), ExportFFmpeg::Export(), ExportFLAC::Export(), ExportMP3::Export(), ExportOGG::Export(), ExportPCM::Export(), ExportWavPack::Export(), and InitProgress().

Here is the caller graph for this function:

InitProgress() [2/2]

void ExportPlugin::InitProgress ( std::unique_ptr< BasicUI::ProgressDialog > &  pDialog, const wxFileNameWrapper &  title, const TranslatableString &  message  )

staticprotected

Definition at line 267 of file Export.cpp.

{
   return InitProgress(
      pDialog, Verbatim( title.GetName() ), message );
}

References InitProgress(), title, and Verbatim().

Here is the call graph for this function:

IsExtension()

bool ExportPlugin::IsExtension ( const FileExtension &  ext, int  index  )

virtual

Definition at line 189 of file Export.cpp.

{
   bool isext = false;
   for (int i = index; i < GetFormatCount(); i = GetFormatCount())
   {
      const auto &defext = GetExtension(i);
      const auto &defexts = GetExtensions(i);
      int indofext = defexts.Index(ext, false);
      if (defext.empty() || (indofext != wxNOT_FOUND))
         isext = true;
   }
   return isext;
}

References GetExtension(), GetExtensions(), and GetFormatCount().

Here is the call graph for this function:

OptionsCreate()

void ExportPlugin::OptionsCreate ( ShuttleGui &  S, int  format  )

pure virtual

Implemented in ExportCL, ExportFFmpeg, ExportFLAC, ExportMP3, ExportOGG, ExportPCM, and ExportWavPack.

Definition at line 208 of file Export.cpp.

{
   S.StartHorizontalLay(wxCENTER);
   {
      S.StartHorizontalLay(wxCENTER, 0);
      {
         S.Prop(1).AddTitle(XO("No format specific options"));
      }
      S.EndHorizontalLay();
   }
   S.EndHorizontalLay();
}

References S, and XO().

Referenced by ExportFFmpeg::OptionsCreate(), and ExportPCM::OptionsCreate().

Here is the call graph for this function:

Here is the caller graph for this function:

SetCanMetaData()

void ExportPlugin::SetCanMetaData	(	bool	canmetadata,
		int	index
	)

Definition at line 146 of file Export.cpp.

{
   mFormatInfos[index].mCanMetaData = canmetadata;
}

References mFormatInfos.

Referenced by ExportCL::ExportCL(), ExportFFmpeg::ExportFFmpeg(), ExportFLAC::ExportFLAC(), ExportMP3::ExportMP3(), ExportOGG::ExportOGG(), ExportPCM::ExportPCM(), and ExportWavPack::ExportWavPack().

Here is the caller graph for this function:

SetDescription()

void ExportPlugin::SetDescription	(	const TranslatableString &	description,
		int	index
	)

Definition at line 121 of file Export.cpp.

{
   mFormatInfos[index].mDescription = description;
}

References mFormatInfos.

Referenced by ExportCL::ExportCL(), ExportFFmpeg::ExportFFmpeg(), ExportFLAC::ExportFLAC(), ExportMP3::ExportMP3(), ExportOGG::ExportOGG(), ExportPCM::ExportPCM(), and ExportWavPack::ExportWavPack().

Here is the caller graph for this function:

SetExtensions()

void ExportPlugin::SetExtensions	(	FileExtensions	extensions,
		int	index
	)

Definition at line 131 of file Export.cpp.

{
   mFormatInfos[index].mExtensions = std::move(extensions);
}

References mFormatInfos.

Referenced by ExportPCM::ExportPCM().

Here is the caller graph for this function:

SetFormat()

void ExportPlugin::SetFormat	(	const wxString &	format,
		int	index
	)

Parameters

index

The plugin to set the format for (range 0 to one less than the count of formats)

Definition at line 116 of file Export.cpp.

{
   mFormatInfos[index].mFormat = format;
}

References format, and mFormatInfos.

Referenced by ExportCL::ExportCL(), ExportFFmpeg::ExportFFmpeg(), ExportFLAC::ExportFLAC(), ExportMP3::ExportMP3(), ExportOGG::ExportOGG(), ExportPCM::ExportPCM(), and ExportWavPack::ExportWavPack().

Here is the caller graph for this function:

SetMask()

void ExportPlugin::SetMask	(	FileNames::FileTypes	mask,
		int	index
	)

Definition at line 136 of file Export.cpp.

{
   mFormatInfos[index].mMask = std::move( mask );
}

References mFormatInfos.

SetMaxChannels()

void ExportPlugin::SetMaxChannels	(	unsigned	maxchannels,
		unsigned	index
	)

Definition at line 141 of file Export.cpp.

{
   mFormatInfos[index].mMaxChannels = maxchannels;
}

References mFormatInfos.

Referenced by ExportCL::ExportCL(), ExportFFmpeg::ExportFFmpeg(), ExportFLAC::ExportFLAC(), ExportMP3::ExportMP3(), ExportOGG::ExportOGG(), ExportPCM::ExportPCM(), and ExportWavPack::ExportWavPack().

Here is the caller graph for this function:

SetNumExportChannels()

virtual int ExportPlugin::SetNumExportChannels ( )

inlinevirtual

Exporter plug-ins may override this to specify the number of channels in exported file. -1 for unspecified.

Reimplemented in ExportMP3.

Definition at line 109 of file Export.h.

{ return -1; }

Member Data Documentation

mFormatInfos

std::vector<FormatInfo> ExportPlugin::mFormatInfos

private

Definition at line 158 of file Export.h.

Referenced by AddExtension(), AddFormat(), GetCanMetaData(), GetDescription(), GetExtension(), GetExtensions(), GetFormat(), GetFormatCount(), GetMask(), GetMaxChannels(), SetCanMetaData(), SetDescription(), SetExtensions(), SetFormat(), SetMask(), and SetMaxChannels().

---

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

• Export.h
• Export.cpp