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