ProjectSettings Class Reference

Holds various per-project settings values, including the sample rate, and sends events to the project when certain values change. More...

#include <ProjectSettings.h>

Inheritance diagram for ProjectSettings:

Collaboration diagram for ProjectSettings:

Public Types
enum	EventCode : int { ChangedSyncLock, ChangedProjectRate }

Public Member Functions
	ProjectSettings (AudacityProject &project)
	ProjectSettings (const ProjectSettings &) PROHIBITED
ProjectSettings &	operator= (const ProjectSettings &) PROHIBITED
bool	GetTracksFitVerticallyZoomed () const
void	SetTracksFitVerticallyZoomed (bool flag)
bool	GetShowId3Dialog () const
void	SetShowId3Dialog (bool flag)
bool	IsSyncLocked () const
void	SetSyncLock (bool flag)
void	SetRate (double rate)
double	GetRate () const
void	SetSnapTo (int snap)
int	GetSnapTo () const
void	SetTool (int tool)
int	GetTool () const
double	GetPlaySpeed () const
void	SetPlaySpeed (double value)
void	SetSelectionFormat (const NumericFormatSymbol &format)
const NumericFormatSymbol &	GetSelectionFormat () const
void	SetAudioTimeFormat (const NumericFormatSymbol &format)
const NumericFormatSymbol &	GetAudioTimeFormat () const
void	SetFrequencySelectionFormatName (const NumericFormatSymbol &format)
const NumericFormatSymbol &	GetFrequencySelectionFormatName () const
void	SetBandwidthSelectionFormatName (const NumericFormatSymbol &format)
const NumericFormatSymbol &	GetBandwidthSelectionFormatName () const
bool	IsSoloSimple () const
bool	IsSoloNone () const
bool	EmptyCanBeDirty () const
bool	GetShowSplashScreen () const
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static ProjectSettings &	Get (AudacityProject &project)
static const ProjectSettings &	Get (const AudacityProject &project)

Private Member Functions
void	UpdatePrefs () override
Private Member Functions inherited from PrefsListener
	PrefsListener ()
virtual	~PrefsListener ()
virtual void	UpdateSelectedPrefs (int id)

Private Attributes
AudacityProject &	mProject
NumericFormatSymbol	mSelectionFormat
NumericFormatSymbol	mFrequencySelectionFormatName
NumericFormatSymbol	mBandwidthSelectionFormatName
NumericFormatSymbol	mAudioTimeFormat
wxString	mSoloPref
double	mRate
std::atomic< double >	mPlaySpeed {}
int	mSnapTo
int	mCurrentTool
bool	mTracksFitVerticallyZoomed { false }
bool	mShowId3Dialog { true }
bool	mIsSyncLocked { false }
bool	mEmptyCanBeDirty
bool	mShowSplashScreen

Detailed Description

Holds various per-project settings values, including the sample rate, and sends events to the project when certain values change.

Definition at line 50 of file ProjectSettings.h.

Member Enumeration Documentation

EventCode

enum ProjectSettings::EventCode : int

Enumerator
ChangedSyncLock
ChangedProjectRate

Definition at line 59 of file ProjectSettings.h.

                  : int {
      ChangedSyncLock,
      ChangedProjectRate
   };

Constructor & Destructor Documentation

ProjectSettings() [1/2]

ProjectSettings::ProjectSettings ( AudacityProject &  project )

explicit

Definition at line 50 of file ProjectSettings.cpp.

   : mProject{ project }
   , mSelectionFormat{ NumericTextCtrl::LookupFormat(
      NumericConverter::TIME,
      gPrefs->Read(wxT("/SelectionFormat"), wxT("")))
}
, mAudioTimeFormat{ NumericTextCtrl::LookupFormat(
   NumericConverter::TIME,
   gPrefs->Read(wxT("/AudioTimeFormat"), wxT("hh:mm:ss")))
}
, mFrequencySelectionFormatName{ NumericTextCtrl::LookupFormat(
   NumericConverter::FREQUENCY,
   gPrefs->Read(wxT("/FrequencySelectionFormatName"), wxT("")) )
}
, mBandwidthSelectionFormatName{ NumericTextCtrl::LookupFormat(
   NumericConverter::BANDWIDTH,
   gPrefs->Read(wxT("/BandwidthSelectionFormatName"), wxT("")) )
}
, mSnapTo( gPrefs->Read(wxT("/SnapTo"), SNAP_OFF) )
{
   if (!gPrefs->Read(wxT("/SamplingRate/DefaultProjectSampleRate"), &mRate,
         AudioIOBase::GetOptimalSupportedSampleRate())) {
      // The default given above can vary with host/devices. So unless there is
      // an entry for the default sample rate in audacity.cfg, Audacity can open
      // with a rate which is different from the rate with which it closed.
      // See bug 1879.
      gPrefs->Write(wxT("/SamplingRate/DefaultProjectSampleRate"), mRate);
      gPrefs->Flush();
   }
   gPrefs->Read(wxT("/GUI/SyncLockTracks"), &mIsSyncLocked, false);
 
   bool multiToolActive = false;
   gPrefs->Read(wxT("/GUI/ToolBars/Tools/MultiToolActive"), &multiToolActive);
 
   if (multiToolActive)
      mCurrentTool = ToolCodes::multiTool;
   else
      mCurrentTool = ToolCodes::selectTool;
 
   UpdatePrefs();
}

ProjectSettings() [2/2]

ProjectSettings::ProjectSettings

(

const ProjectSettings &

)

Member Function Documentation

EmptyCanBeDirty()

bool ProjectSettings::EmptyCanBeDirty ( ) const

inline

Definition at line 117 of file ProjectSettings.h.

{ return mEmptyCanBeDirty; }

References mEmptyCanBeDirty.

Get() [1/2]

ProjectSettings & ProjectSettings::Get ( AudacityProject &  project )

static

Definition at line 39 of file ProjectSettings.cpp.

{
   return project.AttachedObjects::Get< ProjectSettings >(
      sProjectSettingsKey );
}

References sProjectSettingsKey.

Referenced by ProjectFileManager::AddImportedTracks(), MacroCommands::ApplyCommandInBatchMode(), ProjectSelectionManager::AS_GetRate(), ProjectSelectionManager::AS_GetSelectionFormat(), ProjectSelectionManager::AS_GetSnapTo(), ProjectSelectionManager::AS_SetRate(), ProjectSelectionManager::AS_SetSelectionFormat(), ProjectSelectionManager::AS_SetSnapTo(), BenchmarkDialog::BenchmarkDialog(), TimeTrack::Clear(), SelectHandle::Click(), TimeShiftHandle::Click(), ContrastDialog::ContrastDialog(), DefaultPlayOptions(), DefaultSpeedPlayOptions(), anonymous_namespace{ClipMenus.cpp}::DoClipLeftOrRight(), LabelTrackView::DoEditLabels(), Exporter::DoEditMetadata(), EffectUI::DoEffect(), SelectUtilities::DoListSelection(), anonymous_namespace{TrackMenus.cpp}::DoMixAndRender(), anonymous_namespace{EditMenus.cpp}::DoPasteNothingSelected(), ProjectAudioManager::DoRecord(), ProjectFileManager::DoSave(), TrackUtilities::DoTrackMute(), TrackUtilities::DoTrackSolo(), TrackPanel::DrawTracks(), anonymous_namespace{LabelMenus.cpp}::EditByLabel(), anonymous_namespace{LabelMenus.cpp}::EditClipboardByLabel(), ExportCL::Export(), ExportFLAC::Export(), ExportMP3::Export(), ExportOGG::Export(), ExportPCM::Export(), ExportMultipleDialog::ExportMultipleByLabel(), ExportMultipleDialog::ExportMultipleByTrack(), Get(), ProjectManager::GetEstimatedRecordingMinsLeftOnDisk(), Effect::GetSelectionFormat(), anonymous_namespace{SelectMenus.cpp}::GridMove(), MixerTrackCluster::HandleResize(), ProjectFileIO::HandleXMLTag(), CommonTrackView::HitTest(), MuteButtonHandle::HitTest(), SoloButtonHandle::HitTest(), AUPImportFileHandle::Import(), ImportRaw(), ExportFFmpeg::InitCodecs(), AudacityApp::InitPart2(), IsNotSyncLockedFlag(), IsSyncLockedFlag(), Track::IsSyncLockSelected(), MenuManager::ModifyToolbarMenus(), anonymous_namespace{SelectMenus.cpp}::MoveWhenAudioInactive(), TrackActions::Handler::MuteTracks(), anonymous_namespace{SelectMenus.cpp}::NearestZeroCrossing(), MixerTrackCluster::OnButton_Mute(), ProjectManager::OnCloseWindow(), TrackActions::Handler::OnNewStereoTrack(), TrackActions::Handler::OnNewWaveTrack(), EditActions::Handler::OnPaste(), TrackActions::Handler::OnResample(), SelectActions::Handler::OnSetLeftSelection(), SelectActions::Handler::OnSetRightSelection(), TimeToolBar::OnSettingsChanged(), TransportActions::Handler::OnTimerRecord(), ToolsToolBar::OnTool(), ViewActions::Handler::OnUndoPushed(), SelectActions::Handler::OnZeroCrossing(), ProjectFileManager::OpenFile(), TimeTrack::Paste(), TimeToolBar::Populate(), SelectHandle::Preview(), NyquistEffect::Process(), Exporter::Process(), EffectTruncSilence::ProcessIndependently(), SnapManager::Reinit(), StretchHandle::Release(), anonymous_namespace{SelectMenus.cpp}::SeekWhenAudioInactive(), Exporter::SetAutoExportOptions(), EffectToneGen::SetAutomationParameters(), ToolsToolBar::SetCurrentTool(), TranscriptionToolBar::SetPlaySpeed(), SnapManager::Snap(), ProjectSelectionManager::SnapSelection(), ProjectSelectionManager::SSBL_GetBandwidthSelectionFormatName(), ProjectSelectionManager::SSBL_GetFrequencySelectionFormatName(), ProjectSelectionManager::SSBL_GetRate(), ProjectSelectionManager::SSBL_SetBandwidthSelectionFormatName(), ProjectSelectionManager::SSBL_SetFrequencySelectionFormatName(), ProjectSelectionManager::TT_GetAudioTimeFormat(), ProjectSelectionManager::TT_SetAudioTimeFormat(), and ProjectFileIO::WriteXML().

Get() [2/2]

const ProjectSettings & ProjectSettings::Get ( const AudacityProject &  project )

static

Definition at line 45 of file ProjectSettings.cpp.

{
   return Get( const_cast< AudacityProject & >( project ) );
}

References Get().

Here is the call graph for this function:

GetAudioTimeFormat()

const NumericFormatSymbol & ProjectSettings::GetAudioTimeFormat

(

)

const

Definition at line 161 of file ProjectSettings.cpp.

{
   return mAudioTimeFormat;
}

References mAudioTimeFormat.

GetBandwidthSelectionFormatName()

const NumericFormatSymbol & ProjectSettings::GetBandwidthSelectionFormatName

(

)

const

Definition at line 135 of file ProjectSettings.cpp.

{
   return mBandwidthSelectionFormatName;
}

References mBandwidthSelectionFormatName.

GetFrequencySelectionFormatName()

const NumericFormatSymbol & ProjectSettings::GetFrequencySelectionFormatName

(

)

const

Definition at line 123 of file ProjectSettings.cpp.

{
   return mFrequencySelectionFormatName;
}

References mFrequencySelectionFormatName.

GetPlaySpeed()

double ProjectSettings::GetPlaySpeed ( ) const

inline

Definition at line 94 of file ProjectSettings.h.

                               {
      return mPlaySpeed.load( std::memory_order_relaxed ); }

References mPlaySpeed.

GetRate()

double ProjectSettings::GetRate

(

)

const

Definition at line 166 of file ProjectSettings.cpp.

{
   return mRate;
}

References mRate.

Referenced by TimeTrack::Clear(), DefaultPlayOptions(), LabelTrackView::DoEditLabels(), anonymous_namespace{EditMenus.cpp}::DoPasteNothingSelected(), ExportCL::Export(), ExportMP3::Export(), ExportOGG::Export(), ExportPCM::Export(), ProjectManager::GetEstimatedRecordingMinsLeftOnDisk(), ImportRaw(), WaveTrackFactory::NewWaveTrack(), TimeTrack::Paste(), NyquistEffect::Process(), and EffectToneGen::SetAutomationParameters().

Here is the caller graph for this function:

GetSelectionFormat()

const NumericFormatSymbol & ProjectSettings::GetSelectionFormat

(

)

const

Definition at line 151 of file ProjectSettings.cpp.

{
   return mSelectionFormat;
}

References mSelectionFormat.

Referenced by Effect::GetSelectionFormat().

Here is the caller graph for this function:

GetShowId3Dialog()

bool ProjectSettings::GetShowId3Dialog ( ) const

inline

Definition at line 72 of file ProjectSettings.h.

{ return mShowId3Dialog; } //lda

References mShowId3Dialog.

Referenced by Exporter::Process(), and Exporter::SetAutoExportOptions().

Here is the caller graph for this function:

GetShowSplashScreen()

bool ProjectSettings::GetShowSplashScreen ( ) const

inline

Definition at line 119 of file ProjectSettings.h.

{ return mShowSplashScreen; }

References mShowSplashScreen.

Referenced by AudacityApp::InitPart2().

Here is the caller graph for this function:

GetSnapTo()

int ProjectSettings::GetSnapTo

(

)

const

Definition at line 185 of file ProjectSettings.cpp.

{
   return mSnapTo;
}

References mSnapTo.

Referenced by SnapManager::Snap().

Here is the caller graph for this function:

GetTool()

int ProjectSettings::GetTool ( ) const

inline

Definition at line 91 of file ProjectSettings.h.

{ return mCurrentTool; }

References mCurrentTool.

Referenced by TimeShiftHandle::Click(), and SelectHandle::Preview().

Here is the caller graph for this function:

GetTracksFitVerticallyZoomed()

bool ProjectSettings::GetTracksFitVerticallyZoomed ( ) const

inline

Definition at line 69 of file ProjectSettings.h.

{ return mTracksFitVerticallyZoomed; } //lda

References mTracksFitVerticallyZoomed.

Referenced by ProjectAudioManager::DoRecord().

Here is the caller graph for this function:

IsSoloNone()

bool ProjectSettings::IsSoloNone ( ) const

inline

Definition at line 115 of file ProjectSettings.h.

{ return mSoloPref == wxT("None"); }

References mSoloPref.

Referenced by MixerTrackCluster::HandleResize(), MuteButtonHandle::HitTest(), and SoloButtonHandle::HitTest().

Here is the caller graph for this function:

IsSoloSimple()

bool ProjectSettings::IsSoloSimple ( ) const

inline

Definition at line 114 of file ProjectSettings.h.

{ return mSoloPref == wxT("Simple"); }

References mSoloPref.

Referenced by MixerTrackCluster::OnButton_Mute().

Here is the caller graph for this function:

IsSyncLocked()

bool ProjectSettings::IsSyncLocked

(

)

const

Definition at line 190 of file ProjectSettings.cpp.

{
#ifdef EXPERIMENTAL_SYNC_LOCK
   return mIsSyncLocked;
#else
   return false;
#endif
}

References mIsSyncLocked.

Referenced by TimeShiftHandle::Click(), anonymous_namespace{LabelMenus.cpp}::EditByLabel(), anonymous_namespace{LabelMenus.cpp}::EditClipboardByLabel(), IsNotSyncLockedFlag(), IsSyncLockedFlag(), and Track::IsSyncLockSelected().

Here is the caller graph for this function:

operator=()

ProjectSettings& ProjectSettings::operator=

(

const ProjectSettings &

)

SetAudioTimeFormat()

void ProjectSettings::SetAudioTimeFormat

(

const NumericFormatSymbol &

format

)

Definition at line 156 of file ProjectSettings.cpp.

{
   mAudioTimeFormat = format;
}

References format, and mAudioTimeFormat.

SetBandwidthSelectionFormatName()

void ProjectSettings::SetBandwidthSelectionFormatName

(

const NumericFormatSymbol &

format

)

Definition at line 140 of file ProjectSettings.cpp.

{
   mBandwidthSelectionFormatName = formatName;
}

References mBandwidthSelectionFormatName.

SetFrequencySelectionFormatName()

void ProjectSettings::SetFrequencySelectionFormatName

(

const NumericFormatSymbol &

format

)

Definition at line 128 of file ProjectSettings.cpp.

{
   mFrequencySelectionFormatName = formatName;
}

References mFrequencySelectionFormatName.

SetPlaySpeed()

void ProjectSettings::SetPlaySpeed ( double  value )

inline

Definition at line 96 of file ProjectSettings.h.

                                     {
      mPlaySpeed.store( value, std::memory_order_relaxed ); }

References mPlaySpeed.

Referenced by TranscriptionToolBar::SetPlaySpeed().

Here is the caller graph for this function:

SetRate()

void ProjectSettings::SetRate

(

double

rate

)

Definition at line 171 of file ProjectSettings.cpp.

{
   auto &project = mProject;
   if (rate != mRate) {
      mRate = rate;
      Notify( project, ChangedProjectRate );
   }
}

References ChangedProjectRate, mProject, mRate, and anonymous_namespace{ProjectSettings.cpp}::Notify().

Here is the call graph for this function:

SetSelectionFormat()

void ProjectSettings::SetSelectionFormat

(

const NumericFormatSymbol &

format

)

Definition at line 146 of file ProjectSettings.cpp.

{
   mSelectionFormat = format;
}

References format, and mSelectionFormat.

SetShowId3Dialog()

void ProjectSettings::SetShowId3Dialog ( bool  flag )

inline

Definition at line 73 of file ProjectSettings.h.

{ mShowId3Dialog = flag; } //lda

References flag, and mShowId3Dialog.

SetSnapTo()

void ProjectSettings::SetSnapTo

(

int

snap

)

Definition at line 180 of file ProjectSettings.cpp.

{
   mSnapTo = snap;
}

References mSnapTo.

SetSyncLock()

void ProjectSettings::SetSyncLock

(

bool

flag

)

Definition at line 199 of file ProjectSettings.cpp.

{
   auto &project = mProject;
   if (flag != mIsSyncLocked) {
      mIsSyncLocked = flag;
      Notify( project, ChangedSyncLock );
   }
}

References ChangedSyncLock, flag, mIsSyncLocked, mProject, and anonymous_namespace{ProjectSettings.cpp}::Notify().

Here is the call graph for this function:

SetTool()

void ProjectSettings::SetTool ( int  tool )

inline

Definition at line 90 of file ProjectSettings.h.

{ mCurrentTool = tool; }

References mCurrentTool.

Referenced by ToolsToolBar::OnTool(), and ToolsToolBar::SetCurrentTool().

Here is the caller graph for this function:

SetTracksFitVerticallyZoomed()

void ProjectSettings::SetTracksFitVerticallyZoomed ( bool  flag )

inline

Definition at line 70 of file ProjectSettings.h.

{ mTracksFitVerticallyZoomed = flag; } //lda

References flag, and mTracksFitVerticallyZoomed.

UpdatePrefs()

void ProjectSettings::UpdatePrefs ( )

overrideprivatevirtual

Implements PrefsListener.

Definition at line 92 of file ProjectSettings.cpp.

{
   gPrefs->Read(wxT("/AudioFiles/ShowId3Dialog"), &mShowId3Dialog, true);
   gPrefs->Read(wxT("/GUI/EmptyCanBeDirty"), &mEmptyCanBeDirty, true);
   gPrefs->Read(wxT("/GUI/ShowSplashScreen"), &mShowSplashScreen, true);
   mSoloPref = TracksBehaviorsSolo.Read();
   // Update the old default to the NEW default.
   if (mSoloPref == wxT("Standard"))
      mSoloPref = wxT("Simple");
   gPrefs->Read(wxT("/GUI/TracksFitVerticallyZoomed"),
      &mTracksFitVerticallyZoomed, false);
   //   gPrefs->Read(wxT("/GUI/UpdateSpectrogram"),
   //     &mViewInfo.bUpdateSpectrogram, true);
 
   // This code to change an empty projects rate is currently disabled, after
   // discussion.  The rule 'Default sample rate' only affects newly created
   // projects was felt to be simpler and better.
#if 0
   // The DefaultProjectSample rate is the rate for new projects.
   // Do not change this project's rate, unless there are no tracks.
   if( TrackList::Get( *this ).size() == 0){
      gPrefs->Read(wxT("/SamplingRate/DefaultProjectSampleRate"), &mRate,
         AudioIOBase::GetOptimalSupportedSampleRate());
      // If necessary, we change this rate in the selection toolbar too.
      auto bar = SelectionBar::Get( *this );
      bar.SetRate( mRate );
   }
#endif
}

References SelectionBar::Get(), TrackList::Get(), AudioIOBase::GetOptimalSupportedSampleRate(), gPrefs, mEmptyCanBeDirty, mRate, mShowId3Dialog, mShowSplashScreen, mSoloPref, mTracksFitVerticallyZoomed, ChoiceSetting::Read(), TrackList::size(), and TracksBehaviorsSolo.

Here is the call graph for this function:

Member Data Documentation

mAudioTimeFormat

NumericFormatSymbol ProjectSettings::mAudioTimeFormat

private

Definition at line 129 of file ProjectSettings.h.

Referenced by GetAudioTimeFormat(), and SetAudioTimeFormat().

mBandwidthSelectionFormatName

NumericFormatSymbol ProjectSettings::mBandwidthSelectionFormatName

private

Definition at line 128 of file ProjectSettings.h.

Referenced by GetBandwidthSelectionFormatName(), and SetBandwidthSelectionFormatName().

mCurrentTool

int ProjectSettings::mCurrentTool

private

Definition at line 141 of file ProjectSettings.h.

Referenced by GetTool(), and SetTool().

mEmptyCanBeDirty

bool ProjectSettings::mEmptyCanBeDirty

private

Definition at line 146 of file ProjectSettings.h.

Referenced by EmptyCanBeDirty(), and UpdatePrefs().

mFrequencySelectionFormatName

NumericFormatSymbol ProjectSettings::mFrequencySelectionFormatName

private

Definition at line 127 of file ProjectSettings.h.

Referenced by GetFrequencySelectionFormatName(), and SetFrequencySelectionFormatName().

mIsSyncLocked

bool ProjectSettings::mIsSyncLocked { false }

private

Definition at line 145 of file ProjectSettings.h.

Referenced by IsSyncLocked(), and SetSyncLock().

mPlaySpeed

std::atomic<double> ProjectSettings::mPlaySpeed {}

private

Definition at line 137 of file ProjectSettings.h.

Referenced by GetPlaySpeed(), and SetPlaySpeed().

mProject

AudacityProject& ProjectSettings::mProject

private

Definition at line 124 of file ProjectSettings.h.

Referenced by SetRate(), and SetSyncLock().

mRate

double ProjectSettings::mRate

private

Definition at line 133 of file ProjectSettings.h.

Referenced by GetRate(), SetRate(), and UpdatePrefs().

mSelectionFormat

NumericFormatSymbol ProjectSettings::mSelectionFormat

private

Definition at line 126 of file ProjectSettings.h.

Referenced by GetSelectionFormat(), and SetSelectionFormat().

mShowId3Dialog

bool ProjectSettings::mShowId3Dialog { true }

private

Definition at line 144 of file ProjectSettings.h.

Referenced by GetShowId3Dialog(), SetShowId3Dialog(), and UpdatePrefs().

mShowSplashScreen

bool ProjectSettings::mShowSplashScreen

private

Definition at line 147 of file ProjectSettings.h.

Referenced by GetShowSplashScreen(), and UpdatePrefs().

mSnapTo

int ProjectSettings::mSnapTo

private

Definition at line 139 of file ProjectSettings.h.

Referenced by GetSnapTo(), and SetSnapTo().

mSoloPref

wxString ProjectSettings::mSoloPref

private

Definition at line 131 of file ProjectSettings.h.

Referenced by IsSoloNone(), IsSoloSimple(), and UpdatePrefs().

mTracksFitVerticallyZoomed

bool ProjectSettings::mTracksFitVerticallyZoomed { false }

private

Definition at line 143 of file ProjectSettings.h.

Referenced by GetTracksFitVerticallyZoomed(), SetTracksFitVerticallyZoomed(), and UpdatePrefs().

---

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

• ProjectSettings.h
• ProjectSettings.cpp