Fix unit-test data (XML attributes changed)
[ardour.git] / libs / ardour / midi_model.cc
index 99f87e845ca61924bdf5e03aa32ffa1bd5c97a03..13268cd84ad9c270896be0e94d278333d0910586 100644 (file)
 /*
- Copyright (C) 2007 Paul Davis 
- Written by Dave Robillard, 2007
+  Copyright (C) 2007 Paul Davis
+  Author: David Robillard
 
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.
 
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- GNU General Public License for more details.
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
- You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
- */
-
-#define __STDC_LIMIT_MACROS 1
+*/
 
-#include <iostream>
 #include <algorithm>
+#include <iostream>
+#include <set>
 #include <stdexcept>
 #include <stdint.h>
-#include <pbd/error.h>
-#include <pbd/enumwriter.h>
-#include <midi++/events.h>
 
-#include <ardour/midi_model.h>
-#include <ardour/midi_source.h>
-#include <ardour/types.h>
-#include <ardour/session.h>
+#include "pbd/compose.h"
+#include "pbd/enumwriter.h"
+#include "pbd/error.h"
+
+#include "evoral/Control.hpp"
+
+#include "midi++/events.h"
+
+#include "ardour/automation_control.h"
+#include "ardour/evoral_types_convert.h"
+#include "ardour/midi_automation_list_binder.h"
+#include "ardour/midi_model.h"
+#include "ardour/midi_source.h"
+#include "ardour/midi_state_tracker.h"
+#include "ardour/session.h"
+#include "ardour/types.h"
+
+#include "pbd/i18n.h"
+
+namespace PBD {
+       DEFINE_ENUM_CONVERT(ARDOUR::MidiModel::NoteDiffCommand::Property);
+       DEFINE_ENUM_CONVERT(ARDOUR::MidiModel::SysExDiffCommand::Property);
+       DEFINE_ENUM_CONVERT(ARDOUR::MidiModel::PatchChangeDiffCommand::Property);
+}
 
 using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
-MidiModel::MidiModel(MidiSource *s, size_t size)
-       : AutomatableSequence<TimeType>(s->session(), size)
-       , _midi_source(s)
+MidiModel::MidiModel (boost::shared_ptr<MidiSource> s)
+       : AutomatableSequence<TimeType>(s->session())
 {
-       cerr << "MidiModel \"" << s->name() << "\" constructed: " << this << endl;
+       set_midi_source (s);
 }
 
-/** Start a new command.
+/** Start a new NoteDiff command.
  *
  * This has no side-effects on the model or Session, the returned command
  * can be held on to for as long as the caller wishes, or discarded without
  * formality, until apply_command is called and ownership is taken.
  */
-MidiModel::DeltaCommand* MidiModel::new_delta_command(const string name)
+MidiModel::NoteDiffCommand*
+MidiModel::new_note_diff_command (const string& name)
+{
+       boost::shared_ptr<MidiSource> ms = _midi_source.lock ();
+       assert (ms);
+
+       return new NoteDiffCommand (ms->model(), name);
+}
+
+/** Start a new SysExDiff command */
+MidiModel::SysExDiffCommand*
+MidiModel::new_sysex_diff_command (const string& name)
+{
+       boost::shared_ptr<MidiSource> ms = _midi_source.lock ();
+       assert (ms);
+
+       return new SysExDiffCommand (ms->model(), name);
+}
+
+/** Start a new PatchChangeDiff command */
+MidiModel::PatchChangeDiffCommand*
+MidiModel::new_patch_change_diff_command (const string& name)
 {
-       DeltaCommand* cmd = new DeltaCommand(_midi_source->model(), name);
-       return cmd;
+       boost::shared_ptr<MidiSource> ms = _midi_source.lock ();
+       assert (ms);
+
+       return new PatchChangeDiffCommand (ms->model(), name);
 }
 
+
 /** Apply a command.
  *
  * Ownership of cmd is taken, it must not be deleted by the caller.
@@ -64,255 +103,1736 @@ MidiModel::DeltaCommand* MidiModel::new_delta_command(const string name)
 void
 MidiModel::apply_command(Session& session, Command* cmd)
 {
-       session.begin_reversible_command(cmd->name());
+       session.begin_reversible_command (cmd->name());
+       (*cmd)();
+       session.commit_reversible_command (cmd);
+       set_edited (true);
+}
+
+/** Apply a command as part of a larger reversible transaction
+ *
+ * Ownership of cmd is taken, it must not be deleted by the caller.
+ * The command will constitute one item on the undo stack.
+ */
+void
+MidiModel::apply_command_as_subcommand(Session& session, Command* cmd)
+{
        (*cmd)();
-       assert(is_sorted());
-       session.commit_reversible_command(cmd);
-       set_edited(true);
+       session.add_command (cmd);
+       set_edited (true);
 }
 
+/************** DIFF COMMAND ********************/
 
-// DeltaCommand
+#define NOTE_DIFF_COMMAND_ELEMENT "NoteDiffCommand"
+#define DIFF_NOTES_ELEMENT "ChangedNotes"
+#define ADDED_NOTES_ELEMENT "AddedNotes"
+#define REMOVED_NOTES_ELEMENT "RemovedNotes"
+#define SIDE_EFFECT_REMOVALS_ELEMENT "SideEffectRemovals"
+#define SYSEX_DIFF_COMMAND_ELEMENT "SysExDiffCommand"
+#define DIFF_SYSEXES_ELEMENT "ChangedSysExes"
+#define PATCH_CHANGE_DIFF_COMMAND_ELEMENT "PatchChangeDiffCommand"
+#define ADDED_PATCH_CHANGES_ELEMENT "AddedPatchChanges"
+#define REMOVED_PATCH_CHANGES_ELEMENT "RemovedPatchChanges"
+#define DIFF_PATCH_CHANGES_ELEMENT "ChangedPatchChanges"
 
-MidiModel::DeltaCommand::DeltaCommand(boost::shared_ptr<MidiModel> m,
-               const std::string& name)
-       : Command(name)
-       , _model(m)
-       , _name(name)
+MidiModel::DiffCommand::DiffCommand(boost::shared_ptr<MidiModel> m, const std::string& name)
+       : Command (name)
+       , _model (m)
+       , _name (name)
 {
+       assert(_model);
 }
 
-MidiModel::DeltaCommand::DeltaCommand(boost::shared_ptr<MidiModel> m,
-               const XMLNode& node)
-       : _model(m)
+MidiModel::NoteDiffCommand::NoteDiffCommand (boost::shared_ptr<MidiModel> m, const XMLNode& node)
+       : DiffCommand (m, "")
 {
-       set_state(node);
+       assert (_model);
+       set_state (node, Stateful::loading_state_version);
 }
 
 void
-MidiModel::DeltaCommand::add(const boost::shared_ptr< Evoral::Note<TimeType> > note)
+MidiModel::NoteDiffCommand::add (const NotePtr note)
 {
-       //cerr << "MEC: apply" << endl;
        _removed_notes.remove(note);
        _added_notes.push_back(note);
 }
 
 void
-MidiModel::DeltaCommand::remove(const boost::shared_ptr< Evoral::Note<TimeType> > note)
+MidiModel::NoteDiffCommand::remove (const NotePtr note)
 {
-       //cerr << "MEC: remove" << endl;
        _added_notes.remove(note);
        _removed_notes.push_back(note);
 }
 
 void
-MidiModel::DeltaCommand::operator()()
+MidiModel::NoteDiffCommand::side_effect_remove (const NotePtr note)
+{
+       side_effect_removals.insert (note);
+}
+
+Variant
+MidiModel::NoteDiffCommand::get_value (const NotePtr note, Property prop)
+{
+       switch (prop) {
+       case NoteNumber:
+               return Variant(note->note());
+       case Velocity:
+               return Variant(note->velocity());
+       case Channel:
+               return Variant(note->channel());
+       case StartTime:
+               return Variant(note->time());
+       case Length:
+               return Variant(note->length());
+       }
+
+       return Variant();
+}
+
+Variant::Type
+MidiModel::NoteDiffCommand::value_type(Property prop)
+{
+       switch (prop) {
+       case NoteNumber:
+       case Velocity:
+       case Channel:
+               return Variant::INT;
+       case StartTime:
+       case Length:
+               return Variant::BEATS;
+       }
+
+       return Variant::NOTHING;
+}
+
+void
+MidiModel::NoteDiffCommand::change (const NotePtr  note,
+                                    Property       prop,
+                                    const Variant& new_value)
 {
-       // This could be made much faster by using a priority_queue for added and
-       // removed notes (or sort here), and doing a single iteration over _model
-       
-       _model->write_lock();
+       assert (note);
 
-       // Store the current seek position so we can restore the read iterator
-       // after modifying the contents of the model
-       const double read_time = _model->read_time();
+       const NoteChange change = {
+               prop, note, 0, get_value(note, prop), new_value
+       };
 
-       for (NoteList::iterator i = _added_notes.begin(); i != _added_notes.end(); ++i)
-               _model->add_note_unlocked(*i);
+       if (change.old_value == new_value) {
+               return;
+       }
 
-       for (NoteList::iterator i = _removed_notes.begin(); i != _removed_notes.end(); ++i)
-               _model->remove_note_unlocked(*i);
+       _changes.push_back (change);
+}
 
-       _model->write_unlock();
-       // FIXME: race?
-       _model->read_seek(read_time); // restore read position
+MidiModel::NoteDiffCommand &
+MidiModel::NoteDiffCommand::operator+= (const NoteDiffCommand& other)
+{
+       if (this == &other) {
+               return *this;
+       }
 
-       _model->ContentsChanged(); /* EMIT SIGNAL */
+       if (_model != other._model) {
+               return *this;
+       }
+
+       _added_notes.insert (_added_notes.end(), other._added_notes.begin(), other._added_notes.end());
+       _removed_notes.insert (_removed_notes.end(), other._removed_notes.begin(), other._removed_notes.end());
+       side_effect_removals.insert (other.side_effect_removals.begin(), other.side_effect_removals.end());
+       _changes.insert (_changes.end(), other._changes.begin(), other._changes.end());
+
+       return *this;
 }
 
 void
-MidiModel::DeltaCommand::undo()
+MidiModel::NoteDiffCommand::operator() ()
 {
-       // This could be made much faster by using a priority_queue for added and
-       // removed notes (or sort here), and doing a single iteration over _model
-       
-       _model->write_lock();
+       {
+               MidiModel::WriteLock lock(_model->edit_lock());
+
+               for (NoteList::iterator i = _added_notes.begin(); i != _added_notes.end(); ++i) {
+                       if (!_model->add_note_unlocked(*i)) {
+                               /* failed to add it, so don't leave it in the removed list, to
+                                  avoid apparent errors on undo.
+                               */
+                               _removed_notes.remove (*i);
+                       }
+               }
+
+               for (NoteList::iterator i = _removed_notes.begin(); i != _removed_notes.end(); ++i) {
+                       _model->remove_note_unlocked(*i);
+               }
+
+               /* notes we modify in a way that requires remove-then-add to maintain ordering */
+               set<NotePtr> temporary_removals;
+
+               for (ChangeList::iterator i = _changes.begin(); i != _changes.end(); ++i) {
+                       Property prop = i->property;
+
+                       if (!i->note) {
+                               /* note found during deserialization, so try
+                                  again now that the model state is different.
+                               */
+                               i->note = _model->find_note (i->note_id);
+                               assert (i->note);
+                       }
 
-       // Store the current seek position so we can restore the read iterator
-       // after modifying the contents of the model
-       const double read_time = _model->read_time();
+                       switch (prop) {
+                       case NoteNumber:
+                               if (temporary_removals.find (i->note) == temporary_removals.end()) {
+                                       _model->remove_note_unlocked (i->note);
+                                       temporary_removals.insert (i->note);
+                               }
+                               i->note->set_note (i->new_value.get_int());
+                               break;
 
-       for (NoteList::iterator i = _added_notes.begin(); i != _added_notes.end(); ++i)
-               _model->remove_note_unlocked(*i);
+                       case StartTime:
+                               if (temporary_removals.find (i->note) == temporary_removals.end()) {
+                                       _model->remove_note_unlocked (i->note);
+                                       temporary_removals.insert (i->note);
+                               }
+                               i->note->set_time (i->new_value.get_beats());
+                               break;
 
-       for (NoteList::iterator i = _removed_notes.begin(); i != _removed_notes.end(); ++i)
-               _model->add_note_unlocked(*i);
+                       case Channel:
+                               if (temporary_removals.find (i->note) == temporary_removals.end()) {
+                                       _model->remove_note_unlocked (i->note);
+                                       temporary_removals.insert (i->note);
+                               }
+                               i->note->set_channel (i->new_value.get_int());
+                               break;
 
-       _model->write_unlock();
-       // FIXME: race?
-       _model->read_seek(read_time); // restore read position
+                               /* no remove-then-add required for these properties, since we do not index them
+                                */
+
+                       case Velocity:
+                               i->note->set_velocity (i->new_value.get_int());
+                               break;
+
+                       case Length:
+                               i->note->set_length (i->new_value.get_beats());
+                               break;
+
+                       }
+               }
+
+               for (set<NotePtr>::iterator i = temporary_removals.begin(); i != temporary_removals.end(); ++i) {
+                       NoteDiffCommand side_effects (model(), "side effects");
+                       if (_model->add_note_unlocked (*i, &side_effects)) {
+                               /* The note was re-added ok */
+                               *this += side_effects;
+                       } else {
+                               /* The note that we removed earlier could not be re-added.  This change record
+                                  must say that the note was removed.  We'll keep the changes we made, though,
+                                  as if the note is re-added by the undo the changes must also be undone.
+                               */
+                               _removed_notes.push_back (*i);
+                       }
+               }
+
+               if (!side_effect_removals.empty()) {
+                       cerr << "SER: \n";
+                       for (set<NotePtr>::iterator i = side_effect_removals.begin(); i != side_effect_removals.end(); ++i) {
+                               cerr << "\t" << *i << ' ' << **i << endl;
+                       }
+               }
+       }
 
        _model->ContentsChanged(); /* EMIT SIGNAL */
 }
 
-XMLNode&
-MidiModel::DeltaCommand::marshal_note(const boost::shared_ptr< Evoral::Note<TimeType> > note)
+void
+MidiModel::NoteDiffCommand::undo ()
 {
-       XMLNode *xml_note = new XMLNode("note");
-       ostringstream note_str(ios::ate);
-       note_str << int(note->note());
-       xml_note->add_property("note", note_str.str());
+       {
+               MidiModel::WriteLock lock(_model->edit_lock());
 
-       ostringstream channel_str(ios::ate);
-       channel_str << int(note->channel());
-       xml_note->add_property("channel", channel_str.str());
+               for (NoteList::iterator i = _added_notes.begin(); i != _added_notes.end(); ++i) {
+                       _model->remove_note_unlocked(*i);
+               }
 
-       ostringstream time_str(ios::ate);
-       time_str << int(note->time());
-       xml_note->add_property("time", time_str.str());
+               /* Apply changes first; this is important in the case of a note change which
+                  resulted in the note being removed by the overlap checker.  If the overlap
+                  checker removes a note, it will be in _removed_notes.  We are going to re-add
+                  it below, but first we must undo the changes we made so that the overlap
+                  checker doesn't refuse the re-add.
+               */
 
-       ostringstream length_str(ios::ate);
-       length_str <<(unsigned int) note->length();
-       xml_note->add_property("length", length_str.str());
+               /* notes we modify in a way that requires remove-then-add to maintain ordering */
+               set<NotePtr> temporary_removals;
 
-       ostringstream velocity_str(ios::ate);
-       velocity_str << (unsigned int) note->velocity();
-       xml_note->add_property("velocity", velocity_str.str());
+
+               /* lazily discover any affected notes that were not discovered when
+                * loading the history because of deletions, etc.
+                */
+
+               for (ChangeList::iterator i = _changes.begin(); i != _changes.end(); ++i) {
+                       if (!i->note) {
+                               i->note = _model->find_note (i->note_id);
+                               assert (i->note);
+                       }
+               }
+
+               for (ChangeList::iterator i = _changes.begin(); i != _changes.end(); ++i) {
+                       Property prop = i->property;
+
+                       switch (prop) {
+                       case NoteNumber:
+                               if (temporary_removals.find (i->note) == temporary_removals.end() &&
+                                   find (_removed_notes.begin(), _removed_notes.end(), i->note) == _removed_notes.end()) {
+
+                                       /* We only need to mark this note for re-add if (a) we haven't
+                                          already marked it and (b) it isn't on the _removed_notes
+                                          list (which means that it has already been removed and it
+                                          will be re-added anyway)
+                                       */
+
+                                       _model->remove_note_unlocked (i->note);
+                                       temporary_removals.insert (i->note);
+                               }
+                               i->note->set_note (i->old_value.get_int());
+                               break;
+
+                       case StartTime:
+                               if (temporary_removals.find (i->note) == temporary_removals.end() &&
+                                   find (_removed_notes.begin(), _removed_notes.end(), i->note) == _removed_notes.end()) {
+
+                                       /* See above ... */
+
+                                       _model->remove_note_unlocked (i->note);
+                                       temporary_removals.insert (i->note);
+                               }
+                               i->note->set_time (i->old_value.get_beats());
+                               break;
+
+                       case Channel:
+                               if (temporary_removals.find (i->note) == temporary_removals.end() &&
+                                   find (_removed_notes.begin(), _removed_notes.end(), i->note) == _removed_notes.end()) {
+
+                                       /* See above ... */
+
+                                       _model->remove_note_unlocked (i->note);
+                                       temporary_removals.insert (i->note);
+                               }
+                               i->note->set_channel (i->old_value.get_int());
+                               break;
+
+                               /* no remove-then-add required for these properties, since we do not index them
+                                */
+
+                       case Velocity:
+                               i->note->set_velocity (i->old_value.get_int());
+                               break;
+
+                       case Length:
+                               i->note->set_length (i->old_value.get_beats());
+                               break;
+                       }
+               }
+
+               for (NoteList::iterator i = _removed_notes.begin(); i != _removed_notes.end(); ++i) {
+                       _model->add_note_unlocked(*i);
+               }
+
+               for (set<NotePtr>::iterator i = temporary_removals.begin(); i != temporary_removals.end(); ++i) {
+                       _model->add_note_unlocked (*i);
+               }
+
+               /* finally add back notes that were removed by the "do". we don't care
+                  about side effects here since the model should be back to its original
+                  state once this is done.
+               */
+
+               for (set<NotePtr>::iterator i = side_effect_removals.begin(); i != side_effect_removals.end(); ++i) {
+                       _model->add_note_unlocked (*i);
+               }
+       }
+
+       _model->ContentsChanged(); /* EMIT SIGNAL */
+}
+
+XMLNode&
+MidiModel::NoteDiffCommand::marshal_note(const NotePtr note)
+{
+       XMLNode* xml_note = new XMLNode("note");
+
+       xml_note->set_property ("id", note->id ());
+       xml_note->set_property ("note", note->note ());
+       xml_note->set_property ("channel", note->channel ());
+       xml_note->set_property ("time", note->time ());
+       xml_note->set_property ("length", note->length ());
+       xml_note->set_property ("velocity", note->velocity ());
 
        return *xml_note;
 }
 
-boost::shared_ptr< Evoral::Note<double> >
-MidiModel::DeltaCommand::unmarshal_note(XMLNode *xml_note)
+Evoral::Sequence<MidiModel::TimeType>::NotePtr
+MidiModel::NoteDiffCommand::unmarshal_note (XMLNode *xml_note)
 {
-       unsigned int note;
-       XMLProperty* prop;
-       unsigned int channel;
-       unsigned int time;
-       unsigned int length;
-       unsigned int velocity;
+       Evoral::event_id_t id;
+       if (!xml_note->get_property ("id", id)) {
+               error << "note information missing ID value" << endmsg;
+               id = -1;
+       }
 
-       if ((prop = xml_note->property("note")) != 0) {
-               istringstream note_str(prop->value());
-               note_str >> note;
-       } else {
+       uint8_t note;
+       if (!xml_note->get_property("note", note)) {
                warning << "note information missing note value" << endmsg;
                note = 127;
        }
 
-       if ((prop = xml_note->property("channel")) != 0) {
-               istringstream channel_str(prop->value());
-               channel_str >> channel;
-       } else {
+       uint8_t channel;
+       if (!xml_note->get_property("channel", channel)) {
                warning << "note information missing channel" << endmsg;
                channel = 0;
        }
 
-       if ((prop = xml_note->property("time")) != 0) {
-               istringstream time_str(prop->value());
-               time_str >> time;
-       } else {
+       MidiModel::TimeType time;
+       if (!xml_note->get_property("time", time)) {
                warning << "note information missing time" << endmsg;
-               time = 0;
+               time = MidiModel::TimeType();
        }
 
-       if ((prop = xml_note->property("length")) != 0) {
-               istringstream length_str(prop->value());
-               length_str >> length;
-       } else {
+       MidiModel::TimeType length;
+       if (!xml_note->get_property("length", length)) {
                warning << "note information missing length" << endmsg;
-               note = 1;
+               length = MidiModel::TimeType(1);
        }
 
-       if ((prop = xml_note->property("velocity")) != 0) {
-               istringstream velocity_str(prop->value());
-               velocity_str >> velocity;
-       } else {
+       uint8_t velocity;
+       if (!xml_note->get_property("velocity", velocity)) {
                warning << "note information missing velocity" << endmsg;
                velocity = 127;
        }
 
-       boost::shared_ptr< Evoral::Note<TimeType> > note_ptr(new Evoral::Note<TimeType>(
-                       channel, time, length, note, velocity));
+       NotePtr note_ptr(new Evoral::Note<TimeType>(channel, time, length, note, velocity));
+       note_ptr->set_id (id);
+
        return note_ptr;
 }
 
-#define ADDED_NOTES_ELEMENT "added_notes"
-#define REMOVED_NOTES_ELEMENT "removed_notes"
-#define DELTA_COMMAND_ELEMENT "DeltaCommand"
+XMLNode&
+MidiModel::NoteDiffCommand::marshal_change (const NoteChange& change)
+{
+       XMLNode* xml_change = new XMLNode("Change");
+
+       /* first, the change itself */
+
+       xml_change->set_property ("property", change.property);
+
+       if (change.property == StartTime || change.property == Length) {
+               xml_change->set_property ("old", change.old_value.get_beats ());
+       } else {
+               xml_change->set_property ("old", change.old_value.get_int ());
+       }
+
+       if (change.property == StartTime || change.property == Length) {
+               xml_change->set_property ("new", change.new_value.get_beats ());
+       } else {
+               xml_change->set_property ("new", change.new_value.get_int ());
+       }
+
+       if (change.note) {
+               xml_change->set_property ("id", change.note->id());
+       } else if (change.note_id) {
+               warning << _("Change has no note, using note ID") << endmsg;
+               xml_change->set_property ("id", change.note_id);
+       } else {
+               error << _("Change has no note or note ID") << endmsg;
+       }
+
+       return *xml_change;
+}
+
+MidiModel::NoteDiffCommand::NoteChange
+MidiModel::NoteDiffCommand::unmarshal_change (XMLNode *xml_change)
+{
+       NoteChange change;
+       change.note_id = 0;
+
+       if (!xml_change->get_property("property", change.property)) {
+               fatal << "!!!" << endmsg;
+               abort(); /*NOTREACHED*/
+       }
+
+       int note_id;
+       if (!xml_change->get_property ("id", note_id)) {
+               error << _("No NoteID found for note property change - ignored") << endmsg;
+               return change;
+       }
+
+       int old_val;
+       Evoral::Beats old_time;
+       if ((change.property == StartTime || change.property == Length) &&
+           xml_change->get_property ("old", old_time)) {
+               change.old_value = old_time;
+       } else if (xml_change->get_property ("old", old_val)) {
+               change.old_value = old_val;
+       } else {
+               fatal << "!!!" << endmsg;
+               abort(); /*NOTREACHED*/
+       }
+
+       int new_val;
+       Evoral::Beats new_time;
+       if ((change.property == StartTime || change.property == Length) &&
+           xml_change->get_property ("new", new_time)) {
+               change.new_value = new_time;
+       } else if (xml_change->get_property ("new", new_val)) {
+               change.new_value = new_val;
+       } else {
+               fatal << "!!!" << endmsg;
+               abort(); /*NOTREACHED*/
+       }
+
+       /* we must point at the instance of the note that is actually in the model.
+          so go look for it ... it may not be there (it could have been
+          deleted in a later operation, so store the note id so that we can
+          look it up again later).
+       */
+
+       change.note = _model->find_note (note_id);
+       change.note_id = note_id;
+
+       return change;
+}
 
 int
-MidiModel::DeltaCommand::set_state(const XMLNode& delta_command)
+MidiModel::NoteDiffCommand::set_state (const XMLNode& diff_command, int /*version*/)
 {
-       if (delta_command.name() != string(DELTA_COMMAND_ELEMENT)) {
+       if (diff_command.name() != string (NOTE_DIFF_COMMAND_ELEMENT)) {
                return 1;
        }
 
+       /* additions */
+
        _added_notes.clear();
-       XMLNode *added_notes = delta_command.child(ADDED_NOTES_ELEMENT);
-       XMLNodeList notes = added_notes->children();
-       transform(notes.begin(), notes.end(), back_inserter(_added_notes),
-                       sigc::mem_fun(*this, &DeltaCommand::unmarshal_note));
+       XMLNode* added_notes = diff_command.child(ADDED_NOTES_ELEMENT);
+       if (added_notes) {
+               XMLNodeList notes = added_notes->children();
+               transform(notes.begin(), notes.end(), back_inserter(_added_notes),
+                         boost::bind (&NoteDiffCommand::unmarshal_note, this, _1));
+       }
+
+
+       /* removals */
 
        _removed_notes.clear();
-       XMLNode *removed_notes = delta_command.child(REMOVED_NOTES_ELEMENT);
-       notes = removed_notes->children();
-       transform(notes.begin(), notes.end(), back_inserter(_removed_notes),
-                       sigc::mem_fun(*this, &DeltaCommand::unmarshal_note));
+       XMLNode* removed_notes = diff_command.child(REMOVED_NOTES_ELEMENT);
+       if (removed_notes) {
+               XMLNodeList notes = removed_notes->children();
+               transform(notes.begin(), notes.end(), back_inserter(_removed_notes),
+                         boost::bind (&NoteDiffCommand::unmarshal_note, this, _1));
+       }
+
+
+       /* changes */
+
+       _changes.clear();
+
+       XMLNode* changed_notes = diff_command.child(DIFF_NOTES_ELEMENT);
+
+       if (changed_notes) {
+               XMLNodeList notes = changed_notes->children();
+               transform (notes.begin(), notes.end(), back_inserter(_changes),
+                          boost::bind (&NoteDiffCommand::unmarshal_change, this, _1));
+
+       }
+
+       /* side effect removals caused by changes */
+
+       side_effect_removals.clear();
+
+       XMLNode* side_effect_notes = diff_command.child(SIDE_EFFECT_REMOVALS_ELEMENT);
+
+       if (side_effect_notes) {
+               XMLNodeList notes = side_effect_notes->children();
+               for (XMLNodeList::iterator n = notes.begin(); n != notes.end(); ++n) {
+                       side_effect_removals.insert (unmarshal_note (*n));
+               }
+       }
 
        return 0;
 }
 
 XMLNode&
-MidiModel::DeltaCommand::get_state()
+MidiModel::NoteDiffCommand::get_state ()
 {
-       XMLNode *delta_command = new XMLNode(DELTA_COMMAND_ELEMENT);
-       delta_command->add_property("midi-source", _model->midi_source()->id().to_s());
+       XMLNode* diff_command = new XMLNode (NOTE_DIFF_COMMAND_ELEMENT);
+       diff_command->set_property("midi-source", _model->midi_source()->id().to_s());
+
+       XMLNode* changes = diff_command->add_child(DIFF_NOTES_ELEMENT);
+       for_each(_changes.begin(), _changes.end(),
+                boost::bind (
+                        boost::bind (&XMLNode::add_child_nocopy, changes, _1),
+                        boost::bind (&NoteDiffCommand::marshal_change, this, _1)));
+
+       XMLNode* added_notes = diff_command->add_child(ADDED_NOTES_ELEMENT);
+       for_each(_added_notes.begin(), _added_notes.end(),
+                boost::bind(
+                        boost::bind (&XMLNode::add_child_nocopy, added_notes, _1),
+                        boost::bind (&NoteDiffCommand::marshal_note, this, _1)));
 
-       XMLNode *added_notes = delta_command->add_child(ADDED_NOTES_ELEMENT);
-       for_each(_added_notes.begin(), _added_notes.end(), sigc::compose(
-                       sigc::mem_fun(*added_notes, &XMLNode::add_child_nocopy),
-                       sigc::mem_fun(*this, &DeltaCommand::marshal_note)));
+       XMLNode* removed_notes = diff_command->add_child(REMOVED_NOTES_ELEMENT);
+       for_each(_removed_notes.begin(), _removed_notes.end(),
+                boost::bind (
+                        boost::bind (&XMLNode::add_child_nocopy, removed_notes, _1),
+                        boost::bind (&NoteDiffCommand::marshal_note, this, _1)));
 
-       XMLNode *removed_notes = delta_command->add_child(REMOVED_NOTES_ELEMENT);
-       for_each(_removed_notes.begin(), _removed_notes.end(), sigc::compose(
-                       sigc::mem_fun(*removed_notes, &XMLNode::add_child_nocopy),
-                       sigc::mem_fun(*this, &DeltaCommand::marshal_note)));
+       /* if this command had side-effects, store that state too
+        */
 
-       return *delta_command;
+       if (!side_effect_removals.empty()) {
+               XMLNode* side_effect_notes = diff_command->add_child(SIDE_EFFECT_REMOVALS_ELEMENT);
+               for_each(side_effect_removals.begin(), side_effect_removals.end(),
+                        boost::bind (
+                                boost::bind (&XMLNode::add_child_nocopy, side_effect_notes, _1),
+                                boost::bind (&NoteDiffCommand::marshal_note, this, _1)));
+       }
+
+       return *diff_command;
 }
 
-/** Write the model to a MidiSource (i.e. save the model).
- * This is different from manually using read to write to a source in that
- * note off events are written regardless of the track mode.  This is so the
- * user can switch a recorded track (with note durations from some instrument)
- * to percussive, save, reload, then switch it back to sustained without
- * destroying the original note durations.
- */
-bool
-MidiModel::write_to(boost::shared_ptr<MidiSource> source)
+MidiModel::SysExDiffCommand::SysExDiffCommand (boost::shared_ptr<MidiModel> m, const XMLNode& node)
+       : DiffCommand (m, "")
 {
-       read_lock();
+       assert (_model);
+       set_state (node, Stateful::loading_state_version);
+}
 
-       const bool old_percussive = percussive();
-       set_percussive(false);
-       
-       for (Evoral::Sequence<TimeType>::const_iterator i = begin(); i != end(); ++i) {
-               source->append_event_unlocked(Frames, *i);
+void
+MidiModel::SysExDiffCommand::change (boost::shared_ptr<Evoral::Event<TimeType> > s, TimeType new_time)
+{
+       Change change;
+
+       change.sysex = s;
+       change.property = Time;
+       change.old_time = s->time ();
+       change.new_time = new_time;
+
+       _changes.push_back (change);
+}
+
+void
+MidiModel::SysExDiffCommand::operator() ()
+{
+       {
+               MidiModel::WriteLock lock (_model->edit_lock ());
+
+               for (list<SysExPtr>::iterator i = _removed.begin(); i != _removed.end(); ++i) {
+                       _model->remove_sysex_unlocked (*i);
+               }
+
+               /* find any sysex events that were missing when unmarshalling */
+
+               for (ChangeList::iterator i = _changes.begin(); i != _changes.end(); ++i) {
+                       if (!i->sysex) {
+                               i->sysex = _model->find_sysex (i->sysex_id);
+                               assert (i->sysex);
+                       }
+               }
+
+               for (ChangeList::iterator i = _changes.begin(); i != _changes.end(); ++i) {
+                       switch (i->property) {
+                       case Time:
+                               i->sysex->set_time (i->new_time);
+                       }
+               }
        }
-               
-       set_percussive(old_percussive);
-       
-       read_unlock();
-       set_edited(false);
 
-       return true;
+       _model->ContentsChanged (); /* EMIT SIGNAL */
+}
+
+void
+MidiModel::SysExDiffCommand::undo ()
+{
+       {
+               MidiModel::WriteLock lock (_model->edit_lock ());
+
+               for (list<SysExPtr>::iterator i = _removed.begin(); i != _removed.end(); ++i) {
+                       _model->add_sysex_unlocked (*i);
+               }
+
+               /* find any sysex events that were missing when unmarshalling */
+
+               for (ChangeList::iterator i = _changes.begin(); i != _changes.end(); ++i) {
+                       if (!i->sysex) {
+                               i->sysex = _model->find_sysex (i->sysex_id);
+                               assert (i->sysex);
+                       }
+               }
+
+               for (ChangeList::iterator i = _changes.begin(); i != _changes.end(); ++i) {
+                       switch (i->property) {
+                       case Time:
+                               i->sysex->set_time (i->old_time);
+                               break;
+                       }
+               }
+
+       }
+
+       _model->ContentsChanged(); /* EMIT SIGNAL */
+}
+
+void
+MidiModel::SysExDiffCommand::remove (SysExPtr sysex)
+{
+       _removed.push_back(sysex);
 }
 
 XMLNode&
-MidiModel::get_state()
+MidiModel::SysExDiffCommand::marshal_change (const Change& change)
 {
-       XMLNode *node = new XMLNode("MidiModel");
-       return *node;
+       XMLNode* xml_change = new XMLNode ("Change");
+
+       /* first, the change itself */
+
+       xml_change->set_property ("property", change.property);
+       xml_change->set_property ("old", change.old_time);
+       xml_change->set_property ("new", change.new_time);
+       xml_change->set_property ("id", change.sysex->id());
+
+       return *xml_change;
+}
+
+MidiModel::SysExDiffCommand::Change
+MidiModel::SysExDiffCommand::unmarshal_change (XMLNode *xml_change)
+{
+       Change change;
+
+       if (!xml_change->get_property ("property", change.property)) {
+               fatal << "!!!" << endmsg;
+               abort(); /*NOTREACHED*/
+       }
+
+       int sysex_id;
+       if (!xml_change->get_property ("id", sysex_id)) {
+               error << _("No SysExID found for sys-ex property change - ignored") << endmsg;
+               return change;
+       }
+
+       if (!xml_change->get_property ("old", change.old_time)) {
+               fatal << "!!!" << endmsg;
+               abort(); /*NOTREACHED*/
+       }
+
+       if (!xml_change->get_property ("new", change.new_time)) {
+               fatal << "!!!" << endmsg;
+               abort(); /*NOTREACHED*/
+       }
+
+       /* we must point at the instance of the sysex that is actually in the model.
+          so go look for it ...
+       */
+
+       change.sysex = _model->find_sysex (sysex_id);
+       change.sysex_id = sysex_id;
+
+       return change;
+}
+
+int
+MidiModel::SysExDiffCommand::set_state (const XMLNode& diff_command, int /*version*/)
+{
+       if (diff_command.name() != string (SYSEX_DIFF_COMMAND_ELEMENT)) {
+               return 1;
+       }
+
+       /* changes */
+
+       _changes.clear();
+
+       XMLNode* changed_sysexes = diff_command.child (DIFF_SYSEXES_ELEMENT);
+
+       if (changed_sysexes) {
+               XMLNodeList sysexes = changed_sysexes->children();
+               transform (sysexes.begin(), sysexes.end(), back_inserter (_changes),
+                          boost::bind (&SysExDiffCommand::unmarshal_change, this, _1));
+
+       }
+
+       return 0;
+}
+
+XMLNode&
+MidiModel::SysExDiffCommand::get_state ()
+{
+       XMLNode* diff_command = new XMLNode (SYSEX_DIFF_COMMAND_ELEMENT);
+       diff_command->set_property ("midi-source", _model->midi_source()->id().to_s());
+
+       XMLNode* changes = diff_command->add_child(DIFF_SYSEXES_ELEMENT);
+       for_each (_changes.begin(), _changes.end(),
+                 boost::bind (
+                         boost::bind (&XMLNode::add_child_nocopy, changes, _1),
+                         boost::bind (&SysExDiffCommand::marshal_change, this, _1)));
+
+       return *diff_command;
+}
+
+MidiModel::PatchChangeDiffCommand::PatchChangeDiffCommand (boost::shared_ptr<MidiModel> m, const string& name)
+       : DiffCommand (m, name)
+{
+       assert (_model);
+}
+
+MidiModel::PatchChangeDiffCommand::PatchChangeDiffCommand (boost::shared_ptr<MidiModel> m, const XMLNode & node)
+       : DiffCommand (m, "")
+{
+       assert (_model);
+       set_state (node, Stateful::loading_state_version);
+}
+
+void
+MidiModel::PatchChangeDiffCommand::add (PatchChangePtr p)
+{
+       _added.push_back (p);
+}
+
+void
+MidiModel::PatchChangeDiffCommand::remove (PatchChangePtr p)
+{
+       _removed.push_back (p);
+}
+
+void
+MidiModel::PatchChangeDiffCommand::change_time (PatchChangePtr patch, TimeType t)
+{
+       Change c;
+       c.property = Time;
+       c.patch = patch;
+       c.old_time = patch->time ();
+       c.new_time = t;
+
+       _changes.push_back (c);
+}
+
+void
+MidiModel::PatchChangeDiffCommand::change_channel (PatchChangePtr patch, uint8_t channel)
+{
+       Change c;
+       c.property = Channel;
+       c.patch = patch;
+       c.old_channel = patch->channel ();
+       c.new_channel = channel;
+       c.patch_id = patch->id();
+
+       _changes.push_back (c);
 }
 
+void
+MidiModel::PatchChangeDiffCommand::change_program (PatchChangePtr patch, uint8_t program)
+{
+       Change c;
+       c.property = Program;
+       c.patch = patch;
+       c.old_program = patch->program ();
+       c.new_program = program;
+       c.patch_id = patch->id();
+
+       _changes.push_back (c);
+}
+
+void
+MidiModel::PatchChangeDiffCommand::change_bank (PatchChangePtr patch, int bank)
+{
+       Change c;
+       c.property = Bank;
+       c.patch = patch;
+       c.old_bank = patch->bank ();
+       c.new_bank = bank;
+
+       _changes.push_back (c);
+}
+
+void
+MidiModel::PatchChangeDiffCommand::operator() ()
+{
+       {
+               MidiModel::WriteLock lock (_model->edit_lock ());
+
+               for (list<PatchChangePtr>::iterator i = _added.begin(); i != _added.end(); ++i) {
+                       _model->add_patch_change_unlocked (*i);
+               }
+
+               for (list<PatchChangePtr>::iterator i = _removed.begin(); i != _removed.end(); ++i) {
+                       _model->remove_patch_change_unlocked (*i);
+               }
+
+               /* find any patch change events that were missing when unmarshalling */
+
+               for (ChangeList::iterator i = _changes.begin(); i != _changes.end(); ++i) {
+                       if (!i->patch) {
+                               i->patch = _model->find_patch_change (i->patch_id);
+                               assert (i->patch);
+                       }
+               }
+
+               set<PatchChangePtr> temporary_removals;
+
+               for (ChangeList::iterator i = _changes.begin(); i != _changes.end(); ++i) {
+                       switch (i->property) {
+                       case Time:
+                               if (temporary_removals.find (i->patch) == temporary_removals.end()) {
+                                       _model->remove_patch_change_unlocked (i->patch);
+                                       temporary_removals.insert (i->patch);
+                               }
+                               i->patch->set_time (i->new_time);
+                               break;
+
+                       case Channel:
+                               i->patch->set_channel (i->new_channel);
+                               break;
+
+                       case Program:
+                               i->patch->set_program (i->new_program);
+                               break;
+
+                       case Bank:
+                               i->patch->set_bank (i->new_bank);
+                               break;
+                       }
+               }
+
+               for (set<PatchChangePtr>::iterator i = temporary_removals.begin(); i != temporary_removals.end(); ++i) {
+                       _model->add_patch_change_unlocked (*i);
+               }
+       }
+
+       _model->ContentsChanged (); /* EMIT SIGNAL */
+}
+
+void
+MidiModel::PatchChangeDiffCommand::undo ()
+{
+       {
+               MidiModel::WriteLock lock (_model->edit_lock());
+
+               for (list<PatchChangePtr>::iterator i = _added.begin(); i != _added.end(); ++i) {
+                       _model->remove_patch_change_unlocked (*i);
+               }
+
+               for (list<PatchChangePtr>::iterator i = _removed.begin(); i != _removed.end(); ++i) {
+                       _model->add_patch_change_unlocked (*i);
+               }
+
+               /* find any patch change events that were missing when unmarshalling */
+
+               for (ChangeList::iterator i = _changes.begin(); i != _changes.end(); ++i) {
+                       if (!i->patch) {
+                               i->patch = _model->find_patch_change (i->patch_id);
+                               assert (i->patch);
+                       }
+               }
+
+               set<PatchChangePtr> temporary_removals;
+
+               for (ChangeList::iterator i = _changes.begin(); i != _changes.end(); ++i) {
+                       switch (i->property) {
+                       case Time:
+                               if (temporary_removals.find (i->patch) == temporary_removals.end()) {
+                                       _model->remove_patch_change_unlocked (i->patch);
+                                       temporary_removals.insert (i->patch);
+                               }
+                               i->patch->set_time (i->old_time);
+                               break;
+
+                       case Channel:
+                               i->patch->set_channel (i->old_channel);
+                               break;
+
+                       case Program:
+                               i->patch->set_program (i->old_program);
+                               break;
+
+                       case Bank:
+                               i->patch->set_bank (i->old_bank);
+                               break;
+                       }
+               }
+
+               for (set<PatchChangePtr>::iterator i = temporary_removals.begin(); i != temporary_removals.end(); ++i) {
+                       _model->add_patch_change_unlocked (*i);
+               }
+
+       }
+
+       _model->ContentsChanged (); /* EMIT SIGNAL */
+}
+
+XMLNode &
+MidiModel::PatchChangeDiffCommand::marshal_patch_change (constPatchChangePtr p)
+{
+       XMLNode* n = new XMLNode ("patch-change");
+
+       n->set_property ("id", p->id ());
+       n->set_property ("time", p->time ());
+       n->set_property ("channel", p->channel ());
+       n->set_property ("program", p->program ());
+       n->set_property ("bank", p->bank ());
+
+       return *n;
+}
+
+XMLNode&
+MidiModel::PatchChangeDiffCommand::marshal_change (const Change& c)
+{
+       XMLNode* n = new XMLNode (X_("Change"));
+
+       n->set_property (X_("property"), c.property);
+
+       if (c.property == Time) {
+               n->set_property (X_("old"), c.old_time);
+       } else if (c.property == Channel) {
+               n->set_property (X_("old"), c.old_channel);
+       } else if (c.property == Program) {
+               n->set_property (X_("old"), c.old_program);
+       } else if (c.property == Bank) {
+               n->set_property (X_("old"), c.old_bank);
+       }
+
+       if (c.property == Time) {
+               n->set_property (X_ ("new"), c.new_time);
+       } else if (c.property == Channel) {
+               n->set_property (X_ ("new"), c.new_channel);
+       } else if (c.property == Program) {
+               n->set_property (X_ ("new"), c.new_program);
+       } else if (c.property == Bank) {
+               n->set_property (X_ ("new"), c.new_bank);
+       }
+
+       n->set_property ("id", c.patch->id ());
+
+       return *n;
+}
+
+MidiModel::PatchChangePtr
+MidiModel::PatchChangeDiffCommand::unmarshal_patch_change (XMLNode* n)
+{
+       Evoral::event_id_t id = 0;
+       if (!n->get_property ("id", id)) {
+               assert(false);
+       }
+
+       Evoral::Beats time = Evoral::Beats();
+       if (!n->get_property ("time", time)) {
+               // warning??
+       }
+
+       uint8_t channel = 0;
+       if (!n->get_property ("channel", channel)) {
+               // warning??
+       }
+
+       int program = 0;
+       if (!n->get_property ("program", program)) {
+               // warning??
+       }
+
+       int bank = 0;
+       if (!n->get_property ("bank", bank)) {
+               // warning??
+       }
+
+       PatchChangePtr p (new Evoral::PatchChange<TimeType> (time, channel, program, bank));
+       p->set_id (id);
+       return p;
+}
+
+MidiModel::PatchChangeDiffCommand::Change
+MidiModel::PatchChangeDiffCommand::unmarshal_change (XMLNode* n)
+{
+       Change c;
+       Evoral::event_id_t id;
+
+       if (!n->get_property ("property", c.property) || !n->get_property ("id", id)) {
+               assert(false);
+       }
+
+       if ((c.property == Time && !n->get_property ("old", c.old_time)) ||
+           (c.property == Channel && !n->get_property ("old", c.old_channel)) ||
+           (c.property == Program && !n->get_property ("old", c.old_program)) ||
+           (c.property == Bank && !n->get_property ("old", c.old_bank))) {
+               assert (false);
+       }
+
+       if ((c.property == Time && !n->get_property ("new", c.new_time)) ||
+           (c.property == Channel && !n->get_property ("new", c.new_channel)) ||
+           (c.property == Program && !n->get_property ("new", c.new_program)) ||
+           (c.property == Bank && !n->get_property ("new", c.new_bank))) {
+               assert (false);
+       }
+
+       c.patch = _model->find_patch_change (id);
+       c.patch_id = id;
+
+       return c;
+}
+
+int
+MidiModel::PatchChangeDiffCommand::set_state (const XMLNode& diff_command, int /*version*/)
+{
+       if (diff_command.name() != PATCH_CHANGE_DIFF_COMMAND_ELEMENT) {
+               return 1;
+       }
+
+       _added.clear ();
+       XMLNode* added = diff_command.child (ADDED_PATCH_CHANGES_ELEMENT);
+       if (added) {
+               XMLNodeList p = added->children ();
+               transform (p.begin(), p.end(), back_inserter (_added), boost::bind (&PatchChangeDiffCommand::unmarshal_patch_change, this, _1));
+       }
+
+       _removed.clear ();
+       XMLNode* removed = diff_command.child (REMOVED_PATCH_CHANGES_ELEMENT);
+       if (removed) {
+               XMLNodeList p = removed->children ();
+               transform (p.begin(), p.end(), back_inserter (_removed), boost::bind (&PatchChangeDiffCommand::unmarshal_patch_change, this, _1));
+       }
+
+       _changes.clear ();
+       XMLNode* changed = diff_command.child (DIFF_PATCH_CHANGES_ELEMENT);
+       if (changed) {
+               XMLNodeList p = changed->children ();
+               transform (p.begin(), p.end(), back_inserter (_changes), boost::bind (&PatchChangeDiffCommand::unmarshal_change, this, _1));
+       }
+
+       return 0;
+}
+
+XMLNode &
+MidiModel::PatchChangeDiffCommand::get_state ()
+{
+       XMLNode* diff_command = new XMLNode (PATCH_CHANGE_DIFF_COMMAND_ELEMENT);
+       diff_command->set_property("midi-source", _model->midi_source()->id().to_s());
+
+       XMLNode* added = diff_command->add_child (ADDED_PATCH_CHANGES_ELEMENT);
+       for_each (_added.begin(), _added.end(),
+                 boost::bind (
+                         boost::bind (&XMLNode::add_child_nocopy, added, _1),
+                         boost::bind (&PatchChangeDiffCommand::marshal_patch_change, this, _1)
+                         )
+               );
+
+       XMLNode* removed = diff_command->add_child (REMOVED_PATCH_CHANGES_ELEMENT);
+       for_each (_removed.begin(), _removed.end(),
+                 boost::bind (
+                         boost::bind (&XMLNode::add_child_nocopy, removed, _1),
+                         boost::bind (&PatchChangeDiffCommand::marshal_patch_change, this, _1)
+                         )
+               );
+
+       XMLNode* changes = diff_command->add_child (DIFF_PATCH_CHANGES_ELEMENT);
+       for_each (_changes.begin(), _changes.end(),
+                 boost::bind (
+                         boost::bind (&XMLNode::add_child_nocopy, changes, _1),
+                         boost::bind (&PatchChangeDiffCommand::marshal_change, this, _1)
+                         )
+               );
+
+       return *diff_command;
+}
+
+/** Write all of the model to a MidiSource (i.e. save the model).
+ * This is different from manually using read to write to a source in that
+ * note off events are written regardless of the track mode.  This is so the
+ * user can switch a recorded track (with note durations from some instrument)
+ * to percussive, save, reload, then switch it back to sustained without
+ * destroying the original note durations.
+ *
+ * Similarly, control events are written without interpolation (as with the
+ * `Discrete' mode).
+ */
+bool
+MidiModel::write_to (boost::shared_ptr<MidiSource>     source,
+                     const Glib::Threads::Mutex::Lock& source_lock)
+{
+       ReadLock lock(read_lock());
+
+       const bool old_percussive = percussive();
+       set_percussive(false);
+
+       source->drop_model(source_lock);
+       source->mark_streaming_midi_write_started (source_lock, note_mode());
+
+       for (Evoral::Sequence<TimeType>::const_iterator i = begin(TimeType(), true); i != end(); ++i) {
+               source->append_event_beats(source_lock, *i);
+       }
+
+       set_percussive(old_percussive);
+       source->mark_streaming_write_completed(source_lock);
+
+       set_edited(false);
+
+       return true;
+}
+
+/** very similar to ::write_to() but writes to the model's own
+    existing midi_source, without making it call MidiSource::drop_model().
+    the caller is a MidiSource that needs to catch up with the state
+    of the model.
+*/
+bool
+MidiModel::sync_to_source (const Glib::Threads::Mutex::Lock& source_lock)
+{
+       ReadLock lock(read_lock());
+
+       const bool old_percussive = percussive();
+       set_percussive(false);
+
+       boost::shared_ptr<MidiSource> ms = _midi_source.lock ();
+       if (!ms) {
+               error << "MIDI model has no source to sync to" << endmsg;
+               return false;
+       }
+
+       /* Invalidate and store active notes, which will be picked up by the iterator
+          on the next roll if time progresses linearly. */
+       ms->invalidate(source_lock);
+
+       ms->mark_streaming_midi_write_started (source_lock, note_mode());
+
+       for (Evoral::Sequence<TimeType>::const_iterator i = begin(TimeType(), true); i != end(); ++i) {
+               ms->append_event_beats(source_lock, *i);
+       }
+
+       set_percussive (old_percussive);
+       ms->mark_streaming_write_completed (source_lock);
+
+       set_edited (false);
+
+       return true;
+}
+
+/** Write part or all of the model to a MidiSource (i.e. save the model).
+ * This is different from manually using read to write to a source in that
+ * note off events are written regardless of the track mode.  This is so the
+ * user can switch a recorded track (with note durations from some instrument)
+ * to percussive, save, reload, then switch it back to sustained without
+ * destroying the original note durations.
+ */
+bool
+MidiModel::write_section_to (boost::shared_ptr<MidiSource>     source,
+                             const Glib::Threads::Mutex::Lock& source_lock,
+                             TimeType                          begin_time,
+                             TimeType                          end_time,
+                             bool                              offset_events)
+{
+       ReadLock lock(read_lock());
+       MidiStateTracker mst;
+
+       const bool old_percussive = percussive();
+       set_percussive(false);
+
+       source->drop_model(source_lock);
+       source->mark_streaming_midi_write_started (source_lock, note_mode());
+
+       for (Evoral::Sequence<TimeType>::const_iterator i = begin(TimeType(), true); i != end(); ++i) {
+               if (i->time() >= begin_time && i->time() < end_time) {
+
+                       Evoral::Event<TimeType> mev (*i, true); /* copy the event */
+
+                       if (offset_events) {
+                               mev.set_time(mev.time() - begin_time);
+                       }
+
+                       if (mev.is_note_off()) {
+
+                               if (!mst.active (mev.note(), mev.channel())) {
+                                       /* the matching note-on was outside the
+                                          time range we were given, so just
+                                          ignore this note-off.
+                                       */
+                                       continue;
+                               }
+
+                               source->append_event_beats (source_lock, mev);
+                               mst.remove (mev.note(), mev.channel());
+
+                       } else if (mev.is_note_on()) {
+                               mst.add (mev.note(), mev.channel());
+                               source->append_event_beats(source_lock, mev);
+                       } else {
+                               source->append_event_beats(source_lock, mev);
+                       }
+               }
+       }
+
+       if (offset_events) {
+               end_time -= begin_time;
+       }
+       mst.resolve_notes (*source, source_lock, end_time);
+
+       set_percussive(old_percussive);
+       source->mark_streaming_write_completed(source_lock);
+
+       set_edited(false);
+
+       return true;
+}
+
+XMLNode&
+MidiModel::get_state()
+{
+       XMLNode *node = new XMLNode("MidiModel");
+       return *node;
+}
+
+Evoral::Sequence<MidiModel::TimeType>::NotePtr
+MidiModel::find_note (NotePtr other)
+{
+       Notes::iterator l = notes().lower_bound(other);
+
+       if (l != notes().end()) {
+               for (; (*l)->time() == other->time(); ++l) {
+                       /* NB: compare note contents, not note pointers.
+                          If "other" was a ptr to a note already in
+                          the model, we wouldn't be looking for it,
+                          would we now?
+                       */
+                       if (**l == *other) {
+                               return *l;
+                       }
+               }
+       }
+
+       return NotePtr();
+}
+
+Evoral::Sequence<MidiModel::TimeType>::NotePtr
+MidiModel::find_note (gint note_id)
+{
+       /* used only for looking up notes when reloading history from disk,
+          so we don't care about performance *too* much.
+       */
+
+       for (Notes::iterator l = notes().begin(); l != notes().end(); ++l) {
+               if ((*l)->id() == note_id) {
+                       return *l;
+               }
+       }
+
+       return NotePtr();
+}
+
+MidiModel::PatchChangePtr
+MidiModel::find_patch_change (Evoral::event_id_t id)
+{
+       for (PatchChanges::iterator i = patch_changes().begin(); i != patch_changes().end(); ++i) {
+               if ((*i)->id() == id) {
+                       return *i;
+               }
+       }
+
+       return PatchChangePtr ();
+}
+
+boost::shared_ptr<Evoral::Event<MidiModel::TimeType> >
+MidiModel::find_sysex (gint sysex_id)
+{
+       /* used only for looking up notes when reloading history from disk,
+          so we don't care about performance *too* much.
+       */
+
+       for (SysExes::iterator l = sysexes().begin(); l != sysexes().end(); ++l) {
+               if ((*l)->id() == sysex_id) {
+                       return *l;
+               }
+       }
+
+       return boost::shared_ptr<Evoral::Event<TimeType> > ();
+}
+
+/** Lock and invalidate the source.
+ * This should be used by commands and editing things
+ */
+MidiModel::WriteLock
+MidiModel::edit_lock()
+{
+       boost::shared_ptr<MidiSource> ms          = _midi_source.lock();
+       Glib::Threads::Mutex::Lock*   source_lock = 0;
+
+       if (ms) {
+               /* Take source lock and invalidate iterator to release its lock on model.
+                  Add currently active notes to _active_notes so we can restore them
+                  if playback resumes at the same point after the edit. */
+               source_lock = new Glib::Threads::Mutex::Lock(ms->mutex());
+               ms->invalidate(*source_lock);
+       }
+
+       return WriteLock(new WriteLockImpl(source_lock, _lock, _control_lock));
+}
+
+int
+MidiModel::resolve_overlaps_unlocked (const NotePtr note, void* arg)
+{
+       using namespace Evoral;
+
+       if (_writing || insert_merge_policy() == InsertMergeRelax) {
+               return 0;
+       }
+
+       NoteDiffCommand* cmd = static_cast<NoteDiffCommand*>(arg);
+
+       TimeType sa = note->time();
+       TimeType ea  = note->end_time();
+
+       const Pitches& p (pitches (note->channel()));
+       NotePtr search_note(new Note<TimeType>(0, TimeType(), TimeType(), note->note()));
+       set<NotePtr> to_be_deleted;
+       bool set_note_length = false;
+       bool set_note_time = false;
+       TimeType note_time = note->time();
+       TimeType note_length = note->length();
+
+       DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 checking overlaps for note %2 @ %3\n", this, (int)note->note(), note->time()));
+
+       for (Pitches::const_iterator i = p.lower_bound (search_note);
+            i != p.end() && (*i)->note() == note->note(); ++i) {
+
+               TimeType sb = (*i)->time();
+               TimeType eb = (*i)->end_time();
+               OverlapType overlap = OverlapNone;
+
+               if ((sb > sa) && (eb <= ea)) {
+                       overlap = OverlapInternal;
+               } else if ((eb > sa) && (eb <= ea)) {
+                       overlap = OverlapStart;
+               } else if ((sb > sa) && (sb < ea)) {
+                       overlap = OverlapEnd;
+               } else if ((sa >= sb) && (sa <= eb) && (ea <= eb)) {
+                       overlap = OverlapExternal;
+               } else {
+                       /* no overlap */
+                       continue;
+               }
+
+               DEBUG_TRACE (DEBUG::Sequence, string_compose (
+                                    "\toverlap is %1 for (%2,%3) vs (%4,%5)\n",
+                                    enum_2_string(overlap), sa, ea, sb, eb));
+
+               if (insert_merge_policy() == InsertMergeReject) {
+                       DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 just reject\n", this));
+                       return -1;
+               }
+
+               switch (overlap) {
+               case OverlapStart:
+                       cerr << "OverlapStart\n";
+                       /* existing note covers start of new note */
+                       switch (insert_merge_policy()) {
+                       case InsertMergeReplace:
+                               to_be_deleted.insert (*i);
+                               break;
+                       case InsertMergeTruncateExisting:
+                               if (cmd) {
+                                       cmd->change (*i, NoteDiffCommand::Length, (note->time() - (*i)->time()));
+                               }
+                               (*i)->set_length (note->time() - (*i)->time());
+                               break;
+                       case InsertMergeTruncateAddition:
+                               set_note_time = true;
+                               set_note_length = true;
+                               note_time = (*i)->time() + (*i)->length();
+                               note_length = min (note_length, (*i)->length() - ((*i)->end_time() - note->time()));
+                               break;
+                       case InsertMergeExtend:
+                               if (cmd) {
+                                       cmd->change ((*i), NoteDiffCommand::Length, note->end_time() - (*i)->time());
+                               }
+                               (*i)->set_length (note->end_time() - (*i)->time());
+                               return -1; /* do not add the new note */
+                               break;
+                       default:
+                               abort(); /*NOTREACHED*/
+                               /* stupid gcc */
+                               break;
+                       }
+                       break;
+
+               case OverlapEnd:
+                       cerr << "OverlapEnd\n";
+                       /* existing note covers end of new note */
+                       switch (insert_merge_policy()) {
+                       case InsertMergeReplace:
+                               to_be_deleted.insert (*i);
+                               break;
+
+                       case InsertMergeTruncateExisting:
+                               /* resetting the start time of the existing note
+                                  is a problem because of time ordering.
+                               */
+                               break;
+
+                       case InsertMergeTruncateAddition:
+                               set_note_length = true;
+                               note_length = min (note_length, ((*i)->time() - note->time()));
+                               break;
+
+                       case InsertMergeExtend:
+                               /* we can't reset the time of the existing note because
+                                  that will corrupt time ordering. So remove the
+                                  existing note and change the position/length
+                                  of the new note (which has not been added yet)
+                               */
+                               to_be_deleted.insert (*i);
+                               set_note_length = true;
+                               note_length = min (note_length, (*i)->end_time() - note->time());
+                               break;
+                       default:
+                               abort(); /*NOTREACHED*/
+                               /* stupid gcc */
+                               break;
+                       }
+                       break;
+
+               case OverlapExternal:
+                       cerr << "OverlapExt\n";
+                       /* existing note overlaps all the new note */
+                       switch (insert_merge_policy()) {
+                       case InsertMergeReplace:
+                               to_be_deleted.insert (*i);
+                               break;
+                       case InsertMergeTruncateExisting:
+                       case InsertMergeTruncateAddition:
+                       case InsertMergeExtend:
+                               /* cannot add in this case */
+                               return -1;
+                       default:
+                               abort(); /*NOTREACHED*/
+                               /* stupid gcc */
+                               break;
+                       }
+                       break;
+
+               case OverlapInternal:
+                       cerr << "OverlapInt\n";
+                       /* new note fully overlaps an existing note */
+                       switch (insert_merge_policy()) {
+                       case InsertMergeReplace:
+                       case InsertMergeTruncateExisting:
+                       case InsertMergeTruncateAddition:
+                       case InsertMergeExtend:
+                               /* delete the existing note, the new one will cover it */
+                               to_be_deleted.insert (*i);
+                               break;
+                       default:
+                               abort(); /*NOTREACHED*/
+                               /* stupid gcc */
+                               break;
+                       }
+                       break;
+
+               default:
+                       abort(); /*NOTREACHED*/
+                       /* stupid gcc */
+                       break;
+               }
+       }
+
+       for (set<NotePtr>::iterator i = to_be_deleted.begin(); i != to_be_deleted.end(); ++i) {
+               remove_note_unlocked (*i);
+
+               if (cmd) {
+                       cmd->side_effect_remove (*i);
+               }
+       }
+
+       if (set_note_time) {
+               if (cmd) {
+                       cmd->change (note, NoteDiffCommand::StartTime, note_time);
+               }
+               note->set_time (note_time);
+       }
+
+       if (set_note_length) {
+               if (cmd) {
+                       cmd->change (note, NoteDiffCommand::Length, note_length);
+               }
+               note->set_length (note_length);
+       }
+
+       return 0;
+}
+
+InsertMergePolicy
+MidiModel::insert_merge_policy () const
+{
+       /* XXX ultimately this should be a per-track or even per-model policy */
+       boost::shared_ptr<MidiSource> ms = _midi_source.lock ();
+       assert (ms);
+
+       return ms->session().config.get_insert_merge_policy ();
+}
+
+void
+MidiModel::set_midi_source (boost::shared_ptr<MidiSource> s)
+{
+       boost::shared_ptr<MidiSource> old = _midi_source.lock ();
+
+       if (old) {
+               Source::Lock lm(old->mutex());
+               old->invalidate (lm);
+       }
+
+       _midi_source_connections.drop_connections ();
+
+       _midi_source = s;
+
+       s->InterpolationChanged.connect_same_thread (
+               _midi_source_connections, boost::bind (&MidiModel::source_interpolation_changed, this, _1, _2)
+               );
+
+       s->AutomationStateChanged.connect_same_thread (
+               _midi_source_connections, boost::bind (&MidiModel::source_automation_state_changed, this, _1, _2)
+               );
+}
+
+/** The source has signalled that the interpolation style for a parameter has changed.  In order to
+ *  keep MidiSource and ControlList interpolation state the same, we pass this change onto the
+ *  appropriate ControlList.
+ *
+ *  The idea is that MidiSource and the MidiModel's ControlList states are kept in sync, and one
+ *  or the other is listened to by the GUI.
+ */
+void
+MidiModel::source_interpolation_changed (Evoral::Parameter p, Evoral::ControlList::InterpolationStyle s)
+{
+       Glib::Threads::Mutex::Lock lm (_control_lock);
+       control(p)->list()->set_interpolation (s);
+}
+
+/** A ControlList has signalled that its interpolation style has changed.  Again, in order to keep
+ *  MidiSource and ControlList interpolation state in sync, we pass this change onto our MidiSource.
+ */
+void
+MidiModel::control_list_interpolation_changed (Evoral::Parameter p, Evoral::ControlList::InterpolationStyle s)
+{
+       boost::shared_ptr<MidiSource> ms = _midi_source.lock ();
+       assert (ms);
+
+       ms->set_interpolation_of (p, s);
+}
+
+void
+MidiModel::source_automation_state_changed (Evoral::Parameter p, AutoState s)
+{
+       Glib::Threads::Mutex::Lock lm (_control_lock);
+       boost::shared_ptr<AutomationList> al = boost::dynamic_pointer_cast<AutomationList> (control(p)->list ());
+       al->set_automation_state (s);
+}
+
+void
+MidiModel::automation_list_automation_state_changed (Evoral::Parameter p, AutoState s)
+{
+       boost::shared_ptr<MidiSource> ms = _midi_source.lock ();
+       assert (ms);
+       ms->set_automation_state_of (p, s);
+}
+
+boost::shared_ptr<Evoral::Control>
+MidiModel::control_factory (Evoral::Parameter const & p)
+{
+       boost::shared_ptr<Evoral::Control> c = Automatable::control_factory (p);
+
+       /* Set up newly created control's lists to the appropriate interpolation and
+          automation state from our source.
+       */
+
+       boost::shared_ptr<MidiSource> ms = _midi_source.lock ();
+       assert (ms);
+
+       c->list()->set_interpolation (ms->interpolation_of (p));
+
+       boost::shared_ptr<AutomationList> al = boost::dynamic_pointer_cast<AutomationList> (c->list ());
+       assert (al);
+
+       al->set_automation_state (ms->automation_state_of (p));
+
+       return c;
+}
+
+boost::shared_ptr<const MidiSource>
+MidiModel::midi_source ()
+{
+       return _midi_source.lock ();
+}
+
+/** Moves notes, patch changes, controllers and sys-ex to insert silence at the start of the model.
+ *  Adds commands to the session's current undo stack to reflect the movements.
+ */
+void
+MidiModel::insert_silence_at_start (TimeType t)
+{
+       boost::shared_ptr<MidiSource> s = _midi_source.lock ();
+       assert (s);
+
+       /* Notes */
+
+       if (!notes().empty ()) {
+               NoteDiffCommand* c = new_note_diff_command ("insert silence");
+
+               for (Notes::const_iterator i = notes().begin(); i != notes().end(); ++i) {
+                       c->change (*i, NoteDiffCommand::StartTime, (*i)->time() + t);
+               }
+
+               apply_command_as_subcommand (s->session(), c);
+       }
+
+       /* Patch changes */
+
+       if (!patch_changes().empty ()) {
+               PatchChangeDiffCommand* c = new_patch_change_diff_command ("insert silence");
+
+               for (PatchChanges::const_iterator i = patch_changes().begin(); i != patch_changes().end(); ++i) {
+                       c->change_time (*i, (*i)->time() + t);
+               }
+
+               apply_command_as_subcommand (s->session(), c);
+       }
+
+       /* Controllers */
+
+       for (Controls::iterator i = controls().begin(); i != controls().end(); ++i) {
+               boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl> (i->second);
+               XMLNode& before = ac->alist()->get_state ();
+               i->second->list()->shift (0, t.to_double());
+               XMLNode& after = ac->alist()->get_state ();
+               s->session().add_command (new MementoCommand<AutomationList> (new MidiAutomationListBinder (s, i->first), &before, &after));
+       }
+
+       /* Sys-ex */
+
+       if (!sysexes().empty()) {
+               SysExDiffCommand* c = new_sysex_diff_command ("insert silence");
+
+               for (SysExes::iterator i = sysexes().begin(); i != sysexes().end(); ++i) {
+                       c->change (*i, (*i)->time() + t);
+               }
+
+               apply_command_as_subcommand (s->session(), c);
+       }
+
+       ContentsShifted (t.to_double());
+}
+
+void
+MidiModel::transpose (NoteDiffCommand* c, const NotePtr note_ptr, int semitones)
+{
+       int new_note = note_ptr->note() + semitones;
+
+       if (new_note < 0) {
+               new_note = 0;
+       } else if (new_note > 127) {
+               new_note = 127;
+       }
+
+       c->change (note_ptr, NoteDiffCommand::NoteNumber, (uint8_t) new_note);
+}
+
+void
+MidiModel::control_list_marked_dirty ()
+{
+       AutomatableSequence<Evoral::Beats>::control_list_marked_dirty ();
+
+       ContentsChanged (); /* EMIT SIGNAL */
+}