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