ExportMP3 Class Reference

Inheritance diagram for ExportMP3:

Collaboration diagram for ExportMP3:

Public Member Functions
	ExportMP3 ()
bool	CheckFileName (wxFileName &filename, int format) const override
int	GetFormatCount () const override
FormatInfo	GetFormatInfo (int) const override
	Returns FormatInfo structure for given index if it's valid, or a default one. FormatInfo::format isn't guaranteed to be unique. More...
std::unique_ptr< ExportOptionsEditor >	CreateOptionsEditor (int, ExportOptionsEditor::Listener *listener) const override
	Creates format-dependent options editor, that is used to create a valid set of parameters to be used in exporting. More...
std::unique_ptr< ExportProcessor >	CreateProcessor (int format) const override
std::vector< std::string >	GetMimeTypes (int) const override
bool	ParseConfig (int formatIndex, const rapidjson::Value &document, ExportProcessor::Parameters &parameters) const override
	Attempt to parse configuration JSON object and produce a suitable set of parameters. Configuration is format dependent. More...
Public Member Functions inherited from ExportPlugin
	ExportPlugin ()
virtual	~ExportPlugin ()
virtual int	GetFormatCount () const =0
virtual FormatInfo	GetFormatInfo (int index) const =0
	Returns FormatInfo structure for given index if it's valid, or a default one. FormatInfo::format isn't guaranteed to be unique. More...
virtual std::unique_ptr< ExportOptionsEditor >	CreateOptionsEditor (int formatIndex, ExportOptionsEditor::Listener *listener) const =0
	Creates format-dependent options editor, that is used to create a valid set of parameters to be used in exporting. More...
virtual std::vector< std::string >	GetMimeTypes (int formatIndex) const
virtual bool	ParseConfig (int formatIndex, const rapidjson::Value &config, ExportProcessor::Parameters &parameters) const
	Attempt to parse configuration JSON object and produce a suitable set of parameters. Configuration is format dependent. More...
virtual bool	CheckFileName (wxFileName &filename, int format=0) const
virtual std::unique_ptr< ExportProcessor >	CreateProcessor (int format) const =0

Detailed Description

Definition at line 1631 of file ExportMP3.cpp.

Constructor & Destructor Documentation

ExportMP3()

ExportMP3::ExportMP3 ( )

default

Member Function Documentation

CheckFileName()

bool ExportMP3::CheckFileName ( wxFileName &  filename, int  format  ) const

overridevirtual

Reimplemented from ExportPlugin.

Definition at line 1753 of file ExportMP3.cpp.

{
#ifndef DISABLE_DYNAMIC_LOADING_LAME
   MP3Exporter exporter;
 
   if (!exporter.LoadLibrary(wxTheApp->GetTopWindow(), MP3Exporter::Maybe)) {
      BasicUI::ShowMessageBox(XO("Could not open MP3 encoding library!"),
                              BasicUI::MessageBoxOptions()
                                 .IconStyle(BasicUI::Icon::Error)
                                 .Caption(XO("Error")));
      gPrefs->Write(wxT("/MP3/MP3LibPath"), wxString(wxT("")));
      gPrefs->Flush();
 
      return false;
   }
#endif // DISABLE_DYNAMIC_LOADING_LAME
 
   return true;
}

References BasicUI::Error, audacity::BasicSettings::Flush(), gPrefs, MP3Exporter::LoadLibrary(), MP3Exporter::Maybe, BasicUI::ShowMessageBox(), audacity::BasicSettings::Write(), wxT(), and XO().

Here is the call graph for this function:

CreateOptionsEditor()

std::unique_ptr< ExportOptionsEditor > ExportMP3::CreateOptionsEditor ( int  formatIndex, ExportOptionsEditor::Listener *  listener  ) const

overridevirtual

Creates format-dependent options editor, that is used to create a valid set of parameters to be used in exporting.

Parameters

listener

Option listener object that could be used by the editor to report on option changes.

Implements ExportPlugin.

Definition at line 1668 of file ExportMP3.cpp.

{
   return std::make_unique<MP3ExportOptionsEditor>(listener);
}

CreateProcessor()

std::unique_ptr< ExportProcessor > ExportMP3::CreateProcessor ( int  format ) const

overridevirtual

Parameters

format

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.

Implements ExportPlugin.

Definition at line 1673 of file ExportMP3.cpp.

{
   return std::make_unique<MP3ExportProcessor>();
}

GetFormatCount()

int ExportMP3::GetFormatCount ( ) const

overridevirtual

Implements ExportPlugin.

Definition at line 1655 of file ExportMP3.cpp.

{
   return 1;
}

GetFormatInfo()

FormatInfo ExportMP3::GetFormatInfo ( int  index ) const

overridevirtual

Returns FormatInfo structure for given index if it's valid, or a default one. FormatInfo::format isn't guaranteed to be unique.

Parameters

index

Should not exceed the number of formats provided by GetFormatCount()

Implements ExportPlugin.

Definition at line 1660 of file ExportMP3.cpp.

{
   return {
      wxT("MP3"), XO("MP3 Files"), { wxT("mp3") }, 2u, true
   };
}

References wxT(), and XO().

Here is the call graph for this function:

GetMimeTypes()

std::vector< std::string > ExportMP3::GetMimeTypes ( int  formatIndex ) const

overridevirtual

Returns

Mime type(s) supported by the format.

Reimplemented from ExportPlugin.

Definition at line 1678 of file ExportMP3.cpp.

{
   return { "audio/mpeg" };
}

ParseConfig()

bool ExportMP3::ParseConfig ( int  formatIndex, const rapidjson::Value &  config, ExportProcessor::Parameters &  parameters  ) const

overridevirtual

Attempt to parse configuration JSON object and produce a suitable set of parameters. Configuration is format dependent.

Parameters

formatIndex	Internal format index
config	Configuration JSON object
parameters	Where to put parameters

Returns

Whether the parsing was successful

Reimplemented from ExportPlugin.

Definition at line 1683 of file ExportMP3.cpp.

{
   if (!document.IsObject())
      return false;
 
   MP3OptionID qualityMode;
 
   if (document.HasMember("mode"))
   {
      auto& mode = document["mode"];
      if (!mode.IsString())
         return false;
 
      auto value = mode.GetString();
 
      if (value == std::string_view { "SET" })
         qualityMode = MP3OptionIDQualitySET;
      else if (value == std::string_view { "VBR" })
         qualityMode = MP3OptionIDQualityVBR;
      else if (value == std::string_view { "ABR" })
         qualityMode = MP3OptionIDQualityABR;
      else if (value == std::string_view { "CBR" })
         qualityMode = MP3OptionIDQualityCBR;
      else
         return false;
 
      parameters.push_back(std::make_tuple(MP3OptionIDMode, value));
   }
   else
      return false;
 
   if (document.HasMember("quality"))
   {
      auto& qualityMember = document["quality"];
 
      if (!qualityMember.IsInt())
         return false;
 
      const auto quality = qualityMember.GetInt();
 
      if (qualityMode == MP3OptionIDQualitySET && (quality < 0 || quality > 3))
         return false;
      else if (
         qualityMode == MP3OptionIDQualityVBR && (quality < 0 || quality > 9))
         return false;
      else if (
         qualityMode == MP3OptionIDQualityABR &&
         std::find(
            fixRateValues.begin(), fixRateValues.end(),
            ExportValue { quality }) ==
            fixRateValues.end())
         return false;
      else if (
         qualityMode == MP3OptionIDQualityCBR &&
         std::find(
            fixRateValues.begin(), fixRateValues.end(),
            ExportValue { quality }) ==
            fixRateValues.end())
         return false;
 
      parameters.push_back(std::make_tuple(qualityMode, quality));
   }
   else
      return false;
 
   return true;
}

References fixRateValues, MP3OptionIDMode, MP3OptionIDQualityABR, MP3OptionIDQualityCBR, MP3OptionIDQualitySET, and MP3OptionIDQualityVBR.

---

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

• ExportMP3.cpp