Heavy-duty abstraction work to split type-specific classes into
[ardour.git] / gtk2_ardour / audio_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 #include <cassert>
21
22 #include <gtkmm.h>
23
24 #include <gtkmm2ext/gtk_ui.h>
25
26 #include <ardour/audioplaylist.h>
27 #include <ardour/audioregion.h>
28 #include <ardour/audiosource.h>
29 #include <ardour/audio_diskstream.h>
30 #include <ardour/audio_track.h>
31 #include <ardour/playlist_templates.h>
32 #include <ardour/source.h>
33
34 #include "audio_streamview.h"
35 #include "audio_region_view.h"
36 #include "tape_region_view.h"
37 #include "audio_time_axis.h"
38 #include "canvas-waveview.h"
39 #include "canvas-simplerect.h"
40 #include "region_selection.h"
41 #include "selection.h"
42 #include "public_editor.h"
43 #include "ardour_ui.h"
44 #include "crossfade_view.h"
45 #include "rgb_macros.h"
46 #include "gui_thread.h"
47 #include "utils.h"
48 #include "color.h"
49
50 using namespace ARDOUR;
51 using namespace PBD;
52 using namespace Editing;
53
54 AudioStreamView::AudioStreamView (AudioTimeAxisView& tv)
55         : StreamView (tv)
56 {
57         crossfades_visible = true;
58
59         if (tv.is_audio_track())
60                 stream_base_color = color_map[cAudioTrackBase];
61         else
62                 stream_base_color = color_map[cAudioBusBase];
63
64         canvas_rect->property_outline_color_rgba() = color_map[cAudioTrackOutline];
65
66         _amplitude_above_axis = 1.0;
67
68         use_rec_regions = tv.editor.show_waveforms_recording ();
69         last_rec_peak_frame = 0;
70 }
71
72 AudioStreamView::~AudioStreamView ()
73 {
74 }
75
76 int
77 AudioStreamView::set_height (gdouble h)
78 {
79         /* limit the values to something sane-ish */
80         if (h < 10.0 || h > 1000.0) {
81                 return -1;
82         }
83
84         StreamView::set_height(h);
85
86         for (CrossfadeViewList::iterator i = crossfade_views.begin(); i != crossfade_views.end(); ++i) {
87                 (*i)->set_height (h);
88         }
89
90         return 0;
91 }
92
93 int 
94 AudioStreamView::set_samples_per_unit (gdouble spp)
95 {
96         StreamView::set_samples_per_unit(spp);
97
98         for (CrossfadeViewList::iterator xi = crossfade_views.begin(); xi != crossfade_views.end(); ++xi) {
99                 (*xi)->set_samples_per_unit (spp);
100         }
101
102         return 0;
103 }
104
105 int 
106 AudioStreamView::set_amplitude_above_axis (gdouble app)
107 {
108         RegionViewList::iterator i;
109
110         if (app < 1.0) {
111                 return -1;
112         }
113
114         _amplitude_above_axis = app;
115
116         for (i = region_views.begin(); i != region_views.end(); ++i) {
117                 AudioRegionView* const arv = dynamic_cast<AudioRegionView*>(*i);
118                 if (arv)
119                         arv->set_amplitude_above_axis (app);
120         }
121
122         return 0;
123 }
124
125 void
126 AudioStreamView::add_region_view_internal (Region *r, bool wait_for_waves)
127 {
128         ENSURE_GUI_THREAD (bind (mem_fun (*this, &AudioStreamView::add_region_view), r));
129
130         AudioRegion* region = dynamic_cast<AudioRegion*> (r);
131
132         if (region == 0) {
133                 return;
134         }
135
136         AudioRegionView *region_view;
137         list<RegionView *>::iterator i;
138
139         for (i = region_views.begin(); i != region_views.end(); ++i) {
140                 if (&(*i)->region() == r) {
141                         
142                         /* great. we already have a AudioRegionView for this Region. use it again. */
143
144                         (*i)->set_valid (true);
145                         return;
146                 }
147         }
148         
149         switch (_trackview.audio_track()->mode()) {
150         case Normal:
151                 region_view = new AudioRegionView (canvas_group, _trackview, *region, 
152                                                    _samples_per_unit, region_color);
153                 break;
154         case Destructive:
155                 region_view = new TapeAudioRegionView (canvas_group, _trackview, *region, 
156                                                        _samples_per_unit, region_color);
157                 break;
158         }
159
160         region_view->init (region_color, wait_for_waves);
161         region_view->set_amplitude_above_axis(_amplitude_above_axis);
162         region_views.push_front (region_view);
163         
164         /* follow global waveform setting */
165
166         region_view->set_waveform_visible(_trackview.editor.show_waveforms());
167
168         /* catch regionview going away */
169
170         region->GoingAway.connect (mem_fun (*this, &AudioStreamView::remove_region_view));
171         
172         RegionViewAdded (region_view);
173 }
174
175 void
176 AudioStreamView::remove_region_view (Region *r)
177 {
178         ENSURE_GUI_THREAD (bind (mem_fun (*this, &AudioStreamView::remove_region_view), r));
179
180         for (list<CrossfadeView *>::iterator i = crossfade_views.begin(); i != crossfade_views.end();) {
181                 list<CrossfadeView*>::iterator tmp;
182                 
183                 tmp = i;
184                 ++tmp;
185                 
186                 AudioRegion* ar = dynamic_cast<AudioRegion*>(r);
187                 if (ar && (*i)->crossfade.involves (*ar)) {
188                         delete *i;
189                         crossfade_views.erase (i);
190                 }
191                 
192                 i = tmp;
193         }
194
195         StreamView::remove_region_view(r);
196 }
197
198 void
199 AudioStreamView::undisplay_diskstream ()
200 {
201         StreamView::undisplay_diskstream();
202
203         for (CrossfadeViewList::iterator i = crossfade_views.begin(); i != crossfade_views.end(); ++i) {
204                 delete *i;
205         }
206
207         crossfade_views.clear ();
208 }
209
210 void
211 AudioStreamView::playlist_modified ()
212 {
213         ENSURE_GUI_THREAD (mem_fun (*this, &AudioStreamView::playlist_modified));
214
215         StreamView::playlist_modified();
216         
217         /* if the playlist is modified, make sure xfades are on top and all the regionviews are stacked 
218            correctly.
219         */
220
221         for (list<CrossfadeView *>::iterator i = crossfade_views.begin(); i != crossfade_views.end(); ++i) {
222                 (*i)->get_canvas_group()->raise_to_top();
223         }
224 }
225
226 void
227 AudioStreamView::playlist_changed (Diskstream *ds)
228 {
229         ENSURE_GUI_THREAD (bind (mem_fun (*this, &AudioStreamView::playlist_changed), ds));
230
231         StreamView::playlist_changed(ds);
232
233         AudioPlaylist* apl = dynamic_cast<AudioPlaylist*>(ds->playlist());
234         if (apl)
235                 playlist_connections.push_back (apl->NewCrossfade.connect (mem_fun (*this, &AudioStreamView::add_crossfade)));
236 }
237
238 void
239 AudioStreamView::add_crossfade (Crossfade *crossfade)
240 {
241         AudioRegionView* lview = 0;
242         AudioRegionView* rview = 0;
243
244         ENSURE_GUI_THREAD (bind (mem_fun (*this, &AudioStreamView::add_crossfade), crossfade));
245
246         /* first see if we already have a CrossfadeView for this Crossfade */
247
248         for (list<CrossfadeView *>::iterator i = crossfade_views.begin(); i != crossfade_views.end(); ++i) {
249                 if (&(*i)->crossfade == crossfade) {
250                         if (!crossfades_visible) {
251                                 (*i)->hide();
252                         } else {
253                                 (*i)->show ();
254                         }
255                         (*i)->set_valid (true);
256                         return;
257                 }
258         }
259
260         /* create a new one */
261
262         for (list<RegionView *>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
263                 AudioRegionView* arv = dynamic_cast<AudioRegionView*>(*i);
264
265                 if (!lview && arv && &(arv->region()) == &crossfade->out()) {
266                         lview = arv;
267                 }
268                 if (!rview && arv && &(arv->region()) == &crossfade->in()) {
269                         rview = arv;
270                 }
271         }
272
273         CrossfadeView *cv = new CrossfadeView (_trackview.canvas_display,
274                                                _trackview,
275                                                *crossfade,
276                                                _samples_per_unit,
277                                                region_color,
278                                                *lview, *rview);
279
280         crossfade->Invalidated.connect (mem_fun (*this, &AudioStreamView::remove_crossfade));
281         crossfade_views.push_back (cv);
282
283         if (!crossfades_visible) {
284                 cv->hide ();
285         }
286 }
287
288 void
289 AudioStreamView::remove_crossfade (Crossfade *xfade)
290 {
291         ENSURE_GUI_THREAD (bind (mem_fun (*this, &AudioStreamView::remove_crossfade), xfade));
292
293         for (list<CrossfadeView*>::iterator i = crossfade_views.begin(); i != crossfade_views.end(); ++i) {
294                 if (&(*i)->crossfade == xfade) {
295                         delete *i;
296                         crossfade_views.erase (i);
297                         break;
298                 }
299         }
300 }
301
302 void
303 AudioStreamView::redisplay_diskstream ()
304 {
305         list<RegionView *>::iterator i, tmp;
306         list<CrossfadeView*>::iterator xi, tmpx;
307
308         
309         for (i = region_views.begin(); i != region_views.end(); ++i) {
310                 (*i)->set_valid (false);
311         }
312
313         for (xi = crossfade_views.begin(); xi != crossfade_views.end(); ++xi) {
314                 (*xi)->set_valid (false);
315                 if ((*xi)->visible()) {
316                         (*xi)->show ();
317                 }
318         }
319
320         if (_trackview.is_audio_track()) {
321                 _trackview.get_diskstream()->playlist()->foreach_region (static_cast<StreamView*>(this), &StreamView::add_region_view);
322                 AudioPlaylist* apl = dynamic_cast<AudioPlaylist*>(_trackview.get_diskstream()->playlist());
323                 if (apl)
324                         apl->foreach_crossfade (this, &AudioStreamView::add_crossfade);
325         }
326
327         for (i = region_views.begin(); i != region_views.end(); ) {
328                 tmp = i;
329                 tmp++;
330
331                 if (!(*i)->is_valid()) {
332                         delete *i;
333                         region_views.erase (i);
334                 } 
335
336                 i = tmp;
337         }
338
339         for (xi = crossfade_views.begin(); xi != crossfade_views.end();) {
340                 tmpx = xi;
341                 tmpx++;
342
343                 if (!(*xi)->valid()) {
344                         delete *xi;
345                         crossfade_views.erase (xi);
346                 }
347
348                 xi = tmpx;
349         }
350
351         /* now fix layering */
352
353         playlist_modified ();
354 }
355
356 void
357 AudioStreamView::set_show_waveforms (bool yn)
358 {
359         for (list<RegionView *>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
360                 AudioRegionView* const arv = dynamic_cast<AudioRegionView*>(*i);
361                 if (arv)
362                         arv->set_waveform_visible (yn);
363         }
364 }
365
366 void
367 AudioStreamView::set_waveform_shape (WaveformShape shape)
368 {
369         for (RegionViewList::iterator i = region_views.begin(); i != region_views.end(); ++i) {
370                 AudioRegionView* const arv = dynamic_cast<AudioRegionView*>(*i);
371                 if (arv)
372                         arv->set_waveform_shape (shape);
373         }
374 }               
375                 
376 void
377 AudioStreamView::setup_rec_box ()
378 {
379         // cerr << _trackview.name() << " streamview SRB\n";
380
381         if (_trackview.session().transport_rolling()) {
382
383                 // cerr << "\trolling\n";
384
385                 if (!rec_active && 
386                     _trackview.session().record_status() == Session::Recording && 
387                     _trackview.get_diskstream()->record_enabled()) {
388
389                         if (_trackview.audio_track()->mode() == Normal && use_rec_regions && rec_regions.size() == rec_rects.size()) {
390
391                                 /* add a new region, but don't bother if they set use_rec_regions mid-record */
392
393                                 AudioRegion::SourceList sources;
394
395                                 for (list<sigc::connection>::iterator prc = peak_ready_connections.begin(); prc != peak_ready_connections.end(); ++prc) {
396                                         (*prc).disconnect();
397                                 }
398                                 peak_ready_connections.clear();
399                                         
400                                 // FIXME
401                                 AudioDiskstream* ads = dynamic_cast<AudioDiskstream*>(_trackview.get_diskstream());
402                                 assert(ads);
403
404                                 for (uint32_t n=0; n < ads->n_channels(); ++n) {
405                                         AudioSource *src = (AudioSource *) ads->write_source (n);
406                                         if (src) {
407                                                 sources.push_back (src);
408                                                 peak_ready_connections.push_back (src->PeakRangeReady.connect (bind (mem_fun (*this, &AudioStreamView::rec_peak_range_ready), src))); 
409                                         }
410                                 }
411
412                                 // handle multi
413                                 
414                                 jack_nframes_t start = 0;
415                                 if (rec_regions.size() > 0) {
416                                         start = rec_regions.back()->start() + _trackview.get_diskstream()->get_captured_frames(rec_regions.size()-1);
417                                 }
418                                 
419                                 AudioRegion * region = new AudioRegion(sources, start, 1 , "", 0, (Region::Flag)(Region::DefaultFlags | Region::DoNotSaveState), false);
420                                 region->set_position (_trackview.session().transport_frame(), this);
421                                 rec_regions.push_back (region);
422                                 /* catch it if it goes away */
423                                 region->GoingAway.connect (mem_fun (*this, &AudioStreamView::remove_rec_region));
424
425                                 /* we add the region later */
426                         }
427                         
428                         /* start a new rec box */
429
430                         AudioTrack* at;
431
432                         at = _trackview.audio_track(); /* we know what it is already */
433                         AudioDiskstream& ds = at->audio_diskstream();
434                         jack_nframes_t frame_pos = ds.current_capture_start ();
435                         gdouble xstart = _trackview.editor.frame_to_pixel (frame_pos);
436                         gdouble xend;
437                         uint32_t fill_color;
438
439                         switch (_trackview.audio_track()->mode()) {
440                         case Normal:
441                                 xend = xstart;
442                                 fill_color = color_map[cRecordingRectFill];
443                                 break;
444
445                         case Destructive:
446                                 xend = xstart + 2;
447                                 fill_color = color_map[cRecordingRectFill];
448                                 /* make the recording rect translucent to allow
449                                    the user to see the peak data coming in, etc.
450                                 */
451                                 fill_color = UINT_RGBA_CHANGE_A (fill_color, 120);
452                                 break;
453                         }
454                         
455                         ArdourCanvas::SimpleRect * rec_rect = new Gnome::Canvas::SimpleRect (*canvas_group);
456                         rec_rect->property_x1() = xstart;
457                         rec_rect->property_y1() = 1.0;
458                         rec_rect->property_x2() = xend;
459                         rec_rect->property_y2() = (double) _trackview.height - 1;
460                         rec_rect->property_outline_color_rgba() = color_map[cRecordingRectOutline];
461                         rec_rect->property_fill_color_rgba() = fill_color;
462                         
463                         RecBoxInfo recbox;
464                         recbox.rectangle = rec_rect;
465                         recbox.start = _trackview.session().transport_frame();
466                         recbox.length = 0;
467                         
468                         rec_rects.push_back (recbox);
469                         
470                         screen_update_connection.disconnect();
471                         screen_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect (mem_fun (*this, &AudioStreamView::update_rec_box));   
472                         rec_updating = true;
473                         rec_active = true;
474
475                 } else if (rec_active &&
476                            (_trackview.session().record_status() != Session::Recording ||
477                             !_trackview.get_diskstream()->record_enabled())) {
478
479                         screen_update_connection.disconnect();
480                         rec_active = false;
481                         rec_updating = false;
482
483                 }
484                 
485         } else {
486
487                 // cerr << "\tNOT rolling, rec_rects = " << rec_rects.size() << " rec_regions = " << rec_regions.size() << endl;
488
489                 if (!rec_rects.empty() || !rec_regions.empty()) {
490
491                         /* disconnect rapid update */
492                         screen_update_connection.disconnect();
493
494                         for (list<sigc::connection>::iterator prc = peak_ready_connections.begin(); prc != peak_ready_connections.end(); ++prc) {
495                                 (*prc).disconnect();
496                         }
497                         peak_ready_connections.clear();
498
499                         rec_updating = false;
500                         rec_active = false;
501                         last_rec_peak_frame = 0;
502                         
503                         /* remove temp regions */
504                         for (list<Region*>::iterator iter=rec_regions.begin(); iter != rec_regions.end(); )
505                         {
506                                 list<Region*>::iterator tmp;
507
508                                 tmp = iter;
509                                 ++tmp;
510
511                                 /* this will trigger the remove_region_view */
512                                 delete *iter;
513
514                                 iter = tmp;
515                         }
516                         
517                         rec_regions.clear();
518
519                         // cerr << "\tclear " << rec_rects.size() << " rec rects\n";
520                 
521
522                         /* transport stopped, clear boxes */
523                         for (vector<RecBoxInfo>::iterator iter=rec_rects.begin(); iter != rec_rects.end(); ++iter) {
524                                 RecBoxInfo &rect = (*iter);
525                                 delete rect.rectangle;
526                         }
527                         
528                         rec_rects.clear();
529                         
530                 }
531         }
532 }
533
534 void
535 AudioStreamView::foreach_crossfadeview (void (CrossfadeView::*pmf)(void))
536 {
537         for (list<CrossfadeView*>::iterator i = crossfade_views.begin(); i != crossfade_views.end(); ++i) {
538                 ((*i)->*pmf) ();
539         }
540 }
541
542 void
543 AudioStreamView::rec_peak_range_ready (jack_nframes_t start, jack_nframes_t cnt, Source * src)
544 {
545         // this is called from the peak building thread
546
547         ENSURE_GUI_THREAD(bind (mem_fun (*this, &AudioStreamView::rec_peak_range_ready), start, cnt, src));
548         
549         if (rec_peak_ready_map.size() == 0 || start+cnt > last_rec_peak_frame) {
550                 last_rec_peak_frame = start + cnt;
551         }
552
553         rec_peak_ready_map[src] = true;
554
555         if (rec_peak_ready_map.size() == _trackview.get_diskstream()->n_channels()) {
556                 this->update_rec_regions ();
557                 rec_peak_ready_map.clear();
558         }
559 }
560
561 void
562 AudioStreamView::update_rec_regions ()
563 {
564         if (use_rec_regions) {
565
566                 uint32_t n = 0;
567
568                 for (list<Region*>::iterator iter = rec_regions.begin(); iter != rec_regions.end(); n++) {
569
570                         list<Region*>::iterator tmp;
571
572                         tmp = iter;
573                         ++tmp;
574
575                         if (!canvas_item_visible (rec_rects[n].rectangle)) {
576                                 /* rect already hidden, this region is done */
577                                 iter = tmp;
578                                 continue;
579                         }
580                         
581                         // FIXME
582                         AudioRegion * region = dynamic_cast<AudioRegion*>(*iter);
583                         assert(region);
584
585                         jack_nframes_t origlen = region->length();
586
587                         if (region == rec_regions.back() && rec_active) {
588
589                                 if (last_rec_peak_frame > region->start()) {
590
591                                         jack_nframes_t nlen = last_rec_peak_frame - region->start();
592
593                                         if (nlen != region->length()) {
594
595                                                 region->freeze ();
596                                                 region->set_position (_trackview.get_diskstream()->get_capture_start_frame(n), this);
597                                                 region->set_length (nlen, this);
598                                                 region->thaw ("updated");
599
600                                                 if (origlen == 1) {
601                                                         /* our special initial length */
602                                                         add_region_view_internal (region, false);
603                                                 }
604
605                                                 /* also update rect */
606                                                 ArdourCanvas::SimpleRect * rect = rec_rects[n].rectangle;
607                                                 gdouble xend = _trackview.editor.frame_to_pixel (region->position() + region->length());
608                                                 rect->property_x2() = xend;
609                                         }
610                                 }
611
612                         } else {
613
614                                 jack_nframes_t nlen = _trackview.get_diskstream()->get_captured_frames(n);
615
616                                 if (nlen != region->length()) {
617
618                                         if (region->source(0).length() >= region->start() + nlen) {
619
620                                                 region->freeze ();
621                                                 region->set_position (_trackview.get_diskstream()->get_capture_start_frame(n), this);
622                                                 region->set_length (nlen, this);
623                                                 region->thaw ("updated");
624                                                 
625                                                 if (origlen == 1) {
626                                                         /* our special initial length */
627                                                         add_region_view_internal (region, false);
628                                                 }
629                                                 
630                                                 /* also hide rect */
631                                                 ArdourCanvas::Item * rect = rec_rects[n].rectangle;
632                                                 rect->hide();
633
634                                         }
635                                 }
636                         }
637
638                         iter = tmp;
639                 }
640         }
641 }
642
643 void
644 AudioStreamView::show_all_xfades ()
645 {
646         foreach_crossfadeview (&CrossfadeView::show);
647         crossfades_visible = true;
648 }
649
650 void
651 AudioStreamView::hide_all_xfades ()
652 {
653         foreach_crossfadeview (&CrossfadeView::hide);
654         crossfades_visible = false;
655 }
656
657 void
658 AudioStreamView::hide_xfades_involving (AudioRegionView& rv)
659 {
660         for (list<CrossfadeView *>::iterator i = crossfade_views.begin(); i != crossfade_views.end(); ++i) {
661                 if ((*i)->crossfade.involves (rv.audio_region())) {
662                         (*i)->fake_hide ();
663                 }
664         }
665 }
666
667 void
668 AudioStreamView::reveal_xfades_involving (AudioRegionView& rv)
669 {
670         for (list<CrossfadeView *>::iterator i = crossfade_views.begin(); i != crossfade_views.end(); ++i) {
671                 if ((*i)->crossfade.involves (rv.audio_region()) && (*i)->visible()) {
672                         (*i)->show ();
673                 }
674         }
675 }
676
677 void
678 AudioStreamView::color_handler (ColorID id, uint32_t val)
679 {
680         switch (id) {
681         case cAudioTrackBase:
682                 if (_trackview.is_audio_track()) {
683                         canvas_rect->property_fill_color_rgba() = val;
684                 } 
685                 break;
686         case cAudioBusBase:
687                 if (!_trackview.is_audio_track()) {
688                         canvas_rect->property_fill_color_rgba() = val;
689                 }
690                 break;
691         case cAudioTrackOutline:
692                 canvas_rect->property_outline_color_rgba() = val;
693                 break;
694
695         default:
696                 break;
697         }
698 }