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