#include <BrushHandle.h>

Inheritance diagram for BrushHandle:

Collaboration diagram for BrushHandle:

Classes
class	StateSaver

Public Member Functions
	BrushHandle (std::shared_ptr< StateSaver > pStateSaver, const std::shared_ptr< ChannelView > &pChannelView, const TrackList &trackList, const TrackPanelMouseState &st, const ViewInfo &viewInfo, const std::shared_ptr< SpectralData > &pSpectralData, const ProjectSettings &pSettings)

BrushHandle &	operator= (const BrushHandle &)=default

virtual	~BrushHandle ()

std::shared_ptr< const Track >	FindTrack () const override

bool	IsDragging () const override

void	Enter (bool forward, AudacityProject *pProject) override

bool	Escape (AudacityProject *pProject) override

void	HandleHopBinData (int hopNum, int freqBinNum)

Result	Click (const TrackPanelMouseEvent &event, AudacityProject *pProject) override

Result	Drag (const TrackPanelMouseEvent &event, AudacityProject *pProject) override

HitTestPreview	Preview (const TrackPanelMouseState &state, AudacityProject *pProject) override

Result	Release (const TrackPanelMouseEvent &event, AudacityProject pProject, wxWindow pParent) override

Result	Cancel (AudacityProject *) override

Public Member Functions inherited from UIHandle
virtual	~UIHandle ()=0

virtual void	Enter (bool forward, AudacityProject *pProject)

virtual bool	HasRotation () const

virtual bool	Rotate (bool forward)

virtual bool	HasEscape (AudacityProject *pProject) const

virtual bool	Escape (AudacityProject *pProject)

virtual bool	HandlesRightClick ()
	Whether the handle has any special right-button handling. More...

virtual Result	Click (const TrackPanelMouseEvent &event, AudacityProject *pProject)=0

virtual Result	Drag (const TrackPanelMouseEvent &event, AudacityProject *pProject)=0

virtual HitTestPreview	Preview (const TrackPanelMouseState &state, AudacityProject *pProject)=0

virtual Result	Release (const TrackPanelMouseEvent &event, AudacityProject pProject, wxWindow pParent)=0

virtual Result	Cancel (AudacityProject *pProject)=0

virtual bool	StopsOnKeystroke ()

virtual void	OnProjectChange (AudacityProject *pProject)

virtual std::shared_ptr< const Track >	FindTrack () const =0

virtual bool	IsDragging () const

Result	GetChangeHighlight () const

void	SetChangeHighlight (Result val)

Public Member Functions inherited from TrackPanelDrawable
virtual	~TrackPanelDrawable ()=0

virtual void	Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass)

virtual wxRect	DrawingArea (TrackPanelDrawingContext &context, const wxRect &rect, const wxRect &panelRect, unsigned iPass)

Private Member Functions
	BrushHandle (const BrushHandle &)

std::shared_ptr< WaveChannel >	FindChannel ()

void	Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass) override

Private Attributes
std::shared_ptr< StateSaver >	mpStateSaver

std::shared_ptr< SpectralData >	mpSpectralData

std::weak_ptr< ChannelView >	mpView

wxRect	mRect {}

double	mFreqSnappingRatio { 0.01 }

double	mOvertonesThreshold { 0.999 }

bool	mIsSmartSelection

bool	mIsOvertones

long long	mSampleCountUpperBound

long long	mSampleCountLowerBound

wxInt64	mFreqUpperBound

wxInt64	mFreqLowerBound

int	mMostRecentX { -1 }

int	mMostRecentY { -1 }

int	mBrushRadius

bool	mbCtrlDown

std::shared_ptr< SelectionStateChanger >	mSelectionStateChanger

Additional Inherited Members
Public Types inherited from UIHandle
using	Result = unsigned

using	Cell = TrackPanelCell

Static Public Member Functions inherited from UIHandle
static UIHandle::Result	NeedChangeHighlight (const UIHandle &, const UIHandle &)

static std::shared_ptr< const Track >	TrackFromChannel (const std::shared_ptr< const Channel > &pChannel)
	A frequent convenience in the definition of UIHandles. More...

Static Public Member Functions inherited from TrackPanelDrawable
static wxRect	MaximizeWidth (const wxRect &rect, const wxRect &panelRect)

static wxRect	MaximizeHeight (const wxRect &rect, const wxRect &panelRect)

Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Definition at line 30 of file BrushHandle.h.

Constructor & Destructor Documentation

◆ BrushHandle() [1/2]

BrushHandle::BrushHandle ( const BrushHandle & )

private

◆ BrushHandle() [2/2]

BrushHandle::BrushHandle	(	std::shared_ptr< StateSaver >	pStateSaver,
		const std::shared_ptr< ChannelView > &	pChannelView,
		const TrackList &	trackList,
		const TrackPanelMouseState &	st,
		const ViewInfo &	viewInfo,
		const std::shared_ptr< SpectralData > &	pSpectralData,
		const ProjectSettings &	pSettings
	)

explicit

Definition at line 138 of file BrushHandle.cpp.

   : mpStateSaver{ move(pStateSaver) }
   , mpSpectralData(pSpectralData)
   , mpView{ pChannelView }
{
   const wxMouseState &state = st.state;
   auto wc = pChannelView->FindChannel<WaveChannel>();
   double rate = mpSpectralData->GetSR();
 
   mRect = st.rect;
   mBrushRadius = pSettings.GetBrushRadius();
   const auto &settings = SpectrogramSettings::Get(*wc);
   mFreqUpperBound = settings.maxFreq - 1;
   mFreqLowerBound = settings.minFreq + 1;
   mIsSmartSelection = pSettings.IsSmartSelection();
   mIsOvertones = pSettings.IsOvertones();
   // Borrowed from TimeToLongSample
   mSampleCountLowerBound = floor( wc->GetStartTime() * rate + 0.5);
   mSampleCountUpperBound = floor( wc->GetEndTime() * rate + 0.5);
}

References SpectrogramSettings::Get(), ProjectSettings::GetBrushRadius(), ProjectSettings::IsOvertones(), ProjectSettings::IsSmartSelection(), mBrushRadius, mFreqLowerBound, mFreqUpperBound, mIsOvertones, mIsSmartSelection, mpSpectralData, mRect, mSampleCountLowerBound, mSampleCountUpperBound, TrackPanelMouseState::rect, settings(), and TrackPanelMouseState::state.

Here is the call graph for this function:

◆ ~BrushHandle()

BrushHandle::~BrushHandle ( )

virtual

Definition at line 165 of file BrushHandle.cpp.

166{

167}

Member Function Documentation

◆ Cancel()

UIHandle::Result BrushHandle::Cancel ( AudacityProject * pProject )

overridevirtual

Implements UIHandle.

Definition at line 395 of file BrushHandle.cpp.

{
   mpStateSaver.reset();
   return RefreshCode::RefreshAll;
}

References mpStateSaver, and RefreshCode::RefreshAll.

◆ Click()

UIHandle::Result BrushHandle::Click	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject
	)

overridevirtual

Implements UIHandle.

Definition at line 220 of file BrushHandle.cpp.

{
   if (mpStateSaver)
      // Clear all unless there is a modifier key down
      mpStateSaver->Init( *pProject, !evt.event.HasAnyModifiers() );
 
   using namespace RefreshCode;
 
   const auto pView = mpView.lock();
   if ( !pView )
      return Cancelled;
 
   wxMouseEvent &event = evt.event;
   auto &trackPanel = TrackPanel::Get( *pProject );
   auto &viewInfo = ViewInfo::Get( *pProject );
 
   return RefreshAll;
}

References Cancelled, TrackPanelMouseEvent::event, ViewInfo::Get(), TrackPanel::Get(), mpStateSaver, mpView, and RefreshCode::RefreshAll.

Here is the call graph for this function:

◆ Drag()

UIHandle::Result BrushHandle::Drag	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject
	)

overridevirtual

Implements UIHandle.

Definition at line 240 of file BrushHandle.cpp.

{
   using namespace RefreshCode;
 
   const auto pView = mpView.lock();
   if ( !pView )
      return Cancelled;
 
   wxMouseEvent &event = evt.event;
   const auto wc = FindChannel();
   auto &trackPanel = TrackPanel::Get( *pProject );
   auto &viewInfo = ViewInfo::Get( *pProject );
 
   auto posXToHopNum = [&](int x0){
      double posTime = viewInfo.PositionToTime(x0, mRect.x);
      sampleCount sc = wc->TimeToLongSamples(posTime);
      auto hopSize = mpSpectralData->GetHopSize();
      return (sc.as_long_long() + hopSize / 2) / hopSize;
   };
 
   auto posYToFreqBin = [&](int y0){
      int resFreq = PositionToFrequency(*wc, 0, y0, mRect.y, mRect.height);
      double resFreqBin = resFreq / (mpSpectralData->GetSR() / mpSpectralData->GetWindowSize());
      return static_cast<int>(std::round(resFreqBin));
   };
 
   auto drawCircle = [&](int h0, int bm){
      // For each (h0, b0), draw circle
      int h2 = mBrushRadius;
      int b2 = 0;
      int hChange = 1 - (mBrushRadius << 1);
      int bChange = 0;
      int radiusError = 0;
      while (h2 >= b2) {
         for (int i = h0 - h2; i <= h0 + h2; i++)
         {
            HandleHopBinData(i, bm + b2);
            HandleHopBinData(i, bm - b2);
         }
         for (int i = h0 - b2; i <= h0 + b2; i++)
         {
            HandleHopBinData(i, bm + h2);
            HandleHopBinData(i, bm - h2);
         }
 
         b2++;
         radiusError += bChange;
         bChange += 2;
         if (((radiusError << 1) + hChange) > 0)
         {
            h2--;
            radiusError += hChange;
            hChange += 2;
         }
      } // End of full circle drawing
   };
 
   // Clip the coordinates
   // TODO: Find ways to access the ClipParameters (for the mid)
   int dest_xcoord = std::clamp(event.m_x, mRect.x + 10, mRect.x + mRect.width);
   int dest_ycoord = std::clamp(event.m_y, mRect.y + 10, mRect.y + mRect.height);
 
   int h1 = posXToHopNum(dest_xcoord);
   int b1 = posYToFreqBin(dest_ycoord);
 
   mbCtrlDown = event.ControlDown() || event.AltDown();
 
   // Use the hop and bin number to calculate the brush stroke, instead of the mouse coordinates
   // For mouse coordinate:
   // (src_xcoord, src_ycoord) -> (dest_xcoord, dest_ycoord)
 
   const auto &hopSize = mpSpectralData->GetHopSize();
   if(!mpSpectralData->coordHistory.empty()){
      int src_xcoord = mpSpectralData->coordHistory.back().first;
      int src_ycoord = mpSpectralData->coordHistory.back().second;
 
      int h0 = posXToHopNum(src_xcoord);
      int b0 = posYToFreqBin(src_ycoord);
      int wd = mBrushRadius * 2;
 
      int dh =  abs(h1-h0), sh = h0<h1 ? 1 : -1;
      int db = -abs(b1-b0), sb = b0<b1 ? 1 : -1;
      int err = dh+db, err2;
 
      // Line drawing (draw points until the start coordinate reaches the end)
      while(true){
         if (h0 == h1 && b0 == b1)
            break;
         err2 = err * 2;
         if (err2 * 2 >= db) { err += db; h0 += sh; }
         if (err2 * 2 <= dh) { err += dh; b0 += sb; }
 
 
         int bm = b0;
         if(mIsSmartSelection){
            // Correct the y coord (snap to highest energy freq. bin)
            if(auto *sView = dynamic_cast<SpectrumView*>(pView.get())){
               int resFreqBin =
                  SpectralDataManager::FindFrequencySnappingBin(*wc,
                     h0 * hopSize, hopSize, mFreqSnappingRatio, bm);
               if(resFreqBin != - 1)
                  bm = resFreqBin;
            }
         }
 
         if(mIsOvertones){
            // take bm and calculate the highest energy
            std::vector<int> binsToWork = SpectralDataManager::FindHighestFrequencyBins(*wc,
                            h0 * hopSize, hopSize, mOvertonesThreshold, bm);
            for(auto & bins: binsToWork)
               drawCircle(h0, bins);
         }
 
         drawCircle(h0, bm);
      } // End of line connecting
   }
   mpSpectralData->coordHistory.push_back(std::make_pair(dest_xcoord, dest_ycoord));
   return RefreshAll;
}

References sampleCount::as_long_long(), Cancelled, TrackPanelMouseEvent::event, FindChannel(), SpectralDataManager::FindFrequencySnappingBin(), SpectralDataManager::FindHighestFrequencyBins(), ViewInfo::Get(), TrackPanel::Get(), HandleHopBinData(), mbCtrlDown, mBrushRadius, mFreqSnappingRatio, mIsOvertones, mIsSmartSelection, mOvertonesThreshold, mpSpectralData, mpView, mRect, anonymous_namespace{BrushHandle.cpp}::PositionToFrequency(), RefreshCode::RefreshAll, and fast_float::round().

Here is the call graph for this function:

◆ Draw()

void BrushHandle::Draw	(	TrackPanelDrawingContext &	context,
		const wxRect &	rect,
		unsigned	iPass
	)

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 401 of file BrushHandle.cpp.

{
   if ( iPass == TrackArtist::PassTracks ) {
      auto& dc = context.dc;
      wxPoint coord;
      coord.x = mMostRecentX;
      coord.y = mMostRecentY;
      dc.SetBrush( *wxTRANSPARENT_BRUSH );
      dc.SetPen( *wxYELLOW_PEN );
      dc.DrawCircle(coord, mBrushRadius);
   }
}

References TrackPanelDrawingContext::dc, mBrushRadius, mMostRecentX, mMostRecentY, and TrackArtist::PassTracks.

◆ Enter()

void BrushHandle::Enter	(	bool	forward,
		AudacityProject *	pProject
	)

overridevirtual

Reimplemented from UIHandle.

Definition at line 193 of file BrushHandle.cpp.

{
 
}

◆ Escape()

bool BrushHandle::Escape ( AudacityProject * pProject )

overridevirtual

Reimplemented from UIHandle.

Definition at line 198 of file BrushHandle.cpp.

{
   return false;
}

◆ FindChannel()

std::shared_ptr< WaveChannel > BrushHandle::FindChannel ( )

private

Definition at line 416 of file BrushHandle.cpp.

{
   auto pView = mpView.lock();
   if (!pView)
      return {};
   else
      return pView->FindChannel<WaveChannel>();
}

References mpView.

Referenced by Drag(), and FindTrack().

Here is the caller graph for this function:

◆ FindTrack()

std::shared_ptr< const Track > BrushHandle::FindTrack ( ) const

overridevirtual

Returns: pointer to associated track, if any

Implements UIHandle.

Definition at line 169 of file BrushHandle.cpp.

{
   return TrackFromChannel(const_cast<BrushHandle&>(*this).FindChannel());
}

References FindChannel(), and UIHandle::TrackFromChannel().

Here is the call graph for this function:

◆ HandleHopBinData()

void BrushHandle::HandleHopBinData	(	int	hopNum,
		int	freqBinNum
	)

Definition at line 204 of file BrushHandle.cpp.

                                                             {
   // Ignore the mouse dragging outside valid area
   // We should also check for the available freq. range that is visible to user
   long long sampleCount = hopNum * mpSpectralData->GetHopSize();
   wxInt64 freq = freqBinNum * mpSpectralData->GetSR() / mpSpectralData->GetWindowSize();
 
   if(sampleCount < mSampleCountLowerBound || sampleCount > mSampleCountUpperBound ||
      freq < mFreqLowerBound || freq > mFreqUpperBound)
      return;
 
   if(mbCtrlDown)
      mpSpectralData->removeHopBinData(hopNum, freqBinNum);
   else
      mpSpectralData->addHopBinData(hopNum, freqBinNum);
}

References mbCtrlDown, mFreqUpperBound, mpSpectralData, and mSampleCountUpperBound.

Referenced by Drag().

Here is the caller graph for this function:

◆ IsDragging()

bool BrushHandle::IsDragging ( ) const

overridevirtual

Whether the handle is dragging, affecting other panel painting; default returns false

Reimplemented from UIHandle.

Definition at line 57 of file BrushHandle.cpp.

{
   return mSelectionStateChanger.get() != NULL;
}

References mSelectionStateChanger.

◆ operator=()

BrushHandle & BrushHandle::operator= ( const BrushHandle & )

default

◆ Preview()

HitTestPreview BrushHandle::Preview	(	const TrackPanelMouseState &	state,
		AudacityProject *	pProject
	)

overridevirtual

Implements UIHandle.

Definition at line 361 of file BrushHandle.cpp.

{
   TranslatableString tip;
   wxCursor *pCursor = CrosshairCursor();
   return { tip, pCursor };
}

References anonymous_namespace{BrushHandle.cpp}::CrosshairCursor().

Here is the call graph for this function:

◆ Release()

UIHandle::Result BrushHandle::Release	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject,
		wxWindow *	pParent
	)

overridevirtual

Implements UIHandle.

Definition at line 369 of file BrushHandle.cpp.

{
   using namespace RefreshCode;
   mpSpectralData->saveAndClearBuffer();
   if (mpStateSaver) {
      mpStateSaver->Commit();
      mpStateSaver.reset();
   }
   if(mbCtrlDown){
      ProjectHistory::Get( *pProject ).PushState(
            XO( "Erased selected area" ),
            XO( "Erased selected area" ) );
      ProjectHistory::Get( *pProject ).ModifyState(true);
   }
   else{
      ProjectHistory::Get( *pProject ).PushState(
            XO( "Selected area using Brush Tool" ),
            XO( "Brush tool selection" ) );
      ProjectHistory::Get( *pProject ).ModifyState(true);
   }
 
   return RefreshNone;
}

References ProjectHistory::Get(), mbCtrlDown, ProjectHistory::ModifyState(), mpSpectralData, mpStateSaver, ProjectHistory::PushState(), RefreshCode::RefreshNone, and XO().

Here is the call graph for this function:

Member Data Documentation

◆ mbCtrlDown

bool BrushHandle::mbCtrlDown

private

Definition at line 115 of file BrushHandle.h.

Referenced by Drag(), HandleHopBinData(), and Release().

◆ mBrushRadius

int BrushHandle::mBrushRadius

private

Definition at line 114 of file BrushHandle.h.

Referenced by BrushHandle(), Drag(), and Draw().

◆ mFreqLowerBound

wxInt64 BrushHandle::mFreqLowerBound

private

Definition at line 112 of file BrushHandle.h.

Referenced by BrushHandle().

◆ mFreqSnappingRatio

double BrushHandle::mFreqSnappingRatio { 0.01 }

private

Definition at line 105 of file BrushHandle.h.

Referenced by Drag().

◆ mFreqUpperBound

wxInt64 BrushHandle::mFreqUpperBound

private

Definition at line 112 of file BrushHandle.h.

Referenced by BrushHandle(), and HandleHopBinData().

◆ mIsOvertones

bool BrushHandle::mIsOvertones

private

Definition at line 110 of file BrushHandle.h.

Referenced by BrushHandle(), and Drag().

◆ mIsSmartSelection

bool BrushHandle::mIsSmartSelection

private

Definition at line 110 of file BrushHandle.h.

Referenced by BrushHandle(), and Drag().

◆ mMostRecentX

int BrushHandle::mMostRecentX { -1 }

private

Definition at line 113 of file BrushHandle.h.

Referenced by Draw().

◆ mMostRecentY

int BrushHandle::mMostRecentY { -1 }

private

Definition at line 113 of file BrushHandle.h.

Referenced by Draw().

◆ mOvertonesThreshold

double BrushHandle::mOvertonesThreshold { 0.999 }

private

Definition at line 108 of file BrushHandle.h.

Referenced by Drag().

◆ mpSpectralData

std::shared_ptr<SpectralData> BrushHandle::mpSpectralData

private

Definition at line 91 of file BrushHandle.h.

Referenced by BrushHandle(), Drag(), HandleHopBinData(), and Release().

◆ mpStateSaver

std::shared_ptr<StateSaver> BrushHandle::mpStateSaver

private

Definition at line 90 of file BrushHandle.h.

Referenced by Cancel(), Click(), and Release().

◆ mpView

std::weak_ptr<ChannelView> BrushHandle::mpView

private

Definition at line 100 of file BrushHandle.h.

Referenced by Click(), Drag(), and FindChannel().

◆ mRect

wxRect BrushHandle::mRect {}

private

Definition at line 101 of file BrushHandle.h.

Referenced by BrushHandle(), and Drag().

◆ mSampleCountLowerBound

long long BrushHandle::mSampleCountLowerBound

private

Definition at line 111 of file BrushHandle.h.

Referenced by BrushHandle().

◆ mSampleCountUpperBound

long long BrushHandle::mSampleCountUpperBound

private

Definition at line 111 of file BrushHandle.h.

Referenced by BrushHandle(), and HandleHopBinData().

◆ mSelectionStateChanger

std::shared_ptr<SelectionStateChanger> BrushHandle::mSelectionStateChanger

private

Definition at line 117 of file BrushHandle.h.

Referenced by IsDragging().

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BrushHandle() [1/2]

◆ BrushHandle() [2/2]

◆ ~BrushHandle()

Member Function Documentation

◆ Cancel()

◆ Click()

◆ Drag()

◆ Draw()

◆ Enter()

◆ Escape()

◆ FindChannel()

◆ FindTrack()

◆ HandleHopBinData()

◆ IsDragging()

◆ operator=()

◆ Preview()

◆ Release()

Member Data Documentation

◆ mbCtrlDown

◆ mBrushRadius

◆ mFreqLowerBound

◆ mFreqSnappingRatio

◆ mFreqUpperBound

◆ mIsOvertones

◆ mIsSmartSelection

◆ mMostRecentX

◆ mMostRecentY

◆ mOvertonesThreshold

◆ mpSpectralData

◆ mpStateSaver

◆ mpView

◆ mRect

◆ mSampleCountLowerBound

◆ mSampleCountUpperBound

◆ mSelectionStateChanger