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