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