Sequence::contains() and Sequence::overlaps() now use pitch-based indexing to speed...
[ardour2.git] / libs / evoral / src / Sequence.cpp
blob4b9fed035a6b80b2480f16df40e7e070fd451199
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
8 * version.
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 #define __STDC_LIMIT_MACROS 1
20 #include <algorithm>
21 #include <cmath>
22 #include <iostream>
23 #include <limits>
24 #include <stdexcept>
25 #include <stdint.h>
26 #include <cstdio>
28 #include "pbd/compose.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"
39 using namespace std;
40 using namespace PBD;
42 namespace Evoral {
44 // Read iterator (const_iterator)
46 template<typename Time>
47 Sequence<Time>::const_iterator::const_iterator()
48 : _seq(NULL)
49 , _is_end(true)
50 , _control_iter(_control_iters.end())
52 _event = boost::shared_ptr< Event<Time> >(new Event<Time>());
55 template<typename Time>
56 Sequence<Time>::const_iterator::const_iterator(const Sequence<Time>& seq, Time t)
57 : _seq(&seq)
58 , _type(NIL)
59 , _is_end((t == DBL_MAX) || seq.empty())
60 , _note_iter(seq.notes().end())
61 , _sysex_iter(seq.sysexes().end())
62 , _control_iter(_control_iters.end())
64 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Created Iterator @ %1 (is end: %2)\n)", t, _is_end));
66 if (!_is_end) {
67 _lock = seq.read_lock();
68 } else {
69 return;
72 typename Sequence<Time>::ReadLock lock(seq.read_lock());
74 // Find first note which begins at or after t
75 _note_iter = seq.note_lower_bound(t);
77 // Find first sysex event at or after t
78 for (typename Sequence<Time>::SysExes::const_iterator i = seq.sysexes().begin();
79 i != seq.sysexes().end(); ++i) {
80 if ((*i)->time() >= t) {
81 _sysex_iter = i;
82 break;
85 assert(_sysex_iter == seq.sysexes().end() || (*_sysex_iter)->time() >= t);
87 // Find first control event after t
88 ControlIterator earliest_control(boost::shared_ptr<ControlList>(), DBL_MAX, 0.0);
89 _control_iters.reserve(seq._controls.size());
90 bool found = false;
91 size_t earliest_control_index = 0;
92 for (Controls::const_iterator i = seq._controls.begin(); i != seq._controls.end(); ++i) {
93 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Iterator: control: %1\n", seq._type_map.to_symbol(i->first)));
94 double x, y;
95 bool ret = i->second->list()->rt_safe_earliest_event_unlocked(t, DBL_MAX, x, y, true);
96 if (!ret) {
97 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Iterator: CC %1 (size %2) has no events past %3\n",
98 i->first.id(), i->second->list()->size(), t));
99 continue;
102 assert(x >= 0);
104 if (y < i->first.min() || y > i->first.max()) {
105 cerr << "ERROR: Controller value " << y
106 << " out of range [" << i->first.min() << "," << i->first.max()
107 << "], event ignored" << endl;
108 continue;
111 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Iterator: CC %1 added (%2, %3)\n", i->first.id(), x, y));
113 const ControlIterator new_iter(i->second->list(), x, y);
114 _control_iters.push_back(new_iter);
116 // Found a new earliest_control
117 if (x < earliest_control.x) {
118 earliest_control = new_iter;
119 earliest_control_index = _control_iters.size() - 1;
120 found = true;
124 if (found) {
125 _control_iter = _control_iters.begin() + earliest_control_index;
126 assert(_control_iter != _control_iters.end());
127 } else {
128 _control_iter = _control_iters.end();
131 // Now find the earliest event overall and point to it
132 Time earliest_t = t;
134 if (_note_iter != seq.notes().end()) {
135 _type = NOTE_ON;
136 earliest_t = (*_note_iter)->time();
139 if (_sysex_iter != seq.sysexes().end()
140 && ((*_sysex_iter)->time() < earliest_t || _type == NIL)) {
141 _type = SYSEX;
142 earliest_t = (*_sysex_iter)->time();
145 if (_control_iter != _control_iters.end()
146 && earliest_control.list && earliest_control.x >= t
147 && (earliest_control.x < earliest_t || _type == NIL)) {
148 _type = CONTROL;
149 earliest_t = earliest_control.x;
152 switch (_type) {
153 case NOTE_ON:
154 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Starting at note on event @ %1\n", earliest_t));
155 _event = boost::shared_ptr< Event<Time> >(
156 new Event<Time>((*_note_iter)->on_event(), true));
157 _active_notes.push(*_note_iter);
158 break;
159 case SYSEX:
160 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Starting at sysex event @ %1\n", earliest_t));
161 _event = boost::shared_ptr< Event<Time> >(
162 new Event<Time>(*(*_sysex_iter), true));
163 break;
164 case CONTROL:
165 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Starting at control event @ %1\n", earliest_t));
166 seq.control_to_midi_event(_event, earliest_control);
167 break;
168 default:
169 break;
172 if (_type == NIL || !_event || _event->size() == 0) {
173 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Starting at end @ %1\n", t));
174 _type = NIL;
175 _is_end = true;
176 } else {
177 DEBUG_TRACE (DEBUG::Sequence, string_compose ("New iterator = 0x%x : 0x%x @ %f\n",
178 (int)_event->event_type(),
179 (int)((MIDIEvent<Time>*)_event.get())->type(),
180 _event->time()));
181 assert(midi_event_is_valid(_event->buffer(), _event->size()));
185 template<typename Time>
186 Sequence<Time>::const_iterator::~const_iterator()
190 template<typename Time>
191 void
192 Sequence<Time>::const_iterator::invalidate()
194 while (!_active_notes.empty()) {
195 _active_notes.pop();
197 _type = NIL;
198 _is_end = true;
199 if (_seq) {
200 _note_iter = _seq->notes().end();
201 _sysex_iter = _seq->sysexes().end();
203 _control_iter = _control_iters.end();
204 _lock.reset();
207 template<typename Time>
208 const typename Sequence<Time>::const_iterator&
209 Sequence<Time>::const_iterator::operator++()
211 if (_is_end) {
212 throw std::logic_error("Attempt to iterate past end of Sequence");
215 DEBUG_TRACE(DEBUG::Sequence, "Sequence::const_iterator++\n");
216 assert(_event && _event->buffer() && _event->size() > 0);
218 const MIDIEvent<Time>& ev = *((MIDIEvent<Time>*)_event.get());
220 if (!( ev.is_note()
221 || ev.is_cc()
222 || ev.is_pgm_change()
223 || ev.is_pitch_bender()
224 || ev.is_channel_pressure()
225 || ev.is_sysex()) ) {
226 cerr << "WARNING: Unknown event (type " << _type << "): " << hex
227 << int(ev.buffer()[0]) << int(ev.buffer()[1]) << int(ev.buffer()[2]) << endl;
230 double x = 0.0;
231 double y = 0.0;
232 bool ret = false;
234 // Increment past current event
235 switch (_type) {
236 case NOTE_ON:
237 ++_note_iter;
238 break;
239 case NOTE_OFF:
240 break;
241 case CONTROL:
242 // Increment current controller iterator
243 ret = _control_iter->list->rt_safe_earliest_event_unlocked(
244 _control_iter->x, DBL_MAX, x, y, false);
245 assert(!ret || x > _control_iter->x);
246 if (ret) {
247 _control_iter->x = x;
248 _control_iter->y = y;
249 } else {
250 _control_iter->list.reset();
251 _control_iter->x = DBL_MAX;
252 _control_iter->y = DBL_MAX;
255 // Find the controller with the next earliest event time
256 _control_iter = _control_iters.begin();
257 for (ControlIterators::iterator i = _control_iters.begin();
258 i != _control_iters.end(); ++i) {
259 if (i->x < _control_iter->x) {
260 _control_iter = i;
263 break;
264 case SYSEX:
265 ++_sysex_iter;
266 break;
267 default:
268 assert(false);
271 // Now find the earliest event overall and point to it
272 _type = NIL;
273 Time earliest_t = std::numeric_limits<Time>::max();
275 // Next earliest note on
276 if (_note_iter != _seq->notes().end()) {
277 _type = NOTE_ON;
278 earliest_t = (*_note_iter)->time();
281 // Use the next note off iff it's earlier or the same time as the note on
282 if (!_seq->percussive() && (!_active_notes.empty())) {
283 if (_type == NIL || _active_notes.top()->end_time() <= earliest_t) {
284 _type = NOTE_OFF;
285 earliest_t = _active_notes.top()->end_time();
289 // Use the next earliest controller iff it's earlier than the note event
290 if (_control_iter != _control_iters.end() && _control_iter->x != DBL_MAX) {
291 if (_type == NIL || _control_iter->x < earliest_t) {
292 _type = CONTROL;
293 earliest_t = _control_iter->x;
297 // Use the next earliest SysEx iff it's earlier than the controller
298 if (_sysex_iter != _seq->sysexes().end()) {
299 if (_type == NIL || (*_sysex_iter)->time() < earliest_t) {
300 _type = SYSEX;
301 earliest_t = (*_sysex_iter)->time();
305 // Set event to reflect new position
306 switch (_type) {
307 case NOTE_ON:
308 DEBUG_TRACE(DEBUG::Sequence, "iterator = note on\n");
309 *_event = (*_note_iter)->on_event();
310 _active_notes.push(*_note_iter);
311 break;
312 case NOTE_OFF:
313 DEBUG_TRACE(DEBUG::Sequence, "iterator = note off\n");
314 assert(!_active_notes.empty());
315 *_event = _active_notes.top()->off_event();
316 _active_notes.pop();
317 break;
318 case CONTROL:
319 DEBUG_TRACE(DEBUG::Sequence, "iterator = control\n");
320 _seq->control_to_midi_event(_event, *_control_iter);
321 break;
322 case SYSEX:
323 DEBUG_TRACE(DEBUG::Sequence, "iterator = sysex\n");
324 *_event = *(*_sysex_iter);
325 break;
326 default:
327 DEBUG_TRACE(DEBUG::Sequence, "iterator = end\n");
328 _is_end = true;
331 assert(_is_end || (_event->size() > 0 && _event->buffer() && _event->buffer()[0] != '\0'));
333 return *this;
336 template<typename Time>
337 bool
338 Sequence<Time>::const_iterator::operator==(const const_iterator& other) const
340 if (_seq != other._seq) {
341 return false;
342 } else if (_is_end || other._is_end) {
343 return (_is_end == other._is_end);
344 } else if (_type != other._type) {
345 return false;
346 } else {
347 return (_event == other._event);
351 template<typename Time>
352 typename Sequence<Time>::const_iterator&
353 Sequence<Time>::const_iterator::operator=(const const_iterator& other)
355 _seq = other._seq;
356 _event = other._event;
357 _active_notes = other._active_notes;
358 _type = other._type;
359 _is_end = other._is_end;
360 _note_iter = other._note_iter;
361 _sysex_iter = other._sysex_iter;
362 _control_iters = other._control_iters;
364 if (other._lock)
365 _lock = _seq->read_lock();
366 else
367 _lock.reset();
369 if (other._control_iter == other._control_iters.end()) {
370 _control_iter = _control_iters.end();
371 } else {
372 const size_t index = other._control_iter - other._control_iters.begin();
373 _control_iter = _control_iters.begin() + index;
376 return *this;
379 // Sequence
381 template<typename Time>
382 Sequence<Time>::Sequence(const TypeMap& type_map)
383 : _edited(false)
384 , _overlapping_pitches_accepted (true)
385 , _overlap_pitch_resolution (FirstOnFirstOff)
386 , _type_map(type_map)
387 , _writing(false)
388 , _end_iter(*this, DBL_MAX)
389 , _percussive(false)
390 , _lowest_note(127)
391 , _highest_note(0)
393 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Sequence constructed: %1\n", this));
394 assert(_end_iter._is_end);
395 assert( ! _end_iter._lock);
398 template<typename Time>
399 Sequence<Time>::Sequence(const Sequence<Time>& other)
400 : ControlSet (other)
401 , _edited(false)
402 , _overlapping_pitches_accepted (other._overlapping_pitches_accepted)
403 , _overlap_pitch_resolution (other._overlap_pitch_resolution)
404 , _type_map(other._type_map)
405 , _writing(false)
406 , _end_iter(*this, DBL_MAX)
407 , _percussive(other._percussive)
408 , _lowest_note(other._lowest_note)
409 , _highest_note(other._highest_note)
411 for (typename Notes::const_iterator i = other._notes.begin(); i != other._notes.end(); ++i) {
412 boost::shared_ptr<Note<Time> > n (new Note<Time> (**i));
413 _notes.insert (n);
416 for (typename SysExes::const_iterator i = other._sysexes.begin(); i != other._sysexes.end(); ++i) {
417 boost::shared_ptr<Event<Time> > n (new Event<Time> (**i, true));
418 _sysexes.push_back (n);
421 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Sequence copied: %1\n", this));
422 assert(_end_iter._is_end);
423 assert(! _end_iter._lock);
426 /** Write the controller event pointed to by \a iter to \a ev.
427 * The buffer of \a ev will be allocated or resized as necessary.
428 * The event_type of \a ev should be set to the expected output type.
429 * \return true on success
431 template<typename Time>
432 bool
433 Sequence<Time>::control_to_midi_event(
434 boost::shared_ptr< Event<Time> >& ev,
435 const ControlIterator& iter) const
437 assert(iter.list.get());
438 const uint32_t event_type = iter.list->parameter().type();
440 // initialize the event pointer with a new event, if necessary
441 if (!ev) {
442 ev = boost::shared_ptr< Event<Time> >(new Event<Time>(event_type, 0, 3, NULL, true));
445 uint8_t midi_type = _type_map.parameter_midi_type(iter.list->parameter());
446 ev->set_event_type(_type_map.midi_event_type(midi_type));
447 switch (midi_type) {
448 case MIDI_CMD_CONTROL:
449 assert(iter.list.get());
450 assert(iter.list->parameter().channel() < 16);
451 assert(iter.list->parameter().id() <= INT8_MAX);
452 assert(iter.y <= INT8_MAX);
454 ev->time() = iter.x;
455 ev->realloc(3);
456 ev->buffer()[0] = MIDI_CMD_CONTROL + iter.list->parameter().channel();
457 ev->buffer()[1] = (uint8_t)iter.list->parameter().id();
458 ev->buffer()[2] = (uint8_t)iter.y;
459 break;
461 case MIDI_CMD_PGM_CHANGE:
462 assert(iter.list.get());
463 assert(iter.list->parameter().channel() < 16);
464 assert(iter.y <= INT8_MAX);
466 ev->time() = iter.x;
467 ev->realloc(2);
468 ev->buffer()[0] = MIDI_CMD_PGM_CHANGE + iter.list->parameter().channel();
469 ev->buffer()[1] = (uint8_t)iter.y;
470 break;
472 case MIDI_CMD_BENDER:
473 assert(iter.list.get());
474 assert(iter.list->parameter().channel() < 16);
475 assert(iter.y < (1<<14));
477 ev->time() = iter.x;
478 ev->realloc(3);
479 ev->buffer()[0] = MIDI_CMD_BENDER + iter.list->parameter().channel();
480 ev->buffer()[1] = uint16_t(iter.y) & 0x7F; // LSB
481 ev->buffer()[2] = (uint16_t(iter.y) >> 7) & 0x7F; // MSB
482 break;
484 case MIDI_CMD_CHANNEL_PRESSURE:
485 assert(iter.list.get());
486 assert(iter.list->parameter().channel() < 16);
487 assert(iter.y <= INT8_MAX);
489 ev->time() = iter.x;
490 ev->realloc(2);
491 ev->buffer()[0] = MIDI_CMD_CHANNEL_PRESSURE + iter.list->parameter().channel();
492 ev->buffer()[1] = (uint8_t)iter.y;
493 break;
495 default:
496 return false;
499 return true;
502 /** Clear all events from the model.
504 template<typename Time>
505 void
506 Sequence<Time>::clear()
508 WriteLock lock(write_lock());
509 _notes.clear();
510 for (Controls::iterator li = _controls.begin(); li != _controls.end(); ++li)
511 li->second->list()->clear();
514 /** Begin a write of events to the model.
516 * If \a mode is Sustained, complete notes with length are constructed as note
517 * on/off events are received. Otherwise (Percussive), only note on events are
518 * stored; note off events are discarded entirely and all contained notes will
519 * have length 0.
521 template<typename Time>
522 void
523 Sequence<Time>::start_write()
525 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 : start_write (percussive = %2)\n", this, _percussive));
526 WriteLock lock(write_lock());
527 _writing = true;
528 for (int i = 0; i < 16; ++i) {
529 _write_notes[i].clear();
531 _dirty_controls.clear();
534 /** Finish a write of events to the model.
536 * If \a delete_stuck is true and the current mode is Sustained, note on events
537 * that were never resolved with a corresonding note off will be deleted.
538 * Otherwise they will remain as notes with length 0.
540 template<typename Time>
541 void
542 Sequence<Time>::end_write (bool delete_stuck)
544 WriteLock lock(write_lock());
546 if (!_writing) {
547 return;
550 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 : end_write (%2 notes)\n", this, _notes.size()));
552 if (!_percussive && delete_stuck) {
553 for (typename Notes::iterator n = _notes.begin(); n != _notes.end() ;) {
554 typename Notes::iterator next = n;
555 ++next;
556 if ((*n)->length() == 0) {
557 cerr << "WARNING: Stuck note lost: " << (*n)->note() << endl;
558 _notes.erase(n);
561 n = next;
565 for (int i = 0; i < 16; ++i) {
566 if (!_write_notes[i].empty()) {
567 cerr << "WARNING: Sequence<Time>::end_write: Channel " << i << " has "
568 << _write_notes[i].size() << " stuck notes" << endl;
570 _write_notes[i].clear();
573 for (ControlLists::const_iterator i = _dirty_controls.begin(); i != _dirty_controls.end(); ++i) {
574 (*i)->mark_dirty();
577 _writing = false;
581 template<typename Time>
582 bool
583 Sequence<Time>::add_note_unlocked(const boost::shared_ptr< Note<Time> > note)
585 /* This is the core method to add notes to a Sequence
588 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 add note %2 @ %3\n", this, (int)note->note(), note->time()));
590 if (!_overlapping_pitches_accepted && overlaps_unlocked (note)) {
591 return false;
594 _edited = true;
596 if (note->note() < _lowest_note)
597 _lowest_note = note->note();
598 if (note->note() > _highest_note)
599 _highest_note = note->note();
601 _notes.insert (note);
602 _pitches[note->channel()].insert (note);
604 return true;
607 template<typename Time>
608 void
609 Sequence<Time>::remove_note_unlocked(const boost::shared_ptr< const Note<Time> > note)
611 bool erased = false;
613 _edited = true;
615 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 remove note %2 @ %3\n", this, (int)note->note(), note->time()));
617 for (typename Sequence<Time>::Notes::iterator i = note_lower_bound(note->time());
618 i != _notes.end() && (*i)->time() == note->time(); ++i) {
620 if (*i == note) {
622 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1\terasing note %2 @ %3\n", this, (int)(*i)->note(), (*i)->time()));
623 _notes.erase (i);
625 if ((*i)->note() == _lowest_note || (*i)->note() == _highest_note) {
627 _lowest_note = 127;
628 _highest_note = 0;
630 for (typename Sequence<Time>::Notes::iterator ii = _notes.begin(); ii != _notes.end(); ++ii) {
631 if ((*ii)->note() < _lowest_note)
632 _lowest_note = (*ii)->note();
633 if ((*ii)->note() > _highest_note)
634 _highest_note = (*ii)->note();
638 erased = true;
642 Pitches& p (pitches (note->channel()));
644 boost::shared_ptr< Note<Time> > search_note(new Note<Time>(0, 0, 0, note->note(), 0));
646 for (typename Pitches::iterator i = p.lower_bound (search_note);
647 i != p.end() && (*i)->note() == note->note(); ++i) {
648 if (*i == note) {
649 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1\terasing pitch %2 @ %3\n", this, (int)(*i)->note(), (*i)->time()));
650 p.erase (i);
654 if (!erased) {
655 cerr << "Unable to find note to erase" << endl;
659 /** Append \a ev to model. NOT realtime safe.
661 * The timestamp of event is expected to be relative to
662 * the start of this model (t=0) and MUST be monotonically increasing
663 * and MUST be >= the latest event currently in the model.
665 template<typename Time>
666 void
667 Sequence<Time>::append(const Event<Time>& event)
669 WriteLock lock(write_lock());
670 _edited = true;
672 const MIDIEvent<Time>& ev = (const MIDIEvent<Time>&)event;
674 assert(_notes.empty() || ev.time() >= (*_notes.rbegin())->time());
675 assert(_writing);
677 if (!midi_event_is_valid(ev.buffer(), ev.size())) {
678 cerr << "WARNING: Sequence ignoring illegal MIDI event" << endl;
679 return;
682 if (ev.is_note_on()) {
683 boost::shared_ptr< Note<Time> > note(new Note<Time>(ev.channel(), ev.time(), 0, ev.note(), ev.velocity()));
684 append_note_on_unlocked (note);
685 } else if (ev.is_note_off()) {
686 boost::shared_ptr< Note<Time> > note(new Note<Time>(ev.channel(), ev.time(), 0, ev.note(), ev.velocity()));
687 append_note_off_unlocked (note);
688 } else if (ev.is_sysex()) {
689 append_sysex_unlocked(ev);
690 } else if (!_type_map.type_is_midi(ev.event_type())) {
691 printf("WARNING: Sequence: Unknown event type %X: ", ev.event_type());
692 for (size_t i=0; i < ev.size(); ++i) {
693 printf("%X ", ev.buffer()[i]);
695 printf("\n");
696 } else if (ev.is_cc()) {
697 append_control_unlocked(
698 Evoral::MIDI::ContinuousController(ev.event_type(), ev.channel(), ev.cc_number()),
699 ev.time(), ev.cc_value());
700 } else if (ev.is_pgm_change()) {
701 append_control_unlocked(
702 Evoral::MIDI::ProgramChange(ev.event_type(), ev.channel()),
703 ev.time(), ev.pgm_number());
704 } else if (ev.is_pitch_bender()) {
705 append_control_unlocked(
706 Evoral::MIDI::PitchBender(ev.event_type(), ev.channel()),
707 ev.time(), double( (0x7F & ev.pitch_bender_msb()) << 7
708 | (0x7F & ev.pitch_bender_lsb()) ));
709 } else if (ev.is_channel_pressure()) {
710 append_control_unlocked(
711 Evoral::MIDI::ChannelPressure(ev.event_type(), ev.channel()),
712 ev.time(), ev.channel_pressure());
713 } else {
714 printf("WARNING: Sequence: Unknown MIDI event type %X\n", ev.type());
718 template<typename Time>
719 void
720 Sequence<Time>::append_note_on_unlocked (boost::shared_ptr< Note<Time> > note)
722 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 c=%2 note %3 on @ %4 v=%5\n", this,
723 (int) note->channel(), (int) note->note(),
724 note->time(), (int) note->velocity()));
725 assert(note->note() <= 127);
726 assert(note->channel() < 16);
727 assert(_writing);
729 if (note->velocity() == 0) {
730 append_note_off_unlocked (note);
731 return;
734 add_note_unlocked (note);
736 if (!_percussive) {
737 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Sustained: Appending active note on %1 channel %2\n",
738 (unsigned)(uint8_t)note->note(), note->channel()));
739 _write_notes[note->channel()].insert (note);
740 } else {
741 DEBUG_TRACE(DEBUG::Sequence, "Percussive: NOT appending active note on\n");
745 template<typename Time>
746 void
747 Sequence<Time>::append_note_off_unlocked (boost::shared_ptr< Note<Time> > note)
749 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 c=%2 note %3 on @ %4 v=%5\n",
750 this, (int)note->channel(),
751 (int)note->note(), note->time(), (int)note->velocity()));
752 assert(note->note() <= 127);
753 assert(note->channel() < 16);
754 assert(_writing);
755 _edited = true;
757 if (_percussive) {
758 DEBUG_TRACE(DEBUG::Sequence, "Sequence Ignoring note off (percussive mode)\n");
759 return;
762 bool resolved = false;
764 /* _write_notes is sorted earliest-latest, so this will find the first matching note (FIFO) that
765 matches this note (by pitch & channel). the MIDI specification doesn't provide any guidance
766 whether to use FIFO or LIFO for this matching process, so SMF is fundamentally a lossy
767 format.
770 /* XXX use _overlap_pitch_resolution to determine FIFO/LIFO ... */
772 for (typename WriteNotes::iterator n = _write_notes[note->channel()].begin(); n != _write_notes[note->channel()].end(); ++n) {
773 boost::shared_ptr< Note<Time> > nn = *n;
774 if (note->note() == nn->note() && nn->channel() == note->channel()) {
775 assert(note->time() >= nn->time());
777 nn->set_length (note->time() - nn->time());
778 nn->set_off_velocity (note->velocity());
780 _write_notes[note->channel()].erase(n);
781 DEBUG_TRACE (DEBUG::Sequence, string_compose ("resolved note, length: %1\n", note->length()));
782 resolved = true;
783 break;
787 if (!resolved) {
788 cerr << this << " spurious note off chan " << (int)note->channel()
789 << ", note " << (int)note->note() << " @ " << note->time() << endl;
793 template<typename Time>
794 void
795 Sequence<Time>::append_control_unlocked(const Parameter& param, Time time, double value)
797 DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 %2 @ %3\t=\t%4 # controls: %5\n",
798 this, _type_map.to_symbol(param), time, value, _controls.size()));
799 boost::shared_ptr<Control> c = control(param, true);
800 c->list()->rt_add(time, value);
803 template<typename Time>
804 void
805 Sequence<Time>::append_sysex_unlocked(const MIDIEvent<Time>& ev)
807 #ifdef DEBUG_SEQUENCE
808 cerr << this << " SysEx @ " << ev.time() << " \t= \t [ " << hex;
809 for (size_t i=0; i < ev.size(); ++i) {
810 cerr << int(ev.buffer()[i]) << " ";
811 } cerr << "]" << endl;
812 #endif
814 boost::shared_ptr<MIDIEvent<Time> > event(new MIDIEvent<Time>(ev, true));
815 _sysexes.push_back(event);
818 template<typename Time>
819 bool
820 Sequence<Time>::contains (const boost::shared_ptr< Note<Time> >& note) const
822 return contains_unlocked (note);
825 template<typename Time>
826 bool
827 Sequence<Time>::contains_unlocked (const boost::shared_ptr< Note<Time> >& note) const
829 const Pitches& p (pitches (note->channel()));
830 boost::shared_ptr< Note<Time> > search_note(new Note<Time>(0, 0, 0, 0, note->note()));
832 for (typename Pitches::const_iterator i = p.lower_bound (search_note);
833 i != p.end() && (*i)->note() == note->note(); ++i) {
835 if (**i == *note) {
836 cerr << "Existing note matches: " << *i << endl;
837 return true;
841 return false;
844 template<typename Time>
845 bool
846 Sequence<Time>::overlaps (const boost::shared_ptr< Note<Time> >& note) const
848 ReadLock lock (read_lock());
849 return overlaps_unlocked (note);
852 template<typename Time>
853 bool
854 Sequence<Time>::overlaps_unlocked (const boost::shared_ptr< Note<Time> >& note) const
856 Time sa = note->time();
857 Time ea = note->end_time();
859 const Pitches& p (pitches (note->channel()));
860 boost::shared_ptr< Note<Time> > search_note(new Note<Time>(0, 0, 0, 0, note->note()));
862 for (typename Pitches::const_iterator i = p.lower_bound (search_note);
863 i != p.end() && (*i)->note() == note->note(); ++i) {
865 Time sb = (*i)->time();
866 Time eb = (*i)->end_time();
868 if (((sb > sa) && (eb <= ea)) ||
869 ((eb >= sa) && (eb <= ea)) ||
870 ((sb > sa) && (sb <= ea)) ||
871 ((sa >= sb) && (sa <= eb) && (ea <= eb))) {
872 return true;
876 return false;
879 template<typename Time>
880 void
881 Sequence<Time>::set_notes (const Sequence<Time>::Notes& n)
883 _notes = n;
886 /** Return the earliest note with time >= t */
887 template<typename Time>
888 typename Sequence<Time>::Notes::const_iterator
889 Sequence<Time>::note_lower_bound (Time t) const
891 boost::shared_ptr< Note<Time> > search_note(new Note<Time>(0, t, 0, 0, 0));
892 typename Sequence<Time>::Notes::const_iterator i = _notes.lower_bound(search_note);
893 assert(i == _notes.end() || (*i)->time() >= t);
894 return i;
897 template<typename Time>
898 void
899 Sequence<Time>::get_notes (Notes& n, NoteOperator op, uint8_t val, int chan_mask) const
901 switch (op) {
902 case PitchEqual:
903 case PitchLessThan:
904 case PitchLessThanOrEqual:
905 case PitchGreater:
906 case PitchGreaterThanOrEqual:
907 get_notes_by_pitch (n, op, val, chan_mask);
908 break;
910 case VelocityEqual:
911 case VelocityLessThan:
912 case VelocityLessThanOrEqual:
913 case VelocityGreater:
914 case VelocityGreaterThanOrEqual:
915 get_notes_by_velocity (n, op, val, chan_mask);
916 break;
920 template<typename Time>
921 void
922 Sequence<Time>::get_notes_by_pitch (Notes& n, NoteOperator op, uint8_t val, int chan_mask) const
924 for (uint8_t c = 0; c < 16; ++c) {
926 if (chan_mask != 0 && !((1<<c) & chan_mask)) {
927 continue;
930 const Pitches& p (pitches (c));
931 boost::shared_ptr< Note<Time> > search_note(new Note<Time>(0, 0, 0, val, 0));
932 typename Pitches::const_iterator i;
933 switch (op) {
934 case PitchEqual:
935 i = p.lower_bound (search_note);
936 while (i != p.end() && (*i)->note() == val) {
937 n.insert (*i);
939 break;
940 case PitchLessThan:
941 i = p.upper_bound (search_note);
942 while (i != p.end() && (*i)->note() < val) {
943 n.insert (*i);
945 break;
946 case PitchLessThanOrEqual:
947 i = p.upper_bound (search_note);
948 while (i != p.end() && (*i)->note() <= val) {
949 n.insert (*i);
951 break;
952 case PitchGreater:
953 i = p.lower_bound (search_note);
954 while (i != p.end() && (*i)->note() > val) {
955 n.insert (*i);
957 break;
958 case PitchGreaterThanOrEqual:
959 i = p.lower_bound (search_note);
960 while (i != p.end() && (*i)->note() >= val) {
961 n.insert (*i);
963 break;
965 default:
966 //fatal << string_compose (_("programming error: %1 %2", X_("get_notes_by_pitch() called with illegal operator"), op)) << endmsg;
967 abort ();
968 /* NOTREACHED*/
973 template<typename Time>
974 void
975 Sequence<Time>::get_notes_by_velocity (Notes& n, NoteOperator op, uint8_t val, int chan_mask) const
977 ReadLock lock (read_lock());
979 for (typename Notes::const_iterator i = _notes.begin(); i != _notes.end(); ++i) {
981 if (chan_mask != 0 && !((1<<((*i)->channel())) & chan_mask)) {
982 continue;
985 switch (op) {
986 case VelocityEqual:
987 if ((*i)->velocity() == val) {
988 n.insert (*i);
990 break;
991 case VelocityLessThan:
992 if ((*i)->velocity() < val) {
993 n.insert (*i);
995 break;
996 case VelocityLessThanOrEqual:
997 if ((*i)->velocity() <= val) {
998 n.insert (*i);
1000 break;
1001 case VelocityGreater:
1002 if ((*i)->velocity() > val) {
1003 n.insert (*i);
1005 break;
1006 case VelocityGreaterThanOrEqual:
1007 if ((*i)->velocity() >= val) {
1008 n.insert (*i);
1010 break;
1011 default:
1012 // fatal << string_compose (_("programming error: %1 %2", X_("get_notes_by_velocity() called with illegal operator"), op)) << endmsg;
1013 abort ();
1014 /* NOTREACHED*/
1020 template<typename Time>
1021 void
1022 Sequence<Time>::set_overlap_pitch_resolution (OverlapPitchResolution opr)
1024 _overlap_pitch_resolution = opr;
1026 /* XXX todo: clean up existing overlaps in source data? */
1029 template class Sequence<Evoral::MusicalTime>;
1031 } // namespace Evoral