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