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