SnapUtils.cpp File Reference

#include "SnapUtils.h"
#include <algorithm>
#include <cmath>
#include <unordered_map>

Include dependency graph for SnapUtils.cpp:

Go to the source code of this file.

Classes
class	anonymous_namespace{SnapUtils.cpp}::ConstantMultiplierSnapItem
class	anonymous_namespace{SnapUtils.cpp}::ProjectDependentMultiplierSnapItem

Namespaces
namespace	anonymous_namespace{SnapUtils.cpp}

Functions
SnapMode	ReadSnapMode ()
wxString	DeduceSnapTo ()
Identifier	ReadSnapTo ()
SnapResult	anonymous_namespace{SnapUtils.cpp}::SnapWithMultiplier (double value, double multiplier, bool nearest)
std::unique_ptr< SnapRegistryItem >	TimeInvariantSnapFunction (const Identifier &functionId, const TranslatableString &label, MultiplierFunctor functor)
std::unique_ptr< SnapRegistryItem >	TimeInvariantSnapFunction (const Identifier &functionId, const TranslatableString &label, double multiplier)

Variables
const wxString	anonymous_namespace{SnapUtils.cpp}::SnapModeKey = L"/Snap/Mode"
const wxString	anonymous_namespace{SnapUtils.cpp}::SnapToKey = L"/Snap/To"
const wxString	anonymous_namespace{SnapUtils.cpp}::OldSnapToKey = L"/SnapTo"
const wxString	anonymous_namespace{SnapUtils.cpp}::SelectionFormatKey = L"/SelectionFormat"
const auto	anonymous_namespace{SnapUtils.cpp}::PathStart = L"SnapFunctions"
StringSetting	SnapToSetting { SnapToKey, "bar_1_8" }
EnumSetting< SnapMode >	SnapModeSetting

Function Documentation

DeduceSnapTo()

wxString DeduceSnapTo

(

)

Definition at line 46 of file SnapUtils.cpp.

{
   const auto& defaultSnapTo = SnapToSetting.GetDefault();
 
   if (!gPrefs->HasEntry(SelectionFormatKey))
      return defaultSnapTo;
 
   // It appears that we are migrating from an older version of Audacity
   // where snapping was controlled by the "/SelectionFormat".
   // We are only trying to match the known values from the
   // config to the appropriate snapping function, this matching
   // does not introduce any kind of dependency to the lib-numeric-format.
 
   const auto selectionFormat = gPrefs->Read(SelectionFormatKey);
 
   static const std::unordered_map<wxString, wxString> selectionFormatLookup = {
      { L"seconds", L"seconds" },
      { L"seconds + milliseconds", L"milliseconds" },
      { L"hh:mm:ss", L"seconds" },
      { L"dd:hh:mm:ss", L"seconds" },
      { L"hh:mm:ss + hundredths", L"centiseconds" },
      { L"hh:mm:ss + milliseconds", L"milliseconds" },
      { L"hh:mm:ss + samples", L"samples" },
      { L"samples", L"samples" },
      { L"hh:mm:ss + film frames (24 fps)", L"film_24_fps" },
      { L"film frames (24 fps)", L"film_24_fps" },
      { L"hh:mm:ss + NTSC drop frames", L"ntsc_29.97_fps" },
      // Well, not really. Snapping with the "bent" time sounds funny anyway.
      { L"hh:mm:ss + NTSC non-drop frames", L"ntsc_30_fps" },
      { L"NTSC frames", L"ntsc_29.97_fps" },
      { L"hh:mm:ss + PAL frames (25 fps)", L"film_25_fps" },
      { L"PAL frames (25 fps)", L"film_25_fps" },
      { L"hh:mm:ss + CDDA frames (75 fps)", L"cd_75_fps" },
      { L"CDDA frames (75 fps)", L"cd_75_fps" },
   };
 
   auto it = selectionFormatLookup.find(selectionFormat);
 
   if (it != selectionFormatLookup.end())
      return it->second;
 
   return defaultSnapTo;
}

References Setting< T >::GetDefault(), gPrefs, audacity::BasicSettings::HasEntry(), audacity::BasicSettings::Read(), anonymous_namespace{SnapUtils.cpp}::SelectionFormatKey, and SnapToSetting.

Referenced by ReadSnapTo().

Here is the call graph for this function:

Here is the caller graph for this function:

ReadSnapMode()

SnapMode ReadSnapMode

(

)

Definition at line 38 of file SnapUtils.cpp.

{
   if (gPrefs->HasEntry(SnapModeKey))
      return SnapModeSetting.ReadEnum();
 
   return static_cast<SnapMode>(gPrefs->Read(OldSnapToKey, 0L));
}

References gPrefs, audacity::BasicSettings::HasEntry(), anonymous_namespace{SnapUtils.cpp}::OldSnapToKey, audacity::BasicSettings::Read(), anonymous_namespace{SnapUtils.cpp}::SnapModeKey, and SnapModeSetting.

Here is the call graph for this function:

ReadSnapTo()

Identifier ReadSnapTo

(

)

Definition at line 90 of file SnapUtils.cpp.

{
   if (gPrefs->HasEntry(SnapToKey))
      return SnapToSetting.Read();
 
   // Try to perform the config migration once
   const auto snapTo = DeduceSnapTo();
   SnapToSetting.Write(snapTo);
   gPrefs->Flush();
 
 
   return snapTo;
}

References DeduceSnapTo(), audacity::BasicSettings::Flush(), gPrefs, audacity::BasicSettings::HasEntry(), Setting< T >::Read(), anonymous_namespace{SnapUtils.cpp}::SnapToKey, SnapToSetting, and Setting< T >::Write().

Referenced by anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::GetStringValue(), anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::Init(), and anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::OnPopup().

Here is the call graph for this function:

Here is the caller graph for this function:

TimeInvariantSnapFunction() [1/2]

std::unique_ptr< SnapRegistryItem > TimeInvariantSnapFunction	(	const Identifier &	functionId,
		const TranslatableString &	label,
		double	multiplier
	)

Definition at line 294 of file SnapUtils.cpp.

{
   return std::make_unique<ConstantMultiplierSnapItem>(
      functionId, label, multiplier);
}

References label.

TimeInvariantSnapFunction() [2/2]

std::unique_ptr< SnapRegistryItem > TimeInvariantSnapFunction	(	const Identifier &	functionId,
		const TranslatableString &	label,
		MultiplierFunctor	functor
	)

Definition at line 286 of file SnapUtils.cpp.

{
   return std::make_unique<ProjectDependentMultiplierSnapItem>(
      functionId, label, std::move(functor));
}

References label.

Variable Documentation

SnapModeSetting

EnumSetting<SnapMode> SnapModeSetting

Initial value:

{
   SnapModeKey,
   EnumValueSymbols { L"OFF", L"NEAREST", L"PRIOR" },
   0,
   { SnapMode::SNAP_OFF, SnapMode::SNAP_NEAREST, SnapMode::SNAP_PRIOR }
}

Definition at line 31 of file SnapUtils.cpp.

Referenced by anonymous_namespace{PluginMenus.cpp}::OnResetConfig(), ReadSnapMode(), and ProjectSnap::SetSnapMode().

SnapToSetting

StringSetting SnapToSetting { SnapToKey, "bar_1_8" }

Definition at line 29 of file SnapUtils.cpp.

Referenced by DeduceSnapTo(), anonymous_namespace{PluginMenus.cpp}::OnResetConfig(), ReadSnapTo(), and ProjectSnap::SetSnapTo().