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