Move EventRingBuffer to libardour.
[ardour.git] / libs / ardour / midi_playlist.cc
index f2b8722ce33f5533107a00bb72668e7f302124a7..36b6fce75fa60d3cda434d0655e99b694c82d4df 100644 (file)
 
 #include <algorithm>
 #include <iostream>
+#include <utility>
 
 #include <stdlib.h>
 
-#include "pbd/error.h"
-
 #include "evoral/EventList.hpp"
 
-#include "ardour/configuration.h"
 #include "ardour/debug.h"
 #include "ardour/midi_model.h"
 #include "ardour/midi_playlist.h"
 #include "ardour/midi_region.h"
-#include "ardour/midi_ring_buffer.h"
-#include "ardour/session.h"
+#include "ardour/midi_state_tracker.h"
 #include "ardour/types.h"
 
 #include "i18n.h"
@@ -57,6 +54,8 @@ MidiPlaylist::MidiPlaylist (Session& session, const XMLNode& node, bool hidden)
                throw failed_constructor ();
        }
        in_set_state--;
+
+       relayer ();
 }
 
 MidiPlaylist::MidiPlaylist (Session& session, string name, bool hidden)
@@ -83,8 +82,17 @@ 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();
     }
 };
@@ -97,62 +105,52 @@ MidiPlaylist::read (Evoral::EventSink<framepos_t>& dst, framepos_t start, framec
           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);
 
-       framepos_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;
+       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.
-
-                                  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 < start || 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);
-                       }
+               /* 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;
                }
        }
 
-       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;
-               }
-               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());
 
@@ -174,15 +172,23 @@ MidiPlaylist::read (Evoral::EventSink<framepos_t>& dst, framepos_t start, framec
                        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");
+                       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");
+                               }
                        }
-
-                       _read_data_count += mr->read_data_count();
                }
 
        } else {
@@ -195,23 +201,12 @@ MidiPlaylist::read (Evoral::EventSink<framepos_t>& dst, framepos_t start, framec
 
                Evoral::EventList<framepos_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;
-               }
-
-#ifndef NDEBUG
-               DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("After resolution 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
-
                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;
                        }
@@ -220,7 +215,6 @@ MidiPlaylist::read (Evoral::EventSink<framepos_t>& dst, framepos_t start, framec
                        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()) {
@@ -234,7 +228,6 @@ MidiPlaylist::read (Evoral::EventSink<framepos_t>& dst, framepos_t start, framec
 
 
                        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()));
@@ -243,21 +236,36 @@ MidiPlaylist::read (Evoral::EventSink<framepos_t>& dst, framepos_t start, framec
                        }
                        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")));
+
+                               tracker->resolve_notes (evlist, (*i)->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");
+                               if (new_tracker) {
+                                       _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<framepos_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()));
@@ -282,10 +290,12 @@ MidiPlaylist::read (Evoral::EventSink<framepos_t>& dst, framepos_t start, framec
 void
 MidiPlaylist::clear_note_trackers ()
 {
-       Glib::RecMutex::Lock rm (region_lock);
+       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 ();
 }
 
@@ -303,26 +313,6 @@ 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)
 {
@@ -372,7 +362,7 @@ MidiPlaylist::destroy_region (boost::shared_ptr<Region> region)
        bool changed = false;
 
        {
-               RegionLock rlock (this);
+               RegionWriteLock rlock (this);
                RegionList::iterator i;
                RegionList::iterator tmp;
 
@@ -406,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) {