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