Wrap MusicalTime in a class.
[ardour.git] / libs / evoral / evoral / Sequence.hpp
index 1ad456b30274a33654f8f2ea3ad3d37c4dc0d866..e40c4da925f7c3ce23db3081f496de17d4c9738d 100644 (file)
@@ -1,5 +1,5 @@
 /* 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
 #include <list>
 #include <utility>
 #include <boost/shared_ptr.hpp>
-#include <glibmm/thread.h>
+#include <glibmm/threads.h>
+
+#include "evoral/visibility.h"
 #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 {
 
@@ -41,7 +44,7 @@ template<typename Time> class Event;
 
 /** An iterator over (the x axis of) a 2-d double coordinate space.
  */
-class ControlIterator {
+class /*LIBEVORAL_API*/ ControlIterator {
 public:
        ControlIterator(boost::shared_ptr<const ControlList> al, double ax, double ay)
                : list(al)
@@ -59,34 +62,34 @@ public:
  * notes (instead of just unassociated note on/off events) and controller data.
  * Controller data is represented as a list of time-stamped float values. */
 template<typename Time>
-class Sequence : virtual public ControlSet {
+class LIBEVORAL_API Sequence : virtual public ControlSet {
 public:
        Sequence(const TypeMap& type_map);
-        Sequence(const Sequence<Time>& other);
+       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(Glib::Threads::RWLock& s, Glib::Threads::Mutex& c)
+                       : sequence_lock(new Glib::Threads::RWLock::WriterLock(s))
+                       , control_lock(new Glib::Threads::Mutex::Lock(c)) { }
                ~WriteLockImpl() {
                        delete sequence_lock;
                        delete control_lock;
                }
-               Glib::RWLock::WriterLock* sequence_lock;
-               Glib::Mutex::Lock*        control_lock;
+               Glib::Threads::RWLock::WriterLock* sequence_lock;
+               Glib::Threads::Mutex::Lock*        control_lock;
        };
 
 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 typename boost::shared_ptr<Evoral::Note<Time> >  NotePtr;
+       typedef typename boost::shared_ptr<const Evoral::Note<Time> >  constNotePtr;
+
+       typedef boost::shared_ptr<Glib::Threads::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)); }
+       virtual ReadLock  read_lock() const { return ReadLock(new Glib::Threads::RWLock::ReaderLock(_lock)); }
+        virtual WriteLock write_lock()      { return WriteLock(new WriteLockImpl(_lock, _control_lock)); }
 
        void clear();
 
@@ -95,12 +98,19 @@ public:
 
        void start_write();
        bool writing() const { return _writing; }
-       void end_write(bool delete_stuck=false);
 
-       void append(const Event<Time>& ev);
+       enum StuckNoteOption {
+               Relax,
+               DeleteStuckNotes,
+               ResolveStuckNotes
+       };
+
+       void end_write (StuckNoteOption, Time when = Time());
+
+       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 && ControlSet::controls_empty(); }
+       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<Time> >& a,
                                                const boost::shared_ptr< const Note<Time> >& b) {
@@ -141,50 +151,74 @@ public:
        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;
+       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 typename Sequence<Time>::Notes& n);
+
+       typedef boost::shared_ptr< Event<Time> > SysExPtr;
+       typedef boost::shared_ptr<const Event<Time> > constSysExPtr;
+
+       struct EarlierSysExComparator {
+               inline bool operator() (constSysExPtr a, constSysExPtr b) const {
+                       return a->time() < b->time();
+               }
+       };
+
+       typedef std::multiset<SysExPtr, EarlierSysExComparator> 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 {
+       class LIBEVORAL_API /* Added by JE - */ const_iterator {
        public:
                const_iterator();
-               const_iterator(const Sequence<Time>& seq, Time t, std::set<Evoral::Parameter> const &);
+               const_iterator(const Sequence<Time>& seq, Time t, bool, std::set<Evoral::Parameter> const &);
                ~const_iterator();
 
                inline bool valid() const { return !_is_end && _event; }
@@ -207,26 +241,44 @@ public:
                friend class Sequence<Time>;
 
                typedef std::vector<ControlIterator> ControlIterators;
-               enum MIDIMessageType { NIL, NOTE_ON, NOTE_OFF, CONTROL, SYSEX };
-
-               const Sequence<Time>*            _seq;
-               boost::shared_ptr< Event<Time> > _event;
-               mutable ActiveNotes              _active_notes;
-               MIDIMessageType                  _type;
-               bool                             _is_end;
-               typename Sequence::ReadLock      _lock;
-               typename Notes::const_iterator   _note_iter;
-               typename SysExes::const_iterator _sysex_iter;
-               ControlIterators                 _control_iters;
-               ControlIterators::iterator       _control_iter;
+               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, std::set<Evoral::Parameter> const & f = std::set<Evoral::Parameter> ()) const {
-               return const_iterator (*this, t, f);
+       const_iterator begin (
+               Time t = Time(),
+               bool force_discrete = false,
+               std::set<Evoral::Parameter> const & f = std::set<Evoral::Parameter> ()) const {
+               return const_iterator (*this, t, force_discrete, f);
        }
-       const const_iterator& end()           const { return _end_iter; }
 
+       const const_iterator& end() const { return _end_iter; }
+
+       // CONST iterator implementations (x3)
        typename Notes::const_iterator note_lower_bound (Time t) const;
+       typename PatchChanges::const_iterator patch_change_lower_bound (Time t) const;
+       typename SysExes::const_iterator sysex_lower_bound (Time t) const;
+
+       // NON-CONST iterator implementations (x3)
+       typename Notes::iterator note_lower_bound (Time t);
+       typename PatchChanges::iterator patch_change_lower_bound (Time t);
+       typename SysExes::iterator sysex_lower_bound (Time t);
 
        bool control_to_midi_event(boost::shared_ptr< Event<Time> >& ev,
                                   const ControlIterator&            iter) const;
@@ -234,57 +286,70 @@ public:
        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 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);
+       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);
+
+       void add_sysex_unlocked (const SysExPtr);
+       void remove_sysex_unlocked (const SysExPtr);
+
        uint8_t lowest_note()  const { return _lowest_note; }
        uint8_t highest_note() const { return _highest_note; }
 
 
 protected:
        bool                   _edited;
-        bool                   _overlapping_pitches_accepted;
-        OverlapPitchResolution _overlap_pitch_resolution;
-       mutable Glib::RWLock   _lock;
+       bool                   _overlapping_pitches_accepted;
+       OverlapPitchResolution _overlap_pitch_resolution;
+       mutable Glib::Threads::RWLock   _lock;
        bool                   _writing;
 
-        virtual int resolve_overlaps_unlocked (const NotePtr, void* arg = 0) {
-                return 0;
-        }
+       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]; }
+       inline const Pitches& pitches(uint8_t chan) const { return _pitches[chan&0xf]; }
+
+       virtual void control_list_marked_dirty ();
 
 private:
        friend class const_iterator;
 
-        bool overlaps_unlocked (const NotePtr& ev, const NotePtr& ignore_this_note) const;
-        bool contains_unlocked (const NotePtr& ev) const;
+       bool overlaps_unlocked (const NotePtr& ev, const NotePtr& ignore_this_note) const;
+       bool contains_unlocked (const NotePtr& ev) const;
 
-        void append_note_on_unlocked (NotePtr);
-        void append_note_off_unlocked(NotePtr);
-       void append_control_unlocked(const Parameter& param, Time time, double value);
-       void append_sysex_unlocked(const MIDIEvent<Time>& ev);
+       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 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;
 
        const TypeMap& _type_map;
 
-        Notes   _notes;       // notes indexed by time
-        Pitches _pitches[16]; // notes indexed by channel+pitch
-       SysExes _sysexes;
+       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];
 
-       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;
        bool                   _percussive;
@@ -296,5 +361,8 @@ private:
 
 } // namespace Evoral
 
+template<typename Time> /*LIBEVORAL_API*/ std::ostream& operator<<(std::ostream& o, const Evoral::Sequence<Time>& s) { s.dump (o); return o; }
+
+
 #endif // EVORAL_SEQUENCE_HPP