Fix display of MIDI notes/regions while recording.
[ardour.git] / gtk2_ardour / streamview.cc
1 /*
2     Copyright (C) 2001, 2006 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 #include <cmath>
20
21 #include <gtkmm.h>
22
23 #include <gtkmm2ext/gtk_ui.h>
24 #include <gtkmm2ext/utils.h>
25
26 #include "ardour/playlist.h"
27 #include "ardour/region.h"
28 #include "ardour/track.h"
29 #include "ardour/session.h"
30
31 #include "pbd/compose.h"
32
33 #include "canvas/rectangle.h"
34 #include "canvas/debug.h"
35
36 #include "streamview.h"
37 #include "global_signals.h"
38 #include "region_view.h"
39 #include "route_time_axis.h"
40 #include "region_selection.h"
41 #include "selection.h"
42 #include "public_editor.h"
43 #include "ardour_ui.h"
44 #include "rgb_macros.h"
45 #include "gui_thread.h"
46 #include "utils.h"
47
48 #include "i18n.h"
49
50 using namespace std;
51 using namespace ARDOUR;
52 using namespace ARDOUR_UI_UTILS;
53 using namespace PBD;
54 using namespace Editing;
55
56 StreamView::StreamView (RouteTimeAxisView& tv, ArdourCanvas::Container* canvas_group)
57         : _trackview (tv)
58         , _canvas_group (canvas_group ? canvas_group : new ArdourCanvas::Container (_trackview.canvas_display()))
59         , _samples_per_pixel (_trackview.editor().get_current_zoom ())
60         , rec_updating(false)
61         , rec_active(false)
62         , stream_base_color(0xFFFFFFFF)
63         , _layers (1)
64         , _layer_display (Overlaid)
65         , height (tv.height)
66         , last_rec_data_frame(0)
67 {
68         CANVAS_DEBUG_NAME (_canvas_group, string_compose ("SV canvas group %1", _trackview.name()));
69         
70         /* set_position() will position the group */
71
72         canvas_rect = new ArdourCanvas::Rectangle (_canvas_group);
73         CANVAS_DEBUG_NAME (canvas_rect, string_compose ("SV canvas rectangle %1", _trackview.name()));
74         canvas_rect->set (ArdourCanvas::Rect (0, 0, ArdourCanvas::COORD_MAX, tv.current_height ()));
75         canvas_rect->set_outline (false);
76         canvas_rect->set_fill (true);
77         canvas_rect->Event.connect (sigc::bind (sigc::mem_fun (_trackview.editor(), &PublicEditor::canvas_stream_view_event), canvas_rect, &_trackview));
78
79         if (_trackview.is_track()) {
80                 _trackview.track()->DiskstreamChanged.connect (*this, invalidator (*this), boost::bind (&StreamView::diskstream_changed, this), gui_context());
81                 _trackview.track()->RecordEnableChanged.connect (*this, invalidator (*this), boost::bind (&StreamView::rec_enable_changed, this), gui_context());
82
83                 _trackview.session()->TransportStateChange.connect (*this, invalidator (*this), boost::bind (&StreamView::transport_changed, this), gui_context());
84                 _trackview.session()->TransportLooped.connect (*this, invalidator (*this), boost::bind (&StreamView::transport_looped, this), gui_context());
85                 _trackview.session()->RecordStateChanged.connect (*this, invalidator (*this), boost::bind (&StreamView::sess_rec_enable_changed, this), gui_context());
86         }
87
88         ColorsChanged.connect (sigc::mem_fun (*this, &StreamView::color_handler));
89 }
90
91 StreamView::~StreamView ()
92 {
93         undisplay_track ();
94
95         delete canvas_rect;
96 }
97
98 void
99 StreamView::attach ()
100 {
101         if (_trackview.is_track()) {
102                 display_track (_trackview.track ());
103         }
104 }
105
106 int
107 StreamView::set_position (gdouble x, gdouble y)
108 {
109         _canvas_group->set_position (ArdourCanvas::Duple (x, y));
110         return 0;
111 }
112
113 int
114 StreamView::set_height (double h)
115 {
116         /* limit the values to something sane-ish */
117
118         if (h < 10.0 || h > 1000.0) {
119                 return -1;
120         }
121
122         if (canvas_rect->y1() == h) {
123                 return 0;
124         }
125
126         height = h;
127         canvas_rect->set_y1 (height);
128         update_contents_height ();
129
130         return 0;
131 }
132
133 int
134 StreamView::set_samples_per_pixel (double fpp)
135 {
136         RegionViewList::iterator i;
137
138         if (fpp < 1.0) {
139                 return -1;
140         }
141
142         _samples_per_pixel = fpp;
143
144         for (i = region_views.begin(); i != region_views.end(); ++i) {
145                 (*i)->set_samples_per_pixel (fpp);
146         }
147
148         for (vector<RecBoxInfo>::iterator xi = rec_rects.begin(); xi != rec_rects.end(); ++xi) {
149                 RecBoxInfo &recbox = (*xi);
150
151                 ArdourCanvas::Coord const xstart = _trackview.editor().sample_to_pixel (recbox.start);
152                 ArdourCanvas::Coord const xend = _trackview.editor().sample_to_pixel (recbox.start + recbox.length);
153
154                 recbox.rectangle->set_x0 (xstart);
155                 recbox.rectangle->set_x1 (xend);
156         }
157
158         update_coverage_frames ();
159
160         return 0;
161 }
162
163 void
164 StreamView::add_region_view (boost::weak_ptr<Region> wr)
165 {
166         boost::shared_ptr<Region> r (wr.lock());
167         if (!r) {
168                 return;
169         }
170
171         add_region_view_internal (r, true);
172
173         if (_layer_display == Stacked || _layer_display == Expanded) {
174                 update_contents_height ();
175         }
176 }
177
178 void
179 StreamView::remove_region_view (boost::weak_ptr<Region> weak_r)
180 {
181         ENSURE_GUI_THREAD (*this, &StreamView::remove_region_view, weak_r)
182
183         boost::shared_ptr<Region> r (weak_r.lock());
184
185         if (!r) {
186                 return;
187         }
188
189         for (list<RegionView *>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
190                 if (((*i)->region()) == r) {
191                         RegionView* rv = *i;
192                         region_views.erase (i);
193                         delete rv;
194                         break;
195                 }
196         }
197
198         RegionViewRemoved (); /* EMIT SIGNAL */
199 }
200
201 void
202 StreamView::undisplay_track ()
203 {
204         for (RegionViewList::iterator i = region_views.begin(); i != region_views.end() ; ) {
205                 RegionViewList::iterator next = i;
206                 ++next;
207                 delete *i;
208                 i = next;
209         }
210
211         region_views.clear();
212 }
213
214 void
215 StreamView::display_track (boost::shared_ptr<Track> tr)
216 {
217         playlist_switched_connection.disconnect();
218         playlist_switched (tr);
219         tr->PlaylistChanged.connect (playlist_switched_connection, invalidator (*this), boost::bind (&StreamView::playlist_switched, this, boost::weak_ptr<Track> (tr)), gui_context());
220 }
221
222 void
223 StreamView::layer_regions()
224 {
225         // In one traversal of the region view list:
226         // - Build a list of region views sorted by layer
227         // - Remove invalid views from the actual region view list
228         RegionViewList copy;
229         list<RegionView*>::iterator i, tmp;
230         for (i = region_views.begin(); i != region_views.end(); ) {
231                 tmp = i;
232                 tmp++;
233
234                 if (!(*i)->is_valid()) {
235                         delete *i;
236                         region_views.erase (i);
237                         i = tmp;
238                         continue;
239                 } else {
240                         (*i)->enable_display(true);
241                 }
242
243                 if (copy.size() == 0) {
244                         copy.push_front((*i));
245                         i = tmp;
246                         continue;
247                 }
248
249                 RegionViewList::iterator k = copy.begin();
250                 RegionViewList::iterator l = copy.end();
251                 l--;
252
253                 if ((*i)->region()->layer() <= (*k)->region()->layer()) {
254                         copy.push_front((*i));
255                         i = tmp;
256                         continue;
257                 } else if ((*i)->region()->layer() >= (*l)->region()->layer()) {
258                         copy.push_back((*i));
259                         i = tmp;
260                         continue;
261                 }
262
263                 for (RegionViewList::iterator j = copy.begin(); j != copy.end(); ++j) {
264                         if ((*j)->region()->layer() >= (*i)->region()->layer()) {
265                                 copy.insert(j, (*i));
266                                 break;
267                         }
268                 }
269
270                 i = tmp;
271         }
272
273         // Fix canvas layering by raising each to the top in the sorted order.
274         for (RegionViewList::iterator i = copy.begin(); i != copy.end(); ++i) {
275                 (*i)->get_canvas_group()->raise_to_top ();
276         }
277 }
278
279 void
280 StreamView::playlist_layered (boost::weak_ptr<Track> wtr)
281 {
282         boost::shared_ptr<Track> tr (wtr.lock());
283
284         if (!tr) {
285                 return;
286         }
287
288         /* update layers count and the y positions and heights of our regions */
289         if (tr->playlist()) {
290                 _layers = tr->playlist()->top_layer() + 1;
291         }
292
293         if (_layer_display == Stacked) {
294                 update_contents_height ();
295                 update_coverage_frames ();
296         } else {
297                 /* layering has probably been modified. reflect this in the canvas. */
298                 layer_regions();
299         }
300 }
301
302 void
303 StreamView::playlist_switched (boost::weak_ptr<Track> wtr)
304 {
305         boost::shared_ptr<Track> tr (wtr.lock());
306
307         if (!tr) {
308                 return;
309         }
310
311         /* disconnect from old playlist */
312
313         playlist_connections.drop_connections ();
314         undisplay_track ();
315
316         /* draw it */
317
318         redisplay_track ();
319
320         /* update layers count and the y positions and heights of our regions */
321         _layers = tr->playlist()->top_layer() + 1;
322         update_contents_height ();
323         update_coverage_frames ();
324
325         /* catch changes */
326
327         tr->playlist()->LayeringChanged.connect (playlist_connections, invalidator (*this), boost::bind (&StreamView::playlist_layered, this, boost::weak_ptr<Track> (tr)), gui_context());
328         tr->playlist()->RegionAdded.connect (playlist_connections, invalidator (*this), boost::bind (&StreamView::add_region_view, this, _1), gui_context());
329         tr->playlist()->RegionRemoved.connect (playlist_connections, invalidator (*this), boost::bind (&StreamView::remove_region_view, this, _1), gui_context());
330         tr->playlist()->ContentsChanged.connect (playlist_connections, invalidator (*this), boost::bind (&StreamView::update_coverage_frames, this), gui_context());
331 }
332
333
334 void
335 StreamView::diskstream_changed ()
336 {
337         boost::shared_ptr<Track> t;
338
339         if ((t = _trackview.track()) != 0) {
340                 Gtkmm2ext::UI::instance()->call_slot (invalidator (*this), boost::bind (&StreamView::display_track, this, t));
341         } else {
342                 Gtkmm2ext::UI::instance()->call_slot (invalidator (*this), boost::bind (&StreamView::undisplay_track, this));
343         }
344 }
345
346 void
347 StreamView::apply_color (Gdk::Color const& c, ColorTarget target)
348 {
349         return apply_color (gdk_color_to_rgba (c), target);
350 }
351
352 void
353 StreamView::apply_color (uint32_t color, ColorTarget target)
354 {
355         list<RegionView *>::iterator i;
356
357         switch (target) {
358         case RegionColor:
359                 region_color = color;
360                 for (i = region_views.begin(); i != region_views.end(); ++i) {
361                         (*i)->set_color (region_color);
362                 }
363                 break;
364
365         case StreamBaseColor:
366                 stream_base_color = color;
367                 canvas_rect->set_fill_color (stream_base_color);
368                 break;
369         }
370 }
371
372 void
373 StreamView::region_layered (RegionView* rv)
374 {
375         /* don't ever leave it at the bottom, since then it doesn't
376            get events - the  parent group does instead ...
377         */
378         rv->get_canvas_group()->raise (rv->region()->layer());
379 }
380
381 void
382 StreamView::rec_enable_changed ()
383 {
384         setup_rec_box ();
385 }
386
387 void
388 StreamView::sess_rec_enable_changed ()
389 {
390         setup_rec_box ();
391 }
392
393 void
394 StreamView::transport_changed()
395 {
396         setup_rec_box ();
397 }
398
399 void
400 StreamView::transport_looped()
401 {
402         // to force a new rec region
403         rec_active = false;
404         Gtkmm2ext::UI::instance()->call_slot (invalidator (*this), boost::bind (&StreamView::setup_rec_box, this));
405 }
406
407 void
408 StreamView::create_rec_box(framepos_t frame_pos, double width)
409 {
410         const double   xstart     = _trackview.editor().sample_to_pixel(frame_pos);
411         const double   xend       = xstart + width;
412         const uint32_t fill_color = ARDOUR_UI::config()->color_mod("recording rect", "recording_rect");
413
414         ArdourCanvas::Rectangle* rec_rect = new ArdourCanvas::TimeRectangle(_canvas_group);
415         rec_rect->set_x0(xstart);
416         rec_rect->set_y0(0);
417         rec_rect->set_x1(xend);
418         rec_rect->set_y1(child_height ());
419         rec_rect->set_outline_what(ArdourCanvas::Rectangle::What(0));
420         rec_rect->set_outline_color(ARDOUR_UI::config()->color("recording rect"));
421         rec_rect->set_fill_color(fill_color);
422         rec_rect->lower_to_bottom();
423
424         RecBoxInfo recbox;
425         recbox.rectangle = rec_rect;
426         recbox.length    = 0;
427
428         if (rec_rects.empty()) {
429                 recbox.start = _trackview.session()->record_location ();
430         } else {
431                 recbox.start = _trackview.session()->transport_frame ();
432         }
433
434         rec_rects.push_back (recbox);
435
436         screen_update_connection.disconnect();
437         screen_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect(
438                 sigc::mem_fun(*this, &StreamView::update_rec_box));
439
440         rec_updating = true;
441         rec_active = true;
442 }
443
444 void
445 StreamView::update_rec_box ()
446 {
447         if (rec_active && rec_rects.size() > 0) {
448                 /* only update the last box */
449                 RecBoxInfo & rect = rec_rects.back();
450                 framepos_t const at = _trackview.track()->current_capture_end ();
451                 double xstart;
452                 double xend;
453
454                 switch (_trackview.track()->mode()) {
455
456                 case NonLayered:
457                 case Normal:
458                         rect.length = at - rect.start;
459                         xstart = _trackview.editor().sample_to_pixel (rect.start);
460                         xend = _trackview.editor().sample_to_pixel (at);
461                         break;
462
463                 case Destructive:
464                         rect.length = 2;
465                         xstart = _trackview.editor().sample_to_pixel (_trackview.track()->current_capture_start());
466                         xend = _trackview.editor().sample_to_pixel (at);
467                         break;
468
469                 default:
470                         fatal << string_compose (_("programming error: %1"), "illegal track mode") << endmsg;
471                         abort(); /*NOTREACHED*/
472                         return;
473                 }
474
475                 rect.rectangle->set_x0 (xstart);
476                 rect.rectangle->set_x1 (xend);
477         }
478 }
479
480 RegionView*
481 StreamView::find_view (boost::shared_ptr<const Region> region)
482 {
483         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
484
485                 if ((*i)->region() == region) {
486                         return *i;
487                 }
488         }
489         return 0;
490 }
491
492 uint32_t
493 StreamView::num_selected_regionviews () const
494 {
495         uint32_t cnt = 0;
496
497         for (list<RegionView*>::const_iterator i = region_views.begin(); i != region_views.end(); ++i) {
498                 if ((*i)->get_selected()) {
499                         ++cnt;
500                 }
501         }
502         return cnt;
503 }
504
505 void
506 StreamView::foreach_regionview (sigc::slot<void,RegionView*> slot)
507 {
508         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
509                 slot (*i);
510         }
511 }
512
513 void
514 StreamView::foreach_selected_regionview (sigc::slot<void,RegionView*> slot)
515 {
516         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
517                 if ((*i)->get_selected()) {
518                         slot (*i);
519                 }
520         }
521 }
522
523 void
524 StreamView::set_selected_regionviews (RegionSelection& regions)
525 {
526         bool selected;
527
528         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
529
530                 selected = false;
531
532                 for (RegionSelection::iterator ii = regions.begin(); ii != regions.end(); ++ii) {
533                         if (*i == *ii) {
534                                 selected = true;
535                                 break;
536                         }
537                 }
538
539                 (*i)->set_selected (selected);
540         }
541 }
542
543
544 /** Get selectable things within a given range.
545  *  @param start Start time in session frames.
546  *  @param end End time in session frames.
547  *  @param top Top y range, in trackview coordinates (ie 0 is the top of the track view)
548  *  @param bot Bottom y range, in trackview coordinates (ie 0 is the top of the track view)
549  *  @param result Filled in with selectable things.
550  */
551
552 void
553 StreamView::get_selectables (framepos_t start, framepos_t end, double top, double bottom, list<Selectable*>& results)
554 {
555         layer_t min_layer = 0;
556         layer_t max_layer = 0;
557
558         if (_layer_display == Stacked) {
559                 double const c = child_height ();
560
561                 int const mi = _layers - ((bottom - _trackview.y_position()) / c);
562                 if (mi < 0) {
563                         min_layer = 0;
564                 } else {
565                         min_layer = mi;
566                 }
567
568                 int const ma = _layers - ((top - _trackview.y_position()) / c);
569                 if (ma > (int) _layers) {
570                         max_layer = _layers - 1;
571                 } else {
572                         max_layer = ma;
573                 }
574
575         }
576
577         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
578
579                 bool layer_ok = true;
580
581                 if (_layer_display == Stacked) {
582                         layer_t const l = (*i)->region()->layer ();
583                         layer_ok = (min_layer <= l && l <= max_layer);
584                 }
585
586                 if ((*i)->region()->coverage (start, end) != Evoral::OverlapNone && layer_ok) {
587                         results.push_back (*i);
588                 }
589         }
590 }
591
592 void
593 StreamView::get_inverted_selectables (Selection& sel, list<Selectable*>& results)
594 {
595         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
596                 if (!sel.regions.contains (*i)) {
597                         results.push_back (*i);
598                 }
599         }
600 }
601
602 /** @return height of a child region view, depending on stacked / overlaid mode */
603 double
604 StreamView::child_height () const
605 {
606         switch (_layer_display) {
607         case Overlaid:
608                 return height;
609         case Stacked:
610                 return height / _layers;
611         case Expanded:
612                 return height / (_layers * 2 + 1);
613         }
614         
615         abort(); /* NOTREACHED */
616         return height;
617 }
618
619 void
620 StreamView::update_contents_height ()
621 {
622         const double h = child_height ();
623
624         for (RegionViewList::iterator i = region_views.begin(); i != region_views.end(); ++i) {
625                 switch (_layer_display) {
626                 case Overlaid:
627                         (*i)->set_y (0);
628                         break;
629                 case Stacked:
630                         (*i)->set_y (height - ((*i)->region()->layer() + 1) * h);
631                         break;
632                 case Expanded:
633                         (*i)->set_y (height - ((*i)->region()->layer() + 1) * 2 * h);
634                         break;
635                 }
636
637                 (*i)->set_height (h);
638         }
639
640         for (vector<RecBoxInfo>::iterator i = rec_rects.begin(); i != rec_rects.end(); ++i) {
641                 switch (_layer_display) {
642                 case Overlaid:
643                         i->rectangle->set_y1 (height);
644                         break;
645                 case Stacked:
646                 case Expanded:
647                         /* In stacked displays, the recregion is always at the top */
648                         i->rectangle->set_y0 (0);
649                         i->rectangle->set_y1 (h);
650                         break;
651                 }
652         }
653
654         ContentsHeightChanged (); /* EMIT SIGNAL */
655 }
656
657 void
658 StreamView::set_layer_display (LayerDisplay d)
659 {
660         _layer_display = d;
661
662         if (_layer_display == Overlaid) {
663                 layer_regions ();
664         }
665         
666         update_contents_height ();
667         update_coverage_frames ();
668 }
669
670 void
671 StreamView::update_coverage_frames ()
672 {
673         for (RegionViewList::iterator i = region_views.begin (); i != region_views.end (); ++i) {
674                 (*i)->update_coverage_frames (_layer_display);
675         }
676 }
677
678 void
679 StreamView::check_record_layers (boost::shared_ptr<Region> region, framepos_t to)
680 {
681         if (_new_rec_layer_time < to) {
682                 /* The region being recorded has overlapped the start of a top-layered region, so
683                    `fake' a new visual layer for the recording.  This is only a visual thing for now,
684                    as the proper layering will get sorted out when the recorded region is added to
685                    its playlist.
686                 */
687
688                 /* Stop this happening again */
689                 _new_rec_layer_time = max_framepos;
690
691                 /* Make space in the view for the new layer */
692                 ++_layers;
693
694                 /* Set the temporary region to the correct layer so that it gets drawn correctly */
695                 region->set_layer (_layers - 1);
696
697                 /* and reset the view */
698                 update_contents_height ();
699         }
700 }
701
702 void
703 StreamView::setup_new_rec_layer_time (boost::shared_ptr<Region> region)
704 {
705         /* If we are in Stacked mode, we may need to (visually) create a new layer to put the
706            recorded region in.  To work out where this needs to happen, find the start of the next
707            top-layered region after the start of the region we are recording and make a note of it.
708         */
709         if (_layer_display == Stacked) {
710                 _new_rec_layer_time = _trackview.track()->playlist()->find_next_top_layer_position (region->start());
711         } else {
712                 _new_rec_layer_time = max_framepos;
713         }
714 }
715
716 void
717 StreamView::enter_internal_edit_mode ()
718 {
719         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
720                 (*i)->hide_rect ();
721         }
722 }
723
724 void
725 StreamView::leave_internal_edit_mode ()
726 {
727         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
728                 (*i)->show_rect ();
729         }
730 }