gtk2_ardour/automation_line.cc

   1 /*
   2     Copyright (C) 2002-2003 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <cmath>
  21
  22 #ifdef COMPILER_MSVC
  23 #include <float.h>
  24
  25 // 'std::isnan()' is not available in MSVC.
  26 #define isnan_local(val) (bool)_isnan((double)val)
  27 #else
  28 #define isnan_local std::isnan
  29 #endif
  30
  31 #include <climits>
  32 #include <vector>
  33 #include <fstream>
  34
  35 #include "boost/shared_ptr.hpp"
  36
  37 #include "pbd/floating.h"
  38 #include "pbd/memento_command.h"
  39 #include "pbd/stl_delete.h"
  40 #include "pbd/stacktrace.h"
  41
  42 #include "ardour/automation_list.h"
  43 #include "ardour/dB.h"
  44 #include "ardour/debug.h"
  45 #include "ardour/parameter_types.h"
  46 #include "ardour/tempo.h"
  47
  48 #include "evoral/Curve.hpp"
  49
  50 #include "canvas/debug.h"
  51
  52 #include "automation_line.h"
  53 #include "control_point.h"
  54 #include "gui_thread.h"
  55 #include "rgb_macros.h"
  56 #include "ardour_ui.h"
  57 #include "public_editor.h"
  58 #include "selection.h"
  59 #include "time_axis_view.h"
  60 #include "point_selection.h"
  61 #include "automation_time_axis.h"
  62
  63 #include "ardour/event_type_map.h"
  64 #include "ardour/session.h"
  65 #include "ardour/value_as_string.h"
  66
  67 #include "i18n.h"
  68
  69 using namespace std;
  70 using namespace ARDOUR;
  71 using namespace PBD;
  72 using namespace Editing;
  73
  74 /** @param converter A TimeConverter whose origin_b is the start time of the AutomationList in session frames.
  75  *  This will not be deleted by AutomationLine.
  76  */
  77 AutomationLine::AutomationLine (const string&                              name,
  78                                 TimeAxisView&                              tv,
  79                                 ArdourCanvas::Item&                        parent,
  80                                 boost::shared_ptr<AutomationList>          al,
  81                                 const ParameterDescriptor&                 desc,
  82                                 Evoral::TimeConverter<double, framepos_t>* converter)
  83         : trackview (tv)
  84         , _name (name)
  85         , alist (al)
  86         , _time_converter (converter ? converter : new Evoral::IdentityConverter<double, framepos_t>)
  87         , _parent_group (parent)
  88         , _offset (0)
  89         , _maximum_time (max_framepos)
  90         , _desc (desc)
  91 {
  92         if (converter) {
  93                 _our_time_converter = false;
  94         } else {
  95                 _our_time_converter = true;
  96         }
  97
  98         _visible = Line;
  99
 100         update_pending = false;
 101         have_timeout = false;
 102         _uses_gain_mapping = false;
 103         no_draw = false;
 104         _is_boolean = false;
 105         terminal_points_can_slide = true;
 106         _height = 0;
 107
 108         group = new ArdourCanvas::Container (&parent, ArdourCanvas::Duple(0, 1.5));
 109         CANVAS_DEBUG_NAME (group, "region gain envelope group");
 110
 111         line = new ArdourCanvas::PolyLine (group);
 112         CANVAS_DEBUG_NAME (line, "region gain envelope line");
 113         line->set_data ("line", this);
 114         line->set_outline_width (2.0);
 115         line->set_covers_threshold (4.0);
 116
 117         line->Event.connect (sigc::mem_fun (*this, &AutomationLine::event_handler));
 118
 119         trackview.session()->register_with_memento_command_factory(alist->id(), this);
 120
 121         if (alist->parameter().type() == GainAutomation ||
 122             alist->parameter().type() == TrimAutomation ||
 123             alist->parameter().type() == EnvelopeAutomation ||
 124             desc.unit == ParameterDescriptor::DB) {
 125                 set_uses_gain_mapping (true);
 126         }
 127
 128         interpolation_changed (alist->interpolation ());
 129
 130         connect_to_list ();
 131 }
 132
 133 AutomationLine::~AutomationLine ()
 134 {
 135         vector_delete (&control_points);
 136         delete group;
 137
 138         if (_our_time_converter) {
 139                 delete _time_converter;
 140         }
 141 }
 142
 143 bool
 144 AutomationLine::event_handler (GdkEvent* event)
 145 {
 146         return PublicEditor::instance().canvas_line_event (event, line, this);
 147 }
 148
 149 bool
 150 AutomationLine::is_stepped() const
 151 {
 152         return (_desc.toggled ||
 153                 (alist && alist->interpolation() == AutomationList::Discrete));
 154 }
 155
 156 void
 157 AutomationLine::update_visibility ()
 158 {
 159         if (_visible & Line) {
 160                 /* Only show the line when there are some points, otherwise we may show an out-of-date line
 161                    when automation points have been removed (the line will still follow the shape of the
 162                    old points).
 163                 */
 164                 if (control_points.size() >= 2) {
 165                         line->show();
 166                 } else {
 167                         line->hide ();
 168                 }
 169
 170                 if (_visible & ControlPoints) {
 171                         for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
 172                                 (*i)->show ();
 173                         }
 174                 } else if (_visible & SelectedControlPoints) {
 175                         for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
 176                                 if ((*i)->get_selected()) {
 177                                         (*i)->show ();
 178                                 } else {
 179                                         (*i)->hide ();
 180                                 }
 181                         }
 182                 } else {
 183                         for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
 184                                 (*i)->hide ();
 185                         }
 186                 }
 187
 188         } else {
 189                 line->hide ();
 190                 for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
 191                         if (_visible & ControlPoints) {
 192                                 (*i)->show ();
 193                         } else {
 194                                 (*i)->hide ();
 195                         }
 196                 }
 197         }
 198
 199 }
 200
 201 void
 202 AutomationLine::hide ()
 203 {
 204         /* leave control points setting unchanged, we are just hiding the
 205            overall line
 206         */
 207
 208         set_visibility (AutomationLine::VisibleAspects (_visible & ~Line));
 209 }
 210
 211 double
 212 AutomationLine::control_point_box_size ()
 213 {
 214         if (_height > TimeAxisView::preset_height (HeightLarger)) {
 215                 return 8.0;
 216         } else if (_height > (guint32) TimeAxisView::preset_height (HeightNormal)) {
 217                 return 6.0;
 218         }
 219         return 4.0;
 220 }
 221
 222 void
 223 AutomationLine::set_height (guint32 h)
 224 {
 225         if (h != _height) {
 226                 _height = h;
 227
 228                 double bsz = control_point_box_size();
 229
 230                 for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
 231                         (*i)->set_size (bsz);
 232                 }
 233
 234                 reset ();
 235         }
 236 }
 237
 238 void
 239 AutomationLine::set_line_color (uint32_t color)
 240 {
 241         _line_color = color;
 242         line->set_outline_color (color);
 243 }
 244
 245 void
 246 AutomationLine::set_uses_gain_mapping (bool yn)
 247 {
 248         if (yn != _uses_gain_mapping) {
 249                 _uses_gain_mapping = yn;
 250                 reset ();
 251         }
 252 }
 253
 254 ControlPoint*
 255 AutomationLine::nth (uint32_t n)
 256 {
 257         if (n < control_points.size()) {
 258                 return control_points[n];
 259         } else {
 260                 return 0;
 261         }
 262 }
 263
 264 ControlPoint const *
 265 AutomationLine::nth (uint32_t n) const
 266 {
 267         if (n < control_points.size()) {
 268                 return control_points[n];
 269         } else {
 270                 return 0;
 271         }
 272 }
 273
 274 void
 275 AutomationLine::modify_point_y (ControlPoint& cp, double y)
 276 {
 277         /* clamp y-coord appropriately. y is supposed to be a normalized fraction (0.0-1.0),
 278            and needs to be converted to a canvas unit distance.
 279         */
 280
 281         y = max (0.0, y);
 282         y = min (1.0, y);
 283         y = _height - (y * _height);
 284
 285         double const x = trackview.editor().sample_to_pixel_unrounded (_time_converter->to((*cp.model())->when) - _offset);
 286
 287         trackview.editor().begin_reversible_command (_("automation event move"));
 288         trackview.editor().session()->add_command (
 289                 new MementoCommand<AutomationList> (memento_command_binder(), &get_state(), 0));
 290
 291         cp.move_to (x, y, ControlPoint::Full);
 292
 293         alist->freeze ();
 294         sync_model_with_view_point (cp);
 295         alist->thaw ();
 296
 297         reset_line_coords (cp);
 298
 299         if (line_points.size() > 1) {
 300                 line->set_steps (line_points, is_stepped());
 301         }
 302
 303         update_pending = false;
 304
 305         trackview.editor().session()->add_command (
 306                 new MementoCommand<AutomationList> (memento_command_binder(), 0, &alist->get_state()));
 307
 308         trackview.editor().commit_reversible_command ();
 309         trackview.editor().session()->set_dirty ();
 310 }
 311
 312 void
 313 AutomationLine::reset_line_coords (ControlPoint& cp)
 314 {
 315         if (cp.view_index() < line_points.size()) {
 316                 line_points[cp.view_index()].x = cp.get_x ();
 317                 line_points[cp.view_index()].y = cp.get_y ();
 318         }
 319 }
 320
 321 bool
 322 AutomationLine::sync_model_with_view_points (list<ControlPoint*> cp)
 323 {
 324         update_pending = true;
 325
 326         bool moved = false;
 327         for (list<ControlPoint*>::iterator i = cp.begin(); i != cp.end(); ++i) {
 328                 moved = sync_model_with_view_point (**i) || moved;
 329         }
 330
 331         return moved;
 332 }
 333
 334 string
 335 AutomationLine::get_verbose_cursor_string (double fraction) const
 336 {
 337         std::string s = fraction_to_string (fraction);
 338         if (_uses_gain_mapping) {
 339                 s += " dB";
 340         }
 341
 342         return s;
 343 }
 344
 345 string
 346 AutomationLine::get_verbose_cursor_relative_string (double original, double fraction) const
 347 {
 348         std::string s = fraction_to_string (fraction);
 349         if (_uses_gain_mapping) {
 350                 s += " dB";
 351         }
 352
 353         std::string d = fraction_to_relative_string (original, fraction);
 354
 355         if (!d.empty()) {
 356
 357                 s += " (\u0394";
 358                 s += d;
 359
 360                 if (_uses_gain_mapping) {
 361                         s += " dB";
 362                 }
 363
 364                 s += ')';
 365         }
 366
 367         return s;
 368 }
 369
 370 /**
 371  *  @param fraction y fraction
 372  *  @return string representation of this value, using dB if appropriate.
 373  */
 374 string
 375 AutomationLine::fraction_to_string (double fraction) const
 376 {
 377         if (_uses_gain_mapping) {
 378                 char buf[32];
 379                 if (_desc.type == GainAutomation || _desc.type == EnvelopeAutomation || _desc.lower == 0) {
 380                         if (fraction == 0.0) {
 381                                 snprintf (buf, sizeof (buf), "-inf");
 382                         } else {
 383                                 snprintf (buf, sizeof (buf), "%.1f", accurate_coefficient_to_dB (slider_position_to_gain_with_max (fraction, _desc.upper)));
 384                         }
 385                 } else {
 386                         const double lower_db = accurate_coefficient_to_dB (_desc.lower);
 387                         const double range_db = accurate_coefficient_to_dB (_desc.upper) - lower_db;
 388                         snprintf (buf, sizeof (buf), "%.1f", lower_db + fraction * range_db);
 389                 }
 390                 return buf;
 391         } else {
 392                 view_to_model_coord_y (fraction);
 393                 return ARDOUR::value_as_string (_desc, fraction);
 394         }
 395
 396         return ""; /*NOTREACHED*/
 397 }
 398
 399 /**
 400  *  @param original an old y-axis fraction
 401  *  @param fraction the new y fraction
 402  *  @return string representation of the difference between original and fraction, using dB if appropriate.
 403  */
 404 string
 405 AutomationLine::fraction_to_relative_string (double original, double fraction) const
 406 {
 407         char buf[32];
 408
 409         if (original == fraction) {
 410                 return "0";
 411         }
 412
 413         if (_uses_gain_mapping) {
 414                 if (original == 0.0) {
 415                         /* there is no sensible representation of a relative
 416                            change from -inf dB, so return an empty string.
 417                         */
 418                         return "";
 419                 } else if (fraction == 0.0) {
 420                         snprintf (buf, sizeof (buf), "-inf");
 421                 } else {
 422                         double old_db = accurate_coefficient_to_dB (slider_position_to_gain_with_max (original, Config->get_max_gain()));
 423                         double new_db = accurate_coefficient_to_dB (slider_position_to_gain_with_max (fraction, Config->get_max_gain()));
 424                         snprintf (buf, sizeof (buf), "%.1f", new_db - old_db);
 425                 }
 426         } else {
 427                 view_to_model_coord_y (original);
 428                 view_to_model_coord_y (fraction);
 429                 return ARDOUR::value_as_string (_desc, fraction - original);
 430         }
 431
 432         return buf;
 433 }
 434
 435 /**
 436  *  @param s Value string in the form as returned by fraction_to_string.
 437  *  @return Corresponding y fraction.
 438  */
 439 double
 440 AutomationLine::string_to_fraction (string const & s) const
 441 {
 442         if (s == "-inf") {
 443                 return 0;
 444         }
 445
 446         double v;
 447         sscanf (s.c_str(), "%lf", &v);
 448
 449         if (_uses_gain_mapping) {
 450                 v = gain_to_slider_position_with_max (dB_to_coefficient (v), Config->get_max_gain());
 451         } else {
 452                 double dummy = 0.0;
 453                 model_to_view_coord (dummy, v);
 454         }
 455
 456         return v;
 457 }
 458
 459 /** Start dragging a single point, possibly adding others if the supplied point is selected and there
 460  *  are other selected points.
 461  *
 462  *  @param cp Point to drag.
 463  *  @param x Initial x position (units).
 464  *  @param fraction Initial y position (as a fraction of the track height, where 0 is the bottom and 1 the top)
 465  */
 466 void
 467 AutomationLine::start_drag_single (ControlPoint* cp, double x, float fraction)
 468 {
 469         trackview.editor().session()->add_command (
 470                 new MementoCommand<AutomationList> (memento_command_binder(), &get_state(), 0));
 471
 472         _drag_points.clear ();
 473         _drag_points.push_back (cp);
 474
 475         if (cp->get_selected ()) {
 476                 for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
 477                         if (*i != cp && (*i)->get_selected()) {
 478                                 _drag_points.push_back (*i);
 479                         }
 480                 }
 481         }
 482
 483         start_drag_common (x, fraction);
 484 }
 485
 486 /** Start dragging a line vertically (with no change in x)
 487  *  @param i1 Control point index of the `left' point on the line.
 488  *  @param i2 Control point index of the `right' point on the line.
 489  *  @param fraction Initial y position (as a fraction of the track height, where 0 is the bottom and 1 the top)
 490  */
 491 void
 492 AutomationLine::start_drag_line (uint32_t i1, uint32_t i2, float fraction)
 493 {
 494         trackview.editor().session()->add_command (
 495                 new MementoCommand<AutomationList> (memento_command_binder (), &get_state(), 0));
 496
 497         _drag_points.clear ();
 498
 499         for (uint32_t i = i1; i <= i2; i++) {
 500                 _drag_points.push_back (nth (i));
 501         }
 502
 503         start_drag_common (0, fraction);
 504 }
 505
 506 /** Start dragging multiple points (with no change in x)
 507  *  @param cp Points to drag.
 508  *  @param fraction Initial y position (as a fraction of the track height, where 0 is the bottom and 1 the top)
 509  */
 510 void
 511 AutomationLine::start_drag_multiple (list<ControlPoint*> cp, float fraction, XMLNode* state)
 512 {
 513         trackview.editor().session()->add_command (
 514                 new MementoCommand<AutomationList> (memento_command_binder(), state, 0));
 515
 516         _drag_points = cp;
 517         start_drag_common (0, fraction);
 518 }
 519
 520 struct ControlPointSorter
 521 {
 522         bool operator() (ControlPoint const * a, ControlPoint const * b) const {
 523                 if (floateq (a->get_x(), b->get_x(), 1)) {
 524                         return a->view_index() < b->view_index();
 525                 }
 526                 return a->get_x() < b->get_x();
 527         }
 528 };
 529
 530 AutomationLine::ContiguousControlPoints::ContiguousControlPoints (AutomationLine& al)
 531         : line (al), before_x (0), after_x (DBL_MAX)
 532 {
 533 }
 534
 535 void
 536 AutomationLine::ContiguousControlPoints::compute_x_bounds (PublicEditor& e)
 537 {
 538         uint32_t sz = size();
 539
 540         if (sz > 0 && sz < line.npoints()) {
 541                 const TempoMap& map (e.session()->tempo_map());
 542
 543                 /* determine the limits on x-axis motion for this
 544                    contiguous range of control points
 545                 */
 546
 547                 if (front()->view_index() > 0) {
 548                         before_x = line.nth (front()->view_index() - 1)->get_x();
 549
 550                         const framepos_t pos = e.pixel_to_sample(before_x);
 551                         const Meter& meter = map.meter_at (pos);
 552                         const framecnt_t len = ceil (meter.frames_per_bar (map.tempo_at (pos), e.session()->frame_rate())
 553                                         / (Timecode::BBT_Time::ticks_per_beat * meter.divisions_per_bar()) );
 554                         const double one_tick_in_pixels = e.sample_to_pixel_unrounded (len);
 555
 556                         before_x += one_tick_in_pixels;
 557                 }
 558
 559                 /* if our last point has a point after it in the line,
 560                    we have an "after" bound
 561                 */
 562
 563                 if (back()->view_index() < (line.npoints() - 1)) {
 564                         after_x = line.nth (back()->view_index() + 1)->get_x();
 565
 566                         const framepos_t pos = e.pixel_to_sample(after_x);
 567                         const Meter& meter = map.meter_at (pos);
 568                         const framecnt_t len = ceil (meter.frames_per_bar (map.tempo_at (pos), e.session()->frame_rate())
 569                                         / (Timecode::BBT_Time::ticks_per_beat * meter.divisions_per_bar()));
 570                         const double one_tick_in_pixels = e.sample_to_pixel_unrounded (len);
 571
 572                         after_x -= one_tick_in_pixels;
 573                 }
 574         }
 575 }
 576
 577 double
 578 AutomationLine::ContiguousControlPoints::clamp_dx (double dx)
 579 {
 580         if (empty()) {
 581                 return dx;
 582         }
 583
 584         /* get the maximum distance we can move any of these points along the x-axis
 585          */
 586
 587         double tx; /* possible position a point would move to, given dx */
 588         ControlPoint* cp;
 589
 590         if (dx > 0) {
 591                 /* check the last point, since we're moving later in time */
 592                 cp = back();
 593         } else {
 594                 /* check the first point, since we're moving earlier in time */
 595                 cp = front();
 596         }
 597
 598         tx = cp->get_x() + dx; // new possible position if we just add the motion
 599         tx = max (tx, before_x); // can't move later than following point
 600         tx = min (tx, after_x);  // can't move earlier than preceeding point
 601         return  tx - cp->get_x ();
 602 }
 603
 604 void
 605 AutomationLine::ContiguousControlPoints::move (double dx, double dy)
 606 {
 607         for (std::list<ControlPoint*>::iterator i = begin(); i != end(); ++i) {
 608                 (*i)->move_to ((*i)->get_x() + dx, (*i)->get_y() - line.height() * dy, ControlPoint::Full);
 609                 line.reset_line_coords (**i);
 610         }
 611 }
 612
 613 /** Common parts of starting a drag.
 614  *  @param x Starting x position in units, or 0 if x is being ignored.
 615  *  @param fraction Starting y position (as a fraction of the track height, where 0 is the bottom and 1 the top)
 616  */
 617 void
 618 AutomationLine::start_drag_common (double x, float fraction)
 619 {
 620         _drag_x = x;
 621         _drag_distance = 0;
 622         _last_drag_fraction = fraction;
 623         _drag_had_movement = false;
 624         did_push = false;
 625
 626         /* they are probably ordered already, but we have to make sure */
 627
 628         _drag_points.sort (ControlPointSorter());
 629 }
 630
 631
 632 /** Should be called to indicate motion during a drag.
 633  *  @param x New x position of the drag in canvas units, or undefined if ignore_x == true.
 634  *  @param fraction New y fraction.
 635  *  @return x position and y fraction that were actually used (once clamped).
 636  */
 637 pair<double, float>
 638 AutomationLine::drag_motion (double const x, float fraction, bool ignore_x, bool with_push, uint32_t& final_index)
 639 {
 640         if (_drag_points.empty()) {
 641                 return pair<double,float> (x,fraction);
 642         }
 643
 644         double dx = ignore_x ? 0 : (x - _drag_x);
 645         double dy = fraction - _last_drag_fraction;
 646
 647         if (!_drag_had_movement) {
 648
 649                 /* "first move" ... do some stuff that we don't want to do if
 650                    no motion ever took place, but need to do before we handle
 651                    motion.
 652                 */
 653
 654                 /* partition the points we are dragging into (potentially several)
 655                  * set(s) of contiguous points. this will not happen with a normal
 656                  * drag, but if the user does a discontiguous selection, it can.
 657                  */
 658
 659                 uint32_t expected_view_index = 0;
 660                 CCP contig;
 661
 662                 for (list<ControlPoint*>::iterator i = _drag_points.begin(); i != _drag_points.end(); ++i) {
 663                         if (i == _drag_points.begin() || (*i)->view_index() != expected_view_index) {
 664                                 contig.reset (new ContiguousControlPoints (*this));
 665                                 contiguous_points.push_back (contig);
 666                         }
 667                         contig->push_back (*i);
 668                         expected_view_index = (*i)->view_index() + 1;
 669                 }
 670
 671                 if (contiguous_points.back()->empty()) {
 672                         contiguous_points.pop_back ();
 673                 }
 674
 675                 for (vector<CCP>::iterator ccp = contiguous_points.begin(); ccp != contiguous_points.end(); ++ccp) {
 676                         (*ccp)->compute_x_bounds (trackview.editor());
 677                 }
 678         }
 679
 680         /* OK, now on to the stuff related to *this* motion event. First, for
 681          * each contiguous range, figure out the maximum x-axis motion we are
 682          * allowed (because of neighbouring points that are not moving.
 683          *
 684          * if we are moving forwards with push, we don't need to do this,
 685          * since all later points will move too.
 686          */
 687
 688         if (dx < 0 || ((dx > 0) && !with_push)) {
 689                 for (vector<CCP>::iterator ccp = contiguous_points.begin(); ccp != contiguous_points.end(); ++ccp) {
 690                         double dxt = (*ccp)->clamp_dx (dx);
 691                         if (fabs (dxt) < fabs (dx)) {
 692                                 dx = dxt;
 693                         }
 694                 }
 695         }
 696
 697         /* clamp y */
 698
 699         for (list<ControlPoint*>::iterator i = _drag_points.begin(); i != _drag_points.end(); ++i) {
 700                 double const y = ((_height - (*i)->get_y()) / _height) + dy;
 701                 if (y < 0) {
 702                         dy -= y;
 703                 }
 704                 if (y > 1) {
 705                         dy -= (y - 1);
 706                 }
 707         }
 708
 709         if (dx || dy) {
 710
 711                 /* and now move each section */
 712
 713                 for (vector<CCP>::iterator ccp = contiguous_points.begin(); ccp != contiguous_points.end(); ++ccp) {
 714                         (*ccp)->move (dx, dy);
 715                 }
 716                 if (with_push) {
 717                         final_index = contiguous_points.back()->back()->view_index () + 1;
 718                         ControlPoint* p;
 719                         uint32_t i = final_index;
 720                         while ((p = nth (i)) != 0 && p->can_slide()) {
 721                                 p->move_to (p->get_x() + dx, p->get_y(), ControlPoint::Full);
 722                                 reset_line_coords (*p);
 723                                 ++i;
 724                         }
 725                 }
 726
 727                 /* update actual line coordinates (will queue a redraw)
 728                  */
 729
 730                 if (line_points.size() > 1) {
 731                         line->set_steps (line_points, is_stepped());
 732                 }
 733         }
 734
 735         _drag_distance += dx;
 736         _drag_x += dx;
 737         _last_drag_fraction = fraction;
 738         _drag_had_movement = true;
 739         did_push = with_push;
 740
 741         return pair<double, float> (_drag_x + dx, _last_drag_fraction + dy);
 742 }
 743
 744 /** Should be called to indicate the end of a drag */
 745 void
 746 AutomationLine::end_drag (bool with_push, uint32_t final_index)
 747 {
 748         if (!_drag_had_movement) {
 749                 return;
 750         }
 751
 752         alist->freeze ();
 753         bool moved = sync_model_with_view_points (_drag_points);
 754
 755         if (with_push) {
 756                 ControlPoint* p;
 757                 uint32_t i = final_index;
 758                 while ((p = nth (i)) != 0 && p->can_slide()) {
 759                         moved = sync_model_with_view_point (*p) || moved;
 760                         ++i;
 761                 }
 762         }
 763
 764         alist->thaw ();
 765
 766         update_pending = false;
 767
 768         if (moved) {
 769                 /* A point has moved as a result of sync (clamped to integer or boolean
 770                    value), update line accordingly. */
 771                 line->set_steps (line_points, is_stepped());
 772         }
 773
 774         trackview.editor().session()->add_command (
 775                 new MementoCommand<AutomationList>(memento_command_binder (), 0, &alist->get_state()));
 776
 777         trackview.editor().session()->set_dirty ();
 778         did_push = false;
 779
 780         contiguous_points.clear ();
 781 }
 782
 783 bool
 784 AutomationLine::sync_model_with_view_point (ControlPoint& cp)
 785 {
 786         /* find out where the visual control point is.
 787            initial results are in canvas units. ask the
 788            line to convert them to something relevant.
 789         */
 790
 791         double view_x = cp.get_x();
 792         double view_y = 1.0 - (cp.get_y() / _height);
 793
 794         /* if xval has not changed, set it directly from the model to avoid rounding errors */
 795
 796         if (view_x == trackview.editor().sample_to_pixel_unrounded (_time_converter->to ((*cp.model())->when)) - _offset) {
 797                 view_x = (*cp.model())->when - _offset;
 798         } else {
 799                 view_x = trackview.editor().pixel_to_sample (view_x);
 800                 view_x = _time_converter->from (view_x + _offset);
 801         }
 802
 803         update_pending = true;
 804
 805         view_to_model_coord_y (view_y);
 806
 807         alist->modify (cp.model(), view_x, view_y);
 808
 809         /* convert back from model to view y for clamping position (for integer/boolean/etc) */
 810         model_to_view_coord_y (view_y);
 811         const double point_y = _height - (view_y * _height);
 812         if (point_y != cp.get_y()) {
 813                 cp.move_to (cp.get_x(), point_y, ControlPoint::Full);
 814                 reset_line_coords (cp);
 815                 return true;
 816         }
 817
 818         return false;
 819 }
 820
 821 bool
 822 AutomationLine::control_points_adjacent (double xval, uint32_t & before, uint32_t& after)
 823 {
 824         ControlPoint *bcp = 0;
 825         ControlPoint *acp = 0;
 826         double unit_xval;
 827
 828         unit_xval = trackview.editor().sample_to_pixel_unrounded (xval);
 829
 830         for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
 831
 832                 if ((*i)->get_x() <= unit_xval) {
 833
 834                         if (!bcp || (*i)->get_x() > bcp->get_x()) {
 835                                 bcp = *i;
 836                                 before = bcp->view_index();
 837                         }
 838
 839                 } else if ((*i)->get_x() > unit_xval) {
 840                         acp = *i;
 841                         after = acp->view_index();
 842                         break;
 843                 }
 844         }
 845
 846         return bcp && acp;
 847 }
 848
 849 bool
 850 AutomationLine::is_last_point (ControlPoint& cp)
 851 {
 852         // If the list is not empty, and the point is the last point in the list
 853
 854         if (alist->empty()) {
 855                 return false;
 856         }
 857
 858         AutomationList::const_iterator i = alist->end();
 859         --i;
 860
 861         if (cp.model() == i) {
 862                 return true;
 863         }
 864
 865         return false;
 866 }
 867
 868 bool
 869 AutomationLine::is_first_point (ControlPoint& cp)
 870 {
 871         // If the list is not empty, and the point is the first point in the list
 872
 873         if (!alist->empty() && cp.model() == alist->begin()) {
 874                 return true;
 875         }
 876
 877         return false;
 878 }
 879
 880 // This is copied into AudioRegionGainLine
 881 void
 882 AutomationLine::remove_point (ControlPoint& cp)
 883 {
 884         trackview.editor().begin_reversible_command (_("remove control point"));
 885         XMLNode &before = alist->get_state();
 886
 887         alist->erase (cp.model());
 888
 889         trackview.editor().session()->add_command(
 890                 new MementoCommand<AutomationList> (memento_command_binder (), &before, &alist->get_state()));
 891
 892         trackview.editor().commit_reversible_command ();
 893         trackview.editor().session()->set_dirty ();
 894 }
 895
 896 /** Get selectable points within an area.
 897  *  @param start Start position in session frames.
 898  *  @param end End position in session frames.
 899  *  @param bot Bottom y range, as a fraction of line height, where 0 is the bottom of the line.
 900  *  @param top Top y range, as a fraction of line height, where 0 is the bottom of the line.
 901  *  @param result Filled in with selectable things; in this case, ControlPoints.
 902  */
 903 void
 904 AutomationLine::get_selectables (framepos_t start, framepos_t end, double botfrac, double topfrac, list<Selectable*>& results)
 905 {
 906         /* convert fractions to display coordinates with 0 at the top of the track */
 907         double const bot_track = (1 - topfrac) * trackview.current_height ();
 908         double const top_track = (1 - botfrac) * trackview.current_height ();
 909
 910         for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
 911                 double const model_when = (*(*i)->model())->when;
 912
 913                 /* model_when is relative to the start of the source, so we just need to add on the origin_b here
 914                    (as it is the session frame position of the start of the source)
 915                 */
 916
 917                 framepos_t const session_frames_when = _time_converter->to (model_when) + _time_converter->origin_b ();
 918
 919                 if (session_frames_when >= start && session_frames_when <= end && (*i)->get_y() >= bot_track && (*i)->get_y() <= top_track) {
 920                         results.push_back (*i);
 921                 }
 922         }
 923 }
 924
 925 void
 926 AutomationLine::get_inverted_selectables (Selection&, list<Selectable*>& /*results*/)
 927 {
 928         // hmmm ....
 929 }
 930
 931 void
 932 AutomationLine::set_selected_points (PointSelection const & points)
 933 {
 934         for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
 935                 (*i)->set_selected (false);
 936         }
 937
 938         for (PointSelection::const_iterator i = points.begin(); i != points.end(); ++i) {
 939                 (*i)->set_selected (true);
 940         }
 941
 942         if (points.empty()) {
 943                 remove_visibility (SelectedControlPoints);
 944         } else {
 945                 add_visibility (SelectedControlPoints);
 946         }
 947
 948         set_colors ();
 949 }
 950
 951 void AutomationLine::set_colors ()
 952 {
 953         set_line_color (ARDOUR_UI::config()->color ("automation line"));
 954         for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
 955                 (*i)->set_color ();
 956         }
 957 }
 958
 959 void
 960 AutomationLine::list_changed ()
 961 {
 962         DEBUG_TRACE (DEBUG::Automation, string_compose ("\tline changed, existing update pending? %1\n", update_pending));
 963
 964         if (!update_pending) {
 965                 update_pending = true;
 966                 Gtkmm2ext::UI::instance()->call_slot (invalidator (*this), boost::bind (&AutomationLine::queue_reset, this));
 967         }
 968 }
 969
 970 void
 971 AutomationLine::reset_callback (const Evoral::ControlList& events)
 972 {
 973         uint32_t vp = 0;
 974         uint32_t pi = 0;
 975         uint32_t np;
 976
 977         if (events.empty()) {
 978                 for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
 979                         delete *i;
 980                 }
 981                 control_points.clear ();
 982                 line->hide();
 983                 return;
 984         }
 985
 986         /* hide all existing points, and the line */
 987
 988         for (vector<ControlPoint*>::iterator i = control_points.begin(); i != control_points.end(); ++i) {
 989                 (*i)->hide();
 990         }
 991
 992         line->hide ();
 993         np = events.size();
 994
 995         Evoral::ControlList& e = const_cast<Evoral::ControlList&> (events);
 996
 997         for (AutomationList::iterator ai = e.begin(); ai != e.end(); ++ai, ++pi) {
 998
 999                 double tx = (*ai)->when;
1000                 double ty = (*ai)->value;
1001
1002                 /* convert from model coordinates to canonical view coordinates */
1003
1004                 model_to_view_coord (tx, ty);
1005
1006                 if (isnan_local (tx) || isnan_local (ty)) {
1007                         warning << string_compose (_("Ignoring illegal points on AutomationLine \"%1\""),
1008                                                    _name) << endmsg;
1009                         continue;
1010                 }
1011
1012                 if (tx >= max_framepos || tx < 0 || tx >= _maximum_time) {
1013                         continue;
1014                 }
1015
1016                 /* convert x-coordinate to a canvas unit coordinate (this takes
1017                  * zoom and scroll into account).
1018                  */
1019
1020                 tx = trackview.editor().sample_to_pixel_unrounded (tx);
1021
1022                 /* convert from canonical view height (0..1.0) to actual
1023                  * height coordinates (using X11's top-left rooted system)
1024                  */
1025
1026                 ty = _height - (ty * _height);
1027
1028                 add_visible_control_point (vp, pi, tx, ty, ai, np);
1029                 vp++;
1030         }
1031
1032         /* discard extra CP's to avoid confusing ourselves */
1033
1034         while (control_points.size() > vp) {
1035                 ControlPoint* cp = control_points.back();
1036                 control_points.pop_back ();
1037                 delete cp;
1038         }
1039
1040         if (!terminal_points_can_slide) {
1041                 control_points.back()->set_can_slide(false);
1042         }
1043
1044         if (vp > 1) {
1045
1046                 /* reset the line coordinates given to the CanvasLine */
1047
1048                 while (line_points.size() < vp) {
1049                         line_points.push_back (ArdourCanvas::Duple (0,0));
1050                 }
1051
1052                 while (line_points.size() > vp) {
1053                         line_points.pop_back ();
1054                 }
1055
1056                 for (uint32_t n = 0; n < vp; ++n) {
1057                         line_points[n].x = control_points[n]->get_x();
1058                         line_points[n].y = control_points[n]->get_y();
1059                 }
1060
1061                 line->set_steps (line_points, is_stepped());
1062
1063                 update_visibility ();
1064         }
1065
1066         set_selected_points (trackview.editor().get_selection().points);
1067 }
1068
1069 void
1070 AutomationLine::reset ()
1071 {
1072         DEBUG_TRACE (DEBUG::Automation, "\t\tLINE RESET\n");
1073         update_pending = false;
1074         have_timeout = false;
1075
1076         if (no_draw) {
1077                 return;
1078         }
1079
1080         alist->apply_to_points (*this, &AutomationLine::reset_callback);
1081 }
1082
1083 void
1084 AutomationLine::queue_reset ()
1085 {
1086         /* this must be called from the GUI thread
1087          */
1088
1089         if (trackview.editor().session()->transport_rolling() && alist->automation_write()) {
1090                 /* automation write pass ... defer to a timeout */
1091                 /* redraw in 1/4 second */
1092                 if (!have_timeout) {
1093                         DEBUG_TRACE (DEBUG::Automation, "\tqueue timeout\n");
1094                         Glib::signal_timeout().connect (sigc::bind_return (sigc::mem_fun (*this, &AutomationLine::reset), false), 250);
1095                         have_timeout = true;
1096                 } else {
1097                         DEBUG_TRACE (DEBUG::Automation, "\ttimeout already queued, change ignored\n");
1098                 }
1099         } else {
1100                 reset ();
1101         }
1102 }
1103
1104 void
1105 AutomationLine::clear ()
1106 {
1107         /* parent must create and commit command */
1108         XMLNode &before = alist->get_state();
1109         alist->clear();
1110
1111         trackview.editor().session()->add_command (
1112                 new MementoCommand<AutomationList> (memento_command_binder (), &before, &alist->get_state()));
1113 }
1114
1115 void
1116 AutomationLine::set_list (boost::shared_ptr<ARDOUR::AutomationList> list)
1117 {
1118         alist = list;
1119         queue_reset ();
1120         connect_to_list ();
1121 }
1122
1123 void
1124 AutomationLine::add_visibility (VisibleAspects va)
1125 {
1126         VisibleAspects old = _visible;
1127
1128         _visible = VisibleAspects (_visible | va);
1129
1130         if (old != _visible) {
1131                 update_visibility ();
1132         }
1133 }
1134
1135 void
1136 AutomationLine::set_visibility (VisibleAspects va)
1137 {
1138         if (_visible != va) {
1139                 _visible = va;
1140                 update_visibility ();
1141         }
1142 }
1143
1144 void
1145 AutomationLine::remove_visibility (VisibleAspects va)
1146 {
1147         VisibleAspects old = _visible;
1148
1149         _visible = VisibleAspects (_visible & ~va);
1150
1151         if (old != _visible) {
1152                 update_visibility ();
1153         }
1154 }
1155
1156 void
1157 AutomationLine::track_entered()
1158 {
1159         add_visibility (ControlPoints);
1160 }
1161
1162 void
1163 AutomationLine::track_exited()
1164 {
1165         remove_visibility (ControlPoints);
1166 }
1167
1168 XMLNode &
1169 AutomationLine::get_state (void)
1170 {
1171         /* function as a proxy for the model */
1172         return alist->get_state();
1173 }
1174
1175 int
1176 AutomationLine::set_state (const XMLNode &node, int version)
1177 {
1178         /* function as a proxy for the model */
1179         return alist->set_state (node, version);
1180 }
1181
1182 void
1183 AutomationLine::view_to_model_coord (double& x, double& y) const
1184 {
1185         x = _time_converter->from (x);
1186         view_to_model_coord_y (y);
1187 }
1188
1189 void
1190 AutomationLine::view_to_model_coord_y (double& y) const
1191 {
1192         /* TODO: This should be more generic (use ParameterDescriptor)
1193          * or better yet:  Controllable -> set_interface();
1194          */
1195         if (   alist->parameter().type() == GainAutomation
1196             || alist->parameter().type() == EnvelopeAutomation
1197             || (_desc.unit == ParameterDescriptor::DB && _desc.lower == 0.)) {
1198                 y = slider_position_to_gain_with_max (y, _desc.upper);
1199                 y = max ((double)_desc.lower, y);
1200                 y = min ((double)_desc.upper, y);
1201         } else if (alist->parameter().type() == TrimAutomation
1202                    || (_desc.unit == ParameterDescriptor::DB && _desc.lower > 0 && _desc.upper > _desc.lower)) {
1203                 const double lower_db = accurate_coefficient_to_dB (_desc.lower);
1204                 const double range_db = accurate_coefficient_to_dB (_desc.upper) - lower_db;
1205                 y = max (0.0, y);
1206                 y = min (1.0, y);
1207                 y = dB_to_coefficient (lower_db + y * range_db);
1208         } else if (alist->parameter().type() == PanAzimuthAutomation ||
1209                    alist->parameter().type() == PanElevationAutomation) {
1210                 y = 1.0 - y;
1211         } else if (alist->parameter().type() == PanWidthAutomation) {
1212                 y = 2.0 * y - 1.0;
1213         } else {
1214                 y = y * (double)(alist->get_max_y() - alist->get_min_y()) + alist->get_min_y();
1215                 if (_desc.integer_step) {
1216                         y = round(y);
1217                 } else if (_desc.toggled) {
1218                         y = (y > 0.5) ? 1.0 : 0.0;
1219                 }
1220         }
1221 }
1222
1223 void
1224 AutomationLine::model_to_view_coord_y (double& y) const
1225 {
1226         /* TODO: This should be more generic (use ParameterDescriptor) */
1227         if (   alist->parameter().type() == GainAutomation
1228             || alist->parameter().type() == EnvelopeAutomation
1229             || (_desc.unit == ParameterDescriptor::DB && _desc.lower == 0.)) {
1230                 y = gain_to_slider_position_with_max (y, Config->get_max_gain());
1231         } else if (alist->parameter().type() == TrimAutomation
1232                    || (_desc.unit == ParameterDescriptor::DB && _desc.lower > 0 && _desc.upper > _desc.lower)) {
1233                 const double lower_db = accurate_coefficient_to_dB (_desc.lower);
1234                 const double range_db = accurate_coefficient_to_dB (_desc.upper) - lower_db;
1235                 y = (accurate_coefficient_to_dB (y) - lower_db) / range_db;
1236         } else if (alist->parameter().type() == PanAzimuthAutomation ||
1237                    alist->parameter().type() == PanElevationAutomation) {
1238                 y = 1.0 - y;
1239         } else if (alist->parameter().type() == PanWidthAutomation) {
1240                 y = .5 + y * .5;
1241         } else {
1242                 y = (y - alist->get_min_y()) / (double)(alist->get_max_y() - alist->get_min_y());
1243         }
1244 }
1245
1246 void
1247 AutomationLine::model_to_view_coord (double& x, double& y) const
1248 {
1249         model_to_view_coord_y (y);
1250         x = _time_converter->to (x) - _offset;
1251 }
1252
1253 /** Called when our list has announced that its interpolation style has changed */
1254 void
1255 AutomationLine::interpolation_changed (AutomationList::InterpolationStyle style)
1256 {
1257         if (line_points.size() > 1) {
1258                 line->set_steps(line_points, is_stepped());
1259         }
1260 }
1261
1262 void
1263 AutomationLine::add_visible_control_point (uint32_t view_index, uint32_t pi, double tx, double ty,
1264                                            AutomationList::iterator model, uint32_t npoints)
1265 {
1266         ControlPoint::ShapeType shape;
1267
1268         if (view_index >= control_points.size()) {
1269
1270                 /* make sure we have enough control points */
1271
1272                 ControlPoint* ncp = new ControlPoint (*this);
1273                 ncp->set_size (control_point_box_size ());
1274
1275                 control_points.push_back (ncp);
1276         }
1277
1278         if (!terminal_points_can_slide) {
1279                 if (pi == 0) {
1280                         control_points[view_index]->set_can_slide (false);
1281                         if (tx == 0) {
1282                                 shape = ControlPoint::Start;
1283                         } else {
1284                                 shape = ControlPoint::Full;
1285                         }
1286                 } else if (pi == npoints - 1) {
1287                         control_points[view_index]->set_can_slide (false);
1288                         shape = ControlPoint::End;
1289                 } else {
1290                         control_points[view_index]->set_can_slide (true);
1291                         shape = ControlPoint::Full;
1292                 }
1293         } else {
1294                 control_points[view_index]->set_can_slide (true);
1295                 shape = ControlPoint::Full;
1296         }
1297
1298         control_points[view_index]->reset (tx, ty, model, view_index, shape);
1299
1300         /* finally, control visibility */
1301
1302         if (_visible & ControlPoints) {
1303                 control_points[view_index]->show ();
1304         } else {
1305                 control_points[view_index]->hide ();
1306         }
1307 }
1308
1309 void
1310 AutomationLine::connect_to_list ()
1311 {
1312         _list_connections.drop_connections ();
1313
1314         alist->StateChanged.connect (_list_connections, invalidator (*this), boost::bind (&AutomationLine::list_changed, this), gui_context());
1315
1316         alist->InterpolationChanged.connect (
1317                 _list_connections, invalidator (*this), boost::bind (&AutomationLine::interpolation_changed, this, _1), gui_context());
1318 }
1319
1320 MementoCommandBinder<AutomationList>*
1321 AutomationLine::memento_command_binder ()
1322 {
1323         return new SimpleMementoCommandBinder<AutomationList> (*alist.get());
1324 }
1325
1326 /** Set the maximum time that points on this line can be at, relative
1327  *  to the start of the track or region that it is on.
1328  */
1329 void
1330 AutomationLine::set_maximum_time (framecnt_t t)
1331 {
1332         if (_maximum_time == t) {
1333                 return;
1334         }
1335
1336         _maximum_time = t;
1337         reset ();
1338 }
1339
1340
1341 /** @return min and max x positions of points that are in the list, in session frames */
1342 pair<framepos_t, framepos_t>
1343 AutomationLine::get_point_x_range () const
1344 {
1345         pair<framepos_t, framepos_t> r (max_framepos, 0);
1346
1347         for (AutomationList::const_iterator i = the_list()->begin(); i != the_list()->end(); ++i) {
1348                 r.first = min (r.first, session_position (i));
1349                 r.second = max (r.second, session_position (i));
1350         }
1351
1352         return r;
1353 }
1354
1355 framepos_t
1356 AutomationLine::session_position (AutomationList::const_iterator p) const
1357 {
1358         return _time_converter->to ((*p)->when) + _offset + _time_converter->origin_b ();
1359 }
1360
1361 void
1362 AutomationLine::set_offset (framepos_t off)
1363 {
1364         if (_offset == off) {
1365                 return;
1366         }
1367
1368         _offset = off;
1369         reset ();
1370 }