Optimize automation-event process splitting
[ardour.git] / libs / ardour / midi_source.cc
index 5bfa73518c040964170c77b736bc9e994a787a99..18efd4e9ea1588052fcfc3f825ccdbc630faee91 100644 (file)
 #include "pbd/pthread_utils.h"
 #include "pbd/basename.h"
 
+#include "evoral/Control.hpp"
 #include "evoral/EventSink.hpp"
 
 #include "ardour/debug.h"
+#include "ardour/file_source.h"
+#include "ardour/midi_channel_filter.h"
+#include "ardour/midi_cursor.h"
 #include "ardour/midi_model.h"
-#include "ardour/midi_state_tracker.h"
 #include "ardour/midi_source.h"
-#include "ardour/file_source.h"
+#include "ardour/midi_state_tracker.h"
 #include "ardour/session.h"
 #include "ardour/session_directory.h"
 #include "ardour/source_factory.h"
+#include "ardour/tempo.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 namespace ARDOUR { template <typename T> class MidiRingBuffer; }
 
@@ -53,14 +57,10 @@ using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
-PBD::Signal1<void,MidiSource*> MidiSource::MidiSourceCreated;
-
 MidiSource::MidiSource (Session& s, string name, Source::Flag flags)
        : Source(s, DataType::MIDI, name, flags)
        , _writing(false)
-       , _model_iter_valid(false)
        , _length_beats(0.0)
-       , _last_read_end(0)
        , _capture_length(0)
        , _capture_loop_length(0)
 {
@@ -69,9 +69,7 @@ MidiSource::MidiSource (Session& s, string name, Source::Flag flags)
 MidiSource::MidiSource (Session& s, const XMLNode& node)
        : Source(s, node)
        , _writing(false)
-       , _model_iter_valid(false)
        , _length_beats(0.0)
-       , _last_read_end(0)
        , _capture_length(0)
        , _capture_loop_length(0)
 {
@@ -82,6 +80,8 @@ MidiSource::MidiSource (Session& s, const XMLNode& node)
 
 MidiSource::~MidiSource ()
 {
+       /* invalidate any existing iterators */
+       Invalidated (false);
 }
 
 XMLNode&
@@ -90,19 +90,19 @@ MidiSource::get_state ()
        XMLNode& node (Source::get_state());
 
        if (_captured_for.length()) {
-               node.add_property ("captured-for", _captured_for);
+               node.set_property ("captured-for", _captured_for);
        }
 
        for (InterpolationStyleMap::const_iterator i = _interpolation_style.begin(); i != _interpolation_style.end(); ++i) {
                XMLNode* child = node.add_child (X_("InterpolationStyle"));
-               child->add_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
-               child->add_property (X_("style"), enum_2_string (i->second));
+               child->set_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
+               child->set_property (X_("style"), enum_2_string (i->second));
        }
 
        for (AutomationStateMap::const_iterator i = _automation_state.begin(); i != _automation_state.end(); ++i) {
                XMLNode* child = node.add_child (X_("AutomationState"));
-               child->add_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
-               child->add_property (X_("state"), enum_2_string (i->second));
+               child->set_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
+               child->set_property (X_("state"), enum_2_string (i->second));
        }
 
        return node;
@@ -111,40 +111,52 @@ MidiSource::get_state ()
 int
 MidiSource::set_state (const XMLNode& node, int /*version*/)
 {
-       const XMLProperty* prop;
-       if ((prop = node.property ("captured-for")) != 0) {
-               _captured_for = prop->value();
-       }
+       node.get_property ("captured-for", _captured_for);
 
+       std::string str;
        XMLNodeList children = node.children ();
        for (XMLNodeConstIterator i = children.begin(); i != children.end(); ++i) {
                if ((*i)->name() == X_("InterpolationStyle")) {
-                       if ((prop = (*i)->property (X_("parameter"))) == 0) {
+                       if (!(*i)->get_property (X_("parameter"), str)) {
                                error << _("Missing parameter property on InterpolationStyle") << endmsg;
                                return -1;
                        }
-                       Evoral::Parameter p = EventTypeMap::instance().from_symbol (prop->value());
+                       Evoral::Parameter p = EventTypeMap::instance().from_symbol (str);
+
+                       switch (p.type()) {
+                       case MidiCCAutomation:
+                       case MidiPgmChangeAutomation:       break;
+                       case MidiChannelPressureAutomation: break;
+                       case MidiNotePressureAutomation:    break;
+                       case MidiPitchBenderAutomation:     break;
+                       case MidiSystemExclusiveAutomation:
+                               cerr << "Parameter \"" << str << "\" is system exclusive - no automation possible!\n";
+                               continue;
+                       default:
+                               cerr << "Parameter \"" << str << "\" found for MIDI source ... not legal; ignoring this parameter\n";
+                               continue;
+                       }
 
-                       if ((prop = (*i)->property (X_("style"))) == 0) {
+                       if (!(*i)->get_property (X_("style"), str)) {
                                error << _("Missing style property on InterpolationStyle") << endmsg;
                                return -1;
                        }
-                       Evoral::ControlList::InterpolationStyle s = static_cast<Evoral::ControlList::InterpolationStyle>(
-                               string_2_enum (prop->value(), s));
+                       Evoral::ControlList::InterpolationStyle s =
+                           static_cast<Evoral::ControlList::InterpolationStyle>(string_2_enum (str, s));
                        set_interpolation_of (p, s);
 
                } else if ((*i)->name() == X_("AutomationState")) {
-                       if ((prop = (*i)->property (X_("parameter"))) == 0) {
+                       if (!(*i)->get_property (X_("parameter"), str)) {
                                error << _("Missing parameter property on AutomationState") << endmsg;
                                return -1;
                        }
-                       Evoral::Parameter p = EventTypeMap::instance().from_symbol (prop->value());
+                       Evoral::Parameter p = EventTypeMap::instance().from_symbol (str);
 
-                       if ((prop = (*i)->property (X_("state"))) == 0) {
+                       if (!(*i)->get_property (X_("state"), str)) {
                                error << _("Missing state property on AutomationState") << endmsg;
                                return -1;
                        }
-                       AutoState s = static_cast<AutoState> (string_2_enum (prop->value(), s));
+                       AutoState s = static_cast<AutoState>(string_2_enum (str, s));
                        set_automation_state_of (p, s);
                }
        }
@@ -158,96 +170,154 @@ MidiSource::empty () const
        return !_length_beats;
 }
 
-framecnt_t
-MidiSource::length (framepos_t pos) const
+samplecnt_t
+MidiSource::length (samplepos_t pos) const
 {
        if (!_length_beats) {
                return 0;
        }
 
-       BeatsFramesConverter converter(_session.tempo_map(), pos);
+       BeatsSamplesConverter converter(_session.tempo_map(), pos);
        return converter.to(_length_beats);
 }
 
 void
-MidiSource::update_length (framecnt_t)
+MidiSource::update_length (samplecnt_t)
 {
        // You're not the boss of me!
 }
 
 void
-MidiSource::invalidate ()
+MidiSource::invalidate (const Lock& lock)
 {
-       _model_iter_valid = false;
-       _model_iter.invalidate();
+       Invalidated(_session.transport_rolling());
 }
 
-framecnt_t
-MidiSource::midi_read (Evoral::EventSink<framepos_t>&     dst,
-                       framepos_t                         source_start,
-                       framepos_t                         start,
-                       framecnt_t                         cnt,
+samplecnt_t
+MidiSource::midi_read (const Lock&                        lm,
+                       Evoral::EventSink<samplepos_t>&     dst,
+                       samplepos_t                         source_start,
+                       samplepos_t                         start,
+                       samplecnt_t                         cnt,
+                       Evoral::Range<samplepos_t>*         loop_range,
+                       MidiCursor&                        cursor,
                        MidiStateTracker*                  tracker,
-                       const std::set<Evoral::Parameter>& filtered) const
+                       MidiChannelFilter*                 filter,
+                       const std::set<Evoral::Parameter>& filtered,
+                       const double                       pos_beats,
+                       const double                       start_beats) const
 {
-       Glib::Threads::Mutex::Lock lm (_lock);
+       BeatsSamplesConverter converter(_session.tempo_map(), source_start);
 
-       BeatsFramesConverter converter(_session.tempo_map(), source_start);
+       const double start_qn = pos_beats - start_beats;
 
        DEBUG_TRACE (DEBUG::MidiSourceIO,
                     string_compose ("MidiSource::midi_read() %5 sstart %1 start %2 cnt %3 tracker %4\n",
                                     source_start, start, cnt, tracker, name()));
 
-       if (_model) {
-               // Find appropriate model iterator
-               Evoral::Sequence<Evoral::MusicalTime>::const_iterator& i = _model_iter;
-               if (_last_read_end == 0 || start != _last_read_end || !_model_iter_valid) {
-                       // Cached iterator is invalid, search for the first event past start
-                       i                 = _model->begin(converter.from(start), false, filtered);
-                       _model_iter_valid = true;
-               }
+       if (!_model) {
+               return read_unlocked (lm, dst, source_start, start, cnt, loop_range, tracker, filter);
+       }
+
+       // Find appropriate model iterator
+       Evoral::Sequence<Temporal::Beats>::const_iterator& i = cursor.iter;
+       const bool linear_read = cursor.last_read_end != 0 && start == cursor.last_read_end;
+       if (!linear_read || !i.valid()) {
+               /* Cached iterator is invalid, search for the first event past start.
+                  Note that multiple tracks can use a MidiSource simultaneously, so
+                  all playback state must be in parameters (the cursor) and must not
+                  be cached in the source of model itself.
+                  See http://tracker.ardour.org/view.php?id=6541
+               */
+               cursor.connect(Invalidated);
+               cursor.iter = _model->begin(converter.from(start), false, filtered, &cursor.active_notes);
+               cursor.active_notes.clear();
+       }
+
+       cursor.last_read_end = start + cnt;
+
+       // Copy events in [start, start + cnt) into dst
+       for (; i != _model->end(); ++i) {
+
+               // Offset by source start to convert event time to session time
+
+               samplepos_t time_samples = _session.tempo_map().sample_at_quarter_note (i->time().to_double() + start_qn);
+
+               if (time_samples < start + source_start) {
+                       /* event too early */
 
-               _last_read_end = start + cnt;
+                       continue;
 
-               // Copy events in [start, start + cnt) into dst
-               for (; i != _model->end(); ++i) {
-                       const framecnt_t time_frames = converter.to(i->time());
-                       if (time_frames < start + cnt) {
-                               // Offset by source start to convert event time to session time
-                               dst.write (time_frames + source_start, i->event_type(), i->size(), i->buffer());
+               } else if (time_samples >= start + cnt + source_start) {
 
-                               DEBUG_TRACE (DEBUG::MidiSourceIO,
-                                            string_compose ("%1: add event @ %2 type %3 size %4\n",
-                                                            _name, time_frames + source_start, i->event_type(), i->size()));
+                       DEBUG_TRACE (DEBUG::MidiSourceIO,
+                                    string_compose ("%1: reached end with event @ %2 vs. %3\n",
+                                                    _name, time_samples, start+cnt));
+                       break;
 
-                               if (tracker) {
-                                       tracker->track (*i);
+               } else {
+
+                       /* in range */
+
+                       if (loop_range) {
+                               time_samples = loop_range->squish (time_samples);
+                       }
+
+                       const uint8_t status           = i->buffer()[0];
+                       const bool    is_channel_event = (0x80 <= (status & 0xF0)) && (status <= 0xE0);
+                       if (filter && is_channel_event) {
+                               /* Copy event so the filter can modify the channel.  I'm not
+                                  sure if this is necessary here (channels are mapped later in
+                                  buffers anyway), but it preserves existing behaviour without
+                                  destroying events in the model during read. */
+                               Evoral::Event<Temporal::Beats> ev(*i, true);
+                               if (!filter->filter(ev.buffer(), ev.size())) {
+                                       dst.write(time_samples, ev.event_type(), ev.size(), ev.buffer());
+                               } else {
+                                       DEBUG_TRACE (DEBUG::MidiSourceIO,
+                                                    string_compose ("%1: filter event @ %2 type %3 size %4\n",
+                                                                    _name, time_samples, i->event_type(), i->size()));
                                }
                        } else {
-                               DEBUG_TRACE (DEBUG::MidiSourceIO,
-                                            string_compose ("%1: reached end with event @ %2 vs. %3\n",
-                                                            _name, time_frames, start+cnt));
-                               break;
+                               dst.write (time_samples, i->event_type(), i->size(), i->buffer());
+                       }
+
+#ifndef NDEBUG
+                       if (DEBUG_ENABLED(DEBUG::MidiSourceIO)) {
+                               DEBUG_STR_DECL(a);
+                               DEBUG_STR_APPEND(a, string_compose ("%1 added event @ %2 sz %3 within %4 .. %5 ",
+                                                                   _name, time_samples, i->size(),
+                                                                   start + source_start, start + cnt + source_start));
+                               for (size_t n=0; n < i->size(); ++n) {
+                                       DEBUG_STR_APPEND(a,hex);
+                                       DEBUG_STR_APPEND(a,"0x");
+                                       DEBUG_STR_APPEND(a,(int)i->buffer()[n]);
+                                       DEBUG_STR_APPEND(a,' ');
+                               }
+                               DEBUG_STR_APPEND(a,'\n');
+                               DEBUG_TRACE (DEBUG::MidiSourceIO, DEBUG_STR(a).str());
+                       }
+#endif
+
+                       if (tracker) {
+                               tracker->track (*i);
                        }
                }
-               return cnt;
-       } else {
-               return read_unlocked (dst, source_start, start, cnt, tracker);
        }
+
+       return cnt;
 }
 
-framecnt_t
-MidiSource::midi_write (MidiRingBuffer<framepos_t>& source,
-                        framepos_t                  source_start,
-                        framecnt_t                  cnt)
+samplecnt_t
+MidiSource::midi_write (const Lock&                 lm,
+                        MidiRingBuffer<samplepos_t>& source,
+                        samplepos_t                  source_start,
+                        samplecnt_t                  cnt)
 {
-       Glib::Threads::Mutex::Lock lm (_lock);
+       const samplecnt_t ret = write_unlocked (lm, source, source_start, cnt);
 
-       const framecnt_t ret = write_unlocked (source, source_start, cnt);
-
-       if (cnt == max_framecnt) {
-               _last_read_end = 0;
-               invalidate();
+       if (cnt == max_samplecnt) {
+               invalidate(lm);
        } else {
                _capture_length += cnt;
        }
@@ -256,7 +326,7 @@ MidiSource::midi_write (MidiRingBuffer<framepos_t>& source,
 }
 
 void
-MidiSource::mark_streaming_midi_write_started (NoteMode mode)
+MidiSource::mark_streaming_midi_write_started (const Lock& lock, NoteMode mode)
 {
        if (_model) {
                _model->set_note_mode (mode);
@@ -267,12 +337,12 @@ MidiSource::mark_streaming_midi_write_started (NoteMode mode)
 }
 
 void
-MidiSource::mark_write_starting_now (framecnt_t position,
-                                     framecnt_t capture_length,
-                                     framecnt_t loop_length)
+MidiSource::mark_write_starting_now (samplecnt_t position,
+                                     samplecnt_t capture_length,
+                                     samplecnt_t loop_length)
 {
        /* I'm not sure if this is the best way to approach this, but
-          _capture_length needs to be set up with the transport frame
+          _capture_length needs to be set up with the transport sample
           when a record actually starts, as it is used by
           SMFSource::write_unlocked to decide whether incoming notes
           are within the correct time range.
@@ -286,60 +356,90 @@ MidiSource::mark_write_starting_now (framecnt_t position,
        _capture_length      = capture_length;
        _capture_loop_length = loop_length;
 
-       BeatsFramesConverter converter(_session.tempo_map(), position);
+       TempoMap& map (_session.tempo_map());
+       BeatsSamplesConverter converter(map, position);
        _length_beats = converter.from(capture_length);
 }
 
 void
-MidiSource::mark_streaming_write_started ()
+MidiSource::mark_streaming_write_started (const Lock& lock)
 {
        NoteMode note_mode = _model ? _model->note_mode() : Sustained;
-       mark_streaming_midi_write_started (note_mode);
+       mark_streaming_midi_write_started (lock, note_mode);
 }
 
 void
-MidiSource::mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::StuckNoteOption option,
-                                                 Evoral::MusicalTime                                    end)
+MidiSource::mark_midi_streaming_write_completed (const Lock&                                      lock,
+                                                 Evoral::Sequence<Temporal::Beats>::StuckNoteOption option,
+                                                 Temporal::Beats                                  end)
 {
        if (_model) {
                _model->end_write (option, end);
+
+               /* Make captured controls discrete to play back user input exactly. */
+               for (MidiModel::Controls::iterator i = _model->controls().begin(); i != _model->controls().end(); ++i) {
+                       if (i->second->list()) {
+                               i->second->list()->set_interpolation(Evoral::ControlList::Discrete);
+                               _interpolation_style.insert(std::make_pair(i->second->parameter(), Evoral::ControlList::Discrete));
+                       }
+               }
        }
 
+       invalidate(lock);
        _writing = false;
 }
 
 void
-MidiSource::mark_streaming_write_completed ()
+MidiSource::mark_streaming_write_completed (const Lock& lock)
 {
-       mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::DeleteStuckNotes);
+       mark_midi_streaming_write_completed (lock, Evoral::Sequence<Temporal::Beats>::DeleteStuckNotes);
 }
 
 int
-MidiSource::write_to (boost::shared_ptr<MidiSource> newsrc, Evoral::MusicalTime begin, Evoral::MusicalTime end)
+MidiSource::export_write_to (const Lock& lock, boost::shared_ptr<MidiSource> newsrc, Temporal::Beats begin, Temporal::Beats end)
 {
+       Lock newsrc_lock (newsrc->mutex ());
+
+       if (!_model) {
+               error << string_compose (_("programming error: %1"), X_("no model for MidiSource during export"));
+               return -1;
+       }
+
+       _model->write_section_to (newsrc, newsrc_lock, begin, end, true);
+
+       newsrc->flush_midi(newsrc_lock);
+
+       return 0;
+}
+
+int
+MidiSource::write_to (const Lock& lock, boost::shared_ptr<MidiSource> newsrc, Temporal::Beats begin, Temporal::Beats end)
+{
+       Lock newsrc_lock (newsrc->mutex ());
+
        newsrc->set_timeline_position (_timeline_position);
        newsrc->copy_interpolation_from (this);
        newsrc->copy_automation_state_from (this);
 
        if (_model) {
-               if (begin == Evoral::MinMusicalTime && end == Evoral::MaxMusicalTime) {
-                       _model->write_to (newsrc);
+               if (begin == Temporal::Beats() && end == std::numeric_limits<Temporal::Beats>::max()) {
+                       _model->write_to (newsrc, newsrc_lock);
                } else {
-                       _model->write_section_to (newsrc, begin, end);
+                       _model->write_section_to (newsrc, newsrc_lock, begin, end);
                }
        } else {
                error << string_compose (_("programming error: %1"), X_("no model for MidiSource during ::clone()"));
                return -1;
        }
 
-       newsrc->flush_midi();
+       newsrc->flush_midi(newsrc_lock);
 
        /* force a reload of the model if the range is partial */
 
-       if (begin != Evoral::MinMusicalTime || end != Evoral::MaxMusicalTime) {
-               newsrc->load_model (true, true);
+       if (begin != Temporal::Beats() || end != std::numeric_limits<Temporal::Beats>::max()) {
+               newsrc->load_model (newsrc_lock, true);
        } else {
-               newsrc->set_model (_model);
+               newsrc->set_model (newsrc_lock, _model);
        }
 
        /* this file is not removable (but since it is MIDI, it is mutable) */
@@ -352,6 +452,8 @@ MidiSource::write_to (boost::shared_ptr<MidiSource> newsrc, Evoral::MusicalTime
 void
 MidiSource::session_saved()
 {
+       Lock lm (_lock);
+
        /* this writes a copy of the data to disk.
           XXX do we need to do this every time?
        */
@@ -366,18 +468,18 @@ MidiSource::session_saved()
                _model.reset ();
 
                /* Flush model contents to disk. */
-               mm->sync_to_source ();
+               mm->sync_to_source (lm);
 
                /* Reacquire model. */
                _model = mm;
 
        } else {
-               flush_midi();
+               flush_midi(lm);
        }
 }
 
 void
-MidiSource::set_note_mode(NoteMode mode)
+MidiSource::set_note_mode(const Lock& lock, NoteMode mode)
 {
        if (_model) {
                _model->set_note_mode(mode);
@@ -385,16 +487,18 @@ MidiSource::set_note_mode(NoteMode mode)
 }
 
 void
-MidiSource::drop_model ()
+MidiSource::drop_model (const Lock& lock)
 {
        _model.reset();
+       invalidate(lock);
        ModelChanged (); /* EMIT SIGNAL */
 }
 
 void
-MidiSource::set_model (boost::shared_ptr<MidiModel> m)
+MidiSource::set_model (const Lock& lock, boost::shared_ptr<MidiModel> m)
 {
        _model = m;
+       invalidate(lock);
        ModelChanged (); /* EMIT SIGNAL */
 }