Scrubber Class Reference

#include <Scrubbing.h>

Inheritance diagram for Scrubber:

Collaboration diagram for Scrubber:

Classes
class	ScrubPoller

Public Member Functions
	Scrubber (AudacityProject *project)
	Scrubber (const Scrubber &)=delete
Scrubber &	operator= (const Scrubber &)=delete
	~Scrubber ()
void	MarkScrubStart (wxCoord xx, bool smoothScrolling, bool seek)
bool	MaybeStartScrubbing (wxCoord xx)
bool	StartKeyboardScrubbing (double time0, bool backwards)
double	GetKeyboardScrubbingSpeed ()
void	ContinueScrubbingUI ()
void	ContinueScrubbingPoll ()
void	StopScrubbing ()
wxCoord	GetScrubStartPosition () const
bool	WasSpeedPlaying () const
bool	IsSpeedPlaying () const
bool	WasKeyboardScrubbing () const
bool	IsKeyboardScrubbing () const
void	SetBackwards (bool backwards)
bool	IsBackwards () const
bool	HasMark () const
bool	IsScrubbing () const
bool	IsScrollScrubbing () const
void	SetScrollScrubbing (bool value)
bool	ChoseSeeking () const
void	SetMayDragToSeek (bool value)
bool	MayDragToSeek () const
bool	TemporarilySeeks () const
bool	Seeks () const
bool	Scrubs () const
bool	ShowsBar () const
void	Cancel ()
bool	ShouldDrawScrubSpeed ()
double	FindScrubSpeed (bool seeking, double time) const
double	GetMaxScrubSpeed () const
void	HandleScrollWheel (int steps)
bool	CanScrub () const
void	PopulatePopupMenu (wxMenu &menu)
void	OnScrubOrSeek (bool seek)
void	OnScrub (const CommandContext &)
void	OnSeek (const CommandContext &)
void	OnToggleScrubRuler (const CommandContext &)
void	OnKeyboardScrubBackwards (const CommandContext &)
void	OnKeyboardScrubForwards (const CommandContext &)
void	DoKeyboardScrub (bool backwards, bool keyUp)
template<void(Scrubber::*)(const CommandContext &) pfn>
void	Thunk (wxCommandEvent &)
const TranslatableString &	GetUntranslatedStateString () const
wxString	StatusMessageForWave () const
void	Pause (bool paused)
bool	IsPaused () const
void	CheckMenuItems ()
bool	IsTransportingPinned () const
void	SetSeekPress (bool value)
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static Scrubber &	Get (AudacityProject &project)
static const Scrubber &	Get (const AudacityProject &project)
static bool	ShouldScrubPinned ()

Private Member Functions
void	UpdatePrefs () override
void	StartPolling ()
void	StopPolling ()
void	DoScrub (bool seek)
void	OnActivateOrDeactivateApp (wxActivateEvent &event)
void	ScrubPollerThread ()
void	JoinThread ()
Private Member Functions inherited from PrefsListener
	PrefsListener ()
virtual	~PrefsListener ()
virtual void	UpdatePrefs ()=0
virtual void	UpdateSelectedPrefs (int id)

Private Attributes
int	mScrubToken
int	mScrubSpeedDisplayCountdown
wxCoord	mScrubStartPosition
wxCoord	mLastScrubPosition {}
bool	mScrubSeekPress {}
bool	mSmoothScrollingScrub
bool	mPaused {}
bool	mSeeking {}
bool	mSpeedPlaying {true}
bool	mKeyboardScrubbing {}
bool	mBackwards {}
bool	mDragging {}
bool	mCancelled {}
AudacityProject *	mProject
std::unique_ptr< ScrubPoller >	mPoller
ScrubbingOptions	mOptions
double	mMaxSpeed { 1.0 }
bool	mShowScrubbing { false }
bool	mMayDragToSeek { false }

Additional Inherited Members
Static Private Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...

Detailed Description

Definition at line 39 of file Scrubbing.h.

Constructor & Destructor Documentation

Scrubber() [1/2]

Scrubber::Scrubber ( AudacityProject *  project )

explicit

Definition at line 197 of file Scrubbing.cpp.

   : mScrubToken(-1)
   , mScrubSpeedDisplayCountdown(0)
   , mScrubStartPosition(-1)
   , mSmoothScrollingScrub(false)
   , mPaused(true)
#ifdef EXPERIMENTAL_SCRUBBING_SCROLL_WHEEL
   , mLogMaxScrubSpeed(0)
#endif
 
   , mProject(project)
   , mPoller { std::make_unique<ScrubPoller>(*this) }
   , mOptions {}
 
{
   if (wxTheApp)
      wxTheApp->Bind
      (wxEVT_ACTIVATE_APP,
       &Scrubber::OnActivateOrDeactivateApp, this);
 
   UpdatePrefs();
}

References OnActivateOrDeactivateApp(), and UpdatePrefs().

Here is the call graph for this function:

Scrubber() [2/2]

Scrubber::Scrubber ( const Scrubber &  )

delete

~Scrubber()

Scrubber::~Scrubber

(

)

Definition at line 230 of file Scrubbing.cpp.

{
   JoinThread();
}

References JoinThread().

Here is the call graph for this function:

Member Function Documentation

Cancel()

void Scrubber::Cancel ( )

inline

Definition at line 106 of file Scrubbing.h.

   { mCancelled = true; }

CanScrub()

bool Scrubber::CanScrub

(

)

const

CheckMenuItems()

void Scrubber::CheckMenuItems

(

)

Referenced by MarkScrubStart().

Here is the caller graph for this function:

ChoseSeeking()

bool Scrubber::ChoseSeeking

(

)

const

ContinueScrubbingPoll()

void Scrubber::ContinueScrubbingPoll

(

)

Referenced by Scrubber::ScrubPoller::Notify().

Here is the caller graph for this function:

ContinueScrubbingUI()

void Scrubber::ContinueScrubbingUI

(

)

Referenced by Scrubber::ScrubPoller::Notify().

Here is the caller graph for this function:

DoKeyboardScrub()

void Scrubber::DoKeyboardScrub	(	bool	backwards,
		bool	keyUp
	)

DoScrub()

void Scrubber::DoScrub ( bool  seek )

private

FindScrubSpeed()

double Scrubber::FindScrubSpeed	(	bool	seeking,
		double	time
	)		const

Referenced by ScrubbingOverlay::OnTimer().

Here is the caller graph for this function:

Get() [1/2]

Scrubber & Scrubber::Get ( AudacityProject &  project )

static

Definition at line 187 of file Scrubbing.cpp.

{
   return project.AttachedObjects::Get< Scrubber >( key );
}

References key, and project.

Referenced by AdornedRulerPanel::ScrubbingHandle::Cancel(), AdornedRulerPanel::ScrubbingHandle::Click(), ProjectAudioManager::DoPlayStopSelect(), ScrubbingToolBar::DoRegenerateTooltips(), ScrubbingToolBar::EnableDisableButtons(), Get(), anonymous_namespace{PlayIndicatorOverlay.cpp}::GetIndicatorBitmap(), ScrubbingOverlay::GetScrubber(), anonymous_namespace{AdornedRulerPanel.cpp}::PlayheadHandle::HitTest(), ProjectWindow::MayScrollBeyondZero(), ScrubbingToolBar::OnButton(), ControlToolBar::OnIdle(), AudacityApp::OnKeyDown(), ProjectAudioManager::OnPause(), PlayIndicatorOverlay::OnTimer(), AdornedRulerPanel::ScrubbingHandle::Preview(), ScrubForwarder::ScrubForwarder(), AdornedRulerPanel::ShowingScrubRuler(), AdornedRulerPanel::ShowScrubMenu(), ControlToolBar::StartScrollingIfPreferred(), ControlToolBar::StateForStatusBar(), ProjectAudioManager::Stop(), AdornedRulerPanel::TogglePinnedHead(), AdornedRulerPanel::ScrubbingRulerOverlay::Update(), and AdornedRulerPanel::TrackPanelGuidelineOverlay::Update().

Here is the caller graph for this function:

Get() [2/2]

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

static

Definition at line 192 of file Scrubbing.cpp.

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

References Get(), and project.

Here is the call graph for this function:

GetKeyboardScrubbingSpeed()

double Scrubber::GetKeyboardScrubbingSpeed

(

)

GetMaxScrubSpeed()

double Scrubber::GetMaxScrubSpeed ( ) const

inline

Definition at line 111 of file Scrubbing.h.

{ return mOptions.maxSpeed; }

Referenced by ScrubbingOverlay::OnTimer().

Here is the caller graph for this function:

GetScrubStartPosition()

wxCoord Scrubber::GetScrubStartPosition ( ) const

inline

Definition at line 72 of file Scrubbing.h.

   { return mScrubStartPosition; }

GetUntranslatedStateString()

const TranslatableString & Scrubber::GetUntranslatedStateString

(

)

const

Referenced by ControlToolBar::StateForStatusBar().

Here is the caller graph for this function:

HandleScrollWheel()

void Scrubber::HandleScrollWheel

(

int

steps

)

HasMark()

bool Scrubber::HasMark ( ) const

inline

Definition at line 89 of file Scrubbing.h.

   { return GetScrubStartPosition() >= 0; }

Referenced by ScrubbingOverlay::OnTimer(), and anonymous_namespace{AdornedRulerPanel.cpp}::ScrubbingMessage().

Here is the caller graph for this function:

IsBackwards()

bool Scrubber::IsBackwards ( ) const

inline

Definition at line 85 of file Scrubbing.h.

   { return mBackwards;}

IsKeyboardScrubbing()

bool Scrubber::IsKeyboardScrubbing ( ) const

inline

Definition at line 81 of file Scrubbing.h.

   { return IsScrubbing() && mKeyboardScrubbing; }

Referenced by ScrubbingOverlay::OnTimer().

Here is the caller graph for this function:

IsPaused()

bool Scrubber::IsPaused

(

)

const

IsScrollScrubbing()

bool Scrubber::IsScrollScrubbing ( ) const

inline

Definition at line 93 of file Scrubbing.h.

   { return mSmoothScrollingScrub; }

Referenced by ScrubbingOverlay::Draw(), and ScrubbingOverlay::OnTimer().

Here is the caller graph for this function:

IsScrubbing()

bool Scrubber::IsScrubbing

(

)

const

Referenced by anonymous_namespace{AdornedRulerPanel.cpp}::ContinueScrubbingMessage(), and ScrubbingOverlay::OnTimer().

Here is the caller graph for this function:

IsSpeedPlaying()

bool Scrubber::IsSpeedPlaying ( ) const

inline

Definition at line 77 of file Scrubbing.h.

   { return IsScrubbing() && mSpeedPlaying; }

Referenced by ScrubbingOverlay::OnTimer().

Here is the caller graph for this function:

IsTransportingPinned()

bool Scrubber::IsTransportingPinned

(

)

const

Referenced by anonymous_namespace{PlayIndicatorOverlay.cpp}::GetIndicatorBitmap().

Here is the caller graph for this function:

JoinThread()

void Scrubber::JoinThread ( )

private

Definition at line 220 of file Scrubbing.cpp.

{
#ifdef USE_SCRUB_THREAD
   if (mThread.joinable()) {
      mFinishThread.store(true, std::memory_order_release);
      mThread.join();
   }
#endif
}

Referenced by ~Scrubber().

Here is the caller graph for this function:

MarkScrubStart()

void Scrubber::MarkScrubStart	(	wxCoord	xx,
		bool	smoothScrolling,
		bool	seek
	)

Definition at line 306 of file Scrubbing.cpp.

{
   // Don't actually start scrubbing, but collect some information
   // needed for the decision to start scrubbing later when handling
   // drag events.
   mSmoothScrollingScrub  = smoothScrolling;
 
   auto &projectAudioManager = ProjectAudioManager::Get( *mProject );
 
   // Stop any play in progress
   // Bug 1492: mCancelled to stop us collapsing the selected region.
   mCancelled = true;
   projectAudioManager.Stop();
   mCancelled = false;
 
   // Usually the timer handler of TrackPanel does this, but we do this now,
   // so that same timer does not StopPlaying() again after this function and destroy
   // scrubber state
   ProjectAudioIO::Get( *mProject ).SetAudioIOToken(0);
 
   mSeeking = seek;
   CheckMenuItems();
 
   // Commented out for Bug 1421
   //   mSeeking
   //   ? ControlToolBar::PlayAppearance::Seek
   //   : ControlToolBar::PlayAppearance::Scrub);
 
   mScrubStartPosition = xx;
   mCancelled = false;
}

References CheckMenuItems(), ProjectAudioIO::Get(), ProjectAudioManager::Get(), mCancelled, mProject, mScrubStartPosition, mSeeking, mSmoothScrollingScrub, and ProjectAudioIO::SetAudioIOToken().

Here is the call graph for this function:

MaybeStartScrubbing()

bool Scrubber::MaybeStartScrubbing

(

wxCoord

xx

)

Referenced by ScrubbingOverlay::OnTimer().

Here is the caller graph for this function:

MayDragToSeek()

bool Scrubber::MayDragToSeek ( ) const

inline

Definition at line 100 of file Scrubbing.h.

{ return mMayDragToSeek; }

OnActivateOrDeactivateApp()

void Scrubber::OnActivateOrDeactivateApp ( wxActivateEvent &  event )

private

Referenced by Scrubber().

Here is the caller graph for this function:

OnKeyboardScrubBackwards()

void Scrubber::OnKeyboardScrubBackwards

(

const CommandContext &

)

OnKeyboardScrubForwards()

void Scrubber::OnKeyboardScrubForwards

(

const CommandContext &

)

OnScrub()

void Scrubber::OnScrub

(

const CommandContext &

)

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

Here is the caller graph for this function:

OnScrubOrSeek()

void Scrubber::OnScrubOrSeek

(

bool

seek

)

OnSeek()

void Scrubber::OnSeek

(

const CommandContext &

)

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

Here is the caller graph for this function:

OnToggleScrubRuler()

void Scrubber::OnToggleScrubRuler

(

const CommandContext &

)

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

Here is the caller graph for this function:

operator=()

Scrubber & Scrubber::operator= ( const Scrubber &  )

delete

Pause()

void Scrubber::Pause

(

bool

paused

)

PopulatePopupMenu()

void Scrubber::PopulatePopupMenu

(

wxMenu &

menu

)

ScrubPollerThread()

void Scrubber::ScrubPollerThread ( )

private

Scrubs()

bool Scrubber::Scrubs

(

)

const

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

Here is the caller graph for this function:

Seeks()

bool Scrubber::Seeks

(

)

const

Referenced by anonymous_namespace{AdornedRulerPanel.cpp}::ContinueScrubbingMessage(), anonymous_namespace{Scrubbing.cpp}::menuItems(), and ScrubbingOverlay::OnTimer().

Here is the caller graph for this function:

SetBackwards()

void Scrubber::SetBackwards ( bool  backwards )

inline

Definition at line 83 of file Scrubbing.h.

   { mBackwards = backwards;}

SetMayDragToSeek()

void Scrubber::SetMayDragToSeek ( bool  value )

inline

Definition at line 99 of file Scrubbing.h.

{ mMayDragToSeek = value; }

SetScrollScrubbing()

void Scrubber::SetScrollScrubbing ( bool  value )

inline

Definition at line 95 of file Scrubbing.h.

   { mSmoothScrollingScrub = value; }

SetSeekPress()

void Scrubber::SetSeekPress ( bool  value )

inline

Definition at line 146 of file Scrubbing.h.

{ mScrubSeekPress = value; }

ShouldDrawScrubSpeed()

bool Scrubber::ShouldDrawScrubSpeed

(

)

Referenced by ScrubbingOverlay::DoGetRectangle(), ScrubbingOverlay::Draw(), and ScrubbingOverlay::OnTimer().

Here is the caller graph for this function:

ShouldScrubPinned()

bool Scrubber::ShouldScrubPinned ( )

static

Definition at line 150 of file Scrubbing.cpp.

{
   return TracksPrefs::GetPinnedHeadPreference() &&
      !PlaybackPrefs::GetUnpinnedScrubbingPreference();
}

References TracksPrefs::GetPinnedHeadPreference(), and PlaybackPrefs::GetUnpinnedScrubbingPreference().

Referenced by AdornedRulerPanel::ScrubbingHandle::Click().

Here is the call graph for this function:

Here is the caller graph for this function:

ShowsBar()

bool Scrubber::ShowsBar

(

)

const

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

Here is the caller graph for this function:

StartKeyboardScrubbing()

bool Scrubber::StartKeyboardScrubbing	(	double	time0,
		bool	backwards
	)

StartPolling()

void Scrubber::StartPolling ( )

private

Precondition

!mThread.joinable() (when defined(USE_SCRUB_THREAD))

StatusMessageForWave()

wxString Scrubber::StatusMessageForWave

(

)

const

StopPolling()

void Scrubber::StopPolling ( )

private

StopScrubbing()

void Scrubber::StopScrubbing

(

)

TemporarilySeeks()

bool Scrubber::TemporarilySeeks

(

)

const

Referenced by ScrubbingOverlay::OnTimer().

Here is the caller graph for this function:

Thunk()

template<void(Scrubber::*)(const CommandContext &) pfn>

void Scrubber::Thunk ( wxCommandEvent &  )

inline

Definition at line 132 of file Scrubbing.h.

         { (this->*pfn)(*mProject); }

UpdatePrefs()

void Scrubber::UpdatePrefs ( )

overrideprivatevirtual

Implements PrefsListener.

Referenced by Scrubber().

Here is the caller graph for this function:

WasKeyboardScrubbing()

bool Scrubber::WasKeyboardScrubbing ( ) const

inline

Definition at line 79 of file Scrubbing.h.

   { return mKeyboardScrubbing; }

WasSpeedPlaying()

bool Scrubber::WasSpeedPlaying ( ) const

inline

Definition at line 75 of file Scrubbing.h.

   { return mSpeedPlaying;}

Member Data Documentation

mBackwards

bool Scrubber::mBackwards {}

private

Definition at line 172 of file Scrubbing.h.

mCancelled

bool Scrubber::mCancelled {}

private

Definition at line 175 of file Scrubbing.h.

Referenced by MarkScrubStart().

mDragging

bool Scrubber::mDragging {}

private

Definition at line 173 of file Scrubbing.h.

mKeyboardScrubbing

bool Scrubber::mKeyboardScrubbing {}

private

Definition at line 171 of file Scrubbing.h.

mLastScrubPosition

wxCoord Scrubber::mLastScrubPosition {}

private

Definition at line 164 of file Scrubbing.h.

mMaxSpeed

double Scrubber::mMaxSpeed { 1.0 }

private

Definition at line 198 of file Scrubbing.h.

mMayDragToSeek

bool Scrubber::mMayDragToSeek { false }

private

Definition at line 201 of file Scrubbing.h.

mOptions

ScrubbingOptions Scrubber::mOptions

private

Definition at line 197 of file Scrubbing.h.

mPaused

bool Scrubber::mPaused {}

private

Definition at line 168 of file Scrubbing.h.

mPoller

std::unique_ptr<ScrubPoller> Scrubber::mPoller

private

Definition at line 195 of file Scrubbing.h.

mProject

AudacityProject* Scrubber::mProject

private

Definition at line 181 of file Scrubbing.h.

Referenced by MarkScrubStart().

mScrubSeekPress

bool Scrubber::mScrubSeekPress {}

private

Definition at line 165 of file Scrubbing.h.

mScrubSpeedDisplayCountdown

int Scrubber::mScrubSpeedDisplayCountdown

private

Definition at line 162 of file Scrubbing.h.

mScrubStartPosition

wxCoord Scrubber::mScrubStartPosition

private

Definition at line 163 of file Scrubbing.h.

Referenced by MarkScrubStart().

mScrubToken

int Scrubber::mScrubToken

private

Definition at line 161 of file Scrubbing.h.

mSeeking

bool Scrubber::mSeeking {}

private

Definition at line 169 of file Scrubbing.h.

Referenced by MarkScrubStart().

mShowScrubbing

bool Scrubber::mShowScrubbing { false }

private

Definition at line 200 of file Scrubbing.h.

mSmoothScrollingScrub

bool Scrubber::mSmoothScrollingScrub

private

Definition at line 166 of file Scrubbing.h.

Referenced by MarkScrubStart().

mSpeedPlaying

bool Scrubber::mSpeedPlaying {true}

private

Definition at line 170 of file Scrubbing.h.

---

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

• Scrubbing.h
• Scrubbing.cpp