1 /* This file is part of Evoral.
2 * Copyright (C) 2008 Dave Robillard <http://drobilla.net>
3 * Copyright (C) 2000-2008 Paul Davis
5 * Evoral is free software; you can redistribute it and/or modify it under the
6 * terms of the GNU General Public License as published by the Free Software
7 * Foundation; either version 2 of the License, or (at your option) any later
10 * Evoral is distributed in the hope that it will be useful, but WITHOUT ANY
11 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 #ifndef EVORAL_SEQUENCE_HPP
20 #define EVORAL_SEQUENCE_HPP
27 #include <boost/shared_ptr.hpp>
28 #include <glibmm/thread.h>
29 #include "evoral/types.hpp"
30 #include "evoral/Note.hpp"
31 #include "evoral/Parameter.hpp"
32 #include "evoral/ControlSet.hpp"
33 #include "evoral/ControlList.hpp"
38 template<typename Time> class EventSink;
39 template<typename Time> class Note;
40 template<typename Time> class Event;
42 /** An iterator over (the x axis of) a 2-d double coordinate space.
44 class ControlIterator {
46 ControlIterator(boost::shared_ptr<const ControlList> al, double ax, double ay)
52 boost::shared_ptr<const ControlList> list;
58 /** This is a higher level view of events, with separate representations for
59 * notes (instead of just unassociated note on/off events) and controller data.
60 * Controller data is represented as a list of time-stamped float values. */
61 template<typename Time>
62 class Sequence : virtual public ControlSet {
64 Sequence(const TypeMap& type_map, size_t size=0);
66 bool read_locked() { return _read_iter.locked(); }
71 void read_lock() const;
72 void read_unlock() const;
76 bool percussive() const { return _percussive; }
77 void set_percussive(bool p) { _percussive = p; }
80 bool writing() const { return _writing; }
81 void end_write(bool delete_stuck=false);
83 /** Resizes vector if necessary (NOT realtime safe) */
84 void append(const Event<Time>& ev);
86 inline const boost::shared_ptr< const Note<Time> > note_at(size_t i) const { return _notes[i]; }
87 inline const boost::shared_ptr< Note<Time> > note_at(size_t i) { return _notes[i]; }
89 inline size_t n_notes() const { return _notes.size(); }
90 inline bool empty() const { return _notes.size() == 0 && ControlSet::empty(); }
92 inline static bool note_time_comparator(const boost::shared_ptr< const Note<Time> >& a,
93 const boost::shared_ptr< const Note<Time> >& b) {
94 return a->time() < b->time();
97 struct LaterNoteEndComparator {
98 typedef const Note<Time>* value_type;
99 inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
100 const boost::shared_ptr< const Note<Time> > b) const {
101 return a->end_time() > b->end_time();
105 typedef std::vector< boost::shared_ptr< Note<Time> > > Notes;
106 inline Notes& notes() { return _notes; }
107 inline const Notes& notes() const { return _notes; }
109 typedef std::vector< boost::shared_ptr< Event<Time> > > SysExes;
110 inline SysExes& sysexes() { return _sysexes; }
111 inline const SysExes& sysexes() const { return _sysexes; }
114 typedef std::priority_queue< boost::shared_ptr< Note<Time> >,
115 std::deque< boost::shared_ptr< Note<Time> > >,
116 LaterNoteEndComparator >
121 class const_iterator {
124 const_iterator(const Sequence<Time>& seq, Time t);
127 inline bool valid() const { return !_is_end && _event; }
128 inline bool locked() const { return _locked; }
130 const Event<Time>& operator*() const { return *_event; }
131 const boost::shared_ptr< Event<Time> > operator->() const { return _event; }
132 const boost::shared_ptr< Event<Time> > get_event_pointer() { return _event; }
134 const const_iterator& operator++(); // prefix only
136 bool operator==(const const_iterator& other) const;
137 bool operator!=(const const_iterator& other) const { return ! operator==(other); }
139 const_iterator& operator=(const const_iterator& other);
142 friend class Sequence<Time>;
144 typedef std::vector<ControlIterator> ControlIterators;
145 enum MIDIMessageType { NIL, NOTE_ON, NOTE_OFF, CONTROL, SYSEX };
147 const Sequence<Time>* _seq;
148 boost::shared_ptr< Event<Time> > _event;
149 mutable ActiveNotes _active_notes;
150 MIDIMessageType _type;
153 typename Notes::const_iterator _note_iter;
154 typename SysExes::const_iterator _sysex_iter;
155 ControlIterators _control_iters;
156 ControlIterators::iterator _control_iter;
159 const_iterator begin(Time t=0) const { return const_iterator(*this, t); }
160 const const_iterator& end() const { return _end_iter; }
162 void read_seek(Time t) { _read_iter = begin(t); }
163 Time read_time() const { return _read_iter.valid() ? _read_iter->time() : 0.0; }
165 bool control_to_midi_event(boost::shared_ptr< Event<Time> >& ev,
166 const ControlIterator& iter) const;
168 bool edited() const { return _edited; }
169 void set_edited(bool yn) { _edited = yn; }
171 void add_note_unlocked(const boost::shared_ptr< Note<Time> > note);
172 void remove_note_unlocked(const boost::shared_ptr< const Note<Time> > note);
174 uint8_t lowest_note() const { return _lowest_note; }
175 uint8_t highest_note() const { return _highest_note; }
178 mutable const_iterator _read_iter;
182 friend class const_iterator;
184 void append_note_on_unlocked(uint8_t chan, Time time, uint8_t note, uint8_t velocity);
185 void append_note_off_unlocked(uint8_t chan, Time time, uint8_t note);
186 void append_control_unlocked(const Parameter& param, Time time, double value);
187 void append_sysex_unlocked(const MIDIEvent<Time>& ev);
189 mutable Glib::RWLock _lock;
191 const TypeMap& _type_map;
196 typedef std::vector<size_t> WriteNotes;
197 WriteNotes _write_notes[16];
200 typedef std::vector< boost::shared_ptr<const ControlList> > ControlLists;
201 ControlLists _dirty_controls;
203 const const_iterator _end_iter;
206 uint8_t _lowest_note;
207 uint8_t _highest_note;
211 } // namespace Evoral
213 #endif // EVORAL_SEQUENCE_HPP