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
27 #include "pbd/compose.h"
28 #include "pbd/error.h"
30 #include "evoral/Control.hpp"
31 #include "evoral/ControlList.hpp"
32 #include "evoral/ControlSet.hpp"
33 #include "evoral/EventSink.hpp"
34 #include "evoral/MIDIParameters.hpp"
35 #include "evoral/Sequence.hpp"
36 #include "evoral/TypeMap.hpp"
37 #include "evoral/midi_util.h"
44 /** Minimum time between MIDI outputs from a single interpolated controller,
45 expressed in beats. This is to limit the rate at which MIDI messages
46 are generated. It is only applied to interpolated controllers.
48 XXX: This is a hack. The time should probably be expressed in
49 seconds rather than beats, and should be configurable etc. etc.
51 static double const time_between_interpolated_controller_outputs = 1.0 / 256;
55 // Read iterator (const_iterator)
57 template<typename Time>
58 Sequence<Time>::const_iterator::const_iterator()
61 , _control_iter(_control_iters.end())
63 _event = boost::shared_ptr< Event<Time> >(new Event<Time>());
66 /** @param force_discrete true to force ControlLists to use discrete evaluation, otherwise false to get them to use their configured mode */
67 template<typename Time>
68 Sequence<Time>::const_iterator::const_iterator(const Sequence<Time>& seq, Time t, bool force_discrete, std::set<Evoral::Parameter> const & filtered)
70 , _active_patch_change_message (0)
72 , _is_end((t == DBL_MAX) || seq.empty())
73 , _note_iter(seq.notes().end())
74 , _sysex_iter(seq.sysexes().end())
75 , _patch_change_iter(seq.patch_changes().end())
76 , _control_iter(_control_iters.end())
77 , _force_discrete (force_discrete)
79 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Created Iterator @ %1 (is end: %2)\n)", t, _is_end));
85 _lock = seq.read_lock();
87 // Find first note which begins at or after t
88 _note_iter = seq.note_lower_bound(t);
90 // Find first sysex event at or after t
91 for (typename Sequence<Time>::SysExes::const_iterator i = seq.sysexes().begin();
92 i != seq.sysexes().end(); ++i) {
93 if ((*i)->time() >= t) {
98 assert(_sysex_iter == seq.sysexes().end() || (*_sysex_iter)->time() >= t);
100 // Find first patch event at or after t
101 for (typename Sequence<Time>::PatchChanges::const_iterator i = seq.patch_changes().begin(); i != seq.patch_changes().end(); ++i) {
102 if ((*i)->time() >= t) {
103 _patch_change_iter = i;
107 assert (_patch_change_iter == seq.patch_changes().end() || (*_patch_change_iter)->time() >= t);
109 // Find first control event after t
110 ControlIterator earliest_control(boost::shared_ptr<ControlList>(), DBL_MAX, 0.0);
111 _control_iters.reserve(seq._controls.size());
113 size_t earliest_control_index = 0;
114 for (Controls::const_iterator i = seq._controls.begin(); i != seq._controls.end(); ++i) {
116 if (filtered.find (i->first) != filtered.end()) {
117 /* this parameter is filtered, so don't bother setting up an iterator for it */
121 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Iterator: control: %1\n", seq._type_map.to_symbol(i->first)));
124 if (_force_discrete) {
125 ret = i->second->list()->rt_safe_earliest_event_discrete_unlocked (t, x, y, true);
127 ret = i->second->list()->rt_safe_earliest_event_unlocked(t, x, y, true);
130 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Iterator: CC %1 (size %2) has no events past %3\n",
131 i->first.id(), i->second->list()->size(), t));
137 if (y < i->first.min() || y > i->first.max()) {
138 cerr << "ERROR: Controller value " << y
139 << " out of range [" << i->first.min() << "," << i->first.max()
140 << "], event ignored" << endl;
144 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Iterator: CC %1 added (%2, %3)\n", i->first.id(), x, y));
146 const ControlIterator new_iter(i->second->list(), x, y);
147 _control_iters.push_back(new_iter);
149 // Found a new earliest_control
150 if (x < earliest_control.x) {
151 earliest_control = new_iter;
152 earliest_control_index = _control_iters.size() - 1;
158 _control_iter = _control_iters.begin() + earliest_control_index;
159 assert(_control_iter != _control_iters.end());
161 _control_iter = _control_iters.end();
164 // Now find the earliest event overall and point to it
167 if (_note_iter != seq.notes().end()) {
169 earliest_t = (*_note_iter)->time();
172 if (_sysex_iter != seq.sysexes().end()
173 && ((*_sysex_iter)->time() < earliest_t || _type == NIL)) {
175 earliest_t = (*_sysex_iter)->time();
178 if (_patch_change_iter != seq.patch_changes().end() && ((*_patch_change_iter)->time() < earliest_t || _type == NIL)) {
179 _type = PATCH_CHANGE;
180 earliest_t = (*_patch_change_iter)->time ();
183 if (_control_iter != _control_iters.end()
184 && earliest_control.list && earliest_control.x >= t
185 && (earliest_control.x < earliest_t || _type == NIL)) {
187 earliest_t = earliest_control.x;
192 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Starting at note on event @ %1\n", earliest_t));
193 _event = boost::shared_ptr<Event<Time> > (new Event<Time> ((*_note_iter)->on_event(), true));
194 _active_notes.push(*_note_iter);
197 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Starting at sysex event @ %1\n", earliest_t));
198 _event = boost::shared_ptr< Event<Time> >(
199 new Event<Time>(*(*_sysex_iter), true));
202 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Starting at control event @ %1\n", earliest_t));
203 seq.control_to_midi_event(_event, earliest_control);
206 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Starting at patch change event @ %1\n", earliest_t));
207 _event = boost::shared_ptr<Event<Time> > (new Event<Time> ((*_patch_change_iter)->message (_active_patch_change_message), true));
213 if (_type == NIL || !_event || _event->size() == 0) {
214 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Starting at end @ %1\n", t));
218 DEBUG_TRACE (DEBUG::Sequence, string_compose ("New iterator = 0x%1 : 0x%2 @ %3\n",
219 (int)_event->event_type(),
220 (int)((MIDIEvent<Time>*)_event.get())->type(),
223 assert(midi_event_is_valid(_event->buffer(), _event->size()));
228 template<typename Time>
229 Sequence<Time>::const_iterator::~const_iterator()
233 template<typename Time>
235 Sequence<Time>::const_iterator::invalidate()
237 while (!_active_notes.empty()) {
243 _note_iter = _seq->notes().end();
244 _sysex_iter = _seq->sysexes().end();
245 _patch_change_iter = _seq->patch_changes().end();
246 _active_patch_change_message = 0;
248 _control_iter = _control_iters.end();
252 template<typename Time>
253 const typename Sequence<Time>::const_iterator&
254 Sequence<Time>::const_iterator::operator++()
257 throw std::logic_error("Attempt to iterate past end of Sequence");
260 assert(_event && _event->buffer() && _event->size() > 0);
262 const MIDIEvent<Time>& ev = *((MIDIEvent<Time>*)_event.get());
266 || ev.is_pgm_change()
267 || ev.is_pitch_bender()
268 || ev.is_channel_pressure()
269 || ev.is_sysex()) ) {
270 cerr << "WARNING: Unknown event (type " << _type << "): " << hex
271 << int(ev.buffer()[0]) << int(ev.buffer()[1]) << int(ev.buffer()[2]) << endl;
278 // Increment past current event
286 // Increment current controller iterator
287 if (_force_discrete || _control_iter->list->interpolation() == ControlList::Discrete) {
288 ret = _control_iter->list->rt_safe_earliest_event_discrete_unlocked (
289 _control_iter->x, x, y, false
292 ret = _control_iter->list->rt_safe_earliest_event_linear_unlocked (
293 _control_iter->x + time_between_interpolated_controller_outputs, x, y, false
296 assert(!ret || x > _control_iter->x);
298 _control_iter->x = x;
299 _control_iter->y = y;
301 _control_iter->list.reset();
302 _control_iter->x = DBL_MAX;
303 _control_iter->y = DBL_MAX;
306 // Find the controller with the next earliest event time
307 _control_iter = _control_iters.begin();
308 for (ControlIterators::iterator i = _control_iters.begin();
309 i != _control_iters.end(); ++i) {
310 if (i->x < _control_iter->x) {
319 ++_active_patch_change_message;
320 if (_active_patch_change_message == (*_patch_change_iter)->messages()) {
321 ++_patch_change_iter;
322 _active_patch_change_message = 0;
329 // Now find the earliest event overall and point to it
331 Time earliest_t = std::numeric_limits<Time>::max();
333 // Next earliest note on
334 if (_note_iter != _seq->notes().end()) {
336 earliest_t = (*_note_iter)->time();
339 // Use the next note off iff it's earlier or the same time as the note on
340 #ifdef PERCUSSIVE_IGNORE_NOTE_OFFS
341 // issue 0005121 When in Percussive mode, all note offs go missing, which jams all MIDI instruments that they stop playing
342 // remove this code since it drowns MIDI instruments by stealing all voices and crashes LinuxSampler
343 if (!_seq->percussive() && (!_active_notes.empty())) {
345 if ((!_active_notes.empty())) {
347 if (_type == NIL || _active_notes.top()->end_time() <= earliest_t) {
349 earliest_t = _active_notes.top()->end_time();
353 // Use the next earliest controller iff it's earlier than the note event
354 if (_control_iter != _control_iters.end() && _control_iter->x != DBL_MAX) {
355 if (_type == NIL || _control_iter->x < earliest_t) {
357 earliest_t = _control_iter->x;
361 // Use the next earliest SysEx iff it's earlier than the controller
362 if (_sysex_iter != _seq->sysexes().end()) {
363 if (_type == NIL || (*_sysex_iter)->time() < earliest_t) {
365 earliest_t = (*_sysex_iter)->time();
369 // Use the next earliest patch change iff it's earlier than the SysEx
370 if (_patch_change_iter != _seq->patch_changes().end()) {
371 if (_type == NIL || (*_patch_change_iter)->time() < earliest_t) {
372 _type = PATCH_CHANGE;
373 earliest_t = (*_patch_change_iter)->time();
377 // Set event to reflect new position
380 // DEBUG_TRACE(DEBUG::Sequence, "iterator = note on\n");
381 *_event = (*_note_iter)->on_event();
382 _active_notes.push(*_note_iter);
385 // DEBUG_TRACE(DEBUG::Sequence, "iterator = note off\n");
386 assert(!_active_notes.empty());
387 *_event = _active_notes.top()->off_event();
391 //DEBUG_TRACE(DEBUG::Sequence, "iterator = control\n");
392 _seq->control_to_midi_event(_event, *_control_iter);
395 //DEBUG_TRACE(DEBUG::Sequence, "iterator = sysex\n");
396 *_event = *(*_sysex_iter);
399 //DEBUG_TRACE(DEBUG::Sequence, "iterator = patch change\n");
400 *_event = (*_patch_change_iter)->message (_active_patch_change_message);
403 //DEBUG_TRACE(DEBUG::Sequence, "iterator = end\n");
407 assert(_is_end || (_event->size() > 0 && _event->buffer() && _event->buffer()[0] != '\0'));
412 template<typename Time>
414 Sequence<Time>::const_iterator::operator==(const const_iterator& other) const
416 if (_seq != other._seq) {
418 } else if (_is_end || other._is_end) {
419 return (_is_end == other._is_end);
420 } else if (_type != other._type) {
423 return (_event == other._event);
427 template<typename Time>
428 typename Sequence<Time>::const_iterator&
429 Sequence<Time>::const_iterator::operator=(const const_iterator& other)
432 _event = other._event;
433 _active_notes = other._active_notes;
435 _is_end = other._is_end;
436 _note_iter = other._note_iter;
437 _sysex_iter = other._sysex_iter;
438 _patch_change_iter = other._patch_change_iter;
439 _control_iters = other._control_iters;
440 _force_discrete = other._force_discrete;
441 _active_patch_change_message = other._active_patch_change_message;
444 _lock = _seq->read_lock();
449 if (other._control_iter == other._control_iters.end()) {
450 _control_iter = _control_iters.end();
452 const size_t index = other._control_iter - other._control_iters.begin();
453 _control_iter = _control_iters.begin() + index;
461 template<typename Time>
462 Sequence<Time>::Sequence(const TypeMap& type_map)
464 , _overlapping_pitches_accepted (true)
465 , _overlap_pitch_resolution (FirstOnFirstOff)
467 , _type_map(type_map)
468 , _end_iter(*this, DBL_MAX, false, std::set<Evoral::Parameter> ())
473 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Sequence constructed: %1\n", this));
474 assert(_end_iter._is_end);
475 assert( ! _end_iter._lock);
477 for (int i = 0; i < 16; ++i) {
482 template<typename Time>
483 Sequence<Time>::Sequence(const Sequence<Time>& other)
486 , _overlapping_pitches_accepted (other._overlapping_pitches_accepted)
487 , _overlap_pitch_resolution (other._overlap_pitch_resolution)
489 , _type_map(other._type_map)
490 , _end_iter(*this, DBL_MAX, false, std::set<Evoral::Parameter> ())
491 , _percussive(other._percussive)
492 , _lowest_note(other._lowest_note)
493 , _highest_note(other._highest_note)
495 for (typename Notes::const_iterator i = other._notes.begin(); i != other._notes.end(); ++i) {
496 NotePtr n (new Note<Time> (**i));
500 for (typename SysExes::const_iterator i = other._sysexes.begin(); i != other._sysexes.end(); ++i) {
501 boost::shared_ptr<Event<Time> > n (new Event<Time> (**i, true));
505 for (typename PatchChanges::const_iterator i = other._patch_changes.begin(); i != other._patch_changes.end(); ++i) {
506 PatchChangePtr n (new PatchChange<Time> (**i));
507 _patch_changes.insert (n);
510 for (int i = 0; i < 16; ++i) {
511 _bank[i] = other._bank[i];
514 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Sequence copied: %1\n", this));
515 assert(_end_iter._is_end);
516 assert(! _end_iter._lock);
519 /** Write the controller event pointed to by \a iter to \a ev.
520 * The buffer of \a ev will be allocated or resized as necessary.
521 * The event_type of \a ev should be set to the expected output type.
522 * \return true on success
524 template<typename Time>
526 Sequence<Time>::control_to_midi_event(
527 boost::shared_ptr< Event<Time> >& ev,
528 const ControlIterator& iter) const
530 assert(iter.list.get());
531 const uint32_t event_type = iter.list->parameter().type();
533 // initialize the event pointer with a new event, if necessary
535 ev = boost::shared_ptr< Event<Time> >(new Event<Time>(event_type, 0, 3, NULL, true));
538 uint8_t midi_type = _type_map.parameter_midi_type(iter.list->parameter());
539 ev->set_event_type(_type_map.midi_event_type(midi_type));
541 case MIDI_CMD_CONTROL:
542 assert(iter.list.get());
543 assert(iter.list->parameter().channel() < 16);
544 assert(iter.list->parameter().id() <= INT8_MAX);
545 assert(iter.y <= INT8_MAX);
547 ev->set_time(iter.x);
549 ev->buffer()[0] = MIDI_CMD_CONTROL + iter.list->parameter().channel();
550 ev->buffer()[1] = (uint8_t)iter.list->parameter().id();
551 ev->buffer()[2] = (uint8_t)iter.y;
554 case MIDI_CMD_PGM_CHANGE:
555 assert(iter.list.get());
556 assert(iter.list->parameter().channel() < 16);
557 assert(iter.y <= INT8_MAX);
559 ev->set_time(iter.x);
561 ev->buffer()[0] = MIDI_CMD_PGM_CHANGE + iter.list->parameter().channel();
562 ev->buffer()[1] = (uint8_t)iter.y;
565 case MIDI_CMD_BENDER:
566 assert(iter.list.get());
567 assert(iter.list->parameter().channel() < 16);
568 assert(iter.y < (1<<14));
570 ev->set_time(iter.x);
572 ev->buffer()[0] = MIDI_CMD_BENDER + iter.list->parameter().channel();
573 ev->buffer()[1] = uint16_t(iter.y) & 0x7F; // LSB
574 ev->buffer()[2] = (uint16_t(iter.y) >> 7) & 0x7F; // MSB
577 case MIDI_CMD_CHANNEL_PRESSURE:
578 assert(iter.list.get());
579 assert(iter.list->parameter().channel() < 16);
580 assert(iter.y <= INT8_MAX);
582 ev->set_time(iter.x);
584 ev->buffer()[0] = MIDI_CMD_CHANNEL_PRESSURE + iter.list->parameter().channel();
585 ev->buffer()[1] = (uint8_t)iter.y;
595 /** Clear all events from the model.
597 template<typename Time>
599 Sequence<Time>::clear()
601 WriteLock lock(write_lock());
603 for (Controls::iterator li = _controls.begin(); li != _controls.end(); ++li)
604 li->second->list()->clear();
607 /** Begin a write of events to the model.
609 * If \a mode is Sustained, complete notes with length are constructed as note
610 * on/off events are received. Otherwise (Percussive), only note on events are
611 * stored; note off events are discarded entirely and all contained notes will
614 template<typename Time>
616 Sequence<Time>::start_write()
618 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 : start_write (percussive = %2)\n", this, _percussive));
619 WriteLock lock(write_lock());
621 for (int i = 0; i < 16; ++i) {
622 _write_notes[i].clear();
626 /** Finish a write of events to the model.
628 * If \a delete_stuck is true and the current mode is Sustained, note on events
629 * that were never resolved with a corresonding note off will be deleted.
630 * Otherwise they will remain as notes with length 0.
632 template<typename Time>
634 Sequence<Time>::end_write (StuckNoteOption option, Time when)
636 WriteLock lock(write_lock());
642 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 : end_write (%2 notes) delete stuck option %3 @ %4\n", this, _notes.size(), option, when));
644 #ifdef PERCUSSIVE_IGNORE_NOTE_OFFS
647 for (typename Notes::iterator n = _notes.begin(); n != _notes.end() ;) {
648 typename Notes::iterator next = n;
651 if ((*n)->length() == 0) {
655 case DeleteStuckNotes:
656 cerr << "WARNING: Stuck note lost: " << (*n)->note() << endl;
659 case ResolveStuckNotes:
660 if (when <= (*n)->time()) {
661 cerr << "WARNING: Stuck note resolution - end time @ "
662 << when << " is before note on: " << (**n) << endl;
665 (*n)->set_length (when - (*n)->time());
666 cerr << "WARNING: resolved note-on with no note-off to generate " << (**n) << endl;
674 #ifdef PERCUSSIVE_IGNORE_NOTE_OFFS
678 for (int i = 0; i < 16; ++i) {
679 _write_notes[i].clear();
686 template<typename Time>
688 Sequence<Time>::add_note_unlocked(const NotePtr note, void* arg)
690 /* This is the core method to add notes to a Sequence
693 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 add note %2 @ %3 dur %4\n", this, (int)note->note(), note->time(), note->length()));
695 if (resolve_overlaps_unlocked (note, arg)) {
696 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 DISALLOWED: note %2 @ %3\n", this, (int)note->note(), note->time()));
700 if (note->id() < 0) {
701 note->set_id (Evoral::next_event_id());
704 if (note->note() < _lowest_note)
705 _lowest_note = note->note();
706 if (note->note() > _highest_note)
707 _highest_note = note->note();
709 _notes.insert (note);
710 _pitches[note->channel()].insert (note);
717 template<typename Time>
719 Sequence<Time>::remove_note_unlocked(const constNotePtr note)
722 bool id_matched = false;
724 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 remove note #%2 %3 @ %4\n", this, note->id(), (int)note->note(), note->time()));
726 /* first try searching for the note using the time index, which is
727 * faster since the container is "indexed" by time. (technically, this
728 * means that lower_bound() can do a binary search rather than linear)
730 * this may not work, for reasons explained below.
733 typename Sequence<Time>::Notes::iterator i;
735 for (i = note_lower_bound(note->time()); i != _notes.end() && musical_time_equal ((*i)->time(), note->time()); ++i) {
739 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1\terasing note #%2 %3 @ %4\n", this, (*i)->id(), (int)(*i)->note(), (*i)->time()));
742 if (note->note() == _lowest_note || note->note() == _highest_note) {
747 for (typename Sequence<Time>::Notes::iterator ii = _notes.begin(); ii != _notes.end(); ++ii) {
748 if ((*ii)->note() < _lowest_note)
749 _lowest_note = (*ii)->note();
750 if ((*ii)->note() > _highest_note)
751 _highest_note = (*ii)->note();
760 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1\ttime-based lookup did not find note #%2 %3 @ %4\n", this, note->id(), (int)note->note(), note->time()));
764 /* if the note's time property was changed in tandem with some
765 * other property as the next operation after it was added to
766 * the sequence, then at the point where we call this to undo
767 * the add, the note we are targetting currently has a
768 * different time property than the one we we passed via
771 * in this scenario, we have no choice other than to linear
772 * search the list of notes and find the note by ID.
775 for (i = _notes.begin(); i != _notes.end(); ++i) {
777 if ((*i)->id() == note->id()) {
779 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1\tID-based pass, erasing note #%2 %3 @ %4\n", this, (*i)->id(), (int)(*i)->note(), (*i)->time()));
782 if (note->note() == _lowest_note || note->note() == _highest_note) {
787 for (typename Sequence<Time>::Notes::iterator ii = _notes.begin(); ii != _notes.end(); ++ii) {
788 if ((*ii)->note() < _lowest_note)
789 _lowest_note = (*ii)->note();
790 if ((*ii)->note() > _highest_note)
791 _highest_note = (*ii)->note();
804 Pitches& p (pitches (note->channel()));
806 typename Pitches::iterator j;
808 /* if we had to ID-match above, we can't expect to find it in
809 * pitches via note comparison either. so do another linear
810 * search to locate it. otherwise, we can use the note index
811 * to potentially speed things up.
816 for (j = p.begin(); j != p.end(); ++j) {
817 if ((*j)->id() == note->id()) {
825 /* Now find the same note in the "pitches" list (which indexes
826 * notes by channel+time. We care only about its note number
827 * so the search_note has all other properties unset.
830 NotePtr search_note (new Note<Time>(0, 0, 0, note->note(), 0));
832 for (j = p.lower_bound (search_note); j != p.end() && (*j)->note() == note->note(); ++j) {
835 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1\terasing pitch %2 @ %3\n", this, (int)(*j)->note(), (*j)->time()));
843 warning << string_compose ("erased note %1 not found in pitches for channel %2", *note, (int) note->channel()) << endmsg;
849 cerr << "Unable to find note to erase matching " << *note.get() << endmsg;
853 template<typename Time>
855 Sequence<Time>::remove_patch_change_unlocked (const constPatchChangePtr p)
857 typename Sequence<Time>::PatchChanges::iterator i = patch_change_lower_bound (p->time ());
859 while (i != _patch_changes.end() && (musical_time_equal ((*i)->time(), p->time()))) {
861 typename Sequence<Time>::PatchChanges::iterator tmp = i;
865 _patch_changes.erase (i);
872 template<typename Time>
874 Sequence<Time>::remove_sysex_unlocked (const SysExPtr sysex)
876 typename Sequence<Time>::SysExes::iterator i = sysex_lower_bound (sysex->time ());
877 while (i != _sysexes.end() && (*i)->time() == sysex->time()) {
879 typename Sequence<Time>::SysExes::iterator tmp = i;
890 /** Append \a ev to model. NOT realtime safe.
892 * The timestamp of event is expected to be relative to
893 * the start of this model (t=0) and MUST be monotonically increasing
894 * and MUST be >= the latest event currently in the model.
896 template<typename Time>
898 Sequence<Time>::append(const Event<Time>& event, event_id_t evid)
900 WriteLock lock(write_lock());
902 const MIDIEvent<Time>& ev = (const MIDIEvent<Time>&)event;
904 assert(_notes.empty() || ev.time() >= (*_notes.rbegin())->time());
907 if (!midi_event_is_valid(ev.buffer(), ev.size())) {
908 cerr << "WARNING: Sequence ignoring illegal MIDI event" << endl;
912 if (ev.is_note_on()) {
913 NotePtr note(new Note<Time>(ev.channel(), ev.time(), 0, ev.note(), ev.velocity()));
914 append_note_on_unlocked (note, evid);
915 } else if (ev.is_note_off()) {
916 NotePtr note(new Note<Time>(ev.channel(), ev.time(), 0, ev.note(), ev.velocity()));
917 /* XXX note: event ID is discarded because we merge the on+off events into
920 append_note_off_unlocked (note);
921 } else if (ev.is_sysex()) {
922 append_sysex_unlocked(ev, evid);
923 } else if (ev.is_cc() && (ev.cc_number() == MIDI_CTL_MSB_BANK || ev.cc_number() == MIDI_CTL_LSB_BANK)) {
924 /* note bank numbers in our _bank[] array, so that we can write an event when the program change arrives */
925 if (ev.cc_number() == MIDI_CTL_MSB_BANK) {
926 _bank[ev.channel()] &= ~(0x7f << 7);
927 _bank[ev.channel()] |= ev.cc_value() << 7;
929 _bank[ev.channel()] &= ~0x7f;
930 _bank[ev.channel()] |= ev.cc_value();
932 } else if (ev.is_cc()) {
933 append_control_unlocked(
934 Evoral::MIDI::ContinuousController(ev.event_type(), ev.channel(), ev.cc_number()),
935 ev.time(), ev.cc_value(), evid);
936 } else if (ev.is_pgm_change()) {
937 /* write a patch change with this program change and any previously set-up bank number */
938 append_patch_change_unlocked (PatchChange<Time> (ev.time(), ev.channel(), ev.pgm_number(), _bank[ev.channel()]), evid);
939 } else if (ev.is_pitch_bender()) {
940 append_control_unlocked(
941 Evoral::MIDI::PitchBender(ev.event_type(), ev.channel()),
942 ev.time(), double ((0x7F & ev.pitch_bender_msb()) << 7
943 | (0x7F & ev.pitch_bender_lsb())),
945 } else if (ev.is_channel_pressure()) {
946 append_control_unlocked(
947 Evoral::MIDI::ChannelPressure(ev.event_type(), ev.channel()),
948 ev.time(), ev.channel_pressure(), evid);
949 } else if (!_type_map.type_is_midi(ev.event_type())) {
950 printf("WARNING: Sequence: Unknown event type %X: ", ev.event_type());
951 for (size_t i=0; i < ev.size(); ++i) {
952 printf("%X ", ev.buffer()[i]);
956 printf("WARNING: Sequence: Unknown MIDI event type %X\n", ev.type());
962 template<typename Time>
964 Sequence<Time>::append_note_on_unlocked (NotePtr note, event_id_t evid)
966 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 c=%2 note %3 on @ %4 v=%5\n", this,
967 (int) note->channel(), (int) note->note(),
968 note->time(), (int) note->velocity()));
971 if (note->note() > 127) {
972 error << string_compose (_("illegal note number (%1) used in Note on event - event will be ignored"), (int) note->note()) << endmsg;
975 if (note->channel() >= 16) {
976 error << string_compose (_("illegal channel number (%1) used in Note on event - event will be ignored"), (int) note->channel()) << endmsg;
980 if (note->id() < 0) {
984 if (note->velocity() == 0) {
985 append_note_off_unlocked (note);
989 add_note_unlocked (note);
991 #ifdef PERCUSSIVE_IGNORE_NOTE_OFFS
995 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Sustained: Appending active note on %1 channel %2\n",
996 (unsigned)(uint8_t)note->note(), note->channel()));
997 _write_notes[note->channel()].insert (note);
999 #ifdef PERCUSSIVE_IGNORE_NOTE_OFFS
1001 DEBUG_TRACE(DEBUG::Sequence, "Percussive: NOT appending active note on\n");
1007 template<typename Time>
1009 Sequence<Time>::append_note_off_unlocked (NotePtr note)
1011 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 c=%2 note %3 OFF @ %4 v=%5\n",
1012 this, (int)note->channel(),
1013 (int)note->note(), note->time(), (int)note->velocity()));
1016 if (note->note() > 127) {
1017 error << string_compose (_("illegal note number (%1) used in Note off event - event will be ignored"), (int) note->note()) << endmsg;
1020 if (note->channel() >= 16) {
1021 error << string_compose (_("illegal channel number (%1) used in Note off event - event will be ignored"), (int) note->channel()) << endmsg;
1027 #ifdef PERCUSSIVE_IGNORE_NOTE_OFFS
1029 DEBUG_TRACE(DEBUG::Sequence, "Sequence Ignoring note off (percussive mode)\n");
1034 bool resolved = false;
1036 /* _write_notes is sorted earliest-latest, so this will find the first matching note (FIFO) that
1037 matches this note (by pitch & channel). the MIDI specification doesn't provide any guidance
1038 whether to use FIFO or LIFO for this matching process, so SMF is fundamentally a lossy
1042 /* XXX use _overlap_pitch_resolution to determine FIFO/LIFO ... */
1044 for (typename WriteNotes::iterator n = _write_notes[note->channel()].begin(); n != _write_notes[note->channel()].end(); ) {
1046 typename WriteNotes::iterator tmp = n;
1050 if (note->note() == nn->note() && nn->channel() == note->channel()) {
1051 assert(note->time() >= nn->time());
1053 nn->set_length (note->time() - nn->time());
1054 nn->set_off_velocity (note->velocity());
1056 _write_notes[note->channel()].erase(n);
1057 DEBUG_TRACE (DEBUG::Sequence, string_compose ("resolved note @ %2 length: %1\n", nn->length(), nn->time()));
1066 cerr << this << " spurious note off chan " << (int)note->channel()
1067 << ", note " << (int)note->note() << " @ " << note->time() << endl;
1071 template<typename Time>
1073 Sequence<Time>::append_control_unlocked(const Parameter& param, Time time, double value, event_id_t /* evid */)
1075 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 %2 @ %3 = %4 # controls: %5\n",
1076 this, _type_map.to_symbol(param), time, value, _controls.size()));
1077 boost::shared_ptr<Control> c = control(param, true);
1078 c->list()->add (time, value);
1079 /* XXX control events should use IDs */
1082 template<typename Time>
1084 Sequence<Time>::append_sysex_unlocked(const MIDIEvent<Time>& ev, event_id_t /* evid */)
1086 #ifdef DEBUG_SEQUENCE
1087 cerr << this << " SysEx @ " << ev.time() << " \t= \t [ " << hex;
1088 for (size_t i=0; i < ev.size(); ++i) {
1089 cerr << int(ev.buffer()[i]) << " ";
1090 } cerr << "]" << endl;
1093 boost::shared_ptr<MIDIEvent<Time> > event(new MIDIEvent<Time>(ev, true));
1094 /* XXX sysex events should use IDs */
1095 _sysexes.insert(event);
1098 template<typename Time>
1100 Sequence<Time>::append_patch_change_unlocked (const PatchChange<Time>& ev, event_id_t id)
1102 PatchChangePtr p (new PatchChange<Time> (ev));
1108 _patch_changes.insert (p);
1111 template<typename Time>
1113 Sequence<Time>::add_patch_change_unlocked (PatchChangePtr p)
1116 p->set_id (Evoral::next_event_id ());
1119 _patch_changes.insert (p);
1122 template<typename Time>
1124 Sequence<Time>::add_sysex_unlocked (SysExPtr s)
1127 s->set_id (Evoral::next_event_id ());
1130 _sysexes.insert (s);
1133 template<typename Time>
1135 Sequence<Time>::contains (const NotePtr& note) const
1137 ReadLock lock (read_lock());
1138 return contains_unlocked (note);
1141 template<typename Time>
1143 Sequence<Time>::contains_unlocked (const NotePtr& note) const
1145 const Pitches& p (pitches (note->channel()));
1146 NotePtr search_note(new Note<Time>(0, 0, 0, note->note()));
1148 for (typename Pitches::const_iterator i = p.lower_bound (search_note);
1149 i != p.end() && (*i)->note() == note->note(); ++i) {
1159 template<typename Time>
1161 Sequence<Time>::overlaps (const NotePtr& note, const NotePtr& without) const
1163 ReadLock lock (read_lock());
1164 return overlaps_unlocked (note, without);
1167 template<typename Time>
1169 Sequence<Time>::overlaps_unlocked (const NotePtr& note, const NotePtr& without) const
1171 Time sa = note->time();
1172 Time ea = note->end_time();
1174 const Pitches& p (pitches (note->channel()));
1175 NotePtr search_note(new Note<Time>(0, 0, 0, note->note()));
1177 for (typename Pitches::const_iterator i = p.lower_bound (search_note);
1178 i != p.end() && (*i)->note() == note->note(); ++i) {
1180 if (without && (**i) == *without) {
1184 Time sb = (*i)->time();
1185 Time eb = (*i)->end_time();
1187 if (((sb > sa) && (eb <= ea)) ||
1188 ((eb >= sa) && (eb <= ea)) ||
1189 ((sb > sa) && (sb <= ea)) ||
1190 ((sa >= sb) && (sa <= eb) && (ea <= eb))) {
1198 template<typename Time>
1200 Sequence<Time>::set_notes (const Sequence<Time>::Notes& n)
1205 /** Return the earliest note with time >= t */
1206 template<typename Time>
1207 typename Sequence<Time>::Notes::const_iterator
1208 Sequence<Time>::note_lower_bound (Time t) const
1210 NotePtr search_note(new Note<Time>(0, t, 0, 0, 0));
1211 typename Sequence<Time>::Notes::const_iterator i = _notes.lower_bound(search_note);
1212 assert(i == _notes.end() || (*i)->time() >= t);
1216 /** Return the earliest patch change with time >= t */
1217 template<typename Time>
1218 typename Sequence<Time>::PatchChanges::const_iterator
1219 Sequence<Time>::patch_change_lower_bound (Time t) const
1221 PatchChangePtr search (new PatchChange<Time> (t, 0, 0, 0));
1222 typename Sequence<Time>::PatchChanges::const_iterator i = _patch_changes.lower_bound (search);
1223 assert (i == _patch_changes.end() || musical_time_greater_or_equal_to ((*i)->time(), t));
1227 /** Return the earliest sysex with time >= t */
1228 template<typename Time>
1229 typename Sequence<Time>::SysExes::const_iterator
1230 Sequence<Time>::sysex_lower_bound (Time t) const
1232 SysExPtr search (new Event<Time> (0, t));
1233 typename Sequence<Time>::SysExes::const_iterator i = _sysexes.lower_bound (search);
1234 assert (i == _sysexes.end() || (*i)->time() >= t);
1238 template<typename Time>
1240 Sequence<Time>::get_notes (Notes& n, NoteOperator op, uint8_t val, int chan_mask) const
1245 case PitchLessThanOrEqual:
1247 case PitchGreaterThanOrEqual:
1248 get_notes_by_pitch (n, op, val, chan_mask);
1252 case VelocityLessThan:
1253 case VelocityLessThanOrEqual:
1254 case VelocityGreater:
1255 case VelocityGreaterThanOrEqual:
1256 get_notes_by_velocity (n, op, val, chan_mask);
1261 template<typename Time>
1263 Sequence<Time>::get_notes_by_pitch (Notes& n, NoteOperator op, uint8_t val, int chan_mask) const
1265 for (uint8_t c = 0; c < 16; ++c) {
1267 if (chan_mask != 0 && !((1<<c) & chan_mask)) {
1271 const Pitches& p (pitches (c));
1272 NotePtr search_note(new Note<Time>(0, 0, 0, val, 0));
1273 typename Pitches::const_iterator i;
1276 i = p.lower_bound (search_note);
1277 while (i != p.end() && (*i)->note() == val) {
1282 i = p.upper_bound (search_note);
1283 while (i != p.end() && (*i)->note() < val) {
1287 case PitchLessThanOrEqual:
1288 i = p.upper_bound (search_note);
1289 while (i != p.end() && (*i)->note() <= val) {
1294 i = p.lower_bound (search_note);
1295 while (i != p.end() && (*i)->note() > val) {
1299 case PitchGreaterThanOrEqual:
1300 i = p.lower_bound (search_note);
1301 while (i != p.end() && (*i)->note() >= val) {
1307 //fatal << string_compose (_("programming error: %1 %2", X_("get_notes_by_pitch() called with illegal operator"), op)) << endmsg;
1314 template<typename Time>
1316 Sequence<Time>::get_notes_by_velocity (Notes& n, NoteOperator op, uint8_t val, int chan_mask) const
1318 ReadLock lock (read_lock());
1320 for (typename Notes::const_iterator i = _notes.begin(); i != _notes.end(); ++i) {
1322 if (chan_mask != 0 && !((1<<((*i)->channel())) & chan_mask)) {
1328 if ((*i)->velocity() == val) {
1332 case VelocityLessThan:
1333 if ((*i)->velocity() < val) {
1337 case VelocityLessThanOrEqual:
1338 if ((*i)->velocity() <= val) {
1342 case VelocityGreater:
1343 if ((*i)->velocity() > val) {
1347 case VelocityGreaterThanOrEqual:
1348 if ((*i)->velocity() >= val) {
1353 // fatal << string_compose (_("programming error: %1 %2", X_("get_notes_by_velocity() called with illegal operator"), op)) << endmsg;
1361 template<typename Time>
1363 Sequence<Time>::set_overlap_pitch_resolution (OverlapPitchResolution opr)
1365 _overlap_pitch_resolution = opr;
1367 /* XXX todo: clean up existing overlaps in source data? */
1370 template<typename Time>
1372 Sequence<Time>::control_list_marked_dirty ()
1377 template<typename Time>
1379 Sequence<Time>::dump (ostream& str) const
1381 typename Sequence<Time>::const_iterator i;
1382 str << "+++ dump\n";
1383 for (i = begin(); i != end(); ++i) {
1386 str << "--- dump\n";
1389 template class Sequence<Evoral::MusicalTime>;
1391 } // namespace Evoral