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