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