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