Spectrogram settings, either for one track or as defaults. More...

#include <SpectrogramSettings.h>

Inheritance diagram for SpectrogramSettings:

Collaboration diagram for SpectrogramSettings:

Classes
class	ColorSchemeEnumSetting

class	Globals

Public Types
enum	{ LogMinWindowSize = 3 , LogMaxWindowSize = 15 , NumWindowSizes = LogMaxWindowSize - LogMinWindowSize + 1 }

enum	ScaleTypeValues : int { stLinear , stLogarithmic , stMel , stBark , stErb , stPeriod , stNumScaleTypes }

enum	ColorScheme : int { csColorNew = 0 , csColorTheme , csGrayscale , csInvGrayscale , csNumColorScheme }

enum	AlgorithmValues : int { algSTFT = 0 , algReassignment , algPitchEAC , algNumAlgorithms }

typedef int	ScaleType

typedef int	Algorithm

Public Types inherited from ClientData::Cloneable< Covariant, Owner >
using	Base = std::conditional_t< std::is_void_v< Covariant >, Cloneable, Covariant >

using	PointerType = Owner< Base >

Public Member Functions
	SpectrogramSettings ()

	SpectrogramSettings (const SpectrogramSettings &other)

SpectrogramSettings &	operator= (const SpectrogramSettings &other)

	~SpectrogramSettings ()

PointerType	Clone () const override

bool	IsDefault () const

bool	Validate (bool quiet)

void	LoadPrefs ()

void	SavePrefs ()

void	UpdatePrefs () override

void	InvalidateCaches ()

void	DestroyWindows ()

void	CacheWindows ()

void	ConvertToEnumeratedWindowSizes ()

void	ConvertToActualWindowSizes ()

float	findBin (float frequency, float binUnit) const

NumberScale	GetScale (float minFreq, float maxFreq) const

bool	SpectralSelectionEnabled () const

size_t	WindowSize () const

size_t	ZeroPaddingFactor () const

size_t	GetFFTLength () const

size_t	NBins () const

Public Member Functions inherited from PrefsListener
	PrefsListener ()

virtual	~PrefsListener ()

virtual void	UpdatePrefs ()=0

Public Member Functions inherited from ClientData::Cloneable< Covariant, Owner >
	Cloneable ()=default

	Cloneable (const Cloneable &)=default

Cloneable &	operator= (const Cloneable &)=default

virtual	~Cloneable ()=default

virtual PointerType	Clone () const =0

Static Public Member Functions
static const EnumValueSymbols &	GetScaleNames ()

static const EnumValueSymbols &	GetColorSchemeNames ()

static const TranslatableStrings &	GetAlgorithmNames ()

static SpectrogramSettings &	Get (const WaveTrack &track)

static SpectrogramSettings &	Get (const WaveChannel &channel)

static SpectrogramSettings &	Own (WaveChannel &wc)

static void	Reset (WaveChannel &channel)
	Make channel lose indpendent settings and use defaults. More...

static SpectrogramSettings &	defaults ()

Static Public Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...

Public Attributes
int	minFreq

int	maxFreq

int	range

int	gain

int	frequencyGain

int	windowType

ColorScheme	colorScheme

ScaleType	scaleType

bool	spectralSelection

Algorithm	algorithm

HFFT	hFFT

Floats	window

Floats	tWindow

Floats	dWindow

Static Public Attributes
static ColorSchemeEnumSetting	colorSchemeSetting

Private Attributes
int	windowSize

int	zeroPaddingFactor

Friends
class	SpectrumPrefs

Additional Inherited Members
Protected Member Functions inherited from PrefsListener
virtual void	UpdateSelectedPrefs (int id)

Detailed Description

Spectrogram settings, either for one track or as defaults.

Definition at line 29 of file SpectrogramSettings.h.

Member Typedef Documentation

◆ Algorithm

typedef int SpectrogramSettings::Algorithm

Definition at line 175 of file SpectrogramSettings.h.

◆ ScaleType

typedef int SpectrogramSettings::ScaleType

Definition at line 62 of file SpectrogramSettings.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
LogMinWindowSize
LogMaxWindowSize
NumWindowSizes

Definition at line 52 of file SpectrogramSettings.h.

        {
      LogMinWindowSize = 3,
      LogMaxWindowSize = 15,
 
      NumWindowSizes = LogMaxWindowSize - LogMinWindowSize + 1,
   };

◆ AlgorithmValues

enum SpectrogramSettings::AlgorithmValues : int

Enumerator
algSTFT
algReassignment
algPitchEAC
algNumAlgorithms

Definition at line 176 of file SpectrogramSettings.h.

                        : int {
      algSTFT = 0,
      algReassignment,
      algPitchEAC,
 
      algNumAlgorithms,
   };

◆ ColorScheme

enum SpectrogramSettings::ColorScheme : int

Enumerator
csColorNew
csColorTheme
csGrayscale
csInvGrayscale
csNumColorScheme

Definition at line 152 of file SpectrogramSettings.h.

                    : int {
      // Keep in correspondence with AColor::colorSchemes, AColor::gradient_pre
      csColorNew = 0,
      csColorTheme,
      csGrayscale,
      csInvGrayscale,
 
      csNumColorScheme,
   };

◆ ScaleTypeValues

enum SpectrogramSettings::ScaleTypeValues : int

Enumerator
stLinear
stLogarithmic
stMel
stBark
stErb
stPeriod
stNumScaleTypes

Definition at line 63 of file SpectrogramSettings.h.

                        : int {
      stLinear,
      stLogarithmic,
      stMel,
      stBark,
      stErb,
      stPeriod,
 
      stNumScaleTypes,
   };

Constructor & Destructor Documentation

◆ SpectrogramSettings() [1/2]

SpectrogramSettings::SpectrogramSettings ( )

Definition at line 142 of file SpectrogramSettings.cpp.

{
   LoadPrefs();
}

References LoadPrefs().

Here is the call graph for this function:

◆ SpectrogramSettings() [2/2]

SpectrogramSettings::SpectrogramSettings ( const SpectrogramSettings & other )

Definition at line 147 of file SpectrogramSettings.cpp.

   : minFreq(other.minFreq)
   , maxFreq(other.maxFreq)
   , range(other.range)
   , gain(other.gain)
   , frequencyGain(other.frequencyGain)
   , windowType(other.windowType)
   , windowSize(other.windowSize)
   , zeroPaddingFactor(other.zeroPaddingFactor)
   , colorScheme(other.colorScheme)
   , scaleType(other.scaleType)
#ifndef SPECTRAL_SELECTION_GLOBAL_SWITCH
   , spectralSelection(other.spectralSelection)
#endif
   , algorithm(other.algorithm)
#ifdef EXPERIMENTAL_FFT_Y_GRID
   , fftYGrid(other.fftYGrid)
#endif
#ifdef EXPERIMENTAL_FIND_NOTES
   , fftFindNotes(other.fftFindNotes)
   , findNotesMinA(other.findNotesMinA)
   , numberOfMaxima(other.numberOfMaxima)
   , findNotesQuantize(other.findNotesQuantize)
#endif
 
   // Do not copy these!
   , hFFT{}
   , window{}
   , tWindow{}
   , dWindow{}
{
}

◆ ~SpectrogramSettings()

SpectrogramSettings::~SpectrogramSettings ( )

Definition at line 518 of file SpectrogramSettings.cpp.

{
   DestroyWindows();
}

References DestroyWindows().

Here is the call graph for this function:

Member Function Documentation

◆ CacheWindows()

void SpectrogramSettings::CacheWindows ( )

Definition at line 593 of file SpectrogramSettings.cpp.

{
   if (hFFT == NULL || window == NULL) {
 
      double scale;
      auto factor = ZeroPaddingFactor();
      const auto fftLen = WindowSize() * factor;
      const auto padding = (WindowSize() * (factor - 1)) / 2;
 
      hFFT = GetFFT(fftLen);
      RecreateWindow(window, WINDOW, fftLen, padding, windowType, windowSize, scale);
      if (algorithm == algReassignment) {
         RecreateWindow(tWindow, TWINDOW, fftLen, padding, windowType, windowSize, scale);
         RecreateWindow(dWindow, DWINDOW, fftLen, padding, windowType, windowSize, scale);
      }
   }
}

References algorithm, algReassignment, anonymous_namespace{SpectrogramSettings.cpp}::DWINDOW, dWindow, GetFFT(), hFFT, anonymous_namespace{SpectrogramSettings.cpp}::RecreateWindow(), anonymous_namespace{SpectrogramSettings.cpp}::TWINDOW, tWindow, anonymous_namespace{SpectrogramSettings.cpp}::WINDOW, window, windowSize, WindowSize(), windowType, and ZeroPaddingFactor().

Here is the call graph for this function:

◆ Clone()

auto SpectrogramSettings::Clone ( ) const

overridevirtual

Implements ClientData::Cloneable< Covariant, Owner >.

Definition at line 523 of file SpectrogramSettings.cpp.

{
   return std::make_unique<SpectrogramSettings>(*this);
}

◆ ConvertToActualWindowSizes()

void SpectrogramSettings::ConvertToActualWindowSizes ( )

Definition at line 633 of file SpectrogramSettings.cpp.

{
   windowSize = 1 << (windowSize + LogMinWindowSize);
   zeroPaddingFactor = 1 << zeroPaddingFactor;
}

References LogMinWindowSize, windowSize, and zeroPaddingFactor.

Referenced by SpectrumPrefs::Preview(), SpectrumPrefs::Validate(), and Validate().

Here is the caller graph for this function:

◆ ConvertToEnumeratedWindowSizes()

void SpectrogramSettings::ConvertToEnumeratedWindowSizes ( )

Definition at line 611 of file SpectrogramSettings.cpp.

{
   unsigned size;
   int logarithm;
 
   logarithm = -LogMinWindowSize;
   size = unsigned(windowSize);
   while (size > 1)
      size >>= 1, ++logarithm;
   windowSize = std::max(0, std::min(NumWindowSizes - 1, logarithm));
 
   // Choices for zero padding begin at 1
   logarithm = 0;
   size = unsigned(zeroPaddingFactor);
   while (zeroPaddingFactor > 1)
      zeroPaddingFactor >>= 1, ++logarithm;
   zeroPaddingFactor = std::max(0,
      std::min(LogMaxWindowSize - (windowSize + LogMinWindowSize),
         logarithm
   ));
}

References LogMaxWindowSize, LogMinWindowSize, min(), NumWindowSizes, size, windowSize, and zeroPaddingFactor.

Referenced by SpectrumPrefs::OnDefaults(), SpectrumPrefs::Preview(), SpectrumPrefs::SpectrumPrefs(), SpectrumPrefs::Validate(), and Validate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ defaults()

SpectrogramSettings & SpectrogramSettings::defaults ( )

static

Definition at line 213 of file SpectrogramSettings.cpp.

{
   static SpectrogramSettings instance;
   return instance;
}

Referenced by SpectrumPrefs::Commit(), Get(), SpectrumPrefs::OnDefaults(), SpectrumPrefs::Preview(), SpectrumPrefs::Rollback(), SpectrumPrefs::SpectrumPrefs(), and UpdatePrefs().

Here is the caller graph for this function:

◆ DestroyWindows()

void SpectrogramSettings::DestroyWindows ( )

Definition at line 528 of file SpectrogramSettings.cpp.

{
   hFFT.reset();
   window.reset();
   dWindow.reset();
   tWindow.reset();
}

References dWindow, hFFT, tWindow, and window.

Referenced by InvalidateCaches(), operator=(), and ~SpectrogramSettings().

Here is the caller graph for this function:

◆ findBin()

float SpectrogramSettings::findBin	(	float	frequency,
		float	binUnit
	)		const

Definition at line 639 of file SpectrogramSettings.cpp.

{
   float linearBin = frequency / binUnit;
   if (linearBin < 0)
      return -1;
   else
      return linearBin;
}

◆ Get() [1/2]

SpectrogramSettings & SpectrogramSettings::Get ( const WaveChannel & channel )

static

Return either the track's independent settings or global defaults Mutative access to attachment even if the track argument is const

Definition at line 120 of file SpectrogramSettings.cpp.

{
   return Get(channel.GetTrack());
}

References Get(), and WaveChannel::GetTrack().

Here is the call graph for this function:

◆ Get() [2/2]

SpectrogramSettings & SpectrogramSettings::Get ( const WaveTrack & track )

static

Return either the track's independent settings or global defaults Mutative access to attachment even if the track argument is const

Definition at line 110 of file SpectrogramSettings.cpp.

{
   auto &mutTrack = const_cast<WaveTrack&>(track);
   auto pSettings = mutTrack.Attachments::Find<SpectrogramSettings>(key1);
   if (pSettings)
      return *pSettings;
   else
      return SpectrogramSettings::defaults();
}

References defaults(), and key1.

Referenced by SetTrackVisualsCommand::ApplyInner(), BrushHandle::BrushHandle(), SpectrumView::DoSetMinimized(), SpectrumVRulerControls::DoUpdateVRuler(), SpectrumVZoomHandle::DoZoom(), anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), for(), anonymous_namespace{BrushHandle.cpp}::FrequencyToPosition(), anonymous_namespace{SelectHandle.cpp}::FrequencyToPosition(), Get(), SpectrogramBounds::Get(), SpectrogramBounds::GetBounds(), NyquistEffect::Init(), anonymous_namespace{SelectHandle.cpp}::isSpectralSelectionView(), anonymous_namespace{BrushHandle.cpp}::isSpectralSelectionView(), SpectrumVRulerMenuTable::OnSpectrumScaleType(), anonymous_namespace{BrushHandle.cpp}::PositionToFrequency(), anonymous_namespace{SelectHandle.cpp}::PositionToFrequency(), NyquistEffect::ProcessOne(), SelectHandle::SnapCenterOnce(), SpectrumPrefs::SpectrumPrefs(), and SelectHandle::StartSnappingFreqSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAlgorithmNames()

const TranslatableStrings & SpectrogramSettings::GetAlgorithmNames ( )

static

Definition at line 280 of file SpectrogramSettings.cpp.

{
   static const TranslatableStrings results{
      // Keep in correspondence with enum SpectrogramSettings::Algorithm:
      XO("Frequencies") ,
      /* i18n-hint: the Reassignment algorithm for spectrograms */
      XO("Reassignment") ,
      /* i18n-hint: EAC abbreviates "Enhanced Autocorrelation" */
      XO("Pitch (EAC)") ,
   };
   return results;
}

References XO().

Referenced by SpectrumPrefs::PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetColorSchemeNames()

const EnumValueSymbols & SpectrogramSettings::GetColorSchemeNames ( )

static

Definition at line 239 of file SpectrogramSettings.cpp.

{
   static const EnumValueSymbols result{
      // Keep in correspondence with enum SpectrogramSettings::ColorScheme:
      /* i18n-hint: New color scheme for spectrograms, Roseus is proper name of the color scheme */
      { wxT("SpecColorNew"),     XC("Color (Roseus)",    "spectrum prefs") },
      /* i18n-hint: Classic color scheme(from theme) for spectrograms */
      { wxT("SpecColorTheme"),   XC("Color (classic)",   "spectrum prefs") },
      /* i18n-hint: Grayscale color scheme for spectrograms */
      { wxT("SpecGrayscale"),    XC("Grayscale",         "spectrum prefs") },
      /* i18n-hint: Inverse grayscale color scheme for spectrograms */
      { wxT("SpecInvGrayscale"), XC("Inverse grayscale", "spectrum prefs") },
   };
 
   wxASSERT(csNumColorScheme == result.size());
   static_assert(csNumColorScheme == AColor::colorSchemes, "Broken correspondence");
 
   return result;
}

References AColor::colorSchemes, csNumColorScheme, wxT(), and XC.

Referenced by SpectrogramSettings::ColorSchemeEnumSetting::Migrate(), SetTrackVisualsCommand::PopulateOrExchange(), SpectrumPrefs::PopulateOrExchange(), and SetTrackVisualsCommand::VisitSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFFTLength()

size_t SpectrogramSettings::GetFFTLength ( ) const

Definition at line 648 of file SpectrogramSettings.cpp.

{
//#ifndef EXPERIMENTAL_ZERO_PADDED_SPECTROGRAMS
  // return windowSize;
//#else
   return windowSize * ((algorithm != algPitchEAC) ? zeroPaddingFactor : 1);
//#endif
}

References algorithm, algPitchEAC, windowSize, and zeroPaddingFactor.

Referenced by NBins().

Here is the caller graph for this function:

◆ GetScale()

NumberScale SpectrogramSettings::GetScale	(	float	minFreq,
		float	maxFreq
	)		const

Definition at line 663 of file SpectrogramSettings.cpp.

{
   NumberScaleType type = nstLinear;
 
   // Don't assume the correspondence of the enums will remain direct in the future.
   // Do this switch.
   switch (scaleType) {
   default:
      wxASSERT(false);
   case stLinear:
      type = nstLinear; break;
   case stLogarithmic:
      type = nstLogarithmic; break;
   case stMel:
      type = nstMel; break;
   case stBark:
      type = nstBark; break;
   case stErb:
      type = nstErb; break;
   case stPeriod:
      type = nstPeriod; break;
   }
 
   return NumberScale(type, minFreqIn, maxFreqIn);
}

References nstBark, nstErb, nstLinear, nstLogarithmic, nstMel, nstPeriod, scaleType, stBark, stErb, stLinear, stLogarithmic, stMel, and stPeriod.

◆ GetScaleNames()

const EnumValueSymbols & SpectrogramSettings::GetScaleNames ( )

static

Definition at line 220 of file SpectrogramSettings.cpp.

{
   static const EnumValueSymbols result{
      // Keep in correspondence with enum SpectrogramSettings::ScaleType:
      XO("Linear") ,
      XO("Logarithmic") ,
      /* i18n-hint: The name of a frequency scale in psychoacoustics */
      XO("Mel") ,
      /* i18n-hint: The name of a frequency scale in psychoacoustics, named for Heinrich Barkhausen */
      XO("Bark") ,
      /* i18n-hint: The name of a frequency scale in psychoacoustics, abbreviates Equivalent Rectangular Bandwidth */
      XO("ERB") ,
      /* i18n-hint: Time units, that is Period = 1 / Frequency */
      XO("Period") ,
   };
   return result;
}

References XO().

Referenced by SpectrumPrefs::PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InvalidateCaches()

void SpectrogramSettings::InvalidateCaches ( )

Definition at line 513 of file SpectrogramSettings.cpp.

{
   DestroyWindows();
}

References DestroyWindows().

Referenced by LoadPrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsDefault()

bool SpectrogramSettings::IsDefault ( ) const

inline

Definition at line 101 of file SpectrogramSettings.h.

   {
      return this == &defaults();
   }

◆ LoadPrefs()

void SpectrogramSettings::LoadPrefs ( )

Definition at line 364 of file SpectrogramSettings.cpp.

{
   minFreq = SpectrumMinFreq.Read();
 
   maxFreq = SpectrumMaxFreq.Read();
 
   range = SpectrumRange.Read();
   gain = SpectrumGain.Read();
   frequencyGain = SpectrumFrequencyGain.Read();
 
   windowSize = SpectrumFFTSize.Read();
 
   zeroPaddingFactor = SpectrumZeroPaddingFactor.Read();
 
   windowType = SpectrumWindowFunction.Read();
 
   colorScheme = colorSchemeSetting.ReadEnum();
 
   scaleType = static_cast<ScaleType>(SpectrumScale.Read());
 
#ifndef SPECTRAL_SELECTION_GLOBAL_SWITCH
   spectralSelection = SpectrumEnableSelection.Read();
#endif
 
   algorithm = static_cast<Algorithm>(SpectrumAlgorithm.Read());
 
#ifdef EXPERIMENTAL_FFT_Y_GRID
   fftYGrid = SpectrumYGrid.Read();
#endif //EXPERIMENTAL_FFT_Y_GRID
 
#ifdef EXPERIMENTAL_FIND_NOTES
   fftFindNotes = SpectrumFindNotes.Read();
   findNotesMinA = SpectrumFindNotesMinA.Read();
   numberOfMaxima = SpectrumFindNotesN.Read();
   findNotesQuantize = SpectrumFindNotesQuantize.Read();
#endif //EXPERIMENTAL_FIND_NOTES
 
   // Enforce legal values
   Validate(true);
 
   InvalidateCaches();
}

Referenced by SpectrumPrefs::Commit(), and SpectrogramSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NBins()

size_t SpectrogramSettings::NBins ( ) const

Definition at line 657 of file SpectrogramSettings.cpp.

{
   // Omit the Nyquist frequency bin
   return GetFFTLength() / 2;
}

References GetFFTLength().

Here is the call graph for this function:

◆ operator=()

SpectrogramSettings & SpectrogramSettings::operator= ( const SpectrogramSettings & other )

Definition at line 180 of file SpectrogramSettings.cpp.

{
   if (this != &other) {
      minFreq = other.minFreq;
      maxFreq = other.maxFreq;
      range = other.range;
      gain = other.gain;
      frequencyGain = other.frequencyGain;
      windowType = other.windowType;
      windowSize = other.windowSize;
      zeroPaddingFactor = other.zeroPaddingFactor;
      colorScheme = other.colorScheme;
      scaleType = other.scaleType;
#ifndef SPECTRAL_SELECTION_GLOBAL_SWITCH
      spectralSelection = other.spectralSelection;
#endif
      algorithm = other.algorithm;
#ifdef EXPERIMENTAL_FFT_Y_GRID
      fftYGrid = other.fftYGrid;
#endif
#ifdef EXPERIMENTAL_FIND_NOTES
      fftFindNotes = other.fftFindNotes;
      findNotesMinA = other.findNotesMinA;
      numberOfMaxima = other.numberOfMaxima;
      findNotesQuantize = other.findNotesQuantize;
#endif
 
      // Invalidate the caches
      DestroyWindows();
   }
   return *this;
}

References algorithm, colorScheme, DestroyWindows(), frequencyGain, gain, maxFreq, minFreq, range, scaleType, spectralSelection, windowSize, windowType, and zeroPaddingFactor.

Here is the call graph for this function:

◆ Own()

SpectrogramSettings & SpectrogramSettings::Own ( WaveChannel & wc )

static

Definition at line 125 of file SpectrogramSettings.cpp.

{
   auto &track = wc.GetTrack();
   auto pSettings = track.Attachments::Find<SpectrogramSettings>(key1);
   if (!pSettings) {
      auto uSettings = std::make_unique<SpectrogramSettings>();
      pSettings = uSettings.get();
      track.Attachments::Assign(key1, std::move(uSettings));
   }
   return *pSettings;
}

References WaveChannel::GetTrack(), and key1.

Referenced by SetTrackVisualsCommand::ApplyInner(), SpectrumVRulerControls::DoHandleWheelRotation(), SpectrumVRulerMenuTable::OnSpectrumScaleType(), SpectrumPrefs::Preview(), and SpectrumPrefs::Rollback().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Reset()

void SpectrogramSettings::Reset ( WaveChannel & channel )

static

Make channel lose indpendent settings and use defaults.

Definition at line 137 of file SpectrogramSettings.cpp.

{
   wc.GetTrack().Attachments::Assign(key1, nullptr);
}

References WaveChannel::GetTrack(), and key1.

Referenced by SetTrackVisualsCommand::ApplyInner(), SpectrumPrefs::Preview(), and SpectrumPrefs::Rollback().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SavePrefs()

void SpectrogramSettings::SavePrefs ( )

Definition at line 407 of file SpectrogramSettings.cpp.

{
   SpectrumMinFreq.Write(minFreq);
   SpectrumMaxFreq.Write(maxFreq);
 
   // Nothing wrote these.  They only varied from the linear scale bounds in-session. -- PRL
   // gPrefs->Write(wxT("/SpectrumLog/MaxFreq"), logMinFreq);
   // gPrefs->Write(wxT("/SpectrumLog/MinFreq"), logMaxFreq);
 
   SpectrumRange.Write(range);
   SpectrumGain.Write(gain);
   SpectrumFrequencyGain.Write(frequencyGain);
 
   SpectrumFFTSize.Write(windowSize);
 
   SpectrumZeroPaddingFactor.Write(zeroPaddingFactor);
 
   SpectrumWindowFunction.Write(windowType);
 
   colorSchemeSetting.WriteEnum(colorScheme);
 
   SpectrumScale.Write(static_cast<int>(scaleType));
 
#ifndef SPECTRAL_SELECTION_GLOBAL_SWITCH
   SpectrumEnableSelection.Write(spectralSelection);
#endif
 
   SpectrumAlgorithm.Write(static_cast<int>(algorithm));
 
#ifdef EXPERIMENTAL_FFT_Y_GRID
   SpectrumYGrid.Write(fftYGrid);
#endif //EXPERIMENTAL_FFT_Y_GRID
 
#ifdef EXPERIMENTAL_FIND_NOTES
   SpectrumFindNotes.Write(fftFindNotes);
   SpectrumFindNotesMinA.Write(findNotesMinA);
   SpectrumFindNotesN.Write(numberOfMaxima);
   SpectrumFindNotesQuantize.Write(findNotesQuantize);
#endif //EXPERIMENTAL_FIND_NOTES
}

Referenced by SpectrumPrefs::Commit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SpectralSelectionEnabled()

bool SpectrogramSettings::SpectralSelectionEnabled ( ) const

Definition at line 689 of file SpectrogramSettings.cpp.

{
#ifdef SPECTRAL_SELECTION_GLOBAL_SWITCH
   return Globals::Get().spectralSelection;
#else
   return spectralSelection;
#endif
}

References SpectrogramSettings::Globals::Get(), and spectralSelection.

Referenced by NyquistEffect::Init(), anonymous_namespace{SelectHandle.cpp}::isSpectralSelectionView(), anonymous_namespace{BrushHandle.cpp}::isSpectralSelectionView(), and NyquistEffect::ProcessOne().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdatePrefs()

void SpectrogramSettings::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Definition at line 449 of file SpectrogramSettings.cpp.

{
   if (minFreq == defaults().minFreq)
      minFreq = SpectrumMinFreq.Read();
 
   if (maxFreq == defaults().maxFreq)
      maxFreq = SpectrumMaxFreq.Read();
 
   if (range == defaults().range)
      range = SpectrumRange.Read();
 
   if (gain == defaults().gain)
      gain = SpectrumGain.Read();
 
   if (frequencyGain == defaults().frequencyGain)
      frequencyGain = SpectrumFrequencyGain.Read();
 
   if (windowSize == defaults().windowSize)
      windowSize = SpectrumFFTSize.Read();
 
   if (zeroPaddingFactor == defaults().zeroPaddingFactor)
      zeroPaddingFactor = SpectrumZeroPaddingFactor.Read();
 
   if (windowType == defaults().windowType)
      windowType = SpectrumWindowFunction.Read();
 
   if (colorScheme == defaults().colorScheme) {
      colorScheme = colorSchemeSetting.ReadEnum();
   }
 
   if (scaleType == defaults().scaleType)
      scaleType = static_cast<ScaleType>(SpectrumScale.Read());
 
#ifndef SPECTRAL_SELECTION_GLOBAL_SWITCH
   if (spectralSelection == defaults().spectralSelection)
      spectralSelection = SpectrumEnableSelection.Read();
#endif
 
   if (algorithm == defaults().algorithm)
      algorithm = static_cast<Algorithm>(SpectrumAlgorithm.Read());
 
#ifdef EXPERIMENTAL_FFT_Y_GRID
   if (fftYGrid == defaults().fftYGrid)
      fftYGrid = SpectrumYGrid.Read();
#endif //EXPERIMENTAL_FFT_Y_GRID
 
#ifdef EXPERIMENTAL_FIND_NOTES
   if (fftFindNotes == defaults().fftFindNotes)
      fftFindNotes = SpectrumFindNotes.Read();
 
   if (findNotesMinA == defaults().findNotesMinA)
      findNotesMinA = SpectrumFindNotesMinA.Read();
 
   if (numberOfMaxima == defaults().numberOfMaxima)
      numberOfMaxima = SpectrumFindNotesN.Read();
 
   if (findNotesQuantize == defaults().findNotesQuantize)
      findNotesQuantize = SpectrumFindNotesQuantize.Read();
#endif //EXPERIMENTAL_FIND_NOTES
 
   // Enforce legal values
   Validate(true);
}

Here is the call graph for this function:

◆ Validate()

bool SpectrogramSettings::Validate ( bool quiet )

Definition at line 293 of file SpectrogramSettings.cpp.

{
   if (!quiet &&
      maxFreq < 100) {
      AudacityMessageBox( XO("Maximum frequency must be 100 Hz or above") );
      return false;
   }
   else
      maxFreq = std::max(100, maxFreq);
 
   if (!quiet &&
      minFreq < 0) {
      AudacityMessageBox( XO("Minimum frequency must be at least 0 Hz") );
      return false;
   }
   else
      minFreq = std::max(0, minFreq);
 
   if (!quiet &&
      maxFreq <= minFreq) {
      AudacityMessageBox( XO(
"Minimum frequency must be less than maximum frequency") );
      return false;
   }
   else
      maxFreq = std::max(1 + minFreq, maxFreq);
 
   if (!quiet &&
      range <= 0) {
      AudacityMessageBox( XO("The range must be at least 1 dB") );
      return false;
   }
   else
      range = std::max(1, range);
 
   if (!quiet &&
      frequencyGain < 0) {
      AudacityMessageBox( XO("The frequency gain cannot be negative") );
      return false;
   }
   else if (!quiet &&
      frequencyGain > 60) {
      AudacityMessageBox( XO(
"The frequency gain must be no more than 60 dB/dec") );
      return false;
   }
   else
      frequencyGain =
         std::max(0, std::min(60, frequencyGain));
 
   // The rest are controlled by drop-down menus so they can't go wrong
   // in the Preferences dialog, but we also come here after reading fom saved
   // preference files, which could be or from future versions.  Validate quietly.
   windowType =
      std::max(0, std::min(NumWindowFuncs() - 1, windowType));
   scaleType =
      ScaleType(std::max(0,
         std::min((int)(SpectrogramSettings::stNumScaleTypes) - 1,
            (int)(scaleType))));
   colorScheme = ColorScheme(
      std::max(0, std::min<int>(csNumColorScheme-1, colorScheme))
   );
   algorithm = Algorithm(
      std::max(0, std::min((int)(algNumAlgorithms) - 1, (int)(algorithm)))
   );
   ConvertToEnumeratedWindowSizes();
   ConvertToActualWindowSizes();
 
   return true;
}

References algNumAlgorithms, algorithm, AudacityMessageBox(), colorScheme, ConvertToActualWindowSizes(), ConvertToEnumeratedWindowSizes(), csNumColorScheme, frequencyGain, maxFreq, min(), minFreq, NumWindowFuncs(), range, scaleType, stNumScaleTypes, windowType, and XO().

Referenced by LoadPrefs(), UpdatePrefs(), and SpectrumPrefs::Validate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WindowSize()

size_t SpectrogramSettings::WindowSize ( ) const

inline

Definition at line 140 of file SpectrogramSettings.h.

140{ return windowSize; }

Referenced by CacheWindows(), and SpectrumPrefs::SpectrumPrefs().

Here is the caller graph for this function:

◆ ZeroPaddingFactor()

size_t SpectrogramSettings::ZeroPaddingFactor ( ) const

inline

Definition at line 145 of file SpectrogramSettings.h.

                                    {
      return algorithm == algPitchEAC ? 1 : zeroPaddingFactor;
   }

Referenced by CacheWindows().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ SpectrumPrefs

friend class SpectrumPrefs

friend

Definition at line 33 of file SpectrogramSettings.h.

Member Data Documentation

◆ algorithm

Algorithm SpectrogramSettings::algorithm

Definition at line 183 of file SpectrogramSettings.h.

Referenced by CacheWindows(), GetFFTLength(), LoadPrefs(), operator=(), SpectrumPrefs::PopulateOrExchange(), SavePrefs(), UpdatePrefs(), and Validate().

◆ colorScheme

ColorScheme SpectrogramSettings::colorScheme

Definition at line 161 of file SpectrogramSettings.h.

Referenced by LoadPrefs(), operator=(), SpectrumPrefs::PopulateOrExchange(), SavePrefs(), UpdatePrefs(), and Validate().

◆ colorSchemeSetting

SpectrogramSettings::ColorSchemeEnumSetting SpectrogramSettings::colorSchemeSetting

static

Initial value:

{
   wxT("/Spectrum/ColorScheme"),
   GetColorSchemeNames(),
   csColorNew, 
   { csColorNew, csColorTheme, csGrayscale, csInvGrayscale },
}

Definition at line 167 of file SpectrogramSettings.h.

Referenced by LoadPrefs(), SavePrefs(), and UpdatePrefs().

◆ dWindow

Floats SpectrogramSettings::dWindow

Definition at line 204 of file SpectrogramSettings.h.

Referenced by CacheWindows(), and DestroyWindows().

◆ frequencyGain

int SpectrogramSettings::frequencyGain

Definition at line 133 of file SpectrogramSettings.h.

Referenced by LoadPrefs(), operator=(), SpectrumPrefs::PopulateOrExchange(), SavePrefs(), UpdatePrefs(), and Validate().

◆ gain

int SpectrogramSettings::gain

Definition at line 132 of file SpectrogramSettings.h.

Referenced by LoadPrefs(), operator=(), SpectrumPrefs::PopulateOrExchange(), SavePrefs(), and UpdatePrefs().

◆ hFFT

HFFT SpectrogramSettings::hFFT

Definition at line 199 of file SpectrogramSettings.h.

Referenced by CacheWindows(), and DestroyWindows().

◆ maxFreq

int SpectrogramSettings::maxFreq

Definition at line 126 of file SpectrogramSettings.h.

Referenced by LoadPrefs(), operator=(), SpectrumPrefs::PopulateOrExchange(), SpectrumPrefs::Preview(), SavePrefs(), SpectrumPrefs::SpectrumPrefs(), UpdatePrefs(), and Validate().

◆ minFreq

int SpectrogramSettings::minFreq

Definition at line 125 of file SpectrogramSettings.h.

Referenced by LoadPrefs(), operator=(), SpectrumPrefs::PopulateOrExchange(), SpectrumPrefs::Preview(), SavePrefs(), SpectrumPrefs::SpectrumPrefs(), UpdatePrefs(), and Validate().

◆ range

int SpectrogramSettings::range

Definition at line 131 of file SpectrogramSettings.h.

Referenced by LoadPrefs(), operator=(), SpectrumPrefs::PopulateOrExchange(), SavePrefs(), UpdatePrefs(), and Validate().

◆ scaleType

ScaleType SpectrogramSettings::scaleType

Definition at line 169 of file SpectrogramSettings.h.

Referenced by SpectrumView::DoSetMinimized(), GetScale(), LoadPrefs(), SpectrumVRulerMenuTable::OnSpectrumScaleType(), operator=(), SpectrumPrefs::PopulateOrExchange(), SavePrefs(), UpdatePrefs(), and Validate().

◆ spectralSelection

bool SpectrogramSettings::spectralSelection

Definition at line 172 of file SpectrogramSettings.h.

Referenced by SpectrogramSettings::Globals::LoadPrefs(), LoadPrefs(), operator=(), SpectrumPrefs::PopulateOrExchange(), SpectrogramSettings::Globals::SavePrefs(), SavePrefs(), SpectralSelectionEnabled(), and UpdatePrefs().

◆ tWindow

Floats SpectrogramSettings::tWindow

Definition at line 203 of file SpectrogramSettings.h.

Referenced by CacheWindows(), and DestroyWindows().

◆ window

Floats SpectrogramSettings::window

Definition at line 200 of file SpectrogramSettings.h.

Referenced by CacheWindows(), DestroyWindows(), and anonymous_namespace{SpectrogramSettings.cpp}::RecreateWindow().

◆ windowSize

int SpectrogramSettings::windowSize

private

Definition at line 138 of file SpectrogramSettings.h.

Referenced by CacheWindows(), ConvertToActualWindowSizes(), ConvertToEnumeratedWindowSizes(), GetFFTLength(), LoadPrefs(), operator=(), SpectrumPrefs::PopulateOrExchange(), anonymous_namespace{SpectrogramSettings.cpp}::RecreateWindow(), SavePrefs(), and UpdatePrefs().

◆ windowType

int SpectrogramSettings::windowType

Definition at line 135 of file SpectrogramSettings.h.

Referenced by CacheWindows(), LoadPrefs(), operator=(), SpectrumPrefs::PopulateOrExchange(), anonymous_namespace{SpectrogramSettings.cpp}::RecreateWindow(), SavePrefs(), UpdatePrefs(), and Validate().

◆ zeroPaddingFactor

int SpectrogramSettings::zeroPaddingFactor

private

Definition at line 143 of file SpectrogramSettings.h.

Referenced by ConvertToActualWindowSizes(), ConvertToEnumeratedWindowSizes(), GetFFTLength(), LoadPrefs(), operator=(), SpectrumPrefs::PopulateOrExchange(), SavePrefs(), and UpdatePrefs().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Algorithm

◆ ScaleType

Member Enumeration Documentation

◆ anonymous enum

◆ AlgorithmValues

◆ ColorScheme

◆ ScaleTypeValues

Constructor & Destructor Documentation

◆ SpectrogramSettings() [1/2]

◆ SpectrogramSettings() [2/2]

◆ ~SpectrogramSettings()

Member Function Documentation

◆ CacheWindows()

◆ Clone()

◆ ConvertToActualWindowSizes()

◆ ConvertToEnumeratedWindowSizes()

◆ defaults()

◆ DestroyWindows()

◆ findBin()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetAlgorithmNames()

◆ GetColorSchemeNames()

◆ GetFFTLength()

◆ GetScale()

◆ GetScaleNames()

◆ InvalidateCaches()

◆ IsDefault()

◆ LoadPrefs()

◆ NBins()

◆ operator=()

◆ Own()

◆ Reset()

◆ SavePrefs()

◆ SpectralSelectionEnabled()

◆ UpdatePrefs()

◆ Validate()

◆ WindowSize()

◆ ZeroPaddingFactor()

Friends And Related Function Documentation

◆ SpectrumPrefs

Member Data Documentation

◆ algorithm

◆ colorScheme

◆ colorSchemeSetting

◆ dWindow

◆ frequencyGain

◆ gain

◆ hFFT

◆ maxFreq

◆ minFreq

◆ range

◆ scaleType

◆ spectralSelection

◆ tWindow

◆ window

◆ windowSize

◆ windowType

◆ zeroPaddingFactor