initial pass at session-renaming functionality
[ardour.git] / libs / evoral / evoral / Sequence.hpp
index 10a61704ed1a835f282e8e26e0a97797e7cefea1..298ef48e52ec979e75c6a035fbdbdf79d9e188ac 100644 (file)
@@ -1,16 +1,16 @@
 /* This file is part of Evoral.
- * Copyright (C) 2008 Dave Robillard <http://drobilla.net>
+ * Copyright (C) 2008 David Robillard <http://drobilla.net>
  * Copyright (C) 2000-2008 Paul Davis
- * 
+ *
  * Evoral 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.
- * 
+ *
  * Evoral 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 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.,
  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 #include <vector>
 #include <queue>
-#include <deque>
-#include <map>
+#include <set>
+#include <list>
 #include <utility>
 #include <boost/shared_ptr.hpp>
-#include <boost/utility.hpp>
 #include <glibmm/thread.h>
-#include <evoral/types.hpp>
-#include <evoral/Note.hpp>
-#include <evoral/Parameter.hpp>
-#include <evoral/ControlSet.hpp>
+#include "evoral/types.hpp"
+#include "evoral/Note.hpp"
+#include "evoral/Parameter.hpp"
+#include "evoral/ControlSet.hpp"
+#include "evoral/ControlList.hpp"
+#include "evoral/PatchChange.hpp"
 
 namespace Evoral {
 
-class EventSink;
-class Note;
-class Event;
-class ControlList;
+class TypeMap;
+template<typename Time> class EventSink;
+template<typename Time> class Note;
+template<typename Time> class Event;
 
-/** This class keeps track of the current x and y for a control
+/** An iterator over (the x axis of) a 2-d double coordinate space.
  */
 class ControlIterator {
 public:
+       ControlIterator(boost::shared_ptr<const ControlList> al, double ax, double ay)
+               : list(al)
+               , x(ax)
+               , y(ay)
+       {}
+
        boost::shared_ptr<const ControlList> list;
        double x;
        double y;
-       
-       ControlIterator(boost::shared_ptr<const ControlList> a_list,
-                       double a_x,
-                       double a_y)
-               : list(a_list)
-               , x(a_x)
-               , y(a_y)
-       {}
 };
 
 
 /** This is a higher level view of events, with separate representations for
  * notes (instead of just unassociated note on/off events) and controller data.
- * Controller data is represented as a list of time-stamped float values.
- */
-class Sequence : public boost::noncopyable, virtual public ControlSet {
+ * Controller data is represented as a list of time-stamped float values. */
+template<typename Time>
+class Sequence : virtual public ControlSet {
 public:
-       Sequence(size_t size);
-       
-       void write_lock();
-       void write_unlock();
+       Sequence(const TypeMap& type_map);
+       Sequence(const Sequence<Time>& other);
+
+protected:
+       struct WriteLockImpl {
+               WriteLockImpl(Glib::RWLock& s, Glib::Mutex& c)
+                       : sequence_lock(new Glib::RWLock::WriterLock(s))
+                       , control_lock(new Glib::Mutex::Lock(c))
+               { }
+               ~WriteLockImpl() {
+                       delete sequence_lock;
+                       delete control_lock;
+               }
+               Glib::RWLock::WriterLock* sequence_lock;
+               Glib::Mutex::Lock*        control_lock;
+       };
 
-       void read_lock()   const;
-       void read_unlock() const;
+public:
+
+       typedef typename boost::shared_ptr<Evoral::Note<Time> >  NotePtr;
+       typedef typename boost::shared_ptr<const Evoral::Note<Time> >  constNotePtr;
+
+       typedef boost::shared_ptr<Glib::RWLock::ReaderLock> ReadLock;
+       typedef boost::shared_ptr<WriteLockImpl>            WriteLock;
+
+       virtual ReadLock  read_lock() const { return ReadLock(new Glib::RWLock::ReaderLock(_lock)); }
+       virtual WriteLock write_lock()      { return WriteLock(new WriteLockImpl(_lock, _control_lock)); }
 
        void clear();
 
@@ -78,138 +97,244 @@ public:
 
        void start_write();
        bool writing() const { return _writing; }
-       void end_write(bool delete_stuck=false);
-
-       size_t read(EventSink&  dst,
-                   timestamp_t start,
-                   timedur_t   length,
-                   timestamp_t stamp_offset) const;
+        void end_write (Time when=0, bool delete_stuck=false, bool resolve=false);
 
-       /** Resizes vector if necessary (NOT realtime safe) */
-       void append(const Event& ev);
-       
-       inline const boost::shared_ptr<const Note> note_at(unsigned i) const { return _notes[i]; }
-       inline const boost::shared_ptr<Note>       note_at(unsigned i)       { return _notes[i]; }
+       void append(const Event<Time>& ev, Evoral::event_id_t evid);
 
        inline size_t n_notes() const { return _notes.size(); }
-       inline bool   empty()   const { return _notes.size() == 0 && _controls.size() == 0; }
+       inline bool   empty()   const { return _notes.empty() && _sysexes.empty() && _patch_changes.empty() && ControlSet::controls_empty(); }
 
-       inline static bool note_time_comparator(const boost::shared_ptr<const Note> a,
-                                               const boost::shared_ptr<const Note> b) { 
+       inline static bool note_time_comparator(const boost::shared_ptr< const Note<Time> >& a,
+                                               const boost::shared_ptr< const Note<Time> >& b) {
                return a->time() < b->time();
        }
 
+       struct NoteNumberComparator {
+               inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
+                                      const boost::shared_ptr< const Note<Time> > b) const {
+                       return a->note() < b->note();
+               }
+       };
+
+       struct EarlierNoteComparator {
+               inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
+                                      const boost::shared_ptr< const Note<Time> > b) const {
+                       return a->time() < b->time();
+               }
+       };
+
+       struct LaterNoteComparator {
+               typedef const Note<Time>* value_type;
+               inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
+                                      const boost::shared_ptr< const Note<Time> > b) const {
+                       return a->time() > b->time();
+               }
+       };
+
        struct LaterNoteEndComparator {
-               typedef const Note* value_type;
-               inline bool operator()(const boost::shared_ptr<const Note> a,
-                                      const boost::shared_ptr<const Note> b) const { 
+               typedef const Note<Time>* value_type;
+               inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
+                                      const boost::shared_ptr< const Note<Time> > b) const {
                        return a->end_time() > b->end_time();
                }
        };
 
-       typedef std::vector< boost::shared_ptr<Note> > Notes;
+       typedef std::multiset<NotePtr, EarlierNoteComparator> Notes;
        inline       Notes& notes()       { return _notes; }
        inline const Notes& notes() const { return _notes; }
 
+       enum NoteOperator { 
+               PitchEqual,
+               PitchLessThan,
+               PitchLessThanOrEqual,
+               PitchGreater,
+               PitchGreaterThanOrEqual,
+               VelocityEqual,
+               VelocityLessThan,
+               VelocityLessThanOrEqual,
+               VelocityGreater,
+               VelocityGreaterThanOrEqual,
+       };
+
+       void get_notes (Notes&, NoteOperator, uint8_t val, int chan_mask = 0) const;
+
+       void remove_overlapping_notes ();
+       void trim_overlapping_notes ();
+       void remove_duplicate_notes ();
+
+       enum OverlapPitchResolution { 
+               LastOnFirstOff,
+               FirstOnFirstOff
+       };
+
+       bool overlapping_pitches_accepted() const { return _overlapping_pitches_accepted; }
+       void overlapping_pitches_accepted(bool yn)  { _overlapping_pitches_accepted = yn; }
+       OverlapPitchResolution overlap_pitch_resolution() const { return _overlap_pitch_resolution; }
+       void set_overlap_pitch_resolution(OverlapPitchResolution opr);
+
+       void set_notes (const Sequence<Time>::Notes& n);
+
+       typedef std::vector< boost::shared_ptr< Event<Time> > > SysExes;
+       inline       SysExes& sysexes()       { return _sysexes; }
+       inline const SysExes& sysexes() const { return _sysexes; }
+
+       typedef boost::shared_ptr<PatchChange<Time> > PatchChangePtr;
+       typedef boost::shared_ptr<const PatchChange<Time> > constPatchChangePtr;
+       
+       struct EarlierPatchChangeComparator {
+               inline bool operator() (constPatchChangePtr a, constPatchChangePtr b) const {
+                       return a->time() < b->time();
+               }
+       };
+
+       typedef std::multiset<PatchChangePtr, EarlierPatchChangeComparator> PatchChanges;
+       inline       PatchChanges& patch_changes ()       { return _patch_changes; }
+       inline const PatchChanges& patch_changes () const { return _patch_changes; }
+
+        void dump (std::ostream&) const;
+
+private:
+       typedef std::priority_queue<NotePtr, std::deque<NotePtr>, LaterNoteEndComparator> ActiveNotes;
+public:
+
        /** Read iterator */
        class const_iterator {
        public:
-               const_iterator(const Sequence& seq, double t);
+               const_iterator();
+               const_iterator(const Sequence<Time>& seq, Time t, bool, std::set<Evoral::Parameter> const &);
                ~const_iterator();
 
-               inline bool locked() const { return _locked; }
+               inline bool valid() const { return !_is_end && _event; }
+               //inline bool locked() const { return _locked; }
+
+               void invalidate();
 
-               const Event& operator*()  const { return *_event;  }
-               const boost::shared_ptr<Event> operator->() const  { return _event; }
-               const boost::shared_ptr<Event> get_event_pointer() { return _event; }
+               const Event<Time>& operator*()  const { return *_event;  }
+               const boost::shared_ptr< Event<Time> > operator->() const  { return _event; }
+               const boost::shared_ptr< Event<Time> > get_event_pointer() { return _event; }
 
                const const_iterator& operator++(); // prefix only
+
                bool operator==(const const_iterator& other) const;
                bool operator!=(const const_iterator& other) const { return ! operator==(other); }
-               
+
                const_iterator& operator=(const const_iterator& other);
 
        private:
-               friend class Sequence;
-
-               const Sequence*          _seq;
-               boost::shared_ptr<Event> _event;
-
-               typedef std::priority_queue< boost::shared_ptr<Note>,
-                                            std::deque< boost::shared_ptr<Note> >,
-                                            LaterNoteEndComparator >
-                       ActiveNotes;
-               
-               mutable ActiveNotes _active_notes;
-
-               bool                                   _is_end;
-               bool                                   _locked;
-               Notes::const_iterator                  _note_iter;
-               std::vector<ControlIterator>           _control_iters;
-               std::vector<ControlIterator>::iterator _control_iter;
+               friend class Sequence<Time>;
+
+               typedef std::vector<ControlIterator> ControlIterators;
+               enum MIDIMessageType { NIL, NOTE_ON, NOTE_OFF, CONTROL, SYSEX, PATCH_CHANGE };
+
+               const Sequence<Time>*                 _seq;
+               boost::shared_ptr< Event<Time> >      _event;
+               mutable ActiveNotes                   _active_notes;
+               /** If the iterator is pointing at a patch change, this is the index of the
+                *  sub-message within that change.
+                */
+               int                                   _active_patch_change_message;
+               MIDIMessageType                       _type;
+               bool                                  _is_end;
+               typename Sequence::ReadLock           _lock;
+               typename Notes::const_iterator        _note_iter;
+               typename SysExes::const_iterator      _sysex_iter;
+               typename PatchChanges::const_iterator _patch_change_iter;
+               ControlIterators                      _control_iters;
+               ControlIterators::iterator            _control_iter;
+               bool                                  _force_discrete;
        };
+
+       const_iterator begin (
+               Time t = 0,
+               bool force_discrete = false,
+               std::set<Evoral::Parameter> const & f = std::set<Evoral::Parameter> ()) const {
+               return const_iterator (*this, t, force_discrete, f);
+       }
        
-       const_iterator        begin() const { return const_iterator(*this, 0); }
-       const const_iterator& end()   const { return _end_iter; }
-       
-       bool control_to_midi_event(boost::shared_ptr<Event>& ev,
-                                  const ControlIterator&    iter) const;
-       
-       typedef std::map< Parameter, boost::shared_ptr<Control> > Controls;
-       Controls&       controls()       { return _controls; }
-       const Controls& controls() const { return _controls; }
-       
+       const const_iterator& end() const { return _end_iter; }
+
+       typename Notes::const_iterator note_lower_bound (Time t) const;
+       typename PatchChanges::const_iterator patch_change_lower_bound (Time t) const;
+
+       bool control_to_midi_event(boost::shared_ptr< Event<Time> >& ev,
+                                  const ControlIterator&            iter) const;
+
        bool edited() const      { return _edited; }
        void set_edited(bool yn) { _edited = yn; }
-       
+
+       bool overlaps (const NotePtr& ev, 
+                      const NotePtr& ignore_this_note) const;
+       bool contains (const NotePtr& ev) const;
+
+       bool add_note_unlocked (const NotePtr note, void* arg = 0);
+       void remove_note_unlocked(const constNotePtr note);
+
+       void add_patch_change_unlocked (const PatchChangePtr);
+       void remove_patch_change_unlocked (const constPatchChangePtr);
+
+       uint8_t lowest_note()  const { return _lowest_note; }
+       uint8_t highest_note() const { return _highest_note; }
+
+
 protected:
-       void add_note_unlocked(const boost::shared_ptr<Note> note);
-       void remove_note_unlocked(const boost::shared_ptr<const Note> note);
-       
-       mutable const_iterator _read_iter;
        bool                   _edited;
-#ifndef NDEBUG
-       bool is_sorted() const;
-#endif
+       bool                   _overlapping_pitches_accepted;
+       OverlapPitchResolution _overlap_pitch_resolution;
+       mutable Glib::RWLock   _lock;
+       bool                   _writing;
+
+       virtual int resolve_overlaps_unlocked (const NotePtr, void* /* arg */ = 0) {
+               return 0;
+       }
+
+       typedef std::multiset<NotePtr, NoteNumberComparator>  Pitches;
+       inline       Pitches& pitches(uint8_t chan)       { return _pitches[chan&0xf]; }
+       inline const Pitches& pitches(uint8_t chan) const { return _pitches[chan&0xf]; }
 
 private:
        friend class const_iterator;
-       
-       void append_note_on_unlocked(uint8_t chan, double time, uint8_t note, uint8_t velocity);
-       void append_note_off_unlocked(uint8_t chan, double time, uint8_t note);
-       void append_control_unlocked(const Parameter& param, double time, double value);
 
-       mutable Glib::RWLock _lock;
+       bool overlaps_unlocked (const NotePtr& ev, const NotePtr& ignore_this_note) const;
+       bool contains_unlocked (const NotePtr& ev) const;
 
-       Notes    _notes;
-       Controls _controls;
-       
-       typedef std::vector<size_t> WriteNotes;
+       void append_note_on_unlocked (NotePtr, Evoral::event_id_t);
+       void append_note_off_unlocked(NotePtr);
+       void append_control_unlocked(const Parameter& param, Time time, double value, Evoral::event_id_t);
+       void append_sysex_unlocked(const MIDIEvent<Time>& ev, Evoral::event_id_t);
+       void append_patch_change_unlocked (const PatchChange<Time>&, Evoral::event_id_t);
+
+       void get_notes_by_pitch (Notes&, NoteOperator, uint8_t val, int chan_mask = 0) const;
+       void get_notes_by_velocity (Notes&, NoteOperator, uint8_t val, int chan_mask = 0) const;
+
+       void control_list_marked_dirty ();
+
+       const TypeMap& _type_map;
+
+       Notes        _notes;       // notes indexed by time
+       Pitches      _pitches[16]; // notes indexed by channel+pitch
+       SysExes      _sysexes;
+       PatchChanges _patch_changes;
+
+       typedef std::multiset<NotePtr, EarlierNoteComparator> WriteNotes;
        WriteNotes _write_notes[16];
-       bool       _writing;
-       
-       typedef std::vector< boost::shared_ptr<const ControlList> > ControlLists;
-       ControlLists _dirty_controls;
+
+       /** Current bank number on each channel so that we know what
+        *  to put in PatchChange events when program changes are
+        *  seen.
+        */
+       int _bank[16];
 
        const   const_iterator _end_iter;
-       mutable nframes_t      _next_read;
        bool                   _percussive;
 
-       /** FIXME: Make fully dynamic, map to URIs */
-       enum EventTypes {
-               midi_cc_type=1,
-               midi_pc_type,
-               midi_pb_type,
-               midi_ca_type
-       };
-
-       typedef std::priority_queue<
-                       boost::shared_ptr<Note>, std::deque< boost::shared_ptr<Note> >,
-                       LaterNoteEndComparator>
-               ActiveNotes;
+       uint8_t _lowest_note;
+       uint8_t _highest_note;
 };
 
+
 } // namespace Evoral
 
+// template<typename Time> std::ostream& operator<<(std::ostream& o, const Evoral::Sequence<Time>& s) { s.dump (o); return o; }
+
 #endif // EVORAL_SEQUENCE_HPP