1 /* This file is part of Evoral.
2 * Copyright (C) 2008 David 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/threads.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"
34 #include "evoral/PatchChange.hpp"
39 template<typename Time> class EventSink;
40 template<typename Time> class Note;
41 template<typename Time> class Event;
43 /** An iterator over (the x axis of) a 2-d double coordinate space.
45 class ControlIterator {
47 ControlIterator(boost::shared_ptr<const ControlList> al, double ax, double ay)
53 boost::shared_ptr<const ControlList> list;
59 /** This is a higher level view of events, with separate representations for
60 * notes (instead of just unassociated note on/off events) and controller data.
61 * Controller data is represented as a list of time-stamped float values. */
62 template<typename Time>
63 class Sequence : virtual public ControlSet {
65 Sequence(const TypeMap& type_map);
66 Sequence(const Sequence<Time>& other);
69 struct WriteLockImpl {
70 WriteLockImpl(Glib::Threads::RWLock& s, Glib::Threads::Mutex& c)
71 : sequence_lock(new Glib::Threads::RWLock::WriterLock(s))
72 , control_lock(new Glib::Threads::Mutex::Lock(c)) { }
77 Glib::Threads::RWLock::WriterLock* sequence_lock;
78 Glib::Threads::Mutex::Lock* control_lock;
83 typedef typename boost::shared_ptr<Evoral::Note<Time> > NotePtr;
84 typedef typename boost::shared_ptr<const Evoral::Note<Time> > constNotePtr;
86 typedef boost::shared_ptr<Glib::Threads::RWLock::ReaderLock> ReadLock;
87 typedef boost::shared_ptr<WriteLockImpl> WriteLock;
89 virtual ReadLock read_lock() const { return ReadLock(new Glib::Threads::RWLock::ReaderLock(_lock)); }
90 virtual WriteLock write_lock() { return WriteLock(new WriteLockImpl(_lock, _control_lock)); }
94 bool percussive() const { return _percussive; }
95 void set_percussive(bool p) { _percussive = p; }
98 bool writing() const { return _writing; }
100 enum StuckNoteOption {
106 void end_write (StuckNoteOption, Time when = 0);
108 void append(const Event<Time>& ev, Evoral::event_id_t evid);
110 inline size_t n_notes() const { return _notes.size(); }
111 inline bool empty() const { return _notes.empty() && _sysexes.empty() && _patch_changes.empty() && ControlSet::controls_empty(); }
113 inline static bool note_time_comparator(const boost::shared_ptr< const Note<Time> >& a,
114 const boost::shared_ptr< const Note<Time> >& b) {
115 return a->time() < b->time();
118 struct NoteNumberComparator {
119 inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
120 const boost::shared_ptr< const Note<Time> > b) const {
121 return a->note() < b->note();
125 struct EarlierNoteComparator {
126 inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
127 const boost::shared_ptr< const Note<Time> > b) const {
128 return musical_time_less_than (a->time(), b->time());
132 struct LaterNoteComparator {
133 typedef const Note<Time>* value_type;
134 inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
135 const boost::shared_ptr< const Note<Time> > b) const {
136 return musical_time_greater_than (a->time(), b->time());
137 return a->time() > b->time();
141 struct LaterNoteEndComparator {
142 typedef const Note<Time>* value_type;
143 inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
144 const boost::shared_ptr< const Note<Time> > b) const {
145 return musical_time_greater_than (a->end_time(), b->end_time());
149 typedef std::multiset<NotePtr, EarlierNoteComparator> Notes;
150 inline Notes& notes() { return _notes; }
151 inline const Notes& notes() const { return _notes; }
156 PitchLessThanOrEqual,
158 PitchGreaterThanOrEqual,
161 VelocityLessThanOrEqual,
163 VelocityGreaterThanOrEqual,
166 void get_notes (Notes&, NoteOperator, uint8_t val, int chan_mask = 0) const;
168 void remove_overlapping_notes ();
169 void trim_overlapping_notes ();
170 void remove_duplicate_notes ();
172 enum OverlapPitchResolution {
177 bool overlapping_pitches_accepted() const { return _overlapping_pitches_accepted; }
178 void overlapping_pitches_accepted(bool yn) { _overlapping_pitches_accepted = yn; }
179 OverlapPitchResolution overlap_pitch_resolution() const { return _overlap_pitch_resolution; }
180 void set_overlap_pitch_resolution(OverlapPitchResolution opr);
182 void set_notes (const typename Sequence<Time>::Notes& n);
184 typedef boost::shared_ptr< Event<Time> > SysExPtr;
185 typedef boost::shared_ptr<const Event<Time> > constSysExPtr;
187 struct EarlierSysExComparator {
188 inline bool operator() (constSysExPtr a, constSysExPtr b) const {
189 return musical_time_less_than (a->time(), b->time());
193 typedef std::multiset<SysExPtr, EarlierSysExComparator> SysExes;
194 inline SysExes& sysexes() { return _sysexes; }
195 inline const SysExes& sysexes() const { return _sysexes; }
197 typedef boost::shared_ptr<PatchChange<Time> > PatchChangePtr;
198 typedef boost::shared_ptr<const PatchChange<Time> > constPatchChangePtr;
200 struct EarlierPatchChangeComparator {
201 inline bool operator() (constPatchChangePtr a, constPatchChangePtr b) const {
202 return musical_time_less_than (a->time(), b->time());
206 typedef std::multiset<PatchChangePtr, EarlierPatchChangeComparator> PatchChanges;
207 inline PatchChanges& patch_changes () { return _patch_changes; }
208 inline const PatchChanges& patch_changes () const { return _patch_changes; }
210 void dump (std::ostream&) const;
213 typedef std::priority_queue<NotePtr, std::deque<NotePtr>, LaterNoteEndComparator> ActiveNotes;
217 class const_iterator {
220 const_iterator(const Sequence<Time>& seq, Time t, bool, std::set<Evoral::Parameter> const &);
223 inline bool valid() const { return !_is_end && _event; }
224 //inline bool locked() const { return _locked; }
228 const Event<Time>& operator*() const { return *_event; }
229 const boost::shared_ptr< Event<Time> > operator->() const { return _event; }
230 const boost::shared_ptr< Event<Time> > get_event_pointer() { return _event; }
232 const const_iterator& operator++(); // prefix only
234 bool operator==(const const_iterator& other) const;
235 bool operator!=(const const_iterator& other) const { return ! operator==(other); }
237 const_iterator& operator=(const const_iterator& other);
240 friend class Sequence<Time>;
242 typedef std::vector<ControlIterator> ControlIterators;
243 enum MIDIMessageType { NIL, NOTE_ON, NOTE_OFF, CONTROL, SYSEX, PATCH_CHANGE };
245 const Sequence<Time>* _seq;
246 boost::shared_ptr< Event<Time> > _event;
247 mutable ActiveNotes _active_notes;
248 /** If the iterator is pointing at a patch change, this is the index of the
249 * sub-message within that change.
251 int _active_patch_change_message;
252 MIDIMessageType _type;
254 typename Sequence::ReadLock _lock;
255 typename Notes::const_iterator _note_iter;
256 typename SysExes::const_iterator _sysex_iter;
257 typename PatchChanges::const_iterator _patch_change_iter;
258 ControlIterators _control_iters;
259 ControlIterators::iterator _control_iter;
260 bool _force_discrete;
263 const_iterator begin (
265 bool force_discrete = false,
266 std::set<Evoral::Parameter> const & f = std::set<Evoral::Parameter> ()) const {
267 return const_iterator (*this, t, force_discrete, f);
270 const const_iterator& end() const { return _end_iter; }
272 // CONST iterator implementations (x3)
273 typename Notes::const_iterator note_lower_bound (Time t) const;
274 typename PatchChanges::const_iterator patch_change_lower_bound (Time t) const;
275 typename SysExes::const_iterator sysex_lower_bound (Time t) const;
277 // NON-CONST iterator implementations (x3)
278 typename Notes::iterator note_lower_bound (Time t);
279 typename PatchChanges::iterator patch_change_lower_bound (Time t);
280 typename SysExes::iterator sysex_lower_bound (Time t);
282 bool control_to_midi_event(boost::shared_ptr< Event<Time> >& ev,
283 const ControlIterator& iter) const;
285 bool edited() const { return _edited; }
286 void set_edited(bool yn) { _edited = yn; }
288 bool overlaps (const NotePtr& ev,
289 const NotePtr& ignore_this_note) const;
290 bool contains (const NotePtr& ev) const;
292 bool add_note_unlocked (const NotePtr note, void* arg = 0);
293 void remove_note_unlocked(const constNotePtr note);
295 void add_patch_change_unlocked (const PatchChangePtr);
296 void remove_patch_change_unlocked (const constPatchChangePtr);
298 void add_sysex_unlocked (const SysExPtr);
299 void remove_sysex_unlocked (const SysExPtr);
301 uint8_t lowest_note() const { return _lowest_note; }
302 uint8_t highest_note() const { return _highest_note; }
307 bool _overlapping_pitches_accepted;
308 OverlapPitchResolution _overlap_pitch_resolution;
309 mutable Glib::Threads::RWLock _lock;
312 virtual int resolve_overlaps_unlocked (const NotePtr, void* /* arg */ = 0) {
316 typedef std::multiset<NotePtr, NoteNumberComparator> Pitches;
317 inline Pitches& pitches(uint8_t chan) { return _pitches[chan&0xf]; }
318 inline const Pitches& pitches(uint8_t chan) const { return _pitches[chan&0xf]; }
320 virtual void control_list_marked_dirty ();
323 friend class const_iterator;
325 bool overlaps_unlocked (const NotePtr& ev, const NotePtr& ignore_this_note) const;
326 bool contains_unlocked (const NotePtr& ev) const;
328 void append_note_on_unlocked (NotePtr, Evoral::event_id_t);
329 void append_note_off_unlocked(NotePtr);
330 void append_control_unlocked(const Parameter& param, Time time, double value, Evoral::event_id_t);
331 void append_sysex_unlocked(const MIDIEvent<Time>& ev, Evoral::event_id_t);
332 void append_patch_change_unlocked (const PatchChange<Time>&, Evoral::event_id_t);
334 void get_notes_by_pitch (Notes&, NoteOperator, uint8_t val, int chan_mask = 0) const;
335 void get_notes_by_velocity (Notes&, NoteOperator, uint8_t val, int chan_mask = 0) const;
337 const TypeMap& _type_map;
339 Notes _notes; // notes indexed by time
340 Pitches _pitches[16]; // notes indexed by channel+pitch
342 PatchChanges _patch_changes;
344 typedef std::multiset<NotePtr, EarlierNoteComparator> WriteNotes;
345 WriteNotes _write_notes[16];
347 /** Current bank number on each channel so that we know what
348 * to put in PatchChange events when program changes are
353 const const_iterator _end_iter;
356 uint8_t _lowest_note;
357 uint8_t _highest_note;
361 } // namespace Evoral
363 template<typename Time> std::ostream& operator<<(std::ostream& o, const Evoral::Sequence<Time>& s) { s.dump (o); return o; }
365 #endif // EVORAL_SEQUENCE_HPP