430a92503dc2ecf24cd3608a2c9139dadb049b1a
[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_diskstream (boost::shared_ptr<Diskstream> ds)
213 {
214         StreamView::display_diskstream(ds);
215         draw_note_lines();
216         NoteRangeChanged();
217 }
218
219 void
220 MidiStreamView::update_contents_metrics(boost::shared_ptr<Region> r)
221 {
222         boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(r);
223         if (mr) {
224                 mr->midi_source(0)->load_model();
225                 _range_dirty = update_data_note_range(
226                                 mr->model()->lowest_note(),
227                                 mr->model()->highest_note());
228         }
229 }
230
231 bool
232 MidiStreamView::update_data_note_range(uint8_t min, uint8_t max)
233 {
234         bool dirty = false;
235         if (min < _data_note_min) {
236                 _data_note_min = min;
237                 dirty = true;
238         }
239         if (max > _data_note_max) {
240                 _data_note_max = max;
241                 dirty = true;
242         }
243         return dirty;
244 }
245
246 void
247 MidiStreamView::redisplay_diskstream ()
248 {
249         if (!_trackview.is_midi_track()) {
250                 return;
251         }
252
253         list<RegionView*>::iterator i;
254
255         // Load models if necessary, and find note range of all our contents
256         _range_dirty = false;
257         _data_note_min = 127;
258         _data_note_max = 0;
259         _trackview.get_diskstream()->playlist()->foreach_region(
260                 sigc::mem_fun (*this, &StreamView::update_contents_metrics)
261                 );
262
263         // No notes, use default range
264         if (!_range_dirty) {
265                 _data_note_min = 60;
266                 _data_note_max = 71;
267         }
268
269         // Extend visible range to show newly recorded data, if necessary
270         _lowest_note  = std::min(_lowest_note, _data_note_min);
271         _highest_note = std::max(_highest_note, _data_note_max);
272
273         veto_note_range(_lowest_note, _highest_note);
274
275         // Flag region views as invalid and disable drawing
276         for (i = region_views.begin(); i != region_views.end(); ++i) {
277                 (*i)->set_valid(false);
278                 (*i)->enable_display(false);
279         }
280
281         // Add and display region views, and flag them as valid
282         _trackview.get_diskstream()->playlist()->foreach_region(
283                 sigc::hide_return (sigc::mem_fun (*this, &StreamView::add_region_view))
284                 );
285
286         // Stack regions by layer, and remove invalid regions
287         layer_regions();
288
289         // Update note range (not regions which are correct) and draw note lines
290         apply_note_range(_lowest_note, _highest_note, false);
291 }
292
293
294 void
295 MidiStreamView::update_contents_height ()
296 {
297         StreamView::update_contents_height();
298         _note_lines->property_y2() = height;
299         draw_note_lines();
300 }
301
302 void
303 MidiStreamView::draw_note_lines()
304 {
305         double y;
306         double prev_y = contents_height();
307         uint32_t color;
308
309         _note_lines->clear();
310
311         for (int i = lowest_note(); i <= highest_note(); ++i) {
312                 y = floor(note_to_y(i));
313
314                 _note_lines->add_line(prev_y, 1.0, ARDOUR_UI::config()->canvasvar_PianoRollBlackOutline.get());
315
316                 switch (i % 12) {
317                 case 1:
318                 case 3:
319                 case 6:
320                 case 8:
321                 case 10:
322                         color = ARDOUR_UI::config()->canvasvar_PianoRollBlack.get();
323                         break;
324                 default:
325                         color = ARDOUR_UI::config()->canvasvar_PianoRollWhite.get();
326                         break;
327                 }
328
329                 if (i == highest_note()) {
330                         _note_lines->add_line(y, prev_y - y, color);
331                 } else {
332                         _note_lines->add_line(y + 1.0, prev_y - y - 1.0, color);
333                 }
334
335                 prev_y = y;
336         }
337 }
338
339 void
340 MidiStreamView::set_note_range(VisibleNoteRange r)
341 {
342         if (r == FullRange) {
343                 _lowest_note = 0;
344                 _highest_note = 127;
345         } else {
346                 _lowest_note = _data_note_min;
347                 _highest_note = _data_note_max;
348         }
349
350         apply_note_range(_lowest_note, _highest_note, true);
351 }
352
353 void
354 MidiStreamView::apply_note_range(uint8_t lowest, uint8_t highest, bool to_region_views)
355 {
356         _highest_note = highest;
357         _lowest_note = lowest;
358         note_range_adjustment.set_page_size(_highest_note - _lowest_note);
359         note_range_adjustment.set_value(_lowest_note);
360         draw_note_lines();
361
362         if (to_region_views) {
363                 for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
364                         ((MidiRegionView*)(*i))->apply_note_range(lowest, highest);
365                 }
366         }
367
368         NoteRangeChanged();
369 }
370
371 void
372 MidiStreamView::update_note_range(uint8_t note_num)
373 {
374         assert(note_num <= 127);
375         _data_note_min = min(_data_note_min, note_num);
376         _data_note_max = max(_data_note_max, note_num);
377 }
378
379 void
380 MidiStreamView::setup_rec_box ()
381 {
382         // cerr << _trackview.name() << " streamview SRB\n";
383
384         if (_trackview.session()->transport_rolling()) {
385
386                 if (!rec_active &&
387                     _trackview.session()->record_status() == Session::Recording &&
388                     _trackview.get_diskstream()->record_enabled()) {
389
390                         if (Config->get_show_waveforms_while_recording() && rec_regions.size() == rec_rects.size()) {
391
392                                 /* add a new region, but don't bother if they set show-waveforms-while-recording mid-record */
393
394                                 MidiRegion::SourceList sources;
395
396                                 rec_data_ready_connections.drop_connections ();
397
398                                 boost::shared_ptr<MidiDiskstream> mds = _trackview.midi_track()->midi_diskstream();
399
400                                 sources.push_back(mds->write_source());
401
402                                 mds->write_source()->ViewDataRangeReady.connect 
403                                         (rec_data_ready_connections, 
404                                          invalidator (*this),
405                                          ui_bind (&MidiStreamView::rec_data_range_ready, this, _1, _2, boost::weak_ptr<Source>(mds->write_source())),
406                                          gui_context());
407
408                                 // handle multi
409
410                                 nframes_t start = 0;
411                                 if (rec_regions.size() > 0) {
412                                         start = rec_regions.back().first->start()
413                                                         + _trackview.get_diskstream()->get_captured_frames(rec_regions.size()-1);
414                                 }
415                                 
416                                 PropertyList plist; 
417                                 
418                                 plist.add (ARDOUR::Properties::start, start);
419                                 plist.add (ARDOUR::Properties::length, 1);
420                                 plist.add (ARDOUR::Properties::name, string());
421                                 plist.add (ARDOUR::Properties::layer, 0);
422
423                                 boost::shared_ptr<MidiRegion> region (boost::dynamic_pointer_cast<MidiRegion>
424                                                                       (RegionFactory::create (sources, plist, false)));
425
426                                 assert(region);
427                                 region->block_property_changes ();
428                                 region->set_position (_trackview.session()->transport_frame(), this);
429                                 rec_regions.push_back (make_pair(region, (RegionView*)0));
430
431                                 // rec regions are destroyed in setup_rec_box
432
433                                 /* we add the region later */
434                         }
435
436                         /* start a new rec box */
437
438                         boost::shared_ptr<MidiTrack> mt = _trackview.midi_track(); /* we know what it is already */
439                         boost::shared_ptr<MidiDiskstream> ds = mt->midi_diskstream();
440                         nframes_t frame_pos = ds->current_capture_start ();
441                         gdouble xstart = _trackview.editor().frame_to_pixel (frame_pos);
442                         gdouble xend;
443                         uint32_t fill_color;
444
445                         assert(_trackview.midi_track()->mode() == Normal);
446
447                         xend = xstart;
448                         fill_color = ARDOUR_UI::config()->canvasvar_RecordingRect.get();
449
450                         ArdourCanvas::SimpleRect * rec_rect = new Gnome::Canvas::SimpleRect (*canvas_group);
451                         rec_rect->property_x1() = xstart;
452                         rec_rect->property_y1() = 1.0;
453                         rec_rect->property_x2() = xend;
454                         rec_rect->property_y2() = (double) _trackview.current_height() - 1;
455                         rec_rect->property_outline_color_rgba() = ARDOUR_UI::config()->canvasvar_RecordingRect.get();
456                         rec_rect->property_fill_color_rgba() = fill_color;
457                         rec_rect->lower_to_bottom();
458
459                         RecBoxInfo recbox;
460                         recbox.rectangle = rec_rect;
461                         recbox.start = _trackview.session()->transport_frame();
462                         recbox.length = 0;
463
464                         rec_rects.push_back (recbox);
465
466                         screen_update_connection.disconnect();
467                         screen_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect (
468                                         sigc::mem_fun (*this, &MidiStreamView::update_rec_box));
469                         rec_updating = true;
470                         rec_active = true;
471
472                 } else if (rec_active &&
473                            (_trackview.session()->record_status() != Session::Recording ||
474                             !_trackview.get_diskstream()->record_enabled())) {
475                         screen_update_connection.disconnect();
476                         rec_active = false;
477                         rec_updating = false;
478                 }
479
480         } else {
481
482                 // cerr << "\tNOT rolling, rec_rects = " << rec_rects.size() << " rec_regions = " << rec_regions.size() << endl;
483
484                 if (!rec_rects.empty() || !rec_regions.empty()) {
485
486                         /* disconnect rapid update */
487                         screen_update_connection.disconnect();
488                         rec_data_ready_connections.drop_connections ();
489
490                         rec_updating = false;
491                         rec_active = false;
492
493                         /* remove temp regions */
494
495                         for (list<pair<boost::shared_ptr<Region>,RegionView*> >::iterator iter = rec_regions.begin(); iter != rec_regions.end();) {
496                                 list<pair<boost::shared_ptr<Region>,RegionView*> >::iterator tmp;
497
498                                 tmp = iter;
499                                 ++tmp;
500
501                                 (*iter).first->drop_references ();
502
503                                 iter = tmp;
504                         }
505
506                         rec_regions.clear();
507
508                         // cerr << "\tclear " << rec_rects.size() << " rec rects\n";
509
510                         /* transport stopped, clear boxes */
511                         for (vector<RecBoxInfo>::iterator iter=rec_rects.begin(); iter != rec_rects.end(); ++iter) {
512                                 RecBoxInfo &rect = (*iter);
513                                 delete rect.rectangle;
514                         }
515
516                         rec_rects.clear();
517
518                 }
519         }
520 }
521
522 void
523 MidiStreamView::update_rec_regions (boost::shared_ptr<MidiModel> data, nframes_t start, nframes_t dur)
524 {
525         ENSURE_GUI_THREAD (*this, &MidiStreamView::update_rec_regions, data, start, dur)
526
527         if (Config->get_show_waveforms_while_recording ()) {
528
529                 uint32_t n = 0;
530                 bool     update_range = false;
531
532                 for (list<pair<boost::shared_ptr<Region>,RegionView*> >::iterator iter = rec_regions.begin();
533                                 iter != rec_regions.end(); n++) {
534
535                         list<pair<boost::shared_ptr<Region>,RegionView*> >::iterator tmp = iter;
536                         ++tmp;
537
538                         if (!canvas_item_visible (rec_rects[n].rectangle)) {
539                                 /* rect already hidden, this region is done */
540                                 iter = tmp;
541                                 continue;
542                         }
543
544                         boost::shared_ptr<MidiRegion> region = boost::dynamic_pointer_cast<MidiRegion>(iter->first);
545                         if (!region) {
546                                 iter = tmp;
547                                 continue;
548                         }
549
550                         nframes_t origlen = region->length();
551
552                         if (region == rec_regions.back().first && rec_active) {
553
554                                 if (start >= region->midi_source(0)->timeline_position()) {
555
556                                         nframes_t nlen = start + dur - region->position();
557
558                                         if (nlen != region->length()) {
559
560                                                 region->suspend_property_changes ();
561                                                 region->set_position (_trackview.get_diskstream()->get_capture_start_frame(n), this);
562                                                 region->set_length (start + dur - region->position(), this);
563                                                 region->resume_property_changes ();
564
565                                                 if (origlen == 1) {
566                                                         /* our special initial length */
567                                                         iter->second = add_region_view_internal (region, false);
568                                                         ((MidiRegionView*)iter->second)->begin_write();
569                                                 }
570
571                                                 /* also update rect */
572                                                 ArdourCanvas::SimpleRect * rect = rec_rects[n].rectangle;
573                                                 gdouble xend = _trackview.editor().frame_to_pixel (region->position() + region->length());
574                                                 rect->property_x2() = xend;
575
576                                                 ARDOUR::BeatsFramesConverter tconv(_trackview.session()->tempo_map(), region->position());
577                                                 const MidiModel::TimeType start_beats = tconv.from(start);
578
579                                                 /* draw events */
580                                                 MidiRegionView* mrv = (MidiRegionView*)iter->second;
581
582                                                 for (MidiModel::Notes::const_iterator i = data->note_lower_bound(start_beats);
583                                                                 i != data->notes().end(); ++i) {
584
585                                                         const boost::shared_ptr<MidiRegionView::NoteType>& note = *i;
586
587                                                         nframes_t note_start_frames = tconv.to(note->time());
588                                                         nframes_t note_end_frames   = tconv.to(note->end_time());
589
590                                                         if (note->length() > 0 && note_end_frames + region->position() > start)
591                                                                 mrv->resolve_note(note->note(), note_end_frames);
592
593                                                         if (note_start_frames + region->position() < start) {
594                                                                 continue;
595                                                         }
596
597                                                         if (note_start_frames + region->position() > start + dur) {
598                                                                 break;
599                                                         }
600
601                                                         if (note->note() < _lowest_note) {
602                                                                 _lowest_note = note->note();
603                                                                 update_range = true;
604                                                         } else if (note->note() > _highest_note) {
605                                                                 _highest_note = note->note();
606                                                                 update_range = true;
607                                                         }
608
609                                                         mrv->add_note (note, !update_range);
610                                                 }
611
612                                                 mrv->extend_active_notes();
613                                         }
614                                 }
615
616                         } else {
617
618                                 nframes_t nlen = _trackview.get_diskstream()->get_captured_frames(n);
619
620                                 if (nlen != region->length()) {
621
622                                         if (region->source_length(0) >= region->position() + nlen) {
623
624                                                 region->suspend_property_changes ();
625                                                 region->set_position (_trackview.get_diskstream()->get_capture_start_frame(n), this);
626                                                 region->set_length (nlen, this);
627                                                 region->resume_property_changes ();
628
629                                                 if (origlen == 1) {
630                                                         /* our special initial length */
631                                                         iter->second = add_region_view_internal (region, false);
632                                                 }
633
634                                                 /* also hide rect */
635                                                 ArdourCanvas::Item * rect = rec_rects[n].rectangle;
636                                                 rect->hide();
637
638                                         }
639                                 }
640                         }
641
642                         iter = tmp;
643                 }
644
645                 if (update_range)
646                         update_contents_height();
647         }
648 }
649
650 void
651 MidiStreamView::rec_data_range_ready (nframes_t start, nframes_t cnt, boost::weak_ptr<Source> weak_src)
652 {
653         // this is called from the butler thread for now
654
655         ENSURE_GUI_THREAD (*this, &MidiStreamView::rec_data_range_ready, start, cnt, weak_src)
656
657         boost::shared_ptr<SMFSource> src (boost::dynamic_pointer_cast<SMFSource>(weak_src.lock()));
658
659         if (!src) {
660                 return;
661         }
662
663         if (start + cnt > last_rec_data_frame) {
664                 last_rec_data_frame = start + cnt;
665         }
666
667         this->update_rec_regions (src->model(), start, cnt);
668 }
669
670 void
671 MidiStreamView::color_handler ()
672 {
673         //case cMidiTrackBase:
674         if (_trackview.is_midi_track()) {
675                 //canvas_rect->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_MidiTrackBase.get();
676         }
677
678         //case cMidiBusBase:
679         if (!_trackview.is_midi_track()) {
680                 //canvas_rect->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_MidiBusBase.get();;
681         }
682 }
683
684 void
685 MidiStreamView::note_range_adjustment_changed()
686 {
687         double sum = note_range_adjustment.get_value() + note_range_adjustment.get_page_size();
688         int lowest = (int) floor(note_range_adjustment.get_value());
689         int highest;
690
691         if (sum == _range_sum_cache) {
692                 //cerr << "cached" << endl;
693                 highest = (int) floor(sum);
694         } else {
695                 //cerr << "recalc" << endl;
696                 highest = lowest + (int) floor(note_range_adjustment.get_page_size());
697                 _range_sum_cache = sum;
698         }
699
700         if (lowest == _lowest_note && highest == _highest_note) {
701                 return;
702         }
703
704         //cerr << "note range adjustment changed: " << lowest << " " << highest << endl;
705         //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;
706
707         _lowest_note = lowest;
708         _highest_note = highest;
709         apply_note_range(lowest, highest, true);
710 }
711