mechanism to allow Track (or other Route-derived type) to add its own processors...
[ardour.git] / gtk2_ardour / editor_summary.cc
index da0174f10367bc6266f9964e7d70b763f6f8e581..95b54cdf02a3b0981176143dfafb9e8e57335d77 100644 (file)
@@ -21,6 +21,9 @@
 
 #include "canvas/debug.h"
 
+#include <gtkmm/menu.h>
+#include <gtkmm/menuitem.h>
+
 #include "time_axis_view.h"
 #include "streamview.h"
 #include "editor_summary.h"
@@ -35,6 +38,8 @@
 #include "route_time_axis.h"
 #include "ui_config.h"
 
+#include "pbd/i18n.h"
+
 using namespace std;
 using namespace ARDOUR;
 using Gtkmm2ext::Keyboard;
@@ -46,17 +51,13 @@ EditorSummary::EditorSummary (Editor* e)
        : EditorComponent (e),
          _start (0),
          _end (1),
-         _overhang_fraction (0.1),
          _x_scale (1),
          _track_height (16),
          _last_playhead (-1),
-         _begin_dragging (false),
          _move_dragging (false),
-         _moved (false),
          _view_rectangle_x (0, 0),
          _view_rectangle_y (0, 0),
          _zoom_trim_dragging (false),
-         _zoom_dragging (false),
          _old_follow_playhead (false),
          _image (0),
          _background_dirty (true)
@@ -116,6 +117,9 @@ EditorSummary::set_session (Session* s)
                _session->EndTimeChanged.connect (_session_connections, invalidator (*this), boost::bind (&EditorSummary::set_background_dirty, this), gui_context());
                _editor->selection->RegionsChanged.connect (sigc::mem_fun(*this, &EditorSummary::set_background_dirty));
        }
+
+       _leftmost = max_framepos;
+       _rightmost = 0;
 }
 
 void
@@ -134,10 +138,26 @@ EditorSummary::render_background_image ()
 
        /* compute start and end points for the summary */
 
-       framecnt_t const session_length = _session->current_end_frame() - _session->current_start_frame ();
-       double const theoretical_start = _session->current_start_frame() - session_length * _overhang_fraction;
+       std::pair<framepos_t, framepos_t> ext = _editor->session_gui_extents();
+       double theoretical_start = ext.first;
+       double theoretical_end = ext.second;
+
+       /* the summary should encompass the full extent of everywhere we've visited since the session was opened */
+       if ( _leftmost < theoretical_start)
+               theoretical_start = _leftmost;
+       if ( _rightmost > theoretical_end )
+               theoretical_end = _rightmost;
+
+       /* range-check */
        _start = theoretical_start > 0 ? theoretical_start : 0;
-       _end = _session->current_end_frame() + session_length * _overhang_fraction;
+       _end = theoretical_end < max_framepos ? theoretical_end : max_framepos;
+
+       /* calculate x scale */
+       if (_end != _start) {
+               _x_scale = static_cast<double> (get_width()) / (_end - _start);
+       } else {
+               _x_scale = 1;
+       }
 
        /* compute track height */
        int N = 0;
@@ -153,13 +173,6 @@ EditorSummary::render_background_image ()
                _track_height = (double) get_height() / N;
        }
 
-       /* calculate x scale */
-       if (_end != _start) {
-               _x_scale = static_cast<double> (get_width()) / (_end - _start);
-       } else {
-               _x_scale = 1;
-       }
-
        /* render tracks and regions */
 
        double y = 0;
@@ -171,12 +184,14 @@ EditorSummary::render_background_image ()
 
                /* paint a non-bg colored strip to represent the track itself */
 
-               cairo_set_source_rgb (cr, 0.2, 0.2, 0.2);
-               cairo_set_line_width (cr, _track_height - 1);
-               cairo_move_to (cr, 0, y + _track_height / 2);
-               cairo_line_to (cr, get_width(), y + _track_height / 2);
-               cairo_stroke (cr);
-
+               if ( _track_height > 4 ) {
+                       cairo_set_source_rgb (cr, 0.2, 0.2, 0.2);
+                       cairo_set_line_width (cr, _track_height - 1);
+                       cairo_move_to (cr, 0, y + _track_height / 2);
+                       cairo_line_to (cr, get_width(), y + _track_height / 2);
+                       cairo_stroke (cr);
+               }
+               
                StreamView* s = (*i)->view ();
 
                if (s) {
@@ -221,6 +236,19 @@ EditorSummary::render (Cairo::RefPtr<Cairo::Context> const& ctx, cairo_rectangle
                return;
        }
 
+       /* maintain the leftmost and rightmost locations that we've ever reached */
+       framecnt_t const leftmost = _editor->leftmost_sample ();
+       if ( leftmost < _leftmost) {
+               _leftmost = leftmost;
+               _background_dirty = true;
+       }
+       framecnt_t const rightmost = leftmost + _editor->current_page_samples();
+       if ( rightmost > _rightmost) {
+               _rightmost = rightmost;
+               _background_dirty = true;
+       }
+
+       //draw the background (regions, markers, etc ) if they've changed
        if (!_image || _background_dirty) {
                render_background_image ();
                _background_dirty = false;
@@ -245,7 +273,6 @@ EditorSummary::render (Cairo::RefPtr<Cairo::Context> const& ctx, cairo_rectangle
 
        int32_t width = _view_rectangle_x.second - _view_rectangle_x.first;
        std::min(8, width);
-       int32_t height = _view_rectangle_y.second - _view_rectangle_y.first;
        cairo_rectangle (cr, _view_rectangle_x.first, 0, width, get_height ());
        cairo_set_source_rgba (cr, 1, 1, 1, 0.15);
        cairo_fill (cr);
@@ -317,9 +344,9 @@ EditorSummary::set_overlays_dirty ()
 
 /** Set the summary so that just the overlays (viewbox, playhead etc.) in a given area will be re-rendered */
 void
-EditorSummary::set_overlays_dirty (int x, int y, int w, int h)
+EditorSummary::set_overlays_dirty_rect (int x, int y, int w, int h)
 {
-       ENSURE_GUI_THREAD (*this, &EditorSummary::set_overlays_dirty);
+       ENSURE_GUI_THREAD (*this, &EditorSummary::set_overlays_dirty_rect);
        queue_draw_area (x, y, w, h);
 }
 
@@ -402,6 +429,8 @@ EditorSummary::on_key_release_event (GdkEventKey* key)
        return false;
 }
 
+#include "gtkmm2ext/utils.h"
+
 /** Handle a button press.
  *  @param ev GTK event.
  */
@@ -410,6 +439,16 @@ EditorSummary::on_button_press_event (GdkEventButton* ev)
 {
        _old_follow_playhead = _editor->follow_playhead ();
 
+       if (ev->button == 3) {  //right-click:  show the reset menu action
+               using namespace Gtk::Menu_Helpers;
+               Gtk::Menu* m = manage (new Gtk::Menu);
+               MenuList& items = m->items ();
+               items.push_back(MenuElem(_("Reset Summary to Extents"),
+                       sigc::mem_fun(*this, &EditorSummary::reset_to_extents)));
+               m->popup (ev->button, ev->time);
+               return true;
+       }
+
        if (ev->button != 1) {
                return true;
        }
@@ -449,9 +488,22 @@ EditorSummary::on_button_press_event (GdkEventButton* ev)
 
        } else {
 
-               /* start a move or zoom drag */
-               /* won't know which one until the mouse moves */
-               _begin_dragging = true;
+               /* start a move+zoom drag */
+               get_editor (&_pending_editor_x, &_pending_editor_y);
+               _pending_editor_changed = false;
+               _editor->_dragging_playhead = true;
+               _editor->set_follow_playhead (false);
+
+               _move_dragging = true;
+               
+               _last_mx = ev->x;
+               _last_my = ev->y;
+               _last_dx = 0;
+               _last_dy = 0;
+               _last_y_delta = 0;
+
+               get_window()->set_cursor (*_editor->_cursors->expand_left_right);
+       
        }
 
        return true;
@@ -463,7 +515,7 @@ EditorSummary::on_button_press_event (GdkEventButton* ev)
 bool
 EditorSummary::suspending_editor_updates () const
 {
-       return (!UIConfiguration::instance().get_update_editor_during_summary_drag () && (_zoom_dragging || _zoom_trim_dragging || _move_dragging));
+       return (!UIConfiguration::instance().get_update_editor_during_summary_drag () && (_zoom_trim_dragging || _move_dragging));
 }
 
 /** Fill in x and y with the editor's current viewable area in summary coordinates */
@@ -521,6 +573,18 @@ EditorSummary::get_position (double x, double y) const
        }
 }
 
+void
+EditorSummary::reset_to_extents()
+{
+       //reset as if the user never went anywhere outside the extents
+       _leftmost = max_framepos;
+       _rightmost = 0;
+
+       _editor->temporal_zoom_extents ();
+       set_background_dirty ();
+}
+
+
 void
 EditorSummary::set_cursor (Position p)
 {
@@ -535,7 +599,7 @@ EditorSummary::set_cursor (Position p)
                get_window()->set_cursor (*_editor->_cursors->move);
                break;
        case TO_LEFT_OR_RIGHT:
-               get_window()->set_cursor (*_editor->_cursors->expand_left_right);
+               get_window()->set_cursor (*_editor->_cursors->move);
                break;
        default:
                assert (0);
@@ -544,51 +608,100 @@ EditorSummary::set_cursor (Position p)
        }
 }
 
-bool
-EditorSummary::on_motion_notify_event (GdkEventMotion* ev)
+void
+EditorSummary::summary_zoom_step ( int steps /* positive steps to zoom "out" , negative steps to zoom "in" */  )
 {
-       pair<double, double> xr = _start_editor_x;
-       double x = _start_editor_x.first;
+       pair<double, double> xn;
 
-       if (_move_dragging) {
-
-               _moved = true;
+       get_editor (&xn);
 
-               assert (_start_position == INSIDE || _start_position == TO_LEFT_OR_RIGHT);
-               x += ev->x - _start_mouse_x;
+       xn.first -= steps;
+       xn.second += steps;
 
-               if (x < 0) {
-                       x = 0;
-               }
+       //for now, disallow really close zooming-in from the scroomer. ( currently it causes the start-offset to 'walk' because of integer limitations.  to fix this, probably need to maintain float throught the get/set_editor() path )
+       if (steps<0) {
+      if ( (xn.second-xn.first) < 2)
+               return;
+       }
 
-               set_editor (x);
+       set_overlays_dirty ();
+       set_editor_x (xn);
+}
 
-       } else if (_zoom_dragging) {
 
-               //ToDo: refactor into summary_zoom_in/out(
-               //ToDo:  protect the case where the editor position is small, and results in offsetting the position
+bool
+EditorSummary::on_motion_notify_event (GdkEventMotion* ev)
+{
+       if (_move_dragging) {
 
-               double const dy = ev->y - _zoom_last_y;
+               //To avoid accidental zooming, the mouse must move exactly vertical, not diagonal, to trigger a zoom step
+               //we use screen coordinates for this, not canvas-based grab_x
+               double mx = ev->x;
+               double dx = mx - _last_mx;
+               double my = ev->y;
+               double dy = my - _last_my;
+
+               //do zooming in windowed "steps" so it feels more reversible ?
+               const int stepsize = 2;
+               int y_delta = _start_mouse_y - my;
+               y_delta = y_delta / stepsize;
+
+               //do the zoom?
+               const float zscale = 3;
+               if ( (dx==0) && (_last_dx ==0) && (y_delta != _last_y_delta) ) {
+
+                       summary_zoom_step( dy * zscale );
+
+                       //after the zoom we must re-calculate x-pos grabs
+                       pair<double, double> xr;
+                       get_editor (&xr);
+                       _start_editor_x = xr;
+                       _start_mouse_x = ev->x;
+                       
+                       _last_y_delta = y_delta;
+               }
                
-               pair<double, double> xn;
-               get_editor (&xn);
+               //always track horizontal movement, if any
+               if ( dx != 0 ) {
 
-               xn.first -= dy;
-               xn.second += dy;
-       
-               set_overlays_dirty ();
-               set_editor_x (xn);
-       
-               _zoom_last_y = ev->y;
+                       double x = _start_editor_x.first;
+                       x += ev->x - _start_mouse_x;
                        
+                       if (x < 0) {
+                               x = 0;
+                       }
+
+                       //zoom-behavior-tweaks
+                       //protect the right edge from expanding beyond the end
+                       pair<double, double> xr;
+                       get_editor (&xr);
+                       double w = xr.second - xr.first;
+                       if ( x + w < get_width() ) {
+                               set_editor (x);
+                       }
+               }
+
+               _last_my = my;
+               _last_mx = mx;
+               _last_dx = dx;
+               _last_dy = dy;
+
        } else if (_zoom_trim_dragging) {
 
+               pair<double, double> xr = _start_editor_x;
+
                double const dx = ev->x - _start_mouse_x;
 
                if (_zoom_trim_position == LEFT) {
                        xr.first += dx;
                } else if (_zoom_trim_position == RIGHT) {
-                       xr.second += dx;
+
+                       //zoom-behavior-tweaks
+                       //protect the right edge from expanding beyond the edge
+                       if ( (xr.second + dx) < get_width() ) {
+                               xr.second += dx;
+                       }
+
                } else {
                        assert (0);
                        xr.first = -1; /* do not change */
@@ -598,49 +711,8 @@ EditorSummary::on_motion_notify_event (GdkEventMotion* ev)
                set_cursor (_zoom_trim_position);
                set_editor (xr);
 
-       } else if (_begin_dragging) {
-
-               double const dx = ev->x - _start_mouse_x;
-               double const dy = ev->y - _start_mouse_y;
-
-               if ( fabs(dx) > fabs(dy) ) {
-                       
-                       /* initiate a move drag */
-
-                       /* get the editor's state in case we are suspending updates */
-                       get_editor (&_pending_editor_x, &_pending_editor_y);
-                       _pending_editor_changed = false;
-
-                       _move_dragging = true;
-                       _moved = false;
-                       _editor->_dragging_playhead = true;
-                       _editor->set_follow_playhead (false);
-
-                       get_window()->set_cursor (*_editor->_cursors->expand_left_right);
-
-                       _begin_dragging = false;
-               
-               } else if ( fabs(dy) > fabs(dx) ) {
-               
-                       /* initiate a zoom drag */
-
-                       /* get the editor's state in case we are suspending updates */
-                       get_editor (&_pending_editor_x, &_pending_editor_y);
-                       _pending_editor_changed = false;
-
-                       //_zoom_position = get_position (ev->x, ev->y);
-                       _zoom_dragging = true;
-                       _zoom_last_y = ev->y;
-                       _editor->_dragging_playhead = true;
-                       _editor->set_follow_playhead (false);
-
-                       get_window()->set_cursor (*_editor->_cursors->expand_up_down);
-
-                       _begin_dragging = false;
-               }
-               
        } else {
-               set_cursor ( INSIDE );
+               set_cursor ( get_position(ev->x, ev->y) );
        }
 
        return true;
@@ -651,10 +723,8 @@ EditorSummary::on_button_release_event (GdkEventButton*)
 {
        bool const was_suspended = suspending_editor_updates ();
 
-       _begin_dragging = false;
        _move_dragging = false;
        _zoom_trim_dragging = false;
-       _zoom_dragging = false;
        _editor->_dragging_playhead = false;
        _editor->set_follow_playhead (_old_follow_playhead, false);
 
@@ -675,29 +745,15 @@ EditorSummary::on_scroll_event (GdkEventScroll* ev)
 
        switch (ev->direction) {
                case GDK_SCROLL_UP: {
-                       //ToDo:  use function summary_zoom_in/out
                        
-                       pair<double, double> xn;
-                       get_editor (&xn);
-
-                       xn.first += 2;
-                       xn.second -= 2;
-               
-                       set_overlays_dirty ();
-                       set_editor_x (xn);
+                       summary_zoom_step( -4 );
                
                        return true;
                } break;
                
                case GDK_SCROLL_DOWN: {
-                       pair<double, double> xn;
-                       get_editor (&xn);
-
-                       xn.first -= 2;
-                       xn.second += 2;
-               
-                       set_overlays_dirty ();
-                       set_editor_x (xn);
+                       
+                       summary_zoom_step( 4 );
                
                        return true;
                } break;
@@ -841,7 +897,7 @@ EditorSummary::playhead_position_changed (framepos_t p)
        if (_session && o != n) {
                int a = max(2, min (o, n));
                int b = max (o, n);
-               set_overlays_dirty (a - 2, 0, b + 2, get_height ());
+               set_overlays_dirty_rect (a - 2, 0, b + 2, get_height ());
        }
 }