Spectral selection cursor and mode selection changes from Paul Licameli.

This also now shows a new green 'play cursor' when ctrl is held down on wave track, and shift being held down is signalled by a cursor change to finger-pointer too.

I also accidentally enabled EXPERIMENTAL_MIDI_OUT.  We may disable that in December for release.  Leaving it in for now.

images/Cursors.h

@@ -26,6 +26,10 @@
 #include "Cursors32/ZoomOutCursor.xpm"
 #include "Cursors32/LabelCursorLeft.xpm"
 #include "Cursors32/LabelCursorRight.xpm"
+#include "Cursors32/BottomFrequencyCursor.xpm"
+#include "Cursors32/TopFrequencyCursor.xpm"
+#include "Cursors32/BandWidthCursor.xpm"
+#include "Cursors32/PlaybackCursor.xpm"
 #ifdef USE_MIDI
 #include "Cursors32/StretchCursor.xpm"
 #include "Cursors32/StretchLeftCursor.xpm"
@@ -43,6 +47,10 @@
 #include "Cursors16/ZoomOutCursor.xpm"
 #include "Cursors16/LabelCursorLeft.xpm"
 #include "Cursors16/LabelCursorRight.xpm"
+#include "Cursors16/BottomFrequencyCursor.xpm"
+#include "Cursors16/TopFrequencyCursor.xpm"
+#include "Cursors16/BandWidthCursor.xpm"
+#include "Cursors16/PlaybackCursor.xpm"
 #ifdef USE_MIDI
 #include "Cursors16/StretchCursor.xpm"
 #include "Cursors16/StretchLeftCursor.xpm"

lib-src/mod-script-pipe/ScripterCallback.cpp

@@ -107,6 +107,7 @@ int SCRIPT_PIPE_DLL_API RegScriptServerFunc( tpExecScriptServerFunc pFn )
       pScriptServerFn = pFn;
       PipeServer();
    }
+
    return 4;
 }
 

src/AllThemeResources.h

@@ -102,6 +102,10 @@ from there.  Audacity will look for a file called "Pause.png".
    DEFINE_IMAGE( bmpLabelCursorLeft, wxImage( 32, 32 ), wxT("LabelCursorLeft"));
    DEFINE_IMAGE( bmpLabelCursorRight, wxImage( 32, 32 ), wxT("LabelCursorRight"));
    DEFINE_IMAGE( bmpDisabledCursor, wxImage( 32, 32 ), wxT("DisabledCursor"));
+   DEFINE_IMAGE( bmpBottomFrequencyCursor, wxImage( 32, 32 ), wxT("BottomFrequencyCursor"));
+   DEFINE_IMAGE( bmpTopFrequencyCursor, wxImage( 32, 32 ), wxT("TopFrequencyCursor"));
+   DEFINE_IMAGE( bmpBandWidthCursor, wxImage(32, 32), wxT("BandWidthCursor"));
+   DEFINE_IMAGE( bmpPlaybackCursor, wxImage(32, 32), wxT("PlaybackCursor"));
 
    SET_THEME_FLAGS(  resFlagNone  );
    DEFINE_IMAGE( bmpIBeam, wxImage( 27, 27 ), wxT("IBeam"));

src/Experimental.h

@@ -113,7 +113,7 @@
 // Enables MIDI Output of NoteTrack (MIDI) data during playback
 // USE_MIDI must be defined in order for EXPERIMENTAL_MIDI_OUT to work
 #ifdef USE_MIDI
-//#define EXPERIMENTAL_MIDI_OUT
+#define EXPERIMENTAL_MIDI_OUT
 #endif
 
 // USE_MIDI must be defined in order for EXPERIMENTAL_SCOREALIGN to work

src/TrackPanel.cpp

@@ -165,6 +165,7 @@ is time to refresh some aspect of the screen.
 #include <stdlib.h>
 
 //#define DEBUG_DRAW_TIMING 1
+// #define SPECTRAL_EDITING_ESC_KEY
 
 #include <wx/combobox.h>
 #include <wx/dcclient.h>
@@ -495,6 +496,17 @@ TrackPanel::TrackPanel(wxWindow * parent, wxWindowID id,
    mZoomOutCursor = MakeCursor( wxCURSOR_MAGNIFIER, ZoomOutCursorXpm, 19, 15);
    mLabelCursorLeft  = MakeCursor( wxCURSOR_ARROW,  LabelCursorLeftXpm, 19, 15);
    mLabelCursorRight = MakeCursor( wxCURSOR_ARROW,  LabelCursorRightXpm, 16, 16);
+   
+#ifdef EXPERIMENTAL_SPECTRAL_EDITING
+   mBottomFrequencyCursor =
+      MakeCursor( wxCURSOR_ARROW,  BottomFrequencyCursorXpm, 16, 16);
+   mTopFrequencyCursor =
+      MakeCursor( wxCURSOR_ARROW,  TopFrequencyCursorXpm, 16, 16);
+   mBandWidthCursor = MakeCursor( wxCURSOR_ARROW,  BandWidthCursorXpm, 16, 16);
+#endif
+
+   mPlaybackCursor = MakeCursor(wxCURSOR_ARROW, PlaybackCursorXpm, 8, 16);
+
 #if USE_MIDI
    mStretchMode = stretchCenter;
    mStretching = false;
@@ -612,6 +624,12 @@ TrackPanel::~TrackPanel()
    delete mRearrangeCursor;
    delete mAdjustLeftSelectionCursor;
    delete mAdjustRightSelectionCursor;
+#ifdef EXPERIMENTAL_SPECTRAL_EDITING
+   delete mBottomFrequencyCursor;
+   delete mTopFrequencyCursor;
+   delete mBandWidthCursor;
+#endif
+   delete mPlaybackCursor;
 #if USE_MIDI
    delete mStretchCursor;
    delete mStretchLeftCursor;
@@ -1641,13 +1659,61 @@ void TrackPanel::MaySetOnDemandTip( Track * t, const wxChar ** ppTip )
    return;
 }
 
+#ifdef EXPERIMENTAL_SPECTRAL_EDITING
+void TrackPanel::HandleCenterFrequencyCursor
+(bool shiftDown, const wxChar ** ppTip, const wxCursor ** ppCursor)
+{
+#ifndef SPECTRAL_EDITING_ESC_KEY
+   *ppTip =
+      shiftDown ?
+      _("Click and drag to move center selection frequency.") :
+      _("Click and drag to move center selection frequency to a spectral peak.");
+
+#else
+   shiftDown;
+
+   *ppTip =
+      _("Click and drag to move center selection frequency.");
+
+#endif
+
+   *ppCursor = mEnvelopeCursor;
+}
+
+void TrackPanel::HandleCenterFrequencyClick
+(bool shiftDown, Track *pTrack, double value)
+{
+   if (shiftDown) {
+      // Disable time selection
+      mSelStart = -1;
+      mFreqSelTrack = static_cast<WaveTrack*>(pTrack);
+      mFreqSelPin = value;
+      mFreqSelMode = FREQ_SEL_DRAG_CENTER;
+   }
+   else {
+#ifndef SPECTRAL_EDITING_ESC_KEY
+      // Start center snapping
+      WaveTrack *wt = static_cast<WaveTrack*>(pTrack);
+      // Turn center snapping on (the only way to do this)
+      mFreqSelMode = FREQ_SEL_SNAPPING_CENTER;
+      // Disable time selection
+      mSelStart = -1;
+      StartSnappingFreqSelection(wt);
+#endif
+   }
+}
+#endif
+
 // The select tool can have different cursors and prompts depending on what
 // we hover over, most notably when hovering over the selction boundaries.
 // Determine and set the cursor and tip accordingly.
 void TrackPanel::SetCursorAndTipWhenSelectTool( Track * t,
-        wxMouseEvent & event, wxRect &r, bool bMultiToolMode, const wxChar ** ppTip )
+        wxMouseEvent & event, wxRect &r, bool bMultiToolMode,
+        const wxChar ** ppTip, const wxCursor ** ppCursor )
 {
-   SetCursor(*mSelectCursor);
+   // Do not set the default cursor here and re-set later, that causes
+   // flashing.
+   *ppCursor = mSelectCursor;
 
    //In Multi-tool mode, give multitool prompt if no-special-hit.
    if( bMultiToolMode ) {
@@ -1694,18 +1760,18 @@ void TrackPanel::SetCursorAndTipWhenSelectTool( Track * t,
       ) {
       *ppTip = _("Click to start or resume playback at the chosen time.");
       // cursor?
+      *ppCursor = mPlaybackCursor;
       return;
    }
 #endif
 
 #ifdef EXPERIMENTAL_SPECTRAL_EDITING
    bool logF;
-   if ( !bShiftDown && 
+   if ( (mFreqSelMode == FREQ_SEL_SNAPPING_CENTER) &&
-        (mFreqSelMode == FREQ_SEL_SNAPPING_CENTER) &&
          isSpectrogramTrack(t, &logF) ) {
       // Not shift-down, but center frequency snapping toggle is on
       *ppTip = _("Click and drag to set frequency bandwidth.");
-      // need new distinct cursor?
+      *ppCursor = mEnvelopeCursor;
       return;
    }
 #endif
@@ -1724,7 +1790,7 @@ void TrackPanel::SetCursorAndTipWhenSelectTool( Track * t,
       case SBRight:
          if ( HitTestStretch(t, r, event)) {
             *ppTip = _("Click and drag to stretch within selected region.");
-            SetCursor(*mStretchCursor);
+            *ppCursor = mStretchCursor;
             return;
          }
          break;
@@ -1745,18 +1811,20 @@ void TrackPanel::SetCursorAndTipWhenSelectTool( Track * t,
          break;
       case SBLeft:
          *ppTip = _("Click and drag to move left selection boundary.");
-         SetCursor(*mAdjustLeftSelectionCursor);
+         *ppCursor = mAdjustLeftSelectionCursor;
          return;
       case SBRight:
          *ppTip = _("Click and drag to move right selection boundary.");
-         SetCursor(*mAdjustRightSelectionCursor);
+         *ppCursor = mAdjustRightSelectionCursor;
          return;
 #ifdef EXPERIMENTAL_SPECTRAL_EDITING
       case SBBottom:
          *ppTip = bShiftDown ? 
             _("Click and drag to move bottom selection frequency.") :
             _("Click and drag to adjust frequency bandwidth.");
-         SetCursor(*mEnvelopeCursor); // For want of a better...
+         *ppCursor = bShiftDown
+          ? mBottomFrequencyCursor
+          : mBandWidthCursor;
          return;
       case SBTop:
          // With Shift NOT down, this is no different from dragging
@@ -1764,13 +1832,12 @@ void TrackPanel::SetCursorAndTipWhenSelectTool( Track * t,
          *ppTip = bShiftDown ?
             _("Click and drag to move top selection frequency.") :
             _("Click and drag to adjust frequency bandwidth.");
-         SetCursor(*mEnvelopeCursor); // For want of a better...
+       *ppCursor = bShiftDown
+          ? mTopFrequencyCursor
+          : mBandWidthCursor;
          return;
       case SBCenter:
-         // Don't need to assert, can just ignore shift down
+         HandleCenterFrequencyCursor(bShiftDown, ppTip, ppCursor);
-         // wxASSERT( !bShiftDown );
-         *ppTip = _("Click and drag to move center selection frequency.");
-         SetCursor(*mEnvelopeCursor); // For want of a better...
          return;
 #endif
       default:
@@ -1892,7 +1959,12 @@ void TrackPanel::HandleCursor(wxMouseEvent & event)
       else
       {
          bool bMultiToolMode = ttb->IsDown(multiTool);
-         SetCursorAndTipWhenSelectTool( t, event, r, bMultiToolMode, &tip );
+         const wxCursor *pSelection = 0;
+         SetCursorAndTipWhenSelectTool
+            ( t, event, r, bMultiToolMode, &tip, &pSelection );
+         if (pSelection)
+            // Set cursor once only here, to avoid flashing during drags
+            SetCursor(*pSelection);
       }
    }
 
@@ -1980,10 +2052,12 @@ void TrackPanel::HandleSelect(wxMouseEvent & event)
       MakeParentModifyState(false);
    }
 #ifdef EXPERIMENTAL_SPECTRAL_EDITING
+#ifdef SPECTRAL_EDITING_ESC_KEY
    else if (!event.IsButton() &&
             mFreqSelMode == FREQ_SEL_SNAPPING_CENTER &&
             !mViewInfo->selectedRegion.isPoint())
       MoveSnappingFreqSelection(event.m_y, r.y, r.height, t);
+#endif
 #endif
  done:
    SelectionHandleDrag(event, t);
@@ -2092,6 +2166,9 @@ void TrackPanel::SelectionHandleClick(wxMouseEvent & event,
             ExtendFreqSelection(event.m_y, r.y, r.height);
             break;
          }
+         case SBCenter:
+            HandleCenterFrequencyClick(true, pTrack, value);
+            break;
 #endif
          default:
             wxASSERT(false);
@@ -2194,14 +2271,16 @@ void TrackPanel::SelectionHandleClick(wxMouseEvent & event,
 #ifdef EXPERIMENTAL_SPECTRAL_EDITING
             case SBBottom:
             case SBTop:
-            case SBCenter:
                startNewSelection = false;
                // Disable time selection
                mSelStart = -1;
                mFreqSelTrack = static_cast<WaveTrack*>(pTrack);
                mFreqSelPin = value;
-               mFreqSelMode = (boundary == SBCenter)
+               mFreqSelMode = FREQ_SEL_PINNED_CENTER;
-                  ? FREQ_SEL_DRAG_CENTER : FREQ_SEL_PINNED_CENTER;
+               break;
+            case SBCenter:
+               HandleCenterFrequencyClick(false, pTrack, value);
+               startNewSelection = false;
                break;
 #endif
             default:
@@ -2499,7 +2578,7 @@ void TrackPanel::MoveSnappingFreqSelection (int mouseYCoordinate,
        isSpectrogramTrack(pTrack, &logF)) {
       WaveTrack *const wt = static_cast<WaveTrack*>(pTrack);
       // PRL:
-      // What happens if ESC then move began in one spectrogram track,
+      // What happens if center snapping selection began in one spectrogram track,
       // then continues inside another?  We do not then recalculate
       // the spectrum (as was done in StartSnappingFreqSelection)
       // but snap according to the peaks in the old track.
@@ -2889,6 +2968,12 @@ void TrackPanel::SelectionHandleDrag(wxMouseEvent & event, Track *clickedTrack)
 #endif
 
 #ifdef EXPERIMENTAL_SPECTRAL_EDITING
+#ifndef SPECTRAL_EDITING_ESC_KEY
+   if (mFreqSelMode == FREQ_SEL_SNAPPING_CENTER &&
+      !mViewInfo->selectedRegion.isPoint())
+      MoveSnappingFreqSelection(y, r.y, r.height, pTrack);
+   else
+#endif
    if (mFreqSelTrack == pTrack)
       ExtendFreqSelection(y, r.y, r.height);
 #endif
@@ -3008,7 +3093,7 @@ void SetIfNotNull( double * pValue, const double Value )
 
 TrackPanel::SelectionBoundary TrackPanel::ChooseBoundary
 (wxMouseEvent & event, const Track *pTrack, const wxRect &rect,
- bool mayChooseCenter, bool onlyWithinSnapDistance,
+bool mayDragWidth, bool onlyWithinSnapDistance,
  double *pPinValue) const
 {
    // Choose one of four boundaries to adjust, or the center frequency.
@@ -3022,7 +3107,7 @@ TrackPanel::SelectionBoundary TrackPanel::ChooseBoundary
 #ifdef EXPERIMENTAL_SPECTRAL_EDITING
    const double f0 = mViewInfo->selectedRegion.f0();
    const double f1 = mViewInfo->selectedRegion.f1();
-   double fc = SelectedRegion::UndefinedFrequency;
+   const double fc = mViewInfo->selectedRegion.fc();
    double ratio = 0;
 #endif
    wxInt64 pixelDist = mViewInfo->zoom * fabs(selend - t0);
@@ -3055,9 +3140,11 @@ TrackPanel::SelectionBoundary TrackPanel::ChooseBoundary
       const wxInt64 topDist = abs(int(event.m_y - topSel));
       if (topDist < verticalDist)
          chooseBottom = false, verticalDist = topDist;
-      if (mayChooseCenter) {
+      if (fc > 0
-         fc = mViewInfo->selectedRegion.fc();
+#ifdef SPECTRAL_EDITING_ESC_KEY
-         if (fc > 0) {
+         && mayDragWidth
+#endif
+         ) {
          const wxInt64 centerSel =
             FrequencyToPosition(fc, rect.y, rect.height,
                                  wt->GetRate(), logF);
@@ -3066,13 +3153,12 @@ TrackPanel::SelectionBoundary TrackPanel::ChooseBoundary
             chooseCenter = true, verticalDist = centerDist,
             ratio = f1 / fc;
       }
-      }
       if (verticalDist >= 0 &&
           verticalDist < pixelDist &&
-          // If center choice is possible, do not choose any frequency,
+          // If dragging width is possible, do not choose any frequency,
           // unless center is defined (i.e. top and bottom are both
           // defined).
-          (!mayChooseCenter || fc > 0)) {
+          (!mayDragWidth || fc > 0)) {
          pixelDist = verticalDist;
          chooseTime = false;
       }
@@ -3093,11 +3179,11 @@ TrackPanel::SelectionBoundary TrackPanel::ChooseBoundary
          return SBCenter;
       }
       else if (chooseBottom) {
-         SetIfNotNull( pPinValue, mayChooseCenter ? fc : f1 );
+         SetIfNotNull( pPinValue, mayDragWidth ? fc : f1 );
          return SBBottom;
       }
       else {
-         SetIfNotNull( pPinValue, mayChooseCenter ? fc : f0 );
+         SetIfNotNull(pPinValue, mayDragWidth ? fc : f0);
          return SBTop;
       }
    }
@@ -5682,6 +5768,7 @@ void TrackPanel::OnKeyDown(wxKeyEvent & event)
    Track *t = GetFocusedTrack();
 
 #ifdef EXPERIMENTAL_SPECTRAL_EDITING
+#ifdef SPECTRAL_EDITING_ESC_KEY
    // Test for pinning and unpinning of the center frequency
    bool logF;
    if (mAdjustSelectionEdges &&
@@ -5726,6 +5813,7 @@ void TrackPanel::OnKeyDown(wxKeyEvent & event)
          // And don't skip event, yet
       }
    }
+#endif
 #endif
 
    // Only deal with LabelTracks

src/TrackPanel.h

@@ -341,7 +341,8 @@ class AUDACITY_DLL_API TrackPanel:public wxPanel {
    virtual void SetCursorAndTipWhenInLabel( Track * t, wxMouseEvent &event, const wxChar ** ppTip );
    virtual void SetCursorAndTipWhenInVResizeArea( Track * label, bool blinked, const wxChar ** ppTip );
    virtual void SetCursorAndTipWhenInLabelTrack( LabelTrack * pLT, wxMouseEvent & event, const wxChar ** ppTip );
-   virtual void SetCursorAndTipWhenSelectTool( Track * t, wxMouseEvent & event, wxRect &r, bool bMultiToolMode, const wxChar ** ppTip );
+   virtual void SetCursorAndTipWhenSelectTool
+      ( Track * t, wxMouseEvent & event, wxRect &r, bool bMultiToolMode, const wxChar ** ppTip, const wxCursor ** ppCursor );
    virtual void SetCursorAndTipByTool( int tool, wxMouseEvent & event, const wxChar **ppTip );
    virtual void HandleCursor(wxMouseEvent & event);
    virtual void MaySetOnDemandTip( Track * t, const wxChar ** ppTip );
@@ -643,6 +644,14 @@ protected:
    sampleCount mDrawingLastDragSample; // sample of last drag-over
    float mDrawingLastDragSampleValue;  // value of last drag-over
 
+#ifdef EXPERIMENTAL_SPECTRAL_EDITING
+   void HandleCenterFrequencyCursor
+      (bool shiftDown, const wxChar ** ppTip, const wxCursor ** ppCursor);
+
+   void HandleCenterFrequencyClick
+      (bool shiftDown, Track *pTrack, double value);
+#endif
+
    double PositionToTime(wxInt64 mouseXCoordinate,
                          wxInt64 trackLeftEdge) const;
    wxInt64 TimeToPosition(double time,
@@ -672,7 +681,7 @@ protected:
    SelectionBoundary ChooseBoundary
       (wxMouseEvent & event, const Track *pTrack,
        const wxRect &rect,
-       bool mayChooseCenter,
+       bool mayDragWidth,
        bool onlyWithinSnapDistance,
        double *pPinValue = NULL) const;
 
@@ -725,7 +734,8 @@ protected:
    wxCursor *mSelectCursor;
    wxCursor *mResizeCursor;
    wxCursor *mSlideCursor;
-   wxCursor *mEnvelopeCursor;
+   wxCursor *mEnvelopeCursor; // doubles as the center frequency cursor
+                              // for spectral selection
    wxCursor *mSmoothCursor;
    wxCursor *mZoomInCursor;
    wxCursor *mZoomOutCursor;
@@ -735,6 +745,12 @@ protected:
    wxCursor *mDisabledCursor;
    wxCursor *mAdjustLeftSelectionCursor;
    wxCursor *mAdjustRightSelectionCursor;
+#ifdef EXPERIMENTAL_SPECTRAL_EDITING
+   wxCursor *mBottomFrequencyCursor;
+   wxCursor *mTopFrequencyCursor;
+   wxCursor *mBandWidthCursor;
+#endif
+   wxCursor *mPlaybackCursor;
 #if USE_MIDI
    wxCursor *mStretchCursor;
    wxCursor *mStretchLeftCursor;