gtk2_ardour/automation_time_axis.cc

   1 /*
   2     Copyright (C) 2000-2007 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 <utility>
  21 #include <gtkmm2ext/barcontroller.h>
  22 #include <gtkmm2ext/utils.h>
  23 #include <boost/algorithm/string.hpp>
  24 #include <boost/lexical_cast.hpp>
  25
  26 #include "pbd/error.h"
  27 #include "pbd/memento_command.h"
  28 #include "pbd/stacktrace.h"
  29
  30 #include "ardour/automation_control.h"
  31 #include "ardour/event_type_map.h"
  32 #include "ardour/parameter_types.h"
  33 #include "ardour/profile.h"
  34 #include "ardour/route.h"
  35 #include "ardour/session.h"
  36
  37 #include "canvas/debug.h"
  38
  39 #include "ardour_ui.h"
  40 #include "automation_time_axis.h"
  41 #include "automation_streamview.h"
  42 #include "global_signals.h"
  43 #include "gui_thread.h"
  44 #include "route_time_axis.h"
  45 #include "automation_line.h"
  46 #include "paste_context.h"
  47 #include "public_editor.h"
  48 #include "selection.h"
  49 #include "rgb_macros.h"
  50 #include "point_selection.h"
  51 #include "control_point.h"
  52 #include "utils.h"
  53 #include "item_counts.h"
  54
  55 #include "i18n.h"
  56
  57 using namespace std;
  58 using namespace ARDOUR;
  59 using namespace ARDOUR_UI_UTILS;
  60 using namespace PBD;
  61 using namespace Gtk;
  62 using namespace Gtkmm2ext;
  63 using namespace Editing;
  64
  65 Pango::FontDescription AutomationTimeAxisView::name_font;
  66 bool AutomationTimeAxisView::have_name_font = false;
  67
  68
  69 /** \a a the automatable object this time axis is to display data for.
  70  * For route/track automation (e.g. gain) pass the route for both \r and \a.
  71  * For route child (e.g. plugin) automation, pass the child for \a.
  72  * For region automation (e.g. MIDI CC), pass null for \a.
  73  */
  74 AutomationTimeAxisView::AutomationTimeAxisView (
  75         Session* s,
  76         boost::shared_ptr<Route> r,
  77         boost::shared_ptr<Automatable> a,
  78         boost::shared_ptr<AutomationControl> c,
  79         Evoral::Parameter p,
  80         PublicEditor& e,
  81         TimeAxisView& parent,
  82         bool show_regions,
  83         ArdourCanvas::Canvas& canvas,
  84         const string & nom,
  85         const string & nomparent
  86         )
  87         : AxisView (s)
  88         , TimeAxisView (s, e, &parent, canvas)
  89         , _route (r)
  90         , _control (c)
  91         , _automatable (a)
  92         , _parameter (p)
  93         , _base_rect (new ArdourCanvas::Rectangle (_canvas_display))
  94         , _view (show_regions ? new AutomationStreamView (*this) : 0)
  95         , auto_button (X_("")) /* force addition of a label */
  96         , _show_regions (show_regions)
  97 {
  98         //concatenate plugin name and param name into the tooltip
  99         string tipname = nomparent;
 100         if (!tipname.empty()) {
 101                 tipname += ": ";
 102         }
 103         tipname += nom;
 104         ARDOUR_UI::instance()->set_tip(controls_ebox, tipname);
 105
 106         //plugin name and param name appear on 2 separate lines in the track header
 107         tipname = nomparent;
 108         if (!tipname.empty()) {
 109                 tipname += "\n";
 110         }
 111         tipname += nom;
 112         _name = tipname;
 113
 114         CANVAS_DEBUG_NAME (_canvas_display, string_compose ("main for auto %2/%1", _name, r->name()));
 115         CANVAS_DEBUG_NAME (selection_group, string_compose ("selections for auto %2/%1", _name, r->name()));
 116         CANVAS_DEBUG_NAME (_ghost_group, string_compose ("ghosts for auto %2/%1", _name, r->name()));
 117
 118         if (!have_name_font) {
 119                 name_font = get_font_for_style (X_("AutomationTrackName"));
 120                 have_name_font = true;
 121         }
 122
 123         if (_automatable && _control) {
 124                 _controller = AutomationController::create (_automatable, _control->parameter(), _control->desc(), _control);
 125         }
 126
 127         const std::string fill_color_name = (dynamic_cast<MidiTimeAxisView*>(&parent)
 128                                              ? "midi automation track fill"
 129                                              : "audio automation track fill");
 130
 131         automation_menu = 0;
 132         auto_off_item = 0;
 133         auto_touch_item = 0;
 134         auto_write_item = 0;
 135         auto_play_item = 0;
 136         mode_discrete_item = 0;
 137         mode_line_item = 0;
 138
 139         ignore_state_request = false;
 140         first_call_to_set_height = true;
 141
 142         CANVAS_DEBUG_NAME (_base_rect, string_compose ("base rect for %1", _name));
 143         _base_rect->set_x1 (ArdourCanvas::COORD_MAX);
 144         _base_rect->set_outline (false);
 145         _base_rect->set_fill_color (ARDOUR_UI::config()->color_mod (fill_color_name, "automation track fill"));
 146         _base_rect->set_data ("trackview", this);
 147         _base_rect->Event.connect (sigc::bind (sigc::mem_fun (_editor, &PublicEditor::canvas_automation_track_event), _base_rect, this));
 148         if (!a) {
 149                 _base_rect->lower_to_bottom();
 150         }
 151
 152         hide_button.set_elements ((ArdourButton::Element)(ArdourButton::Edge|ArdourButton::Body|ArdourButton::CloseCross));
 153         hide_button.set_tweaks(ArdourButton::TrackHeader);
 154
 155         auto_button.set_name ("route button");
 156         hide_button.set_name ("route button");
 157
 158         auto_button.unset_flags (Gtk::CAN_FOCUS);
 159         hide_button.unset_flags (Gtk::CAN_FOCUS);
 160
 161         controls_table.set_no_show_all();
 162
 163         ARDOUR_UI::instance()->set_tip(auto_button, _("automation state"));
 164         ARDOUR_UI::instance()->set_tip(hide_button, _("hide track"));
 165
 166         const string str = gui_property ("height");
 167         if (!str.empty()) {
 168                 set_height (atoi (str));
 169         } else {
 170                 set_height (preset_height (HeightNormal));
 171         }
 172
 173         //name label isn't editable on an automation track; remove the tooltip
 174         ARDOUR_UI::instance()->set_tip (name_label, X_(""));
 175
 176         /* repack the name label */
 177
 178         if (name_label.get_parent()) {
 179                 name_label.get_parent()->remove (name_label);
 180         }
 181
 182         name_label.set_text (_name);
 183         name_label.set_alignment (Gtk::ALIGN_LEFT, Gtk::ALIGN_CENTER);
 184         name_label.set_name (X_("TrackParameterName"));
 185         name_label.set_ellipsize (Pango::ELLIPSIZE_END);
 186
 187         /* add the buttons */
 188         controls_table.set_border_width (1);
 189         controls_table.remove (name_hbox);
 190         controls_table.attach (hide_button, 1, 2, 0, 1, Gtk::SHRINK, Gtk::SHRINK, 0, 0);
 191         controls_table.attach (name_label,  2, 3, 1, 3, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND, 2, 0);
 192         controls_table.attach (auto_button, 3, 4, 2, 3, Gtk::SHRINK, Gtk::SHRINK, 0, 0);
 193
 194         Gtk::DrawingArea *blank0 = manage (new Gtk::DrawingArea());
 195         Gtk::DrawingArea *blank1 = manage (new Gtk::DrawingArea());
 196
 197         RouteTimeAxisView* rtv = dynamic_cast<RouteTimeAxisView*>(&parent);
 198         // TODO use rtv->controls_base_unselected_name
 199         // subscribe to route_active_changed, ...
 200         if (rtv && rtv->is_audio_track()) {
 201                 blank0->set_name ("AudioTrackControlsBaseUnselected");
 202         }
 203         else if (rtv && rtv->is_midi_track()) {
 204                 blank0->set_name ("MidiTrackControlsBaseUnselected");
 205         }
 206         else {
 207                 blank0->set_name ("AudioBusControlsBaseUnselected");
 208         }
 209         blank0->set_size_request (-1, -1);
 210         blank1->set_size_request (1, 0);
 211         VSeparator* separator = manage (new VSeparator());
 212         separator->set_name("TrackSeparator");
 213         separator->set_size_request (1, -1);
 214
 215         controls_button_size_group->add_widget(hide_button);
 216         controls_button_size_group->add_widget(*blank0);
 217
 218         time_axis_hbox.pack_start (*blank0, false, false);
 219         time_axis_hbox.pack_start (*separator, false, false);
 220         time_axis_hbox.reorder_child (*blank0, 0);
 221         time_axis_hbox.reorder_child (*separator, 1);
 222         time_axis_hbox.reorder_child (time_axis_vbox, 2);
 223
 224         if (!ARDOUR::Profile->get_mixbus() ) {
 225                 time_axis_hbox.pack_start (*blank1, false, false);
 226         }
 227
 228         blank0->show();
 229         separator->show();
 230         name_label.show ();
 231         hide_button.show ();
 232
 233         if (_controller) {
 234                 _controller->disable_vertical_scroll ();
 235                 controls_table.attach (*_controller.get(), 2, 4, 0, 1, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND, 0, 0);
 236         }
 237
 238         controls_table.show_all ();
 239
 240         hide_button.signal_clicked.connect (sigc::mem_fun(*this, &AutomationTimeAxisView::hide_clicked));
 241         auto_button.signal_clicked.connect (sigc::mem_fun(*this, &AutomationTimeAxisView::auto_clicked));
 242
 243         controls_base_selected_name = X_("AutomationTrackControlsBaseSelected");
 244         controls_base_unselected_name = X_("AutomationTrackControlsBase");
 245
 246         controls_ebox.set_name (controls_base_unselected_name);
 247         time_axis_frame.set_name (controls_base_unselected_name);
 248
 249         /* ask for notifications of any new RegionViews */
 250         if (show_regions) {
 251
 252                 if (_view) {
 253                         _view->attach ();
 254                 }
 255
 256         } else {
 257                 /* no regions, just a single line for the entire track (e.g. bus gain) */
 258
 259                 assert (_control);
 260
 261                 boost::shared_ptr<AutomationLine> line (
 262                         new AutomationLine (
 263                                 ARDOUR::EventTypeMap::instance().to_symbol(_parameter),
 264                                 *this,
 265                                 *_canvas_display,
 266                                 _control->alist(),
 267                                 _control->desc()
 268                                 )
 269                         );
 270
 271                 line->set_line_color (ARDOUR_UI::config()->color ("processor automation line"));
 272                 line->queue_reset ();
 273                 add_line (line);
 274         }
 275
 276         /* make sure labels etc. are correct */
 277
 278         automation_state_changed ();
 279         ColorsChanged.connect (sigc::mem_fun (*this, &AutomationTimeAxisView::color_handler));
 280
 281         _route->DropReferences.connect (
 282                 _route_connections, invalidator (*this), boost::bind (&AutomationTimeAxisView::route_going_away, this), gui_context ()
 283                 );
 284 }
 285
 286 AutomationTimeAxisView::~AutomationTimeAxisView ()
 287 {
 288         delete _view;
 289 }
 290
 291 void
 292 AutomationTimeAxisView::route_going_away ()
 293 {
 294         _route.reset ();
 295 }
 296
 297 void
 298 AutomationTimeAxisView::auto_clicked ()
 299 {
 300         using namespace Menu_Helpers;
 301
 302         if (automation_menu == 0) {
 303                 automation_menu = manage (new Menu);
 304                 automation_menu->set_name ("ArdourContextMenu");
 305                 MenuList& items (automation_menu->items());
 306
 307                 items.push_back (MenuElem (S_("Automation|Manual"), sigc::bind (sigc::mem_fun(*this,
 308                                                                                               &AutomationTimeAxisView::set_automation_state), (AutoState) ARDOUR::Off)));
 309                 items.push_back (MenuElem (_("Play"), sigc::bind (sigc::mem_fun(*this,
 310                                 &AutomationTimeAxisView::set_automation_state), (AutoState) Play)));
 311                 items.push_back (MenuElem (_("Write"), sigc::bind (sigc::mem_fun(*this,
 312                                 &AutomationTimeAxisView::set_automation_state), (AutoState) Write)));
 313                 items.push_back (MenuElem (_("Touch"), sigc::bind (sigc::mem_fun(*this,
 314                                 &AutomationTimeAxisView::set_automation_state), (AutoState) Touch)));
 315         }
 316
 317         automation_menu->popup (1, gtk_get_current_event_time());
 318 }
 319
 320 void
 321 AutomationTimeAxisView::set_automation_state (AutoState state)
 322 {
 323         if (ignore_state_request) {
 324                 return;
 325         }
 326
 327         if (_automatable) {
 328                 _automatable->set_parameter_automation_state (_parameter, state);
 329         }
 330
 331         if (_view) {
 332                 _view->set_automation_state (state);
 333
 334                 /* AutomationStreamViews don't signal when their automation state changes, so handle
 335                    our updates `manually'.
 336                 */
 337                 automation_state_changed ();
 338         }
 339 }
 340
 341 void
 342 AutomationTimeAxisView::automation_state_changed ()
 343 {
 344         AutoState state;
 345
 346         /* update button label */
 347
 348         if (_view) {
 349                 state = _view->automation_state ();
 350         } else if (_line) {
 351                 assert (_control);
 352                 state = _control->alist()->automation_state ();
 353         } else {
 354                 state = ARDOUR::Off;
 355         }
 356
 357         switch (state & (ARDOUR::Off|Play|Touch|Write)) {
 358         case ARDOUR::Off:
 359                 auto_button.set_text (S_("Automation|Manual"));
 360                 if (auto_off_item) {
 361                         ignore_state_request = true;
 362                         auto_off_item->set_active (true);
 363                         auto_play_item->set_active (false);
 364                         auto_touch_item->set_active (false);
 365                         auto_write_item->set_active (false);
 366                         ignore_state_request = false;
 367                 }
 368                 break;
 369         case Play:
 370                 auto_button.set_text (_("Play"));
 371                 if (auto_play_item) {
 372                         ignore_state_request = true;
 373                         auto_play_item->set_active (true);
 374                         auto_off_item->set_active (false);
 375                         auto_touch_item->set_active (false);
 376                         auto_write_item->set_active (false);
 377                         ignore_state_request = false;
 378                 }
 379                 break;
 380         case Write:
 381                 auto_button.set_text (_("Write"));
 382                 if (auto_write_item) {
 383                         ignore_state_request = true;
 384                         auto_write_item->set_active (true);
 385                         auto_off_item->set_active (false);
 386                         auto_play_item->set_active (false);
 387                         auto_touch_item->set_active (false);
 388                         ignore_state_request = false;
 389                 }
 390                 break;
 391         case Touch:
 392                 auto_button.set_text (_("Touch"));
 393                 if (auto_touch_item) {
 394                         ignore_state_request = true;
 395                         auto_touch_item->set_active (true);
 396                         auto_off_item->set_active (false);
 397                         auto_play_item->set_active (false);
 398                         auto_write_item->set_active (false);
 399                         ignore_state_request = false;
 400                 }
 401                 break;
 402         default:
 403                 auto_button.set_text (_("???"));
 404                 break;
 405         }
 406 }
 407
 408 /** The interpolation style of our AutomationList has changed, so update */
 409 void
 410 AutomationTimeAxisView::interpolation_changed (AutomationList::InterpolationStyle s)
 411 {
 412         if (mode_line_item && mode_discrete_item) {
 413                 if (s == AutomationList::Discrete) {
 414                         mode_discrete_item->set_active(true);
 415                         mode_line_item->set_active(false);
 416                 } else {
 417                         mode_line_item->set_active(true);
 418                         mode_discrete_item->set_active(false);
 419                 }
 420         }
 421 }
 422
 423 /** A menu item has been selected to change our interpolation mode */
 424 void
 425 AutomationTimeAxisView::set_interpolation (AutomationList::InterpolationStyle style)
 426 {
 427         /* Tell our view's list, if we have one, otherwise tell our own.
 428          * Everything else will be signalled back from that.
 429          */
 430
 431         if (_view) {
 432                 _view->set_interpolation (style);
 433         } else {
 434                 assert (_control);
 435                 _control->list()->set_interpolation (style);
 436         }
 437 }
 438
 439 void
 440 AutomationTimeAxisView::clear_clicked ()
 441 {
 442         assert (_line || _view);
 443
 444         _editor.begin_reversible_command (_("clear automation"));
 445
 446         if (_line) {
 447                 _line->clear ();
 448         } else if (_view) {
 449                 _view->clear ();
 450         }
 451
 452         _editor.commit_reversible_command ();
 453         _session->set_dirty ();
 454 }
 455
 456 void
 457 AutomationTimeAxisView::set_height (uint32_t h, TrackHeightMode m)
 458 {
 459         bool const changed = (height != (uint32_t) h) || first_call_to_set_height;
 460         uint32_t const normal = preset_height (HeightNormal);
 461         bool const changed_between_small_and_normal = ( (height < normal && h >= normal) || (height >= normal || h < normal) );
 462
 463         TimeAxisView::set_height (h, m);
 464
 465         _base_rect->set_y1 (h);
 466
 467         if (_line) {
 468                 _line->set_height(h);
 469         }
 470
 471         if (_view) {
 472                 _view->set_height(h);
 473                 _view->update_contents_height();
 474         }
 475
 476         if (changed_between_small_and_normal || first_call_to_set_height) {
 477
 478                 first_call_to_set_height = false;
 479
 480                 if (h >= preset_height (HeightNormal)) {
 481                         if (!(_parameter.type() >= MidiCCAutomation &&
 482                               _parameter.type() <= MidiChannelPressureAutomation)) {
 483                                 auto_button.show();
 484                         }
 485                         name_label.show();
 486                         hide_button.show();
 487
 488                 } else if (h >= preset_height (HeightSmall)) {
 489                         controls_table.hide_all ();
 490                         auto_button.hide();
 491                         name_label.hide();
 492                 }
 493         }
 494
 495         if (changed) {
 496                 if (_canvas_display->visible() && _route) {
 497                         /* only emit the signal if the height really changed and we were visible */
 498                         _route->gui_changed ("visible_tracks", (void *) 0); /* EMIT_SIGNAL */
 499                 }
 500         }
 501 }
 502
 503 void
 504 AutomationTimeAxisView::set_samples_per_pixel (double fpp)
 505 {
 506         TimeAxisView::set_samples_per_pixel (fpp);
 507
 508         if (_line) {
 509                 _line->reset ();
 510         }
 511
 512         if (_view) {
 513                 _view->set_samples_per_pixel (fpp);
 514         }
 515 }
 516
 517 void
 518 AutomationTimeAxisView::hide_clicked ()
 519 {
 520         hide_button.set_sensitive(false);
 521         set_marked_for_display (false);
 522         RouteTimeAxisView* rtv = dynamic_cast<RouteTimeAxisView*>(parent);
 523         if (rtv) {
 524                 rtv->request_redraw ();
 525         }
 526         hide_button.set_sensitive(true);
 527 }
 528
 529 void
 530 AutomationTimeAxisView::build_display_menu ()
 531 {
 532         using namespace Menu_Helpers;
 533
 534         /* prepare it */
 535
 536         TimeAxisView::build_display_menu ();
 537
 538         /* now fill it with our stuff */
 539
 540         MenuList& items = display_menu->items();
 541
 542         items.push_back (MenuElem (_("Hide"), sigc::mem_fun(*this, &AutomationTimeAxisView::hide_clicked)));
 543         items.push_back (SeparatorElem());
 544         items.push_back (MenuElem (_("Clear"), sigc::mem_fun(*this, &AutomationTimeAxisView::clear_clicked)));
 545         items.push_back (SeparatorElem());
 546
 547         /* state menu */
 548
 549         Menu* auto_state_menu = manage (new Menu);
 550         auto_state_menu->set_name ("ArdourContextMenu");
 551         MenuList& as_items = auto_state_menu->items();
 552
 553         as_items.push_back (CheckMenuElem (S_("Automation|Manual"), sigc::bind (
 554                         sigc::mem_fun(*this, &AutomationTimeAxisView::set_automation_state),
 555                         (AutoState) ARDOUR::Off)));
 556         auto_off_item = dynamic_cast<Gtk::CheckMenuItem*>(&as_items.back());
 557
 558         as_items.push_back (CheckMenuElem (_("Play"), sigc::bind (
 559                         sigc::mem_fun(*this, &AutomationTimeAxisView::set_automation_state),
 560                         (AutoState) Play)));
 561         auto_play_item = dynamic_cast<Gtk::CheckMenuItem*>(&as_items.back());
 562
 563         as_items.push_back (CheckMenuElem (_("Write"), sigc::bind (
 564                         sigc::mem_fun(*this, &AutomationTimeAxisView::set_automation_state),
 565                         (AutoState) Write)));
 566         auto_write_item = dynamic_cast<Gtk::CheckMenuItem*>(&as_items.back());
 567
 568         as_items.push_back (CheckMenuElem (_("Touch"), sigc::bind (
 569                         sigc::mem_fun(*this, &AutomationTimeAxisView::set_automation_state),
 570                         (AutoState) Touch)));
 571         auto_touch_item = dynamic_cast<Gtk::CheckMenuItem*>(&as_items.back());
 572
 573         if (!(_parameter.type() >= MidiCCAutomation &&
 574               _parameter.type() <= MidiChannelPressureAutomation)) {
 575                 items.push_back (MenuElem (_("State"), *auto_state_menu));
 576         }
 577
 578         /* mode menu */
 579
 580         /* current interpolation state */
 581         AutomationList::InterpolationStyle const s = _view ? _view->interpolation() : _control->list()->interpolation ();
 582
 583         if (ARDOUR::parameter_is_midi((AutomationType)_parameter.type())) {
 584
 585                 Menu* auto_mode_menu = manage (new Menu);
 586                 auto_mode_menu->set_name ("ArdourContextMenu");
 587                 MenuList& am_items = auto_mode_menu->items();
 588
 589                 RadioMenuItem::Group group;
 590
 591                 am_items.push_back (RadioMenuElem (group, _("Discrete"), sigc::bind (
 592                                 sigc::mem_fun(*this, &AutomationTimeAxisView::set_interpolation),
 593                                 AutomationList::Discrete)));
 594                 mode_discrete_item = dynamic_cast<Gtk::CheckMenuItem*>(&am_items.back());
 595                 mode_discrete_item->set_active (s == AutomationList::Discrete);
 596
 597                 am_items.push_back (RadioMenuElem (group, _("Linear"), sigc::bind (
 598                                 sigc::mem_fun(*this, &AutomationTimeAxisView::set_interpolation),
 599                                 AutomationList::Linear)));
 600                 mode_line_item = dynamic_cast<Gtk::CheckMenuItem*>(&am_items.back());
 601                 mode_line_item->set_active (s == AutomationList::Linear);
 602
 603                 items.push_back (MenuElem (_("Mode"), *auto_mode_menu));
 604         }
 605
 606         /* make sure the automation menu state is correct */
 607
 608         automation_state_changed ();
 609         interpolation_changed (s);
 610 }
 611
 612 void
 613 AutomationTimeAxisView::add_automation_event (GdkEvent* event, framepos_t when, double y, bool with_guard_points)
 614 {
 615         if (!_line) {
 616                 return;
 617         }
 618
 619         boost::shared_ptr<AutomationList> list = _line->the_list ();
 620
 621         if (list->in_write_pass()) {
 622                 /* do not allow the GUI to add automation events during an
 623                    automation write pass.
 624                 */
 625                 return;
 626         }
 627
 628         double x = 0;
 629
 630         _canvas_display->canvas_to_item (x, y);
 631
 632         /* compute vertical fractional position */
 633
 634         y = 1.0 - (y / height);
 635
 636         /* map using line */
 637
 638         _line->view_to_model_coord (x, y);
 639
 640
 641         _editor.snap_to_with_modifier (when, event);
 642
 643         _editor.begin_reversible_command (_("add automation event"));
 644         XMLNode& before = list->get_state();
 645
 646         list->add (when, y, with_guard_points);
 647
 648         XMLNode& after = list->get_state();
 649         _session->add_command (new MementoCommand<ARDOUR::AutomationList> (*list, &before, &after));
 650         _editor.commit_reversible_command ();
 651         _session->set_dirty ();
 652 }
 653
 654 bool
 655 AutomationTimeAxisView::paste (framepos_t pos, const Selection& selection, PasteContext& ctx)
 656 {
 657         if (_line) {
 658                 return paste_one (pos, ctx.count, ctx.times, selection, ctx.counts, ctx.greedy);
 659         } else if (_view) {
 660                 AutomationSelection::const_iterator l = selection.lines.get_nth(_parameter, ctx.counts.n_lines(_parameter));
 661                 if (l == selection.lines.end()) {
 662                         if (ctx.greedy && selection.lines.size() == 1) {
 663                                 l = selection.lines.begin();
 664                         }
 665                 }
 666                 if (l != selection.lines.end() && _view->paste (pos, ctx.count, ctx.times, *l)) {
 667                         ctx.counts.increase_n_lines(_parameter);
 668                         return true;
 669                 }
 670         }
 671
 672         return false;
 673 }
 674
 675 bool
 676 AutomationTimeAxisView::paste_one (framepos_t pos, unsigned paste_count, float times, const Selection& selection, ItemCounts& counts, bool greedy)
 677 {
 678         boost::shared_ptr<AutomationList> alist(_line->the_list());
 679
 680         if (_session->transport_rolling() && alist->automation_write()) {
 681                 /* do not paste if this control is in write mode and we're rolling */
 682                 return false;
 683         }
 684
 685         /* Get appropriate list from selection. */
 686         AutomationSelection::const_iterator p = selection.lines.get_nth(_parameter, counts.n_lines(_parameter));
 687         if (p == selection.lines.end()) {
 688                 if (greedy && selection.lines.size() == 1) {
 689                         p = selection.lines.begin();
 690                 } else {
 691                         return false;
 692                 }
 693         }
 694         counts.increase_n_lines(_parameter);
 695
 696         /* add multi-paste offset if applicable */
 697         pos += _editor.get_paste_offset(pos, paste_count, (*p)->length());
 698
 699         double const model_pos = _line->time_converter().from (pos - _line->time_converter().origin_b ());
 700
 701         XMLNode &before = alist->get_state();
 702         alist->paste (**p, model_pos, times);
 703         _session->add_command (new MementoCommand<AutomationList>(*alist.get(), &before, &alist->get_state()));
 704
 705         return true;
 706 }
 707
 708 void
 709 AutomationTimeAxisView::get_selectables (framepos_t start, framepos_t end, double top, double bot, list<Selectable*>& results, bool /*within*/)
 710 {
 711         if (!_line && !_view) {
 712                 return;
 713         }
 714
 715         if (touched (top, bot)) {
 716
 717                 /* remember: this is X Window - coordinate space starts in upper left and moves down.
 718                    _y_position is the "origin" or "top" of the track.
 719                 */
 720
 721                 /* bottom of our track */
 722                 double const mybot = _y_position + height;
 723
 724                 double topfrac;
 725                 double botfrac;
 726
 727                 if (_y_position >= top && mybot <= bot) {
 728
 729                         /* _y_position is below top, mybot is above bot, so we're fully
 730                            covered vertically.
 731                         */
 732
 733                         topfrac = 1.0;
 734                         botfrac = 0.0;
 735
 736                 } else {
 737
 738                         /* top and bot are within _y_position .. mybot */
 739
 740                         topfrac = 1.0 - ((top - _y_position) / height);
 741                         botfrac = 1.0 - ((bot - _y_position) / height);
 742
 743                 }
 744
 745                 if (_line) {
 746                         _line->get_selectables (start, end, botfrac, topfrac, results);
 747                 } else if (_view) {
 748                         _view->get_selectables (start, end, botfrac, topfrac, results);
 749                 }
 750         }
 751 }
 752
 753 void
 754 AutomationTimeAxisView::get_inverted_selectables (Selection& sel, list<Selectable*>& result)
 755 {
 756         if (_line) {
 757                 _line->get_inverted_selectables (sel, result);
 758         }
 759 }
 760
 761 void
 762 AutomationTimeAxisView::set_selected_points (PointSelection& points)
 763 {
 764         if (_line) {
 765                 _line->set_selected_points (points);
 766         } else if (_view) {
 767                 _view->set_selected_points (points);
 768         }
 769 }
 770
 771 void
 772 AutomationTimeAxisView::clear_lines ()
 773 {
 774         _line.reset();
 775         _list_connections.drop_connections ();
 776 }
 777
 778 void
 779 AutomationTimeAxisView::add_line (boost::shared_ptr<AutomationLine> line)
 780 {
 781         if (_control && line) {
 782                 assert(line->the_list() == _control->list());
 783
 784                 _control->alist()->automation_state_changed.connect (
 785                         _list_connections, invalidator (*this), boost::bind (&AutomationTimeAxisView::automation_state_changed, this), gui_context()
 786                         );
 787
 788                 _control->alist()->InterpolationChanged.connect (
 789                         _list_connections, invalidator (*this), boost::bind (&AutomationTimeAxisView::interpolation_changed, this, _1), gui_context()
 790                         );
 791         }
 792
 793         _line = line;
 794
 795         line->set_height (height);
 796
 797         /* pick up the current state */
 798         automation_state_changed ();
 799
 800         line->add_visibility (AutomationLine::Line);
 801 }
 802
 803 void
 804 AutomationTimeAxisView::entered()
 805 {
 806         if (_line) {
 807                 _line->track_entered();
 808         }
 809 }
 810
 811 void
 812 AutomationTimeAxisView::exited ()
 813 {
 814         if (_line) {
 815                 _line->track_exited();
 816         }
 817 }
 818
 819 void
 820 AutomationTimeAxisView::color_handler ()
 821 {
 822         if (_line) {
 823                 _line->set_colors();
 824         }
 825 }
 826
 827 int
 828 AutomationTimeAxisView::set_state_2X (const XMLNode& node, int /*version*/)
 829 {
 830         if (node.name() == X_("gain") && _parameter == Evoral::Parameter (GainAutomation)) {
 831                 XMLProperty const * shown = node.property (X_("shown"));
 832                 if (shown) {
 833                         bool yn = string_is_affirmative (shown->value ());
 834                         if (yn) {
 835                                 _canvas_display->show (); /* FIXME: necessary? show_at? */
 836                         }
 837                         set_gui_property ("visible", yn);
 838                 } else {
 839                         set_gui_property ("visible", false);
 840                 }
 841         }
 842
 843         return 0;
 844 }
 845
 846 int
 847 AutomationTimeAxisView::set_state (const XMLNode&, int /*version*/)
 848 {
 849         return 0;
 850 }
 851
 852 void
 853 AutomationTimeAxisView::what_has_visible_automation (const boost::shared_ptr<Automatable>& automatable, set<Evoral::Parameter>& visible)
 854 {
 855         /* this keeps "knowledge" of how we store visibility information
 856            in XML private to this class.
 857         */
 858
 859         assert (automatable);
 860
 861         Automatable::Controls& controls (automatable->controls());
 862
 863         for (Automatable::Controls::iterator i = controls.begin(); i != controls.end(); ++i) {
 864
 865                 boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl> (i->second);
 866
 867                 if (ac && ac->alist()) {
 868
 869                         const XMLNode* gui_node = ac->extra_xml ("GUI");
 870
 871                         if (gui_node) {
 872                                 const XMLProperty* prop = gui_node->property ("shown");
 873                                 if (prop) {
 874                                         if (string_is_affirmative (prop->value())) {
 875                                                 visible.insert (i->first);
 876                                         }
 877                                 }
 878                         }
 879                 }
 880         }
 881 }
 882
 883
 884 /** @return true if this view has any automation data to display */
 885 bool
 886 AutomationTimeAxisView::has_automation () const
 887 {
 888         return ( (_line && _line->npoints() > 0) || (_view && _view->has_automation()) );
 889 }
 890
 891 list<boost::shared_ptr<AutomationLine> >
 892 AutomationTimeAxisView::lines () const
 893 {
 894         list<boost::shared_ptr<AutomationLine> > lines;
 895
 896         if (_line) {
 897                 lines.push_back (_line);
 898         } else if (_view) {
 899                 lines = _view->get_lines ();
 900         }
 901
 902         return lines;
 903 }
 904
 905 string
 906 AutomationTimeAxisView::state_id() const
 907 {
 908         if (_automatable != _route && _control) {
 909                 return string_compose ("automation %1", _control->id().to_s());
 910         } else if (_parameter) {
 911                 return string_compose ("automation %1 %2/%3/%4",
 912                                        _route->id(),
 913                                        _parameter.type(),
 914                                        _parameter.id(),
 915                                        (int) _parameter.channel());
 916         } else {
 917                 error << "Automation time axis has no state ID" << endmsg;
 918                 return "";
 919         }
 920 }
 921
 922 /** Given a state id string, see if it is one generated by
 923  *  this class.  If so, parse it into its components.
 924  *  @param state_id State ID string to parse.
 925  *  @param route_id Filled in with the route's ID if the state ID string is parsed.
 926  *  @param has_parameter Filled in with true if the state ID has a parameter, otherwise false.
 927  *  @param parameter Filled in with the state ID's parameter, if it has one.
 928  *  @return true if this is a state ID generated by this class, otherwise false.
 929  */
 930
 931 bool
 932 AutomationTimeAxisView::parse_state_id (
 933         string const & state_id,
 934         PBD::ID & route_id,
 935         bool & has_parameter,
 936         Evoral::Parameter & parameter)
 937 {
 938         stringstream s;
 939         s << state_id;
 940
 941         string a, b, c;
 942         s >> a >> b >> c;
 943
 944         if (a != X_("automation")) {
 945                 return false;
 946         }
 947
 948         route_id = PBD::ID (b);
 949
 950         if (c.empty ()) {
 951                 has_parameter = false;
 952                 return true;
 953         }
 954
 955         has_parameter = true;
 956
 957         vector<string> p;
 958         boost::split (p, c, boost::is_any_of ("/"));
 959
 960         assert (p.size() == 3);
 961
 962         parameter = Evoral::Parameter (
 963                 boost::lexical_cast<int> (p[0]),
 964                 boost::lexical_cast<int> (p[2]),
 965                 boost::lexical_cast<int> (p[1])
 966                 );
 967
 968         return true;
 969 }
 970
 971 void
 972 AutomationTimeAxisView::cut_copy_clear (Selection& selection, CutCopyOp op)
 973 {
 974         list<boost::shared_ptr<AutomationLine> > lines;
 975         if (_line) {
 976                 lines.push_back (_line);
 977         } else if (_view) {
 978                 lines = _view->get_lines ();
 979         }
 980
 981         for (list<boost::shared_ptr<AutomationLine> >::iterator i = lines.begin(); i != lines.end(); ++i) {
 982                 cut_copy_clear_one (**i, selection, op);
 983         }
 984 }
 985
 986 void
 987 AutomationTimeAxisView::cut_copy_clear_one (AutomationLine& line, Selection& selection, CutCopyOp op)
 988 {
 989         boost::shared_ptr<Evoral::ControlList> what_we_got;
 990         boost::shared_ptr<AutomationList> alist (line.the_list());
 991
 992         XMLNode &before = alist->get_state();
 993
 994         /* convert time selection to automation list model coordinates */
 995         const Evoral::TimeConverter<double, ARDOUR::framepos_t>& tc = line.time_converter ();
 996         double const start = tc.from (selection.time.front().start - tc.origin_b ());
 997         double const end = tc.from (selection.time.front().end - tc.origin_b ());
 998
 999         switch (op) {
1000         case Delete:
1001                 if (alist->cut (start, end) != 0) {
1002                         _session->add_command(new MementoCommand<AutomationList>(*alist.get(), &before, &alist->get_state()));
1003                 }
1004                 break;
1005
1006         case Cut:
1007
1008                 if ((what_we_got = alist->cut (start, end)) != 0) {
1009                         _editor.get_cut_buffer().add (what_we_got);
1010                         _session->add_command(new MementoCommand<AutomationList>(*alist.get(), &before, &alist->get_state()));
1011                 }
1012                 break;
1013         case Copy:
1014                 if ((what_we_got = alist->copy (start, end)) != 0) {
1015                         _editor.get_cut_buffer().add (what_we_got);
1016                 }
1017                 break;
1018
1019         case Clear:
1020                 if ((what_we_got = alist->cut (start, end)) != 0) {
1021                         _session->add_command(new MementoCommand<AutomationList>(*alist.get(), &before, &alist->get_state()));
1022                 }
1023                 break;
1024         }
1025
1026         if (what_we_got) {
1027                 for (AutomationList::iterator x = what_we_got->begin(); x != what_we_got->end(); ++x) {
1028                         double when = (*x)->when;
1029                         double val  = (*x)->value;
1030                         line.model_to_view_coord (when, val);
1031                         (*x)->when = when;
1032                         (*x)->value = val;
1033                 }
1034         }
1035 }