EqualizationParameters Struct Reference

Parameters of the Equalization effects that persist in configuration files. More...

#include <EqualizationParameters.h>

Inheritance diagram for EqualizationParameters:

Collaboration diagram for EqualizationParameters:

Public Types
enum	kInterpolations { kBspline , kCosine , kCubic , nInterpolations }

Public Member Functions
	EqualizationParameters (const EffectSettingsManager &manager)
void	LoadDefaults (int options)
void	SaveConfig (const EffectSettingsManager &manager) const
bool	IsLinear () const

Public Attributes
wxString	mCurveName
float	mdBMin
float	mdBMax
size_t	mM
int	mInterp
bool	mDrawMode
bool	mDrawGrid
bool	mLin

Static Public Attributes
static const EnumValueSymbol	kInterpStrings [nInterpolations]
static constexpr EffectParameter	FilterLength
static constexpr EffectParameter	CurveName
static constexpr EffectParameter	InterpLin
static constexpr EnumParameter	InterpMeth
static constexpr EffectParameter	DrawMode
static constexpr EffectParameter	DrawGrid
static constexpr EffectParameter	dBMin
static constexpr EffectParameter	dBMax

Detailed Description

Parameters of the Equalization effects that persist in configuration files.

Definition at line 29 of file EqualizationParameters.h.

Member Enumeration Documentation

kInterpolations

enum EqualizationParameters::kInterpolations

Enumerator
kBspline
kCosine
kCubic
nInterpolations

Definition at line 30 of file EqualizationParameters.h.

                        {
      kBspline,
      kCosine,
      kCubic,
      nInterpolations
   };

Constructor & Destructor Documentation

EqualizationParameters()

EqualizationParameters::EqualizationParameters ( const EffectSettingsManager &  manager )

explicit

Definition at line 26 of file EqualizationParameters.cpp.

   : mCurveName{ CurveName.def }
   , mM{ FilterLength.def }
   , mInterp{ InterpMeth.def }
   , mLin{ InterpLin.def }
{
   GetConfig(manager, PluginSettings::Private,
      CurrentSettingsGroup(), wxT("dBMin"), mdBMin, dBMin.def);
   GetConfig(manager, PluginSettings::Private,
      CurrentSettingsGroup(), wxT("dBMax"), mdBMax, dBMax.def);
   GetConfig(manager, PluginSettings::Private,
      CurrentSettingsGroup(), wxT("DrawMode"), mDrawMode, DrawMode.def);
   GetConfig(manager, PluginSettings::Private,
      CurrentSettingsGroup(), wxT("DrawGrid"), mDrawGrid, DrawGrid.def);
}

References CurrentSettingsGroup(), dBMax, dBMin, EffectParameter< Structure, Member, Type, Value >::def, DrawGrid, DrawMode, PluginSettings::GetConfig(), manager, mdBMax, mdBMin, mDrawGrid, mDrawMode, PluginSettings::Private, and wxT().

Here is the call graph for this function:

Member Function Documentation

IsLinear()

bool EqualizationParameters::IsLinear

(

)

const

Definition at line 70 of file EqualizationParameters.cpp.

{
   // If sliders show (!mDrawMode), always use the log envelope
   return mDrawMode && mLin;
}

References mDrawMode, and mLin.

Referenced by EqualizationFilter::CalcFilter(), EqualizationFilter::ChooseEnvelopeToPaint(), and EqualizationCurvesList::EnvelopeUpdated().

Here is the caller graph for this function:

LoadDefaults()

void EqualizationParameters::LoadDefaults

(

int

options

)

Definition at line 43 of file EqualizationParameters.cpp.

{
   mdBMin = dBMin.def;
   mdBMax = dBMax.def;
   mDrawMode = DrawMode.def;
   mDrawGrid = DrawGrid.def;
 
   if( options == kEqOptionCurve)
      mDrawMode = true;
   if( options == kEqOptionGraphic)
      mDrawMode = false;
}

References dBMax, dBMin, EffectParameter< Structure, Member, Type, Value >::def, DrawGrid, DrawMode, kEqOptionCurve, kEqOptionGraphic, mdBMax, mdBMin, mDrawGrid, and mDrawMode.

Referenced by EffectEqualization::DoLoadFactoryDefaults().

Here is the caller graph for this function:

SaveConfig()

void EqualizationParameters::SaveConfig

(

const EffectSettingsManager &

manager

)

const

Definition at line 56 of file EqualizationParameters.cpp.

{
   // TODO: just visit these effect settings the default way
   SetConfig(manager, PluginSettings::Private,
      CurrentSettingsGroup(), wxT("dBMin"), mdBMin);
   SetConfig(manager, PluginSettings::Private,
      CurrentSettingsGroup(), wxT("dBMax"), mdBMax);
   SetConfig(manager, PluginSettings::Private,
      CurrentSettingsGroup(), wxT("DrawMode"), mDrawMode);
   SetConfig(manager, PluginSettings::Private,
      CurrentSettingsGroup(), wxT("DrawGrid"), mDrawGrid);
}

References CurrentSettingsGroup(), manager, mdBMax, mdBMin, mDrawGrid, mDrawMode, PluginSettings::Private, PluginSettings::SetConfig(), and wxT().

Here is the call graph for this function:

Member Data Documentation

CurveName

constexpr EffectParameter EqualizationParameters::CurveName

staticconstexpr

Initial value:

{ &EqualizationParameters::mCurveName,
   L"CurveName",           L"unnamed", L"", L"", L""}

Definition at line 55 of file EqualizationParameters.h.

dBMax

constexpr EffectParameter EqualizationParameters::dBMax

staticconstexpr

Initial value:

{ &EqualizationParameters::mdBMax,
   L"",                   30.0f,    0.0,     60.0,    0      }

Definition at line 67 of file EqualizationParameters.h.

Referenced by EqualizationParameters(), and LoadDefaults().

dBMin

constexpr EffectParameter EqualizationParameters::dBMin

staticconstexpr

Initial value:

{ &EqualizationParameters::mdBMin,
   L"",                   -30.0f,   -120.0,  -10.0,   0      }

Definition at line 65 of file EqualizationParameters.h.

Referenced by EqualizationParameters(), and LoadDefaults().

DrawGrid

constexpr EffectParameter EqualizationParameters::DrawGrid

staticconstexpr

Initial value:

{ &EqualizationParameters::mDrawGrid,
   L"",                   true,    false,   true,    false  }

Definition at line 63 of file EqualizationParameters.h.

Referenced by EqualizationParameters(), and LoadDefaults().

DrawMode

constexpr EffectParameter EqualizationParameters::DrawMode

staticconstexpr

Initial value:

{ &EqualizationParameters::mDrawMode,
   L"",                   true,    false,   true,    false  }

Definition at line 61 of file EqualizationParameters.h.

Referenced by EqualizationParameters(), and LoadDefaults().

FilterLength

constexpr EffectParameter EqualizationParameters::FilterLength

staticconstexpr

Initial value:

{ &EqualizationParameters::mM,
   L"FilterLength",        8191,    21,      8191,    0      }

Definition at line 53 of file EqualizationParameters.h.

Referenced by EffectEqualization::Parameters().

InterpLin

constexpr EffectParameter EqualizationParameters::InterpLin

staticconstexpr

Initial value:

{ &EqualizationParameters::mLin,
   L"InterpolateLin",      false,   false,   true,    false  }

Definition at line 57 of file EqualizationParameters.h.

Referenced by EffectEqualization::Parameters().

InterpMeth

constexpr EnumParameter EqualizationParameters::InterpMeth

staticconstexpr

Initial value:

{ &EqualizationParameters::mInterp,
   L"InterpolationMethod", 0,       0,       0,       0, kInterpStrings, nInterpolations      }

Definition at line 59 of file EqualizationParameters.h.

Referenced by EffectEqualization::Parameters().

kInterpStrings

const EnumValueSymbol EqualizationParameters::kInterpStrings

static

Initial value:

=
{
   
 
   
   { XO("B-spline") },
   { XO("Cosine") },
   { XO("Cubic") }
}

Definition at line 36 of file EqualizationParameters.h.

Referenced by EqualizationUI::PopulateOrExchange().

mCurveName

wxString EqualizationParameters::mCurveName

Definition at line 43 of file EqualizationParameters.h.

Referenced by EffectEqualization::Init(), EqualizationUI::OnIdle(), EqualizationCurvesList::Select(), EqualizationUI::UpdateCurves(), and EqualizationUI::ValidateUI().

mdBMax

float EqualizationParameters::mdBMax

Definition at line 45 of file EqualizationParameters.h.

Referenced by EqualizationParameters(), LoadDefaults(), EqualizationPanel::OnMouseEvent(), EqualizationPanel::OnPaint(), EqualizationUI::OnSliderDBMAX(), and SaveConfig().

mdBMin

float EqualizationParameters::mdBMin

Definition at line 44 of file EqualizationParameters.h.

Referenced by EqualizationParameters(), LoadDefaults(), EqualizationUI::OnSliderDBMIN(), SaveConfig(), and EqualizationUI::UpdateRuler().

mDrawGrid

bool EqualizationParameters::mDrawGrid

Definition at line 49 of file EqualizationParameters.h.

Referenced by EqualizationParameters(), LoadDefaults(), EqualizationUI::OnGridOnOff(), and SaveConfig().

mDrawMode

bool EqualizationParameters::mDrawMode

Definition at line 48 of file EqualizationParameters.h.

Referenced by EqualizationCurvesList::EnvelopeUpdated(), EqualizationParameters(), EqualizationBandSliders::Flatten(), IsLinear(), LoadDefaults(), EqualizationUI::OnCurve(), EqualizationUI::OnDrawMode(), EqualizationUI::OnGraphicMode(), EqualizationUI::OnInterp(), and SaveConfig().

mInterp

int EqualizationParameters::mInterp

Definition at line 47 of file EqualizationParameters.h.

Referenced by EqualizationBandSliders::GraphicEQ().

mLin

bool EqualizationParameters::mLin

Definition at line 50 of file EqualizationParameters.h.

Referenced by EqualizationFilter::ChooseEnvelope(), EffectEqualization::Init(), IsLinear(), EqualizationUI::OnLinFreq(), EqualizationUI::TransferDataToWindow(), EqualizationUI::UpdateDraw(), and EqualizationUI::UpdateGraphic().

mM

size_t EqualizationParameters::mM

Definition at line 46 of file EqualizationParameters.h.

Referenced by EqualizationFilter::CalcFilter(), EqualizationUI::OnSliderM(), EqualizationUI::PopulateOrExchange(), EffectEqualization::Process(), and EffectEqualization::ProcessOne().

---

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

• EqualizationParameters.h
• EqualizationParameters.cpp