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