ExportWavPack Class Reference

Inheritance diagram for ExportWavPack:

Collaboration diagram for ExportWavPack:

Public Member Functions
	ExportWavPack ()
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::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...
std::unique_ptr< ExportOptionsEditor >	CreateOptionsEditor (int, ExportOptionsEditor::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
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 280 of file ExportWavPack.cpp.

Constructor & Destructor Documentation

ExportWavPack()

ExportWavPack::ExportWavPack ( )

default

Member Function Documentation

CreateOptionsEditor()

std::unique_ptr< ExportOptionsEditor > ExportWavPack::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 362 of file ExportWavPack.cpp.

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

CreateProcessor()

std::unique_ptr< ExportProcessor > ExportWavPack::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 367 of file ExportWavPack.cpp.

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

GetFormatCount()

int ExportWavPack::GetFormatCount ( ) const

overridevirtual

Implements ExportPlugin.

Definition at line 301 of file ExportWavPack.cpp.

{
   return 1;
}

GetFormatInfo()

FormatInfo ExportWavPack::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 306 of file ExportWavPack.cpp.

{
   return {
      wxT("WavPack"), XO("WavPack Files"), { wxT("wv") }, 255, true
   };
}

References wxT(), and XO().

Here is the call graph for this function:

GetMimeTypes()

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

overridevirtual

Returns

Mime type(s) supported by the format.

Reimplemented from ExportPlugin.

Definition at line 313 of file ExportWavPack.cpp.

{
   return { "audio/x-wavpack" };
}

ParseConfig()

bool ExportWavPack::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 318 of file ExportWavPack.cpp.

{
   if(!config.IsObject() ||
      !config.HasMember("quality") || !config["quality"].IsNumber() ||
      !config.HasMember("bit_rate") || !config["bit_rate"].IsNumber() ||
      !config.HasMember("bit_depth") || !config["bit_depth"].IsNumber() ||
      !config.HasMember("hybrid_mode") || !config["hybrid_mode"].IsBool())
      return false;
 
   const auto quality = ExportValue(config["quality"].GetInt());
   const auto bitRate = ExportValue(config["bit_rate"].GetInt());
   const auto bitDepth = ExportValue(config["bit_depth"].GetInt());
   const auto hybridMode = ExportValue(config["hybrid_mode"].GetBool());
 
   for(const auto& option : ExportWavPackOptions)
   {
      if((option.id == OptionIDQuality &&
         std::find(option.values.begin(),
            option.values.end(),
            quality) == option.values.end())
         ||
         (option.id == OptionIDBitRate &&
         std::find(option.values.begin(),
            option.values.end(),
            bitRate) == option.values.end())
         ||
         (option.id == OptionIDBitDepth &&
         std::find(option.values.begin(),
            option.values.end(),
            bitDepth) == option.values.end()))
         return false;
   }
   ExportProcessor::Parameters result {
      { OptionIDQuality, quality },
      { OptionIDBitRate, bitRate },
      { OptionIDBitDepth, bitDepth },
      { OptionIDHybridMode, hybridMode },
      { OptionIDCreateCorrection, false }
   };
   std::swap(parameters, result);
   return true;
}

References anonymous_namespace{ExportWavPack.cpp}::ExportWavPackOptions, anonymous_namespace{ExportWavPack.cpp}::OptionIDBitDepth, anonymous_namespace{ExportWavPack.cpp}::OptionIDBitRate, anonymous_namespace{ExportWavPack.cpp}::OptionIDCreateCorrection, anonymous_namespace{ExportWavPack.cpp}::OptionIDHybridMode, anonymous_namespace{ExportWavPack.cpp}::OptionIDQuality, and anonymous_namespace{NoteTrack.cpp}::swap().

Here is the call graph for this function:

---

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

• ExportWavPack.cpp