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 #define __STDC_LIMIT_MACROS 1
27 #include "evoral/Control.hpp"
28 #include "evoral/ControlList.hpp"
29 #include "evoral/ControlSet.hpp"
30 #include "evoral/EventSink.hpp"
31 #include "evoral/MIDIParameters.hpp"
32 #include "evoral/Sequence.hpp"
33 #include "evoral/TypeMap.hpp"
34 #include "evoral/midi_util.h"
36 //#define DEBUG_SEQUENCE 1
38 #include <boost/format.hpp>
40 #define DUMP(x) cerr << (x);
49 template<typename Time>
50 void Sequence<Time>::write_lock() {
55 template<typename Time>
56 void Sequence<Time>::write_unlock() {
57 _lock.writer_unlock();
58 _control_lock.unlock();
61 template<typename Time>
62 void Sequence<Time>::read_lock() const {
66 template<typename Time>
67 void Sequence<Time>::read_unlock() const {
68 _lock.reader_unlock();
72 // Read iterator (const_iterator)
74 template<typename Time>
75 Sequence<Time>::const_iterator::const_iterator()
79 , _control_iter(_control_iters.end())
81 _event = boost::shared_ptr< Event<Time> >(new Event<Time>());
84 template<typename Time>
85 Sequence<Time>::const_iterator::const_iterator(const Sequence<Time>& seq, Time t)
88 , _is_end((t == DBL_MAX) || seq.empty())
90 , _note_iter(seq.notes().end())
91 , _sysex_iter(seq.sysexes().end())
92 , _control_iter(_control_iters.end())
94 DUMP(format("Created Iterator @ %1% (is end: %2%)\n)") % t % _is_end);
102 // Find first note which begins after t
103 for (typename Sequence<Time>::Notes::const_iterator i = seq.notes().begin();
104 i != seq.notes().end(); ++i) {
105 if ((*i)->time() >= t) {
110 assert(_note_iter == seq.notes().end() || (*_note_iter)->time() >= t);
112 // Find first sysex event after t
113 for (typename Sequence<Time>::SysExes::const_iterator i = seq.sysexes().begin();
114 i != seq.sysexes().end(); ++i) {
115 if ((*i)->time() >= t) {
120 assert(_sysex_iter == seq.sysexes().end() || (*_sysex_iter)->time() >= t);
122 // Find first control event after t
123 ControlIterator earliest_control(boost::shared_ptr<ControlList>(), DBL_MAX, 0.0);
124 _control_iters.reserve(seq._controls.size());
126 size_t earliest_control_index = 0;
127 for (Controls::const_iterator i = seq._controls.begin(); i != seq._controls.end(); ++i) {
128 DUMP(format("Iterator: control: %1%\n") % seq._type_map.to_symbol(i->first));
130 bool ret = i->second->list()->rt_safe_earliest_event_unlocked(t, DBL_MAX, x, y);
132 DUMP(format("Iterator: CC %1% (size %2%) has no events past %3%\n")
133 % i->first.id() % i->second->list()->size() % t);
139 if (y < i->first.min() || y > i->first.max()) {
140 cerr << "ERROR: Controller value " << y
141 << " out of range [" << i->first.min() << "," << i->first.max()
142 << "], event ignored" << endl;
146 DUMP(format("Iterator: CC %1% added (%2%, %3%)\n") % i->first.id() % x % y);
148 const ControlIterator new_iter(i->second->list(), x, y);
149 _control_iters.push_back(new_iter);
151 // Found a new earliest_control
152 if (x < earliest_control.x) {
153 earliest_control = new_iter;
154 earliest_control_index = _control_iters.size() - 1;
160 _control_iter = _control_iters.begin() + earliest_control_index;
162 _control_iter = _control_iters.end();
165 // Now find the earliest event overall and point to it
168 if (_note_iter != seq.notes().end()) {
170 earliest_t = (*_note_iter)->time();
173 if (_sysex_iter != seq.sysexes().end() && (*_sysex_iter)->time() < earliest_t) {
175 earliest_t = (*_sysex_iter)->time();
178 if (_control_iter != _control_iters.end()
179 && earliest_control.list && earliest_control.x >= t
180 && earliest_control.x < earliest_t) {
182 earliest_t = earliest_control.x;
187 DUMP(format("Starting at note on event @ %1%\n") % earliest_t);
188 _event = boost::shared_ptr< Event<Time> >(
189 new Event<Time>((*_note_iter)->on_event(), true));
190 _active_notes.push(*_note_iter);
193 DUMP(format("Starting at sysex event @ %1%\n") % earliest_t);
194 _event = boost::shared_ptr< Event<Time> >(
195 new Event<Time>(*(*_sysex_iter), true));
198 DUMP(format("Starting at control event @ %1%\n") % earliest_t);
199 seq.control_to_midi_event(_event, earliest_control);
205 if (_type == NIL || !_event || _event->size() == 0) {
206 DUMP(format("Starting at end @ %1%\n") % t);
212 DUMP(format("New iterator = %1% : %2% @ %3%\n")
213 % (int)_event->event_type()
214 % (int)((MIDIEvent<Time>*)_event.get())->type()
216 assert(midi_event_is_valid(_event->buffer(), _event->size()));
220 template<typename Time>
221 Sequence<Time>::const_iterator::~const_iterator()
228 template<typename Time>
230 Sequence<Time>::const_iterator::invalidate()
232 while (!_active_notes.empty()) {
238 _note_iter = _seq->notes().end();
239 _sysex_iter = _seq->sysexes().end();
241 _control_iter = _control_iters.end();
248 template<typename Time>
249 const typename Sequence<Time>::const_iterator&
250 Sequence<Time>::const_iterator::operator++()
253 throw std::logic_error("Attempt to iterate past end of Sequence");
256 DUMP("Sequence::const_iterator++\n");
257 assert(_event && _event->buffer() && _event->size() > 0);
259 const MIDIEvent<Time>& ev = *((MIDIEvent<Time>*)_event.get());
263 || ev.is_pgm_change()
264 || ev.is_pitch_bender()
265 || ev.is_channel_pressure()
266 || ev.is_sysex()) ) {
267 cerr << "WARNING: Unknown event (type " << _type << "): " << hex
268 << int(ev.buffer()[0]) << int(ev.buffer()[1]) << int(ev.buffer()[2]) << endl;
275 // Increment past current event
283 // Increment current controller iterator
284 ret = _control_iter->list->rt_safe_earliest_event_unlocked(
285 _control_iter->x, DBL_MAX, x, y, false);
286 assert(!ret || x > _control_iter->x);
288 _control_iter->x = x;
289 _control_iter->y = y;
291 _control_iter->list.reset();
292 _control_iter->x = DBL_MAX;
293 _control_iter->y = DBL_MAX;
296 // Find the controller with the next earliest event time
297 _control_iter = _control_iters.begin();
298 for (ControlIterators::iterator i = _control_iters.begin();
299 i != _control_iters.end(); ++i) {
300 if (i->x < _control_iter->x) {
312 // Now find the earliest event overall and point to it
314 Time earliest_t = std::numeric_limits<Time>::max();
316 // Next earliest note on
317 if (_note_iter != _seq->notes().end()) {
319 earliest_t = (*_note_iter)->time();
322 // Use the next note off iff it's earlier or the same time as the note on
323 if (!_seq->percussive() && (!_active_notes.empty())) {
324 if (_type == NIL || _active_notes.top()->end_time() <= earliest_t) {
326 earliest_t = _active_notes.top()->end_time();
330 // Use the next earliest controller iff it's earlier than the note event
331 if (_control_iter != _control_iters.end() && _control_iter->x != DBL_MAX) {
332 if (_type == NIL || _control_iter->x < earliest_t) {
334 earliest_t = _control_iter->x;
338 // Use the next earliest SysEx iff it's earlier than the controller
339 if (_sysex_iter != _seq->sysexes().end()) {
340 if (_type == NIL || (*_sysex_iter)->time() < earliest_t) {
342 earliest_t = (*_sysex_iter)->time();
346 // Set event to reflect new position
349 DUMP("iterator = note on\n");
350 *_event = (*_note_iter)->on_event();
351 _active_notes.push(*_note_iter);
354 DUMP("iterator = note off\n");
355 assert(!_active_notes.empty());
356 *_event = _active_notes.top()->off_event();
360 DUMP("iterator = control\n");
361 _seq->control_to_midi_event(_event, *_control_iter);
364 DUMP("iterator = sysex\n");
365 *_event = *(*_sysex_iter);
368 DUMP("iterator = end\n");
372 assert(_is_end || (_event->size() > 0 && _event->buffer() && _event->buffer()[0] != '\0'));
377 template<typename Time>
379 Sequence<Time>::const_iterator::operator==(const const_iterator& other) const
381 if (_seq != other._seq) {
383 } else if (_is_end || other._is_end) {
384 return (_is_end == other._is_end);
385 } else if (_type != other._type) {
388 return (_event == other._event);
392 template<typename Time>
393 typename Sequence<Time>::const_iterator&
394 Sequence<Time>::const_iterator::operator=(const const_iterator& other)
396 if (_seq != other._seq) {
401 other._seq->read_lock();
403 } else if (!_locked && other._locked) {
408 _event = other._event;
409 _active_notes = other._active_notes;
411 _is_end = other._is_end;
412 _locked = other._locked;
413 _note_iter = other._note_iter;
414 _sysex_iter = other._sysex_iter;
415 _control_iters = other._control_iters;
417 if (other._control_iter == other._control_iters.end()) {
418 _control_iter = _control_iters.end();
420 const size_t index = other._control_iter - other._control_iters.begin();
421 _control_iter = _control_iters.begin() + index;
429 template<typename Time>
430 Sequence<Time>::Sequence(const TypeMap& type_map, size_t size)
432 , _type_map(type_map)
435 , _end_iter(*this, DBL_MAX)
440 DUMP(format("Sequence (size %1%) constructed: %2%\n") % size % this);
441 assert(_end_iter._is_end);
442 assert( ! _end_iter._locked);
445 /** Write the controller event pointed to by \a iter to \a ev.
446 * The buffer of \a ev will be allocated or resized as necessary.
447 * The event_type of \a ev should be set to the expected output type.
448 * \return true on success
450 template<typename Time>
452 Sequence<Time>::control_to_midi_event(
453 boost::shared_ptr< Event<Time> >& ev,
454 const ControlIterator& iter) const
456 assert(iter.list.get());
457 const uint32_t event_type = iter.list->parameter().type();
459 // initialize the event pointer with a new event, if necessary
461 ev = boost::shared_ptr< Event<Time> >(new Event<Time>(event_type, 0, 3, NULL, true));
464 uint8_t midi_type = _type_map.parameter_midi_type(iter.list->parameter());
465 ev->set_event_type(_type_map.midi_event_type(midi_type));
467 case MIDI_CMD_CONTROL:
468 assert(iter.list.get());
469 assert(iter.list->parameter().channel() < 16);
470 assert(iter.list->parameter().id() <= INT8_MAX);
471 assert(iter.y <= INT8_MAX);
475 ev->buffer()[0] = MIDI_CMD_CONTROL + iter.list->parameter().channel();
476 ev->buffer()[1] = (uint8_t)iter.list->parameter().id();
477 ev->buffer()[2] = (uint8_t)iter.y;
480 case MIDI_CMD_PGM_CHANGE:
481 assert(iter.list.get());
482 assert(iter.list->parameter().channel() < 16);
483 assert(iter.y <= INT8_MAX);
487 ev->buffer()[0] = MIDI_CMD_PGM_CHANGE + iter.list->parameter().channel();
488 ev->buffer()[1] = (uint8_t)iter.y;
491 case MIDI_CMD_BENDER:
492 assert(iter.list.get());
493 assert(iter.list->parameter().channel() < 16);
494 assert(iter.y < (1<<14));
498 ev->buffer()[0] = MIDI_CMD_BENDER + iter.list->parameter().channel();
499 ev->buffer()[1] = uint16_t(iter.y) & 0x7F; // LSB
500 ev->buffer()[2] = (uint16_t(iter.y) >> 7) & 0x7F; // MSB
503 case MIDI_CMD_CHANNEL_PRESSURE:
504 assert(iter.list.get());
505 assert(iter.list->parameter().channel() < 16);
506 assert(iter.y <= INT8_MAX);
510 ev->buffer()[0] = MIDI_CMD_CHANNEL_PRESSURE + iter.list->parameter().channel();
511 ev->buffer()[1] = (uint8_t)iter.y;
521 /** Clear all events from the model.
523 template<typename Time>
525 Sequence<Time>::clear()
529 for (Controls::iterator li = _controls.begin(); li != _controls.end(); ++li)
530 li->second->list()->clear();
531 _lock.writer_unlock();
534 /** Begin a write of events to the model.
536 * If \a mode is Sustained, complete notes with length are constructed as note
537 * on/off events are received. Otherwise (Percussive), only note on events are
538 * stored; note off events are discarded entirely and all contained notes will
541 template<typename Time>
543 Sequence<Time>::start_write()
545 DUMP(format("%1% : start_write (percussive = %2%)\n") % this % _percussive);
548 for (int i = 0; i < 16; ++i) {
549 _write_notes[i].clear();
551 _dirty_controls.clear();
555 /** Finish a write of events to the model.
557 * If \a delete_stuck is true and the current mode is Sustained, note on events
558 * that were never resolved with a corresonding note off will be deleted.
559 * Otherwise they will remain as notes with length 0.
561 template<typename Time>
563 Sequence<Time>::end_write(bool delete_stuck)
568 DUMP(format("%1% : end_write (%2% notes)\n") % this % _notes.size());
570 if (!_percussive && delete_stuck) {
571 for (typename Notes::iterator n = _notes.begin(); n != _notes.end() ;) {
572 if ((*n)->length() == 0) {
573 cerr << "WARNING: Stuck note lost: " << (*n)->note() << endl;
575 // we have to break here because erase invalidates the iterator
583 for (int i = 0; i < 16; ++i) {
584 if (!_write_notes[i].empty()) {
585 cerr << "WARNING: Sequence<Time>::end_write: Channel " << i << " has "
586 << _write_notes[i].size() << " stuck notes" << endl;
588 _write_notes[i].clear();
591 for (ControlLists::const_iterator i = _dirty_controls.begin(); i != _dirty_controls.end(); ++i) {
599 /** Append \a ev to model. NOT realtime safe.
601 * Timestamps of events in \a buf are expected to be relative to
602 * the start of this model (t=0) and MUST be monotonically increasing
603 * and MUST be >= the latest event currently in the model.
605 template<typename Time>
607 Sequence<Time>::append(const Event<Time>& event)
612 const MIDIEvent<Time>& ev = (const MIDIEvent<Time>&)event;
614 assert(_notes.empty() || ev.time() >= _notes.back()->time());
617 if (!midi_event_is_valid(ev.buffer(), ev.size())) {
618 cerr << "WARNING: Sequence ignoring illegal MIDI event" << endl;
623 if (ev.is_note_on()) {
624 append_note_on_unlocked(ev.channel(), ev.time(), ev.note(), ev.velocity());
625 } else if (ev.is_note_off()) {
626 append_note_off_unlocked(ev.channel(), ev.time(), ev.note());
627 } else if (ev.is_sysex()) {
628 append_sysex_unlocked(ev);
629 } else if (!_type_map.type_is_midi(ev.event_type())) {
630 printf("WARNING: Sequence: Unknown event type %X: ", ev.event_type());
631 for (size_t i=0; i < ev.size(); ++i) {
632 printf("%X ", ev.buffer()[i]);
635 } else if (ev.is_cc()) {
636 append_control_unlocked(
637 Evoral::MIDI::ContinuousController(ev.event_type(), ev.channel(), ev.cc_number()),
638 ev.time(), ev.cc_value());
639 } else if (ev.is_pgm_change()) {
640 append_control_unlocked(
641 Evoral::MIDI::ProgramChange(ev.event_type(), ev.channel()),
642 ev.time(), ev.pgm_number());
643 } else if (ev.is_pitch_bender()) {
644 append_control_unlocked(
645 Evoral::MIDI::PitchBender(ev.event_type(), ev.channel()),
646 ev.time(), double( (0x7F & ev.pitch_bender_msb()) << 7
647 | (0x7F & ev.pitch_bender_lsb()) ));
648 } else if (ev.is_channel_pressure()) {
649 append_control_unlocked(
650 Evoral::MIDI::ChannelPressure(ev.event_type(), ev.channel()),
651 ev.time(), ev.channel_pressure());
653 printf("WARNING: Sequence: Unknown MIDI event type %X\n", ev.type());
659 template<typename Time>
661 Sequence<Time>::append_note_on_unlocked(uint8_t chan, Time time, uint8_t note_num, uint8_t velocity)
663 DUMP(format("%1% c=%2% note %3% on @ %4% v=%5%\n")
664 % this % (int)chan % (int)note_num % time % (int)velocity);
665 assert(note_num <= 127);
671 append_note_off_unlocked(chan, time, note_num);
675 if (note_num < _lowest_note)
676 _lowest_note = note_num;
677 if (note_num > _highest_note)
678 _highest_note = note_num;
680 boost::shared_ptr< Note<Time> > new_note(new Note<Time>(chan, time, 0, note_num, velocity));
681 _notes.push_back(new_note);
683 DUMP(format("Sustained: Appending active note on %1% channel %2%\n")
684 % (unsigned)(uint8_t)note_num % chan);
685 _write_notes[chan].push_back(_notes.size() - 1);
687 DUMP("Percussive: NOT appending active note on\n");
691 template<typename Time>
693 Sequence<Time>::append_note_off_unlocked(uint8_t chan, Time time, uint8_t note_num)
695 DUMP(format("%1% c=%2% note %3% off @ %4%\n")
696 % this % (int)chan % (int)note_num % time);
697 assert(note_num <= 127);
703 DUMP("Sequence Ignoring note off (percussive mode)\n");
707 /* FIXME: make _write_notes fixed size (127 noted) for speed */
709 /* FIXME: note off velocity for that one guy out there who actually has
710 * keys that send it */
712 bool resolved = false;
714 for (WriteNotes::iterator n = _write_notes[chan].begin(); n
715 != _write_notes[chan].end(); ++n) {
716 Note<Time>& note = *_notes[*n].get();
717 if (note.note() == note_num) {
718 assert(time >= note.time());
719 note.set_length(time - note.time());
720 _write_notes[chan].erase(n);
721 DUMP(format("resolved note, length: %1%\n") % note.length());
728 cerr << this << " spurious note off chan " << (int)chan
729 << ", note " << (int)note_num << " @ " << time << endl;
733 template<typename Time>
735 Sequence<Time>::append_control_unlocked(const Parameter& param, Time time, double value)
737 DUMP(format("%1% %2% @ %3%\t=\t%4% # controls: %5%\n")
738 % this % _type_map.to_symbol(param) % time % value % _controls.size());
739 boost::shared_ptr<Control> c = control(param, true);
740 c->list()->rt_add(time, value);
743 template<typename Time>
745 Sequence<Time>::append_sysex_unlocked(const MIDIEvent<Time>& ev)
747 #ifdef DEBUG_SEQUENCE
748 cerr << this << " SysEx @ " << ev.time() << " \t= \t [ " << hex;
749 for (size_t i=0; i < ev.size(); ++i) {
750 cerr << int(ev.buffer()[i]) << " ";
751 } cerr << "]" << endl;
754 boost::shared_ptr<MIDIEvent<Time> > event(new MIDIEvent<Time>(ev, true));
755 _sysexes.push_back(event);
758 template<typename Time>
760 Sequence<Time>::add_note_unlocked(const boost::shared_ptr< Note<Time> > note)
762 DUMP(format("%1% add note %2% @ %3%\n") % this % (int)note->note() % note->time());
764 typename Notes::iterator i = upper_bound(_notes.begin(), _notes.end(), note,
765 note_time_comparator);
766 _notes.insert(i, note);
769 template<typename Time>
771 Sequence<Time>::remove_note_unlocked(const boost::shared_ptr< const Note<Time> > note)
774 DUMP(format("%1% remove note %2% @ %3%\n") % this % (int)note->note() % note->time());
775 for (typename Notes::iterator n = _notes.begin(); n != _notes.end(); ++n) {
776 if (*(*n) == *note) {
783 template<typename Time>
785 Sequence<Time>::set_notes (const Sequence<Time>::Notes& n)
790 template class Sequence<Evoral::MusicalTime>;
792 } // namespace Evoral