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