Remove unused (and weirdly typed) time parameter from begin_write.
[ardour.git] / libs / evoral / evoral / Sequence.hpp
index ef3ad39fc1129f014a9aa8a6baf384f0bf1637e9..c972df3b29c87e8a6e8fd4b250f325fc65126f83 100644 (file)
 #include <map>
 #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"
 
 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);
+       Sequence(const TypeMap& type_map, size_t size=0);
        
+       bool read_locked() { return _read_iter.locked(); }
+
        void write_lock();
        void write_unlock();
 
@@ -80,48 +80,54 @@ public:
        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;
+       size_t read(EventSink<Time>& dst,
+                   timestamp_t   start,
+                   timedur_t     length,
+                   timestamp_t   stamp_offset) const;
 
        /** Resizes vector if necessary (NOT realtime safe) */
-       void append(const Event& ev);
+       void append(const Event<Time>& 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]; }
+       inline const boost::shared_ptr< const Note<Time> > note_at(unsigned i) const { return _notes[i]; }
+       inline const boost::shared_ptr< Note<Time> >       note_at(unsigned i)       { return _notes[i]; }
 
        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.size() == 0 && ControlSet::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 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::vector< boost::shared_ptr< Note<Time> > > Notes;
        inline       Notes& notes()       { return _notes; }
        inline const Notes& notes() const { return _notes; }
 
+       // useful for storing SysEx / Meta events
+       typedef std::vector< boost::shared_ptr< Event<Time> > > SysExes;
+       inline       SysExes& sysexes()       { return _sysexes; }
+       inline const SysExes& sysexes() const { return _sysexes; }
+
        /** Read iterator */
        class const_iterator {
        public:
-               const_iterator(const Sequence& seq, double t);
+               const_iterator(const Sequence<Time>& seq, Time t);
                ~const_iterator();
 
+               inline bool valid() const { return !_is_end && _event; }
                inline bool locked() const { return _locked; }
 
-               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;
@@ -130,59 +136,71 @@ public:
                const_iterator& operator=(const const_iterator& other);
 
        private:
-               friend class Sequence;
+               friend class Sequence<Time>;
+               
+               enum MIDIMessageType { NIL, NOTE_ON, NOTE_OFF, CONTROL, SYSEX };
 
-               const Sequence*          _seq;
-               boost::shared_ptr<Event> _event;
+               const Sequence<Time>*            _seq;
+               boost::shared_ptr< Event<Time> > _event;
 
-               typedef std::priority_queue< boost::shared_ptr<Note>,
-                                            std::deque< boost::shared_ptr<Note> >,
+               typedef std::priority_queue< boost::shared_ptr< Note<Time> >,
+                                            std::deque< boost::shared_ptr< Note<Time> > >,
                                             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;
+               typedef std::vector<ControlIterator> ControlIterators;
+
+               bool                             _is_end;
+               bool                             _locked;
+               typename Notes::const_iterator   _note_iter;
+               typename SysExes::const_iterator _sysex_iter;
+               ControlIterators                 _control_iters;
+               ControlIterators::iterator       _control_iter;
        };
        
-       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;
+       const_iterator        begin(Time t=0) const { return const_iterator(*this, t); }
+       const const_iterator& end()        const { return _end_iter; }
        
-       typedef std::map< Parameter, boost::shared_ptr<Control> > Controls;
-       Controls&       controls()       { return _controls; }
-       const Controls& controls() const { return _controls; }
+       void         read_seek(Time t)    { _read_iter = begin(t); }
+       Time         read_time() const    { return _read_iter.valid() ? _read_iter->time() : 0.0; }
+
+       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; }
+
+#ifndef NDEBUG
+       bool is_sorted() const;
+#endif
        
-protected:
-       void add_note_unlocked(const boost::shared_ptr<Note> note);
-       void remove_note_unlocked(const boost::shared_ptr<const Note> note);
+       void add_note_unlocked(const boost::shared_ptr< Note<Time> > note);
+       void remove_note_unlocked(const boost::shared_ptr< const Note<Time> > note);
        
+       uint8_t lowest_note()  const { return _lowest_note; }
+       uint8_t highest_note() const { return _highest_note; }
+       
+protected:
        mutable const_iterator _read_iter;
        bool                   _edited;
-#ifndef NDEBUG
-       bool is_sorted() const;
-#endif
 
 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(Parameter param, double time, double value);
+       void append_note_on_unlocked(uint8_t chan, Time time, uint8_t note, uint8_t velocity);
+       void append_note_off_unlocked(uint8_t chan, Time time, uint8_t note);
+       void append_control_unlocked(const Parameter& param, Time time, double value);
+       void append_sysex_unlocked(const MIDIEvent<Time>& ev);
 
        mutable Glib::RWLock _lock;
 
-       Notes    _notes;
-       Controls _controls;
+       const TypeMap& _type_map;
+       
+       Notes _notes;
+       
+       SysExes _sysexes;
        
        typedef std::vector<size_t> WriteNotes;
        WriteNotes _write_notes[16];
@@ -192,23 +210,19 @@ private:
        ControlLists _dirty_controls;
 
        const   const_iterator _end_iter;
-       mutable nframes_t      _next_read;
+       mutable FrameTime      _next_read;
        bool                   _percussive;
 
-       /** FIXME: Make fully dynamic, map to URIs */
-       enum EventTypes {
-               midi_cc_type,
-               midi_pc_type,
-               midi_pb_type,
-               midi_ca_type
-       };
+       uint8_t _lowest_note;
+       uint8_t _highest_note;
 
        typedef std::priority_queue<
-                       boost::shared_ptr<Note>, std::deque< boost::shared_ptr<Note> >,
+                       boost::shared_ptr< Note<Time> >, std::deque< boost::shared_ptr< Note<Time> > >,
                        LaterNoteEndComparator>
                ActiveNotes;
 };
 
+
 } // namespace Evoral
 
 #endif // EVORAL_SEQUENCE_HPP