A PrefsPanel used for setting audio quality. More...

#include <QualityPrefs.h>

Inheritance diagram for QualityPrefs:

Collaboration diagram for QualityPrefs:

Public Member Functions
	QualityPrefs (wxWindow *parent, wxWindowID winid)

virtual	~QualityPrefs ()

ComponentInterfaceSymbol	GetSymbol () const override

TranslatableString	GetDescription () const override

bool	Commit () override

ManualPageID	HelpPageName () override
	If not empty string, the Help button is added below the panel. More...

void	PopulateOrExchange (ShuttleGui &S) override

Public Member Functions inherited from PrefsPanel
	PrefsPanel (wxWindow *parent, wxWindowID winid, const TranslatableString &title)

virtual	~PrefsPanel ()

virtual void	Preview ()

virtual bool	Commit ()=0

virtual PluginPath	GetPath () const override

virtual VendorSymbol	GetVendor () const override

virtual wxString	GetVersion () const override

virtual bool	ShowsPreviewButton ()

virtual void	PopulateOrExchange (ShuttleGui &WXUNUSED(S))

virtual ManualPageID	HelpPageName ()
	If not empty string, the Help button is added below the panel. More...

virtual void	Cancel ()

Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()

	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL\|wxNO_BORDER, const TranslatableString &name=XO("Panel"))

bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL\|wxNO_BORDER, const TranslatableString &name=XO("Panel"))

void	SetLabel (const TranslatableString &label)

void	SetName (const TranslatableString &name)

void	SetToolTip (const TranslatableString &toolTip)

void	SetName ()

Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)

	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete

	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete

wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete

wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
void	Populate ()

void	GetNamesAndLabels ()

void	OnSampleRateChoice (wxCommandEvent &e)

Private Attributes
TranslatableStrings	mSampleRateNames

std::vector< int >	mSampleRateLabels

wxChoice *	mSampleRates

wxTextCtrl *	mOtherSampleRate

int	mOtherSampleRateValue

Additional Inherited Members
Public Types inherited from PrefsPanel
using	Factories = std::vector< PrefsPanel::PrefsNode >

using	Factory = std::function< PrefsPanel (wxWindow parent, wxWindowID winid, AudacityProject *) >

Static Public Member Functions inherited from PrefsPanel
static Factories &	DefaultFactories ()

Detailed Description

A PrefsPanel used for setting audio quality.

Definition at line 28 of file QualityPrefs.h.

Constructor & Destructor Documentation

◆ QualityPrefs()

QualityPrefs::QualityPrefs	(	wxWindow *	parent,
		wxWindowID	winid
	)

Definition at line 39 of file QualityPrefs.cpp.

:  PrefsPanel(parent, winid, XO("Quality"))
{
   Populate();
}

◆ ~QualityPrefs()

QualityPrefs::~QualityPrefs ( )

virtual

Definition at line 46 of file QualityPrefs.cpp.

47{

48}

Member Function Documentation

◆ Commit()

bool QualityPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 198 of file QualityPrefs.cpp.

{
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
 
   QualitySettings::DefaultSampleRate.Invalidate();
 
   // The complex compound control may have value 'other' in which case the
   // value in prefs comes from the second field.
   if (mOtherSampleRate->IsEnabled()) {
      QualitySettings::DefaultSampleRate.Write( mOtherSampleRateValue );
      gPrefs->Flush();
   }
 
   // Tell CopySamples() to use these ditherers now
   InitDitherers();
 
   return true;
}

References QualitySettings::DefaultSampleRate, eIsSavingToPrefs, FileConfig::Flush(), gPrefs, InitDitherers(), Setting< T >::Invalidate(), mOtherSampleRate, mOtherSampleRateValue, PopulateOrExchange(), S, and Setting< T >::Write().

Here is the call graph for this function:

◆ GetDescription()

TranslatableString QualityPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 55 of file QualityPrefs.cpp.

{
   return XO("Preferences for Quality");
}

References XO().

Here is the call graph for this function:

◆ GetNamesAndLabels()

void QualityPrefs::GetNamesAndLabels ( )

private

Gets the lists of names and lists of labels which are used in the choice controls. The names are what the user sees in the wxChoice. The corresponding labels are what gets stored.

Definition at line 87 of file QualityPrefs.cpp.

{
   //------------ Sample Rate Names
   // JKC: I don't understand the following comment.
   //      Can someone please explain or correct it?
   // XXX: This should use a previously changed, but not yet saved
   //      sound card setting from the "I/O" preferences tab.
   // LLL: It means that until the user clicks "Ok" in preferences, the
   //      GetSupportedSampleRates() call should use the devices they
   //      may have changed on the Audio I/O page.  As coded, the sample
   //      rates it will return could be completely invalid as they will
   //      be what's supported by the devices that were selected BEFORE
   //      coming into preferences.
   //
   //      GetSupportedSampleRates() allows passing in device names, but
   //      how do you get at them as they are on the Audio I/O page????
   for (int i = 0; i < AudioIOBase::NumStandardRates; i++) {
      int iRate = AudioIOBase::StandardRates[i];
      mSampleRateLabels.push_back(iRate);
      mSampleRateNames.push_back( XO("%i Hz").Format( iRate ) );
   }
 
   mSampleRateNames.push_back(XO("Other..."));
 
   // The label for the 'Other...' case can be any value at all.
   mSampleRateLabels.push_back(44100); // If chosen, this value will be overwritten
}

References mSampleRateLabels, mSampleRateNames, AudioIOBase::NumStandardRates, AudioIOBase::StandardRates, and XO().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol QualityPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 50 of file QualityPrefs.cpp.

{
   return QUALITY_PREFS_PLUGIN_SYMBOL;
}

References QUALITY_PREFS_PLUGIN_SYMBOL.

◆ HelpPageName()

ManualPageID QualityPrefs::HelpPageName ( )

overridevirtual

If not empty string, the Help button is added below the panel.

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 60 of file QualityPrefs.cpp.

{
   return "Quality_Preferences";
}

◆ OnSampleRateChoice()

void QualityPrefs::OnSampleRateChoice ( wxCommandEvent & e )

private

Enables or disables the Edit box depending on whether we selected 'Other...' or not.

Definition at line 192 of file QualityPrefs.cpp.

{
   int sel = mSampleRates->GetSelection();
   mOtherSampleRate->Enable(sel == (int)mSampleRates->GetCount() - 1);
}

References mOtherSampleRate, and mSampleRates.

Referenced by Populate().

Here is the caller graph for this function:

◆ Populate()

void QualityPrefs::Populate ( )

private

Definition at line 65 of file QualityPrefs.cpp.

{
   // First any pre-processing for constructing the GUI.
   GetNamesAndLabels();
   mOtherSampleRateValue = QualitySettings::DefaultSampleRate.Read();
 
   //------------------------- Main section --------------------
   // Now construct the GUI itself.
   // Use 'eIsCreatingFromPrefs' so that the GUI is
   // initialised with values from gPrefs.
   ShuttleGui S(this, eIsCreatingFromPrefs);
   PopulateOrExchange(S);
   // ----------------------- End of main section --------------
 
   wxCommandEvent e;
   OnSampleRateChoice(e); // Enable/disable the control.
}

References QualitySettings::DefaultSampleRate, eIsCreatingFromPrefs, GetNamesAndLabels(), mOtherSampleRateValue, OnSampleRateChoice(), PopulateOrExchange(), Setting< T >::Read(), and S.

Here is the call graph for this function:

◆ PopulateOrExchange()

void QualityPrefs::PopulateOrExchange ( ShuttleGui & S )

override

Definition at line 115 of file QualityPrefs.cpp.

{
   S.SetBorder(2);
   S.StartScroller();
 
   S.StartStatic(XO("Sampling"));
   {
      S.StartMultiColumn(2);
      {
         S.AddPrompt(XXO("Default Sample &Rate:"));
 
         S.StartMultiColumn(2);
         {
            // First the choice...
            // We make sure it uses the ID we want, so that we get changes
            // We make sure we have a pointer to it, so that we can drive it.
            mSampleRates =
            S
               .Id(ID_SAMPLE_RATE_CHOICE)
               .TieNumberAsChoice( {},
                  QualitySettings::DefaultSampleRate,
                  mSampleRateNames,
                  &mSampleRateLabels,
                  // If the value in Prefs isn't in the list, then we want
                  // the last item, 'Other...' to be shown.
                  mSampleRateNames.size() - 1 );
 
            // Now do the edit box...
            mOtherSampleRate = S.TieNumericTextBox( {},
                                                   mOtherSampleRateValue,
                                                   15);
         }
         S.EndHorizontalLay();
 
         S
            .TieChoice( XXO("Default Sample &Format:"),
                       QualitySettings::SampleFormatSetting );
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
 
   S.StartStatic(XO("Real-time Conversion"));
   {
      S.StartMultiColumn(2, wxEXPAND);
      {
         S.TieChoice(XXO("Sample Rate Con&verter:"),
                     Resample::FastMethodSetting);
 
         /* i18n-hint: technical term for randomization to reduce undesirable resampling artifacts */
         S.TieChoice(XXO("&Dither:"),
                     Dither::FastSetting);
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
 
   S.StartStatic(XO("High-quality Conversion"));
   {
      S.StartMultiColumn(2);
      {
         S.TieChoice(XXO("Sample Rate Conver&ter:"),
                     Resample::BestMethodSetting);
 
         /* i18n-hint: technical term for randomization to reduce undesirable resampling artifacts */
         S.TieChoice(XXO("Dit&her:"),
                     Dither::BestSetting);
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
   S.EndScroller();
 
}

References Resample::BestMethodSetting, Dither::BestSetting, QualitySettings::DefaultSampleRate, Resample::FastMethodSetting, Dither::FastSetting, ID_SAMPLE_RATE_CHOICE, mOtherSampleRate, mOtherSampleRateValue, mSampleRateLabels, mSampleRateNames, mSampleRates, S, QualitySettings::SampleFormatSetting, XO(), and XXO().

Referenced by Commit(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mOtherSampleRate

wxTextCtrl* QualityPrefs::mOtherSampleRate

private

Definition at line 49 of file QualityPrefs.h.

Referenced by Commit(), OnSampleRateChoice(), and PopulateOrExchange().

◆ mOtherSampleRateValue

int QualityPrefs::mOtherSampleRateValue

private

Definition at line 50 of file QualityPrefs.h.

Referenced by Commit(), Populate(), and PopulateOrExchange().

◆ mSampleRateLabels

std::vector<int> QualityPrefs::mSampleRateLabels

private

Definition at line 46 of file QualityPrefs.h.

Referenced by GetNamesAndLabels(), and PopulateOrExchange().

◆ mSampleRateNames

TranslatableStrings QualityPrefs::mSampleRateNames

private

Definition at line 45 of file QualityPrefs.h.

Referenced by GetNamesAndLabels(), and PopulateOrExchange().

◆ mSampleRates

wxChoice* QualityPrefs::mSampleRates

private

Definition at line 48 of file QualityPrefs.h.

Referenced by OnSampleRateChoice(), and PopulateOrExchange().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QualityPrefs()

◆ ~QualityPrefs()

Member Function Documentation

◆ Commit()

◆ GetDescription()

◆ GetNamesAndLabels()

◆ GetSymbol()

◆ HelpPageName()

◆ OnSampleRateChoice()

◆ Populate()

◆ PopulateOrExchange()

Member Data Documentation

◆ mOtherSampleRate

◆ mOtherSampleRateValue

◆ mSampleRateLabels

◆ mSampleRateNames

◆ mSampleRates