#include <SpectrumView.h>

Inheritance diagram for SpectrumView:

Collaboration diagram for SpectrumView:

Classes
class	SpectralDataSaver

Public Member Functions
	SpectrumView (WaveChannelView &waveChannelView, const SpectrumView &src)=delete

	SpectrumView (WaveChannelView &waveChannelView)

	~SpectrumView () override

const Type &	SubViewType () const override

std::shared_ptr< ChannelVRulerControls >	DoGetVRulerControls () override

std::shared_ptr< SpectralData >	GetSpectralData ()

bool	IsSpectral () const override

void	CopyToSubView (WaveChannelSubView *destSubView) const override

Public Member Functions inherited from WaveChannelSubView
	WaveChannelSubView (WaveChannelView &waveChannelView)

std::shared_ptr< WaveChannel >	FindWaveChannel ()

virtual const Type &	SubViewType () const =0

virtual void	CopyToSubView (WaveChannelSubView *destSubView) const

std::pair< bool, std::vector< UIHandlePtr > >	DoDetailedHitTest (const TrackPanelMouseState &state, const AudacityProject *pProject, int currentTool, bool bMultiTool, const std::shared_ptr< WaveChannel > &wt)

Public Member Functions inherited from CommonChannelView
std::shared_ptr< TrackPanelCell >	ContextMenuDelegate () override

std::vector< UIHandlePtr >	HitTest (const TrackPanelMouseState &, const AudacityProject *pProject) final

void	TimeShiftHitTest ()

virtual int	GetMinimizedHeight () const override

	ChannelView (const std::shared_ptr< Channel > &pChannel)

Public Member Functions inherited from ChannelView
	ChannelView (const std::shared_ptr< Channel > &pChannel)

virtual	~ChannelView ()=0

void	Reparent (const std::shared_ptr< Track > &parent, size_t iChannel) override
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. More...

void	CopyTo (Track &track, size_t iChannel) const override
	Copy state, for undo/redo purposes. More...

bool	GetMinimized () const

void	SetMinimized (bool minimized)

int	GetCumulativeHeightBefore () const

int	GetExpandedHeight () const

virtual int	GetMinimizedHeight () const =0

int	GetHeight () const

void	SetCumulativeHeightBefore (int y)
	Set cached value dependent on position within the track list. More...

void	SetExpandedHeight (int height)

std::shared_ptr< ChannelVRulerControls >	GetVRulerControls ()

std::shared_ptr< const ChannelVRulerControls >	GetVRulerControls () const

virtual std::shared_ptr< CommonTrackCell >	GetAffordanceControls ()

void	WriteXMLAttributes (XMLWriter &writer, size_t iChannel) const override
	Serialize persistent attributes. More...

bool	HandleXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView, size_t iChannel) override
	Deserialize an attribute, returning true if recognized. More...

virtual Refinement	GetSubViews (const wxRect &rect)

virtual bool	IsSpectral () const

virtual void	DoSetMinimized (bool isMinimized)

Public Member Functions inherited from CommonChannelCell
	CommonChannelCell (const std::shared_ptr< Channel > &pChannel)
	Construct from a channel. More...

	~CommonChannelCell ()

std::shared_ptr< Track >	DoFindTrack () override

void	Reparent (const std::shared_ptr< Track > &parent, size_t iChannel) override
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. More...

template<typename Subtype = Channel>
auto	FindChannel () -> std::shared_ptr< Subtype >
	May return null. More...

template<typename Subtype = const Channel>
auto	FindChannel () const -> std::enable_if_t< std::is_const_v< Subtype >, std::shared_ptr< Subtype > >
	May return null. More...

Public Member Functions inherited from CommonTrackPanelCell
	CommonTrackPanelCell ()

virtual	~CommonTrackPanelCell ()=0

HitTestPreview	DefaultPreview (const TrackPanelMouseState &, const AudacityProject *) override

std::shared_ptr< Track >	FindTrack ()

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

virtual std::vector< MenuItem >	GetMenuItems (const wxRect &rect, const wxPoint pPosition, AudacityProject pProject)
	Return a list of items for DoContextMenu() (empties for separators) More...

Public Member Functions inherited from TrackPanelCell
	TrackPanelCell ()=default

	TrackPanelCell (const TrackPanelCell &)=delete

TrackPanelCell &	operator= (const TrackPanelCell &)=delete

virtual	~TrackPanelCell ()=0

virtual HitTestPreview	DefaultPreview (const TrackPanelMouseState &state, const AudacityProject *pProject)

virtual std::vector< UIHandlePtr >	HitTest (const TrackPanelMouseState &state, const AudacityProject *pProject)=0

virtual unsigned	HandleWheelRotation (const TrackPanelMouseEvent &event, AudacityProject *pProject)

virtual std::shared_ptr< TrackPanelCell >	ContextMenuDelegate ()

virtual unsigned	DoContextMenu (const wxRect &rect, wxWindow pParent, const wxPoint pPosition, AudacityProject *pProject)

virtual unsigned	CaptureKey (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow pParent, AudacityProject project)

virtual unsigned	KeyDown (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow pParent, AudacityProject project)

virtual unsigned	KeyUp (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow pParent, AudacityProject project)

virtual unsigned	Char (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow pParent, AudacityProject project)

virtual unsigned	LoseFocus (AudacityProject *project)

Public Member Functions inherited from TrackPanelNode
	TrackPanelNode ()

virtual	~TrackPanelNode ()=0

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)

Public Member Functions inherited from ChannelAttachment
virtual	~ChannelAttachment ()

virtual void	CopyTo (Track &track, size_t iChannel) const
	Copy state, for undo/redo purposes. More...

virtual void	Reparent (const std::shared_ptr< Track > &parent, size_t iChannel)
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. More...

virtual void	WriteXMLAttributes (XMLWriter &writer, size_t iChannel) const
	Serialize persistent attributes. More...

virtual bool	HandleXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView, size_t iChannel)
	Deserialize an attribute, returning true if recognized. More...

Static Public Attributes
static int	mBrushRadius

Private Member Functions
SpectrumView &	operator= (const SpectrumView &)=delete

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

void	DoDraw (TrackPanelDrawingContext &context, const WaveChannel &channel, const WaveTrack::Interval *selectedClip, const wxRect &rect)

std::vector< UIHandlePtr >	DetailedHitTest (const TrackPanelMouseState &state, const AudacityProject *pProject, int currentTool, bool bMultiTool) override

unsigned	CaptureKey (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow pParent, AudacityProject project) override

unsigned	KeyDown (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow pParent, AudacityProject project) override

unsigned	Char (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow pParent, AudacityProject project) override

void	DoSetMinimized (bool minimized) override

Static Private Member Functions
static void	ForAll (AudacityProject &project, std::function< void(SpectrumView &view)> fn)

Private Attributes
std::weak_ptr< BrushHandle >	mBrushHandle

std::shared_ptr< SpectralData >	mpSpectralData

std::shared_ptr< SpectralData >	mpBackupSpectralData

bool	mOnBrushTool

Additional Inherited Members
Public Types inherited from WaveChannelSubView
using	Display = WaveChannelViewConstants::Display

using	Type = WaveChannelSubViewType

Public Types inherited from ChannelView
enum	: unsigned { DefaultHeight = 150 }

using	Refinement = std::vector< std::pair< wxCoord, std::shared_ptr< ChannelView > > >

Static Public Member Functions inherited from CommonChannelView
static void	GetEnvelopeValues (const Envelope &env, double aligned_time, double sampleDur, double *buffer, int bufferLen, int leftOffset, const ZoomInfo &zoomInfo)
	Get many envelope points for pixel columns at once, but don't assume uniform time per pixel. More...

Static Public Member Functions inherited from ChannelView
static ChannelView &	Get (Channel &channel)

static const ChannelView &	Get (const Channel &channel)

static ChannelView *	Find (Channel *pChannel)

static const ChannelView *	Find (const Channel *pChannel)

static int	GetChannelGroupHeight (const Track *pTrack)

static int	GetCumulativeHeight (const Channel *pChannel)

static int	GetCumulativeHeight (const Track *pTrack)

static int	GetTotalHeight (const TrackList &list)

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)

Public Attributes inherited from CommonChannelView
std::weak_ptr< TimeShiftHandle >	mTimeShiftHandle

Public Attributes inherited from ChannelView
std::pair< int, int >	vrulerSize

Protected Member Functions inherited from WaveChannelSubView
std::weak_ptr< WaveChannelView >	GetWaveChannelView () const

std::vector< MenuItem >	GetMenuItems (const wxRect &rect, const wxPoint pPosition, AudacityProject pProject) override
	Return a list of items for DoContextMenu() (empties for separators) More...

virtual std::vector< UIHandlePtr >	DetailedHitTest (const TrackPanelMouseState &, const AudacityProject *pProject, int currentTool, bool bMultiTool)=0

virtual std::shared_ptr< ChannelVRulerControls >	DoGetVRulerControls ()=0

Protected Member Functions inherited from CommonTrackPanelCell
virtual std::shared_ptr< Track >	DoFindTrack ()=0

unsigned	DoContextMenu (const wxRect &rect, wxWindow pParent, const wxPoint pPosition, AudacityProject *pProject) override

unsigned	HandleWheelRotation (const TrackPanelMouseEvent &event, AudacityProject *pProject) override

Static Protected Member Functions inherited from WaveChannelSubView
static void	DrawBoldBoundaries (TrackPanelDrawingContext &context, const WaveChannel &channel, const wxRect &rect)

Protected Attributes inherited from CommonChannelView
std::weak_ptr< SelectHandle >	mSelectHandle

Protected Attributes inherited from ChannelView
std::shared_ptr< ChannelVRulerControls >	mpVRulerControls

Detailed Description

Definition at line 123 of file SpectrumView.h.

Constructor & Destructor Documentation

◆ SpectrumView() [1/2]

SpectrumView::SpectrumView	(	WaveChannelView &	waveChannelView,
		const SpectrumView &	src
	)

delete

◆ SpectrumView() [2/2]

SpectrumView::SpectrumView ( WaveChannelView & waveChannelView )

explicit

Definition at line 55 of file SpectrumView.cpp.

   : WaveChannelSubView(waveChannelView)
{
   const auto wt = FindWaveChannel();
   mpSpectralData = std::make_shared<SpectralData>(wt->GetRate());
   mOnBrushTool = false;
}

References WaveChannelSubView::FindWaveChannel(), mOnBrushTool, and mpSpectralData.

Here is the call graph for this function:

◆ ~SpectrumView()

SpectrumView::~SpectrumView ( )

overridedefault

Member Function Documentation

◆ CaptureKey()

unsigned SpectrumView::CaptureKey	(	wxKeyEvent &	event,
		ViewInfo &	viewInfo,
		wxWindow *	pParent,
		AudacityProject *	project
	)

overrideprivatevirtual

Reimplemented from TrackPanelCell.

Definition at line 1062 of file SpectrumView.cpp.

{
   bool capture = ShouldCaptureEvent(event, mpSpectralData.get());
   event.Skip(!capture);
   return RefreshCode::RefreshNone;
}

References mpSpectralData, RefreshCode::RefreshNone, and ShouldCaptureEvent().

Here is the call graph for this function:

◆ Char()

unsigned SpectrumView::Char	(	wxKeyEvent &	event,
		ViewInfo &	viewInfo,
		wxWindow *	pParent,
		AudacityProject *	project
	)

overrideprivatevirtual

Reimplemented from TrackPanelCell.

Definition at line 1080 of file SpectrumView.cpp.

{
   bool capture = ShouldCaptureEvent(event, mpSpectralData.get());
   event.Skip(!capture);
   return RefreshCode::RefreshNone;
}

References mpSpectralData, RefreshCode::RefreshNone, and ShouldCaptureEvent().

Here is the call graph for this function:

◆ CopyToSubView()

void SpectrumView::CopyToSubView ( WaveChannelSubView * destSubView ) const

overridevirtual

Reimplemented from WaveChannelSubView.

Definition at line 233 of file SpectrumView.cpp.

{
   if (const auto pDest = dynamic_cast< SpectrumView* >(destSubView)) {
      pDest->mpSpectralData =
         std::make_shared<SpectralData>(mpSpectralData->GetSR());
      pDest->mpSpectralData->CopyFrom(*mpSpectralData);
   }
}

References mpSpectralData.

◆ DetailedHitTest()

std::vector< UIHandlePtr > SpectrumView::DetailedHitTest	(	const TrackPanelMouseState &	state,
		const AudacityProject *	pProject,
		int	currentTool,
		bool	bMultiTool
	)

overrideprivatevirtual

Implements CommonChannelView.

Definition at line 169 of file SpectrumView.cpp.

{
   const auto wt = FindWaveChannel();
   std::vector<UIHandlePtr> results;
 
#ifdef EXPERIMENTAL_BRUSH_TOOL
   mOnBrushTool = (currentTool == ToolCodes::brushTool);
   if(mOnBrushTool){
      const auto result = BrushHandleHitTest(
         mBrushHandle, state,
         pProject, std::static_pointer_cast<SpectrumView>(shared_from_this()),
         mpSpectralData);
      results.push_back(result);
      return results;
   }
#endif
 
   return WaveChannelSubView::DoDetailedHitTest(
      state, pProject, currentTool, bMultiTool, wt
   ).second;
}

References BrushHandleHitTest(), WaveChannelSubView::DoDetailedHitTest(), WaveChannelSubView::FindWaveChannel(), mBrushHandle, mOnBrushTool, and mpSpectralData.

Here is the call graph for this function:

◆ DoDraw()

void SpectrumView::DoDraw	(	TrackPanelDrawingContext &	context,
		const WaveChannel &	channel,
		const WaveTrack::Interval *	selectedClip,
		const wxRect &	rect
	)

private

Definition at line 858 of file SpectrumView.cpp.

{
   const auto artist = TrackArtist::Get( context );
   const auto &blankSelectedBrush = artist->blankSelectedBrush;
   const auto &blankBrush = artist->blankBrush;
   TrackArt::DrawBackgroundWithSelection(
      context, rect, channel, blankSelectedBrush, blankBrush );
 
   for (const auto &pInterval : channel.Intervals()) {
      bool selected = selectedClip &&
         selectedClip == &pInterval->GetClip();
      DrawClipSpectrum(context, channel, *pInterval, rect, mpSpectralData,
         selected);
   }
 
   DrawBoldBoundaries(context, channel, rect);
}

References TrackArt::DrawBackgroundWithSelection(), WaveChannelSubView::DrawBoldBoundaries(), anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), TrackArtist::Get(), WaveChannel::Intervals(), and mpSpectralData.

Referenced by Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoGetVRulerControls()

std::shared_ptr< ChannelVRulerControls > SpectrumView::DoGetVRulerControls ( )

overridevirtual

Implements ChannelView.

Definition at line 224 of file SpectrumView.cpp.

{
   return std::make_shared<SpectrumVRulerControls>(shared_from_this());
}

◆ DoSetMinimized()

void SpectrumView::DoSetMinimized ( bool minimized )

overrideprivatevirtual

Reimplemented from ChannelView.

Definition at line 193 of file SpectrumView.cpp.

{
   const auto wt = FindWaveChannel();
   if (!wt)
      return;
 
   bool bHalfWave;
   gPrefs->Read(wxT("/GUI/CollapseToHalfWave"), &bHalfWave, false);
   if( bHalfWave && minimized)
   {
      // It is all right to set the top of scale to a huge number,
      // not knowing the track sampleRate here -- because when retrieving the
      // value, then we pass in a sample rate and clamp it above to the
      // Nyquist frequency.
      constexpr auto max = std::numeric_limits<float>::max();
      const bool spectrumLinear =
         (SpectrogramSettings::Get(*wt).scaleType ==
            SpectrogramSettings::stLinear);
      // Zoom out full
      SpectrogramBounds::Get(*wt)
         .SetBounds( spectrumLinear ? 0.0f : 1.0f, max );
   }
 
   ChannelView::DoSetMinimized(minimized);
}

References ChannelView::DoSetMinimized(), WaveChannelSubView::FindWaveChannel(), SpectrogramSettings::Get(), SpectrogramBounds::Get(), gPrefs, audacity::BasicSettings::Read(), SpectrogramSettings::scaleType, SpectrogramBounds::SetBounds(), SpectrogramSettings::stLinear, and wxT().

Here is the call graph for this function:

◆ Draw()

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

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 878 of file SpectrumView.cpp.

{
   if ( iPass == TrackArtist::PassTracks ) {
      const auto artist = TrackArtist::Get(context);
      const auto &pendingTracks = *artist->pPendingTracks;
 
      auto &dc = context.dc;
 
      const auto pChannel = FindChannel();
      if (!pChannel)
         return;
      const auto &wt = static_cast<const WaveChannel&>(
         pendingTracks.SubstitutePendingChangedChannel(*pChannel));
 
#if defined(__WXMAC__)
      wxAntialiasMode aamode = dc.GetGraphicsContext()->GetAntialiasMode();
      dc.GetGraphicsContext()->SetAntialiasMode(wxANTIALIAS_NONE);
#endif
 
      auto waveChannelView = GetWaveChannelView().lock();
      wxASSERT(waveChannelView.use_count());
 
      auto selectedClip = waveChannelView->GetSelectedClip();
      DoDraw(context, wt, selectedClip.get(), rect);
 
#if defined(__WXMAC__)
      dc.GetGraphicsContext()->SetAntialiasMode(aamode);
#endif
   }
   WaveChannelSubView::Draw(context, rect, iPass);
}

References TrackPanelDrawingContext::dc, DoDraw(), TrackPanelDrawable::Draw(), CommonChannelCell::FindChannel(), TrackArtist::Get(), WaveChannelSubView::GetWaveChannelView(), and TrackArtist::PassTracks.

Here is the call graph for this function:

◆ ForAll()

void SpectrumView::ForAll	(	AudacityProject &	project,
		std::function< void(SpectrumView &view)>	fn
	)

staticprivate

Definition at line 151 of file SpectrumView.cpp.

{
   if (!fn)
      return;
   for (const auto wt : TrackList::Get(project).Any<WaveTrack>()) {
      for (auto pChannel : wt->Channels()) {
         if (auto pWaveChannelView =
             dynamic_cast<WaveChannelView*>(&ChannelView::Get(*pChannel))) {
            for (const auto &pSubView : pWaveChannelView->GetAllSubViews()) {
               if (const auto sView = dynamic_cast<SpectrumView*>(pSubView.get()))
                  fn( *sView );
            }
         }
      }
   }
}

References fn, TrackList::Get(), ChannelView::Get(), and project.

Referenced by SpectrumView::SpectralDataSaver::Init(), and SpectrumView::SpectralDataSaver::~SpectralDataSaver().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSpectralData()

std::shared_ptr< SpectralData > SpectrumView::GetSpectralData ( )

Definition at line 229 of file SpectrumView.cpp.

                                                         {
   return mpSpectralData;
}

References mpSpectralData.

◆ IsSpectral()

bool SpectrumView::IsSpectral ( ) const

overridevirtual

Reimplemented from ChannelView.

Definition at line 65 of file SpectrumView.cpp.

{
   return true;
}

◆ KeyDown()

unsigned SpectrumView::KeyDown	(	wxKeyEvent &	event,
		ViewInfo &	viewInfo,
		wxWindow *	pParent,
		AudacityProject *	project
	)

overrideprivatevirtual

Reimplemented from TrackPanelCell.

Definition at line 1070 of file SpectrumView.cpp.

{
   bool capture = ShouldCaptureEvent(event, mpSpectralData.get());
   event.Skip(!capture);
   if (capture && SpectralDataManager::ProcessTracks(*project))
      // Not RefreshCell, because there might be effects in multiple tracks
      return RefreshCode::RefreshAll;
   return RefreshCode::RefreshNone;
}

References mpSpectralData, SpectralDataManager::ProcessTracks(), project, RefreshCode::RefreshAll, RefreshCode::RefreshNone, and ShouldCaptureEvent().

Here is the call graph for this function:

◆ operator=()

SpectrumView & SpectrumView::operator= ( const SpectrumView & )

privatedelete

◆ SubViewType()

auto SpectrumView::SubViewType ( ) const

overridevirtual

Implements WaveChannelSubView.

Definition at line 219 of file SpectrumView.cpp.

{
   return sType;
}

References sType.

Member Data Documentation

◆ mBrushHandle

std::weak_ptr<BrushHandle> SpectrumView::mBrushHandle

private

Definition at line 147 of file SpectrumView.h.

Referenced by DetailedHitTest().

◆ mBrushRadius

int SpectrumView::mBrushRadius

static

Definition at line 140 of file SpectrumView.h.

◆ mOnBrushTool

bool SpectrumView::mOnBrushTool

private

Definition at line 149 of file SpectrumView.h.

Referenced by DetailedHitTest(), and SpectrumView().

◆ mpBackupSpectralData

std::shared_ptr<SpectralData> SpectrumView::mpBackupSpectralData

private

Definition at line 148 of file SpectrumView.h.

Referenced by SpectrumView::SpectralDataSaver::Init(), and SpectrumView::SpectralDataSaver::~SpectralDataSaver().

◆ mpSpectralData

std::shared_ptr<SpectralData> SpectrumView::mpSpectralData

private

Definition at line 148 of file SpectrumView.h.

Referenced by CaptureKey(), Char(), CopyToSubView(), DetailedHitTest(), DoDraw(), GetSpectralData(), SpectrumView::SpectralDataSaver::Init(), KeyDown(), and SpectrumView().

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

Classes

Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SpectrumView() [1/2]

◆ SpectrumView() [2/2]

◆ ~SpectrumView()

Member Function Documentation

◆ CaptureKey()

◆ Char()

◆ CopyToSubView()

◆ DetailedHitTest()

◆ DoDraw()

◆ DoGetVRulerControls()

◆ DoSetMinimized()

◆ Draw()

◆ ForAll()

◆ GetSpectralData()

◆ IsSpectral()

◆ KeyDown()

◆ operator=()

◆ SubViewType()

Member Data Documentation

◆ mBrushHandle

◆ mBrushRadius

◆ mOnBrushTool

◆ mpBackupSpectralData

◆ mpSpectralData