/**********************************************************************

Audacity: A Digital Audio Editor

WaveformSettings.h

Paul Licameli

**********************************************************************/

#ifndef __AUDACITY_WAVEFORM_SETTINGS__
#define __AUDACITY_WAVEFORM_SETTINGS__

#include "ClientData.h" // to inherit
#include "Prefs.h"

class wxRect;

class EnumValueSymbols;
class WaveChannel;
class WaveTrack;

class AUDACITY_DLL_API WaveformSettings
   : public PrefsListener
   , public ClientData::Cloneable<>
{
public:

   //! Create waveform settings for the track on demand
   //! Mutative access to attachment even if the track argument is const
   static WaveformSettings &Get(const WaveTrack &track);

   /*!
    @copydoc Get(const WaveTrack &);
    */
   static WaveformSettings &Get(const WaveChannel &channel);

   //! Guarantee independence of settings, then assign
   static void Set(
      WaveChannel &channel, std::unique_ptr<WaveformSettings> pSettings );

   // Singleton for settings that are not per-track
   class AUDACITY_DLL_API Globals
   {
   public:
      static Globals &Get();
      void SavePrefs();

   private:
      Globals();
      void LoadPrefs();
   };

   static WaveformSettings &defaults();

   WaveformSettings();
   WaveformSettings(const WaveformSettings &other);
   WaveformSettings& operator= (const WaveformSettings &other);
   ~WaveformSettings() override;

   PointerType Clone() const override;

   bool IsDefault() const
   {
      return this == &defaults();
   }

   bool Validate(bool quiet);
   void LoadPrefs();
   void SavePrefs();
   void Update();

   void UpdatePrefs() override;

   void ConvertToEnumeratedDBRange();
   void ConvertToActualDBRange();
   void NextLowerDBRange();
   void NextHigherDBRange();

   typedef int ScaleType;
   enum ScaleTypeValues : int {
      stLinearAmp,
      stLogarithmicDb,
      stLinearDb,

      stNumScaleTypes,
   };

   static const EnumValueSymbols &GetScaleNames();

   ScaleType scaleType;
   int dBRange;

   // Convenience
   bool isLinear() const { return scaleType == stLinearAmp || scaleType == stLinearDb; }
};

class AUDACITY_DLL_API WaveformScale
   : public ClientData::Cloneable<>
{
public:
   //! Mutative access to attachment even if the track argument is const
   static WaveformScale &Get(const WaveTrack &track);

   /*!
    @copydoc Get(const WaveTrack &)
    */
   static WaveformScale &Get(const WaveChannel &channel);

   ~WaveformScale() override;
   PointerType Clone() const override;

   int ZeroLevelYCoordinate(wxRect rect) const;

   void GetDisplayBounds(float &min, float &max) const
   { min = mDisplayMin; max = mDisplayMax; }

   void SetDisplayBounds(float min, float max)
   { mDisplayMin = min; mDisplayMax = max; }

   float GetLastScaleType() const { return mLastScaleType; }
   void SetLastScaleType(int type) { mLastScaleType = type; }

   int GetLastDBRange() const { return mLastdBRange; }
   void SetLastDBRange(int range) { mLastdBRange = range; }

private:
   float mDisplayMin = -1.0f, mDisplayMax = 1.0f;
   int mLastScaleType = -1;
   int mLastdBRange = -1;
};

#endif
