4ab4c7154e46e63424ea5fb6787f50d8746f0bb8
[ardour.git] / gtk2_ardour / midi_streamview.cc
1 /*
2     Copyright (C) 2001-2007 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 #include <utility>
22
23 #include <gtkmm.h>
24
25 #include <gtkmm2ext/gtk_ui.h>
26
27 #include "ardour/midi_diskstream.h"
28 #include "ardour/midi_playlist.h"
29 #include "ardour/midi_region.h"
30 #include "ardour/midi_source.h"
31 #include "ardour/midi_track.h"
32 #include "ardour/region_factory.h"
33 #include "ardour/smf_source.h"
34 #include "ardour/session.h"
35
36 #include "ardour_ui.h"
37 #include "canvas-simplerect.h"
38 #include "gui_thread.h"
39 #include "lineset.h"
40 #include "midi_region_view.h"
41 #include "midi_streamview.h"
42 #include "midi_time_axis.h"
43 #include "midi_util.h"
44 #include "public_editor.h"
45 #include "region_selection.h"
46 #include "region_view.h"
47 #include "rgb_macros.h"
48 #include "selection.h"
49 #include "simplerect.h"
50 #include "utils.h"
51
52 using namespace std;
53 using namespace ARDOUR;
54 using namespace PBD;
55 using namespace Editing;
56
57 MidiStreamView::MidiStreamView (MidiTimeAxisView& tv)
58         : StreamView (tv)
59         , note_range_adjustment(0.0f, 0.0f, 0.0f)
60         , _range_dirty(false)
61         , _range_sum_cache(-1.0)
62         , _lowest_note(60)
63         , _highest_note(71)
64         , _data_note_min(60)
65         , _data_note_max(71)
66 {
67         if (tv.is_track()) {
68                 stream_base_color = ARDOUR_UI::config()->canvasvar_MidiTrackBase.get();
69         } else {
70                 stream_base_color = ARDOUR_UI::config()->canvasvar_MidiBusBase.get();
71         }
72
73         /* use a group dedicated to MIDI underlays. Audio underlays are not in this group. */
74         midi_underlay_group = new ArdourCanvas::Group (*_canvas_group);
75         midi_underlay_group->lower_to_bottom();
76
77         /* put the note lines in the timeaxisview's group, so it
78            can be put below ghost regions from MIDI underlays*/
79         _note_lines = new ArdourCanvas::LineSet(*_canvas_group, ArdourCanvas::LineSet::Horizontal);
80
81         _note_lines->property_x1() = 0;
82         _note_lines->property_y1() = 0;
83         _note_lines->property_x2() = trackview().editor().frame_to_pixel (max_frames);
84         _note_lines->property_y2() = 0;
85
86         _note_lines->signal_event().connect(sigc::bind(
87                         sigc::mem_fun(_trackview.editor(), &PublicEditor::canvas_stream_view_event),
88                         _note_lines, &_trackview));
89
90         _note_lines->lower_to_bottom();
91
92         ColorsChanged.connect(sigc::mem_fun(*this, &MidiStreamView::draw_note_lines));
93
94         note_range_adjustment.set_page_size(_highest_note - _lowest_note);
95         note_range_adjustment.set_value(_lowest_note);
96
97         note_range_adjustment.signal_value_changed().connect(
98                         sigc::mem_fun(*this, &MidiStreamView::note_range_adjustment_changed));
99 }
100
101 MidiStreamView::~MidiStreamView ()
102 {
103 }
104
105 static void
106 veto_note_range(uint8_t& min, uint8_t& max)
107 {
108         /* Legal notes, thanks */
109         clamp_to_0_127(min);
110         clamp_to_0_127(max);
111
112         /* Always display at least one octave in [0, 127] */
113         if (max == 127) {
114                 if (min > (127 - 11)) {
115                         min = 127 - 11;
116                 }
117         } else if (max < min + 11) {
118                 uint8_t d = 11 - (max - min);
119                 if (max + d/2 > 127) {
120                         min -= d;
121                 } else {
122                         min -= d / 2;
123                         max += d / 2;
124                 }
125         }
126         assert(max - min >= 11);
127         assert(max <= 127);
128         assert(min <= 127);
129 }
130
131 RegionView*
132 MidiStreamView::create_region_view (boost::shared_ptr<Region> r, bool /*wfd*/, bool)
133 {
134         boost::shared_ptr<MidiRegion> region = boost::dynamic_pointer_cast<MidiRegion> (r);
135
136         if (region == 0) {
137                 return 0;
138         }
139
140         RegionView* region_view = new MidiRegionView (_canvas_group, _trackview, region,
141                                                       _samples_per_unit, region_color);
142
143         region_view->init (region_color, false);
144
145         return region_view;
146 }
147
148 RegionView*
149 MidiStreamView::add_region_view_internal (boost::shared_ptr<Region> r, bool wfd, bool recording)
150 {
151         boost::shared_ptr<MidiRegion> region = boost::dynamic_pointer_cast<MidiRegion> (r);
152
153         if (region == 0) {
154                 return 0;
155         }
156
157         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
158                 if ((*i)->region() == r) {
159
160                         /* great. we already have a MidiRegionView for this Region. use it again. */
161
162                         (*i)->set_valid (true);
163
164                         display_region(dynamic_cast<MidiRegionView*>(*i), wfd);
165
166                         return 0;
167                 }
168         }
169
170         MidiRegionView* region_view = dynamic_cast<MidiRegionView*> (create_region_view (r, wfd, recording));
171         if (region_view == 0) {
172                 return 0;
173         }
174
175         region_views.push_front (region_view);
176
177         /* display events and find note range */
178         display_region (region_view, wfd);
179
180         /* catch regionview going away */
181         region->DropReferences.connect (*this, invalidator (*this), boost::bind (&MidiStreamView::remove_region_view, this, region), gui_context());
182
183         RegionViewAdded (region_view);
184
185         return region_view;
186 }
187
188 void
189 MidiStreamView::display_region(MidiRegionView* region_view, bool load_model)
190 {
191         if ( ! region_view)
192                 return;
193
194         region_view->enable_display(true);
195
196         boost::shared_ptr<MidiSource> source(region_view->midi_region()->midi_source(0));
197
198         if (load_model) {
199                 source->load_model();
200         }
201
202         _range_dirty = update_data_note_range(
203                         source->model()->lowest_note(),
204                         source->model()->highest_note());
205
206         // Display region contents
207         region_view->set_height(height);
208         region_view->display_model(source->model());
209 }
210
211 void
212 MidiStreamView::display_track (boost::shared_ptr<Track> tr)
213 {
214         StreamView::display_track (tr);
215
216         draw_note_lines();
217         
218         NoteRangeChanged();
219 }
220
221 void
222 MidiStreamView::update_contents_metrics(boost::shared_ptr<Region> r)
223 {
224         boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(r);
225         if (mr) {
226                 mr->midi_source(0)->load_model();
227                 _range_dirty = update_data_note_range(
228                                 mr->model()->lowest_note(),
229                                 mr->model()->highest_note());
230         }
231 }
232
233 bool
234 MidiStreamView::update_data_note_range(uint8_t min, uint8_t max)
235 {
236         bool dirty = false;
237         if (min < _data_note_min) {
238                 _data_note_min = min;
239                 dirty = true;
240         }
241         if (max > _data_note_max) {
242                 _data_note_max = max;
243                 dirty = true;
244         }
245         return dirty;
246 }
247
248 void
249 MidiStreamView::redisplay_track ()
250 {
251         if (!_trackview.is_midi_track()) {
252                 return;
253         }
254
255         list<RegionView*>::iterator i;
256
257         // Load models if necessary, and find note range of all our contents
258         _range_dirty = false;
259         _data_note_min = 127;
260         _data_note_max = 0;
261         _trackview.track()->playlist()->foreach_region(
262                 sigc::mem_fun (*this, &StreamView::update_contents_metrics)
263                 );
264
265         // No notes, use default range
266         if (!_range_dirty) {
267                 _data_note_min = 60;
268                 _data_note_max = 71;
269         }
270
271         // Extend visible range to show newly recorded data, if necessary
272         _lowest_note  = std::min(_lowest_note, _data_note_min);
273         _highest_note = std::max(_highest_note, _data_note_max);
274
275         veto_note_range(_lowest_note, _highest_note);
276
277         // Flag region views as invalid and disable drawing
278         for (i = region_views.begin(); i != region_views.end(); ++i) {
279                 (*i)->set_valid(false);
280                 (*i)->enable_display(false);
281         }
282
283         // Add and display region views, and flag them as valid
284         _trackview.track()->playlist()->foreach_region(
285                 sigc::hide_return (sigc::mem_fun (*this, &StreamView::add_region_view))
286                 );
287
288         // Stack regions by layer, and remove invalid regions
289         layer_regions();
290
291         // Update note range (not regions which are correct) and draw note lines
292         apply_note_range(_lowest_note, _highest_note, false);
293 }
294
295
296 void
297 MidiStreamView::update_contents_height ()
298 {
299         StreamView::update_contents_height();
300         _note_lines->property_y2() = height;
301
302         draw_note_lines();
303 }
304
305 void
306 MidiStreamView::draw_note_lines()
307 {
308         double y;
309         double prev_y = contents_height();
310         uint32_t color;
311
312         _note_lines->clear();
313         
314         if(height < 140){
315                 return;
316         }
317
318         for (int i = lowest_note(); i <= highest_note(); ++i) {
319                 y = floor(note_to_y(i));
320
321                 _note_lines->add_line(prev_y, 1.0, ARDOUR_UI::config()->canvasvar_PianoRollBlackOutline.get());
322
323                 switch (i % 12) {
324                 case 1:
325                 case 3:
326                 case 6:
327                 case 8:
328                 case 10:
329                         color = ARDOUR_UI::config()->canvasvar_PianoRollBlack.get();
330                         break;
331                 default:
332                         color = ARDOUR_UI::config()->canvasvar_PianoRollWhite.get();
333                         break;
334                 }
335
336                 if (i == highest_note()) {
337                         _note_lines->add_line(y, prev_y - y, color);
338                 } else {
339                         _note_lines->add_line(y + 1.0, prev_y - y - 1.0, color);
340                 }
341
342                 prev_y = y;
343         }
344 }
345
346 void
347 MidiStreamView::set_note_range(VisibleNoteRange r)
348 {
349         if (r == FullRange) {
350                 _lowest_note = 0;
351                 _highest_note = 127;
352         } else {
353                 _lowest_note = _data_note_min;
354                 _highest_note = _data_note_max;
355         }
356
357         apply_note_range(_lowest_note, _highest_note, true);
358 }
359
360 void
361 MidiStreamView::apply_note_range(uint8_t lowest, uint8_t highest, bool to_region_views)
362 {
363         _highest_note = highest;
364         _lowest_note = lowest;
365         note_range_adjustment.set_page_size(_highest_note - _lowest_note);
366         note_range_adjustment.set_value(_lowest_note);
367         draw_note_lines();
368
369         if (to_region_views) {
370                 for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
371                         ((MidiRegionView*)(*i))->apply_note_range(lowest, highest);
372                 }
373         }
374
375         NoteRangeChanged();
376 }
377
378 void
379 MidiStreamView::update_note_range(uint8_t note_num)
380 {
381         assert(note_num <= 127);
382         _data_note_min = min(_data_note_min, note_num);
383         _data_note_max = max(_data_note_max, note_num);
384 }
385
386 void
387 MidiStreamView::setup_rec_box ()
388 {
389         // cerr << _trackview.name() << " streamview SRB\n";
390
391         if (_trackview.session()->transport_rolling()) {
392
393                 if (!rec_active &&
394                     _trackview.session()->record_status() == Session::Recording &&
395                     _trackview.track()->record_enabled()) {
396
397                         if (Config->get_show_waveforms_while_recording() && rec_regions.size() == rec_rects.size()) {
398
399                                 /* add a new region, but don't bother if they set show-waveforms-while-recording mid-record */
400
401                                 MidiRegion::SourceList sources;
402
403                                 rec_data_ready_connections.drop_connections ();
404
405                                 sources.push_back (_trackview.midi_track()->write_source());
406
407                                 _trackview.midi_track()->write_source()->ViewDataRangeReady.connect 
408                                         (rec_data_ready_connections, 
409                                          invalidator (*this),
410                                          ui_bind (&MidiStreamView::rec_data_range_ready, this, _1, _2, boost::weak_ptr<Source>(_trackview.midi_track()->write_source())),
411                                          gui_context());
412
413                                 // handle multi
414
415                                 nframes_t start = 0;
416                                 if (rec_regions.size() > 0) {
417                                         start = rec_regions.back().first->start()
418                                                         + _trackview.track()->get_captured_frames(rec_regions.size()-1);
419                                 }
420                                 
421                                 PropertyList plist; 
422                                 
423                                 plist.add (ARDOUR::Properties::start, start);
424                                 plist.add (ARDOUR::Properties::length, 1);
425                                 plist.add (ARDOUR::Properties::name, string());
426                                 plist.add (ARDOUR::Properties::layer, 0);
427
428                                 boost::shared_ptr<MidiRegion> region (boost::dynamic_pointer_cast<MidiRegion>
429                                                                       (RegionFactory::create (sources, plist, false)));
430
431                                 assert(region);
432                                 region->block_property_changes ();
433                                 region->set_position (_trackview.session()->transport_frame(), this);
434                                 rec_regions.push_back (make_pair(region, (RegionView*)0));
435
436                                 // rec regions are destroyed in setup_rec_box
437
438                                 /* we add the region later */
439                         }
440
441                         /* start a new rec box */
442
443                         boost::shared_ptr<MidiTrack> mt = _trackview.midi_track(); /* we know what it is already */
444                         nframes_t frame_pos = mt->current_capture_start ();
445                         gdouble xstart = _trackview.editor().frame_to_pixel (frame_pos);
446                         gdouble xend;
447                         uint32_t fill_color;
448
449                         assert(_trackview.midi_track()->mode() == Normal);
450
451                         xend = xstart;
452                         fill_color = ARDOUR_UI::config()->canvasvar_RecordingRect.get();
453
454                         ArdourCanvas::SimpleRect * rec_rect = new Gnome::Canvas::SimpleRect (*_canvas_group);
455                         rec_rect->property_x1() = xstart;
456                         rec_rect->property_y1() = 1.0;
457                         rec_rect->property_x2() = xend;
458                         rec_rect->property_y2() = (double) _trackview.current_height() - 1;
459                         rec_rect->property_outline_color_rgba() = ARDOUR_UI::config()->canvasvar_RecordingRect.get();
460                         rec_rect->property_fill_color_rgba() = fill_color;
461                         rec_rect->lower_to_bottom();
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 (
472                                         sigc::mem_fun (*this, &MidiStreamView::update_rec_box));
473                         rec_updating = true;
474                         rec_active = true;
475
476                 } else if (rec_active &&
477                            (_trackview.session()->record_status() != Session::Recording ||
478                             !_trackview.track()->record_enabled())) {
479                         screen_update_connection.disconnect();
480                         rec_active = false;
481                         rec_updating = false;
482                 }
483
484         } else {
485
486                 // cerr << "\tNOT rolling, rec_rects = " << rec_rects.size() << " rec_regions = " << rec_regions.size() << endl;
487
488                 if (!rec_rects.empty() || !rec_regions.empty()) {
489
490                         /* disconnect rapid update */
491                         screen_update_connection.disconnect();
492                         rec_data_ready_connections.drop_connections ();
493
494                         rec_updating = false;
495                         rec_active = false;
496
497                         /* remove temp regions */
498
499                         for (list<pair<boost::shared_ptr<Region>,RegionView*> >::iterator iter = rec_regions.begin(); iter != rec_regions.end();) {
500                                 list<pair<boost::shared_ptr<Region>,RegionView*> >::iterator tmp;
501
502                                 tmp = iter;
503                                 ++tmp;
504
505                                 (*iter).first->drop_references ();
506
507                                 iter = tmp;
508                         }
509
510                         rec_regions.clear();
511
512                         // cerr << "\tclear " << rec_rects.size() << " rec rects\n";
513
514                         /* transport stopped, clear boxes */
515                         for (vector<RecBoxInfo>::iterator iter=rec_rects.begin(); iter != rec_rects.end(); ++iter) {
516                                 RecBoxInfo &rect = (*iter);
517                                 delete rect.rectangle;
518                         }
519
520                         rec_rects.clear();
521
522                 }
523         }
524 }
525
526 void
527 MidiStreamView::update_rec_regions (boost::shared_ptr<MidiModel> data, nframes_t start, nframes_t dur)
528 {
529         ENSURE_GUI_THREAD (*this, &MidiStreamView::update_rec_regions, data, start, dur)
530
531         if (Config->get_show_waveforms_while_recording ()) {
532
533                 uint32_t n = 0;
534                 bool     update_range = false;
535
536                 for (list<pair<boost::shared_ptr<Region>,RegionView*> >::iterator iter = rec_regions.begin();
537                                 iter != rec_regions.end(); n++) {
538
539                         list<pair<boost::shared_ptr<Region>,RegionView*> >::iterator tmp = iter;
540                         ++tmp;
541
542                         if (!canvas_item_visible (rec_rects[n].rectangle)) {
543                                 /* rect already hidden, this region is done */
544                                 iter = tmp;
545                                 continue;
546                         }
547
548                         boost::shared_ptr<MidiRegion> region = boost::dynamic_pointer_cast<MidiRegion>(iter->first);
549                         if (!region) {
550                                 iter = tmp;
551                                 continue;
552                         }
553
554                         nframes_t origlen = region->length();
555
556                         if (region == rec_regions.back().first && rec_active) {
557
558                                 if (start >= region->midi_source(0)->timeline_position()) {
559
560                                         nframes_t nlen = start + dur - region->position();
561
562                                         if (nlen != region->length()) {
563
564                                                 region->suspend_property_changes ();
565                                                 region->set_position (_trackview.track()->get_capture_start_frame(n), this);
566                                                 region->set_length (start + dur - region->position(), this);
567                                                 region->resume_property_changes ();
568
569                                                 if (origlen == 1) {
570                                                         /* our special initial length */
571                                                         iter->second = add_region_view_internal (region, false);
572                                                         ((MidiRegionView*)iter->second)->begin_write();
573                                                 }
574
575                                                 /* also update rect */
576                                                 ArdourCanvas::SimpleRect * rect = rec_rects[n].rectangle;
577                                                 gdouble xend = _trackview.editor().frame_to_pixel (region->position() + region->length());
578                                                 rect->property_x2() = xend;
579
580                                                 ARDOUR::BeatsFramesConverter tconv(_trackview.session()->tempo_map(), region->position());
581                                                 const MidiModel::TimeType start_beats = tconv.from(start);
582
583                                                 /* draw events */
584                                                 MidiRegionView* mrv = (MidiRegionView*)iter->second;
585
586                                                 for (MidiModel::Notes::const_iterator i = data->note_lower_bound(start_beats);
587                                                                 i != data->notes().end(); ++i) {
588
589                                                         const boost::shared_ptr<MidiRegionView::NoteType>& note = *i;
590
591                                                         nframes_t note_start_frames = tconv.to(note->time());
592                                                         nframes_t note_end_frames   = tconv.to(note->end_time());
593
594                                                         if (note->length() > 0 && note_end_frames + region->position() > start)
595                                                                 mrv->resolve_note(note->note(), note_end_frames);
596
597                                                         if (note_start_frames + region->position() < start) {
598                                                                 continue;
599                                                         }
600
601                                                         if (note_start_frames + region->position() > start + dur) {
602                                                                 break;
603                                                         }
604
605                                                         if (note->note() < _lowest_note) {
606                                                                 _lowest_note = note->note();
607                                                                 update_range = true;
608                                                         } else if (note->note() > _highest_note) {
609                                                                 _highest_note = note->note();
610                                                                 update_range = true;
611                                                         }
612
613                                                         mrv->add_note (note, !update_range);
614                                                 }
615
616                                                 mrv->extend_active_notes();
617                                         }
618                                 }
619
620                         } else {
621
622                                 nframes_t nlen = _trackview.track()->get_captured_frames(n);
623
624                                 if (nlen != region->length()) {
625
626                                         if (region->source_length(0) >= region->position() + nlen) {
627
628                                                 region->suspend_property_changes ();
629                                                 region->set_position (_trackview.track()->get_capture_start_frame(n), this);
630                                                 region->set_length (nlen, this);
631                                                 region->resume_property_changes ();
632
633                                                 if (origlen == 1) {
634                                                         /* our special initial length */
635                                                         iter->second = add_region_view_internal (region, false);
636                                                 }
637
638                                                 /* also hide rect */
639                                                 ArdourCanvas::Item * rect = rec_rects[n].rectangle;
640                                                 rect->hide();
641
642                                         }
643                                 }
644                         }
645
646                         iter = tmp;
647                 }
648
649                 if (update_range)
650                         update_contents_height();
651         }
652 }
653
654 void
655 MidiStreamView::rec_data_range_ready (nframes_t start, nframes_t cnt, boost::weak_ptr<Source> weak_src)
656 {
657         // this is called from the butler thread for now
658
659         ENSURE_GUI_THREAD (*this, &MidiStreamView::rec_data_range_ready, start, cnt, weak_src)
660
661         boost::shared_ptr<SMFSource> src (boost::dynamic_pointer_cast<SMFSource>(weak_src.lock()));
662
663         if (!src) {
664                 return;
665         }
666
667         if (start + cnt > last_rec_data_frame) {
668                 last_rec_data_frame = start + cnt;
669         }
670
671         this->update_rec_regions (src->model(), start, cnt);
672 }
673
674 void
675 MidiStreamView::color_handler ()
676 {
677         //case cMidiTrackBase:
678         if (_trackview.is_midi_track()) {
679                 //canvas_rect->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_MidiTrackBase.get();
680         }
681
682         //case cMidiBusBase:
683         if (!_trackview.is_midi_track()) {
684                 //canvas_rect->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_MidiBusBase.get();;
685         }
686 }
687
688 void
689 MidiStreamView::note_range_adjustment_changed()
690 {
691         double sum = note_range_adjustment.get_value() + note_range_adjustment.get_page_size();
692         int lowest = (int) floor(note_range_adjustment.get_value());
693         int highest;
694
695         if (sum == _range_sum_cache) {
696                 //cerr << "cached" << endl;
697                 highest = (int) floor(sum);
698         } else {
699                 //cerr << "recalc" << endl;
700                 highest = lowest + (int) floor(note_range_adjustment.get_page_size());
701                 _range_sum_cache = sum;
702         }
703
704         if (lowest == _lowest_note && highest == _highest_note) {
705                 return;
706         }
707
708         //cerr << "note range adjustment changed: " << lowest << " " << highest << endl;
709         //cerr << "  val=" << v_zoom_adjustment.get_value() << " page=" << v_zoom_adjustment.get_page_size() << " sum=" << v_zoom_adjustment.get_value() + v_zoom_adjustment.get_page_size() << endl;
710
711         _lowest_note = lowest;
712         _highest_note = highest;
713         apply_note_range(lowest, highest, true);
714 }
715