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