do not sort MIDI regions by layer since they are all transparent
[ardour.git] / gtk2_ardour / editor_summary.cc
index 0936692abf886070b842d90bc56a672ee8b2e179..6740ef92eb7385d21a8c138c496784dbacec8706 100644 (file)
@@ -1,3 +1,22 @@
+/*
+    Copyright (C) 2009 Paul Davis
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+*/
+
 #include "ardour/session.h"
 #include "time_axis_view.h"
 #include "streamview.h"
@@ -6,6 +25,7 @@
 #include "editor.h"
 #include "region_view.h"
 #include "rgb_macros.h"
+#include "keyboard.h"
 
 using namespace std;
 using namespace sigc;
@@ -15,87 +35,55 @@ using namespace ARDOUR;
  *  @param e Editor to represent.
  */
 EditorSummary::EditorSummary (Editor* e)
-       : _editor (e),
-         _session (0),
-         _pixmap (0),
-         _regions_dirty (true),
-         _width (512),
-         _height (64),
-         _pixels_per_frame (1),
-         _vertical_scale (1),
-         _dragging (false),
-         _moved (false)
-         
+       : EditorComponent (e),
+         _x_scale (1),
+         _y_scale (1),
+         _last_playhead (-1),
+         _move_dragging (false),
+         _moved (false),
+         _zoom_dragging (false)
+
 {
-       
+
 }
 
-/** Set the session.
+/** Connect to a session.
  *  @param s Session.
  */
 void
-EditorSummary::set_session (Session* s)
+EditorSummary::connect_to_session (Session* s)
 {
-       _session = s;
+       EditorComponent::connect_to_session (s);
 
        Region::RegionPropertyChanged.connect (sigc::hide (mem_fun (*this, &EditorSummary::set_dirty)));
 
-       _session->RegionRemoved.connect (sigc::hide (mem_fun (*this, &EditorSummary::set_dirty)));
-       _session->EndTimeChanged.connect (mem_fun (*this, &EditorSummary::set_dirty));
-       _session->StartTimeChanged.connect (mem_fun (*this, &EditorSummary::set_dirty));
+       _session_connections.push_back (_session->RegionRemoved.connect (sigc::hide (mem_fun (*this, &EditorSummary::set_dirty))));
+       _session_connections.push_back (_session->EndTimeChanged.connect (mem_fun (*this, &EditorSummary::set_dirty)));
+       _session_connections.push_back (_session->StartTimeChanged.connect (mem_fun (*this, &EditorSummary::set_dirty)));
+       _editor->playhead_cursor->PositionChanged.connect (mem_fun (*this, &EditorSummary::playhead_position_changed));
 
        set_dirty ();
 }
 
-/** Destroy */
-EditorSummary::~EditorSummary ()
-{
-       if (_pixmap) {
-               gdk_pixmap_unref (_pixmap);
-       }
-}
-
 /** Handle an expose event.
  *  @param event Event from GTK.
  */
 bool
 EditorSummary::on_expose_event (GdkEventExpose* event)
 {
-       /* Render the regions pixmap */
-       
-       Gdk::Rectangle const exposure (
-               event->area.x, event->area.y, event->area.width, event->area.height
-               );
-
-       Gdk::Rectangle r = exposure;
-       Gdk::Rectangle content (0, 0, _width, _height);
-       bool intersects;
-       r.intersect (content, intersects);
-       
-       if (intersects) {
-
-               GdkPixmap* p = get_pixmap (get_window()->gobj ());
-
-               gdk_draw_drawable (
-                       get_window()->gobj(),
-                       get_style()->get_fg_gc (Gtk::STATE_NORMAL)->gobj(),
-                       p,
-                       r.get_x(),
-                       r.get_y(),
-                       r.get_x(),
-                       r.get_y(),
-                       r.get_width(),
-                       r.get_height()
-                       );
+       CairoWidget::on_expose_event (event);
+
+       if (_session == 0) {
+               return false;
        }
 
+       cairo_t* cr = gdk_cairo_create (get_window()->gobj());
+
        /* Render the view rectangle */
-       
+
        pair<double, double> x;
        pair<double, double> y;
-       editor_view (&x, &y);
-       
-       cairo_t* cr = gdk_cairo_create (get_window()->gobj());
+       get_editor (&x, &y);
 
        cairo_move_to (cr, x.first, y.first);
        cairo_line_to (cr, x.second, y.first);
@@ -108,32 +96,21 @@ EditorSummary::on_expose_event (GdkEventExpose* event)
        cairo_set_source_rgba (cr, 1, 1, 1, 0.5);
        cairo_stroke (cr);
 
-       cairo_destroy (cr);
-       
-       return true;
-}
-
-/** @param drawable GDK drawable.
- *  @return pixmap for the regions.
- */
-GdkPixmap *
-EditorSummary::get_pixmap (GdkDrawable* drawable)
-{
-       if (_regions_dirty) {
+       /* Playhead */
 
-               if (_pixmap) {
-                       gdk_pixmap_unref (_pixmap);
-               }
-               _pixmap = gdk_pixmap_new (drawable, _width, _height, -1);
+       cairo_set_line_width (cr, 1);
+       /* XXX: colour should be set from configuration file */
+       cairo_set_source_rgba (cr, 1, 0, 0, 1);
 
-               cairo_t* cr = gdk_cairo_create (_pixmap);
-               render (cr);
-               cairo_destroy (cr);
+       double const p = _editor->playhead_cursor->current_frame * _x_scale;
+       cairo_move_to (cr, p, 0);
+       cairo_line_to (cr, p, _height);
+       cairo_stroke (cr);
+       _last_playhead = p;
 
-               _regions_dirty = false;
-       }
+       cairo_destroy (cr);
 
-       return _pixmap;
+       return true;
 }
 
 /** Render the required regions to a cairo context.
@@ -142,26 +119,37 @@ EditorSummary::get_pixmap (GdkDrawable* drawable)
 void
 EditorSummary::render (cairo_t* cr)
 {
-       if (_session == 0) {
-               return;
-       }
-
        /* background */
-       
+
        cairo_set_source_rgb (cr, 0, 0, 0);
        cairo_rectangle (cr, 0, 0, _width, _height);
        cairo_fill (cr);
 
+       if (_session == 0) {
+               return;
+       }
+
        /* compute total height of all tracks */
-       
+
        int h = 0;
+       int max_height = 0;
        for (PublicEditor::TrackViewList::const_iterator i = _editor->track_views.begin(); i != _editor->track_views.end(); ++i) {
-               h += (*i)->effective_height ();
+               int const t = (*i)->effective_height ();
+               h += t;
+               max_height = max (max_height, t);
        }
 
        nframes_t const start = _session->current_start_frame ();
-       _pixels_per_frame = static_cast<double> (_width) / (_session->current_end_frame() - start);
-       _vertical_scale = static_cast<double> (_height) / h;
+       _x_scale = static_cast<double> (_width) / (_session->current_end_frame() - start);
+       _y_scale = static_cast<double> (_height) / h;
+
+       /* tallest a region should ever be in the summary, in pixels */
+       int const tallest_region_pixels = 4;
+
+       if (max_height * _y_scale > tallest_region_pixels) {
+               _y_scale = static_cast<double> (tallest_region_pixels) / max_height;
+
+       }
 
        /* render regions */
 
@@ -170,7 +158,7 @@ EditorSummary::render (cairo_t* cr)
                StreamView* s = (*i)->view ();
 
                if (s) {
-                       double const h = (*i)->effective_height () * _vertical_scale;
+                       double const h = (*i)->effective_height () * _y_scale;
                        cairo_set_line_width (cr, h);
 
                        s->foreach_regionview (bind (
@@ -196,27 +184,17 @@ EditorSummary::render_region (RegionView* r, cairo_t* cr, nframes_t start, doubl
 {
        uint32_t const c = r->get_fill_color ();
        cairo_set_source_rgb (cr, UINT_RGBA_R (c) / 255.0, UINT_RGBA_G (c) / 255.0, UINT_RGBA_B (c) / 255.0);
-                       
-       cairo_move_to (cr, (r->region()->position() - start) * _pixels_per_frame, y);
-       cairo_line_to (cr, ((r->region()->position() - start + r->region()->length())) * _pixels_per_frame, y);
-       cairo_stroke (cr);
-}
-
-/** Set the summary so that the whole thing will be re-rendered next time it is required */
-void
-EditorSummary::set_dirty ()
-{
-       ENSURE_GUI_THREAD (mem_fun (*this, &EditorSummary::set_dirty));
 
-       _regions_dirty = true;
-       queue_draw ();
+       cairo_move_to (cr, (r->region()->position() - start) * _x_scale, y);
+       cairo_line_to (cr, ((r->region()->position() - start + r->region()->length())) * _x_scale, y);
+       cairo_stroke (cr);
 }
 
-/** Set the summary so that just the view boundary markers will be re-rendered */
+/** Set the summary so that just the overlays (viewbox, playhead etc.) will be re-rendered */
 void
-EditorSummary::set_bounds_dirty ()
+EditorSummary::set_overlays_dirty ()
 {
-       ENSURE_GUI_THREAD (mem_fun (*this, &EditorSummary::set_bounds_dirty));
+       ENSURE_GUI_THREAD (mem_fun (*this, &EditorSummary::set_overlays_dirty));
        queue_draw ();
 }
 
@@ -228,45 +206,42 @@ EditorSummary::on_size_request (Gtk::Requisition *req)
 {
        /* Use a dummy, small width and the actual height that we want */
        req->width = 64;
-       req->height = 64;
+       req->height = 32;
 }
 
-/** Handle a size allocation.
- *  @param alloc GTK allocation.
- */
-void
-EditorSummary::on_size_allocate (Gtk::Allocation& alloc)
-{
-       Gtk::EventBox::on_size_allocate (alloc);
-
-       _width = alloc.get_width ();
-       _height = alloc.get_height ();
-
-       set_dirty ();
-}
 
 void
 EditorSummary::centre_on_click (GdkEventButton* ev)
 {
-       nframes_t x = (ev->x / _pixels_per_frame) + _session->current_start_frame();
-       nframes_t const xh = _editor->current_page_frames () / 2;
-       if (x > xh) {
-               x -= xh;
-       } else {
-               x = 0;
+       pair<double, double> xr;
+       pair<double, double> yr;
+       get_editor (&xr, &yr);
+
+       double const w = xr.second - xr.first;
+       double const h = yr.second - yr.first;
+
+       xr.first = ev->x - w / 2;
+       xr.second = ev->x + w / 2;
+       yr.first = ev->y - h / 2;
+       yr.second = ev->y + h / 2;
+
+       if (xr.first < 0) {
+               xr.first = 0;
+               xr.second = w;
+       } else if (xr.second > _width) {
+               xr.second = _width;
+               xr.first = _width - w;
        }
-       
-       _editor->reset_x_origin (x);
-       
-       double y = ev->y / _vertical_scale;
-       double const yh = _editor->canvas_height () / 2;
-       if (y > yh) {
-               y -= yh;
-       } else {
-               y = 0;
+
+       if (yr.first < 0) {
+               yr.first = 0;
+               yr.second = h;
+       } else if (yr.second > _height) {
+               yr.second = _height;
+               yr.first = _height - h;
        }
-       
-       _editor->reset_y_origin (y);
+
+       set_editor (xr, yr);
 }
 
 /** Handle a button press.
@@ -279,21 +254,53 @@ EditorSummary::on_button_press_event (GdkEventButton* ev)
 
                pair<double, double> xr;
                pair<double, double> yr;
-               editor_view (&xr, &yr);
+               get_editor (&xr, &yr);
 
-               if (xr.first <= ev->x && ev->x <= xr.second && yr.first <= ev->y && ev->y <= yr.second) {
+               _start_editor_x = xr;
+               _start_editor_y = yr;
+               _start_mouse_x = ev->x;
+               _start_mouse_y = ev->y;
 
-                       /* click inside the view rectangle: drag it */
-                       _dragging = true;
-                       _moved = false;
-                       _x_offset = ev->x - xr.first;
-                       _y_offset = ev->y - yr.first;
+               if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
+
+                       /* primary-modifier-click: start a zoom drag */
+
+                       double const hx = (xr.first + xr.second) * 0.5;
+                       _zoom_left = ev->x < hx;
+                       _zoom_dragging = true;
                        _editor->_dragging_playhead = true;
-                       
-               } else {
-                       
-                       /* click outside the view rectangle: centre the view around the mouse click */
+
+
+                       /* In theory, we could support vertical dragging, which logically
+                          might scale track heights in order to make the editor reflect
+                          the dragged viewbox.  However, having tried this:
+                          a) it's hard to do
+                          b) it's quite slow
+                          c) it doesn't seem particularly useful, especially with the
+                          limited height of the summary
+
+                          So at the moment we don't support that...
+                       */
+
+
+               } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::SecondaryModifier)) {
+
+                       /* secondary-modifier-click: locate playhead */
+                       if (_session) {
+                               _session->request_locate (ev->x / _x_scale + _session->current_start_frame());
+                       }
+
+               } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
+
                        centre_on_click (ev);
+
+               } else {
+
+                       /* ordinary click: start a move drag */
+
+                       _move_dragging = true;
+                       _moved = false;
+                       _editor->_dragging_playhead = true;
                }
        }
 
@@ -301,38 +308,130 @@ EditorSummary::on_button_press_event (GdkEventButton* ev)
 }
 
 void
-EditorSummary::editor_view (pair<double, double>* x, pair<double, double>* y) const
+EditorSummary::get_editor (pair<double, double>* x, pair<double, double>* y) const
 {
-       x->first = (_editor->leftmost_position () - _session->current_start_frame ()) * _pixels_per_frame;
-       x->second = x->first + _editor->current_page_frames() * _pixels_per_frame;
+       x->first = (_editor->leftmost_position () - _session->current_start_frame ()) * _x_scale;
+       x->second = x->first + _editor->current_page_frames() * _x_scale;
 
-       y->first = _editor->get_trackview_group_vertical_offset () * _vertical_scale;
-       y->second = y->first + _editor->canvas_height () * _vertical_scale;
+       y->first = _editor->vertical_adjustment.get_value() * _y_scale;
+       y->second = y->first + _editor->canvas_height () * _y_scale;
 }
 
 bool
 EditorSummary::on_motion_notify_event (GdkEventMotion* ev)
 {
-       if (!_dragging) {
-               return false;
-       }
+       pair<double, double> xr = _start_editor_x;
+       pair<double, double> yr = _start_editor_y;
+
+       if (_move_dragging) {
+
+               _moved = true;
+
+               xr.first += ev->x - _start_mouse_x;
+               xr.second += ev->x - _start_mouse_x;
+               yr.first += ev->y - _start_mouse_y;
+               yr.second += ev->y - _start_mouse_y;
+
+               set_editor (xr, yr);
+
+       } else if (_zoom_dragging) {
 
-       _moved = true;
+               double const dx = ev->x - _start_mouse_x;
 
-       _editor->reset_x_origin (((ev->x - _x_offset) / _pixels_per_frame) + _session->current_start_frame ());
-       _editor->reset_y_origin ((ev->y - _y_offset) / _vertical_scale);
+               if (_zoom_left) {
+                       xr.first += dx;
+               } else {
+                       xr.second += dx;
+               }
+
+               set_editor (xr, yr);
+       }
 
        return true;
 }
 
 bool
-EditorSummary::on_button_release_event (GdkEventButton* ev)
+EditorSummary::on_button_release_event (GdkEventButton*)
 {
-       if (_dragging && !_moved) {
-               centre_on_click (ev);
-       }
-       
-       _dragging = false;
+       _move_dragging = false;
+       _zoom_dragging = false;
        _editor->_dragging_playhead = false;
        return true;
 }
+
+bool
+EditorSummary::on_scroll_event (GdkEventScroll* ev)
+{
+       /* mouse wheel */
+
+       pair<double, double> xr;
+       pair<double, double> yr;
+       get_editor (&xr, &yr);
+
+       double const amount = 8;
+
+       if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
+
+               if (ev->direction == GDK_SCROLL_UP) {
+                       xr.first += amount;
+                       xr.second += amount;
+               } else {
+                       xr.first -= amount;
+                       xr.second -= amount;
+               }
+
+       } else {
+
+               if (ev->direction == GDK_SCROLL_DOWN) {
+                       yr.first += amount;
+                       yr.second += amount;
+               } else {
+                       yr.first -= amount;
+                       yr.second -= amount;
+               }
+
+       }
+
+       set_editor (xr, yr);
+       return true;
+}
+
+void
+EditorSummary::set_editor (pair<double,double> const & x, pair<double, double> const & y)
+{
+       if (_editor->pending_visual_change.idle_handler_id < 0) {
+
+               /* As a side-effect, the Editor's visual change idle handler processes
+                  pending GTK events.  Hence this motion notify handler can be called
+                  in the middle of a visual change idle handler, and if this happens,
+                  the queue_visual_change calls below modify the variables that the
+                  idle handler is working with.  This causes problems.  Hence the
+                  check above.  It ensures that we won't modify the pending visual change
+                  while a visual change idle handler is in progress.  It's not perfect,
+                  as it also means that we won't change these variables if an idle handler
+                  is merely pending but not executing.  But c'est la vie.
+               */
+
+               _editor->reset_x_origin (x.first / _x_scale);
+               _editor->reset_y_origin (y.first / _y_scale);
+
+               double const nx = (
+                       ((x.second - x.first) / _x_scale) /
+                       _editor->frame_to_unit (_editor->current_page_frames())
+                       );
+
+               if (nx != _editor->get_current_zoom ()) {
+                       _editor->reset_zoom (nx);
+               }
+       }
+}
+
+void
+EditorSummary::playhead_position_changed (nframes64_t p)
+{
+       if (int (p * _x_scale) != int (_last_playhead)) {
+               set_overlays_dirty ();
+       }
+}
+
+