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