gtk2_ardour/time_axis_view.cc

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