Fix broken whitespace. I'd apologize for the compile times if it was my fault :D
[ardour.git] / libs / ardour / midi_model.cc
index e1a955d43c833d18cf9462fbeb54dbe8822abd39..b6500563ba46604a376bd43548cf42baba6efb5a 100644 (file)
@@ -25,6 +25,7 @@
 #include <stdint.h>
 #include "pbd/error.h"
 #include "pbd/enumwriter.h"
+#include "pbd/compose.h"
 #include "midi++/events.h"
 
 #include "ardour/midi_model.h"
@@ -35,6 +36,8 @@
 #include "ardour/session.h"
 #include "ardour/midi_automation_list_binder.h"
 
+#include "i18n.h"
+
 using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
@@ -56,7 +59,7 @@ MidiModel::new_note_diff_command (const string name)
 {
        boost::shared_ptr<MidiSource> ms = _midi_source.lock ();
        assert (ms);
-       
+
        return new NoteDiffCommand (ms->model(), name);
 }
 
@@ -66,7 +69,7 @@ MidiModel::new_sysex_diff_command (const string name)
 {
        boost::shared_ptr<MidiSource> ms = _midi_source.lock ();
        assert (ms);
-       
+
        return new SysExDiffCommand (ms->model(), name);
 }
 
@@ -76,7 +79,7 @@ MidiModel::new_patch_change_diff_command (const string name)
 {
        boost::shared_ptr<MidiSource> ms = _midi_source.lock ();
        assert (ms);
-       
+
        return new PatchChangeDiffCommand (ms->model(), name);
 }
 
@@ -162,7 +165,7 @@ MidiModel::NoteDiffCommand::change (const NotePtr note, Property prop,
                                     uint8_t new_value)
 {
        assert (note);
-       
+
        NoteChange change;
 
        switch (prop) {
@@ -208,7 +211,7 @@ MidiModel::NoteDiffCommand::change (const NotePtr note, Property prop,
                                     TimeType new_time)
 {
        assert (note);
-       
+
        NoteChange change;
 
        switch (prop) {
@@ -295,7 +298,6 @@ MidiModel::NoteDiffCommand::operator() ()
                                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_time);
                                break;
@@ -322,7 +324,6 @@ MidiModel::NoteDiffCommand::operator() ()
                        }
                }
 
-
                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)) {
@@ -330,23 +331,9 @@ MidiModel::NoteDiffCommand::operator() ()
                                *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.  It is an un-note.
+                                  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.
                                */
-
-                               /* We didn't change it... */
-                               for (ChangeList::iterator j = _changes.begin(); j != _changes.end(); ) {
-
-                                       ChangeList::iterator k = j;
-                                       ++k;
-                                       
-                                       if (*i == j->note) {
-                                               _changes.erase (j);
-                                       }
-
-                                       j = k;
-                               }
-
-                               /* ...in fact, we removed it */
                                _removed_notes.push_back (*i);
                        }
                }
@@ -372,9 +359,12 @@ MidiModel::NoteDiffCommand::undo ()
                        _model->remove_note_unlocked(*i);
                }
 
-               for (NoteList::iterator i = _removed_notes.begin(); i != _removed_notes.end(); ++i) {
-                       _model->add_note_unlocked(*i);
-               }
+               /* 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.
+               */
 
                /* notes we modify in a way that requires remove-then-add to maintain ordering */
                set<NotePtr> temporary_removals;
@@ -382,36 +372,70 @@ MidiModel::NoteDiffCommand::undo ()
                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()) {
+                               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);
                                break;
-                       case Velocity:
-                               i->note->set_velocity (i->old_value);
-                               break;
+
                        case StartTime:
-                               if (temporary_removals.find (i->note) == temporary_removals.end()) {
+                               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_time);
                                break;
-                       case Length:
-                               i->note->set_length (i->old_time);
-                               break;
+
                        case Channel:
-                               if (temporary_removals.find (i->note) == temporary_removals.end()) {
+                               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);
                                break;
+
+                               /* no remove-then-add required for these properties, since we do not index them
+                                */
+
+                       case Velocity:
+                               i->note->set_velocity (i->old_value);
+                               break;
+
+                       case Length:
+                               i->note->set_length (i->old_time);
+                               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);
                }
@@ -701,29 +725,29 @@ MidiModel::NoteDiffCommand::get_state ()
        diff_command->add_property("midi-source", _model->midi_source()->id().to_s());
 
        XMLNode* changes = diff_command->add_child(DIFF_NOTES_ELEMENT);
-       for_each(_changes.begin(), _changes.end(), 
+       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(), 
+       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* removed_notes = diff_command->add_child(REMOVED_NOTES_ELEMENT);
-       for_each(_removed_notes.begin(), _removed_notes.end(), 
+       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)));
 
-       /* if this command had side-effects, store that state too 
+       /* if this command had side-effects, store that state too
         */
 
        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(), 
+               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)));
@@ -896,7 +920,7 @@ MidiModel::SysExDiffCommand::get_state ()
        diff_command->add_property ("midi-source", _model->midi_source()->id().to_s());
 
        XMLNode* changes = diff_command->add_child(DIFF_SYSEXES_ELEMENT);
-       for_each (_changes.begin(), _changes.end(), 
+       for_each (_changes.begin(), _changes.end(),
                  boost::bind (
                          boost::bind (&XMLNode::add_child_nocopy, changes, _1),
                          boost::bind (&SysExDiffCommand::marshal_change, this, _1)));
@@ -973,7 +997,7 @@ MidiModel::PatchChangeDiffCommand::change_bank (PatchChangePtr patch, int bank)
        c.patch = patch;
        c.old_bank = patch->bank ();
        c.new_bank = bank;
-       
+
        _changes.push_back (c);
 }
 
@@ -982,7 +1006,7 @@ 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);
                }
@@ -990,7 +1014,7 @@ MidiModel::PatchChangeDiffCommand::operator() ()
                for (list<PatchChangePtr>::iterator i = _removed.begin(); i != _removed.end(); ++i) {
                        _model->remove_patch_change_unlocked (*i);
                }
-               
+
                set<PatchChangePtr> temporary_removals;
 
                for (ChangeList::iterator i = _changes.begin(); i != _changes.end(); ++i) {
@@ -1038,7 +1062,7 @@ MidiModel::PatchChangeDiffCommand::undo ()
                for (list<PatchChangePtr>::iterator i = _removed.begin(); i != _removed.end(); ++i) {
                        _model->add_patch_change_unlocked (*i);
                }
-               
+
                set<PatchChangePtr> temporary_removals;
 
                for (ChangeList::iterator i = _changes.begin(); i != _changes.end(); ++i) {
@@ -1068,7 +1092,7 @@ MidiModel::PatchChangeDiffCommand::undo ()
                for (set<PatchChangePtr>::iterator i = temporary_removals.begin(); i != temporary_removals.end(); ++i) {
                        _model->add_patch_change_unlocked (*i);
                }
-               
+
        }
 
        _model->ContentsChanged (); /* EMIT SIGNAL */
@@ -1155,7 +1179,7 @@ MidiModel::PatchChangeDiffCommand::marshal_change (const Change& c)
                s << c.patch->id ();
                n->add_property ("id", s.str ());
        }
-       
+
        return *n;
 }
 
@@ -1173,7 +1197,7 @@ MidiModel::PatchChangeDiffCommand::unmarshal_patch_change (XMLNode* n)
                istringstream s (prop->value());
                s >> id;
        }
-       
+
        if ((prop = n->property ("time")) != 0) {
                istringstream s (prop->value ());
                s >> time;
@@ -1212,7 +1236,7 @@ MidiModel::PatchChangeDiffCommand::unmarshal_change (XMLNode* n)
        prop = n->property ("id");
        assert (prop);
        Evoral::event_id_t const id = atoi (prop->value().c_str());
-       
+
        prop = n->property ("old");
        assert (prop);
        {
@@ -1287,7 +1311,7 @@ MidiModel::PatchChangeDiffCommand::get_state ()
        diff_command->add_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(), 
+       for_each (_added.begin(), _added.end(),
                  boost::bind (
                          boost::bind (&XMLNode::add_child_nocopy, added, _1),
                          boost::bind (&PatchChangeDiffCommand::marshal_patch_change, this, _1)
@@ -1295,13 +1319,13 @@ MidiModel::PatchChangeDiffCommand::get_state ()
                );
 
        XMLNode* removed = diff_command->add_child (REMOVED_PATCH_CHANGES_ELEMENT);
-       for_each (_removed.begin(), _removed.end(), 
+       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 (
@@ -1333,7 +1357,7 @@ MidiModel::write_to (boost::shared_ptr<MidiSource> source)
 
        boost::shared_ptr<MidiSource> ms = _midi_source.lock ();
        assert (ms);
-       
+
        source->drop_model();
        source->mark_streaming_midi_write_started (note_mode());
 
@@ -1364,7 +1388,7 @@ MidiModel::sync_to_source ()
 
        boost::shared_ptr<MidiSource> ms = _midi_source.lock ();
        assert (ms);
-       
+
        ms->mark_streaming_midi_write_started (note_mode());
 
        for (Evoral::Sequence<TimeType>::const_iterator i = begin(0, true); i != end(); ++i) {
@@ -1398,7 +1422,7 @@ MidiModel::write_section_to (boost::shared_ptr<MidiSource> source, Evoral::Music
 
        boost::shared_ptr<MidiSource> ms = _midi_source.lock ();
        assert (ms);
-       
+
        source->drop_model();
        source->mark_streaming_midi_write_started (note_mode());
 
@@ -1407,7 +1431,7 @@ MidiModel::write_section_to (boost::shared_ptr<MidiSource> source, Evoral::Music
 
                if (ev.time() >= begin_time && ev.time() < end_time) {
 
-                       const Evoral::MIDIEvent<Evoral::MusicalTime>* mev = 
+                       const Evoral::MIDIEvent<Evoral::MusicalTime>* mev =
                                static_cast<const Evoral::MIDIEvent<Evoral::MusicalTime>* > (&ev);
 
                        if (!mev) {
@@ -1585,8 +1609,8 @@ MidiModel::resolve_overlaps_unlocked (const NotePtr note, void* arg)
        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); 
+
+       for (Pitches::const_iterator i = p.lower_bound (search_note);
             i != p.end() && (*i)->note() == note->note(); ++i) {
 
                TimeType sb = (*i)->time();
@@ -1638,7 +1662,7 @@ MidiModel::resolve_overlaps_unlocked (const NotePtr note, void* arg)
                        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;
@@ -1740,14 +1764,14 @@ MidiModel::resolve_overlaps_unlocked (const NotePtr note, void* arg)
        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);
        }
 
@@ -1755,7 +1779,7 @@ MidiModel::resolve_overlaps_unlocked (const NotePtr note, void* arg)
 }
 
 InsertMergePolicy
-MidiModel::insert_merge_policy () const 
+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 ();
@@ -1768,7 +1792,7 @@ void
 MidiModel::set_midi_source (boost::shared_ptr<MidiSource> s)
 {
        boost::shared_ptr<MidiSource> old = _midi_source.lock ();
-       
+
        if (old) {
                old->invalidate ();
        }
@@ -1864,16 +1888,16 @@ 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);
        }
 
@@ -1912,20 +1936,20 @@ void
 MidiModel::transpose (TimeType from, TimeType to, int semitones)
 {
        boost::shared_ptr<const MidiSource> s = midi_source ();
-       
+
        NoteDiffCommand* c = new_note_diff_command (_("transpose"));
-       
+
        for (Notes::iterator i = notes().begin(); i != notes().end(); ++i) {
 
                if ((*i)->time() >= to) {
-                       
+
                        /* finished */
                        break;
-                       
+
                } else if ((*i)->time() >= from) {
 
                        int new_note = (*i)->note() + semitones;
-                       
+
                        if (new_note < 0) {
                                new_note = 0;
                        } else if (new_note > 127) {
@@ -1933,7 +1957,7 @@ MidiModel::transpose (TimeType from, TimeType to, int semitones)
                        }
 
                        c->change (*i, NoteDiffCommand::NoteNumber, (uint8_t) new_note);
-                       
+
                }
        }