PlayIndicatorOverlay Class Reference

#include <PlayIndicatorOverlay.h>

Inheritance diagram for PlayIndicatorOverlay:

Collaboration diagram for PlayIndicatorOverlay:

Public Member Functions
	PlayIndicatorOverlay (AudacityProject *project)
Public Member Functions inherited from PlayIndicatorOverlayBase
	PlayIndicatorOverlayBase (AudacityProject *project, bool isMaster)
virtual	~PlayIndicatorOverlayBase ()
void	Update (int newIndicatorX)
Public Member Functions inherited from Overlay
	Overlay ()=default
	Overlay (const Overlay &)=delete
Overlay &	operator= (const Overlay &)=delete
virtual	~Overlay ()=0
virtual unsigned	SequenceNumber () const =0
	This number determines an ordering of overlays, so that those with higher numbers overpaint those with lower numbers that intersect. More...
std::pair< wxRect, bool >	GetRectangle (wxSize size)
virtual std::pair< wxRect, bool >	DoGetRectangle (wxSize size)=0
virtual void	Erase (wxDC &dc, wxDC &src)
virtual void	Draw (OverlayPanel &panel, wxDC &dc)=0
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Private Member Functions
void	OnTimer (Observer::Message)

Private Attributes
std::shared_ptr< PlayIndicatorOverlayBase >	mPartner
Observer::Subscription	mSubscription

Additional Inherited Members
Protected Attributes inherited from PlayIndicatorOverlayBase
AudacityProject *const	mProject
const bool	mIsMaster
int	mLastIndicatorX { -1 }
int	mNewIndicatorX { -1 }
bool	mNewIsCapturing { false }
bool	mLastIsCapturing { false }

Detailed Description

Definition at line 49 of file PlayIndicatorOverlay.h.

Constructor & Destructor Documentation

PlayIndicatorOverlay()

PlayIndicatorOverlay::PlayIndicatorOverlay ( AudacityProject *  project )

explicit

Definition at line 143 of file PlayIndicatorOverlay.cpp.

: PlayIndicatorOverlayBase(project, true)
{
   mSubscription = ProjectWindow::Get( *mProject )
      .GetPlaybackScroller().Subscribe( *this, &PlayIndicatorOverlay::OnTimer );
}

References ProjectWindow::Get(), ProjectWindow::GetPlaybackScroller(), PlayIndicatorOverlayBase::mProject, mSubscription, OnTimer(), and Observer::Publisher< Message, NotifyAll >::Subscribe().

Here is the call graph for this function:

Member Function Documentation

OnTimer()

void PlayIndicatorOverlay::OnTimer ( Observer::Message  )

private

Definition at line 150 of file PlayIndicatorOverlay.cpp.

{
   // Ensure that there is an overlay attached to the ruler
   if (!mPartner) {
      auto &ruler = AdornedRulerPanel::Get( *mProject );
      mPartner = std::make_shared<PlayIndicatorOverlayBase>(mProject, false);
      ruler.AddOverlay( mPartner );
   }
 
   const auto &viewInfo = ViewInfo::Get( *mProject );
   auto width = viewInfo.GetTracksUsableWidth();
 
   if (!ProjectAudioIO::Get( *mProject ).IsAudioActive()) {
      mNewIndicatorX = -1;
      mNewIsCapturing = false;
      const auto &scrubber = Scrubber::Get( *mProject );
      if (scrubber.HasMark()) {
         auto position = scrubber.GetScrubStartPosition();
         const auto offset = viewInfo.GetLeftOffset();
         if(position >= viewInfo.GetLeftOffset() &&
            position < offset + width)
            mNewIndicatorX = position;
      }
   }
   else {
      auto &viewport = Viewport::Get(*mProject);
      auto &window = ProjectWindow::Get( *mProject );
      auto &scroller = window.GetPlaybackScroller();
      // Calculate the horizontal position of the indicator
      const double playPos = scroller.GetRecentStreamTime();
 
      using Mode = ProjectWindow::PlaybackScroller::Mode;
      const Mode mode = scroller.GetMode();
      const bool pinned = ( mode == Mode::Pinned || mode == Mode::Right );
 
      // Use a small tolerance to avoid flicker of play head pinned all the way
      // left or right
      const auto tolerance = pinned
         ? 1.5 * std::chrono::duration<double>{kTimerInterval}.count()
         : 0;
      bool onScreen = playPos >= 0.0 &&
         between_incexc(viewInfo.hpos - tolerance,
         playPos,
         viewInfo.GetScreenEndTime() + tolerance);
 
      auto gAudioIO = AudioIO::Get();
      const auto &scrubber = Scrubber::Get( *mProject );
 
      // BG: Scroll screen if option is set
      if( viewInfo.bUpdateTrackIndicator &&
          playPos >= 0 && !onScreen ) {
         // msmeyer: But only if not playing looped or in one-second mode
         // PRL: and not scrolling with play/record head fixed
         auto mode = ProjectAudioManager::Get( *mProject ).GetLastPlayMode();
         if (!pinned &&
             mode != PlayMode::oneSecondPlay &&
             !gAudioIO->IsPaused() &&
             // Bug 2656 allow scrolling when paused in 
             // scrubbing/play-at-speed.
             // ONLY do this additional test if scrubbing/play-at-speed
             // is active.
             (!scrubber.IsScrubbing() || !scrubber.IsPaused())
            )
         {
            auto newPos = playPos;
            if (playPos < viewInfo.hpos) {
               // This is possible when scrubbing backwards.
               // We want to page leftward by (at least) a whole screen, not
               // just a little bit equal to the scrubbing poll interval
               // duration.
               newPos = viewInfo.OffsetTimeByPixels( newPos, -width );
               newPos = std::max(newPos, viewport.ScrollingLowerBoundTime());
            }
            viewport.SetHorizontalThumb(newPos);
            // Might yet be off screen, check it
            onScreen = playPos >= 0.0 &&
            between_incexc(viewInfo.hpos,
                           playPos,
                           viewInfo.GetScreenEndTime());
         }
      }
 
      // Always update scrollbars even if not scrolling the window. This is
      // important when NEW audio is recorded, because this can change the
      // length of the project and therefore the appearance of the scrollbar.
      viewport.UpdateScrollbarsForTracks();
 
      if (onScreen)
         mNewIndicatorX =
            viewInfo.TimeToPosition(playPos, viewInfo.GetLeftOffset());
      else
         mNewIndicatorX = -1;
 
      mNewIsCapturing = gAudioIO->IsCapturing();
   }
 
   if(mPartner)
      mPartner->Update(mNewIndicatorX);
}

References anonymous_namespace{PlayIndicatorOverlay.cpp}::between_incexc(), AudioIO::Get(), ProjectAudioIO::Get(), ViewInfo::Get(), Viewport::Get(), AdornedRulerPanel::Get(), ProjectAudioManager::Get(), ProjectWindow::Get(), Scrubber::Get(), ProjectAudioManager::GetLastPlayMode(), ProjectAudioIO::IsAudioActive(), kTimerInterval, PlayIndicatorOverlayBase::mNewIndicatorX, PlayIndicatorOverlayBase::mNewIsCapturing, mPartner, PlayIndicatorOverlayBase::mProject, oneSecondPlay, and anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler().

Referenced by PlayIndicatorOverlay().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mPartner

std::shared_ptr<PlayIndicatorOverlayBase> PlayIndicatorOverlay::mPartner

private

Definition at line 58 of file PlayIndicatorOverlay.h.

Referenced by OnTimer().

mSubscription

Observer::Subscription PlayIndicatorOverlay::mSubscription

private

Definition at line 59 of file PlayIndicatorOverlay.h.

Referenced by PlayIndicatorOverlay().

---

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

• PlayIndicatorOverlay.h
• PlayIndicatorOverlay.cpp