WaveTrackShifter.cpp

Go to the documentation of this file.

 
#include "../../../ui/TimeShiftHandle.h"
#include "ViewInfo.h"
#include "WaveClip.h"
#include "WaveTrack.h"
#include "WaveChannelView.h"
 
#include <cassert>
#include <unordered_set>
 
class WaveTrackShifter final : public TrackShifter {
public:
   WaveTrackShifter(WaveTrack &track)
      : mpTrack{ track.SharedPointer<WaveTrack>() }
   {
      InitIntervals();
   }
   ~WaveTrackShifter() override {}
   Track &GetTrack() const override {
      return *mpTrack;
   }
 
   HitTestResult HitTest(
      double time, const ViewInfo &viewInfo, HitTestParams* params) override
   {
      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;
   }
 
   void SelectInterval(TimeInterval interval) override
   {
      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;
      });
   }
 
   bool SyncLocks() override { return true; }
 
   bool MayMigrateTo(Track &other) override
   {
      return TrackShifter::CommonMayMigrateTo(other);
   }
 
   double HintOffsetLarger(double desiredOffset) override
   {
      // 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;
   }
 
   double QuantizeOffset( double desiredOffset ) override
   {
      const auto rate = mpTrack->GetRate();
      // set it to a sample point
      return rint(desiredOffset * rate) / rate;
   }
 
   double AdjustOffsetSmaller(double desiredOffset) override
   {
      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;
   }
 
   Intervals Detach() override
   {
      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);
   }
 
   bool AdjustFit(
      const Track &otherTrack, const Intervals &intervals,
      double &desiredOffset, double tolerance) override
   {
      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;
   }
 
   bool Attach(Intervals intervals, double offset) override
   {
      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;
   }
 
   bool FinishMigration() override
   {
      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;
   }
 
   void DoHorizontalOffset(double offset) override
   {
      for (auto &interval : MovingIntervals()) {
         auto &clip = static_cast<WaveTrack::Interval&>(*interval);
         clip.ShiftBy(offset);
      }
   }
 
 
   // Ensure that t0 is still within the clip which it was in before the move.
   // This corrects for any rounding errors.
   double AdjustT0(double t0) const override
   {
      if (MovingIntervals().empty())
         return t0;
      else {
         auto &clip =
            static_cast<WaveTrack::Interval&>(*MovingIntervals()[0]);
         t0 = std::clamp(t0, clip.GetPlayStartTime(), clip.GetPlayEndTime());
      }
      return t0;
   }
 
private:
   const std::shared_ptr<WaveTrack> mpTrack;
 
   // Clips that may require resampling
   std::vector<WaveTrack::IntervalHolder> mMigrated;
};
 
using MakeWaveTrackShifter = MakeTrackShifter::Override<WaveTrack>;
DEFINE_ATTACHED_VIRTUAL_OVERRIDE(MakeWaveTrackShifter) {
   return [](WaveTrack &track, AudacityProject&) {
      return std::make_unique<WaveTrackShifter>(track);
   };
}