SampleHandle.cpp

Go to the documentation of this file.

/**********************************************************************
 
Audacity: A Digital Audio Editor
 
SampleHandle.cpp
 
Paul Licameli split from TrackPanel.cpp
 
**********************************************************************/
 
 
#include "SampleHandle.h"
 
#include <algorithm>
#include <wx/gdicmn.h>
 
#include "Envelope.h"
#include "../../../../HitTestResult.h"
#include "WaveformSettings.h"
#include "ProjectAudioIO.h"
#include "ProjectHistory.h"
#include "../../../../RefreshCode.h"
#include "../../../../TrackArt.h"
#include "../../../../TrackArtist.h"
#include "../../../../TrackPanelMouseEvent.h"
#include "UndoManager.h"
#include "ViewInfo.h"
#include "WaveChannelUtilities.h"
#include "WaveClip.h"
#include "WaveTrack.h"
#include "../../../../../images/Cursors.h"
#include "AudacityMessageBox.h"
#include "prefs/WaveformScale.h"
 
 
static const int SMOOTHING_KERNEL_RADIUS = 3;
static const int SMOOTHING_BRUSH_RADIUS = 5;
static const double SMOOTHING_PROPORTION_MAX = 0.7;
static const double SMOOTHING_PROPORTION_MIN = 0.0;
 
SampleHandle::SampleHandle(const std::shared_ptr<WaveChannel> &pTrack)
   : mClickedTrack{ pTrack }
{
}
 
void SampleHandle::Enter(bool, AudacityProject *)
{
#ifdef EXPERIMENTAL_TRACK_PANEL_HIGHLIGHTING
   mChangeHighlight = RefreshCode::RefreshCell;
#endif
}
 
HitTestPreview SampleHandle::HitPreview
(const wxMouseState &state, const AudacityProject *WXUNUSED(pProject), bool unsafe)
{
   static auto disabledCursor =
      ::MakeCursor(wxCURSOR_NO_ENTRY, DisabledCursorXpm, 16, 16);
   static wxCursor smoothCursor{ wxCURSOR_SPRAYCAN };
   static auto pencilCursor =
      ::MakeCursor(wxCURSOR_PENCIL, DrawCursorXpm, 12, 22);
 
   // TODO:  message should also mention the brush.  Describing the modifier key
   // (alt, or other) varies with operating system.
   auto message = XO("Click and drag to edit the samples");
 
   return {
      message,
      (unsafe
       ? &*disabledCursor
       : (state.AltDown()
          ? &smoothCursor
          : &*pencilCursor))
   };
}
 
UIHandlePtr SampleHandle::HitAnywhere(std::weak_ptr<SampleHandle> &holder,
 const wxMouseState &, const std::shared_ptr<WaveChannel> &pChannel)
{
   auto result = std::make_shared<SampleHandle>(pChannel);
   result = AssignUIHandlePtr(holder, result);
   return result;
}
 
namespace {
   inline double adjustTime(const WaveChannel& wt, double time)
   {
      // Round to an exact sample time
      const auto clip = WaveChannelUtilities::GetClipAtTime(wt, time);
      if (!clip)
         return wt.SnapToSample(time);
      const auto sampleOffset =
         clip->TimeToSamples(time - clip->GetPlayStartTime());
      return clip->SamplesToTime(sampleOffset) + clip->GetPlayStartTime();
   }
 
   // Is the sample horizontally nearest to the cursor sufficiently separated
   // from its neighbors that the pencil tool should be allowed to drag it?
   bool SampleResolutionTest(
      const ViewInfo& viewInfo, const WaveChannelInterval& clip,
      const ZoomInfo::Intervals& intervals)
   {
      // Require more than 3 pixels per sample
      const auto xx = std::max<ZoomInfo::int64>(
         0, viewInfo.TimeToPosition(clip.GetPlayStartTime()));
      const double rate = clip.GetRate() / clip.GetStretchRatio();
      ZoomInfo::Intervals::const_iterator it = intervals.begin(),
         end = intervals.end(), prev;
      wxASSERT(it != end && it->position == 0);
      do
         prev = it++;
      while (it != end && it->position <= xx);
      const double threshold = 3 * rate;
      // three times as many pixels per second, as samples
      return prev->averageZoom > threshold;
   }
}
 
UIHandlePtr SampleHandle::HitTest(std::weak_ptr<SampleHandle> &holder,
 const wxMouseState &state, const wxRect &rect,
 const AudacityProject *pProject, const std::shared_ptr<WaveChannel> &pChannel)
{
   using namespace WaveChannelUtilities;
   const auto &viewInfo = ViewInfo::Get( *pProject );
 
   if (!pChannel)
      return {};
   auto &waveChannel = *pChannel;
   const auto time = viewInfo.PositionToTime(state.m_x, rect.x);
   const auto clickedClip =
      WaveChannelUtilities::GetClipAtTime(waveChannel, time);
   if (!clickedClip)
      return {};
 
   const double tt = adjustTime(waveChannel, time);
   const auto intervals = viewInfo.FindIntervals(rect.width);
   if (!SampleResolutionTest(viewInfo, *clickedClip, intervals))
      return {};
 
   // Just get one sample.
   float oneSample;
   constexpr auto mayThrow = false;
   if (!WaveChannelUtilities::GetFloatAtTime(waveChannel,
      tt, oneSample, mayThrow))
      return {};
 
   // Get y distance of envelope point from center line (in pixels).
   auto &cache = WaveformScale::Get(waveChannel);
   float zoomMin, zoomMax;
   cache.GetDisplayBounds(zoomMin, zoomMax);
 
   double envValue = 1.0;
   if (const auto env =
      WaveChannelUtilities::GetEnvelopeAtTime(waveChannel, time))
      // Calculate sample as it would be rendered
      envValue = env->GetValue(tt);
 
   auto &settings = WaveformSettings::Get(waveChannel);
   const bool dB = !settings.isLinear();
   int yValue = GetWaveYPos(oneSample * envValue,
      zoomMin, zoomMax,
      rect.height, dB, true,
      settings.dBRange, false) + rect.y;
 
   // Get y position of mouse (in pixels)
   int yMouse = state.m_y;
 
   // Perhaps yTolerance should be put into preferences?
   const int yTolerance = 10; // More tolerance on samples than on envelope.
   if (abs(yValue - yMouse) >= yTolerance)
      return {};
 
   return HitAnywhere(holder, state, pChannel);
}
 
SampleHandle::~SampleHandle()
{
}
 
std::shared_ptr<const Track> SampleHandle::FindTrack() const
{
   return TrackFromChannel(mClickedTrack);
}
 
UIHandle::Result SampleHandle::Click
(const TrackPanelMouseEvent &evt, AudacityProject *pProject)
{
   using namespace RefreshCode;
   using namespace WaveChannelUtilities;
   const bool unsafe = ProjectAudioIO::Get( *pProject ).IsAudioActive();
   if ( unsafe )
      return Cancelled;
 
   const wxMouseEvent &event = evt.event;
   const wxRect &rect = evt.rect;
   const auto &viewInfo = ViewInfo::Get( *pProject );
 
   const double t0 = viewInfo.PositionToTime(event.m_x, rect.x);
   const auto pTrack = mClickedTrack.get();
   mClickedClip = WaveChannelUtilities::GetClipAtTime(*pTrack, t0);
   if (!mClickedClip)
      return Cancelled;
 
   const auto intervals = viewInfo.FindIntervals(rect.width);
   if (!SampleResolutionTest(viewInfo, *mClickedClip, intervals))
   {
      AudacityMessageBox(
         XO("To use Draw, zoom in further until you can see the individual samples."),
         XO("Draw Tool"));
      return Cancelled;
   }
 
   mRect = rect;
 
   //convert t0 to samples
   mClickedStartPixel = viewInfo.TimeToPosition(t0);
 
   //Determine how drawing should occur.  If alt is down,
   //do a smoothing, instead of redrawing.
   if (event.m_altDown)
   {
      mAltKey = true;
      //*************************************************
      //***  ALT-DOWN-CLICK (SAMPLE SMOOTHING)        ***
      //*************************************************
      //
      //  Smoothing works like this:  There is a smoothing kernel radius constant that
      //  determines how wide the averaging window is.  Plus, there is a smoothing brush radius,
      //  which determines how many pixels wide around the selected pixel this smoothing is applied.
      //
      //  Samples will be replaced by a mixture of the original points and the smoothed points,
      //  with a triangular mixing probability whose value at the center point is
      //  SMOOTHING_PROPORTION_MAX and at the far bounds is SMOOTHING_PROPORTION_MIN
 
      //Get the region of samples around the selected point
      size_t sampleRegionSize = 1 + 2 * (SMOOTHING_KERNEL_RADIUS + SMOOTHING_BRUSH_RADIUS);
      Floats sampleRegion{ sampleRegionSize };
      Floats newSampleRegion{ 1 + 2 * (size_t)SMOOTHING_BRUSH_RADIUS };
 
      //Get a sample from the clip to do some tricks on.
      constexpr auto mayThrow = false;
      const auto sampleRegionRange = GetFloatsCenteredAroundTime(*mClickedTrack,
            t0, sampleRegion.get(),
            SMOOTHING_KERNEL_RADIUS + SMOOTHING_BRUSH_RADIUS, mayThrow);
 
      //Go through each point of the smoothing brush and apply a smoothing operation.
      for (auto jj = -SMOOTHING_BRUSH_RADIUS; jj <= SMOOTHING_BRUSH_RADIUS; ++jj) {
         float sumOfSamples = 0;
         for (auto ii = -SMOOTHING_KERNEL_RADIUS; ii <= SMOOTHING_KERNEL_RADIUS; ++ii) {
            //Go through each point of the smoothing kernel and find the average
            const auto sampleRegionIndex =
               ii + jj + SMOOTHING_KERNEL_RADIUS + SMOOTHING_BRUSH_RADIUS;
            const auto inRange = sampleRegionRange.first <= sampleRegionIndex &&
                                 sampleRegionIndex < sampleRegionRange.second;
            if (!inRange)
               continue;
            //The average is a weighted average, scaled by a weighting kernel that is simply triangular
            // A triangular kernel across N items, with a radius of R ( 2 R + 1 points), if the farthest:
            // points have a probability of a, the entire triangle has total probability of (R + 1)^2.
            //      For sample number ii and middle brush sample M,  (R + 1 - abs(M-ii))/ ((R+1)^2) gives a
            //   legal distribution whose total probability is 1.
            //
            //
            //                weighting factor                       value
            sumOfSamples += (SMOOTHING_KERNEL_RADIUS + 1 - abs(ii)) *
                            sampleRegion[sampleRegionIndex];
         }
         newSampleRegion[jj + SMOOTHING_BRUSH_RADIUS] =
            sumOfSamples /
               ((SMOOTHING_KERNEL_RADIUS + 1) *(SMOOTHING_KERNEL_RADIUS + 1));
      }
 
 
      // Now that the NEW sample levels are determined, go through each and mix it appropriately
      // with the original point, according to a 2-part linear function whose center has probability
      // SMOOTHING_PROPORTION_MAX and extends out SMOOTHING_BRUSH_RADIUS, at which the probability is
      // SMOOTHING_PROPORTION_MIN.  _MIN and _MAX specify how much of the smoothed curve make it through.
 
      float prob;
 
      for (auto jj = -SMOOTHING_BRUSH_RADIUS; jj <= SMOOTHING_BRUSH_RADIUS; ++jj) {
 
         prob =
            SMOOTHING_PROPORTION_MAX -
            (float)abs(jj) / SMOOTHING_BRUSH_RADIUS *
               (SMOOTHING_PROPORTION_MAX - SMOOTHING_PROPORTION_MIN);
 
         newSampleRegion[jj + SMOOTHING_BRUSH_RADIUS] =
            newSampleRegion[jj + SMOOTHING_BRUSH_RADIUS] * prob +
            sampleRegion[SMOOTHING_BRUSH_RADIUS + SMOOTHING_KERNEL_RADIUS + jj] *
               (1 - prob);
      }
      // Set a range of samples around the mouse event
      // Don't require dithering later
      SetFloatsCenteredAroundTime(*mClickedTrack,
         t0, newSampleRegion.get(), SMOOTHING_BRUSH_RADIUS,
         narrowestSampleFormat);
 
      // mLastDragSampleValue will not be used
   }
   else
   {
      mAltKey = false;
      //*************************************************
      //***   PLAIN DOWN-CLICK (NORMAL DRAWING)       ***
      //*************************************************
 
      //Otherwise (e.g., the alt button is not down) do normal redrawing, based on the mouse position.
      const float newLevel = FindSampleEditingLevel(event, viewInfo, t0);
 
      //Set the sample to the point of the mouse event
      // Don't require dithering later
 
      SetFloatAtTime(*mClickedTrack, t0, newLevel, narrowestSampleFormat);
 
      mLastDragSampleValue = newLevel;
   }
 
   //Set the member data structures for drawing
   mLastDragPixel = mClickedStartPixel;
 
   // Sample data changed on either branch, so refresh the track display.
   return RefreshCell;
}
 
namespace
{
size_t GetLastEditableClipStartingFromNthClip(size_t n, bool forward,
   const WaveChannelUtilities::ClipPointers& sortedClips,
   const ViewInfo& viewInfo, const ZoomInfo::Intervals& intervals)
{
   assert(n < sortedClips.size());
   const auto increment = forward ? 1 : -1;
   int last = n + increment;
   const auto limit = forward ? sortedClips.size() : -1;
   while (last != limit)
   {
      if (!SampleResolutionTest(viewInfo, *sortedClips[last], intervals))
         break;
      last += increment;
   }
   last -= increment;
   assert(last >= 0 && last < sortedClips.size());
   return last;
}
} // namespace
 
UIHandle::Result SampleHandle::Drag
(const TrackPanelMouseEvent &evt, AudacityProject *pProject)
{
   using namespace RefreshCode;
   using namespace WaveChannelUtilities;
   const wxMouseEvent &event = evt.event;
   const auto &viewInfo = ViewInfo::Get( *pProject );
 
   const bool unsafe = ProjectAudioIO::Get( *pProject ).IsAudioActive();
   if (unsafe)
   {
      this->Cancel(pProject);
      return RefreshCell | Cancelled;
   }
 
   // There must have been some clicking before dragging ...
   assert(mClickedTrack && mClickedClip);
   if (!(mClickedTrack && mClickedClip))
      return Cancelled;
 
   //*************************************************
   //***    DRAG-DRAWING                           ***
   //*************************************************
 
   //No dragging effects if the alt key is down--
   //Don't allow left-right dragging for smoothing operation
   if (mAltKey)
      return RefreshNone;
 
   const double t0 = viewInfo.PositionToTime(mLastDragPixel);
   const double t1 = viewInfo.PositionToTime(event.m_x, mRect.x);
 
   const int x1 =
      event.m_controlDown ? mClickedStartPixel : viewInfo.TimeToPosition(t1);
   const float newLevel = FindSampleEditingLevel(event, viewInfo, t0);
   const auto start = std::min(t0, t1);
   const auto end = std::max(t0, t1);
 
   // Starting from the originally clicked clip, restrict the editing boundaries
   // to the succession of clips with visible samples. If, of clips A, B and C,
   // only B had invisible samples, it'd mean one could not drag-draw from A
   // into C, but that probably isn't a behavior worthwhile much implementation
   // complications.
   const auto clips = WaveChannelUtilities::SortedClipArray(*mClickedTrack);
   const auto iter = std::find_if(clips.begin(), clips.end(),
      // Compare the intervals, not the pointers to them
      [this](const auto &pClip){ return *pClip == *mClickedClip; });
   const auto clickedClipIndex = std::distance(clips.begin(), iter);
   constexpr auto forward = true;
   const auto intervals = viewInfo.FindIntervals(mRect.width);
   const size_t leftmostEditable = GetLastEditableClipStartingFromNthClip(
      clickedClipIndex, !forward, clips, viewInfo, intervals);
   const size_t rightmostEditable = GetLastEditableClipStartingFromNthClip(
      clickedClipIndex, forward, clips, viewInfo, intervals);
 
   const auto editStart =
      std::max(start, clips[leftmostEditable]->GetPlayStartTime());
   const auto editEnd =
      std::min(end, clips[rightmostEditable]->GetPlayEndTime());
 
   // For fast pencil movements covering more than one sample between two
   // updates, we draw a line going from v0 at t0 to v1 at t1.
   const auto interpolator = [t0, t1, v0 = mLastDragSampleValue,
                              v1 = newLevel](double t) {
      if (t0 == t1)
         return v1;
      const auto gradient = (v1 - v0) / (t1 - t0);
      const auto value = static_cast<float>(gradient * (t - t0) + v0);
      // t may be outside t0 and t1, and we don't want to extrapolate.
      return std::clamp(value, std::min(v0, v1), std::max(v0, v1));
   };
   SetFloatsWithinTimeRange(*mClickedTrack,
      editStart, editEnd, interpolator, narrowestSampleFormat);
 
   mLastDragPixel = x1;
   mLastDragSampleValue = newLevel;
 
   return RefreshCell;
}
 
HitTestPreview SampleHandle::Preview
(const TrackPanelMouseState &st, AudacityProject *pProject)
{
   const bool unsafe = ProjectAudioIO::Get( *pProject ).IsAudioActive();
   return HitPreview(st.state, pProject, unsafe);
}
 
UIHandle::Result SampleHandle::Release
(const TrackPanelMouseEvent &, AudacityProject *pProject,
 wxWindow *)
{
   const bool unsafe = ProjectAudioIO::Get( *pProject ).IsAudioActive();
   if (unsafe)
      return this->Cancel(pProject);
 
   //*************************************************
   //***    UP-CLICK  (Finish drawing)             ***
   //*************************************************
   //On up-click, send the state to the undo stack
   mClickedTrack.reset();       //Set this to NULL so it will catch improper drag events.
   mClickedClip = nullptr;
   ProjectHistory::Get( *pProject ).PushState(XO("Moved Samples"),
      XO("Sample Edit"),
      UndoPush::CONSOLIDATE);
 
   // No change to draw since last drag
   return RefreshCode::RefreshNone;
}
 
UIHandle::Result SampleHandle::Cancel(AudacityProject *pProject)
{
   mClickedTrack.reset();
   ProjectHistory::Get( *pProject ).RollbackState();
   return RefreshCode::RefreshCell;
}
 
float SampleHandle::FindSampleEditingLevel
   (const wxMouseEvent &event, const ViewInfo &viewInfo, double t0)
{
   using namespace WaveChannelUtilities;
   // Calculate where the mouse is located vertically (between +/- 1)
   float zoomMin, zoomMax;
   auto &cache = WaveformScale::Get(*mClickedTrack);
   cache.GetDisplayBounds(zoomMin, zoomMax);
 
   const int yy = event.m_y - mRect.y;
   const int height = mRect.GetHeight();
   auto &settings = WaveformSettings::Get(*mClickedTrack);
   const bool dB = !settings.isLinear();
   float newLevel =
      ::ValueOfPixel(yy, height, false, dB,
         settings.dBRange, zoomMin, zoomMax);
 
   //Take the envelope into account
   const auto time = viewInfo.PositionToTime(event.m_x, mRect.x);
   if (const auto env = GetEnvelopeAtTime(*mClickedTrack, time)){
      // Calculate sample as it would be rendered
      double envValue = env->GetValue(t0);
      if (envValue > 0)
         newLevel /= envValue;
      else
         newLevel = 0;
 
      //Make sure the NEW level is between +/-1
      newLevel = std::max(-1.0f, std::min(1.0f, newLevel));
   }
 
   return newLevel;
}