anonymous_namespace{Scrubbing.cpp} Namespace Reference

Classes
struct	MenuItem

Typedefs
using	MenuItems = std::vector< MenuItem >

Functions
double	FindScrubbingSpeed (const ViewInfo &viewInfo, double maxScrubSpeed, double screen, double timeAtMouse)
double	FindSeekSpeed (const ViewInfo &viewInfo, double maxScrubSpeed, double screen, double timeAtMouse)
const MenuItems &	menuItems ()
const MenuItem &	FindMenuItem (bool seek)
bool	ReadScrubEnabledPref ()
void	WriteScrubEnabledPref (bool value)
auto	ToolbarMenu ()
auto	KeyboardScrubbingItems ()

Variables
static const wxChar *	scrubEnabledPrefName = wxT("/QuickPlay/ScrubbingEnabled")
static const auto	finder
AttachedItem	sAttachment { Indirect(ToolbarMenu()), wxT("Transport/Basic") }
AttachedItem	sAttachment2

Typedef Documentation

MenuItems

using anonymous_namespace{Scrubbing.cpp}::MenuItems = typedef std::vector< MenuItem >

Definition at line 258 of file Scrubbing.cpp.

Function Documentation

FindMenuItem()

const MenuItem & anonymous_namespace{Scrubbing.cpp}::FindMenuItem ( bool  seek )

inline

Definition at line 292 of file Scrubbing.cpp.

   {
      return *std::find_if(menuItems().begin(), menuItems().end(),
         [=](const MenuItem &item) {
            return seek == item.seek;
         }
      );
   }

References details::begin(), details::end(), menuItems(), and anonymous_namespace{Scrubbing.cpp}::MenuItem::seek.

Referenced by Scrubber::GetUntranslatedStateString().

Here is the call graph for this function:

Here is the caller graph for this function:

FindScrubbingSpeed()

double anonymous_namespace{Scrubbing.cpp}::FindScrubbingSpeed	(	const ViewInfo &	viewInfo,
		double	maxScrubSpeed,
		double	screen,
		double	timeAtMouse
	)

Definition at line 61 of file Scrubbing.cpp.

   {
      // Map a time (which was mapped from a mouse position)
      // to a speed.
      // Map times to positive and negative speeds,
      // with the time at the midline of the screen mapping to 0,
      // and the extremes to the maximum scrub speed.
 
      auto partScreen = screen * TracksPrefs::GetPinnedHeadPositionPreference();
      const double origin = viewInfo.hpos + partScreen;
      if (timeAtMouse >= origin)
         partScreen = screen - partScreen;
 
      // There are various snapping zones that are this fraction of screen:
      const double snap = 0.05;
 
      // By shrinking denom a bit, we make margins left and right
      // that snap to maximum and negative maximum speeds.
      const double factor = 1.0 - (snap * 2);
      const double denom = factor * partScreen;
      double fraction = (denom <= 0.0) ? 0.0 :
         std::min(1.0, fabs(timeAtMouse - origin) / denom);
 
      // Snap to 1.0 and -1.0
      const double unity = 1.0 / maxScrubSpeed;
      const double tolerance = snap / factor;
      // Make speeds near 1 available too by remapping fractions outside
      // this snap zone
      if (fraction <= unity - tolerance)
         fraction *= unity / (unity - tolerance);
      else if (fraction < unity + tolerance)
         fraction = unity;
      else
         fraction = unity + (fraction - (unity + tolerance)) *
         (1.0 - unity) / (1.0 - (unity + tolerance));
 
      double result = fraction * maxScrubSpeed;
      if (timeAtMouse < origin)
         result *= -1.0;
      return result;
   }

References TracksPrefs::GetPinnedHeadPositionPreference(), ZoomInfo::hpos, and min().

Referenced by Scrubber::FindScrubSpeed().

Here is the call graph for this function:

Here is the caller graph for this function:

FindSeekSpeed()

double anonymous_namespace{Scrubbing.cpp}::FindSeekSpeed	(	const ViewInfo &	viewInfo,
		double	maxScrubSpeed,
		double	screen,
		double	timeAtMouse
	)

Definition at line 103 of file Scrubbing.cpp.

   {
      // Map a time (which was mapped from a mouse position)
      // to a signed skip speed: a multiplier of the stutter duration,
      // by which to advance the play position.
      // (The stutter will play at unit speed.)
 
      // Times near the midline of the screen map to skip-less play,
      // and the extremes to a value proportional to maximum scrub speed.
 
      // If the maximum scrubbing speed defaults to 1.0 when you begin to scroll-scrub,
      // the extreme skipping for scroll-seek needs to be larger to be useful.
      static const double ARBITRARY_MULTIPLIER = 10.0;
      const double extreme = std::max(1.0, maxScrubSpeed * ARBITRARY_MULTIPLIER);
 
      // Width of visible track area, in time terms:
      auto partScreen = screen * TracksPrefs::GetPinnedHeadPositionPreference();
      const double origin = viewInfo.hpos + partScreen;
      if (timeAtMouse >= origin)
         partScreen = screen - partScreen;
 
      // The snapping zone is this fraction of screen, on each side of the
      // center line:
      const double snap = 0.05;
      const double fraction = (partScreen <= 0.0) ? 0.0 :
         std::max(snap, std::min(1.0, fabs(timeAtMouse - origin) / partScreen));
 
      double result = 1.0 + ((fraction - snap) / (1.0 - snap)) * (extreme - 1.0);
      if (timeAtMouse < origin)
         result *= -1.0;
      return result;
   }

References TracksPrefs::GetPinnedHeadPositionPreference(), ZoomInfo::hpos, and min().

Referenced by Scrubber::FindScrubSpeed().

Here is the call graph for this function:

Here is the caller graph for this function:

KeyboardScrubbingItems()

auto anonymous_namespace{Scrubbing.cpp}::KeyboardScrubbingItems

(

)

Definition at line 1151 of file Scrubbing.cpp.

{
   static auto items = std::shared_ptr{
   ( FinderScope{ finder },
   Items( wxT("KeyboardScrubbing"),
      Command(wxT("KeyboardScrubBackwards"), XXO("Scrub Bac&kwards"),
         &Scrubber::OnKeyboardScrubBackwards,
         CaptureNotBusyFlag() | CanStopAudioStreamFlag(),
         Options{ wxT("U") }.WantKeyUp() ),
      Command(wxT("KeyboardScrubForwards"), XXO("Scrub For&wards"),
         &Scrubber::OnKeyboardScrubForwards,
         CaptureNotBusyFlag() | CanStopAudioStreamFlag(),
         Options{ wxT("I") }.WantKeyUp() )
   ) ) };
   return items;
}

References CanStopAudioStreamFlag(), CaptureNotBusyFlag(), MenuRegistry::Command, finder, MenuRegistry::Items, Scrubber::OnKeyboardScrubBackwards(), Scrubber::OnKeyboardScrubForwards(), wxT(), and XXO().

Here is the call graph for this function:

menuItems()

const MenuItems & anonymous_namespace{Scrubbing.cpp}::menuItems

(

)

Definition at line 259 of file Scrubbing.cpp.

   {
      static MenuItems theItems{
      /* i18n-hint: These commands assist the user in finding a sound by ear. ...
         "Scrubbing" is variable-speed playback, ...
         "Seeking" is normal speed playback but with skips, ...
       */
      { wxT("Scrub"),       XXO("&Scrub"),           XO("Scrubbing"),
         CaptureNotBusyFlag() | HasWaveDataFlag(),
         &Scrubber::OnScrub,       false,      &Scrubber::Scrubs,
      },
 
      /* i18n-hint: These commands assist the user in finding a sound by ear. ...
         "Scrubbing" is variable-speed playback, ...
         "Seeking" is normal speed playback but with skips, ...
       */
      { wxT("Seek"),        XXO("See&k"),            XO("Seeking"),
         CaptureNotBusyFlag() | HasWaveDataFlag(),
         &Scrubber::OnSeek,        true,       &Scrubber::Seeks,
      },
 
      /* i18n-hint: These commands assist the user in finding a sound by ear. ...
         "Scrubbing" is variable-speed playback, ...
         "Seeking" is normal speed playback but with skips, ...
       */
      { wxT("ToggleScrubRuler"),            XXO("Scrub &Ruler"),   {},
         AlwaysEnabledFlag,
         &Scrubber::OnToggleScrubRuler, false,    &Scrubber::ShowsBar,
      },
      };
      return theItems;
   };

References AlwaysEnabledFlag, CaptureNotBusyFlag(), HasWaveDataFlag(), Scrubber::OnScrub(), Scrubber::OnSeek(), Scrubber::OnToggleScrubRuler(), Scrubber::Scrubs(), Scrubber::Seeks(), Scrubber::ShowsBar(), wxT(), XO(), and XXO().

Referenced by Scrubber::CheckMenuItems(), FindMenuItem(), MenuHelper::PopulateEffectsMenu(), Scrubber::PopulatePopupMenu(), and ToolbarMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

ReadScrubEnabledPref()

bool anonymous_namespace{Scrubbing.cpp}::ReadScrubEnabledPref

(

)

Definition at line 942 of file Scrubbing.cpp.

   {
      bool result {};
      gPrefs->Read(scrubEnabledPrefName, &result, false);
 
      return result;
   }

References gPrefs, audacity::BasicSettings::Read(), and scrubEnabledPrefName.

Referenced by Scrubber::UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

ToolbarMenu()

auto anonymous_namespace{Scrubbing.cpp}::ToolbarMenu

(

)

Definition at line 1127 of file Scrubbing.cpp.

{
   static auto menu = []{
      FinderScope scope{ finder };
      auto menu = std::shared_ptr{ Menu("Scrubbing", XXO("Scru&bbing")) };
      for (const auto &item : menuItems()) {
         menu->push_back(Command(item.name, item.label,
            item.memFn,
            item.flags,
            item.StatusTest
               ? // a checkmark item
                  Options{}.CheckTest([&item](AudacityProject &project){
                  return (Scrubber::Get(project).*(item.StatusTest))(); } )
               : // not a checkmark item
                  Options{}
         ));
      }
      return menu;
   }();
   return menu;
}

References MenuRegistry::Options::CheckTest(), MenuRegistry::Command, finder, MenuRegistry::Menu, menuItems(), project, anonymous_namespace{wxCommandTargets.cpp}::scope, and XXO().

Here is the call graph for this function:

WriteScrubEnabledPref()

void anonymous_namespace{Scrubbing.cpp}::WriteScrubEnabledPref

(

bool

value

)

Definition at line 950 of file Scrubbing.cpp.

   {
      gPrefs->Write(scrubEnabledPrefName, value);
   }

References gPrefs, scrubEnabledPrefName, and audacity::BasicSettings::Write().

Referenced by Scrubber::OnToggleScrubRuler().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

finder

const auto anonymous_namespace{Scrubbing.cpp}::finder

static

Initial value:

=
   [](AudacityProject &project) -> CommandHandlerObject&
     { return Scrubber::Get( project ); }

Definition at line 1122 of file Scrubbing.cpp.

Referenced by CommandManager::Populator::AddGlobalCommand(), CommandManager::Populator::AddItem(), CommandManager::Populator::AddItemList(), MenuRegistry::CommandGroupItem::CommandGroupItem(), Effect::Delegate(), EffectUI::DoEffect(), EffectBase::DoEffect(), CommandManager::DoRepeatProcess(), CommandManager::ExecuteCommand(), MenuRegistry::FinderScope::FinderScope(), KeyboardScrubbingItems(), CommandManager::Populator::NewIdentifier(), ToolbarMenu(), and TrackPanel::TrackPanel().

sAttachment

AttachedItem anonymous_namespace{Scrubbing.cpp}::sAttachment { Indirect(ToolbarMenu()), wxT("Transport/Basic") }

Definition at line 1149 of file Scrubbing.cpp.

sAttachment2

AttachedItem anonymous_namespace{Scrubbing.cpp}::sAttachment2

Initial value:

{ Indirect(KeyboardScrubbingItems()),
   wxT("Optional/Extra/Part1/Transport")
}

Definition at line 1168 of file Scrubbing.cpp.

scrubEnabledPrefName

const wxChar* anonymous_namespace{Scrubbing.cpp}::scrubEnabledPrefName = wxT("/QuickPlay/ScrubbingEnabled")

static

Definition at line 940 of file Scrubbing.cpp.

Referenced by ReadScrubEnabledPref(), and WriteScrubEnabledPref().