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>
30 #include "evoral/visibility.h"
31 #include "evoral/types.hpp"
32 #include "evoral/Note.hpp"
33 #include "evoral/ControlSet.hpp"
34 #include "evoral/ControlList.hpp"
35 #include "evoral/PatchChange.hpp"
41 template<typename Time> class EventSink;
42 template<typename Time> class Note;
43 template<typename Time> class Event;
45 /** An iterator over (the x axis of) a 2-d double coordinate space.
47 class /*LIBEVORAL_API*/ ControlIterator {
49 ControlIterator(boost::shared_ptr<const ControlList> al, double ax, double ay)
55 boost::shared_ptr<const ControlList> list;
61 /** This is a higher level view of events, with separate representations for
62 * notes (instead of just unassociated note on/off events) and controller data.
63 * Controller data is represented as a list of time-stamped float values. */
64 template<typename Time>
65 class LIBEVORAL_API Sequence : virtual public ControlSet {
67 Sequence(const TypeMap& type_map);
68 Sequence(const Sequence<Time>& other);
71 struct WriteLockImpl {
72 WriteLockImpl(Glib::Threads::RWLock& s, Glib::Threads::Mutex& c)
73 : sequence_lock(new Glib::Threads::RWLock::WriterLock(s))
74 , control_lock(new Glib::Threads::Mutex::Lock(c)) { }
79 Glib::Threads::RWLock::WriterLock* sequence_lock;
80 Glib::Threads::Mutex::Lock* control_lock;
85 typedef typename boost::shared_ptr<Evoral::Note<Time> > NotePtr;
86 typedef typename boost::shared_ptr<const Evoral::Note<Time> > constNotePtr;
88 typedef boost::shared_ptr<Glib::Threads::RWLock::ReaderLock> ReadLock;
89 typedef boost::shared_ptr<WriteLockImpl> WriteLock;
91 virtual ReadLock read_lock() const { return ReadLock(new Glib::Threads::RWLock::ReaderLock(_lock)); }
92 virtual WriteLock write_lock() { return WriteLock(new WriteLockImpl(_lock, _control_lock)); }
96 bool percussive() const { return _percussive; }
97 void set_percussive(bool p) { _percussive = p; }
100 bool writing() const { return _writing; }
102 enum StuckNoteOption {
108 void end_write (StuckNoteOption, Time when = Time());
110 void append(const Event<Time>& ev, Evoral::event_id_t evid);
112 const TypeMap& type_map() const { return _type_map; }
114 inline size_t n_notes() const { return _notes.size(); }
115 inline bool empty() const { return _notes.empty() && _sysexes.empty() && _patch_changes.empty() && ControlSet::controls_empty(); }
117 inline static bool note_time_comparator(const boost::shared_ptr< const Note<Time> >& a,
118 const boost::shared_ptr< const Note<Time> >& b) {
119 return a->time() < b->time();
122 struct NoteNumberComparator {
123 inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
124 const boost::shared_ptr< const Note<Time> > b) const {
125 return a->note() < b->note();
129 struct EarlierNoteComparator {
130 inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
131 const boost::shared_ptr< const Note<Time> > b) const {
132 return a->time() < b->time();
136 struct LaterNoteComparator {
137 typedef const Note<Time>* value_type;
138 inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
139 const boost::shared_ptr< const Note<Time> > b) const {
140 return a->time() > b->time();
144 struct LaterNoteEndComparator {
145 typedef const Note<Time>* value_type;
146 inline bool operator()(const boost::shared_ptr< const Note<Time> > a,
147 const boost::shared_ptr< const Note<Time> > b) const {
148 return a->end_time() > b->end_time();
152 typedef std::multiset<NotePtr, EarlierNoteComparator> Notes;
153 inline Notes& notes() { return _notes; }
154 inline const Notes& notes() const { return _notes; }
159 PitchLessThanOrEqual,
161 PitchGreaterThanOrEqual,
164 VelocityLessThanOrEqual,
166 VelocityGreaterThanOrEqual,
169 void get_notes (Notes&, NoteOperator, uint8_t val, int chan_mask = 0) const;
171 void remove_overlapping_notes ();
172 void trim_overlapping_notes ();
173 void remove_duplicate_notes ();
175 enum OverlapPitchResolution {
180 bool overlapping_pitches_accepted() const { return _overlapping_pitches_accepted; }
181 void overlapping_pitches_accepted(bool yn) { _overlapping_pitches_accepted = yn; }
182 OverlapPitchResolution overlap_pitch_resolution() const { return _overlap_pitch_resolution; }
183 void set_overlap_pitch_resolution(OverlapPitchResolution opr);
185 void set_notes (const typename Sequence<Time>::Notes& n);
187 typedef boost::shared_ptr< Event<Time> > SysExPtr;
188 typedef boost::shared_ptr<const Event<Time> > constSysExPtr;
190 struct EarlierSysExComparator {
191 inline bool operator() (constSysExPtr a, constSysExPtr b) const {
192 return a->time() < b->time();
196 typedef std::multiset<SysExPtr, EarlierSysExComparator> SysExes;
197 inline SysExes& sysexes() { return _sysexes; }
198 inline const SysExes& sysexes() const { return _sysexes; }
200 typedef boost::shared_ptr<PatchChange<Time> > PatchChangePtr;
201 typedef boost::shared_ptr<const PatchChange<Time> > constPatchChangePtr;
203 struct EarlierPatchChangeComparator {
204 inline bool operator() (constPatchChangePtr a, constPatchChangePtr b) const {
205 return a->time() < b->time();
209 typedef std::multiset<PatchChangePtr, EarlierPatchChangeComparator> PatchChanges;
210 inline PatchChanges& patch_changes () { return _patch_changes; }
211 inline const PatchChanges& patch_changes () const { return _patch_changes; }
213 void dump (std::ostream&) const;
216 typedef std::priority_queue<NotePtr, std::deque<NotePtr>, LaterNoteEndComparator> ActiveNotes;
220 class LIBEVORAL_API /* Added by JE - */ const_iterator {
223 const_iterator(const Sequence<Time>& seq, Time t, bool, std::set<Evoral::Parameter> const &);
226 inline bool valid() const { return !_is_end && _event; }
227 //inline bool locked() const { return _locked; }
231 const Event<Time>& operator*() const { return *_event; }
232 const boost::shared_ptr< Event<Time> > operator->() const { return _event; }
233 const boost::shared_ptr< Event<Time> > get_event_pointer() { return _event; }
235 const const_iterator& operator++(); // prefix only
237 bool operator==(const const_iterator& other) const;
238 bool operator!=(const const_iterator& other) const { return ! operator==(other); }
240 const_iterator& operator=(const const_iterator& other);
243 friend class Sequence<Time>;
245 typedef std::vector<ControlIterator> ControlIterators;
246 enum MIDIMessageType { NIL, NOTE_ON, NOTE_OFF, CONTROL, SYSEX, PATCH_CHANGE };
248 const Sequence<Time>* _seq;
249 boost::shared_ptr< Event<Time> > _event;
250 mutable ActiveNotes _active_notes;
251 /** If the iterator is pointing at a patch change, this is the index of the
252 * sub-message within that change.
254 int _active_patch_change_message;
255 MIDIMessageType _type;
257 typename Sequence::ReadLock _lock;
258 typename Notes::const_iterator _note_iter;
259 typename SysExes::const_iterator _sysex_iter;
260 typename PatchChanges::const_iterator _patch_change_iter;
261 ControlIterators _control_iters;
262 ControlIterators::iterator _control_iter;
263 bool _force_discrete;
266 const_iterator begin (
268 bool force_discrete = false,
269 std::set<Evoral::Parameter> const & f = std::set<Evoral::Parameter> ()) const {
270 return const_iterator (*this, t, force_discrete, f);
273 const const_iterator& end() const { return _end_iter; }
275 // CONST iterator implementations (x3)
276 typename Notes::const_iterator note_lower_bound (Time t) const;
277 typename PatchChanges::const_iterator patch_change_lower_bound (Time t) const;
278 typename SysExes::const_iterator sysex_lower_bound (Time t) const;
280 // NON-CONST iterator implementations (x3)
281 typename Notes::iterator note_lower_bound (Time t);
282 typename PatchChanges::iterator patch_change_lower_bound (Time t);
283 typename SysExes::iterator sysex_lower_bound (Time t);
285 bool control_to_midi_event(boost::shared_ptr< Event<Time> >& ev,
286 const ControlIterator& iter) const;
288 bool edited() const { return _edited; }
289 void set_edited(bool yn) { _edited = yn; }
291 bool overlaps (const NotePtr& ev,
292 const NotePtr& ignore_this_note) const;
293 bool contains (const NotePtr& ev) const;
295 bool add_note_unlocked (const NotePtr note, void* arg = 0);
296 void remove_note_unlocked(const constNotePtr note);
298 void add_patch_change_unlocked (const PatchChangePtr);
299 void remove_patch_change_unlocked (const constPatchChangePtr);
301 void add_sysex_unlocked (const SysExPtr);
302 void remove_sysex_unlocked (const SysExPtr);
304 uint8_t lowest_note() const { return _lowest_note; }
305 uint8_t highest_note() const { return _highest_note; }
310 bool _overlapping_pitches_accepted;
311 OverlapPitchResolution _overlap_pitch_resolution;
312 mutable Glib::Threads::RWLock _lock;
315 virtual int resolve_overlaps_unlocked (const NotePtr, void* /* arg */ = 0) {
319 typedef std::multiset<NotePtr, NoteNumberComparator> Pitches;
320 inline Pitches& pitches(uint8_t chan) { return _pitches[chan&0xf]; }
321 inline const Pitches& pitches(uint8_t chan) const { return _pitches[chan&0xf]; }
323 virtual void control_list_marked_dirty ();
326 friend class const_iterator;
328 bool overlaps_unlocked (const NotePtr& ev, const NotePtr& ignore_this_note) const;
329 bool contains_unlocked (const NotePtr& ev) const;
331 void append_note_on_unlocked (NotePtr, Evoral::event_id_t);
332 void append_note_off_unlocked(NotePtr);
333 void append_control_unlocked(const Parameter& param, Time time, double value, Evoral::event_id_t);
334 void append_sysex_unlocked(const MIDIEvent<Time>& ev, Evoral::event_id_t);
335 void append_patch_change_unlocked (const PatchChange<Time>&, Evoral::event_id_t);
337 void get_notes_by_pitch (Notes&, NoteOperator, uint8_t val, int chan_mask = 0) const;
338 void get_notes_by_velocity (Notes&, NoteOperator, uint8_t val, int chan_mask = 0) const;
340 const TypeMap& _type_map;
342 Notes _notes; // notes indexed by time
343 Pitches _pitches[16]; // notes indexed by channel+pitch
345 PatchChanges _patch_changes;
347 typedef std::multiset<NotePtr, EarlierNoteComparator> WriteNotes;
348 WriteNotes _write_notes[16];
350 /** Current bank number on each channel so that we know what
351 * to put in PatchChange events when program changes are
356 const const_iterator _end_iter;
359 uint8_t _lowest_note;
360 uint8_t _highest_note;
364 } // namespace Evoral
366 template<typename Time> /*LIBEVORAL_API*/ std::ostream& operator<<(std::ostream& o, const Evoral::Sequence<Time>& s) { s.dump (o); return o; }
369 #endif // EVORAL_SEQUENCE_HPP