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