gtk2_ardour/time_axis_view.cc

   1 /*
   2     Copyright (C) 2000 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 <cstdlib>
  21 #include <cmath>
  22 #include <algorithm>
  23 #include <string>
  24 #include <list>
  25
  26 #include <libgnomecanvasmm.h>
  27 #include <libgnomecanvasmm/canvas.h>
  28 #include <libgnomecanvasmm/item.h>
  29
  30 #include "pbd/error.h"
  31 #include "pbd/convert.h"
  32
  33 #include <gtkmm2ext/doi.h>
  34 #include <gtkmm2ext/utils.h>
  35 #include <gtkmm2ext/selector.h>
  36
  37 #include "ardour_ui.h"
  38 #include "ardour_dialog.h"
  39 #include "global_signals.h"
  40 #include "gui_thread.h"
  41 #include "public_editor.h"
  42 #include "time_axis_view.h"
  43 #include "region_view.h"
  44 #include "ghostregion.h"
  45 #include "simplerect.h"
  46 #include "simpleline.h"
  47 #include "selection.h"
  48 #include "keyboard.h"
  49 #include "rgb_macros.h"
  50 #include "utils.h"
  51 #include "streamview.h"
  52 #include "editor_drag.h"
  53 #include "editor.h"
  54
  55 #include "i18n.h"
  56
  57 using namespace std;
  58 using namespace Gtk;
  59 using namespace Gdk;
  60 using namespace ARDOUR;
  61 using namespace PBD;
  62 using namespace Editing;
  63 using namespace ArdourCanvas;
  64 using Gtkmm2ext::Keyboard;
  65
  66 const double trim_handle_size = 6.0; /* pixels */
  67 uint32_t TimeAxisView::button_height = 0;
  68 uint32_t TimeAxisView::extra_height = 0;
  69 int const TimeAxisView::_max_order = 512;
  70 PBD::Signal1<void,TimeAxisView*> TimeAxisView::CatchDeletion;
  71
  72 TimeAxisView::TimeAxisView (ARDOUR::Session* sess, PublicEditor& ed, TimeAxisView* rent, Canvas& /*canvas*/)
  73         : AxisView (sess)
  74         , controls_table (2, 8)
  75         , _name_editing (false)
  76         , height (0)
  77         , display_menu (0)
  78         , parent (rent)
  79         , selection_group (0)
  80         , _hidden (false)
  81         , in_destructor (false)
  82         , _size_menu (0)
  83         , _canvas_display (0)
  84         , _y_position (0)
  85         , _editor (ed)
  86         , name_entry (0)
  87         , control_parent (0)
  88         , _order (0)
  89         , _effective_height (0)
  90         , _resize_drag_start (-1)
  91         , _preresize_cursor (0)
  92         , _have_preresize_cursor (false)
  93         , _ghost_group (0)
  94         , _ebox_release_can_act (true)
  95 {
  96         if (extra_height == 0) {
  97                 compute_heights ();
  98         }
  99
 100         _canvas_background = new Group (*ed.get_background_group (), 0.0, 0.0);
 101         _canvas_display = new Group (*ed.get_trackview_group (), 0.0, 0.0);
 102         _canvas_display->hide(); // reveal as needed
 103
 104         selection_group = new Group (*_canvas_display);
 105         selection_group->set_data (X_("timeselection"), (void *) 1);
 106         selection_group->hide();
 107
 108         _ghost_group = new Group (*_canvas_display);
 109         _ghost_group->lower_to_bottom();
 110         _ghost_group->show();
 111
 112         name_label.set_name ("TrackLabel");
 113         name_label.set_alignment (0.0, 0.5);
 114         ARDOUR_UI::instance()->set_tip (name_label, _("Track/Bus name (double click to edit)"));
 115
 116         Gtk::Entry* an_entry = new Gtk::Entry;
 117         Gtk::Requisition req;
 118         an_entry->size_request (req);
 119         name_label.set_size_request (-1, req.height);
 120         delete an_entry;
 121
 122         name_hbox.pack_start (name_label, true, true);
 123         name_hbox.show ();
 124         name_label.show ();
 125
 126         controls_table.set_size_request (200);
 127         controls_table.set_row_spacings (2);
 128         controls_table.set_col_spacings (2);
 129         controls_table.set_border_width (2);
 130         controls_table.set_homogeneous (true);
 131
 132         controls_table.attach (name_hbox, 0, 5, 0, 1,  Gtk::FILL|Gtk::EXPAND,  Gtk::FILL|Gtk::EXPAND, 3, 0);
 133         controls_table.show_all ();
 134         controls_table.set_no_show_all ();
 135
 136         HSeparator* separator = manage (new HSeparator());
 137
 138         controls_vbox.pack_start (controls_table, false, false);
 139         controls_vbox.show ();
 140
 141         //controls_ebox.set_name ("TimeAxisViewControlsBaseUnselected");
 142         controls_ebox.add (controls_vbox);
 143         controls_ebox.add_events (Gdk::BUTTON_PRESS_MASK|
 144                                   Gdk::BUTTON_RELEASE_MASK|
 145                                   Gdk::POINTER_MOTION_MASK|
 146                                   Gdk::ENTER_NOTIFY_MASK|
 147                                   Gdk::LEAVE_NOTIFY_MASK|
 148                                   Gdk::SCROLL_MASK);
 149         controls_ebox.set_flags (CAN_FOCUS);
 150
 151         /* note that this handler connects *before* the default handler */
 152         controls_ebox.signal_scroll_event().connect (sigc::mem_fun (*this, &TimeAxisView::controls_ebox_scroll), true);
 153         controls_ebox.signal_button_press_event().connect (sigc::mem_fun (*this, &TimeAxisView::controls_ebox_button_press));
 154         controls_ebox.signal_button_release_event().connect (sigc::mem_fun (*this, &TimeAxisView::controls_ebox_button_release));
 155         controls_ebox.signal_motion_notify_event().connect (sigc::mem_fun (*this, &TimeAxisView::controls_ebox_motion));
 156         controls_ebox.signal_leave_notify_event().connect (sigc::mem_fun (*this, &TimeAxisView::controls_ebox_leave));
 157         controls_ebox.show ();
 158
 159         controls_hbox.pack_start (controls_ebox, true, true);
 160         controls_hbox.show ();
 161
 162         time_axis_vbox.pack_start (controls_hbox, true, true);
 163         time_axis_vbox.pack_end (*separator, false, false);
 164         time_axis_vbox.show();
 165
 166         ColorsChanged.connect (sigc::mem_fun (*this, &TimeAxisView::color_handler));
 167
 168         GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&TimeAxisView::erase_ghost, this, _1), gui_context());
 169 }
 170
 171 TimeAxisView::~TimeAxisView()
 172 {
 173         in_destructor = true;
 174
 175         for (list<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 176                 delete *i;
 177         }
 178
 179         for (list<SelectionRect*>::iterator i = free_selection_rects.begin(); i != free_selection_rects.end(); ++i) {
 180                 delete (*i)->rect;
 181                 delete (*i)->start_trim;
 182                 delete (*i)->end_trim;
 183
 184         }
 185
 186         for (list<SelectionRect*>::iterator i = used_selection_rects.begin(); i != used_selection_rects.end(); ++i) {
 187                 delete (*i)->rect;
 188                 delete (*i)->start_trim;
 189                 delete (*i)->end_trim;
 190         }
 191
 192         delete selection_group;
 193         selection_group = 0;
 194
 195         delete _canvas_background;
 196         _canvas_background = 0;
 197
 198         delete _canvas_display;
 199         _canvas_display = 0;
 200
 201         delete display_menu;
 202         display_menu = 0;
 203
 204         delete _size_menu;
 205 }
 206
 207 void
 208 TimeAxisView::hide ()
 209 {
 210         if (_hidden) {
 211                 return;
 212         }
 213
 214         _canvas_display->hide ();
 215         _canvas_background->hide ();
 216
 217         if (control_parent) {
 218                 control_parent->remove (time_axis_vbox);
 219                 control_parent = 0;
 220         }
 221
 222         _y_position = -1;
 223         _hidden = true;
 224
 225         /* now hide children */
 226
 227         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 228                 (*i)->hide ();
 229         }
 230
 231         /* if its hidden, it cannot be selected */
 232         _editor.get_selection().remove (this);
 233         /* and neither can its regions */
 234         _editor.get_selection().remove_regions (this);
 235
 236         Hiding ();
 237 }
 238
 239 /** Display this TimeAxisView as the nth component of the parent box, at y.
 240 *
 241 * @param y y position.
 242 * @param nth index for this TimeAxisView, increased if this view has children.
 243 * @param parent parent component.
 244 * @return height of this TimeAxisView.
 245 */
 246 guint32
 247 TimeAxisView::show_at (double y, int& nth, VBox *parent)
 248 {
 249         if (control_parent) {
 250                 control_parent->reorder_child (time_axis_vbox, nth);
 251         } else {
 252                 control_parent = parent;
 253                 parent->pack_start (time_axis_vbox, false, false);
 254                 parent->reorder_child (time_axis_vbox, nth);
 255         }
 256
 257         _order = nth;
 258
 259         if (_y_position != y) {
 260                 _canvas_display->property_y () = y;
 261                 _canvas_background->property_y () = y;
 262                 /* silly canvas */
 263                 _canvas_display->move (0.0, 0.0);
 264                 _canvas_background->move (0.0, 0.0);
 265                 _y_position = y;
 266
 267         }
 268
 269         _canvas_background->raise_to_top ();
 270         _canvas_display->raise_to_top ();
 271
 272         _canvas_background->show ();
 273         _canvas_display->show ();
 274
 275         _hidden = false;
 276
 277         _effective_height = current_height ();
 278
 279         /* now show relevant children */
 280
 281         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 282                 if ((*i)->marked_for_display()) {
 283                         ++nth;
 284                         _effective_height += (*i)->show_at (y + _effective_height, nth, parent);
 285                 } else {
 286                         (*i)->hide ();
 287                 }
 288         }
 289
 290         return _effective_height;
 291 }
 292
 293 void
 294 TimeAxisView::clip_to_viewport ()
 295 {
 296         if (marked_for_display()) {
 297                 if (_y_position + _effective_height < _editor.get_trackview_group_vertical_offset () || _y_position > _editor.get_trackview_group_vertical_offset () + _canvas_display->get_canvas()->get_height()) {
 298                         _canvas_background->hide ();
 299                         _canvas_display->hide ();
 300                         return;
 301                 }
 302                 _canvas_background->show ();
 303                 _canvas_display->show ();
 304         }
 305         return;
 306 }
 307
 308 bool
 309 TimeAxisView::controls_ebox_scroll (GdkEventScroll* ev)
 310 {
 311         switch (ev->direction) {
 312         case GDK_SCROLL_UP:
 313                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
 314                         /* See Editor::_stepping_axis_view for notes on this hack */
 315                         Editor& e = dynamic_cast<Editor&> (_editor);
 316                         if (!e.stepping_axis_view ()) {
 317                                 e.set_stepping_axis_view (this);
 318                         }
 319                         e.stepping_axis_view()->step_height (false);
 320                         return true;
 321                 } else if (Keyboard::no_modifiers_active (ev->state)) {
 322                         _editor.scroll_tracks_up_line();
 323                         return true;
 324                 }
 325                 break;
 326
 327         case GDK_SCROLL_DOWN:
 328                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
 329                         /* See Editor::_stepping_axis_view for notes on this hack */
 330                         Editor& e = dynamic_cast<Editor&> (_editor);
 331                         if (!e.stepping_axis_view ()) {
 332                                 e.set_stepping_axis_view (this);
 333                         }
 334                         e.stepping_axis_view()->step_height (true);
 335                         return true;
 336                 } else if (Keyboard::no_modifiers_active (ev->state)) {
 337                         _editor.scroll_tracks_down_line();
 338                         return true;
 339                 }
 340                 break;
 341
 342         default:
 343                 /* no handling for left/right, yet */
 344                 break;
 345         }
 346
 347         return false;
 348 }
 349
 350 bool
 351 TimeAxisView::controls_ebox_button_press (GdkEventButton* event)
 352 {
 353         if ((event->button == 1 && event->type == GDK_2BUTTON_PRESS) || Keyboard::is_edit_event (event)) {
 354                 /* see if it is inside the name label */
 355                 if (name_label.is_ancestor (controls_ebox)) {
 356                         int nlx;
 357                         int nly;
 358                         controls_ebox.translate_coordinates (name_label, event->x, event->y, nlx, nly);
 359                         Gtk::Allocation a = name_label.get_allocation ();
 360                         if (nlx > 0 && nlx < a.get_width() && nly > 0 && nly < a.get_height()) {
 361                                 begin_name_edit ();
 362                                 _ebox_release_can_act = false;
 363                                 return true;
 364                         }
 365                 }
 366
 367         }
 368
 369         _ebox_release_can_act = true;
 370
 371         if (maybe_set_cursor (event->y) > 0) {
 372                 _resize_drag_start = event->y_root;
 373         }
 374
 375         return true;
 376 }
 377
 378 void
 379 TimeAxisView::idle_resize (uint32_t h)
 380 {
 381         set_height (h);
 382 }
 383
 384
 385 bool
 386 TimeAxisView::controls_ebox_motion (GdkEventMotion* ev)
 387 {
 388         if (_resize_drag_start >= 0) {
 389                 /* (ab)use the DragManager to do autoscrolling; adjust the event coordinates
 390                    into the world coordinate space that DragManager::motion_handler is expecting,
 391                    and then fake a DragManager motion event so that when maybe_autoscroll
 392                    asks DragManager for the current pointer position it will get the correct
 393                    answers.
 394                 */
 395                 int tx, ty;
 396                 controls_ebox.translate_coordinates (*control_parent, ev->x, ev->y, tx, ty);
 397                 ev->y = ty - _editor.get_trackview_group_vertical_offset();
 398                 _editor.drags()->motion_handler ((GdkEvent *) ev, false);
 399                 _editor.maybe_autoscroll (false, true, false, ev->y_root < _resize_drag_start);
 400
 401                 /* now do the actual TAV resize */
 402                 int32_t const delta = (int32_t) floor (ev->y_root - _resize_drag_start);
 403                 _editor.add_to_idle_resize (this, delta);
 404                 _resize_drag_start = ev->y_root;
 405         } else {
 406                 /* not dragging but ... */
 407                 maybe_set_cursor (ev->y);
 408         }
 409
 410         return true;
 411 }
 412
 413 bool
 414 TimeAxisView::controls_ebox_leave (GdkEventCrossing*)
 415 {
 416         if (_have_preresize_cursor) {
 417                 gdk_window_set_cursor (controls_ebox.get_window()->gobj(), _preresize_cursor);
 418                 _have_preresize_cursor = false;
 419         }
 420         return true;
 421 }
 422
 423 bool
 424 TimeAxisView::maybe_set_cursor (int y)
 425 {
 426         /* XXX no Gtkmm Gdk::Window::get_cursor() */
 427         Glib::RefPtr<Gdk::Window> win = controls_ebox.get_window();
 428
 429         if (y > (gint) floor (controls_ebox.get_height() * 0.75)) {
 430
 431                 /* y-coordinate in lower 25% */
 432
 433                 if (!_have_preresize_cursor) {
 434                         _preresize_cursor = gdk_window_get_cursor (win->gobj());
 435                         _have_preresize_cursor = true;
 436                         win->set_cursor (Gdk::Cursor(Gdk::SB_V_DOUBLE_ARROW));
 437                 }
 438
 439                 return 1;
 440
 441         } else if (_have_preresize_cursor) {
 442                 gdk_window_set_cursor (win->gobj(), _preresize_cursor);
 443                 _have_preresize_cursor = false;
 444
 445                 return -1;
 446         }
 447
 448         return 0;
 449 }
 450
 451 bool
 452 TimeAxisView::controls_ebox_button_release (GdkEventButton* ev)
 453 {
 454         if (_resize_drag_start >= 0) {
 455                 if (_have_preresize_cursor) {
 456                         gdk_window_set_cursor (controls_ebox.get_window()->gobj(), _preresize_cursor);
 457                         _preresize_cursor = 0;
 458                         _have_preresize_cursor = false;
 459                 }
 460                 _editor.stop_canvas_autoscroll ();
 461                 _resize_drag_start = -1;
 462         }
 463
 464         if (!_ebox_release_can_act) {
 465                 return true;
 466         }
 467
 468         switch (ev->button) {
 469         case 1:
 470                 selection_click (ev);
 471                 break;
 472
 473         case 3:
 474                 popup_display_menu (ev->time);
 475                 break;
 476         }
 477
 478         return true;
 479 }
 480
 481 void
 482 TimeAxisView::selection_click (GdkEventButton* ev)
 483 {
 484         Selection::Operation op = ArdourKeyboard::selection_type (ev->state);
 485         _editor.set_selected_track (*this, op, false);
 486 }
 487
 488
 489 /** Steps through the defined heights for this TrackView.
 490  *  @param coarser true if stepping should decrease in size, otherwise false.
 491  */
 492 void
 493 TimeAxisView::step_height (bool coarser)
 494 {
 495         static const uint32_t step = 25;
 496
 497         if (coarser) {
 498
 499                 if (height <= preset_height (HeightSmall)) {
 500                         return;
 501                 } else if (height <= preset_height (HeightNormal) && height > preset_height (HeightSmall)) {
 502                         set_height_enum (HeightSmall);
 503                 } else {
 504                         set_height (height - step);
 505                 }
 506
 507         } else {
 508
 509                 if (height <= preset_height(HeightSmall)) {
 510                         set_height_enum (HeightNormal);
 511                 } else {
 512                         set_height (height + step);
 513                 }
 514
 515         }
 516 }
 517
 518 void
 519 TimeAxisView::set_height_enum (Height h, bool apply_to_selection)
 520 {
 521         if (apply_to_selection) {
 522                 _editor.get_selection().tracks.foreach_time_axis (boost::bind (&TimeAxisView::set_height_enum, _1, h, false));
 523         } else {
 524                 set_height (preset_height (h));
 525         }
 526 }
 527
 528 void
 529 TimeAxisView::set_height (uint32_t h)
 530 {
 531         if (h < preset_height (HeightSmall)) {
 532                 h = preset_height (HeightSmall);
 533         }
 534
 535         time_axis_vbox.property_height_request () = h;
 536         height = h;
 537
 538         char buf[32];
 539         snprintf (buf, sizeof (buf), "%u", height);
 540         set_gui_property ("height", buf);
 541
 542         for (list<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 543                 (*i)->set_height ();
 544         }
 545
 546         if (canvas_item_visible (selection_group)) {
 547                 /* resize the selection rect */
 548                 show_selection (_editor.get_selection().time);
 549         }
 550 }
 551
 552 bool
 553 TimeAxisView::name_entry_key_press (GdkEventKey* ev)
 554 {
 555         /* steal escape, tabs from GTK */
 556
 557         switch (ev->keyval) {
 558         case GDK_Escape:
 559         case GDK_ISO_Left_Tab:
 560         case GDK_Tab:
 561                 return true;
 562         }
 563         return false;
 564 }
 565
 566 bool
 567 TimeAxisView::name_entry_key_release (GdkEventKey* ev)
 568 {
 569         TrackViewList::iterator i;
 570
 571         switch (ev->keyval) {
 572         case GDK_Escape:
 573                 end_name_edit (RESPONSE_CANCEL);
 574                 return true;
 575
 576         /* Shift+Tab Keys Pressed. Note that for Shift+Tab, GDK actually
 577          * generates a different ev->keyval, rather than setting
 578          * ev->state.
 579          */
 580         case GDK_ISO_Left_Tab:
 581                 end_name_edit (RESPONSE_APPLY);
 582                 return true;
 583
 584         case GDK_Tab:
 585                 end_name_edit (RESPONSE_ACCEPT);
 586                 return true;
 587         default:
 588                 break;
 589         }
 590
 591         return false;
 592 }
 593
 594 bool
 595 TimeAxisView::name_entry_focus_out (GdkEventFocus*)
 596 {
 597         end_name_edit (RESPONSE_OK);
 598         return false;
 599 }
 600
 601 void
 602 TimeAxisView::begin_name_edit ()
 603 {
 604         if (name_entry) {
 605                 return;
 606         }
 607
 608         if (can_edit_name()) {
 609
 610                 name_entry = manage (new Gtkmm2ext::FocusEntry);
 611
 612                 name_entry->set_name ("EditorTrackNameDisplay");
 613                 name_entry->signal_key_press_event().connect (sigc::mem_fun (*this, &TimeAxisView::name_entry_key_press), false);
 614                 name_entry->signal_key_release_event().connect (sigc::mem_fun (*this, &TimeAxisView::name_entry_key_release), false);
 615                 name_entry->signal_focus_out_event().connect (sigc::mem_fun (*this, &TimeAxisView::name_entry_focus_out));
 616                 name_entry->set_text (name_label.get_text());
 617                 name_entry->signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &TimeAxisView::end_name_edit), RESPONSE_OK));
 618
 619                 if (name_label.is_ancestor (name_hbox)) {
 620                         name_hbox.remove (name_label);
 621                 }
 622
 623                 name_hbox.pack_start (*name_entry);
 624                 name_entry->show ();
 625
 626                 name_entry->select_region (0, -1);
 627                 name_entry->set_state (STATE_SELECTED);
 628                 name_entry->grab_focus ();
 629                 name_entry->start_editing (0);
 630         }
 631 }
 632
 633 void
 634 TimeAxisView::end_name_edit (int response)
 635 {
 636         if (!name_entry) {
 637                 return;
 638         }
 639
 640         bool edit_next = false;
 641         bool edit_prev = false;
 642
 643         switch (response) {
 644         case RESPONSE_CANCEL:
 645                 break;
 646         case RESPONSE_OK:
 647                 name_entry_changed ();
 648                 break;
 649         case RESPONSE_ACCEPT:
 650                 name_entry_changed ();
 651                 edit_next = true;
 652         case RESPONSE_APPLY:
 653                 name_entry_changed ();
 654                 edit_prev = true;
 655         }
 656
 657         /* this will delete the name_entry. but it will also drop focus, which
 658          * will cause another callback to this function, so set name_entry = 0
 659          * first to ensure we don't double-remove etc. etc.
 660          */
 661
 662         Gtk::Entry* tmp = name_entry;
 663         name_entry = 0;
 664         name_hbox.remove (*tmp);
 665
 666         /* put the name label back */
 667
 668         name_hbox.pack_start (name_label);
 669         name_label.show ();
 670
 671         if (edit_next) {
 672
 673                 TrackViewList const & allviews = _editor.get_track_views ();
 674                 TrackViewList::const_iterator i = find (allviews.begin(), allviews.end(), this);
 675
 676                 if (i != allviews.end()) {
 677
 678                         do {
 679                                 if (++i == allviews.end()) {
 680                                         return;
 681                                 }
 682
 683                                 RouteTimeAxisView* rtav = dynamic_cast<RouteTimeAxisView*>(*i);
 684
 685                                 if (rtav && rtav->route()->record_enabled()) {
 686                                         continue;
 687                                 }
 688
 689                                 if (!(*i)->hidden()) {
 690                                         break;
 691                                 }
 692
 693                         } while (true);
 694                 }
 695
 696                 if ((i != allviews.end()) && (*i != this) && !(*i)->hidden()) {
 697                         _editor.ensure_time_axis_view_is_visible (**i);
 698                         (*i)->begin_name_edit ();
 699                 }
 700
 701         } else if (edit_prev) {
 702
 703                 TrackViewList const & allviews = _editor.get_track_views ();
 704                 TrackViewList::const_iterator i = find (allviews.begin(), allviews.end(), this);
 705
 706                 if (i != allviews.begin()) {
 707                         do {
 708                                 if (i == allviews.begin()) {
 709                                         return;
 710                                 }
 711
 712                                 --i;
 713
 714                                 RouteTimeAxisView* rtav = dynamic_cast<RouteTimeAxisView*>(*i);
 715
 716                                 if (rtav && rtav->route()->record_enabled()) {
 717                                         continue;
 718                                 }
 719
 720                                 if (!(*i)->hidden()) {
 721                                         break;
 722                                 }
 723
 724                         } while (true);
 725                 }
 726
 727                 if ((i != allviews.end()) && (*i != this) && !(*i)->hidden()) {
 728                         _editor.ensure_time_axis_view_is_visible (**i);
 729                         (*i)->begin_name_edit ();
 730                 }
 731         }
 732 }
 733
 734 void
 735 TimeAxisView::name_entry_changed ()
 736 {
 737 }
 738
 739 bool
 740 TimeAxisView::can_edit_name () const
 741 {
 742         return true;
 743 }
 744
 745 void
 746 TimeAxisView::conditionally_add_to_selection ()
 747 {
 748         Selection& s (_editor.get_selection ());
 749
 750         if (!s.selected (this)) {
 751                 _editor.set_selected_track (*this, Selection::Set);
 752         }
 753 }
 754
 755 void
 756 TimeAxisView::popup_display_menu (guint32 when)
 757 {
 758         conditionally_add_to_selection ();
 759
 760         build_display_menu ();
 761         display_menu->popup (1, when);
 762 }
 763
 764 void
 765 TimeAxisView::set_selected (bool yn)
 766 {
 767         if (yn == _selected) {
 768                 return;
 769         }
 770
 771         Selectable::set_selected (yn);
 772
 773         if (_selected) {
 774                 controls_ebox.set_name (controls_base_selected_name);
 775                 time_axis_vbox.set_name (controls_base_selected_name);
 776                 controls_vbox.set_name (controls_base_selected_name);
 777         } else {
 778                 controls_ebox.set_name (controls_base_unselected_name);
 779                 time_axis_vbox.set_name (controls_base_unselected_name);
 780                 controls_vbox.set_name (controls_base_unselected_name);
 781                 hide_selection ();
 782
 783                 /* children will be set for the yn=true case. but when deselecting
 784                    the editor only has a list of top-level trackviews, so we
 785                    have to do this here.
 786                 */
 787
 788                 for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 789                         (*i)->set_selected (false);
 790                 }
 791         }
 792 }
 793
 794 void
 795 TimeAxisView::build_display_menu ()
 796 {
 797         using namespace Menu_Helpers;
 798
 799         delete display_menu;
 800
 801         display_menu = new Menu;
 802         display_menu->set_name ("ArdourContextMenu");
 803
 804         // Just let implementing classes define what goes into the manu
 805 }
 806
 807 void
 808 TimeAxisView::set_samples_per_unit (double spu)
 809 {
 810         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 811                 (*i)->set_samples_per_unit (spu);
 812         }
 813
 814         AnalysisFeatureList::const_iterator i;
 815         list<ArdourCanvas::SimpleLine*>::iterator l;
 816 }
 817
 818 void
 819 TimeAxisView::show_timestretch (framepos_t start, framepos_t end, int layers, int layer)
 820 {
 821         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 822                 (*i)->show_timestretch (start, end, layers, layer);
 823         }
 824 }
 825
 826 void
 827 TimeAxisView::hide_timestretch ()
 828 {
 829         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 830                 (*i)->hide_timestretch ();
 831         }
 832 }
 833
 834 void
 835 TimeAxisView::show_selection (TimeSelection& ts)
 836 {
 837         double x1;
 838         double x2;
 839         double y2;
 840         SelectionRect *rect;
 841
 842         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 843                 (*i)->show_selection (ts);
 844         }
 845
 846         if (canvas_item_visible (selection_group)) {
 847                 while (!used_selection_rects.empty()) {
 848                         free_selection_rects.push_front (used_selection_rects.front());
 849                         used_selection_rects.pop_front();
 850                         free_selection_rects.front()->rect->hide();
 851                         free_selection_rects.front()->start_trim->hide();
 852                         free_selection_rects.front()->end_trim->hide();
 853                 }
 854                 selection_group->hide();
 855         }
 856
 857         selection_group->show();
 858         selection_group->raise_to_top();
 859
 860         for (list<AudioRange>::iterator i = ts.begin(); i != ts.end(); ++i) {
 861                 framepos_t start, end;
 862                 framecnt_t cnt;
 863
 864                 start = (*i).start;
 865                 end = (*i).end;
 866                 cnt = end - start + 1;
 867
 868                 rect = get_selection_rect ((*i).id);
 869
 870                 x1 = _editor.frame_to_unit (start);
 871                 x2 = _editor.frame_to_unit (start + cnt - 1);
 872                 y2 = current_height();
 873
 874                 rect->rect->property_x1() = x1;
 875                 rect->rect->property_y1() = 1.0;
 876                 rect->rect->property_x2() = x2;
 877                 rect->rect->property_y2() = y2;
 878
 879                 // trim boxes are at the top for selections
 880
 881                 if (x2 > x1) {
 882                         rect->start_trim->property_x1() = x1;
 883                         rect->start_trim->property_y1() = 1.0;
 884                         rect->start_trim->property_x2() = x1 + trim_handle_size;
 885                         rect->start_trim->property_y2() = y2;
 886
 887                         rect->end_trim->property_x1() = x2 - trim_handle_size;
 888                         rect->end_trim->property_y1() = 1.0;
 889                         rect->end_trim->property_x2() = x2;
 890                         rect->end_trim->property_y2() = y2;
 891
 892                         rect->start_trim->show();
 893                         rect->end_trim->show();
 894                 } else {
 895                         rect->start_trim->hide();
 896                         rect->end_trim->hide();
 897                 }
 898
 899                 rect->rect->show ();
 900                 used_selection_rects.push_back (rect);
 901         }
 902 }
 903
 904 void
 905 TimeAxisView::reshow_selection (TimeSelection& ts)
 906 {
 907         show_selection (ts);
 908
 909         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 910                 (*i)->show_selection (ts);
 911         }
 912 }
 913
 914 void
 915 TimeAxisView::hide_selection ()
 916 {
 917         if (canvas_item_visible (selection_group)) {
 918                 while (!used_selection_rects.empty()) {
 919                         free_selection_rects.push_front (used_selection_rects.front());
 920                         used_selection_rects.pop_front();
 921                         free_selection_rects.front()->rect->hide();
 922                         free_selection_rects.front()->start_trim->hide();
 923                         free_selection_rects.front()->end_trim->hide();
 924                 }
 925                 selection_group->hide();
 926         }
 927
 928         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 929                 (*i)->hide_selection ();
 930         }
 931 }
 932
 933 void
 934 TimeAxisView::order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top)
 935 {
 936         /* find the selection rect this is for. we have the item corresponding to one
 937            of the trim handles.
 938          */
 939
 940         for (list<SelectionRect*>::iterator i = used_selection_rects.begin(); i != used_selection_rects.end(); ++i) {
 941                 if ((*i)->start_trim == item || (*i)->end_trim == item) {
 942
 943                         /* make one trim handle be "above" the other so that if they overlap,
 944                            the top one is the one last used.
 945                         */
 946
 947                         (*i)->rect->raise_to_top ();
 948                         (put_start_on_top ? (*i)->start_trim : (*i)->end_trim)->raise_to_top ();
 949                         (put_start_on_top ? (*i)->end_trim : (*i)->start_trim)->raise_to_top ();
 950
 951                         break;
 952                 }
 953         }
 954 }
 955
 956 SelectionRect *
 957 TimeAxisView::get_selection_rect (uint32_t id)
 958 {
 959         SelectionRect *rect;
 960
 961         /* check to see if we already have a visible rect for this particular selection ID */
 962
 963         for (list<SelectionRect*>::iterator i = used_selection_rects.begin(); i != used_selection_rects.end(); ++i) {
 964                 if ((*i)->id == id) {
 965                         return (*i);
 966                 }
 967         }
 968
 969         /* ditto for the free rect list */
 970
 971         for (list<SelectionRect*>::iterator i = free_selection_rects.begin(); i != free_selection_rects.end(); ++i) {
 972                 if ((*i)->id == id) {
 973                         SelectionRect* ret = (*i);
 974                         free_selection_rects.erase (i);
 975                         return ret;
 976                 }
 977         }
 978
 979         /* no existing matching rect, so go get a new one from the free list, or create one if there are none */
 980
 981         if (free_selection_rects.empty()) {
 982
 983                 rect = new SelectionRect;
 984
 985                 rect->rect = new SimpleRect (*selection_group);
 986                 rect->rect->property_outline_what() = 0x0;
 987                 rect->rect->property_x1() = 0.0;
 988                 rect->rect->property_y1() = 0.0;
 989                 rect->rect->property_x2() = 0.0;
 990                 rect->rect->property_y2() = 0.0;
 991                 rect->rect->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_SelectionRect.get();
 992
 993                 rect->start_trim = new SimpleRect (*selection_group);
 994                 rect->start_trim->property_outline_what() = 0x0;
 995                 rect->start_trim->property_x1() = 0.0;
 996                 rect->start_trim->property_x2() = 0.0;
 997
 998                 rect->end_trim = new SimpleRect (*selection_group);
 999                 rect->end_trim->property_outline_what() = 0x0;
1000                 rect->end_trim->property_x1() = 0.0;
1001                 rect->end_trim->property_x2() = 0.0;
1002
1003                 free_selection_rects.push_front (rect);
1004
1005                 rect->rect->signal_event().connect (sigc::bind (sigc::mem_fun (_editor, &PublicEditor::canvas_selection_rect_event), rect->rect, rect));
1006                 rect->start_trim->signal_event().connect (sigc::bind (sigc::mem_fun (_editor, &PublicEditor::canvas_selection_start_trim_event), rect->rect, rect));
1007                 rect->end_trim->signal_event().connect (sigc::bind (sigc::mem_fun (_editor, &PublicEditor::canvas_selection_end_trim_event), rect->rect, rect));
1008         }
1009
1010         rect = free_selection_rects.front();
1011         rect->id = id;
1012         free_selection_rects.pop_front();
1013         return rect;
1014 }
1015
1016 struct null_deleter { void operator()(void const *) const {} };
1017
1018 bool
1019 TimeAxisView::is_child (TimeAxisView* tav)
1020 {
1021         return find (children.begin(), children.end(), boost::shared_ptr<TimeAxisView>(tav, null_deleter())) != children.end();
1022 }
1023
1024 void
1025 TimeAxisView::add_child (boost::shared_ptr<TimeAxisView> child)
1026 {
1027         children.push_back (child);
1028 }
1029
1030 void
1031 TimeAxisView::remove_child (boost::shared_ptr<TimeAxisView> child)
1032 {
1033         Children::iterator i;
1034
1035         if ((i = find (children.begin(), children.end(), child)) != children.end()) {
1036                 children.erase (i);
1037         }
1038 }
1039
1040 /** Get selectable things within a given range.
1041  *  @param start Start time in session frames.
1042  *  @param end End time in session frames.
1043  *  @param top Top y range, in trackview coordinates (ie 0 is the top of the track view)
1044  *  @param bot Bottom y range, in trackview coordinates (ie 0 is the top of the track view)
1045  *  @param result Filled in with selectable things.
1046  */
1047 void
1048 TimeAxisView::get_selectables (framepos_t /*start*/, framepos_t /*end*/, double /*top*/, double /*bot*/, list<Selectable*>& /*result*/)
1049 {
1050         return;
1051 }
1052
1053 void
1054 TimeAxisView::get_inverted_selectables (Selection& /*sel*/, list<Selectable*>& /*result*/)
1055 {
1056         return;
1057 }
1058
1059 void
1060 TimeAxisView::add_ghost (RegionView* rv)
1061 {
1062         GhostRegion* gr = rv->add_ghost (*this);
1063
1064         if (gr) {
1065                 ghosts.push_back(gr);
1066         }
1067 }
1068
1069 void
1070 TimeAxisView::remove_ghost (RegionView* rv)
1071 {
1072         rv->remove_ghost_in (*this);
1073 }
1074
1075 void
1076 TimeAxisView::erase_ghost (GhostRegion* gr)
1077 {
1078         if (in_destructor) {
1079                 return;
1080         }
1081
1082         for (list<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
1083                 if ((*i) == gr) {
1084                         ghosts.erase (i);
1085                         break;
1086                 }
1087         }
1088 }
1089
1090 bool
1091 TimeAxisView::touched (double top, double bot)
1092 {
1093         /* remember: this is X Window - coordinate space starts in upper left and moves down.
1094           y_position is the "origin" or "top" of the track.
1095         */
1096
1097         double mybot = _y_position + current_height();
1098
1099         return ((_y_position <= bot && _y_position >= top) ||
1100                 ((mybot <= bot) && (top < mybot)) ||
1101                 (mybot >= bot && _y_position < top));
1102 }
1103
1104 void
1105 TimeAxisView::set_parent (TimeAxisView& p)
1106 {
1107         parent = &p;
1108 }
1109
1110 void
1111 TimeAxisView::reset_height ()
1112 {
1113         set_height (height);
1114
1115         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
1116                 (*i)->set_height ((*i)->height);
1117         }
1118 }
1119
1120 void
1121 TimeAxisView::compute_heights ()
1122 {
1123         Gtk::Window window (Gtk::WINDOW_TOPLEVEL);
1124         Gtk::Table two_row_table (2, 8);
1125         Gtk::Table one_row_table (1, 8);
1126         Button* buttons[5];
1127         const int border_width = 2;
1128
1129         const int separator_height = 2;
1130         extra_height = (2 * border_width) + separator_height;
1131
1132         window.add (one_row_table);
1133
1134         one_row_table.set_border_width (border_width);
1135         one_row_table.set_row_spacings (0);
1136         one_row_table.set_col_spacings (0);
1137         one_row_table.set_homogeneous (true);
1138
1139         two_row_table.set_border_width (border_width);
1140         two_row_table.set_row_spacings (0);
1141         two_row_table.set_col_spacings (0);
1142         two_row_table.set_homogeneous (true);
1143
1144         for (int i = 0; i < 5; ++i) {
1145                 buttons[i] = manage (new Button (X_("f")));
1146                 buttons[i]->set_name ("TrackMuteButton");
1147         }
1148
1149         one_row_table.attach (*buttons[0], 6, 7, 0, 1, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND, 0, 0);
1150
1151         one_row_table.show_all ();
1152         Gtk::Requisition req(one_row_table.size_request ());
1153
1154         // height required to show 1 row of buttons
1155         button_height = req.height;
1156 }
1157
1158 void
1159 TimeAxisView::color_handler ()
1160 {
1161         for (list<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); i++) {
1162                 (*i)->set_colors();
1163         }
1164
1165         for (list<SelectionRect*>::iterator i = used_selection_rects.begin(); i != used_selection_rects.end(); ++i) {
1166
1167                 (*i)->rect->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_SelectionRect.get();
1168                 (*i)->rect->property_outline_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1169
1170                 (*i)->start_trim->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1171                 (*i)->start_trim->property_outline_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1172
1173                 (*i)->end_trim->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1174                 (*i)->end_trim->property_outline_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1175         }
1176
1177         for (list<SelectionRect*>::iterator i = free_selection_rects.begin(); i != free_selection_rects.end(); ++i) {
1178
1179                 (*i)->rect->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_SelectionRect.get();
1180                 (*i)->rect->property_outline_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1181
1182                 (*i)->start_trim->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1183                 (*i)->start_trim->property_outline_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1184
1185                 (*i)->end_trim->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1186                 (*i)->end_trim->property_outline_color_rgba() = ARDOUR_UI::config()->canvasvar_Selection.get();
1187         }
1188 }
1189
1190 /** @return Pair: TimeAxisView, layer index.
1191  * TimeAxisView is non-0 if this object covers y, or one of its children does.
1192  * If the covering object is a child axis, then the child is returned.
1193  * TimeAxisView is 0 otherwise.
1194  * Layer index is the layer number (possibly fractional) if the TimeAxisView is valid
1195  * and is in stacked or expanded * region display mode, otherwise 0.
1196  */
1197 std::pair<TimeAxisView*, double>
1198 TimeAxisView::covers_y_position (double y)
1199 {
1200         if (hidden()) {
1201                 return std::make_pair ((TimeAxisView *) 0, 0);
1202         }
1203
1204         if (_y_position <= y && y < (_y_position + height)) {
1205
1206                 /* work out the layer index if appropriate */
1207                 double l = 0;
1208                 switch (layer_display ()) {
1209                 case Overlaid:
1210                         break;
1211                 case Stacked:
1212                         if (view ()) {
1213                                 /* compute layer */
1214                                 l = layer_t ((_y_position + height - y) / (view()->child_height ()));
1215                                 /* clamp to max layers to be on the safe side; sometimes the above calculation
1216                                    returns a too-high value */
1217                                 if (l >= view()->layers ()) {
1218                                         l = view()->layers() - 1;
1219                                 }
1220                         }
1221                         break;
1222                 case Expanded:
1223                         if (view ()) {
1224                                 int const n = floor ((_y_position + height - y) / (view()->child_height ()));
1225                                 l = n * 0.5 - 0.5;
1226                                 if (l >= (view()->layers() - 0.5)) {
1227                                         l = view()->layers() - 0.5;
1228                                 }
1229                         }
1230                         break;
1231                 }
1232
1233                 return std::make_pair (this, l);
1234         }
1235
1236         for (Children::const_iterator i = children.begin(); i != children.end(); ++i) {
1237
1238                 std::pair<TimeAxisView*, int> const r = (*i)->covers_y_position (y);
1239                 if (r.first) {
1240                         return r;
1241                 }
1242         }
1243
1244         return std::make_pair ((TimeAxisView *) 0, 0);
1245 }
1246
1247
1248 uint32_t
1249 TimeAxisView::preset_height (Height h)
1250 {
1251         switch (h) {
1252         case HeightLargest:
1253                 return (button_height * 2) + extra_height + 260;
1254         case HeightLarger:
1255                 return (button_height * 2) + extra_height + 160;
1256         case HeightLarge:
1257                 return (button_height * 2) + extra_height + 60;
1258         case HeightNormal:
1259                 return (button_height * 2) + extra_height + 10;
1260         case HeightSmall:
1261                 return button_height + extra_height;
1262         }
1263
1264         /* NOTREACHED */
1265         return 0;
1266 }
1267
1268 /** @return Child time axis views that are not hidden */
1269 TimeAxisView::Children
1270 TimeAxisView::get_child_list ()
1271 {
1272         Children c;
1273
1274         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
1275                 if (!(*i)->hidden()) {
1276                         c.push_back(*i);
1277                 }
1278         }
1279
1280         return c;
1281 }
1282
1283 void
1284 TimeAxisView::build_size_menu ()
1285 {
1286         if (_size_menu && _size_menu->gobj ()) {
1287                 return;
1288         }
1289
1290         delete _size_menu;
1291
1292         using namespace Menu_Helpers;
1293
1294         _size_menu = new Menu;
1295         _size_menu->set_name ("ArdourContextMenu");
1296         MenuList& items = _size_menu->items();
1297
1298         items.push_back (MenuElem (_("Largest"), sigc::bind (sigc::mem_fun (*this, &TimeAxisView::set_height_enum), HeightLargest, true)));
1299         items.push_back (MenuElem (_("Larger"),  sigc::bind (sigc::mem_fun (*this, &TimeAxisView::set_height_enum), HeightLarger, true)));
1300         items.push_back (MenuElem (_("Large"),   sigc::bind (sigc::mem_fun (*this, &TimeAxisView::set_height_enum), HeightLarge, true)));
1301         items.push_back (MenuElem (_("Normal"),  sigc::bind (sigc::mem_fun (*this, &TimeAxisView::set_height_enum), HeightNormal, true)));
1302         items.push_back (MenuElem (_("Small"),   sigc::bind (sigc::mem_fun (*this, &TimeAxisView::set_height_enum), HeightSmall, true)));
1303 }
1304
1305 void
1306 TimeAxisView::reset_visual_state ()
1307 {
1308         /* this method is not required to trigger a global redraw */
1309
1310         string str = gui_property ("height");
1311
1312         if (!str.empty()) {
1313                 set_height (atoi (str));
1314         } else {
1315                 set_height (preset_height (HeightNormal));
1316         }
1317 }
1318
1319 TrackViewList
1320 TrackViewList::filter_to_unique_playlists ()
1321 {
1322         std::set<boost::shared_ptr<ARDOUR::Playlist> > playlists;
1323         TrackViewList ts;
1324
1325         for (iterator i = begin(); i != end(); ++i) {
1326                 RouteTimeAxisView* rtav = dynamic_cast<RouteTimeAxisView*> (*i);
1327                 if (!rtav) {
1328                         /* not a route: include it anyway */
1329                         ts.push_back (*i);
1330                 } else {
1331                         boost::shared_ptr<ARDOUR::Track> t = rtav->track();
1332                         if (t) {
1333                                 if (playlists.insert (t->playlist()).second) {
1334                                         /* playlist not seen yet */
1335                                         ts.push_back (*i);
1336                                 }
1337                         } else {
1338                                 /* not a track: include it anyway */
1339                                 ts.push_back (*i);
1340                         }
1341                 }
1342         }
1343         return ts;
1344 }