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