audacia
/
audacia
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
audacia/src/prefs/TracksPrefs.cpp

404 lines
11 KiB
C++
Raw Blame History

/**********************************************************************
Audacity: A Digital Audio Editor
TracksPrefs.cpp
Brian Gunlogson
Joshua Haberman
Dominic Mazzoni
James Crook
*******************************************************************//**
\class TracksPrefs
\brief A PrefsPanel for track display and behavior properties.
*//*******************************************************************/
#include "../Audacity.h"
#include "TracksPrefs.h"
#include "../Experimental.h"
//#include <algorithm>
//#include <wx/defs.h>
#include "../Prefs.h"
#include "../ShuttleGui.h"
int TracksPrefs::iPreferencePinned = -1;
namespace {
const wxChar *PinnedHeadPreferenceKey()
{
return wxT("/AudioIO/PinnedHead");
}
bool PinnedHeadPreferenceDefault()
{
return false;
}
const wxChar *PinnedHeadPositionPreferenceKey()
{
return wxT("/AudioIO/PinnedHeadPosition");
}
double PinnedHeadPositionPreferenceDefault()
{
return 0.5;
}
}
//////////
class TracksViewModeEnumSetting
: public EnumSetting< WaveTrackViewConstants::Display > {
public:
TracksViewModeEnumSetting(
const wxString &key,
EnumValueSymbols symbols,
long defaultSymbol,
std::initializer_list< WaveTrackViewConstants::Display > intValues,
const wxString &oldKey
)
: EnumSetting{
key, std::move( symbols ), defaultSymbol,
std::move( intValues ), oldKey
}
{}
void Migrate( wxString &value ) override
{
// Special logic for this preference which was twice migrated!
// First test for the older but not oldest key:
EnumSetting::Migrate(value);
if (!value.empty())
return;
// PRL: Bugs 1043, 1044
// 2.1.1 writes a NEW key for this preference, which got NEW values,
// to avoid confusing version 2.1.0 if it reads the preference file afterwards.
// Prefer the NEW preference key if it is present
int oldMode;
gPrefs->Read(wxT("/GUI/DefaultViewMode"), // The very old key
&oldMode,
(int)(WaveTrackViewConstants::Waveform));
auto viewMode = WaveTrackViewConstants::ConvertLegacyDisplayValue(oldMode);
// Now future-proof 2.1.1 against a recurrence of this sort of bug!
viewMode = WaveTrackViewConstants::ValidateWaveTrackDisplay(viewMode);
const_cast<TracksViewModeEnumSetting*>(this)->WriteInt( viewMode );
gPrefs->Flush();
value = mSymbols[ FindInt(viewMode) ].Internal();
}
};
static TracksViewModeEnumSetting viewModeSetting{
wxT("/GUI/DefaultViewModeChoice"),
{
{ XO("Waveform") },
{ wxT("WaveformDB"), XO("Waveform (dB)") },
{ XO("Spectrogram") }
},
0, // Waveform
// for migrating old preferences:
{
WaveTrackViewConstants::Waveform,
WaveTrackViewConstants::obsoleteWaveformDBDisplay,
WaveTrackViewConstants::Spectrum
},
wxT("/GUI/DefaultViewModeNew")
};
WaveTrackViewConstants::Display TracksPrefs::ViewModeChoice()
{
return viewModeSetting.ReadEnum();
}
//////////
static EnumSetting< WaveTrackViewConstants::SampleDisplay >
sampleDisplaySetting{
wxT("/GUI/SampleViewChoice"),
{
{ wxT("ConnectDots"), XO("Connect dots") },
{ wxT("StemPlot"), XO("Stem plot") }
},
1, // StemPlot
// for migrating old preferences:
{
WaveTrackViewConstants::LinearInterpolate,
WaveTrackViewConstants::StemPlot
},
wxT("/GUI/SampleView")
};
WaveTrackViewConstants::SampleDisplay TracksPrefs::SampleViewChoice()
{
return sampleDisplaySetting.ReadEnum();
}
//////////
static const std::initializer_list<EnumValueSymbol> choicesZoom{
{ wxT("FitToWidth"), XO("Fit to Width") },
{ wxT("ZoomToSelection"), XO("Zoom to Selection") },
{ wxT("ZoomDefault"), XO("Zoom Default") },
{ XO("Minutes") },
{ XO("Seconds") },
{ wxT("FifthsOfSeconds"), XO("5ths of Seconds") },
{ wxT("TenthsOfSeconds"), XO("10ths of Seconds") },
{ wxT("TwentiethsOfSeconds"), XO("20ths of Seconds") },
{ wxT("FiftiethsOfSeconds"), XO("50ths of Seconds") },
{ wxT("HundredthsOfSeconds"), XO("100ths of Seconds") },
{ wxT("FiveHundredthsOfSeconds"), XO("500ths of Seconds") },
{ XO("MilliSeconds") },
{ XO("Samples") },
{ wxT("FourPixelsPerSample"), XO("4 Pixels per Sample") },
{ wxT("MaxZoom"), XO("Max Zoom") },
};
static auto enumChoicesZoom = {
WaveTrackViewConstants::kZoomToFit,
WaveTrackViewConstants::kZoomToSelection,
WaveTrackViewConstants::kZoomDefault,
WaveTrackViewConstants::kZoomMinutes,
WaveTrackViewConstants::kZoomSeconds,
WaveTrackViewConstants::kZoom5ths,
WaveTrackViewConstants::kZoom10ths,
WaveTrackViewConstants::kZoom20ths,
WaveTrackViewConstants::kZoom50ths,
WaveTrackViewConstants::kZoom100ths,
WaveTrackViewConstants::kZoom500ths,
WaveTrackViewConstants::kZoomMilliSeconds,
WaveTrackViewConstants::kZoomSamples,
WaveTrackViewConstants::kZoom4To1,
WaveTrackViewConstants::kMaxZoom,
};
static EnumSetting< WaveTrackViewConstants::ZoomPresets > zoom1Setting{
wxT("/GUI/ZoomPreset1Choice"),
choicesZoom,
2, // kZoomDefault
// for migrating old preferences:
enumChoicesZoom,
wxT("/GUI/ZoomPreset1")
};
static EnumSetting< WaveTrackViewConstants::ZoomPresets > zoom2Setting{
wxT("/GUI/ZoomPreset2Choice"),
choicesZoom,
13, // kZoom4To1
// for migrating old preferences:
enumChoicesZoom,
wxT("/GUI/ZoomPreset2")
};
WaveTrackViewConstants::ZoomPresets TracksPrefs::Zoom1Choice()
{
return zoom1Setting.ReadEnum();
}
WaveTrackViewConstants::ZoomPresets TracksPrefs::Zoom2Choice()
{
return zoom2Setting.ReadEnum();
}
//////////
TracksPrefs::TracksPrefs(wxWindow * parent, wxWindowID winid)
/* i18n-hint: "Tracks" include audio recordings but also other collections of
* data associated with a time line, such as sequences of labels, and musical
* notes */
: PrefsPanel(parent, winid, XO("Tracks"))
{
Populate();
}
TracksPrefs::~TracksPrefs()
{
}
ComponentInterfaceSymbol TracksPrefs::GetSymbol()
{
return TRACKS_PREFS_PLUGIN_SYMBOL;
}
TranslatableString TracksPrefs::GetDescription()
{
return XO("Preferences for Tracks");
}
wxString TracksPrefs::HelpPageName()
{
return "Tracks_Preferences";
}
void TracksPrefs::Populate()
{
// Keep view choices and codes in proper correspondence --
// we don't display them by increasing integer values.
// How samples are displayed when zoomed in:
//------------------------- Main section --------------------
// Now construct the GUI itself.
// Use 'eIsCreatingFromPrefs' so that the GUI is
// initialised with values from gPrefs.
ShuttleGui S(this, eIsCreatingFromPrefs);
PopulateOrExchange(S);
// ----------------------- End of main section --------------
}
void TracksPrefs::PopulateOrExchange(ShuttleGui & S)
{
S.SetBorder(2);
S.StartScroller();
S.StartStatic(XO("Display"));
{
S.TieCheckBox(XO("Auto-&fit track height"),
{wxT("/GUI/TracksFitVerticallyZoomed"),
false});
S.TieCheckBox(XO("Sho&w track name as overlay"),
{wxT("/GUI/ShowTrackNameInWaveform"),
false});
#ifdef EXPERIMENTAL_HALF_WAVE
S.TieCheckBox(XO("Use &half-wave display when collapsed"),
{wxT("/GUI/CollapseToHalfWave"),
false});
#endif
#ifdef SHOW_PINNED_UNPINNED_IN_PREFS
S.TieCheckBox(XO("&Pinned Recording/Playback head"),
{PinnedHeadPreferenceKey(),
PinnedHeadPreferenceDefault()});
#endif
S.TieCheckBox(XO("A&uto-scroll if head unpinned"),
{wxT("/GUI/AutoScroll"),
true});
S.AddSpace(10);
S.StartMultiColumn(2);
{
#ifdef SHOW_PINNED_POSITION_IN_PREFS
S.TieNumericTextBox(
XO("Pinned &head position"),
PinnedHeadPositionPreferenceKey(),
PinnedHeadPositionPreferenceDefault(),
30
);
#endif
S.TieChoice(XO("Default &view mode:"),
viewModeSetting );
S.TieChoice(XO("Display &samples:"),
sampleDisplaySetting );
S.TieTextBox(XO("Default audio track &name:"),
{wxT("/GUI/TrackNames/DefaultTrackName"),
_("Audio Track")},
30);
}
S.EndMultiColumn();
}
S.EndStatic();
S.StartStatic(XO("Zoom Toggle"));
{
S.StartMultiColumn(4);
{
S.TieChoice(XO("Preset 1:"),
zoom1Setting );
S.TieChoice(XO("Preset 2:"),
zoom2Setting );
}
}
S.EndStatic();
S.EndScroller();
}
bool TracksPrefs::GetPinnedHeadPreference()
{
// JKC: Cache this setting as it is read many times during drawing, and otherwise causes screen flicker.
// Correct solution would be to re-write wxFileConfig to be efficient.
if( iPreferencePinned >= 0 )
return iPreferencePinned == 1;
bool bResult = gPrefs->ReadBool(PinnedHeadPreferenceKey(), PinnedHeadPreferenceDefault());
iPreferencePinned = bResult ? 1: 0;
return bResult;
}
void TracksPrefs::SetPinnedHeadPreference(bool value, bool flush)
{
iPreferencePinned = value ? 1 :0;
gPrefs->Write(PinnedHeadPreferenceKey(), value);
if(flush)
gPrefs->Flush();
}
double TracksPrefs::GetPinnedHeadPositionPreference()
{
auto value = gPrefs->ReadDouble(
PinnedHeadPositionPreferenceKey(),
PinnedHeadPositionPreferenceDefault());
return std::max(0.0, std::min(1.0, value));
}
void TracksPrefs::SetPinnedHeadPositionPreference(double value, bool flush)
{
value = std::max(0.0, std::min(1.0, value));
gPrefs->Write(PinnedHeadPositionPreferenceKey(), value);
if(flush)
gPrefs->Flush();
}
wxString TracksPrefs::GetDefaultAudioTrackNamePreference()
{
const auto name =
gPrefs->Read(wxT("/GUI/TrackNames/DefaultTrackName"), wxT(""));
if (name.empty() || ( name == "Audio Track" ))
// When nothing was specified,
// the default-default is whatever translation of...
/* i18n-hint: The default name for an audio track. */
return _("Audio Track");
else
return name;
}
bool TracksPrefs::Commit()
{
// Bug 1583: Clear the caching of the preference pinned state.
iPreferencePinned = -1;
ShuttleGui S(this, eIsSavingToPrefs);
PopulateOrExchange(S);
// Bug 1661: Don't store the name for new tracks if the name is the
// default in that language.
if (GetDefaultAudioTrackNamePreference() == _("Audio Track")) {
gPrefs->DeleteEntry(wxT("/GUI/TrackNames/DefaultTrackName"));
gPrefs->Flush();
}
return true;
}
PrefsPanel::Factory
TracksPrefsFactory = [](wxWindow *parent, wxWindowID winid, AudacityProject *)
{
wxASSERT(parent); // to justify safenew
return safenew TracksPrefs(parent, winid);
};
Reference in New Issue View Git Blame Copy Permalink