Scrubbing.cpp File Reference

#include "Scrubbing.h"
#include <functional>
#include "AudioIO.h"
#include "CommandManager.h"
#include "../../CommonCommandFlags.h"
#include "Project.h"
#include "ProjectAudioIO.h"
#include "../../ProjectAudioManager.h"
#include "ProjectHistory.h"
#include "../../ProjectWindows.h"
#include "ProjectStatus.h"
#include "../../ScrubState.h"
#include "Track.h"
#include "ViewInfo.h"
#include "WaveTrack.h"
#include "../../prefs/PlaybackPrefs.h"
#include "../../prefs/TracksPrefs.h"
#include <algorithm>
#include <wx/app.h>
#include <wx/menu.h>
#include <wx/timer.h>

Include dependency graph for Scrubbing.cpp:

Go to the source code of this file.

Classes
class	Scrubber::ScrubPoller
struct	anonymous_namespace{Scrubbing.cpp}::MenuItem

Namespaces
namespace	anonymous_namespace{Scrubbing.cpp}

Macros
#define	THUNK(Name)   Scrubber::Thunk<&Scrubber::Name>

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

Enumerations
enum	{ SCRUBBING_PIXEL_TOLERANCE = 10 , ScrubSpeedStepsPerOctave = 4 , kOneSecondCountdown }
enum	{ CMD_ID = 8000 }

Functions
double	anonymous_namespace{Scrubbing.cpp}::FindScrubbingSpeed (const ViewInfo &viewInfo, double maxScrubSpeed, double screen, double timeAtMouse)
double	anonymous_namespace{Scrubbing.cpp}::FindSeekSpeed (const ViewInfo &viewInfo, double maxScrubSpeed, double screen, double timeAtMouse)
static const ReservedCommandFlag &	HasWaveDataFlag ()
const MenuItems &	anonymous_namespace{Scrubbing.cpp}::menuItems ()
const MenuItem &	anonymous_namespace{Scrubbing.cpp}::FindMenuItem (bool seek)
static AudioIOStartStreamOptions::PolicyFactory	ScrubbingPlaybackPolicyFactory (const ScrubbingOptions &options)
bool	anonymous_namespace{Scrubbing.cpp}::ReadScrubEnabledPref ()
void	anonymous_namespace{Scrubbing.cpp}::WriteScrubEnabledPref (bool value)
auto	anonymous_namespace{Scrubbing.cpp}::ToolbarMenu ()
auto	anonymous_namespace{Scrubbing.cpp}::KeyboardScrubbingItems ()

Variables
static constexpr PlaybackPolicy::Duration	MinStutter {0.2}
static const AudacityProject::AttachedObjects::RegisteredFactory	key
static const auto	HasWaveDataPred
static const wxChar *	anonymous_namespace{Scrubbing.cpp}::scrubEnabledPrefName = wxT("/QuickPlay/ScrubbingEnabled")
static auto	sPlayAtSpeedStatus = XO("Playing at Speed")
static auto	sKeyboardScrubbingStatus = XO("Scrubbing")
static ProjectStatus::RegisteredStatusWidthFunction	registeredStatusWidthFunction
static const auto	anonymous_namespace{Scrubbing.cpp}::finder
AttachedItem	anonymous_namespace{Scrubbing.cpp}::sAttachment { Indirect(ToolbarMenu()), wxT("Transport/Basic") }
AttachedItem	anonymous_namespace{Scrubbing.cpp}::sAttachment2

Macro Definition Documentation

THUNK

#define THUNK

(

Name

)

Scrubber::Thunk<&Scrubber::Name>

Definition at line 972 of file Scrubbing.cpp.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
SCRUBBING_PIXEL_TOLERANCE
ScrubSpeedStepsPerOctave
kOneSecondCountdown

Definition at line 45 of file Scrubbing.cpp.

     {
   // PRL:
   // Mouse must move at least this far to distinguish ctrl-drag to scrub
   // from ctrl+click for playback.
   SCRUBBING_PIXEL_TOLERANCE = 10,
 
   ScrubSpeedStepsPerOctave = 4,
 
   kOneSecondCountdown =
      1000 / std::chrono::milliseconds{ScrubPollInterval}.count(),
};

anonymous enum

anonymous enum

Enumerator
CMD_ID

Definition at line 970 of file Scrubbing.cpp.

{ CMD_ID = 8000 };

Function Documentation

HasWaveDataFlag()

static const ReservedCommandFlag & HasWaveDataFlag ( )

static

Definition at line 242 of file Scrubbing.cpp.

                   { static ReservedCommandFlag flag{
   HasWaveDataPred
}; return flag; } // jkc

References flag, and HasWaveDataPred.

Referenced by anonymous_namespace{Scrubbing.cpp}::menuItems().

Here is the caller graph for this function:

ScrubbingPlaybackPolicyFactory()

static AudioIOStartStreamOptions::PolicyFactory ScrubbingPlaybackPolicyFactory ( const ScrubbingOptions &  options )

static

Definition at line 339 of file Scrubbing.cpp.

{
   return [options](auto&) -> std::unique_ptr<PlaybackPolicy>
   {
      return std::make_unique<ScrubbingPlaybackPolicy>(options);
   };
}

Referenced by Scrubber::MaybeStartScrubbing(), and Scrubber::StartKeyboardScrubbing().

Here is the caller graph for this function:

Variable Documentation

HasWaveDataPred

const auto HasWaveDataPred

static

Initial value:

=
   [](const AudacityProject &project){
      auto range = TrackList::Get(project).Any<const WaveTrack>()
         + [](const WaveTrack *pTrack){
            return pTrack->GetEndTime() > pTrack->GetStartTime();
         };
      return !range.empty();
   }

Definition at line 232 of file Scrubbing.cpp.

Referenced by Scrubber::CanScrub(), and HasWaveDataFlag().

key

const AudacityProject::AttachedObjects::RegisteredFactory key

static

Initial value:

{
  []( AudacityProject &parent ){
     return std::make_shared< Scrubber >( &parent ); }
}

Definition at line 181 of file Scrubbing.cpp.

Referenced by Scrubber::Get().

MinStutter

constexpr PlaybackPolicy::Duration MinStutter {0.2}

staticconstexpr

Definition at line 57 of file Scrubbing.cpp.

Referenced by Scrubber::MaybeStartScrubbing().

registeredStatusWidthFunction

ProjectStatus::RegisteredStatusWidthFunction registeredStatusWidthFunction

static

Initial value:

{
   []( const AudacityProject &, StatusBarField field )
      -> ProjectStatus::StatusWidthResult
   {
      if ( field == StateStatusBarField() ) {
         TranslatableStrings strings;
         
         for (const auto &item : menuItems())
            strings.push_back( item.GetStatus() );
         strings.push_back(
            XO("%s Paused.").Format( sPlayAtSpeedStatus )
         );
         
         return { std::move( strings ), 30 };
      }
      return {};
   }
}

Definition at line 1019 of file Scrubbing.cpp.

sKeyboardScrubbingStatus

auto sKeyboardScrubbingStatus = XO("Scrubbing")

static

Definition at line 984 of file Scrubbing.cpp.

Referenced by Scrubber::GetUntranslatedStateString().

sPlayAtSpeedStatus

auto sPlayAtSpeedStatus = XO("Playing at Speed")

static

Definition at line 982 of file Scrubbing.cpp.

Referenced by Scrubber::GetUntranslatedStateString().