WaveformSettings Class Reference

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

#include <WaveformSettings.h>

Inheritance diagram for WaveformSettings:

Collaboration diagram for WaveformSettings:

Classes
class	Globals

Public Types
enum	ScaleTypeValues : int { stLinearAmp , stLogarithmicDb , stLinearDb , stNumScaleTypes }
typedef int	ScaleType
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
	WaveformSettings ()
	WaveformSettings (const WaveformSettings &other)
WaveformSettings &	operator= (const WaveformSettings &other)
	~WaveformSettings () override
PointerType	Clone () const override
bool	IsDefault () const
bool	Validate (bool quiet)
void	LoadPrefs ()
void	SavePrefs ()
void	Update ()
void	UpdatePrefs () override
void	ConvertToEnumeratedDBRange ()
void	ConvertToActualDBRange ()
void	NextLowerDBRange ()
void	NextHigherDBRange ()
bool	isLinear () 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 WaveformSettings &	Get (const WaveTrack &track)
static WaveformSettings &	Get (const WaveChannel &channel)
static void	Set (WaveChannel &channel, std::unique_ptr< WaveformSettings > pSettings)
	Guarantee independence of settings, then assign. More...
static WaveformSettings &	defaults ()
static const EnumValueSymbols &	GetScaleNames ()
static void	GetRangeChoices (TranslatableStrings *pChoices, wxArrayStringEx *pCodes, int *pDefaultRangeIndex=nullptr)
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
ScaleType	scaleType
int	dBRange

Static Public Attributes
static const wxString	waveformScaleKey
static const wxString	dbLogValueString = wxT("dB")
static const wxString	dbLinValueString = wxT("dBLin")
static EnumSetting< ScaleTypeValues >	waveformScaleSetting

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

Detailed Description

Waveform settings, either for one track or as defaults.

Definition at line 22 of file WaveformSettings.h.

Member Typedef Documentation

ScaleType

typedef int WaveformSettings::ScaleType

Definition at line 78 of file WaveformSettings.h.

Member Enumeration Documentation

ScaleTypeValues

enum WaveformSettings::ScaleTypeValues : int

Enumerator
stLinearAmp
stLogarithmicDb
stLinearDb
stNumScaleTypes

Definition at line 79 of file WaveformSettings.h.

                        : int {
      stLinearAmp,
      stLogarithmicDb,
      stLinearDb,
 
      stNumScaleTypes,
   };

Constructor & Destructor Documentation

WaveformSettings() [1/2]

WaveformSettings::WaveformSettings

(

)

Definition at line 89 of file WaveformSettings.cpp.

{
   LoadPrefs();
}

References LoadPrefs().

Here is the call graph for this function:

WaveformSettings() [2/2]

WaveformSettings::WaveformSettings

(

const WaveformSettings &

other

)

Definition at line 94 of file WaveformSettings.cpp.

   : scaleType(other.scaleType)
   , dBRange(other.dBRange)
{
}

~WaveformSettings()

WaveformSettings::~WaveformSettings ( )

override

Definition at line 242 of file WaveformSettings.cpp.

{
}

Member Function Documentation

Clone()

auto WaveformSettings::Clone ( ) const

overridevirtual

Implements ClientData::Cloneable< Covariant, Owner >.

Definition at line 246 of file WaveformSettings.cpp.

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

ConvertToActualDBRange()

void WaveformSettings::ConvertToActualDBRange

(

)

Definition at line 177 of file WaveformSettings.cpp.

{
   wxArrayStringEx codes;
   WaveformSettings::GetRangeChoices(nullptr, &codes);
   long value = 0;
   codes[std::max(0, std::min((int)(codes.size()) - 1, dBRange))]
      .ToLong(&value);
   dBRange = (int)(value);
}

References dBRange, GetRangeChoices(), and min().

Referenced by WaveformPrefs::Commit(), NextHigherDBRange(), NextLowerDBRange(), WaveformPrefs::Validate(), and Validate().

Here is the call graph for this function:

Here is the caller graph for this function:

ConvertToEnumeratedDBRange()

void WaveformSettings::ConvertToEnumeratedDBRange

(

)

Definition at line 162 of file WaveformSettings.cpp.

{
   // Assumes the codes are in ascending sequence.
   wxArrayStringEx codes;
   WaveformSettings::GetRangeChoices(nullptr, &codes);
   int ii = 0;
   for (int nn = codes.size(); ii < nn; ++ii) {
      long value = 0;
      codes[ii].ToLong(&value);
      if (dBRange < value)
         break;
   }
   dBRange = std::max(0, ii - 1);
}

References dBRange, and GetRangeChoices().

Referenced by WaveformPrefs::Commit(), NextHigherDBRange(), NextLowerDBRange(), WaveformPrefs::OnDefaults(), WaveformPrefs::Validate(), Validate(), and WaveformPrefs::WaveformPrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

defaults()

WaveformSettings & WaveformSettings::defaults ( )

static

Definition at line 109 of file WaveformSettings.cpp.

{
   static WaveformSettings instance;
   return instance;
}

Referenced by WaveformPrefs::Commit(), WaveformPrefs::OnDefaults(), UpdatePrefs(), and WaveformPrefs::WaveformPrefs().

Here is the caller graph for this function:

Get() [1/2]

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

static

Create waveform settings for the track on demand Mutative access to attachment even if the track argument is const

Definition at line 78 of file WaveformSettings.cpp.

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

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

Here is the call graph for this function:

Get() [2/2]

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

static

Create waveform settings for the track on demand Mutative access to attachment even if the track argument is const

Definition at line 72 of file WaveformSettings.cpp.

{
   auto &mutTrack = const_cast<WaveTrack&>(track);
   return mutTrack.Attachments::Get<WaveformSettings>(key1);
}

References key1.

Referenced by SetTrackVisualsCommand::ApplyInner(), EnvelopeHandle::Click(), WaveformPrefs::Commit(), WaveformView::DoDraw(), WaveformVRulerControls::DoHandleWheelRotation(), WaveformVRulerControls::DoUpdateVRuler(), WaveformVZoomHandle::DoZoom(), anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), SampleHandle::FindSampleEditingLevel(), for(), Get(), SampleHandle::HitTest(), WaveformVRulerMenuTable::OnWaveformScaleType(), anonymous_namespace{WaveformVRulerControls.cpp}::SetLastdBRange(), anonymous_namespace{WaveformVRulerControls.cpp}::SetLastScaleType(), EnvelopeHandle::WaveChannelHitTest(), and WaveformPrefs::WaveformPrefs().

Here is the caller graph for this function:

GetRangeChoices()

void WaveformSettings::GetRangeChoices ( TranslatableStrings *  pChoices, wxArrayStringEx *  pCodes, int *  pDefaultRangeIndex = nullptr  )

static

Definition at line 213 of file WaveformSettings.cpp.

{
   static const wxArrayStringEx sCodes = {
      wxT("36"), wxT("48"), wxT("60"),  wxT("72"),
      wxT("84"), wxT("96"), wxT("120"), wxT("145"),
   };
   if (pCodes)
      *pCodes = sCodes;
 
   static const std::initializer_list<TranslatableString> sChoices = {
      XO("-36 dB (shallow range for high-amplitude editing)"),
      XO("-48 dB (PCM range of 8 bit samples)"),
      XO("-60 dB (PCM range of 10 bit samples)"),
      XO("-72 dB (PCM range of 12 bit samples)"),
      XO("-84 dB (PCM range of 14 bit samples)"),
      XO("-96 dB (PCM range of 16 bit samples)"),
      XO("-120 dB (approximate limit of human hearing)"),
      XO("-145 dB (PCM range of 24 bit samples)"),
   };
 
   if (pChoices)
      *pChoices = sChoices;
 
   if (pDefaultRangeIndex)
      *pDefaultRangeIndex = 2; // 60 == ENV_DB_RANGE
}

References wxT(), and XO().

Referenced by ConvertToActualDBRange(), ConvertToEnumeratedDBRange(), GUIPrefs::Populate(), and WaveformPrefs::Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

GetScaleNames()

const EnumValueSymbols & WaveformSettings::GetScaleNames ( )

static

Definition at line 202 of file WaveformSettings.cpp.

{
   static const EnumValueSymbols result{
      // Keep in correspondence with ScaleTypeValues:
      { wxT("Linear"), XO("Linear (amp)") },
      { wxT("dB"), XO("Logarithmic (dB)") },
      { wxT("LinearDB"), XO("Linear (dB)") },
   };
   return result;
}

References wxT(), and XO().

Referenced by WaveformPrefs::PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

IsDefault()

bool WaveformSettings::IsDefault ( ) const

inline

Definition at line 61 of file WaveformSettings.h.

   {
      return this == &defaults();
   }

isLinear()

bool WaveformSettings::isLinear ( ) const

inline

Definition at line 101 of file WaveformSettings.h.

{ return scaleType == stLinearAmp || scaleType == stLinearDb; }

Referenced by EnvelopeHandle::Click(), WaveformView::DoDraw(), and EnvelopeHandle::WaveChannelHitTest().

Here is the caller graph for this function:

LoadPrefs()

void WaveformSettings::LoadPrefs

(

)

Definition at line 127 of file WaveformSettings.cpp.

{
   scaleType = waveformScaleSetting.ReadEnum();
 
   dBRange = DecibelScaleCutoff.Read();
 
   // Enforce legal values
   Validate(true);
 
   Update();
}

References dBRange, DecibelScaleCutoff, Setting< T >::Read(), EnumSetting< Enum >::ReadEnum(), scaleType, Update(), Validate(), and waveformScaleSetting.

Referenced by WaveformPrefs::Commit(), and WaveformSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

NextHigherDBRange()

void WaveformSettings::NextHigherDBRange

(

)

Definition at line 194 of file WaveformSettings.cpp.

{
   ConvertToEnumeratedDBRange();
   --dBRange;
   ConvertToActualDBRange();
}

References ConvertToActualDBRange(), ConvertToEnumeratedDBRange(), and dBRange.

Here is the call graph for this function:

NextLowerDBRange()

void WaveformSettings::NextLowerDBRange

(

)

Definition at line 187 of file WaveformSettings.cpp.

{
   ConvertToEnumeratedDBRange();
   ++dBRange;
   ConvertToActualDBRange();
}

References ConvertToActualDBRange(), ConvertToEnumeratedDBRange(), and dBRange.

Here is the call graph for this function:

operator=()

WaveformSettings & WaveformSettings::operator=

(

const WaveformSettings &

other

)

Definition at line 100 of file WaveformSettings.cpp.

{
   if (this != &other) {
      scaleType = other.scaleType;
      dBRange = other.dBRange;
   }
   return *this;
}

References dBRange, and scaleType.

SavePrefs()

void WaveformSettings::SavePrefs

(

)

Definition at line 139 of file WaveformSettings.cpp.

{
}

Referenced by WaveformPrefs::Commit().

Here is the caller graph for this function:

Set()

void WaveformSettings::Set ( WaveChannel &  channel, std::unique_ptr< WaveformSettings >  pSettings  )

static

Guarantee independence of settings, then assign.

Definition at line 83 of file WaveformSettings.cpp.

{
   channel.GetTrack().Attachments::Assign(key1, move(pSettings));
}

References WaveChannel::GetTrack(), and key1.

Referenced by WaveformPrefs::Commit().

Here is the call graph for this function:

Here is the caller graph for this function:

Update()

void WaveformSettings::Update

(

)

Definition at line 143 of file WaveformSettings.cpp.

{
}

Referenced by LoadPrefs().

Here is the caller graph for this function:

UpdatePrefs()

void WaveformSettings::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Definition at line 148 of file WaveformSettings.cpp.

{
   if (scaleType == defaults().scaleType) {
      scaleType = waveformScaleSetting.ReadEnum();
   }
 
   if (dBRange == defaults().dBRange){
      dBRange = DecibelScaleCutoff.Read();
   }
 
   // Enforce legal values
   Validate(true);
}

References dBRange, DecibelScaleCutoff, defaults(), Setting< T >::Read(), EnumSetting< Enum >::ReadEnum(), scaleType, Validate(), and waveformScaleSetting.

Here is the call graph for this function:

Validate()

bool WaveformSettings::Validate

(

bool

quiet

)

Definition at line 115 of file WaveformSettings.cpp.

{
   scaleType = ScaleType(
      std::max(0, std::min((int)(stNumScaleTypes) - 1, (int)(scaleType)))
   );
 
   ConvertToEnumeratedDBRange();
   ConvertToActualDBRange();
 
   return true;
}

References ConvertToActualDBRange(), ConvertToEnumeratedDBRange(), min(), scaleType, and stNumScaleTypes.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

dbLinValueString

const wxString WaveformSettings::dbLinValueString = wxT("dBLin")

static

Definition at line 94 of file WaveformSettings.h.

dbLogValueString

const wxString WaveformSettings::dbLogValueString = wxT("dB")

static

Definition at line 93 of file WaveformSettings.h.

Referenced by TracksViewModeEnumSetting::Migrate().

dBRange

int WaveformSettings::dBRange

Definition at line 98 of file WaveformSettings.h.

Referenced by EnvelopeHandle::Click(), ConvertToActualDBRange(), ConvertToEnumeratedDBRange(), LoadPrefs(), NextHigherDBRange(), NextLowerDBRange(), operator=(), WaveformPrefs::PopulateOrExchange(), UpdatePrefs(), and EnvelopeHandle::WaveChannelHitTest().

scaleType

ScaleType WaveformSettings::scaleType

Definition at line 97 of file WaveformSettings.h.

Referenced by SetTrackVisualsCommand::ApplyInner(), for(), LoadPrefs(), WaveformVRulerMenuTable::OnWaveformScaleType(), operator=(), WaveformPrefs::PopulateOrExchange(), UpdatePrefs(), and Validate().

waveformScaleKey

const wxString WaveformSettings::waveformScaleKey

static

Initial value:

=
   wxT("/GUI/DefaultWaveformScaleChoice")

Definition at line 92 of file WaveformSettings.h.

Referenced by TracksViewModeEnumSetting::Migrate().

waveformScaleSetting

EnumSetting< WaveformSettings::ScaleTypeValues > WaveformSettings::waveformScaleSetting

static

Initial value:

{
      waveformScaleKey,
      {
         { wxT("Linear"), XO("Linear (amp)") },
         { dbLogValueString, XO("Logarithmic (dB)") },
         { dbLinValueString, XO("Linear (dB)") },
      },
 
      0, 
 
      {
         WaveformSettings::stLinearAmp,
         WaveformSettings::stLogarithmicDb,
         WaveformSettings::stLinearDb,
      }
   }

Definition at line 95 of file WaveformSettings.h.

Referenced by LoadPrefs(), TracksPrefs::PopulateOrExchange(), and UpdatePrefs().

---

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

• WaveformSettings.h
• WaveformSettings.cpp