debug-tracify current MIDI playlist debug output
[ardour.git] / libs / ardour / midi_playlist.cc
index b2318bbe96257e74ef3135f288fe155902093259..d02079c7157dd576057f0a03168cd7444de4b4c7 100644 (file)
@@ -1,17 +1,17 @@
 /*
-    Copyright (C) 2006 Paul Davis 
-       Written by Dave Robillard, 2006
+    Copyright (C) 2006 Paul Davis
+    Written by Dave Robillard, 2006
 
     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
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
+
     This program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
+
     You should have received a copy of the GNU General Public License
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 #include <cassert>
 
 #include <algorithm>
+#include <iostream>
 
 #include <stdlib.h>
-
 #include <sigc++/bind.h>
 
-#include <ardour/types.h>
-#include <ardour/configuration.h>
-#include <ardour/midi_playlist.h>
-#include <ardour/midi_region.h>
-#include <ardour/session.h>
-#include <ardour/midi_ring_buffer.h>
+#include "evoral/EventList.hpp"
 
-#include <pbd/error.h>
+#include "ardour/debug.h"
+#include "ardour/types.h"
+#include "ardour/configuration.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 "i18n.h"
 
@@ -42,29 +45,22 @@ using namespace std;
 
 MidiPlaylist::MidiPlaylist (Session& session, const XMLNode& node, bool hidden)
                : Playlist (session, node, DataType::MIDI, hidden)
+               , _note_mode(Sustained)
 {
        const XMLProperty* prop = node.property("type");
        assert(prop && DataType(prop->value()) == DataType::MIDI);
 
-       in_set_state = true;
-       set_state (node);
-       in_set_state = false;
-
-       if (!hidden) {
-               PlaylistCreated (this); /* EMIT SIGNAL */
-       }
+       in_set_state++;
+       set_state (node, Stateful::loading_state_version);
+       in_set_state--;
 }
 
 MidiPlaylist::MidiPlaylist (Session& session, string name, bool hidden)
                : Playlist (session, name, DataType::MIDI, hidden)
 {
-       if (!hidden) {
-               PlaylistCreated (this); /* EMIT SIGNAL */
-       }
-
 }
 
-MidiPlaylist::MidiPlaylist (const MidiPlaylist& other, string name, bool hidden)
+MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, string name, bool hidden)
                : Playlist (other, name, hidden)
 {
        throw; // nope
@@ -98,7 +94,7 @@ MidiPlaylist::MidiPlaylist (const MidiPlaylist& other, string name, bool hidden)
                                        out_o++;
                                        out_n++;
                                }
-                               //                              cerr << "HUH!? second region in the crossfade not found!" << endl;
+                               // cerr << "HUH!? second region in the crossfade not found!" << endl;
                        }
                }
 
@@ -106,12 +102,9 @@ MidiPlaylist::MidiPlaylist (const MidiPlaylist& other, string name, bool hidden)
                in_n++;
        }
 */
-       if (!hidden) {
-               PlaylistCreated (this); /* EMIT SIGNAL */
-       }
 }
 
-MidiPlaylist::MidiPlaylist (const MidiPlaylist& other, jack_nframes_t start, jack_nframes_t dur, string name, bool hidden)
+MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, nframes_t start, nframes_t dur, string name, bool hidden)
                : Playlist (other, start, dur, name, hidden)
 {
        /* this constructor does NOT notify others (session) */
@@ -119,7 +112,11 @@ MidiPlaylist::MidiPlaylist (const MidiPlaylist& other, jack_nframes_t start, jac
 
 MidiPlaylist::~MidiPlaylist ()
 {
-       GoingAway (); /* EMIT SIGNAL */
+       GoingAway (); /* EMIT SIGNAL */
+
+       /* drop connections to signals */
+
+       notify_callbacks ();
 }
 
 struct RegionSortByLayer {
@@ -128,151 +125,240 @@ struct RegionSortByLayer {
     }
 };
 
+template<typename Time>
+struct EventsSortByTime {
+    bool operator() (Evoral::Event<Time>* a, Evoral::Event<Time>* b) {
+           return a->time() < b->time();
+    }
+};
+
 /** Returns the number of frames in time duration read (eg could be large when 0 events are read) */
-jack_nframes_t
-MidiPlaylist::read (MidiRingBuffer& dst, jack_nframes_t start,
-                     jack_nframes_t dur, unsigned chan_n)
+nframes_t
+MidiPlaylist::read (MidiRingBuffer<nframes_t>& dst, nframes_t start, nframes_t dur, unsigned chan_n)
 {
        /* this function is never called from a realtime thread, so
           its OK to block (for short intervals).
        */
 
-       Glib::Mutex::Lock rm (region_lock);
+       Glib::RecMutex::Lock rm (region_lock);
+       DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("++++++ %1 .. %2  +++++++++++++++++++++++++++++++++++++++++++++++\n", start, start + dur));
 
-       jack_nframes_t ret         = 0;
-       jack_nframes_t end         = start + dur - 1;
-       //jack_nframes_t read_frames = 0;
-       //jack_nframes_t skip_frames = 0;
+       nframes_t end = start + dur - 1;
 
-       //_read_data_count = 0;
+       _read_data_count = 0;
 
        // relevent regions overlapping start <--> end
-       vector<boost::shared_ptr<Region> > regs;
+       vector< boost::shared_ptr<Region> > regs;
+       typedef pair<MidiStateTracker*,nframes64_t> TrackerInfo;
+       vector<TrackerInfo> tracker_info;
+       uint32_t note_cnt = 0;
 
        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);
+                       }
                }
        }
 
-       RegionSortByLayer layer_cmp;
-       sort(regs.begin(), regs.end(), layer_cmp);
-
-       for (vector<boost::shared_ptr<Region> >::iterator i = regs.begin(); i != regs.end(); ++i) {
-               // FIXME: ensure time is monotonic here
-               boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*i);
-               mr->read_at (dst, start, dur, chan_n, 0, 0);// FIXME read_frames, skip_frames);
-               ret += mr->read_data_count();
+       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 ();
        }
-
-       _read_data_count += ret;
+                       
+       if (regs.size() == 1 && tracker_info.empty()) {
        
-       //return ret; FIXME?
-       return dur;
-}
+               /* 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());
 
-void
-MidiPlaylist::remove_dependents (boost::shared_ptr<Region> region)
-{
-}
+               if (mr) {
 
+                       NoteTrackers::iterator t = _note_trackers.find (mr.get());
+                       MidiStateTracker* tracker;
+                       bool new_tracker = false;
 
-void
-MidiPlaylist::flush_notifications ()
-{
-       Playlist::flush_notifications();
+                       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", 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");
+                       }
 
-       if (in_flush) {
-               return;
-       }
+                       _read_data_count += mr->read_data_count();
+               }
+               
+       } else {
 
-       in_flush = true;
+               /* multiple regions and/or note resolution: sort by layer, read into a temporary non-monotonically 
+                  sorted EventSink, sort and then insert into dst.
+               */
 
-       in_flush = false;
-}
+               DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("%1 regions to read, plus %2 trackers\n", regs.size(), tracker_info.size()));
+               
+               Evoral::EventList<nframes_t> evlist;
 
-void
-MidiPlaylist::refresh_dependents (boost::shared_ptr<Region> r)
-{
-}
-
-void
-MidiPlaylist::finalize_split_region (boost::shared_ptr<Region> original, boost::shared_ptr<Region> left, boost::shared_ptr<Region> right)
-{
-       throw; // I don't wanna
-       /*
-       MidiRegion *orig  = dynamic_cast<MidiRegion*>(o);
-       MidiRegion *left  = dynamic_cast<MidiRegion*>(l);
-       MidiRegion *right = dynamic_cast<MidiRegion*>(r);
+               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);
+               
+               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;
+                       }
 
-       for (Crossfades::iterator x = _crossfades.begin(); x != _crossfades.end();) {
-               Crossfades::iterator tmp;
-               tmp = x;
-               ++tmp;
+                       NoteTrackers::iterator t = _note_trackers.find (mr.get());
+                       MidiStateTracker* tracker;
+                       bool new_tracker = false;
 
-               Crossfade *fade = 0;
+                       
+                       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 ((*x)->_in == orig) {
-                       if (! (*x)->covers(right->position())) {
-                               fade = new Crossfade( *(*x), left, (*x)->_out);
+                       if (t == _note_trackers.end()) {
+                               tracker = new MidiStateTracker;
+                               new_tracker = true;
+                               DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tBEFORE: new tracker\n");
                        } else {
-                               // Overlap, the crossfade is copied on the left side of the right region instead
-                               fade = new Crossfade( *(*x), right, (*x)->_out);
+                               tracker = t->second;
+                               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();
+
+                       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)));
+                       }                       
+                       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 ((*x)->_out == orig) {
-                       if (! (*x)->covers(right->position())) {
-                               fade = new Crossfade( *(*x), (*x)->_in, right);
-                       } else {
-                               // Overlap, the crossfade is copied on the right side of the left region instead
-                               fade = new Crossfade( *(*x), (*x)->_in, left);
+               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);
+                       
+                       /* 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 (fade) {
-                       _crossfades.remove( (*x) );
-                       add_crossfade (*fade);
-               }
-               x = tmp;
-       }*/
+       DEBUG_TRACE (DEBUG::MidiPlaylistIO, "-------------------------------------------------------------\n");
+       return dur;
 }
 
 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) but we might be tracking notes */
+       NoteTrackers::iterator t = _note_trackers.find (region.get());
 
+       /* GACK! THREAD SAFETY! */
 
-int
-MidiPlaylist::set_state (const XMLNode& node)
-{
-       if (!in_set_state) {
-               Playlist::set_state (node);
+       if (t != _note_trackers.end()) {
+               delete t->second;
+               _note_trackers.erase (t);
        }
+}
 
-       // Actually Charles, I don't much care for children
-       
-       /*
-       XMLNodeList nlist = node.children();
-
-       for (XMLNodeConstIterator niter = nlist.begin(); niter != nlist.end(); ++niter) {
 
-               XMLNode* const child = *niter;
+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 */
+}
 
-       return 0;
+void
+MidiPlaylist::check_dependents (boost::shared_ptr<Region> /*r*/, bool /*norefresh*/)
+{
+       /* MIDI regions have no dependents (crossfades) */
 }
 
-XMLNode&
-MidiPlaylist::state (bool full_state)
+
+int
+MidiPlaylist::set_state (const XMLNode& node, int version)
 {
-       XMLNode& node = Playlist::state (full_state);
+       in_set_state++;
+       freeze ();
+
+       Playlist::set_state (node, version);
 
-       return node;
+       thaw();
+       in_set_state--;
+
+       return 0;
 }
 
 void
@@ -337,6 +423,30 @@ MidiPlaylist::destroy_region (boost::shared_ptr<Region> region)
        return changed;
 }
 
+set<Evoral::Parameter>
+MidiPlaylist::contained_automation()
+{
+       /* this function is never called from a realtime thread, so
+          its OK to block (for short intervals).
+       */
+
+       Glib::RecMutex::Lock rm (region_lock);
+
+       set<Evoral::Parameter> ret;
+
+       for (RegionList::const_iterator r = regions.begin(); r != regions.end(); ++r) {
+               boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*r);
+
+               for (Automatable::Controls::iterator c = mr->model()->controls().begin();
+                               c != mr->model()->controls().end(); ++c) {
+                       ret.insert(c->first);
+               }
+       }
+
+       return ret;
+}
+
+
 bool
 MidiPlaylist::region_changed (Change what_changed, boost::shared_ptr<Region> region)
 {
@@ -345,7 +455,7 @@ MidiPlaylist::region_changed (Change what_changed, boost::shared_ptr<Region> reg
        }
 
        // Feeling rather uninterested today, but thanks for the heads up anyway!
-       
+
        Change our_interests = Change (/*MidiRegion::FadeInChanged|
                                       MidiRegion::FadeOutChanged|
                                       MidiRegion::FadeInActiveChanged|