WaveTrackShifter Class Reference

Inheritance diagram for WaveTrackShifter:

Collaboration diagram for WaveTrackShifter:

Public Member Functions
	WaveTrackShifter (WaveTrack &track)
	~WaveTrackShifter () override
Track &	GetTrack () const override
	There is always an associated track. More...
HitTestResult	HitTest (double time, const ViewInfo &viewInfo, HitTestParams *params) override
	Decide how shift behaves, based on the track that is clicked in. More...
void	SelectInterval (TimeInterval interval) override
	Notifies the shifter that a region is selected, so it may update its fixed and moving intervals. More...
bool	SyncLocks () override
	Whether unfixing of an interval should propagate to all overlapping intervals in the sync lock group. More...
bool	MayMigrateTo (Track &other) override
double	HintOffsetLarger (double desiredOffset) override
	Given amount to shift by horizontally, maybe adjust it from zero to suggest minimum distance. More...
double	QuantizeOffset (double desiredOffset) override
	Given amount to shift by horizontally, do any preferred rounding, before placement constraint checks. More...
double	AdjustOffsetSmaller (double desiredOffset) override
	Given amount to shift by horizontally, maybe adjust it toward zero to meet placement constraints. More...
Intervals	Detach () override
	Remove all moving intervals from the track, if possible. More...
bool	AdjustFit (const Track &otherTrack, const Intervals &intervals, double &desiredOffset, double tolerance) override
bool	Attach (Intervals intervals, double offset) override
	Put moving intervals into the track, which may have migrated from another. More...
bool	FinishMigration () override
	When dragging is done, do (once) the final steps of migration (which may be expensive) More...
void	DoHorizontalOffset (double offset) override
double	AdjustT0 (double t0) const override
Public Member Functions inherited from TrackShifter
	TrackShifter ()
	TrackShifter (const TrackShifter &)=delete
TrackShifter &	operator= (const TrackShifter &)=delete
virtual	~TrackShifter ()=0
virtual Track &	GetTrack () const =0
	There is always an associated track. More...
virtual HitTestResult	HitTest (double time, const ViewInfo &viewInfo, HitTestParams *pParams=nullptr)=0
	Decide how shift behaves, based on the track that is clicked in. More...
const Intervals &	FixedIntervals () const
	Return special intervals of the track that will not move. More...
const Intervals &	MovingIntervals () const
	Return special intervals of the track that may move. More...
void	UnfixIntervals (std::function< bool(const ChannelGroupInterval &)> pred)
	Change intervals satisfying a predicate from fixed to moving. More...
void	UnfixAll ()
	Change all intervals from fixed to moving. More...
virtual void	SelectInterval (TimeInterval interval)
	Notifies the shifter that a region is selected, so it may update its fixed and moving intervals. More...
virtual bool	SyncLocks ()=0
	Whether unfixing of an interval should propagate to all overlapping intervals in the sync lock group. More...
virtual double	HintOffsetLarger (double desiredOffset)
	Given amount to shift by horizontally, maybe adjust it from zero to suggest minimum distance. More...
virtual double	QuantizeOffset (double desiredOffset)
	Given amount to shift by horizontally, do any preferred rounding, before placement constraint checks. More...
virtual double	AdjustOffsetSmaller (double desiredOffset)
	Given amount to shift by horizontally, maybe adjust it toward zero to meet placement constraints. More...
virtual bool	MayMigrateTo (Track &otherTrack)
virtual Intervals	Detach ()
	Remove all moving intervals from the track, if possible. More...
virtual bool	AdjustFit (const Track &otherTrack, const Intervals &intervals, double &desiredOffset, double tolerance)
virtual bool	Attach (Intervals intervals, double offset)
	Put moving intervals into the track, which may have migrated from another. More...
virtual bool	FinishMigration ()
	When dragging is done, do (once) the final steps of migration (which may be expensive) More...
virtual void	DoHorizontalOffset (double offset)
virtual double	AdjustT0 (double t0) const

Private Attributes
const std::shared_ptr< WaveTrack >	mpTrack
std::vector< WaveTrack::IntervalHolder >	mMigrated

Additional Inherited Members
Public Types inherited from TrackShifter
enum class	HitTestResult { Miss , Selection , Intervals , Track }
	Possibilities for HitTest on the clicked track. More...
using	Intervals = std::vector< std::shared_ptr< ChannelGroupInterval > >
Protected Member Functions inherited from TrackShifter
void	CommonSelectInterval (TimeInterval interval)
bool	CommonMayMigrateTo (Track &otherTrack)
void	InitIntervals ()
	Derived class constructor can initialize all intervals reported by the track as fixed, none moving. More...
bool	AllFixed () const
Protected Attributes inherited from TrackShifter
Intervals	mFixed
Intervals	mMoving

Detailed Description

Definition at line 15 of file WaveTrackShifter.cpp.

Constructor & Destructor Documentation

WaveTrackShifter()

WaveTrackShifter::WaveTrackShifter ( WaveTrack &  track )

inline

Definition at line 17 of file WaveTrackShifter.cpp.

      : mpTrack{ track.SharedPointer<WaveTrack>() }
   {
      InitIntervals();
   }

References TrackShifter::InitIntervals().

Here is the call graph for this function:

~WaveTrackShifter()

WaveTrackShifter::~WaveTrackShifter ( )

inlineoverride

Definition at line 22 of file WaveTrackShifter.cpp.

{}

Member Function Documentation

AdjustFit()

bool WaveTrackShifter::AdjustFit ( const Track &  otherTrack, const Intervals &  intervals, double &  desiredOffset, double  tolerance  )

inlineoverridevirtual

Test whether intervals can fit into another track, maybe adjusting the offset slightly

Default implementation does nothing and returns false

Parameters

	intervals	Assume these came from Detach() and only after MayMigrateTo returned true for otherTrack
[in,out]	desiredOffset
	tolerance	Nonnegative ceiling for allowed changes in fabs(desiredOffset)

Reimplemented from TrackShifter.

Definition at line 133 of file WaveTrackShifter.cpp.

   {
      bool ok = true;
      auto pOtherWaveTrack = static_cast<const WaveTrack*>(&otherTrack);
      for (auto &interval: intervals) {
         auto &data = static_cast<WaveTrack::Interval&>(*interval);
         if (!(ok = pOtherWaveTrack->CanInsertClip(data, desiredOffset, tolerance)))
            break;
      }
      return ok;
   }

AdjustOffsetSmaller()

double WaveTrackShifter::AdjustOffsetSmaller ( double  desiredOffset )

inlineoverridevirtual

Given amount to shift by horizontally, maybe adjust it toward zero to meet placement constraints.

Default implementation returns the argument

Postcondition

fabs(r) <= fabs(desiredOffset)

r * desiredOffset >= 0 (i.e. signs are not opposite)

(where r is return value)

Reimplemented from TrackShifter.

Definition at line 109 of file WaveTrackShifter.cpp.

   {
      std::vector<WaveTrack::Interval *> movingClips;
      for (auto &interval : MovingIntervals()) {
         auto &data = static_cast<WaveTrack::Interval&>(*interval);
         movingClips.push_back(&data);
      }
      double newAmount = 0;
      mpTrack->CanOffsetClips(movingClips, desiredOffset, &newAmount);
      return newAmount;
   }

References TrackShifter::MovingIntervals(), and mpTrack.

Here is the call graph for this function:

AdjustT0()

double WaveTrackShifter::AdjustT0 ( double  t0 ) const

inlineoverridevirtual

Reimplemented from TrackShifter.

Definition at line 182 of file WaveTrackShifter.cpp.

   {
      if (MovingIntervals().empty())
         return t0;
      else {
         auto &clip =
            static_cast<WaveTrack::Interval&>(*MovingIntervals()[0]);
         t0 = std::clamp(t0, clip.GetPlayStartTime(), clip.GetPlayEndTime());
      }
      return t0;
   }

References TrackShifter::MovingIntervals().

Here is the call graph for this function:

Attach()

bool WaveTrackShifter::Attach ( Intervals  intervals, double  offset  )

inlineoverridevirtual

Put moving intervals into the track, which may have migrated from another.

The ChannelGroupInterval objects pointed to by intervals will not be used again. The shifter should repopupate mMoving with new ChannelGroupInterval objects to reflect the new state of the track. In case of failure, track states are unspecified

Returns

success Default implementation does nothing and returns true

Reimplemented from TrackShifter.

Definition at line 147 of file WaveTrackShifter.cpp.

   {
      for (auto interval : intervals) {
         auto data = std::static_pointer_cast<WaveTrack::Interval>(interval);
         mpTrack->InsertInterval(data, false);
         mMigrated.push_back(data);
         if (offset != .0)
            data->ShiftBy(offset);
         mMoving.emplace_back(std::move(interval));
      }
      return true;
   }

References mMigrated, TrackShifter::mMoving, and mpTrack.

Detach()

Intervals WaveTrackShifter::Detach ( )

inlineoverridevirtual

Remove all moving intervals from the track, if possible.

Default implementation does nothing

Reimplemented from TrackShifter.

Definition at line 121 of file WaveTrackShifter.cpp.

   {
      for (auto &interval: mMoving) {
         auto pClip = std::static_pointer_cast<WaveTrack::Interval>(interval);
         mpTrack->RemoveInterval(pClip);
         mMigrated.erase(
            std::remove(mMigrated.begin(), mMigrated.end(), pClip),
            mMigrated.end());
      }
      return std::move(mMoving);
   }

References mMigrated, TrackShifter::mMoving, and mpTrack.

DoHorizontalOffset()

void WaveTrackShifter::DoHorizontalOffset ( double  offset )

inlineoverridevirtual

Shift all moving intervals horizontally Default moves the whole track, provided !AllFixed(); else does nothing

Reimplemented from TrackShifter.

Definition at line 171 of file WaveTrackShifter.cpp.

   {
      for (auto &interval : MovingIntervals()) {
         auto &clip = static_cast<WaveTrack::Interval&>(*interval);
         clip.ShiftBy(offset);
      }
   }

References TrackShifter::MovingIntervals(), and WaveClip::ShiftBy().

Here is the call graph for this function:

FinishMigration()

bool WaveTrackShifter::FinishMigration ( )

inlineoverridevirtual

When dragging is done, do (once) the final steps of migration (which may be expensive)

Returns

success

In case of failure, track states are unspecified

Default implementation does nothing and returns true

Reimplemented from TrackShifter.

Definition at line 160 of file WaveTrackShifter.cpp.

   {
      auto rate = mpTrack->GetRate();
      for (auto pClip : mMigrated) {
         // Now that user has dropped the clip into a different track,
         // make sure the sample rate matches the destination track.
         pClip->Resample(rate);
      }
      return true;
   }

References mMigrated, and mpTrack.

GetTrack()

Track & WaveTrackShifter::GetTrack ( ) const

inlineoverridevirtual

There is always an associated track.

Implements TrackShifter.

Definition at line 23 of file WaveTrackShifter.cpp.

                                    {
      return *mpTrack;
   }

References mpTrack.

HintOffsetLarger()

double WaveTrackShifter::HintOffsetLarger ( double  desiredOffset )

inlineoverridevirtual

Given amount to shift by horizontally, maybe adjust it from zero to suggest minimum distance.

Any interval placement constraints, not necessarily met at the suggested offset Default implementation returns the argument

Postcondition

fabs(r) >= fabs(desiredOffset)

r * desiredOffset >= 0 (i.e. signs are not opposite)

(where r is return value)

Reimplemented from TrackShifter.

Definition at line 88 of file WaveTrackShifter.cpp.

   {
      // set it to a sample point, and minimum of 1 sample point
      bool positive = (desiredOffset > 0);
      if (!positive)
         desiredOffset *= -1;
      double nSamples = rint(mpTrack->GetRate() * desiredOffset);
      nSamples = std::max(nSamples, 1.0);
      desiredOffset = nSamples / mpTrack->GetRate();
      if (!positive)
         desiredOffset *= -1;
      return desiredOffset;
   }

References mpTrack, and staffpad::audio::simd::rint().

Here is the call graph for this function:

HitTest()

HitTestResult WaveTrackShifter::HitTest ( double  time, const ViewInfo &  viewInfo, HitTestParams *  pParams  )

inlineoverridevirtual

Decide how shift behaves, based on the track that is clicked in.

If the return value is Intervals or Selection, then some intervals may be marked moving as a side effect

Precondition

!pParams || (time == pParams->viewInfo.PositionToTime(pParams->xx, pParams->rect.x))

Parameters

time	A time value to test
pParams	Optional extra information

Implements TrackShifter.

Definition at line 27 of file WaveTrackShifter.cpp.

   {
      const auto pClip = [&]() -> std::shared_ptr<WaveClip> {
         for (auto clip : mpTrack->Intervals())
            if ((
               // y coordinates in this HitTest come from the third argument
               // The channel of the interval is used only for times
               params && WaveChannelView::HitTest(
                  *clip, viewInfo, params->rect, { params->xx, params->yy })
            ) || (
               // WithinPlayRegion misses first sample, which breaks moving
               // "selected" clip. Probable WithinPlayRegion should be fixed
               // instead?
                clip->GetPlayStartTime() <= time &&
                 time < clip->GetPlayEndTime()
            ))
               return clip;
         return {};
      }();
 
      if (!pClip)
         return HitTestResult::Miss;
 
      auto t0 = viewInfo.selectedRegion.t0();
      auto t1 = viewInfo.selectedRegion.t1();
      if (mpTrack->IsSelected() && time >= t0 && time < t1) {
         // Unfix maybe many intervals (at least one because of test above)
         SelectInterval({ t0, t1 });
         return HitTestResult::Selection;
      }
 
      // Select just one interval
      UnfixIntervals([&](const auto &interval){
         return &interval == pClip.get();
      });
 
      return HitTestResult::Intervals;
   }

References WaveChannelView::HitTest(), TrackShifter::Intervals, TrackShifter::Miss, mpTrack, params, ViewInfo::selectedRegion, SelectInterval(), TrackShifter::Selection, NotifyingSelectedRegion::t0(), NotifyingSelectedRegion::t1(), and TrackShifter::UnfixIntervals().

Here is the call graph for this function:

MayMigrateTo()

bool WaveTrackShifter::MayMigrateTo ( Track &  otherTrack )

inlineoverridevirtual

Whether intervals may migrate to the other track, not yet checking all placement constraints

Default implementation returns false

Reimplemented from TrackShifter.

Definition at line 83 of file WaveTrackShifter.cpp.

   {
      return TrackShifter::CommonMayMigrateTo(other);
   }

References TrackShifter::CommonMayMigrateTo().

Here is the call graph for this function:

QuantizeOffset()

double WaveTrackShifter::QuantizeOffset ( double  desiredOffset )

inlineoverridevirtual

Given amount to shift by horizontally, do any preferred rounding, before placement constraint checks.

Default implementation returns argument

Reimplemented from TrackShifter.

Definition at line 102 of file WaveTrackShifter.cpp.

   {
      const auto rate = mpTrack->GetRate();
      // set it to a sample point
      return rint(desiredOffset * rate) / rate;
   }

References mpTrack, and staffpad::audio::simd::rint().

Here is the call graph for this function:

SelectInterval()

void WaveTrackShifter::SelectInterval ( TimeInterval  interval )

inlineoverridevirtual

Notifies the shifter that a region is selected, so it may update its fixed and moving intervals.

Default behavior: if any part of the track is selected, unfix all parts of it.

Reimplemented from TrackShifter.

Definition at line 67 of file WaveTrackShifter.cpp.

   {
      UnfixIntervals([&](auto &myInterval){
         // Use a slightly different test from CommonSelectInterval, rounding times
         // to exact samples according to the clip's rate
         auto &clip = static_cast<const WaveTrack::Interval&>(myInterval);
         const auto c0 = mpTrack->TimeToLongSamples(clip.GetPlayStartTime());
         const auto c1 = mpTrack->TimeToLongSamples(clip.GetPlayEndTime());
         return
             mpTrack->TimeToLongSamples(interval.Start()) < c1 &&
             mpTrack->TimeToLongSamples(interval.End()) > c0;
      });
   }

References TrackShifter::TimeInterval::End(), mpTrack, TrackShifter::TimeInterval::Start(), and TrackShifter::UnfixIntervals().

Referenced by HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

SyncLocks()

bool WaveTrackShifter::SyncLocks ( )

inlineoverridevirtual

Whether unfixing of an interval should propagate to all overlapping intervals in the sync lock group.

Implements TrackShifter.

Definition at line 81 of file WaveTrackShifter.cpp.

{ return true; }

Member Data Documentation

mMigrated

std::vector<WaveTrack::IntervalHolder> WaveTrackShifter::mMigrated

private

Definition at line 198 of file WaveTrackShifter.cpp.

Referenced by Attach(), Detach(), and FinishMigration().

mpTrack

const std::shared_ptr<WaveTrack> WaveTrackShifter::mpTrack

private

Definition at line 195 of file WaveTrackShifter.cpp.

Referenced by AdjustOffsetSmaller(), Attach(), Detach(), FinishMigration(), GetTrack(), HintOffsetLarger(), HitTest(), QuantizeOffset(), and SelectInterval().

---

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

• WaveTrackShifter.cpp