Flesh out RDFF documentation.
[ardour.git] / gtk2_ardour / midi_streamview.cc
index 77d9afabaee3ccbecb63534437a284aa5f944e8c..b79a6dc6d0a61940f533bb5b80b8df69f959592f 100644 (file)
@@ -35,6 +35,7 @@
 
 #include "ardour_ui.h"
 #include "canvas-simplerect.h"
+#include "global_signals.h"
 #include "gui_thread.h"
 #include "lineset.h"
 #include "midi_region_view.h"
@@ -63,26 +64,19 @@ MidiStreamView::MidiStreamView (MidiTimeAxisView& tv)
        , _highest_note(71)
        , _data_note_min(60)
        , _data_note_max(71)
+        , _note_lines (0)
 {
-       if (tv.is_track()) {
-               stream_base_color = ARDOUR_UI::config()->canvasvar_MidiTrackBase.get();
-       } else {
-               stream_base_color = ARDOUR_UI::config()->canvasvar_MidiBusBase.get();
-       }
-
-       use_rec_regions = tv.editor().show_waveforms_recording ();
-
        /* use a group dedicated to MIDI underlays. Audio underlays are not in this group. */
-       midi_underlay_group = new ArdourCanvas::Group (*canvas_group);
+       midi_underlay_group = new ArdourCanvas::Group (*_canvas_group);
        midi_underlay_group->lower_to_bottom();
 
        /* put the note lines in the timeaxisview's group, so it
           can be put below ghost regions from MIDI underlays*/
-       _note_lines = new ArdourCanvas::LineSet(*canvas_group, ArdourCanvas::LineSet::Horizontal);
+       _note_lines = new ArdourCanvas::LineSet(*_canvas_group, ArdourCanvas::LineSet::Horizontal);
 
        _note_lines->property_x1() = 0;
        _note_lines->property_y1() = 0;
-       _note_lines->property_x2() = trackview().editor().frame_to_pixel (max_frames);
+       _note_lines->property_x2() = DBL_MAX;
        _note_lines->property_y2() = 0;
 
        _note_lines->signal_event().connect(sigc::bind(
@@ -91,7 +85,9 @@ MidiStreamView::MidiStreamView (MidiTimeAxisView& tv)
 
        _note_lines->lower_to_bottom();
 
-       ColorsChanged.connect(sigc::mem_fun(*this, &MidiStreamView::draw_note_lines));
+       color_handler ();
+
+       ColorsChanged.connect(sigc::mem_fun(*this, &MidiStreamView::color_handler));
 
        note_range_adjustment.set_page_size(_highest_note - _lowest_note);
        note_range_adjustment.set_value(_lowest_note);
@@ -139,9 +135,9 @@ MidiStreamView::create_region_view (boost::shared_ptr<Region> r, bool /*wfd*/, b
                return 0;
        }
 
-       RegionView* region_view = new MidiRegionView (canvas_group, _trackview, region,
+       RegionView* region_view = new MidiRegionView (_canvas_group, _trackview, region,
                                                      _samples_per_unit, region_color);
-
+       
        region_view->init (region_color, false);
 
        return region_view;
@@ -176,11 +172,17 @@ MidiStreamView::add_region_view_internal (boost::shared_ptr<Region> r, bool wfd,
 
        region_views.push_front (region_view);
 
+        if (_trackview.editor().internal_editing()) {
+                region_view->hide_rect ();
+        } else {
+                region_view->show_rect ();
+        }
+
        /* display events and find note range */
        display_region (region_view, wfd);
 
        /* catch regionview going away */
-       region->GoingAway.connect (sigc::bind (sigc::mem_fun (*this, &MidiStreamView::remove_region_view), region));
+       region->DropReferences.connect (*this, invalidator (*this), boost::bind (&MidiStreamView::remove_region_view, this, region), gui_context());
 
        RegionViewAdded (region_view);
 
@@ -190,8 +192,9 @@ MidiStreamView::add_region_view_internal (boost::shared_ptr<Region> r, bool wfd,
 void
 MidiStreamView::display_region(MidiRegionView* region_view, bool load_model)
 {
-       if ( ! region_view)
+       if (!region_view) {
                return;
+        }
 
        region_view->enable_display(true);
 
@@ -206,15 +209,17 @@ MidiStreamView::display_region(MidiRegionView* region_view, bool load_model)
                        source->model()->highest_note());
 
        // Display region contents
-       region_view->set_height(height);
+       region_view->set_height (child_height());
        region_view->display_model(source->model());
 }
 
 void
-MidiStreamView::display_diskstream (boost::shared_ptr<Diskstream> ds)
+MidiStreamView::display_track (boost::shared_ptr<Track> tr)
 {
-       StreamView::display_diskstream(ds);
+       StreamView::display_track (tr);
+
        draw_note_lines();
+       
        NoteRangeChanged();
 }
 
@@ -246,7 +251,7 @@ MidiStreamView::update_data_note_range(uint8_t min, uint8_t max)
 }
 
 void
-MidiStreamView::redisplay_diskstream ()
+MidiStreamView::redisplay_track ()
 {
        if (!_trackview.is_midi_track()) {
                return;
@@ -258,7 +263,7 @@ MidiStreamView::redisplay_diskstream ()
        _range_dirty = false;
        _data_note_min = 127;
        _data_note_max = 0;
-       _trackview.get_diskstream()->playlist()->foreach_region(
+       _trackview.track()->playlist()->foreach_region(
                sigc::mem_fun (*this, &StreamView::update_contents_metrics)
                );
 
@@ -281,7 +286,7 @@ MidiStreamView::redisplay_diskstream ()
        }
 
        // Add and display region views, and flag them as valid
-       _trackview.get_diskstream()->playlist()->foreach_region(
+       _trackview.track()->playlist()->foreach_region(
                sigc::hide_return (sigc::mem_fun (*this, &StreamView::add_region_view))
                );
 
@@ -297,18 +302,27 @@ void
 MidiStreamView::update_contents_height ()
 {
        StreamView::update_contents_height();
-       _note_lines->property_y2() = height;
-       draw_note_lines();
+       _note_lines->property_y2() = child_height ();
+
+        apply_note_range (lowest_note(), highest_note(), true);
 }
 
 void
 MidiStreamView::draw_note_lines()
 {
+        if (!_note_lines) {
+                return;
+        }
+
        double y;
        double prev_y = contents_height();
        uint32_t color;
 
        _note_lines->clear();
+       
+       if (child_height() < 140){
+               return;
+       }
 
        for (int i = lowest_note(); i <= highest_note(); ++i) {
                y = floor(note_to_y(i));
@@ -357,13 +371,42 @@ MidiStreamView::apply_note_range(uint8_t lowest, uint8_t highest, bool to_region
 {
        _highest_note = highest;
        _lowest_note = lowest;
+       
+       int const range = _highest_note - _lowest_note;  
+       int const pixels_per_note = floor (child_height () / range);
+       
+       /* do not grow note height beyond 10 pixels */
+       if (pixels_per_note > 10) {
+               
+               int const available_note_range = floor (child_height() / 10);
+               int additional_notes = available_note_range - range;
+               
+               /* distribute additional notes to higher and lower ranges, clamp at 0 and 127 */
+               for (int i = 0; i < additional_notes; i++){
+                       
+                       if (i % 2 && _highest_note < 127){
+                               _highest_note++;
+                       }
+                       else if (i % 2) {
+                               _lowest_note--;
+                       }
+                       else if (_lowest_note > 0){
+                               _lowest_note--;
+                       }
+                       else {
+                               _highest_note++;
+                       }
+               }
+       }
+       
        note_range_adjustment.set_page_size(_highest_note - _lowest_note);
        note_range_adjustment.set_value(_lowest_note);
+       
        draw_note_lines();
 
        if (to_region_views) {
                for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
-                       ((MidiRegionView*)(*i))->apply_note_range(lowest, highest);
+                       ((MidiRegionView*)(*i))->apply_note_range(_lowest_note, _highest_note);
                }
        }
 
@@ -383,68 +426,87 @@ MidiStreamView::setup_rec_box ()
 {
        // cerr << _trackview.name() << " streamview SRB\n";
 
-       if (_trackview.session().transport_rolling()) {
+       if (_trackview.session()->transport_rolling()) {
 
                if (!rec_active &&
-                   _trackview.session().record_status() == Session::Recording &&
-                   _trackview.get_diskstream()->record_enabled()) {
+                   _trackview.session()->record_status() == Session::Recording &&
+                   _trackview.track()->record_enabled()) {
 
-                       if (use_rec_regions && rec_regions.size() == rec_rects.size()) {
+                       if (Config->get_show_waveforms_while_recording() && rec_regions.size() == rec_rects.size()) {
 
-                               /* add a new region, but don't bother if they set use_rec_regions mid-record */
+                               /* add a new region, but don't bother if they set show-waveforms-while-recording mid-record */
 
                                MidiRegion::SourceList sources;
 
-                               for (list<sigc::connection>::iterator prc = rec_data_ready_connections.begin();
-                                               prc != rec_data_ready_connections.end(); ++prc) {
-                                       (*prc).disconnect();
-                               }
-                               rec_data_ready_connections.clear();
-
-                               boost::shared_ptr<MidiDiskstream> mds = _trackview.midi_track()->midi_diskstream();
+                               rec_data_ready_connections.drop_connections ();
 
-                               sources.push_back(mds->write_source());
-
-                               rec_data_ready_connections.push_back (mds->write_source()->ViewDataRangeReady.connect (sigc::bind (
-                                               sigc::mem_fun (*this, &MidiStreamView::rec_data_range_ready),
-                                               boost::weak_ptr<Source>(mds->write_source()))));
+                               sources.push_back (_trackview.midi_track()->write_source());
 
                                // handle multi
 
-                               nframes_t start = 0;
+                               framepos_t start = 0;
                                if (rec_regions.size() > 0) {
                                        start = rec_regions.back().first->start()
-                                                       + _trackview.get_diskstream()->get_captured_frames(rec_regions.size()-1);
+                                                       + _trackview.track()->get_captured_frames(rec_regions.size()-1);
+                               }
+
+                               if (!rec_regions.empty()) {
+                                       MidiRegionView* mrv = dynamic_cast<MidiRegionView*> (rec_regions.back().second);
+                                       mrv->end_write ();
                                }
+                               
+                               PropertyList plist; 
+                               
+                               plist.add (ARDOUR::Properties::start, start);
+                               plist.add (ARDOUR::Properties::length, 1);
+                               /* Just above we're setting this nascent region's length to 1.  I think this
+                                  is so that the RegionView gets created with a non-zero width, as apparently
+                                  creating a RegionView with a zero width causes it never to be displayed
+                                  (there is a warning in TimeAxisViewItem::init about this).  However, we
+                                  must also set length_beats to something non-zero, otherwise the frame length
+                                  of 1 causes length_beats to be set to some small quantity << 1.  Then
+                                  when the position is set up below, this length_beats is used to recompute
+                                  length using BeatsFramesConverter::to, which is slightly innacurate for small
+                                  beats values because it converts floating point beats to bars, beats and
+                                  integer ticks.  The upshot of which being that length gets set back to 0,
+                                  meaning no region view is ever seen, meaning no MIDI notes during record (#3820).
+                               */
+                               plist.add (ARDOUR::Properties::length_beats, 1);
+                               plist.add (ARDOUR::Properties::name, string());
+                               plist.add (ARDOUR::Properties::layer, 0);
 
                                boost::shared_ptr<MidiRegion> region (boost::dynamic_pointer_cast<MidiRegion>
-                                       (RegionFactory::create (sources, start, 1 , "", 0, Region::DefaultFlags, false)));
+                                                                     (RegionFactory::create (sources, plist, false)));
 
                                assert(region);
-                               region->block_property_changes ();
-                               region->set_position (_trackview.session().transport_frame(), this);
-                               rec_regions.push_back (make_pair(region, (RegionView*)0));
+                               region->set_start (_trackview.track()->current_capture_start() - _trackview.track()->get_capture_start_frame (0), this);
+                               region->set_position (_trackview.track()->current_capture_start(), this);
+                               RegionView* rv = add_region_view_internal (region, false);
+                               MidiRegionView* mrv = dynamic_cast<MidiRegionView*> (rv);
+                               mrv->begin_write ();
+
+                               rec_regions.push_back (make_pair (region, rv));
 
                                // rec regions are destroyed in setup_rec_box
 
                                /* we add the region later */
+
+                               setup_new_rec_layer_time (region);
                        }
 
                        /* start a new rec box */
 
                        boost::shared_ptr<MidiTrack> mt = _trackview.midi_track(); /* we know what it is already */
-                       boost::shared_ptr<MidiDiskstream> ds = mt->midi_diskstream();
-                       nframes_t frame_pos = ds->current_capture_start ();
-                       gdouble xstart = _trackview.editor().frame_to_pixel (frame_pos);
-                       gdouble xend;
+                       framepos_t const frame_pos = mt->current_capture_start ();
+                       gdouble const xstart = _trackview.editor().frame_to_pixel (frame_pos);
+                       gdouble const xend = xstart;
                        uint32_t fill_color;
 
                        assert(_trackview.midi_track()->mode() == Normal);
 
-                       xend = xstart;
                        fill_color = ARDOUR_UI::config()->canvasvar_RecordingRect.get();
 
-                       ArdourCanvas::SimpleRect * rec_rect = new Gnome::Canvas::SimpleRect (*canvas_group);
+                       ArdourCanvas::SimpleRect * rec_rect = new Gnome::Canvas::SimpleRect (*_canvas_group);
                        rec_rect->property_x1() = xstart;
                        rec_rect->property_y1() = 1.0;
                        rec_rect->property_x2() = xend;
@@ -455,7 +517,7 @@ MidiStreamView::setup_rec_box ()
 
                        RecBoxInfo recbox;
                        recbox.rectangle = rec_rect;
-                       recbox.start = _trackview.session().transport_frame();
+                       recbox.start = _trackview.session()->transport_frame();
                        recbox.length = 0;
 
                        rec_rects.push_back (recbox);
@@ -467,8 +529,8 @@ MidiStreamView::setup_rec_box ()
                        rec_active = true;
 
                } else if (rec_active &&
-                          (_trackview.session().record_status() != Session::Recording ||
-                           !_trackview.get_diskstream()->record_enabled())) {
+                          (_trackview.session()->record_status() != Session::Recording ||
+                           !_trackview.track()->record_enabled())) {
                        screen_update_connection.disconnect();
                        rec_active = false;
                        rec_updating = false;
@@ -482,12 +544,7 @@ MidiStreamView::setup_rec_box ()
 
                        /* disconnect rapid update */
                        screen_update_connection.disconnect();
-
-                       for (list<sigc::connection>::iterator prc = rec_data_ready_connections.begin();
-                                       prc != rec_data_ready_connections.end(); ++prc) {
-                               (*prc).disconnect();
-                       }
-                       rec_data_ready_connections.clear();
+                       rec_data_ready_connections.drop_connections ();
 
                        rec_updating = false;
                        rec_active = false;
@@ -521,165 +578,15 @@ MidiStreamView::setup_rec_box ()
        }
 }
 
-void
-MidiStreamView::update_rec_regions (boost::shared_ptr<MidiModel> data, nframes_t start, nframes_t dur)
-{
-       ENSURE_GUI_THREAD (*this, &MidiStreamView::update_rec_regions, data, start, dur)
-
-       if (use_rec_regions) {
-
-               uint32_t n = 0;
-               bool     update_range = false;
-
-               for (list<pair<boost::shared_ptr<Region>,RegionView*> >::iterator iter = rec_regions.begin();
-                               iter != rec_regions.end(); n++) {
-
-                       list<pair<boost::shared_ptr<Region>,RegionView*> >::iterator tmp = iter;
-                       ++tmp;
-
-                       if (!canvas_item_visible (rec_rects[n].rectangle)) {
-                               /* rect already hidden, this region is done */
-                               iter = tmp;
-                               continue;
-                       }
-
-                       boost::shared_ptr<MidiRegion> region = boost::dynamic_pointer_cast<MidiRegion>(iter->first);
-                       if (!region) {
-                               iter = tmp;
-                               continue;
-                       }
-
-                       nframes_t origlen = region->length();
-
-                       if (region == rec_regions.back().first && rec_active) {
-
-                               if (start >= region->midi_source(0)->timeline_position()) {
-
-                                       nframes_t nlen = start + dur - region->position();
-
-                                       if (nlen != region->length()) {
-
-                                               region->freeze ();
-                                               region->set_position (_trackview.get_diskstream()->get_capture_start_frame(n), this);
-                                               region->set_length (start + dur - region->position(), this);
-                                               region->thaw ("updated");
-
-                                               if (origlen == 1) {
-                                                       /* our special initial length */
-                                                       iter->second = add_region_view_internal (region, false);
-                                                       ((MidiRegionView*)iter->second)->begin_write();
-                                               }
-
-                                               /* also update rect */
-                                               ArdourCanvas::SimpleRect * rect = rec_rects[n].rectangle;
-                                               gdouble xend = _trackview.editor().frame_to_pixel (region->position() + region->length());
-                                               rect->property_x2() = xend;
-
-                                               ARDOUR::BeatsFramesConverter tconv(_trackview.session().tempo_map(), region->position());
-                                               const MidiModel::TimeType start_beats = tconv.from(start);
-
-                                               /* draw events */
-                                               MidiRegionView* mrv = (MidiRegionView*)iter->second;
-
-                                               for (MidiModel::Notes::const_iterator i = data->note_lower_bound(start_beats);
-                                                               i != data->notes().end(); ++i) {
-
-                                                       const boost::shared_ptr<MidiRegionView::NoteType>& note = *i;
-
-                                                       nframes_t note_start_frames = tconv.to(note->time());
-                                                       nframes_t note_end_frames   = tconv.to(note->end_time());
-
-                                                       if (note->length() > 0 && note_end_frames + region->position() > start)
-                                                               mrv->resolve_note(note->note(), note_end_frames);
-
-                                                       if (note_start_frames + region->position() < start) {
-                                                               continue;
-                                                       }
-
-                                                       if (note_start_frames + region->position() > start + dur) {
-                                                               break;
-                                                       }
-
-                                                       if (note->note() < _lowest_note) {
-                                                               _lowest_note = note->note();
-                                                               update_range = true;
-                                                       } else if (note->note() > _highest_note) {
-                                                               _highest_note = note->note();
-                                                               update_range = true;
-                                                       }
-
-                                                       mrv->add_note (note, !update_range);
-                                               }
-
-                                               mrv->extend_active_notes();
-                                       }
-                               }
-
-                       } else {
-
-                               nframes_t nlen = _trackview.get_diskstream()->get_captured_frames(n);
-
-                               if (nlen != region->length()) {
-
-                                       if (region->source_length(0) >= region->position() + nlen) {
-
-                                               region->freeze ();
-                                               region->set_position (_trackview.get_diskstream()->get_capture_start_frame(n), this);
-                                               region->set_length (nlen, this);
-                                               region->thaw ("updated");
-
-                                               if (origlen == 1) {
-                                                       /* our special initial length */
-                                                       iter->second = add_region_view_internal (region, false);
-                                               }
-
-                                               /* also hide rect */
-                                               ArdourCanvas::Item * rect = rec_rects[n].rectangle;
-                                               rect->hide();
-
-                                       }
-                               }
-                       }
-
-                       iter = tmp;
-               }
-
-               if (update_range)
-                       update_contents_height();
-       }
-}
-
-void
-MidiStreamView::rec_data_range_ready (nframes_t start, nframes_t cnt, boost::weak_ptr<Source> weak_src)
-{
-       // this is called from the butler thread for now
-
-       ENSURE_GUI_THREAD (*this, &MidiStreamView::rec_data_range_ready, start, cnt, weak_src)
-
-       boost::shared_ptr<SMFSource> src (boost::dynamic_pointer_cast<SMFSource>(weak_src.lock()));
-
-       if (!src) {
-               return;
-       }
-
-       if (start + cnt > last_rec_data_frame) {
-               last_rec_data_frame = start + cnt;
-       }
-
-       this->update_rec_regions (src->model(), start, cnt);
-}
-
 void
 MidiStreamView::color_handler ()
 {
-       //case cMidiTrackBase:
-       if (_trackview.is_midi_track()) {
-               //canvas_rect->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_MidiTrackBase.get();
-       }
+        draw_note_lines ();
 
-       //case cMidiBusBase:
-       if (!_trackview.is_midi_track()) {
-               //canvas_rect->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_MidiBusBase.get();;
+       if (_trackview.is_midi_track()) {
+               canvas_rect->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_MidiTrackBase.get();
+       } else {
+               canvas_rect->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_MidiBusBase.get();;
        }
 }
 
@@ -711,3 +618,34 @@ MidiStreamView::note_range_adjustment_changed()
        apply_note_range(lowest, highest, true);
 }
 
+void
+MidiStreamView::update_rec_box ()
+{
+       StreamView::update_rec_box ();
+
+       if (rec_regions.empty()) {
+               return;
+       }
+
+       /* Update the region being recorded to reflect where we currently are */
+       boost::shared_ptr<ARDOUR::Region> region = rec_regions.back().first;
+       region->set_length (_trackview.track()->current_capture_end () - _trackview.track()->current_capture_start(), this);
+
+       MidiRegionView* mrv = dynamic_cast<MidiRegionView*> (rec_regions.back().second);
+       mrv->extend_active_notes ();
+}
+
+uint8_t
+MidiStreamView::y_to_note (double y) const
+{
+       int const n = ((contents_height() - y - 1) / contents_height() * (double)contents_note_range())
+               + lowest_note();
+
+       if (n < 0) {
+               return 0;
+       } else if (n > 127) {
+               return 127;
+       }
+       
+       return n;
+}