replace unicode dash with (monospace) minus.
[ardour.git] / gtk2_ardour / midi_streamview.cc
index e47d83ae8377044023686b558b6067eba4e05b76..90e6147763ab95827af368850550763c030d2f57 100644 (file)
 */
 
 #include <cmath>
-#include <cassert>
 #include <utility>
 
 #include <gtkmm.h>
 
 #include <gtkmm2ext/gtk_ui.h>
 
-#include "ardour/midi_diskstream.h"
-#include "ardour/midi_playlist.h"
 #include "ardour/midi_region.h"
 #include "ardour/midi_source.h"
 #include "ardour/midi_track.h"
+#include "ardour/operations.h"
 #include "ardour/region_factory.h"
-#include "ardour/smf_source.h"
 #include "ardour/session.h"
+#include "ardour/smf_source.h"
 
 #include "ardour_ui.h"
 #include "canvas-simplerect.h"
+#include "global_signals.h"
 #include "gui_thread.h"
 #include "lineset.h"
 #include "midi_region_view.h"
@@ -49,6 +48,8 @@
 #include "simplerect.h"
 #include "utils.h"
 
+#include "i18n.h"
+
 using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
@@ -63,7 +64,8 @@ MidiStreamView::MidiStreamView (MidiTimeAxisView& tv)
        , _highest_note(71)
        , _data_note_min(60)
        , _data_note_max(71)
-        , _note_lines (0)
+       , _note_lines (0)
+       , _updates_suspended (false)
 {
        /* use a group dedicated to MIDI underlays. Audio underlays are not in this group. */
        midi_underlay_group = new ArdourCanvas::Group (*_canvas_group);
@@ -71,16 +73,18 @@ MidiStreamView::MidiStreamView (MidiTimeAxisView& tv)
 
        /* 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() = DBL_MAX;
        _note_lines->property_y2() = 0;
 
-       _note_lines->signal_event().connect(sigc::bind(
-                       sigc::mem_fun(_trackview.editor(), &PublicEditor::canvas_stream_view_event),
-                       _note_lines, &_trackview));
+       _note_lines->signal_event().connect(
+               sigc::bind(sigc::mem_fun(_trackview.editor(),
+                                        &PublicEditor::canvas_stream_view_event),
+                          _note_lines, &_trackview));
 
        _note_lines->lower_to_bottom();
 
@@ -92,39 +96,13 @@ MidiStreamView::MidiStreamView (MidiTimeAxisView& tv)
        note_range_adjustment.set_value(_lowest_note);
 
        note_range_adjustment.signal_value_changed().connect(
-                       sigc::mem_fun(*this, &MidiStreamView::note_range_adjustment_changed));
+               sigc::mem_fun(*this, &MidiStreamView::note_range_adjustment_changed));
 }
 
 MidiStreamView::~MidiStreamView ()
 {
 }
 
-static void
-veto_note_range(uint8_t& min, uint8_t& max)
-{
-       /* Legal notes, thanks */
-       clamp_to_0_127(min);
-       clamp_to_0_127(max);
-
-       /* Always display at least one octave in [0, 127] */
-       if (max == 127) {
-               if (min > (127 - 11)) {
-                       min = 127 - 11;
-               }
-       } else if (max < min + 11) {
-               uint8_t d = 11 - (max - min);
-               if (max + d/2 > 127) {
-                       min -= d;
-               } else {
-                       min -= d / 2;
-                       max += d / 2;
-               }
-       }
-       assert(max - min >= 11);
-       assert(max <= 127);
-       assert(min <= 127);
-}
-
 RegionView*
 MidiStreamView::create_region_view (boost::shared_ptr<Region> r, bool /*wfd*/, bool)
 {
@@ -135,8 +113,8 @@ MidiStreamView::create_region_view (boost::shared_ptr<Region> r, bool /*wfd*/, b
        }
 
        RegionView* region_view = new MidiRegionView (_canvas_group, _trackview, region,
-                                                     _samples_per_unit, region_color);
-       
+                                                     _samples_per_unit, region_color);
+
        region_view->init (region_color, false);
 
        return region_view;
@@ -171,11 +149,23 @@ 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);
 
+       /* fit note range if we are importing */
+       if (_trackview.session()->operation_in_progress (Operations::insert_file)) {
+               set_note_range (ContentsRange);
+       }
+
        /* catch regionview going away */
-       region->DropReferences.connect (*this, invalidator (*this), boost::bind (&MidiStreamView::remove_region_view, this, region), gui_context());
+       boost::weak_ptr<Region> wr (region); // make this explicit
+       region->DropReferences.connect (*this, invalidator (*this), boost::bind (&MidiStreamView::remove_region_view, this, wr), gui_context());
 
        RegionViewAdded (region_view);
 
@@ -185,8 +175,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);
 
@@ -197,8 +188,8 @@ MidiStreamView::display_region(MidiRegionView* region_view, bool load_model)
        }
 
        _range_dirty = update_data_note_range(
-                       source->model()->lowest_note(),
-                       source->model()->highest_note());
+               source->model()->lowest_note(),
+               source->model()->highest_note());
 
        // Display region contents
        region_view->set_height (child_height());
@@ -211,7 +202,7 @@ MidiStreamView::display_track (boost::shared_ptr<Track> tr)
        StreamView::display_track (tr);
 
        draw_note_lines();
-       
+
        NoteRangeChanged();
 }
 
@@ -222,8 +213,8 @@ MidiStreamView::update_contents_metrics(boost::shared_ptr<Region> r)
        if (mr) {
                mr->midi_source(0)->load_model();
                _range_dirty = update_data_note_range(
-                               mr->model()->lowest_note(),
-                               mr->model()->highest_note());
+                       mr->model()->lowest_note(),
+                       mr->model()->highest_note());
        }
 }
 
@@ -256,8 +247,7 @@ MidiStreamView::redisplay_track ()
        _data_note_min = 127;
        _data_note_max = 0;
        _trackview.track()->playlist()->foreach_region(
-               sigc::mem_fun (*this, &StreamView::update_contents_metrics)
-               );
+               sigc::mem_fun (*this, &StreamView::update_contents_metrics));
 
        // No notes, use default range
        if (!_range_dirty) {
@@ -265,12 +255,6 @@ MidiStreamView::redisplay_track ()
                _data_note_max = 71;
        }
 
-       // Extend visible range to show newly recorded data, if necessary
-       _lowest_note  = std::min(_lowest_note, _data_note_min);
-       _highest_note = std::max(_highest_note, _data_note_max);
-
-       veto_note_range(_lowest_note, _highest_note);
-
        // Flag region views as invalid and disable drawing
        for (i = region_views.begin(); i != region_views.end(); ++i) {
                (*i)->set_valid(false);
@@ -279,8 +263,7 @@ MidiStreamView::redisplay_track ()
 
        // Add and display region views, and flag them as valid
        _trackview.track()->playlist()->foreach_region(
-               sigc::hide_return (sigc::mem_fun (*this, &StreamView::add_region_view))
-               );
+               sigc::hide_return (sigc::mem_fun (*this, &StreamView::add_region_view)));
 
        // Stack regions by layer, and remove invalid regions
        layer_regions();
@@ -296,23 +279,24 @@ MidiStreamView::update_contents_height ()
        StreamView::update_contents_height();
        _note_lines->property_y2() = child_height ();
 
-        apply_note_range (lowest_note(), highest_note(), true);
+       apply_note_range (lowest_note(), highest_note(), true);
 }
 
 void
 MidiStreamView::draw_note_lines()
 {
-        if (!_note_lines) {
-                return;
-        }
+       if (!_note_lines || _updates_suspended) {
+               return;
+       }
 
        double y;
        double prev_y = contents_height();
        uint32_t color;
 
        _note_lines->clear();
-       
-       if (child_height() < 140){
+
+       if (child_height() < 140 || note_height() < 3) {
+               /* track is too small for note lines, or there are too many */
                return;
        }
 
@@ -363,19 +347,20 @@ 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 max_note_height = 20;  // This should probably be based on text size...
+       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);
+       if (pixels_per_note > max_note_height) {
+
+               int const available_note_range = floor (child_height() / max_note_height);
                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++;
                        }
@@ -390,25 +375,32 @@ MidiStreamView::apply_note_range(uint8_t lowest, uint8_t highest, bool to_region
                        }
                }
        }
-       
+
        note_range_adjustment.set_page_size(_highest_note - _lowest_note);
        note_range_adjustment.set_value(_lowest_note);
-       
+
        draw_note_lines();
 
        if (to_region_views) {
+               apply_note_range_to_regions ();
+       }
+
+       NoteRangeChanged();
+}
+
+void
+MidiStreamView::apply_note_range_to_regions ()
+{
+       if (!_updates_suspended) {
                for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
                        ((MidiRegionView*)(*i))->apply_note_range(_lowest_note, _highest_note);
                }
        }
-
-       NoteRangeChanged();
 }
 
 void
 MidiStreamView::update_note_range(uint8_t note_num)
 {
-       assert(note_num <= 127);
        _data_note_min = min(_data_note_min, note_num);
        _data_note_max = max(_data_note_max, note_num);
 }
@@ -436,41 +428,56 @@ MidiStreamView::setup_rec_box ()
 
                                // handle multi
 
-                               nframes_t start = 0;
+                               framepos_t start = 0;
                                if (rec_regions.size() > 0) {
                                        start = rec_regions.back().first->start()
-                                                       + _trackview.track()->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; 
-                               
+
+                               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, plist, false)));
-
-                               assert(region);
-                               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 ();
+                                                                     (RegionFactory::create (sources, plist, false)));
+                               if (region) {
+                                       region->set_start (_trackview.track()->current_capture_start()
+                                                          - _trackview.track()->get_capture_start_frame (0));
+                                       region->set_position (_trackview.track()->current_capture_start());
+                                       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 */
+                               
+                                       /* rec region will be destroyed in setup_rec_box */
+                                       rec_regions.push_back (make_pair (region, rv));
 
-                               setup_new_rec_layer_time (region);
+                                       /* we add the region later */
+                                       setup_new_rec_layer_time (region);
+                               } else {
+                                       error << _("failed to create MIDI region") << endmsg;
+                               }
                        }
 
                        /* start a new rec box */
@@ -481,8 +488,6 @@ MidiStreamView::setup_rec_box ()
                        gdouble const xend = xstart;
                        uint32_t fill_color;
 
-                       assert(_trackview.midi_track()->mode() == Normal);
-
                        fill_color = ARDOUR_UI::config()->canvasvar_RecordingRect.get();
 
                        ArdourCanvas::SimpleRect * rec_rect = new Gnome::Canvas::SimpleRect (*_canvas_group);
@@ -503,13 +508,13 @@ MidiStreamView::setup_rec_box ()
 
                        screen_update_connection.disconnect();
                        screen_update_connection = ARDOUR_UI::instance()->SuperRapidScreenUpdate.connect (
-                                       sigc::mem_fun (*this, &MidiStreamView::update_rec_box));
+                               sigc::mem_fun (*this, &MidiStreamView::update_rec_box));
                        rec_updating = true;
                        rec_active = true;
 
                } else if (rec_active &&
-                          (_trackview.session()->record_status() != Session::Recording ||
-                           !_trackview.track()->record_enabled())) {
+                          (_trackview.session()->record_status() != Session::Recording ||
+                           !_trackview.track()->record_enabled())) {
                        screen_update_connection.disconnect();
                        rec_active = false;
                        rec_updating = false;
@@ -560,7 +565,7 @@ MidiStreamView::setup_rec_box ()
 void
 MidiStreamView::color_handler ()
 {
-        draw_note_lines ();
+       draw_note_lines ();
 
        if (_trackview.is_midi_track()) {
                canvas_rect->property_fill_color_rgba() = ARDOUR_UI::config()->canvasvar_MidiTrackBase.get();
@@ -608,9 +613,56 @@ MidiStreamView::update_rec_box ()
 
        /* 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);
+       region->set_length (_trackview.track()->current_capture_end () - _trackview.track()->current_capture_start());
 
        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;
+}
+
+/** Suspend updates to the regions' note ranges and our
+ *  note lines until resume_updates() is called.
+ */
+void
+MidiStreamView::suspend_updates ()
+{
+       _updates_suspended = true;
+}
+
+/** Resume updates to region note ranges and note lines,
+ *  and update them now.
+ */
+void
+MidiStreamView::resume_updates ()
+{
+       _updates_suspended = false;
+
+       draw_note_lines ();
+       apply_note_range_to_regions ();
+}
+
+void
+MidiStreamView::leave_internal_edit_mode ()
+{
+       StreamView::leave_internal_edit_mode ();
+       for (RegionViewList::iterator i = region_views.begin(); i != region_views.end(); ++i) {
+               MidiRegionView* mrv = dynamic_cast<MidiRegionView*> (*i);
+               if (mrv) {
+                       mrv->clear_selection ();
+               }
+       }
+}