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