Fix AutomationTrackItem rubberband click thinking it was unhandled.
[ardour.git] / gtk2_ardour / automation_line.cc
index 94ca7802f056adc09697ce974b1647d8f719175e..d5ed529ad882adca59efd0bfd8fb0746b0ea46e9 100644 (file)
 
 */
 
+#include <cmath>
+
 #ifdef COMPILER_MSVC
 #include <float.h>
 
-// 'std::isinf()' and 'std::isnan()' are not available in MSVC.
-#define isinf(val) !((bool)_finite((double)val))
-#define isnan(val) (bool)_isnan((double)val)
+// 'std::isnan()' is not available in MSVC.
+#define isnan_local(val) (bool)_isnan((double)val)
 #else
-using std::isnan;
-using std::isinf;
+#define isnan_local std::isnan
 #endif
 
-#include <cmath>
 #include <climits>
 #include <vector>
 #include <fstream>
@@ -43,16 +42,19 @@ using std::isinf;
 #include "ardour/automation_list.h"
 #include "ardour/dB.h"
 #include "ardour/debug.h"
+#include "ardour/parameter_types.h"
+#include "ardour/tempo.h"
 
 #include "evoral/Curve.hpp"
 
+#include "canvas/debug.h"
+
 #include "automation_line.h"
 #include "control_point.h"
 #include "gui_thread.h"
 #include "rgb_macros.h"
 #include "ardour_ui.h"
 #include "public_editor.h"
-#include "utils.h"
 #include "selection.h"
 #include "time_axis_view.h"
 #include "point_selection.h"
@@ -60,6 +62,7 @@ using std::isinf;
 
 #include "ardour/event_type_map.h"
 #include "ardour/session.h"
+#include "ardour/value_as_string.h"
 
 #include "i18n.h"
 
@@ -71,9 +74,12 @@ using namespace Editing;
 /** @param converter A TimeConverter whose origin_b is the start time of the AutomationList in session frames.
  *  This will not be deleted by AutomationLine.
  */
-AutomationLine::AutomationLine (const string& name, TimeAxisView& tv, ArdourCanvas::Group& parent,
-               boost::shared_ptr<AutomationList> al,
-               Evoral::TimeConverter<double, framepos_t>* converter)
+AutomationLine::AutomationLine (const string&                              name,
+                                TimeAxisView&                              tv,
+                                ArdourCanvas::Item&                        parent,
+                                boost::shared_ptr<AutomationList>          al,
+                                const ParameterDescriptor&                 desc,
+                                Evoral::TimeConverter<double, framepos_t>* converter)
        : trackview (tv)
        , _name (name)
        , alist (al)
@@ -81,12 +87,11 @@ AutomationLine::AutomationLine (const string& name, TimeAxisView& tv, ArdourCanv
        , _parent_group (parent)
        , _offset (0)
        , _maximum_time (max_framepos)
+       , _desc (desc)
 {
        if (converter) {
-               _time_converter = converter;
                _our_time_converter = false;
        } else {
-               _time_converter = new Evoral::IdentityConverter<double, framepos_t>;
                _our_time_converter = true;
        }
        
@@ -100,18 +105,22 @@ AutomationLine::AutomationLine (const string& name, TimeAxisView& tv, ArdourCanv
        terminal_points_can_slide = true;
        _height = 0;
 
-       group = new ArdourCanvas::Group (&parent);
+       group = new ArdourCanvas::Container (&parent);
+       CANVAS_DEBUG_NAME (group, "region gain envelope group");
 
-       line = new ArdourCanvas::Curve (group);
+       line = new ArdourCanvas::PolyLine (group);
+       CANVAS_DEBUG_NAME (line, "region gain envelope line");
        line->set_data ("line", this);
        line->set_outline_width (2.0);
+       line->set_covers_threshold (4.0);
 
        line->Event.connect (sigc::mem_fun (*this, &AutomationLine::event_handler));
 
        trackview.session()->register_with_memento_command_factory(alist->id(), this);
 
        if (alist->parameter().type() == GainAutomation ||
-           alist->parameter().type() == EnvelopeAutomation) {
+           alist->parameter().type() == EnvelopeAutomation ||
+           desc.unit == ParameterDescriptor::DB) {
                set_uses_gain_mapping (true);
        }
 
@@ -136,53 +145,71 @@ AutomationLine::event_handler (GdkEvent* event)
        return PublicEditor::instance().canvas_line_event (event, line, this);
 }
 
+bool
+AutomationLine::is_stepped() const
+{
+       return (_desc.toggled ||
+               (alist && alist->interpolation() == AutomationList::Discrete));
+}
+
 void
-AutomationLine::show ()
+AutomationLine::update_visibility ()
 {
        if (_visible & Line) {
-               /* Only show the line there are some points, otherwise we may show an out-of-date line
+               /* Only show the line when there are some points, otherwise we may show an out-of-date line
                   when automation points have been removed (the line will still follow the shape of the
                   old points).
                */
-               if (alist->interpolation() != AutomationList::Discrete && control_points.size() >= 2) {
+               if (control_points.size() >= 2) {
                        line->show();
                } else {
                        line->hide ();
                }
-       } else {
-               line->hide();
-       }
 
-       if (_visible & ControlPoints) {
-               for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
-                       (*i)->set_visible (true);
-                       (*i)->show ();
-               }
-       } else if (_visible & SelectedControlPoints) {
-               for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
-                       (*i)->set_visible ((*i)->get_selected());
+               if (_visible & ControlPoints) {
+                       for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
+                               (*i)->show ();
+                       }
+               } else if (_visible & SelectedControlPoints) {
+                       for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
+                               if ((*i)->get_selected()) {
+                                       (*i)->show ();
+                               } else {
+                                       (*i)->hide ();
+                               }
+                       }
+               } else {
+                       for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
+                               (*i)->hide ();
+                       }
                }
+
        } else {
+               line->hide ();
                for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
-                       (*i)->set_visible (false);
+                       if (_visible & ControlPoints) {
+                               (*i)->show ();
+                       } else {
+                               (*i)->hide ();
+                       }
                }
        }
+
 }
 
 void
 AutomationLine::hide ()
 {
-       set_visibility (VisibleAspects (0));
+       /* leave control points setting unchanged, we are just hiding the
+          overall line 
+       */
+       
+       set_visibility (AutomationLine::VisibleAspects (_visible & ~Line));
 }
 
 double
 AutomationLine::control_point_box_size ()
 {
-       if (alist->interpolation() == AutomationList::Discrete) {
-               return max((_height*4.0) / (double)(alist->parameter().max() - alist->parameter().min()),
-                               4.0);
-       }
-
        if (_height > TimeAxisView::preset_height (HeightLarger)) {
                return 8.0;
        } else if (_height > (guint32) TimeAxisView::preset_height (HeightNormal)) {
@@ -256,17 +283,16 @@ AutomationLine::modify_point_y (ControlPoint& cp, double y)
 
        double const x = trackview.editor().sample_to_pixel_unrounded (_time_converter->to((*cp.model())->when) - _offset);
 
-       trackview.editor().session()->begin_reversible_command (_("automation event move"));
+       trackview.editor().begin_reversible_command (_("automation event move"));
        trackview.editor().session()->add_command (
-               new MementoCommand<AutomationList> (memento_command_binder(), &get_state(), 0)
-               );
+               new MementoCommand<AutomationList> (memento_command_binder(), &get_state(), 0));
 
        cp.move_to (x, y, ControlPoint::Full);
 
        reset_line_coords (cp);
 
        if (line_points.size() > 1) {
-               line->set (line_points);
+               line->set_steps (line_points, is_stepped());
        }
 
        alist->freeze ();
@@ -276,10 +302,9 @@ AutomationLine::modify_point_y (ControlPoint& cp, double y)
        update_pending = false;
 
        trackview.editor().session()->add_command (
-               new MementoCommand<AutomationList> (memento_command_binder(), 0, &alist->get_state())
-               );
+               new MementoCommand<AutomationList> (memento_command_binder(), 0, &alist->get_state()));
 
-       trackview.editor().session()->commit_reversible_command ();
+       trackview.editor().commit_reversible_command ();
        trackview.editor().session()->set_dirty ();
 }
 
@@ -345,24 +370,20 @@ AutomationLine::get_verbose_cursor_relative_string (double original, double frac
 string
 AutomationLine::fraction_to_string (double fraction) const
 {
-       char buf[32];
-
        if (_uses_gain_mapping) {
+               char buf[32];
                if (fraction == 0.0) {
                        snprintf (buf, sizeof (buf), "-inf");
                } else {
                        snprintf (buf, sizeof (buf), "%.1f", accurate_coefficient_to_dB (slider_position_to_gain_with_max (fraction, Config->get_max_gain())));
                }
+               return buf;
        } else {
                view_to_model_coord_y (fraction);
-               if (EventTypeMap::instance().is_integer (alist->parameter())) {
-                       snprintf (buf, sizeof (buf), "%d", (int)fraction);
-               } else {
-                       snprintf (buf, sizeof (buf), "%.2f", fraction);
-               }
+               return ARDOUR::value_as_string (_desc, fraction);
        }
 
-       return buf;
+       return ""; /*NOTREACHED*/
 }
 
 /**
@@ -395,11 +416,7 @@ AutomationLine::fraction_to_relative_string (double original, double fraction) c
        } else {
                view_to_model_coord_y (original);
                view_to_model_coord_y (fraction);
-               if (EventTypeMap::instance().is_integer (alist->parameter())) {
-                       snprintf (buf, sizeof (buf), "%d", (int)fraction - (int)original);
-               } else {
-                       snprintf (buf, sizeof (buf), "%.2f", fraction - original);
-               }
+               return ARDOUR::value_as_string (_desc, fraction - original);
        }
 
        return buf;
@@ -439,10 +456,9 @@ AutomationLine::string_to_fraction (string const & s) const
 void
 AutomationLine::start_drag_single (ControlPoint* cp, double x, float fraction)
 {
-       trackview.editor().session()->begin_reversible_command (_("automation event move"));
+       trackview.editor().begin_reversible_command (_("automation event move"));
        trackview.editor().session()->add_command (
-               new MementoCommand<AutomationList> (memento_command_binder(), &get_state(), 0)
-               );
+               new MementoCommand<AutomationList> (memento_command_binder(), &get_state(), 0));
 
        _drag_points.clear ();
        _drag_points.push_back (cp);
@@ -466,10 +482,9 @@ AutomationLine::start_drag_single (ControlPoint* cp, double x, float fraction)
 void
 AutomationLine::start_drag_line (uint32_t i1, uint32_t i2, float fraction)
 {
-       trackview.editor().session()->begin_reversible_command (_("automation range move"));
+       trackview.editor().begin_reversible_command (_("automation range move"));
        trackview.editor().session()->add_command (
-               new MementoCommand<AutomationList> (memento_command_binder (), &get_state(), 0)
-               );
+               new MementoCommand<AutomationList> (memento_command_binder (), &get_state(), 0));
 
        _drag_points.clear ();
 
@@ -487,10 +502,9 @@ AutomationLine::start_drag_line (uint32_t i1, uint32_t i2, float fraction)
 void
 AutomationLine::start_drag_multiple (list<ControlPoint*> cp, float fraction, XMLNode* state)
 {
-       trackview.editor().session()->begin_reversible_command (_("automation range move"));
+       trackview.editor().begin_reversible_command (_("automation range move"));
        trackview.editor().session()->add_command (
-               new MementoCommand<AutomationList> (memento_command_binder(), state, 0)
-               );
+               new MementoCommand<AutomationList> (memento_command_binder(), state, 0));
 
        _drag_points = cp;
        start_drag_common (0, fraction);
@@ -512,11 +526,12 @@ AutomationLine::ContiguousControlPoints::ContiguousControlPoints (AutomationLine
 }
 
 void
-AutomationLine::ContiguousControlPoints::compute_x_bounds ()
+AutomationLine::ContiguousControlPoints::compute_x_bounds (PublicEditor& e)
 {
        uint32_t sz = size();
 
        if (sz > 0 && sz < line.npoints()) {
+               const TempoMap& map (e.session()->tempo_map());
 
                /* determine the limits on x-axis motion for this 
                   contiguous range of control points
@@ -524,14 +539,30 @@ AutomationLine::ContiguousControlPoints::compute_x_bounds ()
 
                if (front()->view_index() > 0) {
                        before_x = line.nth (front()->view_index() - 1)->get_x();
+
+                       const framepos_t pos = e.pixel_to_sample(before_x);
+                       const Meter& meter = map.meter_at (pos);
+                       const framecnt_t len = ceil (meter.frames_per_bar (map.tempo_at (pos), e.session()->frame_rate())
+                                       / (Timecode::BBT_Time::ticks_per_beat * meter.divisions_per_bar()) );
+                       const double one_tick_in_pixels = e.sample_to_pixel_unrounded (len);
+
+                       before_x += one_tick_in_pixels;
                }
 
                /* if our last point has a point after it in the line,
                   we have an "after" bound
                */
 
-               if (back()->view_index() < (line.npoints() - 2)) {
+               if (back()->view_index() < (line.npoints() - 1)) {
                        after_x = line.nth (back()->view_index() + 1)->get_x();
+
+                       const framepos_t pos = e.pixel_to_sample(after_x);
+                       const Meter& meter = map.meter_at (pos);
+                       const framecnt_t len = ceil (meter.frames_per_bar (map.tempo_at (pos), e.session()->frame_rate())
+                                       / (Timecode::BBT_Time::ticks_per_beat * meter.divisions_per_bar()));
+                       const double one_tick_in_pixels = e.sample_to_pixel_unrounded (len);
+
+                       after_x -= one_tick_in_pixels;
                }
        }
 }
@@ -635,7 +666,7 @@ AutomationLine::drag_motion (double const x, float fraction, bool ignore_x, bool
                }
 
                for (vector<CCP>::iterator ccp = contiguous_points.begin(); ccp != contiguous_points.end(); ++ccp) {
-                       (*ccp)->compute_x_bounds ();
+                       (*ccp)->compute_x_bounds (trackview.editor());
                }
        }       
 
@@ -690,7 +721,7 @@ AutomationLine::drag_motion (double const x, float fraction, bool ignore_x, bool
                 */
 
                if (line_points.size() > 1) {
-                       line->set (line_points);
+                       line->set_steps (line_points, is_stepped());
                }
        }
        
@@ -728,8 +759,7 @@ AutomationLine::end_drag (bool with_push, uint32_t final_index)
        update_pending = false;
 
        trackview.editor().session()->add_command (
-               new MementoCommand<AutomationList>(memento_command_binder (), 0, &alist->get_state())
-               );
+               new MementoCommand<AutomationList>(memento_command_binder (), 0, &alist->get_state()));
 
        trackview.editor().session()->set_dirty ();
        did_push = false;
@@ -827,16 +857,15 @@ AutomationLine::is_first_point (ControlPoint& cp)
 void
 AutomationLine::remove_point (ControlPoint& cp)
 {
-       trackview.editor().session()->begin_reversible_command (_("remove control point"));
+       trackview.editor().begin_reversible_command (_("remove control point"));
        XMLNode &before = alist->get_state();
 
        alist->erase (cp.model());
        
        trackview.editor().session()->add_command(
-               new MementoCommand<AutomationList> (memento_command_binder (), &before, &alist->get_state())
-               );
+               new MementoCommand<AutomationList> (memento_command_binder (), &before, &alist->get_state()));
 
-       trackview.editor().session()->commit_reversible_command ();
+       trackview.editor().commit_reversible_command ();
        trackview.editor().session()->set_dirty ();
 }
 
@@ -886,12 +915,18 @@ AutomationLine::set_selected_points (PointSelection const & points)
                (*i)->set_selected (true);
        }
 
+       if (points.empty()) {
+               remove_visibility (SelectedControlPoints);
+       } else {
+               add_visibility (SelectedControlPoints);
+       }
+
        set_colors ();
 }
 
 void AutomationLine::set_colors ()
 {
-       set_line_color (ARDOUR_UI::config()->get_canvasvar_AutomationLine());
+       set_line_color (ARDOUR_UI::config()->color ("automation line"));
        for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
                (*i)->set_color ();
        }
@@ -944,9 +979,9 @@ AutomationLine::reset_callback (const Evoral::ControlList& events)
 
                model_to_view_coord (tx, ty);
 
-               if (isnan (tx) || isnan (ty)) {
+               if (isnan_local (tx) || isnan_local (ty)) {
                        warning << string_compose (_("Ignoring illegal points on AutomationLine \"%1\""),
-                                                  _name) << endmsg;
+                                                  _name) << endmsg;
                        continue;
                }
                
@@ -999,11 +1034,9 @@ AutomationLine::reset_callback (const Evoral::ControlList& events)
                        line_points[n].y = control_points[n]->get_y();
                }
 
-               line->set (line_points);
+               line->set_steps (line_points, is_stepped());
 
-               if (_visible && alist->interpolation() != AutomationList::Discrete) {
-                       line->show();
-               }
+               update_visibility ();
        }
 
        set_selected_points (trackview.editor().get_selection().points);
@@ -1052,13 +1085,7 @@ AutomationLine::clear ()
        alist->clear();
 
        trackview.editor().session()->add_command (
-               new MementoCommand<AutomationList> (memento_command_binder (), &before, &alist->get_state())
-               );
-}
-
-void
-AutomationLine::change_model (AutomationList::iterator /*i*/, double /*x*/, double /*y*/)
-{
+               new MementoCommand<AutomationList> (memento_command_binder (), &before, &alist->get_state()));
 }
 
 void
@@ -1072,38 +1099,46 @@ AutomationLine::set_list (boost::shared_ptr<ARDOUR::AutomationList> list)
 void
 AutomationLine::add_visibility (VisibleAspects va)
 {
+       VisibleAspects old = _visible;
+
        _visible = VisibleAspects (_visible | va);
-       show ();
+
+       if (old != _visible) {
+               update_visibility ();
+       }
 }
 
 void
 AutomationLine::set_visibility (VisibleAspects va)
 {
-       _visible = va;
-       show ();
+       if (_visible != va) {
+               _visible = va;
+               update_visibility ();
+       }
 }
 
 void
 AutomationLine::remove_visibility (VisibleAspects va)
 {
+       VisibleAspects old = _visible;
+
        _visible = VisibleAspects (_visible & ~va);
-       show ();
+
+       if (old != _visible) {
+               update_visibility ();
+       }
 }
 
 void
 AutomationLine::track_entered()
 {
-       if (alist->interpolation() != AutomationList::Discrete) {
-               add_visibility (ControlPoints);
-       }
+       add_visibility (ControlPoints);
 }
 
 void
 AutomationLine::track_exited()
 {
-       if (alist->interpolation() != AutomationList::Discrete) {
-               remove_visibility (ControlPoints);
-       }
+       remove_visibility (ControlPoints);
 }
 
 XMLNode &
@@ -1130,41 +1165,46 @@ AutomationLine::view_to_model_coord (double& x, double& y) const
 void
 AutomationLine::view_to_model_coord_y (double& y) const
 {
-       /* TODO: This should be more generic ... */
+       /* TODO: This should be more generic (use ParameterDescriptor) */
        if (alist->parameter().type() == GainAutomation ||
            alist->parameter().type() == EnvelopeAutomation) {
                y = slider_position_to_gain_with_max (y, Config->get_max_gain());
                y = max (0.0, y);
                y = min (2.0, y);
        } else if (alist->parameter().type() == PanAzimuthAutomation ||
-                   alist->parameter().type() == PanElevationAutomation ||
-                   alist->parameter().type() == PanWidthAutomation) {
+                  alist->parameter().type() == PanElevationAutomation) {
                y = 1.0 - y;
-       } else if (alist->parameter().type() == PluginAutomation) {
-               y = y * (double)(alist->get_max_y()- alist->get_min_y()) + alist->get_min_y();
+       } else if (alist->parameter().type() == PanWidthAutomation) {
+               y = 2.0 * y - 1.0;
        } else {
-               y = rint (y * alist->parameter().max());
+               y = y * (double)(alist->get_max_y() - alist->get_min_y()) + alist->get_min_y();
+               if (_desc.toggled || _desc.integer_step) {
+                       y = round(y);
+               }
        }
 }
 
 void
-AutomationLine::model_to_view_coord (double& x, double& y) const
+AutomationLine::model_to_view_coord_y (double& y) const
 {
-       /* TODO: This should be more generic ... */
+       /* TODO: This should be more generic (use ParameterDescriptor) */
        if (alist->parameter().type() == GainAutomation ||
            alist->parameter().type() == EnvelopeAutomation) {
                y = gain_to_slider_position_with_max (y, Config->get_max_gain());
        } else if (alist->parameter().type() == PanAzimuthAutomation ||
-                   alist->parameter().type() == PanElevationAutomation ||
-                   alist->parameter().type() == PanWidthAutomation) {
-               // vertical coordinate axis reversal
+                  alist->parameter().type() == PanElevationAutomation) {
                y = 1.0 - y;
-       } else if (alist->parameter().type() == PluginAutomation) {
-               y = (y - alist->get_min_y()) / (double)(alist->get_max_y()- alist->get_min_y());
+       } else if (alist->parameter().type() == PanWidthAutomation) {
+               y = .5 + y * .5;
        } else {
-               y = y / (double)alist->parameter().max(); /* ... like this */
+               y = (y - alist->get_min_y()) / (double)(alist->get_max_y() - alist->get_min_y());
        }
+}
 
+void
+AutomationLine::model_to_view_coord (double& x, double& y) const
+{
+       model_to_view_coord_y (y);
        x = _time_converter->to (x) - _offset;
 }
 
@@ -1172,17 +1212,14 @@ AutomationLine::model_to_view_coord (double& x, double& y) const
 void
 AutomationLine::interpolation_changed (AutomationList::InterpolationStyle style)
 {
-       if (style == AutomationList::Discrete) {
-               set_visibility (ControlPoints);
-               line->hide();
-       } else {
-               set_visibility (Line);
+       if (line_points.size() > 1) {
+               line->set_steps(line_points, is_stepped());
        }
 }
 
 void
 AutomationLine::add_visible_control_point (uint32_t view_index, uint32_t pi, double tx, double ty, 
-                                          AutomationList::iterator model, uint32_t npoints)
+                                           AutomationList::iterator model, uint32_t npoints)
 {
        ControlPoint::ShapeType shape;
 
@@ -1222,9 +1259,8 @@ AutomationLine::add_visible_control_point (uint32_t view_index, uint32_t pi, dou
 
        if (_visible & ControlPoints) {
                control_points[view_index]->show ();
-               control_points[view_index]->set_visible (true);
        } else {
-               control_points[view_index]->set_visible (false);
+               control_points[view_index]->hide ();
        }
 }
 
@@ -1236,8 +1272,7 @@ AutomationLine::connect_to_list ()
        alist->StateChanged.connect (_list_connections, invalidator (*this), boost::bind (&AutomationLine::list_changed, this), gui_context());
 
        alist->InterpolationChanged.connect (
-               _list_connections, invalidator (*this), boost::bind (&AutomationLine::interpolation_changed, this, _1), gui_context()
-               );
+               _list_connections, invalidator (*this), boost::bind (&AutomationLine::interpolation_changed, this, _1), gui_context());
 }
 
 MementoCommandBinder<AutomationList>*