Trim dependence on evoral types.hpp and Beats.hpp
[ardour.git] / libs / ardour / ardour / midi_playlist.h
index 3162debbd5489a1eb13211dc9d54f4c09ae27dee..a84c4648018ddfbd879c65d1db214741d39024f0 100644 (file)
@@ -1,17 +1,17 @@
 /*
-    Copyright (C) 2006 Paul Davis 
-       Written by Dave Robillard, 2006
+    Copyright (C) 2006 Paul Davis
+    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
     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 <vector>
 #include <list>
 
-#include <ardour/ardour.h>
-#include <ardour/playlist.h>
+#include <boost/utility.hpp>
+
+#include "ardour/ardour.h"
+#include "ardour/midi_model.h"
+#include "ardour/midi_state_tracker.h"
+#include "ardour/note_fixer.h"
+#include "ardour/playlist.h"
+#include "evoral/Note.hpp"
+#include "evoral/Parameter.hpp"
+
+namespace Evoral {
+template<typename Time> class EventSink;
+class                         Beats;
+}
 
 namespace ARDOUR
 {
 
-class Session;
-class Region;
+class BeatsFramesConverter;
+class MidiChannelFilter;
 class MidiRegion;
+class Session;
 class Source;
-class MidiRingBuffer;
 
-class MidiPlaylist : public ARDOUR::Playlist
+template<typename T> class MidiRingBuffer;
+
+class LIBARDOUR_API MidiPlaylist : public ARDOUR::Playlist
 {
 public:
        MidiPlaylist (Session&, const XMLNode&, bool hidden = false);
-       MidiPlaylist (Session&, string name, bool hidden = false);
-       MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, string name, bool hidden = false);
-       MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, nframes_t start, nframes_t cnt,
-                     string name, bool hidden = false);
+       MidiPlaylist (Session&, std::string name, bool hidden = false);
+       MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, std::string name, bool hidden = false);
 
-       ~MidiPlaylist ();
+       /** This constructor does NOT notify others (session) */
+       MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other,
+                     framepos_t                            start,
+                     framecnt_t                            cnt,
+                     std::string                           name,
+                     bool                                  hidden = false);
 
-       nframes_t read (MidiRingBuffer& buf,
-                       nframes_t start, nframes_t cnt, uint32_t chan_n=0);
+       ~MidiPlaylist ();
 
-       int set_state (const XMLNode&);
-       UndoAction get_memento() const;
+       /** Read a range from the playlist into an event sink.
+        *
+        * @param buf Destination for events.
+        * @param start First frame of read range.
+        * @param cnt Number of frames in read range.
+        * @param chan_n Must be 0 (this is the audio-style "channel", where each
+        * channel is backed by a separate region, not MIDI channels, which all
+        * exist in the same region and are not handled here).
+        * @return The number of frames read (time, not an event count).
+        */
+       framecnt_t read (Evoral::EventSink<framepos_t>& buf,
+                        framepos_t                     start,
+                        framecnt_t                     cnt,
+                        uint32_t                       chan_n = 0,
+                        MidiChannelFilter*             filter = NULL);
+
+       int set_state (const XMLNode&, int version);
 
        bool destroy_region (boost::shared_ptr<Region>);
 
-protected:
+       void set_note_mode (NoteMode m) { _note_mode = m; }
+
+       std::set<Evoral::Parameter> contained_automation();
+
+       /** Handle a region edit during read.
+        *
+        * This must be called before the command is applied to the model.  Events
+        * are injected into the playlist output to compensate for edits to active
+        * notes and maintain coherent output and tracker state.
+        */
+       void region_edited(boost::shared_ptr<Region>         region,
+                          const MidiModel::NoteDiffCommand* cmd);
+
+       /** Clear all note trackers. */
+       void reset_note_trackers ();
 
-       /* playlist "callbacks" */
+       /** Resolve all pending notes and clear all note trackers.
+        *
+        * @param dst Sink to write note offs to.
+        * @param time Time stamp of all written note offs.
+        */
+       void resolve_note_trackers (Evoral::EventSink<framepos_t>& dst, framepos_t time);
 
-       void finalize_split_region (boost::shared_ptr<Region> original, boost::shared_ptr<Region> left, boost::shared_ptr<Region> right);
-       
-       void check_dependents (boost::shared_ptr<Region> region, bool norefresh);
-       void refresh_dependents (boost::shared_ptr<Region> region);
+protected:
        void remove_dependents (boost::shared_ptr<Region> region);
 
 private:
+       typedef Evoral::Note<Evoral::Beats> Note;
+       typedef Evoral::Event<framepos_t>   Event;
+
+       struct RegionTracker : public boost::noncopyable {
+               MidiStateTracker tracker;  ///< Active note tracker
+               NoteFixer        fixer;    ///< Edit compensation
+       };
+
+       typedef std::map< Region*, boost::shared_ptr<RegionTracker> > NoteTrackers;
+
        void dump () const;
 
-       bool region_changed (Change, boost::shared_ptr<Region>);
+       NoteTrackers _note_trackers;
+       NoteMode     _note_mode;
+       framepos_t   _read_end;
 };
 
 } /* namespace ARDOUR */