libs/ardour/midi_model.cc

   1 /*
   2  Copyright (C) 2007 Paul Davis
   3  Written by Dave Robillard, 2007
   4
   5  This program is free software; you can redistribute it and/or modify
   6  it under the terms of the GNU General Public License as published by
   7  the Free Software Foundation; either version 2 of the License, or
   8  (at your option) any later version.
   9
  10  This program is distributed in the hope that it will be useful,
  11  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  GNU General Public License for more details.
  14
  15  You should have received a copy of the GNU General Public License
  16  along with this program; if not, write to the Free Software
  17  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19  */
  20
  21 #define __STDC_LIMIT_MACROS 1
  22
  23 #include <iostream>
  24 #include <algorithm>
  25 #include <stdexcept>
  26 #include <stdint.h>
  27 #include <pbd/enumwriter.h>
  28 #include <midi++/events.h>
  29
  30 #include <ardour/midi_model.h>
  31 #include <ardour/midi_source.h>
  32 #include <ardour/types.h>
  33 #include <ardour/session.h>
  34
  35 using namespace std;
  36 using namespace ARDOUR;
  37
  38 void MidiModel::write_lock() {
  39         _lock.writer_lock();
  40         _automation_lock.lock();
  41 }
  42
  43 void MidiModel::write_unlock() {
  44         _lock.writer_unlock();
  45         _automation_lock.unlock();
  46 }
  47
  48 void MidiModel::read_lock() const {
  49         _lock.reader_lock();
  50         /*_automation_lock.lock();*/
  51 }
  52
  53 void MidiModel::read_unlock() const {
  54         _lock.reader_unlock();
  55         /*_automation_lock.unlock();*/
  56 }
  57
  58 // Read iterator (const_iterator)
  59
  60 MidiModel::const_iterator::const_iterator(const MidiModel& model, double t)
  61         : _model(&model)
  62         , _is_end( (t == DBL_MAX) || model.empty())
  63         , _locked( !_is_end)
  64 {
  65         //cerr << "Created MIDI iterator @ " << t << " (is end: " << _is_end << ")" << endl;
  66
  67         if (_is_end)
  68                 return;
  69
  70         model.read_lock();
  71
  72         _note_iter = model.notes().end();
  73         // find first note which begins after t
  74         for (MidiModel::Notes::const_iterator i = model.notes().begin(); i != model.notes().end(); ++i) {
  75                 if ((*i)->time() >= t) {
  76                         _note_iter = i;
  77                         break;
  78                 }
  79         }
  80
  81         MidiControlIterator earliest_control(boost::shared_ptr<AutomationList>(), DBL_MAX, 0.0);
  82
  83         _control_iters.reserve(model.controls().size());
  84         for (Automatable::Controls::const_iterator i = model.controls().begin();
  85                         i != model.controls().end(); ++i) {
  86
  87                 assert(
  88                         i->first.type() == MidiCCAutomation ||
  89                         i->first.type() == MidiPgmChangeAutomation ||
  90                         i->first.type() == MidiPitchBenderAutomation ||
  91                         i->first.type() == MidiChannelAftertouchAutomation);
  92
  93                 double x, y;
  94                 bool ret = i->second->list()->rt_safe_earliest_event_unlocked(t, DBL_MAX, x, y);
  95                 if (!ret) {
  96                         //cerr << "MIDI Iterator: CC " << i->first.id() << " (size " << i->second->list()->size()
  97                         //      << ") has no events past " << t << endl;
  98                         continue;
  99                 }
 100
 101                 assert(x >= 0);
 102                 assert(y >= i->first.min());
 103                 assert(y <= i->first.max());
 104
 105                 const MidiControlIterator new_iter(i->second->list(), x, y);
 106
 107                 //cerr << "MIDI Iterator: CC " << i->first.id() << " added (" << x << ", " << y << ")" << endl;
 108                 _control_iters.push_back(new_iter);
 109
 110                 if (x < earliest_control.x) {
 111                         earliest_control = new_iter;
 112                         _control_iter = _control_iters.end();
 113                         --_control_iter;
 114                 }
 115         }
 116
 117         if (_note_iter != model.notes().end()) {
 118                 _event = MIDI::Event((*_note_iter)->on_event(), false);
 119                 _active_notes.push(*_note_iter);
 120                 //cerr << " new const iterator: size active notes: " << _active_notes.size() << " is empty: " << _active_notes.empty() << endl;
 121                 ++_note_iter;
 122         }
 123
 124         if (earliest_control.automation_list && earliest_control.x < _event.time())
 125                 model.control_to_midi_event(_event, earliest_control);
 126         else
 127                 _control_iter = _control_iters.end();
 128
 129         if (_event.size() == 0) {
 130                 //cerr << "Created MIDI iterator @ " << t << " is at end." << endl;
 131                 _is_end = true;
 132
 133                 // FIXME: possible race condition here....
 134                 if (_locked) {
 135                         _model->read_unlock();
 136                         _locked = false;
 137                 }
 138         } else {
 139                 //printf("New MIDI Iterator = %X @ %lf\n", _event.type(), _event.time());
 140         }
 141 }
 142
 143 MidiModel::const_iterator::~const_iterator()
 144 {
 145         if (_locked)
 146                 _model->read_unlock();
 147 }
 148
 149 const MidiModel::const_iterator& MidiModel::const_iterator::operator++()
 150 {
 151         if (_is_end)
 152                 throw std::logic_error("Attempt to iterate past end of MidiModel");
 153
 154         /*cerr << "const_iterator::operator++: _event type:" << hex << "0x" << int(_event.type())
 155          << "   buffer: 0x" << int(_event.buffer()[0]) << " 0x" << int(_event.buffer()[1])
 156          << " 0x" << int(_event.buffer()[2]) << endl;*/
 157
 158         if (! (_event.is_note() || _event.is_cc() || _event.is_pgm_change() || _event.is_pitch_bender() || _event.is_channel_aftertouch()) ) {
 159                 cerr << "FAILED event buffer: " << hex << int(_event.buffer()[0]) << int(_event.buffer()[1]) << int(_event.buffer()[2]) << endl;
 160         }
 161         assert((_event.is_note() || _event.is_cc() || _event.is_pgm_change() || _event.is_pitch_bender() || _event.is_channel_aftertouch()));
 162
 163         // Increment past current control event
 164         if (!_event.is_note() && _control_iter != _control_iters.end() && _control_iter->automation_list.get()) {
 165                 double x = 0.0, y = 0.0;
 166                 const bool ret = _control_iter->automation_list->rt_safe_earliest_event_unlocked(
 167                                 _control_iter->x, DBL_MAX, x, y, false);
 168                 cerr << "control_iter x:" << _control_iter->x << " y:" << _control_iter->y << endl;
 169
 170                 if (ret) {
 171                         cerr << "Incremented " << _control_iter->automation_list->parameter().id() << " to " << x << endl;
 172                         _control_iter->x = x;
 173                         _control_iter->y = y;
 174                 } else {
 175                         cerr << "Hit end of " << _control_iter->automation_list->parameter().id() << endl;
 176                         _control_iter->automation_list.reset();
 177                         _control_iter->x = DBL_MAX;
 178                 }
 179         }
 180
 181         // Now find and point at the earliest event
 182
 183         const std::vector<MidiControlIterator>::iterator old_control_iter = _control_iter;
 184         _control_iter = _control_iters.begin();
 185
 186         for (std::vector<MidiControlIterator>::iterator i = _control_iters.begin();
 187                         i != _control_iters.end(); ++i) {
 188                 if (i->x < _control_iter->x) {
 189                         _control_iter = i;
 190                 }
 191         }
 192
 193         enum Type {NIL, NOTE_ON, NOTE_OFF, AUTOMATION};
 194
 195         Type type = NIL;
 196         double t = 0;
 197
 198         // Next earliest note on
 199         if (_note_iter != _model->notes().end()) {
 200                 type = NOTE_ON;
 201                 t = (*_note_iter)->time();
 202         }
 203
 204         // Use the next earliest note off iff it's earlier than the note on
 205         if (_model->note_mode() == Sustained && (! _active_notes.empty())) {
 206                 if (type == NIL || _active_notes.top()->end_time() <= (*_note_iter)->time()) {
 207                         type = NOTE_OFF;
 208                         t = _active_notes.top()->end_time();
 209                 }
 210         }
 211
 212         // Use the next earliest controller iff it's earlier than the note event
 213         if (_control_iter != _control_iters.end()
 214                         && _control_iter->x != DBL_MAX
 215            )//&& _control_iter != old_control_iter)
 216                 if (type == NIL || _control_iter->x < t)
 217                         type = AUTOMATION;
 218
 219         if (type == NOTE_ON) {
 220                 //cerr << "********** MIDI Iterator = note on" << endl;
 221                 _event = MIDI::Event((*_note_iter)->on_event(), false);
 222                 _active_notes.push(*_note_iter);
 223                 ++_note_iter;
 224         } else if (type == NOTE_OFF) {
 225                 //cerr << "********** MIDI Iterator = note off" << endl;
 226                 _event = MIDI::Event(_active_notes.top()->off_event(), false);
 227                 _active_notes.pop();
 228         } else if (type == AUTOMATION) {
 229                 //cerr << "********** MIDI Iterator = Automation" << endl;
 230                 _model->control_to_midi_event(_event, *_control_iter);
 231         } else {
 232                 //cerr << "********** MIDI Iterator = End" << endl;
 233                 _is_end = true;
 234         }
 235
 236         assert(_is_end || _event.size()> 0);
 237
 238         return *this;
 239 }
 240
 241 bool MidiModel::const_iterator::operator==(const const_iterator& other) const
 242 {
 243         if (_is_end || other._is_end)
 244                 return (_is_end == other._is_end);
 245         else
 246                 return (_event == other._event);
 247 }
 248
 249 MidiModel::const_iterator& MidiModel::const_iterator::operator=(const const_iterator& other)
 250 {
 251         if (_locked && _model != other._model)
 252                 _model->read_unlock();
 253
 254         assert( ! other._event.owns_buffer());
 255
 256         _model = other._model;
 257         _event = other._event;
 258         _active_notes = other._active_notes;
 259         _is_end = other._is_end;
 260         _locked = other._locked;
 261         _note_iter = other._note_iter;
 262         _control_iters = other._control_iters;
 263         _control_iter = other._control_iter;
 264
 265         assert( ! _event.owns_buffer());
 266
 267         return *this;
 268 }
 269
 270 // MidiModel
 271
 272 MidiModel::MidiModel(MidiSource *s, size_t size)
 273         : Automatable(s->session(), "midi model")
 274         , _notes(size)
 275         , _note_mode(Sustained)
 276         , _writing(false)
 277         , _edited(false)
 278         , _end_iter(*this, DBL_MAX)
 279         , _next_read(UINT32_MAX)
 280         , _read_iter(*this, DBL_MAX)
 281         , _midi_source(s)
 282 {
 283         assert(_end_iter._is_end);
 284         assert( ! _end_iter._locked);
 285 }
 286
 287 /** Read events in frame range \a start .. \a start+cnt into \a dst,
 288  * adding \a stamp_offset to each event's timestamp.
 289  * \return number of events written to \a dst
 290  */
 291 size_t MidiModel::read(MidiRingBuffer& dst, nframes_t start, nframes_t nframes,
 292                 nframes_t stamp_offset, nframes_t negative_stamp_offset) const
 293 {
 294         //cerr << this << " MM::read @ " << start << " frames: " << nframes << " -> " << stamp_offset << endl;
 295         //cerr << this << " MM # notes: " << n_notes() << endl;
 296
 297         size_t read_events = 0;
 298
 299         if (start != _next_read) {
 300                 _read_iter = const_iterator(*this, (double)start);
 301                 //cerr << "Repositioning iterator from " << _next_read << " to " << start << endl;
 302         } else {
 303                 //cerr << "Using cached iterator at " << _next_read << endl;
 304         }
 305
 306         _next_read = start + nframes;
 307
 308         while (_read_iter != end() && _read_iter->time() < start + nframes) {
 309                 assert(_read_iter->size()> 0);
 310                 dst.write(_read_iter->time() + stamp_offset - negative_stamp_offset,
 311                                 _read_iter->size(), _read_iter->buffer());
 312
 313                 /*
 314                  cerr << this << " MidiModel::read event @ " << _read_iter->time()
 315                  << " type: " << hex << int(_read_iter->type()) << dec
 316                  << " note: " << int(_read_iter->note())
 317                  << " velocity: " << int(_read_iter->velocity())
 318                  << endl;
 319                  */
 320
 321                 ++_read_iter;
 322                 ++read_events;
 323         }
 324
 325         return read_events;
 326 }
 327
 328 bool MidiModel::control_to_midi_event(MIDI::Event& ev,
 329                 const MidiControlIterator& iter) const
 330 {
 331         switch (iter.automation_list->parameter().type()) {
 332         case MidiCCAutomation:
 333                 if (ev.size() < 3)
 334                         ev.set_buffer((Byte*)malloc(3), true);
 335
 336                 assert(iter.automation_list);
 337                 assert(iter.automation_list->parameter().channel() < 16);
 338                 assert(iter.automation_list->parameter().id() <= INT8_MAX);
 339                 assert(iter.y <= INT8_MAX);
 340                 ev.buffer()[0] = MIDI_CMD_CONTROL + iter.automation_list->parameter().channel();
 341                 ev.buffer()[1] = (Byte)iter.automation_list->parameter().id();
 342                 ev.buffer()[2] = (Byte)iter.y;
 343                 ev.time() = iter.x;
 344                 ev.size() = 3;
 345                 return true;
 346
 347         case MidiPgmChangeAutomation:
 348                 if (ev.size() < 3)
 349                         ev.set_buffer((Byte*)malloc(3), true);
 350
 351                 assert(iter.automation_list);
 352                 assert(iter.automation_list->parameter().channel() < 16);
 353                 assert(iter.automation_list->parameter().id() <= INT8_MAX);
 354                 assert(iter.y <= INT8_MAX);
 355                 ev.buffer()[0] = MIDI_CMD_PGM_CHANGE + iter.automation_list->parameter().channel();
 356                 ev.buffer()[1] = (Byte)iter.y;
 357                 ev.buffer()[2] = 0;
 358                 ev.time() = iter.x;
 359                 ev.size() = 3;
 360                 return true;
 361
 362         case MidiPitchBenderAutomation:
 363                 if (ev.size() < 3)
 364                         ev.set_buffer((Byte*)malloc(3), true);
 365
 366                 assert(iter.automation_list);
 367                 assert(iter.automation_list->parameter().channel() < 16);
 368                 assert(iter.automation_list->parameter().id() <= INT8_MAX);
 369                 assert(iter.y < (1<<14));
 370                 ev.buffer()[0] = MIDI_CMD_BENDER + iter.automation_list->parameter().channel();
 371                 ev.buffer()[1] = ((Byte)iter.y) & 0x7F; // LSB
 372                 ev.buffer()[2] = (((Byte)iter.y) >> 7) & 0x7F; // MSB
 373                 ev.time() = iter.x;
 374                 ev.size() = 3;
 375                 return true;
 376
 377         case MidiChannelAftertouchAutomation:
 378                 if (ev.size() < 3)
 379                         ev.set_buffer((Byte*)malloc(3), true);
 380
 381                 assert(iter.automation_list);
 382                 assert(iter.automation_list->parameter().channel() < 16);
 383                 assert(iter.automation_list->parameter().id() <= INT8_MAX);
 384                 assert(iter.y <= INT8_MAX);
 385                 ev.buffer()[0]
 386                                 = MIDI_CMD_CHANNEL_PRESSURE + iter.automation_list->parameter().channel();
 387                 ev.buffer()[1] = (Byte)iter.y;
 388                 ev.buffer()[2] = 0;
 389                 ev.time() = iter.x;
 390                 ev.size() = 3;
 391                 return true;
 392
 393         default:
 394                 return false;
 395         }
 396 }
 397
 398
 399 /** Clear all events from the model.
 400  */
 401 void MidiModel::clear()
 402 {
 403         _lock.writer_lock();
 404         _notes.clear();
 405         clear_automation();
 406         _next_read = 0;
 407         _read_iter = end();
 408         _lock.writer_unlock();
 409 }
 410
 411
 412 /** Begin a write of events to the model.
 413  *
 414  * If \a mode is Sustained, complete notes with duration are constructed as note
 415  * on/off events are received.  Otherwise (Percussive), only note on events are
 416  * stored; note off events are discarded entirely and all contained notes will
 417  * have duration 0.
 418  */
 419 void MidiModel::start_write()
 420 {
 421         //cerr << "MM " << this << " START WRITE, MODE = " << enum_2_string(_note_mode) << endl;
 422         write_lock();
 423         _writing = true;
 424         for (int i = 0; i < 16; ++i)
 425                 _write_notes[i].clear();
 426
 427         _dirty_automations.clear();
 428         write_unlock();
 429 }
 430
 431 /** Finish a write of events to the model.
 432  *
 433  * If \a delete_stuck is true and the current mode is Sustained, note on events
 434  * that were never resolved with a corresonding note off will be deleted.
 435  * Otherwise they will remain as notes with duration 0.
 436  */
 437 void MidiModel::end_write(bool delete_stuck)
 438 {
 439         write_lock();
 440         assert(_writing);
 441
 442         //cerr << "MM " << this << " END WRITE: " << _notes.size() << " NOTES\n";
 443
 444         if (_note_mode == Sustained && delete_stuck) {
 445                 for (Notes::iterator n = _notes.begin(); n != _notes.end() ;) {
 446                         if ((*n)->duration() == 0) {
 447                                 cerr << "WARNING: Stuck note lost: " << (*n)->note() << endl;
 448                                 n = _notes.erase(n);
 449                                 // we have to break here because erase invalidates the iterator
 450                                 break;
 451                         } else {
 452                                 ++n;
 453                         }
 454                 }
 455         }
 456
 457         for (int i = 0; i < 16; ++i) {
 458                 if (!_write_notes[i].empty()) {
 459                         cerr << "WARNING: MidiModel::end_write: Channel " << i << " has "
 460                                         << _write_notes[i].size() << " stuck notes" << endl;
 461                 }
 462                 _write_notes[i].clear();
 463         }
 464
 465         for (AutomationLists::const_iterator i = _dirty_automations.begin(); i != _dirty_automations.end(); ++i) {
 466                 (*i)->Dirty.emit();
 467                 (*i)->lookup_cache().left = -1;
 468                 (*i)->search_cache().left = -1;
 469         }
 470
 471         _writing = false;
 472         write_unlock();
 473 }
 474
 475 /** Append \a in_event to model.  NOT realtime safe.
 476  *
 477  * Timestamps of events in \a buf are expected to be relative to
 478  * the start of this model (t=0) and MUST be monotonically increasing
 479  * and MUST be >= the latest event currently in the model.
 480  */
 481 void MidiModel::append(const MIDI::Event& ev)
 482 {
 483         write_lock();
 484         _edited = true;
 485
 486         cerr << "MidiModel append event type: "
 487                 << hex << "0x" << (int)ev.type() << endl;
 488
 489         assert(_notes.empty() || ev.time() >= _notes.back()->time());
 490         assert(_writing);
 491
 492         if (ev.is_note_on()) {
 493                 append_note_on_unlocked(ev.channel(), ev.time(), ev.note(),
 494                                 ev.velocity());
 495         } else if (ev.is_note_off()) {
 496                 append_note_off_unlocked(ev.channel(), ev.time(), ev.note());
 497         } else if (ev.is_cc()) {
 498                 append_automation_event_unlocked(MidiCCAutomation, ev.channel(),
 499                                 ev.time(), ev.cc_number(), ev.cc_value());
 500         } else if (ev.is_pgm_change()) {
 501                 append_automation_event_unlocked(MidiPgmChangeAutomation, ev.channel(),
 502                                 ev.time(), ev.pgm_number(), 0);
 503         } else if (ev.is_pitch_bender()) {
 504                 append_automation_event_unlocked(MidiPitchBenderAutomation,
 505                                 ev.channel(), ev.time(), ev.pitch_bender_lsb(),
 506                                 ev.pitch_bender_msb());
 507         } else if (ev.is_channel_aftertouch()) {
 508                 append_automation_event_unlocked(MidiChannelAftertouchAutomation,
 509                                 ev.channel(), ev.time(), ev.channel_aftertouch(), 0);
 510         } else {
 511                 printf("WARNING: MidiModel: Unknown event type %X\n", ev.type());
 512         }
 513
 514         write_unlock();
 515 }
 516
 517 void MidiModel::append_note_on_unlocked(uint8_t chan, double time,
 518                 uint8_t note_num, uint8_t velocity)
 519 {
 520         /*cerr << "MidiModel " << this << " chan " << (int)chan <<
 521          " note " << (int)note_num << " on @ " << time << endl;*/
 522
 523         assert(chan < 16);
 524         assert(_writing);
 525         _edited = true;
 526
 527         _notes.push_back(boost::shared_ptr<Note>(new Note(chan, time, 0, note_num, velocity)));
 528         if (_note_mode == Sustained) {
 529                 //cerr << "MM Sustained: Appending active note on " << (unsigned)(uint8_t)note_num << endl;
 530                 _write_notes[chan].push_back(_notes.size() - 1);
 531         }/* else {
 532          cerr << "MM Percussive: NOT appending active note on" << endl;
 533          }*/
 534 }
 535
 536 void MidiModel::append_note_off_unlocked(uint8_t chan, double time,
 537                 uint8_t note_num)
 538 {
 539         /*cerr << "MidiModel " << this << " chan " << (int)chan <<
 540          " note " << (int)note_num << " off @ " << time << endl;*/
 541
 542         assert(chan < 16);
 543         assert(_writing);
 544         _edited = true;
 545
 546         if (_note_mode == Percussive) {
 547                 cerr << "MidiModel Ignoring note off (percussive mode)" << endl;
 548                 return;
 549         }
 550
 551         /* FIXME: make _write_notes fixed size (127 noted) for speed */
 552
 553         /* FIXME: note off velocity for that one guy out there who actually has
 554          * keys that send it */
 555
 556         bool resolved = false;
 557
 558         for (WriteNotes::iterator n = _write_notes[chan].begin(); n
 559                         != _write_notes[chan].end(); ++n) {
 560                 Note& note = *_notes[*n].get();
 561                 //cerr << (unsigned)(uint8_t)note.note() << " ? " << (unsigned)note_num << endl;
 562                 if (note.note() == note_num) {
 563                         assert(time >= note.time());
 564                         note.set_duration(time - note.time());
 565                         _write_notes[chan].erase(n);
 566                         //cerr << "MM resolved note, duration: " << note.duration() << endl;
 567                         resolved = true;
 568                         break;
 569                 }
 570         }
 571
 572         if (!resolved)
 573                 cerr << "MidiModel " << this << " spurious note off chan " << (int)chan
 574                                 << ", note " << (int)note_num << " @ " << time << endl;
 575 }
 576
 577 void MidiModel::append_automation_event_unlocked(AutomationType type,
 578                 uint8_t chan, double time, uint8_t first_byte, uint8_t second_byte)
 579 {
 580         //cerr << "MidiModel " << this << " chan " << (int)chan <<
 581         //              " CC " << (int)number << " = " << (int)value << " @ " << time << endl;
 582
 583         assert(chan < 16);
 584         assert(_writing);
 585         _edited = true;
 586         double value;
 587
 588         uint32_t id = 0;
 589
 590         switch (type) {
 591         case MidiCCAutomation:
 592                 id = first_byte;
 593                 value = double(second_byte);
 594                 break;
 595         case MidiChannelAftertouchAutomation:
 596         case MidiPgmChangeAutomation:
 597                 id = 0;
 598                 value = double(first_byte);
 599                 break;
 600         case MidiPitchBenderAutomation:
 601                 id = 0;
 602                 value = double((0x7F & second_byte) << 7 | (0x7F & first_byte));
 603                 break;
 604         default:
 605                 assert(false);
 606         }
 607
 608         Parameter param(type, id, chan);
 609         boost::shared_ptr<AutomationControl> control = Automatable::control(param, true);
 610         control->list()->fast_simple_add(time, value);
 611         /*cerr << "control list size after fast simple add: " << control->list()->size() << endl;*/
 612 }
 613
 614 void MidiModel::add_note_unlocked(const boost::shared_ptr<Note> note)
 615 {
 616         //cerr << "MidiModel " << this << " add note " << (int)note.note() << " @ " << note.time() << endl;
 617         _edited = true;
 618         Notes::iterator i = upper_bound(_notes.begin(), _notes.end(), note,
 619                         note_time_comparator);
 620         _notes.insert(i, note);
 621 }
 622
 623 void MidiModel::remove_note_unlocked(const boost::shared_ptr<const Note> note)
 624 {
 625         _edited = true;
 626         //cerr << "MidiModel " << this << " remove note " << (int)note.note() << " @ " << note.time() << endl;
 627         for (Notes::iterator n = _notes.begin(); n != _notes.end(); ++n) {
 628                 Note& _n = *(*n);
 629                 const Note& _note = *note;
 630                 // TODO: There is still the issue, that after restarting ardour
 631                 // persisted undo does not work, because of rounding errors in the
 632                 // event times after saving/restoring to/from MIDI files
 633                 cerr << "======================================= " << endl;
 634                 cerr << int(_n.note()) << "@" << int(_n.time()) << "[" << int(_n.channel()) << "] --" << int(_n.duration()) << "-- #" << int(_n.velocity()) << endl;
 635                 cerr << int(_note.note()) << "@" << int(_note.time()) << "[" << int(_note.channel()) << "] --" << int(_note.duration()) << "-- #" << int(_note.velocity()) << endl;
 636                 cerr << "Equal: " << bool(_n == _note) << endl;
 637                 cerr << endl << endl;
 638                 if (_n == _note) {
 639                         _notes.erase(n);
 640                         // we have to break here, because erase invalidates all iterators, ie. n itself
 641                         break;
 642                 }
 643         }
 644 }
 645
 646 /** Slow!  for debugging only. */
 647 #ifndef NDEBUG
 648 bool MidiModel::is_sorted() const {
 649         bool t = 0;
 650         for (Notes::const_iterator n = _notes.begin(); n != _notes.end(); ++n)
 651                 if ((*n)->time() < t)
 652                         return false;
 653                 else
 654                         t = (*n)->time();
 655
 656         return true;
 657 }
 658 #endif
 659
 660 /** Start a new command.
 661  *
 662  * This has no side-effects on the model or Session, the returned command
 663  * can be held on to for as long as the caller wishes, or discarded without
 664  * formality, until apply_command is called and ownership is taken.
 665  */
 666 MidiModel::DeltaCommand* MidiModel::new_delta_command(const string name)
 667 {
 668         DeltaCommand* cmd = new DeltaCommand(_midi_source->model(), name);
 669         return cmd;
 670 }
 671
 672 /** Apply a command.
 673  *
 674  * Ownership of cmd is taken, it must not be deleted by the caller.
 675  * The command will constitute one item on the undo stack.
 676  */
 677 void MidiModel::apply_command(Command* cmd)
 678 {
 679         _session.begin_reversible_command(cmd->name());
 680         (*cmd)();
 681         assert(is_sorted());
 682         _session.commit_reversible_command(cmd);
 683         _edited = true;
 684 }
 685
 686 // MidiEditCommand
 687
 688 MidiModel::DeltaCommand::DeltaCommand(boost::shared_ptr<MidiModel> m,
 689                 const std::string& name)
 690         : Command(name)
 691         , _model(m)
 692         , _name(name)
 693 {
 694 }
 695
 696 MidiModel::DeltaCommand::DeltaCommand(boost::shared_ptr<MidiModel> m,
 697                 const XMLNode& node)
 698         : _model(m)
 699 {
 700         set_state(node);
 701 }
 702
 703 void MidiModel::DeltaCommand::add(const boost::shared_ptr<Note> note)
 704 {
 705         //cerr << "MEC: apply" << endl;
 706         _removed_notes.remove(note);
 707         _added_notes.push_back(note);
 708 }
 709
 710 void MidiModel::DeltaCommand::remove(const boost::shared_ptr<Note> note)
 711 {
 712         //cerr << "MEC: remove" << endl;
 713         _added_notes.remove(note);
 714         _removed_notes.push_back(note);
 715 }
 716
 717 void MidiModel::DeltaCommand::operator()()
 718 {
 719         // This could be made much faster by using a priority_queue for added and
 720         // removed notes (or sort here), and doing a single iteration over _model
 721
 722         // Need to reset iterator to drop the read lock it holds, or we'll deadlock
 723         const bool reset_iter = (_model->_read_iter.locked());
 724         const double iter_time = _model->_read_iter->time();
 725
 726         if (reset_iter)
 727                 _model->_read_iter = _model->end(); // drop read lock
 728
 729         assert( ! _model->_read_iter.locked());
 730
 731         _model->write_lock();
 732
 733         for (std::list< boost::shared_ptr<Note> >::iterator i = _added_notes.begin(); i != _added_notes.end(); ++i)
 734                 _model->add_note_unlocked(*i);
 735
 736         for (std::list< boost::shared_ptr<Note> >::iterator i = _removed_notes.begin(); i != _removed_notes.end(); ++i)
 737                 _model->remove_note_unlocked(*i);
 738
 739         _model->write_unlock();
 740
 741         if (reset_iter)
 742         _model->_read_iter = const_iterator(*_model.get(), iter_time);
 743
 744         _model->ContentsChanged(); /* EMIT SIGNAL */
 745 }
 746
 747 void MidiModel::DeltaCommand::undo()
 748 {
 749         // This could be made much faster by using a priority_queue for added and
 750         // removed notes (or sort here), and doing a single iteration over _model
 751
 752         // Need to reset iterator to drop the read lock it holds, or we'll deadlock
 753         const bool reset_iter = (_model->_read_iter.locked());
 754         const double iter_time = _model->_read_iter->time();
 755
 756         if (reset_iter)
 757                 _model->_read_iter = _model->end(); // drop read lock
 758
 759         assert( ! _model->_read_iter.locked());
 760
 761         _model->write_lock();
 762
 763         for (std::list< boost::shared_ptr<Note> >::iterator i = _added_notes.begin(); i
 764                         != _added_notes.end(); ++i)
 765                 _model->remove_note_unlocked(*i);
 766
 767         for (std::list< boost::shared_ptr<Note> >::iterator i =
 768                         _removed_notes.begin(); i != _removed_notes.end(); ++i)
 769                 _model->add_note_unlocked(*i);
 770
 771         _model->write_unlock();
 772
 773         if (reset_iter)
 774                 _model->_read_iter = const_iterator(*_model.get(), iter_time);
 775
 776         _model->ContentsChanged(); /* EMIT SIGNAL */
 777 }
 778
 779 XMLNode & MidiModel::DeltaCommand::marshal_note(const boost::shared_ptr<Note> note)
 780 {
 781         XMLNode *xml_note = new XMLNode("note");
 782         ostringstream note_str(ios::ate);
 783         note_str << int(note->note());
 784         xml_note->add_property("note", note_str.str());
 785
 786         ostringstream channel_str(ios::ate);
 787         channel_str << int(note->channel());
 788         xml_note->add_property("channel", channel_str.str());
 789
 790         ostringstream time_str(ios::ate);
 791         time_str << int(note->time());
 792         xml_note->add_property("time", time_str.str());
 793
 794         ostringstream duration_str(ios::ate);
 795         duration_str <<(unsigned int) note->duration();
 796         xml_note->add_property("duration", duration_str.str());
 797
 798         ostringstream velocity_str(ios::ate);
 799         velocity_str << (unsigned int) note->velocity();
 800         xml_note->add_property("velocity", velocity_str.str());
 801
 802         return *xml_note;
 803 }
 804
 805 boost::shared_ptr<Note> MidiModel::DeltaCommand::unmarshal_note(XMLNode *xml_note)
 806 {
 807         unsigned int note;
 808         istringstream note_str(xml_note->property("note")->value());
 809         note_str >> note;
 810
 811         unsigned int channel;
 812         istringstream channel_str(xml_note->property("channel")->value());
 813         channel_str >> channel;
 814
 815         unsigned int time;
 816         istringstream time_str(xml_note->property("time")->value());
 817         time_str >> time;
 818
 819         unsigned int duration;
 820         istringstream duration_str(xml_note->property("duration")->value());
 821         duration_str >> duration;
 822
 823         unsigned int velocity;
 824         istringstream velocity_str(xml_note->property("velocity")->value());
 825         velocity_str >> velocity;
 826
 827         boost::shared_ptr<Note> note_ptr(new Note(channel, time, duration, note, velocity));
 828         return note_ptr;
 829 }
 830
 831 #define ADDED_NOTES_ELEMENT "added_notes"
 832 #define REMOVED_NOTES_ELEMENT "removed_notes"
 833 #define DELTA_COMMAND_ELEMENT "DeltaCommand"
 834
 835 int MidiModel::DeltaCommand::set_state(const XMLNode& delta_command)
 836 {
 837         if (delta_command.name() != string(DELTA_COMMAND_ELEMENT)) {
 838                 return 1;
 839         }
 840
 841         _added_notes.clear();
 842         XMLNode *added_notes = delta_command.child(ADDED_NOTES_ELEMENT);
 843         XMLNodeList notes = added_notes->children();
 844         transform(notes.begin(), notes.end(), back_inserter(_added_notes),
 845                         sigc::mem_fun(*this, &DeltaCommand::unmarshal_note));
 846
 847         _removed_notes.clear();
 848         XMLNode *removed_notes = delta_command.child(REMOVED_NOTES_ELEMENT);
 849         notes = removed_notes->children();
 850         transform(notes.begin(), notes.end(), back_inserter(_removed_notes),
 851                         sigc::mem_fun(*this, &DeltaCommand::unmarshal_note));
 852
 853         return 0;
 854 }
 855
 856 XMLNode& MidiModel::DeltaCommand::get_state()
 857 {
 858         XMLNode *delta_command = new XMLNode(DELTA_COMMAND_ELEMENT);
 859         delta_command->add_property("midi_source", _model->midi_source()->id().to_s());
 860
 861         XMLNode *added_notes = delta_command->add_child(ADDED_NOTES_ELEMENT);
 862         for_each(_added_notes.begin(), _added_notes.end(), sigc::compose(
 863                         sigc::mem_fun(*added_notes, &XMLNode::add_child_nocopy),
 864                         sigc::mem_fun(*this, &DeltaCommand::marshal_note)));
 865
 866         XMLNode *removed_notes = delta_command->add_child(REMOVED_NOTES_ELEMENT);
 867         for_each(_removed_notes.begin(), _removed_notes.end(), sigc::compose(
 868                         sigc::mem_fun(*removed_notes, &XMLNode::add_child_nocopy),
 869                         sigc::mem_fun(*this, &DeltaCommand::marshal_note)));
 870
 871         return *delta_command;
 872 }
 873
 874 struct EventTimeComparator {
 875         typedef const MIDI::Event* value_type;
 876         inline bool operator()(const MIDI::Event* a, const MIDI::Event* b) const {
 877                 return a->time() >= b->time();
 878         }
 879 };
 880
 881 /** Write the model to a MidiSource (i.e. save the model).
 882  * This is different from manually using read to write to a source in that
 883  * note off events are written regardless of the track mode.  This is so the
 884  * user can switch a recorded track (with note durations from some instrument)
 885  * to percussive, save, reload, then switch it back to sustained without
 886  * destroying the original note durations.
 887  */
 888 bool MidiModel::write_to(boost::shared_ptr<MidiSource> source)
 889 {
 890         read_lock();
 891
 892         const NoteMode old_note_mode = _note_mode;
 893         _note_mode = Sustained;
 894
 895         for (const_iterator i = begin(); i != end(); ++i)
 896                 source->append_event_unlocked(Frames, *i);
 897
 898         _note_mode = old_note_mode;
 899
 900         read_unlock();
 901         _edited = false;
 902
 903         return true;
 904 }
 905
 906 XMLNode& MidiModel::get_state()
 907 {
 908         XMLNode *node = new XMLNode("MidiModel");
 909         return *node;
 910 }
 911