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