WaveTrackView.h

Go to the documentation of this file.

/**********************************************************************
 
Audacity: A Digital Audio Editor
 
WaveTrackView.h
 
Paul Licameli split from class WaveTrack
 
**********************************************************************/
 
#ifndef __AUDACITY_WAVE_TRACK_VIEW__
#define __AUDACITY_WAVE_TRACK_VIEW__
 
#include "../../../ui/CommonTrackView.h"
#include "ClientData.h"
#include "SampleCount.h"
namespace WaveTrackViewConstants{ enum Display : int; }
struct WaveTrackSubViewType;
 
class CutlineHandle;
class TranslatableString;
class SampleTrack;
class WaveTrack;
class WaveTrackView;
class WaveClip;
class WaveClipTrimHandle;
class ZoomInfo;
 
 
class TrackPanelResizeHandle;
class WaveTrackAffordanceHandle;
 
class SubViewCloseHandle;
class SubViewAdjustHandle;
class SubViewRearrangeHandle;
 
class wxDC;
 
class AUDACITY_DLL_API WaveTrackSubView : public CommonTrackView
{
public:
 
   using Display = WaveTrackViewConstants::Display;
   using Type = WaveTrackSubViewType;
 
   explicit
   WaveTrackSubView(WaveTrackView &waveTrackView);
   
   virtual const Type &SubViewType() const = 0;
 
   // For undo and redo purpose
   // Empty abstract method to be inherited, for copying the spectral data in SpectrumSubView
   virtual void CopyToSubView(WaveTrackSubView *destSubView) const;
 
   std::pair<
      bool, // if true, hit-testing is finished
      std::vector<UIHandlePtr>
   > DoDetailedHitTest(
      const TrackPanelMouseState &state,
      const AudacityProject *pProject, int currentTool, bool bMultiTool,
      const std::shared_ptr<WaveTrack> &wt );
   
protected:
   static void DrawBoldBoundaries(
      TrackPanelDrawingContext &context, const WaveTrack *track,
      const wxRect &rect );
 
   std::weak_ptr<WaveTrackView> GetWaveTrackView() const;
 
   std::vector<MenuItem> GetMenuItems(
      const wxRect &rect, const wxPoint *pPosition, AudacityProject *pProject )
   override;
 
   // Which channel of a WaveTrack (it may contain wide clips)
   const size_t mChannel;
 
private:
   std::weak_ptr<SubViewCloseHandle> mCloseHandle;
   std::weak_ptr<TrackPanelResizeHandle> mResizeHandle;
   std::weak_ptr<SubViewAdjustHandle> mAdjustHandle;
   std::weak_ptr<SubViewRearrangeHandle> mRearrangeHandle;
   std::weak_ptr<WaveClipTrimHandle> mClipTrimHandle;
   std::weak_ptr<CutlineHandle> mCutlineHandle;
   std::weak_ptr<WaveTrackView> mwWaveTrackView;
};
 
struct WaveTrackSubViewPlacement {
   int index;
   float fraction;
};
using WaveTrackSubViewPlacements = std::vector< WaveTrackSubViewPlacement >;
 
class WaveTrackView;
using WaveTrackSubViews = ClientData::Site<
   WaveTrackView, WaveTrackSubView, ClientData::SkipCopying, std::shared_ptr
>;
 
class AUDACITY_DLL_API WaveTrackView final
   : public CommonTrackView
   , public WaveTrackSubViews
{
   WaveTrackView( const WaveTrackView& ) = delete;
   WaveTrackView &operator=( const WaveTrackView& ) = delete;
 
public:
   static constexpr int kChannelSeparatorThickness{ 8 };
 
   using Display = WaveTrackViewConstants::Display;
 
   static WaveTrackView &Get( WaveTrack &track );
   static const WaveTrackView &Get( const WaveTrack &track );
   static WaveTrackView *Find( WaveTrack *pTrack );
   static const WaveTrackView *Find( const WaveTrack *pTrack );
 
 
   WaveTrackView(const std::shared_ptr<Track> &pTrack, size_t channel);
   ~WaveTrackView() override;
 
   size_t GetChannel() const { return mChannel; }
 
   // Preserve some view state too for undo/redo purposes
   void CopyTo( Track &track ) const override;
 
   std::shared_ptr<TrackVRulerControls> DoGetVRulerControls() override;
 
   // CommonTrackView implementation
   void Reparent( const std::shared_ptr<Track> &parent ) override;
 
   static std::pair<
      bool, // if true, hit-testing is finished
      std::vector<UIHandlePtr>
   > DoDetailedHitTest(
      const TrackPanelMouseState &state,
      const AudacityProject *pProject, int currentTool, bool bMultiTool,
      const std::shared_ptr<WaveTrack> &wt,
      CommonTrackView &view);
 
   std::vector< WaveTrackSubView::Type > GetDisplays() const;
   void SetDisplay(Display display, bool exclusive = true);
 
   const WaveTrackSubViewPlacements &SavePlacements() const
      { return DoGetPlacements(); }
   void RestorePlacements( const WaveTrackSubViewPlacements &placements )
      { DoGetPlacements() = placements; }
 
   // Return true if successful.  Fails if you try to toggle off the only
   // sub-view.
   bool ToggleSubView( Display id );
 
   // Get all the sub-views, in a sequence that is unspecified but in
   // correspondence with the result of SavePlacements
   std::vector< std::shared_ptr< WaveTrackSubView > > GetAllSubViews();
 
   // Return cached height of rect in last call of GetSubViews
   wxCoord GetLastHeight() const { return mLastHeight; }
 
   bool GetMultiView() const { return DoGetMultiView(); }
   void SetMultiView( bool value ) { DoGetMultiView() = value; }
 
 
   std::weak_ptr<WaveClip> GetSelectedClip();
 
   // Returns a visible subset of subviews, sorted in the same 
   // order as they are supposed to be displayed
   
 
   // Get the visible sub-views,
   // if rect is provided then result will contain
   // y coordinate for each subview within this rect
   Refinement GetSubViews(const wxRect* rect = nullptr);
 
   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;
 
   unsigned LoseFocus(AudacityProject *project) override;
 
   static bool ClipDetailsVisible(const WaveClip& clip, const ZoomInfo& zoomInfo, const wxRect& viewRect);
   static wxRect ClipHitTestArea(const WaveClip& clip, const ZoomInfo& zoomInfo, const wxRect& viewRect);
   static bool HitTest(const WaveClip& clip, const ZoomInfo& zoomInfo, const wxRect& rect, const wxPoint& pos);
 
   //FIXME: These functions do not push state to undo history
   //because attempt to do so leads to a focus lose which, in
   //turn finalizes text editing (state is saved after text
   //editing was intentionally finished instead)
 
   bool CutSelectedText(AudacityProject& project);
   bool CopySelectedText(AudacityProject& project);
   bool PasteText(AudacityProject& project);
   bool SelectAllText(AudacityProject& project);
 
private:
   void BuildSubViews() const;
   void DoSetDisplay(Display display, bool exclusive = true);
   bool SelectNextClip(ViewInfo& viewInfo, AudacityProject* project, bool forward);
 
   // TrackPanelDrawable implementation
   void Draw(
      TrackPanelDrawingContext &context,
      const wxRect &rect, unsigned iPass ) override;
 
   std::vector<UIHandlePtr> DetailedHitTest
      (const TrackPanelMouseState &state,
       const AudacityProject *pProject, int currentTool, bool bMultiTool)
      override;
 
   // TrackView implementation
   Refinement GetSubViews(const wxRect& rect) override;
 
private:
   std::shared_ptr<CommonTrackCell> GetAffordanceControls() override;
 
   void DoSetMinimized( bool minimized ) override;
 
   // Placements are in correspondence with the array of sub-views
   // in the WaveTrackSubViews base class, though their sequence is
   // unspecified and maybe different in different platforms.
   WaveTrackSubViewPlacements &DoGetPlacements();
   const WaveTrackSubViewPlacements &DoGetPlacements() const;
   mutable wxCoord mLastHeight{};
 
   bool &DoGetMultiView();
   bool DoGetMultiView() const;
 
   std::shared_ptr<CommonTrackCell> DoGetAffordance(const std::shared_ptr<Track>& track);
 
   std::shared_ptr<CommonTrackCell> mpAffordanceCellControl;
 
   std::weak_ptr<TrackPanelCell> mKeyEventDelegate;
 
   std::weak_ptr<WaveTrackAffordanceHandle> mAffordanceHandle;
 
   const size_t mChannel;
};
 
// Helper for drawing routines
class SelectedRegion;
class WaveClip;
class ZoomInfo;
 
struct AUDACITY_DLL_API ClipParameters
{
   // Do a bunch of calculations common to waveform and spectrum drawing.
   ClipParameters(
      bool spectrum, const SampleTrack *track,
      const WaveClip *clip, const wxRect &rect,
      const SelectedRegion &selectedRegion, const ZoomInfo &zoomInfo);
 
   double tOffset;
   double rate;
   double h; // absolute time of left edge of display
   double tpre; // offset corrected time of left edge of display
   double h1;
   double tpost; // offset corrected time of right edge of display
 
   // Calculate actual selection bounds so that t0 > 0 and t1 < the
   // end of the track
   double t0;
   double t1;
 
   double averagePixelsPerSample;
   bool showIndividualSamples;
 
   sampleCount ssel0;
   sampleCount ssel1;
 
   wxRect hiddenMid;
   int hiddenLeftOffset;
 
   wxRect mid;
   int leftOffset;
 
   // returns a clip rectangle restricted by viewRect, 
   // and with clipOffsetX - clip horizontal origin offset within view rect
   static wxRect GetClipRect(const WaveClip& clip, const ZoomInfo& zoomInfo, const wxRect& viewRect, bool* outShowSamples = nullptr);
};
 
#endif