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