ExportPCM Class Reference

Inheritance diagram for ExportPCM:

Collaboration diagram for ExportPCM:

Public Member Functions
	ExportPCM ()
int	GetFormatCount () const override
FormatInfo	GetFormatInfo (int index) 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 formatIndex) const override
bool	ParseConfig (int formatIndex, const rapidjson::Value &, 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 435 of file ExportPCM.cpp.

Constructor & Destructor Documentation

ExportPCM()

ExportPCM::ExportPCM ( )

default

Member Function Documentation

CreateOptionsEditor()

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

{
   if(format < FMT_OTHER)
      return std::make_unique<ExportOptionsSFTypedEditor>(
         kFormats[format].format & SF_FORMAT_TYPEMASK);
   return std::make_unique<ExportOptionsSFEditor>(listener);
}

References FMT_OTHER, anonymous_namespace{ExportPCM.cpp}::format, and anonymous_namespace{ExportPCM.cpp}::kFormats.

CreateProcessor()

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

overridevirtual

Parameters

format

Control whether we are doing a "preset" export to a popular file type, or giving the user full control over libsndfile.

Implements ExportPlugin.

Definition at line 530 of file ExportPCM.cpp.

{
   return std::make_unique<PCMExportProcessor>(format);
}

References anonymous_namespace{ExportPCM.cpp}::format.

GetFormatCount()

int ExportPCM::GetFormatCount ( ) const

overridevirtual

Implements ExportPlugin.

Definition at line 461 of file ExportPCM.cpp.

{
   return WXSIZEOF(kFormats) + 1;// + FMT_OTHER
}

References anonymous_namespace{ExportPCM.cpp}::kFormats.

GetFormatInfo()

FormatInfo ExportPCM::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 466 of file ExportPCM.cpp.

{
   if(index == FMT_OTHER)
   {
      SF_INFO si = {};
      //VS: returned format info depends on the format that was used last time.
      //That could be a source of unexpected behavior
      si.format = LoadOtherFormat(*gPrefs, kFormats[0].format & SF_FORMAT_TYPEMASK);
      si.format |= LoadEncoding(*gPrefs, si.format, kFormats[0].format);
 
      for (si.channels = 1; sf_format_check(&si); si.channels++)
      {
         // just counting
      }
      --si.channels;
 
      return {
         sf_header_shortname(si.format),
         XO("Other uncompressed files"),
         { sf_header_extension(si.format) },
         static_cast<unsigned>(si.channels),
         true
      };
   }
 
   if(!(index >= 0 && index < FMT_OTHER))
      index = 0;
 
   return {
      kFormats[index].name,
      kFormats[index].desc,
      { sf_header_extension(kFormats[index].format) },
      255,
      true
   };
}

References FMT_OTHER, FormatInfo::format, anonymous_namespace{ExportPCM.cpp}::format, gPrefs, anonymous_namespace{ExportPCM.cpp}::kFormats, anonymous_namespace{ExportPCM.cpp}::LoadEncoding(), anonymous_namespace{ExportPCM.cpp}::LoadOtherFormat(), sf_header_extension(), sf_header_shortname(), and XO().

Here is the call graph for this function:

GetMimeTypes()

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

overridevirtual

Returns

Mime type(s) supported by the format.

Reimplemented from ExportPlugin.

Definition at line 503 of file ExportPCM.cpp.

{
   if(formatIndex == FMT_WAV)
      return { "audio/x-wav" };
   return {};
}

References anonymous_namespace{ExportPCM.cpp}::FMT_WAV.

ParseConfig()

bool ExportPCM::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 510 of file ExportPCM.cpp.

{
   if(formatIndex == FMT_WAV)
   {
      //no parameters available...
      parameters = {};
      return true;
   }
   return false;
}

References anonymous_namespace{ExportPCM.cpp}::FMT_WAV.

---

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

• ExportPCM.cpp