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