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
  27 #include "pbd/error.h"
  28 #include "pbd/convert.h"
  29
  30 #include <gtkmm2ext/doi.h>
  31 #include <gtkmm2ext/utils.h>
  32 #include <gtkmm2ext/selector.h>
  33
  34 #include "canvas/rectangle.h"
  35
  36 #include "ardour_ui.h"
  37 #include "ardour_dialog.h"
  38 #include "global_signals.h"
  39 #include "gui_thread.h"
  40 #include "public_editor.h"
  41 #include "time_axis_view.h"
  42 #include "region_view.h"
  43 #include "ghostregion.h"
  44 #include "selection.h"
  45 #include "keyboard.h"
  46 #include "rgb_macros.h"
  47 #include "utils.h"
  48 #include "streamview.h"
  49 #include "editor_drag.h"
  50 #include "editor.h"
  51
  52 #include "i18n.h"
  53
  54 using namespace std;
  55 using namespace Gtk;
  56 using namespace Gdk;
  57 using namespace ARDOUR;
  58 using namespace PBD;
  59 using namespace Editing;
  60 using namespace ArdourCanvas;
  61 using Gtkmm2ext::Keyboard;
  62
  63 const double trim_handle_size = 6.0; /* pixels */
  64 uint32_t TimeAxisView::button_height = 0;
  65 uint32_t TimeAxisView::extra_height = 0;
  66 int const TimeAxisView::_max_order = 512;
  67 PBD::Signal1<void,TimeAxisView*> TimeAxisView::CatchDeletion;
  68
  69 TimeAxisView::TimeAxisView (ARDOUR::Session* sess, PublicEditor& ed, TimeAxisView* rent, Canvas& /*canvas*/)
  70         : AxisView (sess)
  71         , controls_table (2, 8)
  72         , _name_editing (false)
  73         , height (0)
  74         , display_menu (0)
  75         , parent (rent)
  76         , selection_group (0)
  77         , _hidden (false)
  78         , in_destructor (false)
  79         , _size_menu (0)
  80         , _canvas_display (0)
  81         , _y_position (0)
  82         , _editor (ed)
  83         , name_entry (0)
  84         , control_parent (0)
  85         , _order (0)
  86         , _effective_height (0)
  87         , _resize_drag_start (-1)
  88         , _preresize_cursor (0)
  89         , _have_preresize_cursor (false)
  90         , _ghost_group (0)
  91         , _ebox_release_can_act (true)
  92 {
  93         if (extra_height == 0) {
  94                 compute_heights ();
  95         }
  96
  97         _canvas_background = new Group (ed.get_background_group (), ArdourCanvas::Duple (0.0, 0.0));
  98         _canvas_display = new Group (ed.get_trackview_group (), ArdourCanvas::Duple (0.0, 0.0));
  99         _canvas_display->hide(); // reveal as needed
 100
 101         selection_group = new Group (_canvas_display);
 102         selection_group->set_data (X_("timeselection"), (void *) 1);
 103         selection_group->hide();
 104
 105         _ghost_group = new Group (_canvas_display);
 106         _ghost_group->lower_to_bottom();
 107         _ghost_group->show();
 108
 109         name_label.set_name ("TrackLabel");
 110         name_label.set_alignment (0.0, 0.5);
 111         ARDOUR_UI::instance()->set_tip (name_label, _("Track/Bus name (double click to edit)"));
 112
 113         Gtk::Entry* an_entry = new Gtk::Entry;
 114         Gtk::Requisition req;
 115         an_entry->size_request (req);
 116         name_label.set_size_request (-1, req.height);
 117         delete an_entry;
 118
 119         name_hbox.pack_start (name_label, true, true);
 120         name_hbox.show ();
 121         name_label.show ();
 122
 123         controls_table.set_size_request (200);
 124         controls_table.set_row_spacings (2);
 125         controls_table.set_col_spacings (2);
 126         controls_table.set_border_width (2);
 127         controls_table.set_homogeneous (true);
 128
 129         controls_table.attach (name_hbox, 0, 5, 0, 1,  Gtk::FILL|Gtk::EXPAND,  Gtk::FILL|Gtk::EXPAND, 3, 0);
 130         controls_table.show_all ();
 131         controls_table.set_no_show_all ();
 132
 133         HSeparator* separator = manage (new HSeparator());
 134
 135         controls_vbox.pack_start (controls_table, false, false);
 136         controls_vbox.show ();
 137
 138         //controls_ebox.set_name ("TimeAxisViewControlsBaseUnselected");
 139         controls_ebox.add (controls_vbox);
 140         controls_ebox.add_events (Gdk::BUTTON_PRESS_MASK|
 141                                   Gdk::BUTTON_RELEASE_MASK|
 142                                   Gdk::POINTER_MOTION_MASK|
 143                                   Gdk::ENTER_NOTIFY_MASK|
 144                                   Gdk::LEAVE_NOTIFY_MASK|
 145                                   Gdk::SCROLL_MASK);
 146         controls_ebox.set_flags (CAN_FOCUS);
 147
 148         /* note that this handler connects *before* the default handler */
 149         controls_ebox.signal_scroll_event().connect (sigc::mem_fun (*this, &TimeAxisView::controls_ebox_scroll), true);
 150         controls_ebox.signal_button_press_event().connect (sigc::mem_fun (*this, &TimeAxisView::controls_ebox_button_press));
 151         controls_ebox.signal_button_release_event().connect (sigc::mem_fun (*this, &TimeAxisView::controls_ebox_button_release));
 152         controls_ebox.signal_motion_notify_event().connect (sigc::mem_fun (*this, &TimeAxisView::controls_ebox_motion));
 153         controls_ebox.signal_leave_notify_event().connect (sigc::mem_fun (*this, &TimeAxisView::controls_ebox_leave));
 154         controls_ebox.show ();
 155
 156         controls_hbox.pack_start (controls_ebox, true, true);
 157         controls_hbox.show ();
 158
 159         time_axis_vbox.pack_start (controls_hbox, true, true);
 160         time_axis_vbox.pack_end (*separator, false, false);
 161         time_axis_vbox.show();
 162
 163         ColorsChanged.connect (sigc::mem_fun (*this, &TimeAxisView::color_handler));
 164
 165         GhostRegion::CatchDeletion.connect (*this, invalidator (*this), boost::bind (&TimeAxisView::erase_ghost, this, _1), gui_context());
 166 }
 167
 168 TimeAxisView::~TimeAxisView()
 169 {
 170         in_destructor = true;
 171
 172         for (list<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 173                 delete *i;
 174         }
 175
 176         for (list<SelectionRect*>::iterator i = free_selection_rects.begin(); i != free_selection_rects.end(); ++i) {
 177  delete (*i)->rect;
 178                 delete (*i)->start_trim;
 179                 delete (*i)->end_trim;
 180
 181         }
 182
 183         for (list<SelectionRect*>::iterator i = used_selection_rects.begin(); i != used_selection_rects.end(); ++i) {
 184                 delete (*i)->rect;
 185                 delete (*i)->start_trim;
 186                 delete (*i)->end_trim;
 187         }
 188
 189         delete selection_group;
 190         selection_group = 0;
 191
 192         delete _canvas_background;
 193         _canvas_background = 0;
 194
 195         delete _canvas_display;
 196         _canvas_display = 0;
 197
 198         delete display_menu;
 199         display_menu = 0;
 200
 201         delete _size_menu;
 202 }
 203
 204 void
 205 TimeAxisView::hide ()
 206 {
 207         if (_hidden) {
 208                 return;
 209         }
 210
 211         _canvas_display->hide ();
 212         _canvas_background->hide ();
 213
 214         if (control_parent) {
 215                 control_parent->remove (time_axis_vbox);
 216                 control_parent = 0;
 217         }
 218
 219         _y_position = -1;
 220         _hidden = true;
 221
 222         /* now hide children */
 223
 224         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 225                 (*i)->hide ();
 226         }
 227
 228         /* if its hidden, it cannot be selected */
 229         _editor.get_selection().remove (this);
 230         /* and neither can its regions */
 231         _editor.get_selection().remove_regions (this);
 232
 233         Hiding ();
 234 }
 235
 236 /** Display this TimeAxisView as the nth component of the parent box, at y.
 237 *
 238 * @param y y position.
 239 * @param nth index for this TimeAxisView, increased if this view has children.
 240 * @param parent parent component.
 241 * @return height of this TimeAxisView.
 242 */
 243 guint32
 244 TimeAxisView::show_at (double y, int& nth, VBox *parent)
 245 {
 246         if (control_parent) {
 247                 control_parent->reorder_child (time_axis_vbox, nth);
 248         } else {
 249                 control_parent = parent;
 250                 parent->pack_start (time_axis_vbox, false, false);
 251                 parent->reorder_child (time_axis_vbox, nth);
 252         }
 253
 254         _order = nth;
 255
 256         if (_y_position != y) {
 257                 _canvas_display->set_y_position (y);
 258                 _canvas_background->set_y_position (y);
 259                 _y_position = y;
 260
 261         }
 262
 263         _canvas_background->raise_to_top ();
 264         _canvas_display->raise_to_top ();
 265
 266         _canvas_background->show ();
 267         _canvas_display->show ();
 268
 269         _hidden = false;
 270
 271         _effective_height = current_height ();
 272
 273         /* now show relevant children */
 274
 275         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 276                 if ((*i)->marked_for_display()) {
 277                         ++nth;
 278                         _effective_height += (*i)->show_at (y + _effective_height, nth, parent);
 279                 } else {
 280                         (*i)->hide ();
 281                 }
 282         }
 283
 284         return _effective_height;
 285 }
 286
 287 void
 288 TimeAxisView::clip_to_viewport ()
 289 {
 290         if (marked_for_display()) {
 291                 if (_y_position + _effective_height < _editor.get_trackview_group_vertical_offset () ||
 292                     _y_position > _editor.get_trackview_group_vertical_offset () + _canvas_display->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 (selection_group->visible ()) {
 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                 end_name_edit (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                 end_name_edit (RESPONSE_APPLY);
 577                 return true;
 578
 579         case GDK_Tab:
 580                 end_name_edit (RESPONSE_ACCEPT);
 581                 return true;
 582         default:
 583                 break;
 584         }
 585
 586         return false;
 587 }
 588
 589 bool
 590 TimeAxisView::name_entry_focus_out (GdkEventFocus*)
 591 {
 592         end_name_edit (RESPONSE_OK);
 593         return false;
 594 }
 595
 596 void
 597 TimeAxisView::begin_name_edit ()
 598 {
 599         if (name_entry) {
 600                 return;
 601         }
 602
 603         if (can_edit_name()) {
 604
 605                 name_entry = manage (new Gtkmm2ext::FocusEntry);
 606
 607                 name_entry->set_name ("EditorTrackNameDisplay");
 608                 name_entry->signal_key_press_event().connect (sigc::mem_fun (*this, &TimeAxisView::name_entry_key_press), false);
 609                 name_entry->signal_key_release_event().connect (sigc::mem_fun (*this, &TimeAxisView::name_entry_key_release), false);
 610                 name_entry->signal_focus_out_event().connect (sigc::mem_fun (*this, &TimeAxisView::name_entry_focus_out));
 611                 name_entry->set_text (name_label.get_text());
 612                 name_entry->signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &TimeAxisView::end_name_edit), RESPONSE_OK));
 613
 614                 if (name_label.is_ancestor (name_hbox)) {
 615                         name_hbox.remove (name_label);
 616                 }
 617
 618                 name_hbox.pack_start (*name_entry);
 619                 name_entry->show ();
 620
 621                 name_entry->select_region (0, -1);
 622                 name_entry->set_state (STATE_SELECTED);
 623                 name_entry->grab_focus ();
 624                 name_entry->start_editing (0);
 625         }
 626 }
 627
 628 void
 629 TimeAxisView::end_name_edit (int response)
 630 {
 631         if (!name_entry) {
 632                 return;
 633         }
 634
 635         bool edit_next = false;
 636         bool edit_prev = false;
 637
 638         switch (response) {
 639         case RESPONSE_CANCEL:
 640                 break;
 641         case RESPONSE_OK:
 642                 name_entry_changed ();
 643                 break;
 644         case RESPONSE_ACCEPT:
 645                 name_entry_changed ();
 646                 edit_next = true;
 647         case RESPONSE_APPLY:
 648                 name_entry_changed ();
 649                 edit_prev = true;
 650         }
 651
 652         /* this will delete the name_entry. but it will also drop focus, which
 653          * will cause another callback to this function, so set name_entry = 0
 654          * first to ensure we don't double-remove etc. etc.
 655          */
 656
 657         Gtk::Entry* tmp = name_entry;
 658         name_entry = 0;
 659         name_hbox.remove (*tmp);
 660
 661         /* put the name label back */
 662
 663         name_hbox.pack_start (name_label);
 664         name_label.show ();
 665
 666         if (edit_next) {
 667
 668                 TrackViewList const & allviews = _editor.get_track_views ();
 669                 TrackViewList::const_iterator i = find (allviews.begin(), allviews.end(), this);
 670
 671                 if (i != allviews.end()) {
 672
 673                         do {
 674                                 if (++i == allviews.end()) {
 675                                         return;
 676                                 }
 677
 678                                 RouteTimeAxisView* rtav = dynamic_cast<RouteTimeAxisView*>(*i);
 679
 680                                 if (rtav && rtav->route()->record_enabled()) {
 681                                         continue;
 682                                 }
 683
 684                                 if (!(*i)->hidden()) {
 685                                         break;
 686                                 }
 687
 688                         } while (true);
 689                 }
 690
 691                 if ((i != allviews.end()) && (*i != this) && !(*i)->hidden()) {
 692                         _editor.ensure_time_axis_view_is_visible (**i);
 693                         (*i)->begin_name_edit ();
 694                 }
 695
 696         } else if (edit_prev) {
 697
 698                 TrackViewList const & allviews = _editor.get_track_views ();
 699                 TrackViewList::const_iterator i = find (allviews.begin(), allviews.end(), this);
 700
 701                 if (i != allviews.begin()) {
 702                         do {
 703                                 if (i == allviews.begin()) {
 704                                         return;
 705                                 }
 706
 707                                 --i;
 708
 709                                 RouteTimeAxisView* rtav = dynamic_cast<RouteTimeAxisView*>(*i);
 710
 711                                 if (rtav && rtav->route()->record_enabled()) {
 712                                         continue;
 713                                 }
 714
 715                                 if (!(*i)->hidden()) {
 716                                         break;
 717                                 }
 718
 719                         } while (true);
 720                 }
 721
 722                 if ((i != allviews.end()) && (*i != this) && !(*i)->hidden()) {
 723                         _editor.ensure_time_axis_view_is_visible (**i);
 724                         (*i)->begin_name_edit ();
 725                 }
 726         }
 727 }
 728
 729 void
 730 TimeAxisView::name_entry_changed ()
 731 {
 732 }
 733
 734 bool
 735 TimeAxisView::can_edit_name () const
 736 {
 737         return true;
 738 }
 739
 740 void
 741 TimeAxisView::conditionally_add_to_selection ()
 742 {
 743         Selection& s (_editor.get_selection ());
 744
 745         if (!s.selected (this)) {
 746                 _editor.set_selected_track (*this, Selection::Set);
 747         }
 748 }
 749
 750 void
 751 TimeAxisView::popup_display_menu (guint32 when)
 752 {
 753         conditionally_add_to_selection ();
 754
 755         build_display_menu ();
 756         display_menu->popup (1, when);
 757 }
 758
 759 void
 760 TimeAxisView::set_selected (bool yn)
 761 {
 762         if (yn == _selected) {
 763                 return;
 764         }
 765
 766         Selectable::set_selected (yn);
 767
 768         if (_selected) {
 769                 controls_ebox.set_name (controls_base_selected_name);
 770                 time_axis_vbox.set_name (controls_base_selected_name);
 771                 controls_vbox.set_name (controls_base_selected_name);
 772         } else {
 773                 controls_ebox.set_name (controls_base_unselected_name);
 774                 time_axis_vbox.set_name (controls_base_unselected_name);
 775                 controls_vbox.set_name (controls_base_unselected_name);
 776                 hide_selection ();
 777
 778                 /* children will be set for the yn=true case. but when deselecting
 779                    the editor only has a list of top-level trackviews, so we
 780                    have to do this here.
 781                 */
 782
 783                 for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 784                         (*i)->set_selected (false);
 785                 }
 786         }
 787 }
 788
 789 void
 790 TimeAxisView::build_display_menu ()
 791 {
 792         using namespace Menu_Helpers;
 793
 794         delete display_menu;
 795
 796         display_menu = new Menu;
 797         display_menu->set_name ("ArdourContextMenu");
 798
 799         // Just let implementing classes define what goes into the manu
 800 }
 801
 802 void
 803 TimeAxisView::set_frames_per_pixel (double fpp)
 804 {
 805         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 806                 (*i)->set_frames_per_pixel (fpp);
 807         }
 808
 809         AnalysisFeatureList::const_iterator i;
 810         list<ArdourCanvas::Line*>::iterator l;
 811 }
 812
 813 void
 814 TimeAxisView::show_timestretch (framepos_t start, framepos_t end, int layers, int layer)
 815 {
 816         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 817                 (*i)->show_timestretch (start, end, layers, layer);
 818         }
 819 }
 820
 821 void
 822 TimeAxisView::hide_timestretch ()
 823 {
 824         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 825                 (*i)->hide_timestretch ();
 826         }
 827 }
 828
 829 void
 830 TimeAxisView::show_selection (TimeSelection& ts)
 831 {
 832         double x1;
 833         double x2;
 834         double y2;
 835         SelectionRect *rect;
 836
 837         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 838                 (*i)->show_selection (ts);
 839         }
 840
 841         if (selection_group->visible ()) {
 842                 while (!used_selection_rects.empty()) {
 843                         free_selection_rects.push_front (used_selection_rects.front());
 844                         used_selection_rects.pop_front();
 845                         free_selection_rects.front()->rect->hide();
 846                         free_selection_rects.front()->start_trim->hide();
 847                         free_selection_rects.front()->end_trim->hide();
 848                 }
 849                 selection_group->hide();
 850         }
 851
 852         selection_group->show();
 853         selection_group->raise_to_top();
 854
 855         for (list<AudioRange>::iterator i = ts.begin(); i != ts.end(); ++i) {
 856                 framepos_t start, end;
 857                 framecnt_t cnt;
 858
 859                 start = (*i).start;
 860                 end = (*i).end;
 861                 cnt = end - start + 1;
 862
 863                 rect = get_selection_rect ((*i).id);
 864
 865                 x1 = _editor.frame_to_unit (start);
 866                 x2 = _editor.frame_to_unit (start + cnt - 1);
 867                 y2 = current_height();
 868
 869                 rect->rect->set (ArdourCanvas::Rect (x1, 1, x2, y2));
 870
 871                 // trim boxes are at the top for selections
 872
 873                 if (x2 > x1) {
 874                         rect->start_trim->set (ArdourCanvas::Rect (x1, 1, x1 + trim_handle_size, y2));
 875                         rect->end_trim->set (ArdourCanvas::Rect (x2 - trim_handle_size, 1, x2, y2));
 876
 877                         rect->start_trim->show();
 878                         rect->end_trim->show();
 879                 } else {
 880                         rect->start_trim->hide();
 881                         rect->end_trim->hide();
 882                 }
 883
 884                 rect->rect->show ();
 885                 used_selection_rects.push_back (rect);
 886         }
 887 }
 888
 889 void
 890 TimeAxisView::reshow_selection (TimeSelection& ts)
 891 {
 892         show_selection (ts);
 893
 894         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 895                 (*i)->show_selection (ts);
 896         }
 897 }
 898
 899 void
 900 TimeAxisView::hide_selection ()
 901 {
 902         if (selection_group->visible ()) {
 903                 while (!used_selection_rects.empty()) {
 904                         free_selection_rects.push_front (used_selection_rects.front());
 905                         used_selection_rects.pop_front();
 906                         free_selection_rects.front()->rect->hide();
 907                         free_selection_rects.front()->start_trim->hide();
 908                         free_selection_rects.front()->end_trim->hide();
 909                 }
 910                 selection_group->hide();
 911         }
 912
 913         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
 914                 (*i)->hide_selection ();
 915         }
 916 }
 917
 918 void
 919 TimeAxisView::order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top)
 920 {
 921         /* find the selection rect this is for. we have the item corresponding to one
 922            of the trim handles.
 923          */
 924
 925         for (list<SelectionRect*>::iterator i = used_selection_rects.begin(); i != used_selection_rects.end(); ++i) {
 926                 if ((*i)->start_trim == item || (*i)->end_trim == item) {
 927
 928                         /* make one trim handle be "above" the other so that if they overlap,
 929                            the top one is the one last used.
 930                         */
 931
 932                         (*i)->rect->raise_to_top ();
 933                         (put_start_on_top ? (*i)->start_trim : (*i)->end_trim)->raise_to_top ();
 934                         (put_start_on_top ? (*i)->end_trim : (*i)->start_trim)->raise_to_top ();
 935
 936                         break;
 937                 }
 938         }
 939 }
 940
 941 SelectionRect *
 942 TimeAxisView::get_selection_rect (uint32_t id)
 943 {
 944         SelectionRect *rect;
 945
 946         /* check to see if we already have a visible rect for this particular selection ID */
 947
 948         for (list<SelectionRect*>::iterator i = used_selection_rects.begin(); i != used_selection_rects.end(); ++i) {
 949                 if ((*i)->id == id) {
 950                         return (*i);
 951                 }
 952         }
 953
 954         /* ditto for the free rect list */
 955
 956         for (list<SelectionRect*>::iterator i = free_selection_rects.begin(); i != free_selection_rects.end(); ++i) {
 957                 if ((*i)->id == id) {
 958                         SelectionRect* ret = (*i);
 959                         free_selection_rects.erase (i);
 960                         return ret;
 961                 }
 962         }
 963
 964         /* no existing matching rect, so go get a new one from the free list, or create one if there are none */
 965
 966         if (free_selection_rects.empty()) {
 967
 968                 rect = new SelectionRect;
 969
 970                 rect->rect = new ArdourCanvas::Rectangle (selection_group);
 971                 rect->rect->set_outline_what (0);
 972                 rect->rect->set_fill_color (ARDOUR_UI::config()->canvasvar_SelectionRect.get());
 973
 974                 rect->start_trim = new ArdourCanvas::Rectangle (selection_group);
 975                 rect->start_trim->set_outline_what (0);
 976
 977                 rect->end_trim = new ArdourCanvas::Rectangle (selection_group);
 978                 rect->end_trim->set_outline_what (0);
 979
 980                 free_selection_rects.push_front (rect);
 981
 982                 rect->rect->Event.connect (sigc::bind (sigc::mem_fun (_editor, &PublicEditor::canvas_selection_rect_event), rect->rect, rect));
 983                 rect->start_trim->Event.connect (sigc::bind (sigc::mem_fun (_editor, &PublicEditor::canvas_selection_start_trim_event), rect->rect, rect));
 984                 rect->end_trim->Event.connect (sigc::bind (sigc::mem_fun (_editor, &PublicEditor::canvas_selection_end_trim_event), rect->rect, rect));
 985         }
 986
 987         rect = free_selection_rects.front();
 988         rect->id = id;
 989         free_selection_rects.pop_front();
 990         return rect;
 991 }
 992
 993 struct null_deleter { void operator()(void const *) const {} };
 994
 995 bool
 996 TimeAxisView::is_child (TimeAxisView* tav)
 997 {
 998         return find (children.begin(), children.end(), boost::shared_ptr<TimeAxisView>(tav, null_deleter())) != children.end();
 999 }
1000
1001 void
1002 TimeAxisView::add_child (boost::shared_ptr<TimeAxisView> child)
1003 {
1004         children.push_back (child);
1005 }
1006
1007 void
1008 TimeAxisView::remove_child (boost::shared_ptr<TimeAxisView> child)
1009 {
1010         Children::iterator i;
1011
1012         if ((i = find (children.begin(), children.end(), child)) != children.end()) {
1013                 children.erase (i);
1014         }
1015 }
1016
1017 /** Get selectable things within a given range.
1018  *  @param start Start time in session frames.
1019  *  @param end End time in session frames.
1020  *  @param top Top y range, in trackview coordinates (ie 0 is the top of the track view)
1021  *  @param bot Bottom y range, in trackview coordinates (ie 0 is the top of the track view)
1022  *  @param result Filled in with selectable things.
1023  */
1024 void
1025 TimeAxisView::get_selectables (framepos_t /*start*/, framepos_t /*end*/, double /*top*/, double /*bot*/, list<Selectable*>& /*result*/)
1026 {
1027         return;
1028 }
1029
1030 void
1031 TimeAxisView::get_inverted_selectables (Selection& /*sel*/, list<Selectable*>& /*result*/)
1032 {
1033         return;
1034 }
1035
1036 void
1037 TimeAxisView::add_ghost (RegionView* rv)
1038 {
1039         GhostRegion* gr = rv->add_ghost (*this);
1040
1041         if (gr) {
1042                 ghosts.push_back(gr);
1043         }
1044 }
1045
1046 void
1047 TimeAxisView::remove_ghost (RegionView* rv)
1048 {
1049         rv->remove_ghost_in (*this);
1050 }
1051
1052 void
1053 TimeAxisView::erase_ghost (GhostRegion* gr)
1054 {
1055         if (in_destructor) {
1056                 return;
1057         }
1058
1059         for (list<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
1060                 if ((*i) == gr) {
1061                         ghosts.erase (i);
1062                         break;
1063                 }
1064         }
1065 }
1066
1067 bool
1068 TimeAxisView::touched (double top, double bot)
1069 {
1070         /* remember: this is X Window - coordinate space starts in upper left and moves down.
1071           y_position is the "origin" or "top" of the track.
1072         */
1073
1074         double mybot = _y_position + current_height();
1075
1076         return ((_y_position <= bot && _y_position >= top) ||
1077                 ((mybot <= bot) && (top < mybot)) ||
1078                 (mybot >= bot && _y_position < top));
1079 }
1080
1081 void
1082 TimeAxisView::set_parent (TimeAxisView& p)
1083 {
1084         parent = &p;
1085 }
1086
1087 void
1088 TimeAxisView::reset_height ()
1089 {
1090         set_height (height);
1091
1092         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
1093                 (*i)->set_height ((*i)->height);
1094         }
1095 }
1096
1097 void
1098 TimeAxisView::compute_heights ()
1099 {
1100         Gtk::Window window (Gtk::WINDOW_TOPLEVEL);
1101         Gtk::Table two_row_table (2, 8);
1102         Gtk::Table one_row_table (1, 8);
1103         Button* buttons[5];
1104         const int border_width = 2;
1105
1106         const int separator_height = 2;
1107         extra_height = (2 * border_width) + separator_height;
1108
1109         window.add (one_row_table);
1110
1111         one_row_table.set_border_width (border_width);
1112         one_row_table.set_row_spacings (0);
1113         one_row_table.set_col_spacings (0);
1114         one_row_table.set_homogeneous (true);
1115
1116         two_row_table.set_border_width (border_width);
1117         two_row_table.set_row_spacings (0);
1118         two_row_table.set_col_spacings (0);
1119         two_row_table.set_homogeneous (true);
1120
1121         for (int i = 0; i < 5; ++i) {
1122                 buttons[i] = manage (new Button (X_("f")));
1123                 buttons[i]->set_name ("TrackMuteButton");
1124         }
1125
1126         one_row_table.attach (*buttons[0], 6, 7, 0, 1, Gtk::FILL|Gtk::EXPAND, Gtk::FILL|Gtk::EXPAND, 0, 0);
1127
1128         one_row_table.show_all ();
1129         Gtk::Requisition req(one_row_table.size_request ());
1130
1131         // height required to show 1 row of buttons
1132         button_height = req.height;
1133 }
1134
1135 void
1136 TimeAxisView::color_handler ()
1137 {
1138         for (list<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); i++) {
1139                 (*i)->set_colors();
1140         }
1141
1142         for (list<SelectionRect*>::iterator i = used_selection_rects.begin(); i != used_selection_rects.end(); ++i) {
1143
1144                 (*i)->rect->set_fill_color (ARDOUR_UI::config()->canvasvar_SelectionRect.get());
1145                 (*i)->rect->set_outline_color (ARDOUR_UI::config()->canvasvar_Selection.get());
1146
1147                 (*i)->start_trim->set_fill_color (ARDOUR_UI::config()->canvasvar_Selection.get());
1148                 (*i)->start_trim->set_outline_color (ARDOUR_UI::config()->canvasvar_Selection.get());
1149
1150                 (*i)->end_trim->set_fill_color (ARDOUR_UI::config()->canvasvar_Selection.get());
1151                 (*i)->end_trim->set_outline_color (ARDOUR_UI::config()->canvasvar_Selection.get());
1152         }
1153
1154         for (list<SelectionRect*>::iterator i = free_selection_rects.begin(); i != free_selection_rects.end(); ++i) {
1155
1156                 (*i)->rect->set_fill_color (ARDOUR_UI::config()->canvasvar_SelectionRect.get());
1157                 (*i)->rect->set_outline_color (ARDOUR_UI::config()->canvasvar_Selection.get());
1158
1159                 (*i)->start_trim->set_fill_color (ARDOUR_UI::config()->canvasvar_Selection.get());
1160                 (*i)->start_trim->set_outline_color (ARDOUR_UI::config()->canvasvar_Selection.get());
1161
1162                 (*i)->end_trim->set_fill_color (ARDOUR_UI::config()->canvasvar_Selection.get());
1163                 (*i)->end_trim->set_outline_color (ARDOUR_UI::config()->canvasvar_Selection.get());
1164         }
1165 }
1166
1167 /** @return Pair: TimeAxisView, layer index.
1168  * TimeAxisView is non-0 if this object covers y, or one of its children does.
1169  * If the covering object is a child axis, then the child is returned.
1170  * TimeAxisView is 0 otherwise.
1171  * Layer index is the layer number (possibly fractional) if the TimeAxisView is valid
1172  * and is in stacked or expanded * region display mode, otherwise 0.
1173  */
1174 std::pair<TimeAxisView*, double>
1175 TimeAxisView::covers_y_position (double y)
1176 {
1177         if (hidden()) {
1178                 return std::make_pair ((TimeAxisView *) 0, 0);
1179         }
1180
1181         if (_y_position <= y && y < (_y_position + height)) {
1182
1183                 /* work out the layer index if appropriate */
1184                 double l = 0;
1185                 switch (layer_display ()) {
1186                 case Overlaid:
1187                         break;
1188                 case Stacked:
1189                         if (view ()) {
1190                                 /* compute layer */
1191                                 l = layer_t ((_y_position + height - y) / (view()->child_height ()));
1192                                 /* clamp to max layers to be on the safe side; sometimes the above calculation
1193                                    returns a too-high value */
1194                                 if (l >= view()->layers ()) {
1195                                         l = view()->layers() - 1;
1196                                 }
1197                         }
1198                         break;
1199                 case Expanded:
1200                         if (view ()) {
1201                                 int const n = floor ((_y_position + height - y) / (view()->child_height ()));
1202                                 l = n * 0.5 - 0.5;
1203                                 if (l >= (view()->layers() - 0.5)) {
1204                                         l = view()->layers() - 0.5;
1205                                 }
1206                         }
1207                         break;
1208                 }
1209
1210                 return std::make_pair (this, l);
1211         }
1212
1213         for (Children::const_iterator i = children.begin(); i != children.end(); ++i) {
1214
1215                 std::pair<TimeAxisView*, int> const r = (*i)->covers_y_position (y);
1216                 if (r.first) {
1217                         return r;
1218                 }
1219         }
1220
1221         return std::make_pair ((TimeAxisView *) 0, 0);
1222 }
1223
1224
1225 uint32_t
1226 TimeAxisView::preset_height (Height h)
1227 {
1228         switch (h) {
1229         case HeightLargest:
1230                 return (button_height * 2) + extra_height + 260;
1231         case HeightLarger:
1232                 return (button_height * 2) + extra_height + 160;
1233         case HeightLarge:
1234                 return (button_height * 2) + extra_height + 60;
1235         case HeightNormal:
1236                 return (button_height * 2) + extra_height + 10;
1237         case HeightSmall:
1238                 return button_height + extra_height;
1239         }
1240
1241         /* NOTREACHED */
1242         return 0;
1243 }
1244
1245 /** @return Child time axis views that are not hidden */
1246 TimeAxisView::Children
1247 TimeAxisView::get_child_list ()
1248 {
1249         Children c;
1250
1251         for (Children::iterator i = children.begin(); i != children.end(); ++i) {
1252                 if (!(*i)->hidden()) {
1253                         c.push_back(*i);
1254                 }
1255         }
1256
1257         return c;
1258 }
1259
1260 void
1261 TimeAxisView::build_size_menu ()
1262 {
1263         if (_size_menu && _size_menu->gobj ()) {
1264                 return;
1265         }
1266
1267         delete _size_menu;
1268
1269         using namespace Menu_Helpers;
1270
1271         _size_menu = new Menu;
1272         _size_menu->set_name ("ArdourContextMenu");
1273         MenuList& items = _size_menu->items();
1274
1275         items.push_back (MenuElem (_("Largest"), sigc::bind (sigc::mem_fun (*this, &TimeAxisView::set_height_enum), HeightLargest, true)));
1276         items.push_back (MenuElem (_("Larger"),  sigc::bind (sigc::mem_fun (*this, &TimeAxisView::set_height_enum), HeightLarger, true)));
1277         items.push_back (MenuElem (_("Large"),   sigc::bind (sigc::mem_fun (*this, &TimeAxisView::set_height_enum), HeightLarge, true)));
1278         items.push_back (MenuElem (_("Normal"),  sigc::bind (sigc::mem_fun (*this, &TimeAxisView::set_height_enum), HeightNormal, true)));
1279         items.push_back (MenuElem (_("Small"),   sigc::bind (sigc::mem_fun (*this, &TimeAxisView::set_height_enum), HeightSmall, true)));
1280 }
1281
1282 void
1283 TimeAxisView::reset_visual_state ()
1284 {
1285         /* this method is not required to trigger a global redraw */
1286
1287         string str = gui_property ("height");
1288
1289         if (!str.empty()) {
1290                 set_height (atoi (str));
1291         } else {
1292                 set_height (preset_height (HeightNormal));
1293         }
1294 }
1295
1296 TrackViewList
1297 TrackViewList::filter_to_unique_playlists ()
1298 {
1299         std::set<boost::shared_ptr<ARDOUR::Playlist> > playlists;
1300         TrackViewList ts;
1301
1302         for (iterator i = begin(); i != end(); ++i) {
1303                 RouteTimeAxisView* rtav = dynamic_cast<RouteTimeAxisView*> (*i);
1304                 if (!rtav) {
1305                         /* not a route: include it anyway */
1306                         ts.push_back (*i);
1307                 } else {
1308                         boost::shared_ptr<ARDOUR::Track> t = rtav->track();
1309                         if (t) {
1310                                 if (playlists.insert (t->playlist()).second) {
1311                                         /* playlist not seen yet */
1312                                         ts.push_back (*i);
1313                                 }
1314                         } else {
1315                                 /* not a track: include it anyway */
1316                                 ts.push_back (*i);
1317                         }
1318                 }
1319         }
1320         return ts;
1321 }