fix crash when copy'ing latent plugins
[ardour.git] / libs / ardour / midi_playlist.cc
index abc0d682baa07f86cba845d3f289c4c081d72228..e3274c77b193c44d52f9c911e6d720616673eeea 100644 (file)
@@ -1,6 +1,6 @@
 /*
     Copyright (C) 2006 Paul Davis
-    Written by Dave Robillard, 2006
+    Author: David Robillard
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
-#include <cassert>
-
 #include <algorithm>
+#include <cassert>
+#include <cstdlib>
 #include <iostream>
-
-#include <stdlib.h>
+#include <utility>
 
 #include "evoral/EventList.hpp"
+#include "evoral/Control.hpp"
 
+#include "ardour/beats_frames_converter.h"
 #include "ardour/debug.h"
-#include "ardour/types.h"
-#include "ardour/configuration.h"
+#include "ardour/midi_model.h"
 #include "ardour/midi_playlist.h"
 #include "ardour/midi_region.h"
+#include "ardour/midi_source.h"
+#include "ardour/midi_state_tracker.h"
 #include "ardour/session.h"
-#include "ardour/midi_ring_buffer.h"
-
-#include "pbd/error.h"
+#include "ardour/types.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace ARDOUR;
 using namespace PBD;
@@ -45,34 +45,45 @@ using namespace std;
 MidiPlaylist::MidiPlaylist (Session& session, const XMLNode& node, bool hidden)
        : Playlist (session, node, DataType::MIDI, hidden)
        , _note_mode(Sustained)
+       , _read_end(0)
 {
 #ifndef NDEBUG
-       const XMLProperty* prop = node.property("type");
+       XMLProperty const * prop = node.property("type");
        assert(prop && DataType(prop->value()) == DataType::MIDI);
 #endif
 
        in_set_state++;
-       set_state (node, Stateful::loading_state_version);
+       if (set_state (node, Stateful::loading_state_version)) {
+               throw failed_constructor ();
+       }
        in_set_state--;
+
+       relayer ();
 }
 
 MidiPlaylist::MidiPlaylist (Session& session, string name, bool hidden)
        : Playlist (session, name, DataType::MIDI, hidden)
        , _note_mode(Sustained)
+       , _read_end(0)
 {
 }
 
 MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, string name, bool hidden)
        : Playlist (other, name, hidden)
        , _note_mode(other->_note_mode)
+       , _read_end(0)
 {
 }
 
-MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, nframes_t start, nframes_t dur, string name, bool hidden)
+MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other,
+                            framepos_t                            start,
+                            framecnt_t                            dur,
+                            string                                name,
+                            bool                                  hidden)
        : Playlist (other, start, dur, name, hidden)
        , _note_mode(other->_note_mode)
+       , _read_end(0)
 {
-       /* this constructor does NOT notify others (session) */
 }
 
 MidiPlaylist::~MidiPlaylist ()
@@ -80,253 +91,211 @@ MidiPlaylist::~MidiPlaylist ()
 }
 
 template<typename Time>
-struct EventsSortByTime {
+struct EventsSortByTimeAndType {
     bool operator() (Evoral::Event<Time>* a, Evoral::Event<Time>* b) {
+           if (a->time() == b->time()) {
+                   if (parameter_is_midi ((AutomationType)a->event_type()) &&
+                       parameter_is_midi ((AutomationType)b->event_type())) {
+                           /* negate return value since we must return whether
+                            * or not a should sort before b, not b before a
+                            */
+                           return !MidiBuffer::second_simultaneous_midi_byte_is_first (a->buffer()[0], b->buffer()[0]);
+                   }
+           }
            return a->time() < b->time();
     }
 };
 
-/** Returns the number of frames in time duration read (eg could be large when 0 events are read) */
-nframes_t
-MidiPlaylist::read (MidiRingBuffer<nframes_t>& dst, nframes_t start, nframes_t dur, unsigned chan_n)
+framecnt_t
+MidiPlaylist::read (Evoral::EventSink<framepos_t>& dst,
+                    framepos_t                     start,
+                    framecnt_t                     dur,
+                    unsigned                       chan_n,
+                    MidiChannelFilter*             filter)
 {
-       /* this function is never called from a realtime thread, so
-          its OK to block (for short intervals).
-       */
-
-       Glib::RecMutex::Lock rm (region_lock);
-       DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("++++++ %1 .. %2  +++++++++++++++++++++++++++++++++++++++++++++++\n", start, start + dur));
-
-       nframes_t end = start + dur - 1;
+       typedef pair<MidiStateTracker*,framepos_t> TrackerInfo;
 
-       _read_data_count = 0;
+       Playlist::RegionReadLock rl (this);
 
-       // relevent regions overlapping start <--> end
-       vector< boost::shared_ptr<Region> > regs;
-       typedef pair<MidiStateTracker*,framepos_t> TrackerInfo;
-       vector<TrackerInfo> tracker_info;
-       uint32_t note_cnt = 0;
+       DEBUG_TRACE (DEBUG::MidiPlaylistIO,
+                    string_compose ("---- MidiPlaylist::read %1 .. %2 (%3 trackers) ----\n",
+                                    start, start + dur, _note_trackers.size()));
 
-       for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
-               if ((*i)->coverage (start, end) != OverlapNone) {
-                       regs.push_back(*i);
-               } else {
-                       NoteTrackers::iterator t = _note_trackers.find ((*i).get());
-                       if (t != _note_trackers.end()) {
-
-                               /* add it the set of trackers we will do note resolution
-                                  on, and remove it from the list we are keeping
-                                  around, because we don't need it anymore.
-
-                                  if the end of the region (where we want to theoretically resolve notes)
-                                  is outside the current read range, then just do it at the start
-                                  of this read range.
-                               */
-
-                               framepos_t resolve_at = (*i)->last_frame();
-                               if (resolve_at >= end) {
-                                       resolve_at = start;
-                               }
-
-                               tracker_info.push_back (TrackerInfo (t->second, resolve_at));
-                               DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("time to resolve & remove tracker for %1 @ %2\n", (*i)->name(), resolve_at));
-                               note_cnt += (t->second->on());
-                               _note_trackers.erase (t);
-                       }
-               }
+       /* First, emit any queued edit fixup events at start. */
+       for (NoteTrackers::iterator t = _note_trackers.begin(); t != _note_trackers.end(); ++t) {
+               t->second->fixer.emit(dst, _read_end, t->second->tracker);
        }
 
-       if (note_cnt == 0 && !tracker_info.empty()) {
-               /* trackers to dispose of, but they have no notes in them */
-               DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("Clearing %1 empty trackers\n", tracker_info.size()));
-               for (vector<TrackerInfo>::iterator t = tracker_info.begin(); t != tracker_info.end(); ++t) {
-                       delete (*t).first;
+       /* Find relevant regions that overlap [start..end] */
+       const framepos_t                         end = start + dur - 1;
+       std::vector< boost::shared_ptr<Region> > regs;
+       std::vector< boost::shared_ptr<Region> > ended;
+       for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
+               switch ((*i)->coverage (start, end)) {
+               case Evoral::OverlapStart:
+               case Evoral::OverlapInternal:
+                       regs.push_back (*i);
+                       break;
+
+               case Evoral::OverlapExternal:
+                       /* this region is entirely contained in the read range */
+                       regs.push_back (*i);
+                       ended.push_back (*i);
+                       break;
+
+               case Evoral::OverlapEnd:
+                       /* this region ends within the read range */
+                       regs.push_back (*i);
+                       ended.push_back (*i);
+                       break;
+
+               default:
+                       /* we don't care */
+                       break;
                }
-               tracker_info.clear ();
        }
 
-       if (regs.size() == 1 && tracker_info.empty()) {
-
-               /* just a single region - read directly into dst */
-
-               DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("Single region (%1) read, no out-of-bound region tracking info\n", regs.front()->name()));
-
-               boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(regs.front());
+       /* If we are reading from a single region, we can read directly into dst.  Otherwise,
+          we read into a temporarily list, sort it, then write that to dst. */
+       const bool direct_read = regs.size() == 1 &&
+               (ended.empty() || (ended.size() == 1 && ended.front() == regs.front()));
 
-               if (mr) {
+       Evoral::EventList<framepos_t>  evlist;
+       Evoral::EventSink<framepos_t>& tgt = direct_read ? dst : evlist;
 
-                       NoteTrackers::iterator t = _note_trackers.find (mr.get());
-                       MidiStateTracker* tracker;
-                       bool new_tracker = false;
+       DEBUG_TRACE (DEBUG::MidiPlaylistIO,
+                    string_compose ("\t%1 regions to read, direct: %2\n", regs.size(), direct_read));
 
-                       if (t == _note_trackers.end()) {
-                               tracker = new MidiStateTracker;
-                               new_tracker = true;
-                               DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tBEFORE: new tracker\n");
-                       } else {
-                               tracker = t->second;
-                               DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\tBEFORE: tracker says there are %1 on notes\n", tracker->on()));
-                       }
-
-                       mr->read_at (dst, start, dur, chan_n, _note_mode, tracker);
-                       DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\tAFTER: tracker says there are %1 on notes\n", tracker->on()));
-
-                       if (new_tracker) {
-                               pair<Region*,MidiStateTracker*> newpair;
-                               newpair.first = mr.get();
-                               newpair.second = tracker;
-                               _note_trackers.insert (newpair);
-                               DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tadded tracker to trackers\n");
-                       }
-
-                       _read_data_count += mr->read_data_count();
-               }
-
-       } else {
-
-               /* multiple regions and/or note resolution: sort by layer, read into a temporary non-monotonically
-                  sorted EventSink, sort and then insert into dst.
-               */
-
-               DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("%1 regions to read, plus %2 trackers\n", regs.size(), tracker_info.size()));
-
-               Evoral::EventList<nframes_t> evlist;
-
-               for (vector<TrackerInfo>::iterator t = tracker_info.begin(); t != tracker_info.end(); ++t) {
-                       DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("Resolve %1 notes\n", (*t).first->on()));
-                       (*t).first->resolve_notes (evlist, (*t).second);
-                       delete (*t).first;
+       for (vector<boost::shared_ptr<Region> >::iterator i = regs.begin(); i != regs.end(); ++i) {
+               boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*i);
+               if (!mr) {
+                       continue;
                }
 
-#ifndef NDEBUG
-               DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("After resolution we now have %1 events\n",  evlist.size()));
-               for (Evoral::EventList<nframes_t>::iterator x = evlist.begin(); x != evlist.end(); ++x) {
-                       DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\t%1\n", **x));
+               /* Get the existing note tracker for this region, or create a new one. */
+               NoteTrackers::iterator           t           = _note_trackers.find (mr.get());
+               bool                             new_tracker = false;
+               boost::shared_ptr<RegionTracker> tracker;
+               if (t == _note_trackers.end()) {
+                       tracker     = boost::shared_ptr<RegionTracker>(new RegionTracker);
+                       new_tracker = true;
+                       DEBUG_TRACE (DEBUG::MidiPlaylistIO,
+                                    string_compose ("\tPre-read %1 (%2 .. %3): new tracker\n",
+                                                    mr->name(), mr->position(), mr->last_frame()));
+               } else {
+                       tracker = t->second;
+                       DEBUG_TRACE (DEBUG::MidiPlaylistIO,
+                                    string_compose ("\tPre-read %1 (%2 .. %3): %4 active notes\n",
+                                                    mr->name(), mr->position(), mr->last_frame(), tracker->tracker.on()));
                }
-#endif
-
-               DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("for %1 .. %2 we have %3 to consider\n", start, start+dur-1, regs.size()));
-
-               for (vector<boost::shared_ptr<Region> >::iterator i = regs.begin(); i != regs.end(); ++i) {
-                       boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*i);
-                       if (!mr) {
-                               continue;
-                       }
-
-                       NoteTrackers::iterator t = _note_trackers.find (mr.get());
-                       MidiStateTracker* tracker;
-                       bool new_tracker = false;
-
 
-                       DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("Before %1 (%2 .. %3) we now have %4 events\n", mr->name(), mr->position(), mr->last_frame(), evlist.size()));
-
-                       if (t == _note_trackers.end()) {
-                               tracker = new MidiStateTracker;
-                               new_tracker = true;
-                               DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tBEFORE: new tracker\n");
-                       } else {
-                               tracker = t->second;
-                               DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\tBEFORE: tracker says there are %1 on notes\n", tracker->on()));
+               /* Read from region into target. */
+               mr->read_at (tgt, start, dur, chan_n, _note_mode, &tracker->tracker, filter);
+               DEBUG_TRACE (DEBUG::MidiPlaylistIO,
+                            string_compose ("\tPost-read: %1 active notes\n", tracker->tracker.on()));
+
+               if (find (ended.begin(), ended.end(), *i) != ended.end()) {
+                       /* Region ended within the read range, so resolve any active notes
+                          (either stuck notes in the data, or notes that end after the end
+                          of the region). */
+                       DEBUG_TRACE (DEBUG::MidiPlaylistIO,
+                                    string_compose ("\t%1 ended, resolve notes and delete (%2) tracker\n",
+                                                    mr->name(), ((new_tracker) ? "new" : "old")));
+
+                       tracker->tracker.resolve_notes (tgt, (*i)->last_frame());
+                       if (!new_tracker) {
+                               _note_trackers.erase (t);
                        }
 
-
-                       mr->read_at (evlist, start, dur, chan_n, _note_mode, tracker);
-                       _read_data_count += mr->read_data_count();
-
-#ifndef NDEBUG
-                       DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("After %1 (%2 .. %3) we now have %4\n", mr->name(), mr->position(), mr->last_frame(), evlist.size()));
-                       for (Evoral::EventList<nframes_t>::iterator x = evlist.begin(); x != evlist.end(); ++x) {
-                               DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\t%1\n", **x));
-                       }
-                       DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\tAFTER: tracker says there are %1 on notes\n", tracker->on()));
-#endif
+               } else {
 
                        if (new_tracker) {
-                               pair<Region*,MidiStateTracker*> newpair;
-                               newpair.first = mr.get();
-                               newpair.second = tracker;
-                               _note_trackers.insert (newpair);
+                               _note_trackers.insert (make_pair (mr.get(), tracker));
                                DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tadded tracker to trackers\n");
                        }
                }
+       }
 
-               if (!evlist.empty()) {
-
-                       /* sort the event list */
-                       EventsSortByTime<nframes_t> time_cmp;
-                       evlist.sort (time_cmp);
-
-#ifndef NDEBUG
-                       DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("Final we now have %1 events\n",  evlist.size()));
-                       for (Evoral::EventList<nframes_t>::iterator x = evlist.begin(); x != evlist.end(); ++x) {
-                               DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\t%1\n", **x));
-                       }
-#endif
-                       /* write into dst */
-                       for (Evoral::EventList<nframes_t>::iterator e = evlist.begin(); e != evlist.end(); ++e) {
-                               Evoral::Event<nframes_t>* ev (*e);
-                               dst.write (ev->time(), ev->event_type(), ev->size(), ev->buffer());
-                               delete ev;
-                       }
+       if (!direct_read && !evlist.empty()) {
+               /* We've read from multiple regions, sort the event list by time. */
+               EventsSortByTimeAndType<framepos_t> cmp;
+               evlist.sort (cmp);
 
+               /* Copy ordered events from event list to dst. */
+               for (Evoral::EventList<framepos_t>::iterator e = evlist.begin(); e != evlist.end(); ++e) {
+                       Evoral::Event<framepos_t>* ev (*e);
+                       dst.write (ev->time(), ev->event_type(), ev->size(), ev->buffer());
+                       delete ev;
                }
        }
 
-       DEBUG_TRACE (DEBUG::MidiPlaylistIO, "-------------------------------------------------------------\n");
+       DEBUG_TRACE (DEBUG::MidiPlaylistIO, "---- End MidiPlaylist::read ----\n");
+       _read_end = start + dur;
        return dur;
 }
 
 void
-MidiPlaylist::clear_note_trackers ()
+MidiPlaylist::region_edited(boost::shared_ptr<Region>         region,
+                            const MidiModel::NoteDiffCommand* cmd)
 {
-       Glib::RecMutex::Lock rm (region_lock);
-       for (NoteTrackers::iterator n = _note_trackers.begin(); n != _note_trackers.end(); ++n) {
-               delete n->second;
-       }
-       _note_trackers.clear ();
-}
+       typedef MidiModel::NoteDiffCommand Command;
 
-void
-MidiPlaylist::remove_dependents (boost::shared_ptr<Region> region)
-{
-       /* MIDI regions have no dependents (crossfades) but we might be tracking notes */
-       NoteTrackers::iterator t = _note_trackers.find (region.get());
+       boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(region);
+       if (!mr || !_session.transport_rolling()) {
+               return;
+       }
 
-       /* GACK! THREAD SAFETY! */
+       /* Take write lock to prevent concurrency with read(). */
+       Playlist::RegionWriteLock lock(this);
 
-       if (t != _note_trackers.end()) {
-               delete t->second;
-               _note_trackers.erase (t);
+       NoteTrackers::iterator t = _note_trackers.find(mr.get());
+       if (t == _note_trackers.end()) {
+               return; /* Region is not currently active, nothing to do. */
        }
-}
 
+       /* Queue any necessary edit compensation events. */
+       t->second->fixer.prepare(
+               _session.tempo_map(), cmd, mr->position() - mr->start(),
+               _read_end, mr->midi_source()->model()->active_notes());
+}
 
 void
-MidiPlaylist::refresh_dependents (boost::shared_ptr<Region> /*r*/)
+MidiPlaylist::reset_note_trackers ()
 {
-       /* MIDI regions have no dependents (crossfades) */
+       Playlist::RegionWriteLock rl (this, false);
+
+       DEBUG_TRACE (DEBUG::MidiTrackers, string_compose ("%1 reset all note trackers\n", name()));
+       _note_trackers.clear ();
 }
 
 void
-MidiPlaylist::finalize_split_region (boost::shared_ptr<Region> /*original*/, boost::shared_ptr<Region> /*left*/, boost::shared_ptr<Region> /*right*/)
+MidiPlaylist::resolve_note_trackers (Evoral::EventSink<framepos_t>& dst, framepos_t time)
 {
-       /* No MIDI crossfading (yet?), so nothing to do here */
+       Playlist::RegionWriteLock rl (this, false);
+
+       for (NoteTrackers::iterator n = _note_trackers.begin(); n != _note_trackers.end(); ++n) {
+               n->second->tracker.resolve_notes(dst, time);
+       }
+       DEBUG_TRACE (DEBUG::MidiTrackers, string_compose ("%1 resolve all note trackers\n", name()));
+       _note_trackers.clear ();
 }
 
 void
-MidiPlaylist::check_dependents (boost::shared_ptr<Region> /*r*/, bool /*norefresh*/)
+MidiPlaylist::remove_dependents (boost::shared_ptr<Region> region)
 {
-       /* MIDI regions have no dependents (crossfades) */
+       /* MIDI regions have no dependents (crossfades) but we might be tracking notes */
+       _note_trackers.erase(region.get());
 }
 
-
 int
 MidiPlaylist::set_state (const XMLNode& node, int version)
 {
        in_set_state++;
        freeze ();
 
-       Playlist::set_state (node, version);
+       if (Playlist::set_state (node, version)) {
+               return -1;
+       }
 
        thaw();
        in_set_state--;
@@ -367,7 +336,7 @@ MidiPlaylist::destroy_region (boost::shared_ptr<Region> region)
        bool changed = false;
 
        {
-               RegionLock rlock (this);
+               RegionWriteLock rlock (this);
                RegionList::iterator i;
                RegionList::iterator tmp;
 
@@ -401,8 +370,7 @@ MidiPlaylist::contained_automation()
           its OK to block (for short intervals).
        */
 
-       Glib::RecMutex::Lock rm (region_lock);
-
+       Playlist::RegionReadLock rl (this);
        set<Evoral::Parameter> ret;
 
        for (RegionList::const_iterator r = regions.begin(); r != regions.end(); ++r) {
@@ -410,30 +378,11 @@ MidiPlaylist::contained_automation()
 
                for (Automatable::Controls::iterator c = mr->model()->controls().begin();
                                c != mr->model()->controls().end(); ++c) {
-                       ret.insert(c->first);
+                       if (c->second->list()->size() > 0) {
+                               ret.insert(c->first);
+                       }
                }
        }
 
        return ret;
 }
-
-
-bool
-MidiPlaylist::region_changed (const PBD::PropertyChange& what_changed, boost::shared_ptr<Region> region)
-{
-       if (in_flush || in_set_state) {
-               return false;
-       }
-
-       PBD::PropertyChange our_interests;
-        our_interests.add (Properties::midi_data);
-
-       bool parent_wants_notify = Playlist::region_changed (what_changed, region);
-
-       if (parent_wants_notify || what_changed.contains (our_interests)) {
-               notify_contents_changed ();
-       }
-
-       return true;
-}
-