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