libs/evoral/src/Sequence.cpp

   1 /* This file is part of Evoral.
   2  * Copyright (C) 2008 Dave Robillard <http://drobilla.net>
   3  * Copyright (C) 2000-2008 Paul Davis
   4  *
   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.
   9  *
  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.
  13  *
  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
  17  */
  18
  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>
  27
  28 #include "pbd/compose.h"
  29
  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"
  38
  39 using namespace std;
  40 using namespace PBD;
  41
  42 namespace Evoral {
  43
  44 // Read iterator (const_iterator)
  45
  46 template<typename Time>
  47 Sequence<Time>::const_iterator::const_iterator()
  48         : _seq(NULL)
  49         , _is_end(true)
  50         , _control_iter(_control_iters.end())
  51 {
  52         _event = boost::shared_ptr< Event<Time> >(new Event<Time>());
  53 }
  54
  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())
  63 {
  64         DEBUG_TRACE (DEBUG::Sequence, string_compose ("Created Iterator @ %1 (is end: %2)\n)", t, _is_end));
  65
  66         if (!_is_end) {
  67                 _lock = seq.read_lock();
  68         } else {
  69                 return;
  70         }
  71
  72         typename Sequence<Time>::ReadLock lock(seq.read_lock());
  73
  74         // Find first note which begins at or after t
  75         _note_iter = seq.note_lower_bound(t);
  76
  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;
  83                 }
  84         }
  85         assert(_sysex_iter == seq.sysexes().end() || (*_sysex_iter)->time() >= t);
  86
  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;
 100                 }
 101
 102                 assert(x >= 0);
 103
 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;
 109                 }
 110
 111                 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Iterator: CC %1 added (%2, %3)\n", i->first.id(), x, y));
 112
 113                 const ControlIterator new_iter(i->second->list(), x, y);
 114                 _control_iters.push_back(new_iter);
 115
 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;
 121                 }
 122         }
 123
 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();
 129         }
 130
 131         // Now find the earliest event overall and point to it
 132         Time earliest_t = t;
 133
 134         if (_note_iter != seq.notes().end()) {
 135                 _type = NOTE_ON;
 136                 earliest_t = (*_note_iter)->time();
 137         }
 138
 139         if (_sysex_iter != seq.sysexes().end()
 140                         && ((*_sysex_iter)->time() < earliest_t || _type == NIL)) {
 141                 _type = SYSEX;
 142                 earliest_t = (*_sysex_iter)->time();
 143         }
 144
 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;
 150         }
 151
 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;
 170         }
 171
 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()));
 182         }
 183 }
 184
 185 template<typename Time>
 186 Sequence<Time>::const_iterator::~const_iterator()
 187 {
 188 }
 189
 190 template<typename Time>
 191 void
 192 Sequence<Time>::const_iterator::invalidate()
 193 {
 194         while (!_active_notes.empty()) {
 195                 _active_notes.pop();
 196         }
 197         _type = NIL;
 198         _is_end = true;
 199         if (_seq) {
 200                 _note_iter = _seq->notes().end();
 201                 _sysex_iter = _seq->sysexes().end();
 202         }
 203         _control_iter = _control_iters.end();
 204         _lock.reset();
 205 }
 206
 207 template<typename Time>
 208 const typename Sequence<Time>::const_iterator&
 209 Sequence<Time>::const_iterator::operator++()
 210 {
 211         if (_is_end) {
 212                 throw std::logic_error("Attempt to iterate past end of Sequence");
 213         }
 214
 215         DEBUG_TRACE(DEBUG::Sequence, "Sequence::const_iterator++\n");
 216         assert(_event && _event->buffer() && _event->size() > 0);
 217
 218         const MIDIEvent<Time>& ev = *((MIDIEvent<Time>*)_event.get());
 219
 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;
 228         }
 229
 230         double x   = 0.0;
 231         double y   = 0.0;
 232         bool   ret = false;
 233
 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;
 253                 }
 254
 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;
 261                         }
 262                 }
 263                 break;
 264         case SYSEX:
 265                 ++_sysex_iter;
 266                 break;
 267         default:
 268                 assert(false);
 269         }
 270
 271         // Now find the earliest event overall and point to it
 272         _type = NIL;
 273         Time earliest_t = std::numeric_limits<Time>::max();
 274
 275         // Next earliest note on
 276         if (_note_iter != _seq->notes().end()) {
 277                 _type = NOTE_ON;
 278                 earliest_t = (*_note_iter)->time();
 279         }
 280
 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();
 286                 }
 287         }
 288
 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;
 294                 }
 295         }
 296
 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();
 302                 }
 303         }
 304
 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;
 329         }
 330
 331         assert(_is_end || (_event->size() > 0 && _event->buffer() && _event->buffer()[0] != '\0'));
 332
 333         return *this;
 334 }
 335
 336 template<typename Time>
 337 bool
 338 Sequence<Time>::const_iterator::operator==(const const_iterator& other) const
 339 {
 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);
 348         }
 349 }
 350
 351 template<typename Time>
 352 typename Sequence<Time>::const_iterator&
 353 Sequence<Time>::const_iterator::operator=(const const_iterator& other)
 354 {
 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;
 363
 364         if (other._lock)
 365                 _lock = _seq->read_lock();
 366         else
 367                 _lock.reset();
 368
 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;
 374         }
 375
 376         return *this;
 377 }
 378
 379 // Sequence
 380
 381 template<typename Time>
 382 Sequence<Time>::Sequence(const TypeMap& type_map)
 383         : _edited(false)
 384         , _type_map(type_map)
 385         , _writing(false)
 386         , _end_iter(*this, DBL_MAX)
 387         , _percussive(false)
 388         , _lowest_note(127)
 389         , _highest_note(0)
 390 {
 391         DEBUG_TRACE (DEBUG::Sequence, string_compose ("Sequence constructed: %1\n", this));
 392         assert(_end_iter._is_end);
 393         assert( ! _end_iter._lock);
 394 }
 395
 396 template<typename Time>
 397 Sequence<Time>::Sequence(const Sequence<Time>& other)
 398         : ControlSet (other)
 399         , _edited(false)
 400         , _type_map(other._type_map)
 401         , _writing(false)
 402         , _end_iter(*this, DBL_MAX)
 403         , _percussive(other._percussive)
 404         , _lowest_note(other._lowest_note)
 405         , _highest_note(other._highest_note)
 406 {
 407         for (typename Notes::const_iterator i = other._notes.begin(); i != other._notes.end(); ++i) {
 408                 boost::shared_ptr<Note<Time> > n (new Note<Time> (**i));
 409                 _notes.insert (n);
 410         }
 411
 412         for (typename SysExes::const_iterator i = other._sysexes.begin(); i != other._sysexes.end(); ++i) {
 413                 boost::shared_ptr<Event<Time> > n (new Event<Time> (**i, true));
 414                 _sysexes.push_back (n);
 415         }
 416
 417         DEBUG_TRACE (DEBUG::Sequence, string_compose ("Sequence copied: %1\n", this));
 418         assert(_end_iter._is_end);
 419         assert(! _end_iter._lock);
 420 }
 421
 422 /** Write the controller event pointed to by \a iter to \a ev.
 423  * The buffer of \a ev will be allocated or resized as necessary.
 424  * The event_type of \a ev should be set to the expected output type.
 425  * \return true on success
 426  */
 427 template<typename Time>
 428 bool
 429 Sequence<Time>::control_to_midi_event(
 430                 boost::shared_ptr< Event<Time> >& ev,
 431                 const ControlIterator&            iter) const
 432 {
 433         assert(iter.list.get());
 434         const uint32_t event_type = iter.list->parameter().type();
 435
 436         // initialize the event pointer with a new event, if necessary
 437         if (!ev) {
 438                 ev = boost::shared_ptr< Event<Time> >(new Event<Time>(event_type, 0, 3, NULL, true));
 439         }
 440
 441         uint8_t midi_type = _type_map.parameter_midi_type(iter.list->parameter());
 442         ev->set_event_type(_type_map.midi_event_type(midi_type));
 443         switch (midi_type) {
 444         case MIDI_CMD_CONTROL:
 445                 assert(iter.list.get());
 446                 assert(iter.list->parameter().channel() < 16);
 447                 assert(iter.list->parameter().id() <= INT8_MAX);
 448                 assert(iter.y <= INT8_MAX);
 449
 450                 ev->time() = iter.x;
 451                 ev->realloc(3);
 452                 ev->buffer()[0] = MIDI_CMD_CONTROL + iter.list->parameter().channel();
 453                 ev->buffer()[1] = (uint8_t)iter.list->parameter().id();
 454                 ev->buffer()[2] = (uint8_t)iter.y;
 455                 break;
 456
 457         case MIDI_CMD_PGM_CHANGE:
 458                 assert(iter.list.get());
 459                 assert(iter.list->parameter().channel() < 16);
 460                 assert(iter.y <= INT8_MAX);
 461
 462                 ev->time() = iter.x;
 463                 ev->realloc(2);
 464                 ev->buffer()[0] = MIDI_CMD_PGM_CHANGE + iter.list->parameter().channel();
 465                 ev->buffer()[1] = (uint8_t)iter.y;
 466                 break;
 467
 468         case MIDI_CMD_BENDER:
 469                 assert(iter.list.get());
 470                 assert(iter.list->parameter().channel() < 16);
 471                 assert(iter.y < (1<<14));
 472
 473                 ev->time() = iter.x;
 474                 ev->realloc(3);
 475                 ev->buffer()[0] = MIDI_CMD_BENDER + iter.list->parameter().channel();
 476                 ev->buffer()[1] = uint16_t(iter.y) & 0x7F; // LSB
 477                 ev->buffer()[2] = (uint16_t(iter.y) >> 7) & 0x7F; // MSB
 478                 break;
 479
 480         case MIDI_CMD_CHANNEL_PRESSURE:
 481                 assert(iter.list.get());
 482                 assert(iter.list->parameter().channel() < 16);
 483                 assert(iter.y <= INT8_MAX);
 484
 485                 ev->time() = iter.x;
 486                 ev->realloc(2);
 487                 ev->buffer()[0] = MIDI_CMD_CHANNEL_PRESSURE + iter.list->parameter().channel();
 488                 ev->buffer()[1] = (uint8_t)iter.y;
 489                 break;
 490
 491         default:
 492                 return false;
 493         }
 494
 495         return true;
 496 }
 497
 498 /** Clear all events from the model.
 499  */
 500 template<typename Time>
 501 void
 502 Sequence<Time>::clear()
 503 {
 504         WriteLock lock(write_lock());
 505         _notes.clear();
 506         for (Controls::iterator li = _controls.begin(); li != _controls.end(); ++li)
 507                 li->second->list()->clear();
 508 }
 509
 510 /** Begin a write of events to the model.
 511  *
 512  * If \a mode is Sustained, complete notes with length are constructed as note
 513  * on/off events are received.  Otherwise (Percussive), only note on events are
 514  * stored; note off events are discarded entirely and all contained notes will
 515  * have length 0.
 516  */
 517 template<typename Time>
 518 void
 519 Sequence<Time>::start_write()
 520 {
 521         DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 : start_write (percussive = %2)\n", this, _percussive));
 522         WriteLock lock(write_lock());
 523         _writing = true;
 524         for (int i = 0; i < 16; ++i) {
 525                 _write_notes[i].clear();
 526         }
 527         _dirty_controls.clear();
 528 }
 529
 530 /** Finish a write of events to the model.
 531  *
 532  * If \a delete_stuck is true and the current mode is Sustained, note on events
 533  * that were never resolved with a corresonding note off will be deleted.
 534  * Otherwise they will remain as notes with length 0.
 535  */
 536 template<typename Time>
 537 void
 538 Sequence<Time>::end_write (bool delete_stuck)
 539 {
 540         WriteLock lock(write_lock());
 541
 542         if (!_writing) {
 543                 return;
 544         }
 545
 546         DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 : end_write (%2 notes)\n", this, _notes.size()));
 547
 548         if (!_percussive && delete_stuck) {
 549                 for (typename Notes::iterator n = _notes.begin(); n != _notes.end() ;) {
 550                         typename Notes::iterator next = n;
 551                         ++next;
 552                         if ((*n)->length() == 0) {
 553                                 cerr << "WARNING: Stuck note lost: " << (*n)->note() << endl;
 554                                 _notes.erase(n);
 555                         }
 556
 557                         n = next;
 558                 }
 559         }
 560
 561         for (int i = 0; i < 16; ++i) {
 562                 if (!_write_notes[i].empty()) {
 563                         cerr << "WARNING: Sequence<Time>::end_write: Channel " << i << " has "
 564                                         << _write_notes[i].size() << " stuck notes" << endl;
 565                 }
 566                 _write_notes[i].clear();
 567         }
 568
 569         for (ControlLists::const_iterator i = _dirty_controls.begin(); i != _dirty_controls.end(); ++i) {
 570                 (*i)->mark_dirty();
 571         }
 572
 573         _writing = false;
 574 }
 575
 576
 577 template<typename Time>
 578 bool
 579 Sequence<Time>::add_note_unlocked(const boost::shared_ptr< Note<Time> > note)
 580 {
 581         /* This is the core method to add notes to a Sequence
 582          */
 583
 584         DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 add note %2 @ %3\n", this, (int)note->note(), note->time()));
 585
 586         if (contains_unlocked (note)) {
 587                 return false;
 588         }
 589
 590         if (overlaps_unlocked (note)) {
 591                 return false;
 592         }
 593
 594         _edited = true;
 595
 596         if (note->note() < _lowest_note)
 597                 _lowest_note = note->note();
 598         if (note->note() > _highest_note)
 599                 _highest_note = note->note();
 600
 601         _notes.insert(note);
 602
 603         return true;
 604 }
 605
 606 template<typename Time>
 607 void
 608 Sequence<Time>::remove_note_unlocked(const boost::shared_ptr< const Note<Time> > note)
 609 {
 610         bool erased = false;
 611
 612         _edited = true;
 613
 614         DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 remove note %2 @ %3\n", this, (int)note->note(), note->time()));
 615
 616         for (typename Sequence<Time>::Notes::iterator i = note_lower_bound(note->time());
 617              i != _notes.end() && (*i)->time() == note->time(); ++i) {
 618
 619                 if (*i == note) {
 620
 621                         _notes.erase (i);
 622
 623                         if ((*i)->note() == _lowest_note || (*i)->note() == _highest_note) {
 624
 625                                 _lowest_note = 127;
 626                                 _highest_note = 0;
 627
 628                                 for (typename Sequence<Time>::Notes::iterator ii = _notes.begin(); ii != _notes.end(); ++ii) {
 629                                         if ((*ii)->note() < _lowest_note)
 630                                                 _lowest_note = (*ii)->note();
 631                                         if ((*ii)->note() > _highest_note)
 632                                                 _highest_note = (*ii)->note();
 633                                 }
 634                         }
 635
 636                         erased = true;
 637                 }
 638
 639         }
 640
 641         if (!erased) {
 642                 cerr << "Unable to find note to erase" << endl;
 643         }
 644 }
 645
 646 /** Append \a ev to model.  NOT realtime safe.
 647  *
 648  * The timestamp of event is expected to be relative to
 649  * the start of this model (t=0) and MUST be monotonically increasing
 650  * and MUST be >= the latest event currently in the model.
 651  */
 652 template<typename Time>
 653 void
 654 Sequence<Time>::append(const Event<Time>& event)
 655 {
 656         WriteLock lock(write_lock());
 657         _edited = true;
 658
 659         const MIDIEvent<Time>& ev = (const MIDIEvent<Time>&)event;
 660
 661         assert(_notes.empty() || ev.time() >= (*_notes.rbegin())->time());
 662         assert(_writing);
 663
 664         if (!midi_event_is_valid(ev.buffer(), ev.size())) {
 665                 cerr << "WARNING: Sequence ignoring illegal MIDI event" << endl;
 666                 return;
 667         }
 668
 669         if (ev.is_note_on()) {
 670                 boost::shared_ptr< Note<Time> > note(new Note<Time>(ev.channel(), ev.time(), 0, ev.note(), ev.velocity()));
 671                 append_note_on_unlocked (note);
 672         } else if (ev.is_note_off()) {
 673                 boost::shared_ptr< Note<Time> > note(new Note<Time>(ev.channel(), ev.time(), 0, ev.note(), ev.velocity()));
 674                 append_note_off_unlocked (note);
 675         } else if (ev.is_sysex()) {
 676                 append_sysex_unlocked(ev);
 677         } else if (!_type_map.type_is_midi(ev.event_type())) {
 678                 printf("WARNING: Sequence: Unknown event type %X: ", ev.event_type());
 679                 for (size_t i=0; i < ev.size(); ++i) {
 680                         printf("%X ", ev.buffer()[i]);
 681                 }
 682                 printf("\n");
 683         } else if (ev.is_cc()) {
 684                 append_control_unlocked(
 685                                 Evoral::MIDI::ContinuousController(ev.event_type(), ev.channel(), ev.cc_number()),
 686                                 ev.time(), ev.cc_value());
 687         } else if (ev.is_pgm_change()) {
 688                 append_control_unlocked(
 689                                 Evoral::MIDI::ProgramChange(ev.event_type(), ev.channel()),
 690                                 ev.time(), ev.pgm_number());
 691         } else if (ev.is_pitch_bender()) {
 692                 append_control_unlocked(
 693                                 Evoral::MIDI::PitchBender(ev.event_type(), ev.channel()),
 694                                 ev.time(), double(  (0x7F & ev.pitch_bender_msb()) << 7
 695                                         | (0x7F & ev.pitch_bender_lsb()) ));
 696         } else if (ev.is_channel_pressure()) {
 697                 append_control_unlocked(
 698                                 Evoral::MIDI::ChannelPressure(ev.event_type(), ev.channel()),
 699                                 ev.time(), ev.channel_pressure());
 700         } else {
 701                 printf("WARNING: Sequence: Unknown MIDI event type %X\n", ev.type());
 702         }
 703 }
 704
 705 template<typename Time>
 706 void
 707 Sequence<Time>::append_note_on_unlocked (boost::shared_ptr< Note<Time> > note)
 708 {
 709         DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 c=%2 note %3 on @ %4 v=%5\n", this,
 710                                                       (int) note->channel(), (int) note->note(),
 711                                                       note->time(), (int) note->velocity()));
 712         assert(note->note() <= 127);
 713         assert(note->channel() < 16);
 714         assert(_writing);
 715
 716         if (note->velocity() == 0) {
 717                 append_note_off_unlocked (note);
 718                 return;
 719         }
 720
 721         add_note_unlocked (note);
 722
 723         if (!_percussive) {
 724                 DEBUG_TRACE (DEBUG::Sequence, string_compose ("Sustained: Appending active note on %1 channel %2\n",
 725                                                               (unsigned)(uint8_t)note->note(), note->channel()));
 726                 _write_notes[note->channel()].insert (note);
 727         } else {
 728                 DEBUG_TRACE(DEBUG::Sequence, "Percussive: NOT appending active note on\n");
 729         }
 730 }
 731
 732 template<typename Time>
 733 void
 734 Sequence<Time>::append_note_off_unlocked (boost::shared_ptr< Note<Time> > note)
 735 {
 736         DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 c=%2 note %3 on @ %4 v=%5\n",
 737                                                       this, (int)note->channel(),
 738                                                       (int)note->note(), note->time(), (int)note->velocity()));
 739         assert(note->note() <= 127);
 740         assert(note->channel() < 16);
 741         assert(_writing);
 742         _edited = true;
 743
 744         if (_percussive) {
 745                 DEBUG_TRACE(DEBUG::Sequence, "Sequence Ignoring note off (percussive mode)\n");
 746                 return;
 747         }
 748
 749         bool resolved = false;
 750
 751         /* _write_notes is sorted earliest-latest, so this will find the first matching note (FIFO) that
 752            matches this note (by pitch & channel). the MIDI specification doesn't provide any guidance
 753            whether to use FIFO or LIFO for this matching process, so SMF is fundamentally a lossy
 754            format.
 755         */
 756
 757         for (typename WriteNotes::iterator n = _write_notes[note->channel()].begin(); n != _write_notes[note->channel()].end(); ++n) {
 758                 boost::shared_ptr< Note<Time> > nn = *n;
 759                 if (note->note() == nn->note() && nn->channel() == note->channel()) {
 760                         assert(note->time() >= nn->time());
 761
 762                         nn->set_length (note->time() - nn->time());
 763                         nn->set_off_velocity (note->velocity());
 764
 765                         _write_notes[note->channel()].erase(n);
 766                         DEBUG_TRACE (DEBUG::Sequence, string_compose ("resolved note, length: %1\n", note->length()));
 767                         resolved = true;
 768                         break;
 769                 }
 770         }
 771
 772         if (!resolved) {
 773                 cerr << this << " spurious note off chan " << (int)note->channel()
 774                      << ", note " << (int)note->note() << " @ " << note->time() << endl;
 775         }
 776 }
 777
 778 template<typename Time>
 779 void
 780 Sequence<Time>::append_control_unlocked(const Parameter& param, Time time, double value)
 781 {
 782         DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 %2 @ %3\t=\t%4 # controls: %5\n",
 783                                                       this, _type_map.to_symbol(param), time, value, _controls.size()));
 784         boost::shared_ptr<Control> c = control(param, true);
 785         c->list()->rt_add(time, value);
 786 }
 787
 788 template<typename Time>
 789 void
 790 Sequence<Time>::append_sysex_unlocked(const MIDIEvent<Time>& ev)
 791 {
 792         #ifdef DEBUG_SEQUENCE
 793         cerr << this << " SysEx @ " << ev.time() << " \t= \t [ " << hex;
 794         for (size_t i=0; i < ev.size(); ++i) {
 795                 cerr << int(ev.buffer()[i]) << " ";
 796         } cerr << "]" << endl;
 797         #endif
 798
 799         boost::shared_ptr<MIDIEvent<Time> > event(new MIDIEvent<Time>(ev, true));
 800         _sysexes.push_back(event);
 801 }
 802
 803 template<typename Time>
 804 bool
 805 Sequence<Time>::contains (const boost::shared_ptr< Note<Time> > note) const
 806 {
 807         return contains_unlocked (note);
 808 }
 809
 810 template<typename Time>
 811 bool
 812 Sequence<Time>::contains_unlocked (const boost::shared_ptr< Note<Time> > note) const
 813 {
 814         for (typename Sequence<Time>::Notes::const_iterator i = note_lower_bound(note->time());
 815                         i != _notes.end() && (*i)->time() == note->time(); ++i) {
 816                 if (*i == note) {
 817                         cerr << "Existing note matches: " << *i << endl;
 818                         return true;
 819                 }
 820         }
 821         return false;
 822 }
 823
 824 template<typename Time>
 825 bool
 826 Sequence<Time>::overlaps (const boost::shared_ptr< Note<Time> > note) const
 827 {
 828         ReadLock lock (read_lock());
 829         return overlaps_unlocked (note);
 830 }
 831
 832 template<typename Time>
 833 bool
 834 Sequence<Time>::overlaps_unlocked (const boost::shared_ptr< Note<Time> > note) const
 835 {
 836         Time sa = note->time();
 837         Time ea  = note->end_time();
 838
 839         for (typename Sequence<Time>::Notes::const_iterator i = note_lower_bound (note->time()); i != _notes.end(); ++i) {
 840
 841                 if ((note->note() != (*i)->note()) ||
 842                     (note->channel() != (*i)->channel())) {
 843                         continue;
 844                 }
 845
 846                 Time sb = (*i)->time();
 847                 Time eb = (*i)->end_time();
 848
 849                 if (((sb > sa) && (eb <= ea)) ||
 850                     ((eb >= sa) && (eb <= ea)) ||
 851                     ((sb > sa) && (sb <= ea)) ||
 852                     ((sa >= sb) && (sa <= eb) && (ea <= eb))) {
 853                         return true;
 854                 }
 855         }
 856
 857         return false;
 858 }
 859
 860 template<typename Time>
 861 void
 862 Sequence<Time>::set_notes (const Sequence<Time>::Notes& n)
 863 {
 864         _notes = n;
 865 }
 866
 867 /** Return the earliest note with time >= t */
 868 template<typename Time>
 869 typename Sequence<Time>::Notes::const_iterator
 870 Sequence<Time>::note_lower_bound (Time t) const
 871 {
 872         boost::shared_ptr< Note<Time> > search_note(new Note<Time>(0, t, 0, 0, 0));
 873         typename Sequence<Time>::Notes::const_iterator i = _notes.lower_bound(search_note);
 874         assert(i == _notes.end() || (*i)->time() >= t);
 875         return i;
 876 }
 877
 878 template<typename Time>
 879 void
 880 Sequence<Time>::get_notes (Notes& n, NoteOperator op, uint8_t val, int chan_mask) const
 881 {
 882         ReadLock lock (read_lock());
 883
 884         for (typename Notes::const_iterator i = _notes.begin(); i != _notes.end(); ++i) {
 885
 886                 if (chan_mask != 0 && !((1<<(*i)->channel()) & chan_mask)) {
 887                         continue;
 888                 }
 889
 890                 switch (op) {
 891                 case PitchEqual:
 892                         if ((*i)->note() == val) {
 893                                 n.insert (*i);
 894                         }
 895                         break;
 896                 case PitchLessThan:
 897                         if ((*i)->note() < val) {
 898                                 n.insert (*i);
 899                         }
 900                         break;
 901                 case PitchLessThanOrEqual:
 902                         if ((*i)->note() <= val) {
 903                                 n.insert (*i);
 904                         }
 905                         break;
 906                 case PitchGreater:
 907                         if ((*i)->note() > val) {
 908                                 n.insert (*i);
 909                         }
 910                         break;
 911                 case PitchGreaterThanOrEqual:
 912                         if ((*i)->note() >= val) {
 913                                 n.insert (*i);
 914                         }
 915                         break;
 916                 case VelocityEqual:
 917                         if ((*i)->velocity() == val) {
 918                                 n.insert (*i);
 919                         }
 920                         break;
 921                 case VelocityLessThan:
 922                         if ((*i)->velocity() < val) {
 923                                 n.insert (*i);
 924                         }
 925                         break;
 926                 case VelocityLessThanOrEqual:
 927                         if ((*i)->velocity() <= val) {
 928                                 n.insert (*i);
 929                         }
 930                         break;
 931                 case VelocityGreater:
 932                         if ((*i)->velocity() > val) {
 933                                 n.insert (*i);
 934                         }
 935                         break;
 936                 case VelocityGreaterThanOrEqual:
 937                         if ((*i)->velocity() >= val) {
 938                                 n.insert (*i);
 939                         }
 940                         break;
 941                 }
 942         }
 943 }
 944
 945 template class Sequence<Evoral::MusicalTime>;
 946
 947 } // namespace Evoral
 948