Move EventRingBuffer to libardour.
[ardour.git] / libs / ardour / midi_playlist.cc
index f09a62119d4379aae35e67882ad866a5ac448381..36b6fce75fa60d3cda434d0655e99b694c82d4df 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
 
 #include <algorithm>
 #include <iostream>
+#include <utility>
 
 #include <stdlib.h>
-#include <sigc++/bind.h>
 
 #include "evoral/EventList.hpp"
 
 #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/session.h"
-#include "ardour/midi_ring_buffer.h"
-
-#include "pbd/error.h"
+#include "ardour/midi_state_tracker.h"
+#include "ardour/types.h"
 
 #include "i18n.h"
 
 using namespace ARDOUR;
-using namespace sigc;
+using namespace PBD;
 using namespace std;
 
 MidiPlaylist::MidiPlaylist (Session& session, const XMLNode& node, bool hidden)
        : Playlist (session, node, DataType::MIDI, hidden)
        , _note_mode(Sustained)
 {
+#ifndef NDEBUG
        const XMLProperty* 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)
 {
 }
 
 MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, string name, bool hidden)
        : Playlist (other, name, hidden)
+       , _note_mode(other->_note_mode)
 {
 }
 
-MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, nframes_t start, nframes_t dur, string name, bool hidden)
-               : Playlist (other, start, dur, name, 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)
 {
        /* this constructor does NOT notify others (session) */
 }
 
 MidiPlaylist::~MidiPlaylist ()
 {
-       GoingAway (); /* EMIT SIGNAL */
-
-       /* drop connections to signals */
-
-       notify_callbacks ();
 }
 
-struct RegionSortByLayer {
-    bool operator() (boost::shared_ptr<Region> a, boost::shared_ptr<Region> b) {
-           return a->layer() < b->layer();
-    }
-};
-
 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)
 {
        /* 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));
+       Playlist::RegionReadLock rl (this);
 
-       nframes_t end = start + dur - 1;
+       DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("++++++ %1 .. %2  +++++++ %3 trackers +++++++++++++++++\n", 
+                                                           start, start + dur, _note_trackers.size()));
 
-       _read_data_count = 0;
+       framepos_t end = start + dur - 1;
 
        // relevent regions overlapping start <--> end
        vector< boost::shared_ptr<Region> > regs;
-       typedef pair<MidiStateTracker*,nframes64_t> TrackerInfo;
+       vector< boost::shared_ptr<Region> > ended;
+       typedef pair<MidiStateTracker*,framepos_t> TrackerInfo;
        vector<TrackerInfo> tracker_info;
-       uint32_t note_cnt = 0;
+       NoteTrackers::iterator t;
 
        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.
-                               */
-                               
-                               tracker_info.push_back (TrackerInfo (t->second, (*i)->last_frame()));
-                               DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("time to resolve & remove tracker for %1\n", (*i)->name()));
-                               note_cnt += (t->second->on());
-                               _note_trackers.erase (t);
-                       }
-               }
-       }
 
-       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;
+               /* in this call to coverage, the return value indicates the
+                * overlap status of the read range (start...end) WRT to 
+                * the region.
+                */
+
+               switch ((*i)->coverage (start, end)) {
+               case Evoral::OverlapStart:
+               case Evoral::OverlapInternal:
+               case Evoral::OverlapExternal:
+                       regs.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()) {
-       
+
+       if (regs.size() == 1 && 
+           (ended.empty() || (ended.size() == 1 && ended.front() == regs.front()))) {
+
                /* 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()));
-               
+               DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("Single region (%1) read, ended during this read %2\n", regs.front()->name(),
+                                                                   ended.size()));
+
                boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(regs.front());
 
                if (mr) {
@@ -163,52 +166,47 @@ MidiPlaylist::read (MidiRingBuffer<nframes_t>& dst, nframes_t start, nframes_t d
                                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", tracker->on()));
+                               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", 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");
-                       }
+                       DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\tAFTER: tracker says there are %1 on notes\n", tracker->on()));
 
-                       _read_data_count += mr->read_data_count();
+                       if (!ended.empty()) {
+                               DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\t%1 ended in this read, resolve notes and delete (%2) tracker\n",
+                                                                                   mr->name(), ((new_tracker) ? "new" : "old")));
+                               tracker->resolve_notes (dst, mr->last_frame());
+                               delete tracker;
+                               if (!new_tracker) {
+                                       _note_trackers.erase (t);
+                               }
+                       } else {
+                               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");
+                               }
+                       }
                }
-               
+
        } else {
 
-               /* multiple regions and/or note resolution: sort by layer, read into a temporary non-monotonically 
+               /* 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;
-               }
-               
-               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_STR_SET(a,**x);
-                       DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\t%1\n", DEBUG_STR(a)));
-               }                       
-               
-               RegionSortByLayer layer_cmp;
-               sort(regs.begin(), regs.end(), layer_cmp);
-               
+               Evoral::EventList<framepos_t> evlist;
+
                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;
                        }
@@ -217,7 +215,6 @@ MidiPlaylist::read (MidiRingBuffer<nframes_t>& dst, nframes_t start, nframes_t d
                        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()) {
@@ -229,44 +226,60 @@ MidiPlaylist::read (MidiRingBuffer<nframes_t>& dst, nframes_t start, nframes_t d
                                DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\tBEFORE: tracker says there are %1 on notes\n", tracker->on()));
                        }
 
-                               
+
                        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_STR_SET(a,**x);
-                               DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\t%1\n", DEBUG_STR(a)));
-                       }                       
+                       for (Evoral::EventList<framepos_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
+                       if (find (ended.begin(), ended.end(), *i) != ended.end()) {
+
+                               /* the region ended within the read range, so
+                                * resolve any dangling notes (i.e. notes whose
+                                * end is beyond the end of the region).
+                                */
+                               
+                               DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\t%1 ended in this read, resolve notes and delete (%2) tracker\n",
+                                                                                   mr->name(), ((new_tracker) ? "new" : "old")));
 
-                       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");
-                       } 
+                               tracker->resolve_notes (evlist, (*i)->last_frame());
+                               delete tracker;
+                               if (!new_tracker) {
+                                       _note_trackers.erase (t);
+                               }
+
+                       } else {
+
+                               if (new_tracker) {
+                                       _note_trackers.insert (make_pair (mr.get(), tracker));
+                                       DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tadded tracker to trackers\n");
+                               }
+                       }
                }
 
-               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_STR_SET(a,**x);
-                       DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\t%1\n", DEBUG_STR(a)));
-               }                       
-               
                if (!evlist.empty()) {
-               
+
                        /* sort the event list */
-                       EventsSortByTime<nframes_t> time_cmp;
-                       evlist.sort (time_cmp);
-                       
+                       EventsSortByTimeAndType<framepos_t> cmp;
+                       evlist.sort (cmp);
+
+#ifndef NDEBUG
+                       DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("Final we now have %1 events\n",  evlist.size()));
+                       for (Evoral::EventList<framepos_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);
+                       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;
                        }
+
                }
        }
 
@@ -274,6 +287,18 @@ MidiPlaylist::read (MidiRingBuffer<nframes_t>& dst, nframes_t start, nframes_t d
        return dur;
 }
 
+void
+MidiPlaylist::clear_note_trackers ()
+{
+       Playlist::RegionWriteLock rl (this, false);
+
+       for (NoteTrackers::iterator n = _note_trackers.begin(); n != _note_trackers.end(); ++n) {
+               delete n->second;
+       }
+       DEBUG_TRACE (DEBUG::MidiTrackers, string_compose ("%1 clears all note trackers\n", name()));
+       _note_trackers.clear ();
+}
+
 void
 MidiPlaylist::remove_dependents (boost::shared_ptr<Region> region)
 {
@@ -288,33 +313,15 @@ MidiPlaylist::remove_dependents (boost::shared_ptr<Region> region)
        }
 }
 
-
-void
-MidiPlaylist::refresh_dependents (boost::shared_ptr<Region> /*r*/)
-{
-       /* MIDI regions have no dependents (crossfades) */
-}
-
-void
-MidiPlaylist::finalize_split_region (boost::shared_ptr<Region> /*original*/, boost::shared_ptr<Region> /*left*/, boost::shared_ptr<Region> /*right*/)
-{
-       /* No MIDI crossfading (yet?), so nothing to do here */
-}
-
-void
-MidiPlaylist::check_dependents (boost::shared_ptr<Region> /*r*/, bool /*norefresh*/)
-{
-       /* MIDI regions have no dependents (crossfades) */
-}
-
-
 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--;
@@ -347,17 +354,15 @@ bool
 MidiPlaylist::destroy_region (boost::shared_ptr<Region> region)
 {
        boost::shared_ptr<MidiRegion> r = boost::dynamic_pointer_cast<MidiRegion> (region);
-       bool changed = false;
 
-       if (r == 0) {
-               PBD::fatal << _("programming error: non-midi Region passed to remove_overlap in midi playlist")
-               << endmsg;
-               /*NOTREACHED*/
+       if (!r) {
                return false;
        }
 
+       bool changed = false;
+
        {
-               RegionLock rlock (this);
+               RegionWriteLock rlock (this);
                RegionList::iterator i;
                RegionList::iterator tmp;
 
@@ -391,8 +396,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) {
@@ -409,27 +413,19 @@ MidiPlaylist::contained_automation()
 
 
 bool
-MidiPlaylist::region_changed (Change what_changed, boost::shared_ptr<Region> region)
+MidiPlaylist::region_changed (const PBD::PropertyChange& what_changed, boost::shared_ptr<Region> region)
 {
        if (in_flush || in_set_state) {
                return false;
        }
 
-       // Feeling rather uninterested today, but thanks for the heads up anyway!
-
-       Change our_interests = Change (/*MidiRegion::FadeInChanged|
-                                      MidiRegion::FadeOutChanged|
-                                      MidiRegion::FadeInActiveChanged|
-                                      MidiRegion::FadeOutActiveChanged|
-                                      MidiRegion::EnvelopeActiveChanged|
-                                      MidiRegion::ScaleAmplitudeChanged|
-                                      MidiRegion::EnvelopeChanged*/);
-       bool parent_wants_notify;
+       PBD::PropertyChange our_interests;
+       our_interests.add (Properties::midi_data);
 
-       parent_wants_notify = Playlist::region_changed (what_changed, region);
+       bool parent_wants_notify = Playlist::region_changed (what_changed, region);
 
-       if ((parent_wants_notify || (what_changed & our_interests))) {
-               notify_modified ();
+       if (parent_wants_notify || what_changed.contains (our_interests)) {
+               notify_contents_changed ();
        }
 
        return true;