anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor Class Reference

Inheritance diagram for anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor:

Collaboration diagram for anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor:

Public Member Functions
	ExportOptionsSFEditor (Listener *listener)
int	GetOptionsCount () const override
bool	GetOption (int index, ExportOption &option) const override
bool	GetValue (ExportOptionID id, ExportValue &value) const override
bool	SetValue (ExportOptionID id, const ExportValue &value) override
SampleRateList	GetSampleRateList () const override
void	Load (const audacity::BasicSettings &config) override
void	Store (audacity::BasicSettings &config) const override
Public Member Functions inherited from ExportOptionsEditor
virtual	~ExportOptionsEditor ()
virtual int	GetOptionsCount () const =0
virtual bool	GetOption (int index, ExportOption &option) const =0
virtual bool	GetValue (ExportOptionID id, ExportValue &value) const =0
virtual bool	SetValue (ExportOptionID id, const ExportValue &value)=0
virtual SampleRateList	GetSampleRateList () const =0
virtual void	Store (audacity::BasicSettings &settings) const =0
virtual void	Load (const audacity::BasicSettings &config)=0

Private Member Functions
bool	IsValidType (const ExportValue &typeValue) const

Private Attributes
Listener *const	mListener
int	mType
std::unordered_map< int, int >	mEncodings
std::vector< ExportOption >	mOptions

Additional Inherited Members
Public Types inherited from ExportOptionsEditor
using	SampleRateList = std::vector< int >

Detailed Description

Definition at line 185 of file ExportPCM.cpp.

Constructor & Destructor Documentation

ExportOptionsSFEditor()

anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor::ExportOptionsSFEditor ( Listener *  listener )

inlineexplicit

Definition at line 208 of file ExportPCM.cpp.

      : mListener(listener)
   {
      ExportOption typeOption {
         OptionIDSFType, XO("Header"),
         0,
         ExportOption::TypeEnum
      };
 
      auto hasDefaultType = false;
      for (int i = 0, num = sf_num_headers(); i < num; ++i)
      {
         const auto type = static_cast<int>(sf_header_index_to_type(i));
         switch (type)
         {
            // On the Mac, do not include in header list
#if defined(__WXMAC__)
            case SF_FORMAT_AIFF: break;
#endif
            // Do not include in header list
            case SF_FORMAT_WAV: break;
            default:
               {
                  typeOption.values.emplace_back(type);
                  typeOption.names.push_back(Verbatim(sf_header_index_name(i)));
                  ExportOption encodingOption {
                     type,
                     XO("Encoding"),
                     0,
                     ExportOption::TypeEnum
                  };
                  GetEncodings(type, encodingOption.values, encodingOption.names);
                  encodingOption.defaultValue = encodingOption.values[0];
                  if(!hasDefaultType)
                  {
                     mType = type;
                     typeOption.defaultValue = type;
                     hasDefaultType = true;
                  }
                  else
                     encodingOption.flags |= ExportOption::Hidden;
                  mOptions.push_back(std::move(encodingOption));
                  mEncodings[type] = *std::get_if<int>(&encodingOption.defaultValue);
               } break;
         }
      }
      typeOption.defaultValue = typeOption.values[0];
      mOptions.insert(mOptions.begin(), std::move(typeOption));
   }

References anonymous_namespace{ExportPCM.cpp}::GetEncodings(), ExportOption::Hidden, anonymous_namespace{ExportPCM.cpp}::OptionIDSFType, sf_header_index_name(), sf_header_index_to_type(), sf_num_headers(), ExportOption::TypeEnum, Verbatim(), and XO().

Here is the call graph for this function:

Member Function Documentation

GetOption()

bool anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor::GetOption ( int  index, ExportOption &  option  ) const

inlineoverridevirtual

Implements ExportOptionsEditor.

Definition at line 263 of file ExportPCM.cpp.

   {
      if (index >= 0 && index < static_cast<int>(mOptions.size()))
      {
         option = mOptions[index];
         return true;
      }
      return false;
   }

GetOptionsCount()

int anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor::GetOptionsCount ( ) const

inlineoverridevirtual

Implements ExportOptionsEditor.

Definition at line 258 of file ExportPCM.cpp.

   {
      return static_cast<int>(mOptions.size());
   }

GetSampleRateList()

SampleRateList anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor::GetSampleRateList ( ) const

inlineoverridevirtual

Implements ExportOptionsEditor.

Definition at line 335 of file ExportPCM.cpp.

   {
      return {};
   }

GetValue()

bool anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor::GetValue ( ExportOptionID  id, ExportValue &  value  ) const

inlineoverridevirtual

Implements ExportOptionsEditor.

Definition at line 273 of file ExportPCM.cpp.

   {
      if(id == OptionIDSFType)
      {
         value = mType;
         return true;
      }
      auto it = mEncodings.find(id);
      if(it != mEncodings.end())
      {
         value = it->second;
         return true;
      }
      return false;
   }

References anonymous_namespace{ExportPCM.cpp}::OptionIDSFType.

IsValidType()

bool anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor::IsValidType ( const ExportValue &  typeValue ) const

inlineprivate

Definition at line 193 of file ExportPCM.cpp.

   {
      if(std::holds_alternative<int>(typeValue))
      {
         const auto& typeOption = mOptions.front();
         return std::find(typeOption.values.begin(),
            typeOption.values.end(),
            typeValue) != typeOption.values.end();
      }
      return false;
   }

Load()

void anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor::Load ( const audacity::BasicSettings &  config )

inlineoverridevirtual

Implements ExportOptionsEditor.

Definition at line 340 of file ExportPCM.cpp.

   {
      mType = LoadOtherFormat(config, mType);
      for(auto& p : mEncodings)
         p.second = LoadEncoding(config, p.first, p.second);
 
      // Prior to v2.4.0, sf_format will include the subtype.
      if (mType & SF_FORMAT_SUBMASK)
      {
         const auto type = mType & SF_FORMAT_TYPEMASK;
         const auto enc = mType & SF_FORMAT_SUBMASK;
         mEncodings[type] = enc;
         mType = type;
      }
 
      for(auto& option : mOptions)
      {
         const auto it = mEncodings.find(option.id);
         if(it == mEncodings.end())
            continue;
 
         if(mType == it->first)
            option.flags &= ~ExportOption::Hidden;
         else
            option.flags |= ExportOption::Hidden;
      }
   }

References ExportOption::flags, ExportOption::Hidden, anonymous_namespace{ExportPCM.cpp}::LoadEncoding(), and anonymous_namespace{ExportPCM.cpp}::LoadOtherFormat().

Here is the call graph for this function:

SetValue()

bool anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor::SetValue ( ExportOptionID  id, const ExportValue &  value  )

inlineoverridevirtual

Implements ExportOptionsEditor.

Definition at line 289 of file ExportPCM.cpp.

   {
      if(id == OptionIDSFType && IsValidType(value))
      {
         const auto newType = *std::get_if<int>(&value);
         if(newType == mType)
            return true;
         
         if(mListener)
            mListener->OnExportOptionChangeBegin();
 
         for(auto& option : mOptions)
         {
            if(option.id == mType)
            {
               option.flags |= ExportOption::Hidden;
               if(mListener)
                  mListener->OnExportOptionChange(option);
            }
            else if(option.id == newType)
            {
               option.flags &= ~ExportOption::Hidden;
               if(mListener)
                  mListener->OnExportOptionChange(option);
            }
         }
         mType = newType;
         Store(*gPrefs);
         if(mListener)
         {
            mListener->OnExportOptionChangeEnd();
            mListener->OnFormatInfoChange();
         }
         return true;
      }
 
      auto it = mEncodings.find(id);
      if(it != mEncodings.end() && std::holds_alternative<int>(value))
      {
         it->second = *std::get_if<int>(&value);
         Store(*gPrefs);
         return true;
      }
      return false;
   }

References gPrefs, ExportOption::Hidden, ExportOptionsEditor::Listener::OnExportOptionChange(), ExportOptionsEditor::Listener::OnExportOptionChangeBegin(), ExportOptionsEditor::Listener::OnExportOptionChangeEnd(), ExportOptionsEditor::Listener::OnFormatInfoChange(), and anonymous_namespace{ExportPCM.cpp}::OptionIDSFType.

Here is the call graph for this function:

Store()

void anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor::Store ( audacity::BasicSettings &  config ) const

inlineoverridevirtual

Implements ExportOptionsEditor.

Definition at line 368 of file ExportPCM.cpp.

   {
      SaveOtherFormat(config, mType);
      for(auto& [type, encoding] : mEncodings)
         SaveEncoding(config, type, encoding);
   }

References anonymous_namespace{ExportPCM.cpp}::SaveEncoding(), and anonymous_namespace{ExportPCM.cpp}::SaveOtherFormat().

Here is the call graph for this function:

Member Data Documentation

mEncodings

std::unordered_map<int, int> anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor::mEncodings

private

Definition at line 189 of file ExportPCM.cpp.

mListener

Listener* const anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor::mListener

private

Definition at line 187 of file ExportPCM.cpp.

mOptions

std::vector<ExportOption> anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor::mOptions

private

Definition at line 191 of file ExportPCM.cpp.

mType

int anonymous_namespace{ExportPCM.cpp}::ExportOptionsSFEditor::mType

private

Definition at line 188 of file ExportPCM.cpp.

---

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

• ExportPCM.cpp