Fix my name :)
[ardour.git] / libs / evoral / src / Sequence.cpp
index cf0ea1ae38591fda26574f54abd994415ea6a8dc..d7ae73c0569e976b6dff9137d0bbe0ed9c53b82b 100644 (file)
@@ -1,5 +1,5 @@
 /* This file is part of Evoral.
- * Copyright (C) 2008 Dave Robillard <http://drobilla.net>
+ * Copyright (C) 2008 David Robillard <http://drobilla.net>
  * Copyright (C) 2000-2008 Paul Davis
  *
  * Evoral is free software; you can redistribute it and/or modify it under the
@@ -16,7 +16,6 @@
  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
-#define __STDC_LIMIT_MACROS 1
 #include <algorithm>
 #include <cmath>
 #include <iostream>
 using namespace std;
 using namespace PBD;
 
+/** Minimum time between MIDI outputs from a single interpolated controller,
+    expressed in beats.  This is to limit the rate at which MIDI messages
+    are generated.  It is only applied to interpolated controllers.
+
+    XXX: This is a hack.  The time should probably be expressed in
+    seconds rather than beats, and should be configurable etc. etc.
+*/
+static double const time_between_interpolated_controller_outputs = 1.0 / 256;
+
 namespace Evoral {
 
 // Read iterator (const_iterator)
@@ -56,10 +64,12 @@ Sequence<Time>::const_iterator::const_iterator()
 template<typename Time>
 Sequence<Time>::const_iterator::const_iterator(const Sequence<Time>& seq, Time t, bool force_discrete, std::set<Evoral::Parameter> const & filtered)
        : _seq(&seq)
+       , _active_patch_change_message (0)
        , _type(NIL)
        , _is_end((t == DBL_MAX) || seq.empty())
        , _note_iter(seq.notes().end())
        , _sysex_iter(seq.sysexes().end())
+       , _patch_change_iter(seq.patch_changes().end())
        , _control_iter(_control_iters.end())
        , _force_discrete (force_discrete)
 {
@@ -86,6 +96,15 @@ Sequence<Time>::const_iterator::const_iterator(const Sequence<Time>& seq, Time t
        }
        assert(_sysex_iter == seq.sysexes().end() || (*_sysex_iter)->time() >= t);
 
+       // Find first patch event at or after t
+       for (typename Sequence<Time>::PatchChanges::const_iterator i = seq.patch_changes().begin(); i != seq.patch_changes().end(); ++i) {
+               if ((*i)->time() >= t) {
+                       _patch_change_iter = i;
+                       break;
+               }
+       }
+       assert (_patch_change_iter == seq.patch_changes().end() || (*_patch_change_iter)->time() >= t);
+
        // Find first control event after t
        ControlIterator earliest_control(boost::shared_ptr<ControlList>(), DBL_MAX, 0.0);
        _control_iters.reserve(seq._controls.size());
@@ -155,6 +174,11 @@ Sequence<Time>::const_iterator::const_iterator(const Sequence<Time>& seq, Time t
                earliest_t = (*_sysex_iter)->time();
        }
 
+       if (_patch_change_iter != seq.patch_changes().end() && ((*_patch_change_iter)->time() < earliest_t || _type == NIL)) {
+               _type = PATCH_CHANGE;
+               earliest_t = (*_patch_change_iter)->time ();
+       }
+
        if (_control_iter != _control_iters.end()
                        && earliest_control.list && earliest_control.x >= t
                        && (earliest_control.x < earliest_t || _type == NIL)) {
@@ -177,6 +201,10 @@ Sequence<Time>::const_iterator::const_iterator(const Sequence<Time>& seq, Time t
                DEBUG_TRACE (DEBUG::Sequence, string_compose ("Starting at control event @ %1\n", earliest_t));
                seq.control_to_midi_event(_event, earliest_control);
                break;
+       case PATCH_CHANGE:
+               DEBUG_TRACE (DEBUG::Sequence, string_compose ("Starting at patch change event @ %1\n", earliest_t));
+               _event = boost::shared_ptr<Event<Time> > (new Event<Time> ((*_patch_change_iter)->message (_active_patch_change_message), true));
+               break;
        default:
                break;
        }
@@ -186,12 +214,14 @@ Sequence<Time>::const_iterator::const_iterator(const Sequence<Time>& seq, Time t
                _type   = NIL;
                _is_end = true;
        } else {
-               DEBUG_TRACE (DEBUG::Sequence, string_compose ("New iterator = 0x%x : 0x%x @ %f\n",
+               DEBUG_TRACE (DEBUG::Sequence, string_compose ("New iterator = 0x%1 : 0x%2 @ %3\n",
                                                               (int)_event->event_type(),
                                                               (int)((MIDIEvent<Time>*)_event.get())->type(),
                                                               _event->time()));
+               
                assert(midi_event_is_valid(_event->buffer(), _event->size()));
        }
+
 }
 
 template<typename Time>
@@ -211,6 +241,8 @@ Sequence<Time>::const_iterator::invalidate()
        if (_seq) {
                _note_iter = _seq->notes().end();
                _sysex_iter = _seq->sysexes().end();
+               _patch_change_iter = _seq->patch_changes().end();
+               _active_patch_change_message = 0;
        }
        _control_iter = _control_iters.end();
        _lock.reset();
@@ -252,10 +284,14 @@ Sequence<Time>::const_iterator::operator++()
                break;
        case CONTROL:
                // Increment current controller iterator
-               if (_force_discrete) {
-                       ret = _control_iter->list->rt_safe_earliest_event_discrete_unlocked (_control_iter->x, x, y, false);
+               if (_force_discrete || _control_iter->list->interpolation() == ControlList::Discrete) {
+                       ret = _control_iter->list->rt_safe_earliest_event_discrete_unlocked (
+                               _control_iter->x, x, y, false
+                               );
                } else {
-                       ret = _control_iter->list->rt_safe_earliest_event_unlocked (_control_iter->x, x, y, false);
+                       ret = _control_iter->list->rt_safe_earliest_event_linear_unlocked (
+                               _control_iter->x + time_between_interpolated_controller_outputs, x, y, false
+                               );
                }
                assert(!ret || x > _control_iter->x);
                if (ret) {
@@ -279,6 +315,13 @@ Sequence<Time>::const_iterator::operator++()
        case SYSEX:
                ++_sysex_iter;
                break;
+       case PATCH_CHANGE:
+               ++_active_patch_change_message;
+               if (_active_patch_change_message == (*_patch_change_iter)->messages()) {
+                       ++_patch_change_iter;
+                       _active_patch_change_message = 0;
+               }
+               break;
        default:
                assert(false);
        }
@@ -317,6 +360,14 @@ Sequence<Time>::const_iterator::operator++()
                }
        }
 
+       // Use the next earliest patch change iff it's earlier than the SysEx
+       if (_patch_change_iter != _seq->patch_changes().end()) {
+               if (_type == NIL || (*_patch_change_iter)->time() < earliest_t) {
+                       _type = PATCH_CHANGE;
+                       earliest_t = (*_patch_change_iter)->time();
+               }
+       }
+
        // Set event to reflect new position
        switch (_type) {
        case NOTE_ON:
@@ -338,6 +389,10 @@ Sequence<Time>::const_iterator::operator++()
                 DEBUG_TRACE(DEBUG::Sequence, "iterator = sysex\n");
                *_event = *(*_sysex_iter);
                break;
+       case PATCH_CHANGE:
+               DEBUG_TRACE(DEBUG::Sequence, "iterator = patch change\n");
+               *_event = (*_patch_change_iter)->message (_active_patch_change_message);
+               break;
        default:
                 DEBUG_TRACE(DEBUG::Sequence, "iterator = end\n");
                _is_end = true;
@@ -374,8 +429,10 @@ Sequence<Time>::const_iterator::operator=(const const_iterator& other)
        _is_end        = other._is_end;
        _note_iter     = other._note_iter;
        _sysex_iter    = other._sysex_iter;
+       _patch_change_iter = other._patch_change_iter;
        _control_iters = other._control_iters;
        _force_discrete = other._force_discrete;
+       _active_patch_change_message = other._active_patch_change_message;
 
        if (other._lock)
                _lock = _seq->read_lock();
@@ -409,6 +466,10 @@ Sequence<Time>::Sequence(const TypeMap& type_map)
        DEBUG_TRACE (DEBUG::Sequence, string_compose ("Sequence constructed: %1\n", this));
        assert(_end_iter._is_end);
        assert( ! _end_iter._lock);
+
+       for (int i = 0; i < 16; ++i) {
+               _bank[i] = 0;
+       }
 }
 
 template<typename Time>
@@ -434,6 +495,15 @@ Sequence<Time>::Sequence(const Sequence<Time>& other)
                 _sysexes.push_back (n);
         }
 
+       for (typename PatchChanges::const_iterator i = other._patch_changes.begin(); i != other._patch_changes.end(); ++i) {
+               PatchChangePtr n (new PatchChange<Time> (**i));
+               _patch_changes.insert (n);
+       }
+
+       for (int i = 0; i < 16; ++i) {
+               _bank[i] = other._bank[i];
+       }
+
        DEBUG_TRACE (DEBUG::Sequence, string_compose ("Sequence copied: %1\n", this));
        assert(_end_iter._is_end);
        assert(! _end_iter._lock);
@@ -568,6 +638,7 @@ Sequence<Time>::end_write (bool delete_stuck)
                 for (typename Notes::iterator n = _notes.begin(); n != _notes.end() ;) {
                         typename Notes::iterator next = n;
                         ++next;
+                       
                         if ((*n)->length() == 0) {
                                 cerr << "WARNING: Stuck note lost: " << (*n)->note() << endl;
                                 _notes.erase(n);
@@ -599,6 +670,7 @@ Sequence<Time>::add_note_unlocked(const NotePtr note, void* arg)
        DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 add note %2 @ %3\n", this, (int)note->note(), note->time()));
 
         if (resolve_overlaps_unlocked (note, arg)) {
+                DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 DISALLOWED: note %2 @ %3\n", this, (int)note->note(), note->time()));
                 return false;
        }
 
@@ -629,15 +701,20 @@ Sequence<Time>::remove_note_unlocked(const constNotePtr note)
 
        DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 remove note %2 @ %3\n", this, (int)note->note(), note->time()));
 
-       for (typename Sequence<Time>::Notes::iterator i = note_lower_bound(note->time()); 
-             i != _notes.end() && (*i)->time() == note->time(); ++i) {
+       typename Sequence<Time>::Notes::iterator i = note_lower_bound(note->time());
+       while (i != _notes.end() && (*i)->time() == note->time()) {
+
+               typename Sequence<Time>::Notes::iterator tmp = i;
+               ++tmp;
 
                if (*i == note) {
+
+                       NotePtr n = *i;
                         
                         DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1\terasing note %2 @ %3\n", this, (int)(*i)->note(), (*i)->time()));
                        _notes.erase (i);
 
-                        if ((*i)->note() == _lowest_note || (*i)->note() == _highest_note) {
+                        if (n->note() == _lowest_note || n->note() == _highest_note) {
 
                                 _lowest_note = 127;
                                 _highest_note = 0;
@@ -652,18 +729,25 @@ Sequence<Time>::remove_note_unlocked(const constNotePtr note)
                         
                         erased = true;
                 }
+
+               i = tmp;
        }
 
         Pitches& p (pitches (note->channel()));
         
         NotePtr search_note(new Note<Time>(0, 0, 0, note->note(), 0));
 
-        for (typename Pitches::iterator i = p.lower_bound (search_note); 
-             i != p.end() && (*i)->note() == note->note(); ++i) {
-                if (*i == note) {
-                        DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1\terasing pitch %2 @ %3\n", this, (int)(*i)->note(), (*i)->time()));
-                        p.erase (i);
+        typename Pitches::iterator j = p.lower_bound (search_note);
+       while (j != p.end() && (*j)->note() == note->note()) {
+               typename Pitches::iterator tmp = j;
+               ++tmp;
+               
+                if (*j == note) {
+                        DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1\terasing pitch %2 @ %3\n", this, (int)(*j)->note(), (*j)->time()));
+                        p.erase (j);
                 }
+
+               j = tmp;
         }
         
         if (!erased) {
@@ -671,6 +755,34 @@ Sequence<Time>::remove_note_unlocked(const constNotePtr note)
         }
 }
 
+template<typename Time>
+void
+Sequence<Time>::add_patch_change_unlocked (PatchChangePtr p)
+{
+       _patch_changes.insert (p);
+       if (p->id () < 0) {
+               p->set_id (Evoral::next_event_id ());
+       }
+}
+
+template<typename Time>
+void
+Sequence<Time>::remove_patch_change_unlocked (const constPatchChangePtr p)
+{
+       typename Sequence<Time>::PatchChanges::iterator i = patch_change_lower_bound (p->time ());
+       while (i != _patch_changes.end() && (*i)->time() == p->time()) {
+
+               typename Sequence<Time>::PatchChanges::iterator tmp = i;
+               ++tmp;
+
+               if (*i == p) {
+                       _patch_changes.erase (i);
+               }
+
+               i = tmp;
+       }
+}
+
 /** Append \a ev to model.  NOT realtime safe.
  *
  * The timestamp of event is expected to be relative to
@@ -693,7 +805,6 @@ Sequence<Time>::append(const Event<Time>& event, event_id_t evid)
                 return;
         }
 
-
         if (ev.is_note_on()) {
                 NotePtr note(new Note<Time>(ev.channel(), ev.time(), 0, ev.note(), ev.velocity()));
                 append_note_on_unlocked (note, evid);
@@ -705,14 +816,22 @@ Sequence<Time>::append(const Event<Time>& event, event_id_t evid)
                 append_note_off_unlocked (note);
         } else if (ev.is_sysex()) {
                 append_sysex_unlocked(ev, evid);
+       } else if (ev.is_cc() && (ev.cc_number() == MIDI_CTL_MSB_BANK || ev.cc_number() == MIDI_CTL_LSB_BANK)) {
+               /* note bank numbers in our _bank[] array, so that we can write an event when the program change arrives */
+               if (ev.cc_number() == MIDI_CTL_MSB_BANK) {
+                       _bank[ev.channel()] &= (0x7f << 7);
+                       _bank[ev.channel()] |= ev.cc_value() << 7;
+               } else {
+                       _bank[ev.channel()] &= 0x7f;
+                       _bank[ev.channel()] |= ev.cc_value();
+               }
         } else if (ev.is_cc()) {
                 append_control_unlocked(
                         Evoral::MIDI::ContinuousController(ev.event_type(), ev.channel(), ev.cc_number()),
                         ev.time(), ev.cc_value(), evid);
         } else if (ev.is_pgm_change()) {
-                append_control_unlocked(
-                        Evoral::MIDI::ProgramChange(ev.event_type(), ev.channel()),
-                        ev.time(), ev.pgm_number(), evid);
+               /* write a patch change with this program change and any previously set-up bank number */
+               append_patch_change_unlocked (PatchChange<Time> (ev.time(), ev.channel(), ev.pgm_number(), _bank[ev.channel()]), evid);
         } else if (ev.is_pitch_bender()) {
                 append_control_unlocked(
                         Evoral::MIDI::PitchBender(ev.event_type(), ev.channel()),
@@ -794,7 +913,11 @@ Sequence<Time>::append_note_off_unlocked (NotePtr note)
 
         /* XXX use _overlap_pitch_resolution to determine FIFO/LIFO ... */
 
-        for (typename WriteNotes::iterator n = _write_notes[note->channel()].begin(); n != _write_notes[note->channel()].end(); ++n) {
+        for (typename WriteNotes::iterator n = _write_notes[note->channel()].begin(); n != _write_notes[note->channel()].end(); ) {
+
+               typename WriteNotes::iterator tmp = n;
+               ++tmp;
+               
                 NotePtr nn = *n;
                 if (note->note() == nn->note() && nn->channel() == note->channel()) {
                         assert(note->time() >= nn->time());
@@ -807,6 +930,8 @@ Sequence<Time>::append_note_off_unlocked (NotePtr note)
                         resolved = true;
                         break;
                 }
+
+               n = tmp;
         }
 
         if (!resolved) {
@@ -817,18 +942,18 @@ Sequence<Time>::append_note_off_unlocked (NotePtr note)
 
 template<typename Time>
 void
-Sequence<Time>::append_control_unlocked(const Parameter& param, Time time, double value, event_id_t evid)
+Sequence<Time>::append_control_unlocked(const Parameter& param, Time time, double value, event_id_t /* evid */)
 {
         DEBUG_TRACE (DEBUG::Sequence, string_compose ("%1 %2 @ %3\t=\t%4 # controls: %5\n",
                                                       this, _type_map.to_symbol(param), time, value, _controls.size()));
         boost::shared_ptr<Control> c = control(param, true);
-        c->list()->rt_add(time, value);
+        c->list()->add (time, value);
         /* XXX control events should use IDs */
 }
 
 template<typename Time>
 void
-Sequence<Time>::append_sysex_unlocked(const MIDIEvent<Time>& ev, event_id_t evid)
+Sequence<Time>::append_sysex_unlocked(const MIDIEvent<Time>& ev, event_id_t /* evid */)
 {
 #ifdef DEBUG_SEQUENCE
         cerr << this << " SysEx @ " << ev.time() << " \t= \t [ " << hex;
@@ -842,6 +967,19 @@ Sequence<Time>::append_sysex_unlocked(const MIDIEvent<Time>& ev, event_id_t evid
         _sysexes.push_back(event);
 }
 
+template<typename Time>
+void
+Sequence<Time>::append_patch_change_unlocked (const PatchChange<Time>& ev, event_id_t id)
+{
+       PatchChangePtr p (new PatchChange<Time> (ev));
+       
+       if (p->id() < 0) {
+               p->set_id (id);
+       }
+       
+       _patch_changes.insert (p);
+}
+
 template<typename Time>
 bool
 Sequence<Time>::contains (const NotePtr& note) const
@@ -925,6 +1063,17 @@ Sequence<Time>::note_lower_bound (Time t) const
         return i;
 }
 
+/** Return the earliest patch change with time >= t */
+template<typename Time>
+typename Sequence<Time>::PatchChanges::const_iterator
+Sequence<Time>::patch_change_lower_bound (Time t) const
+{
+        PatchChangePtr search (new PatchChange<Time> (t, 0, 0, 0));
+        typename Sequence<Time>::PatchChanges::const_iterator i = _patch_changes.lower_bound (search);
+        assert (i == _patch_changes.end() || (*i)->time() >= t);
+        return i;
+}
+
 template<typename Time>
 void
 Sequence<Time>::get_notes (Notes& n, NoteOperator op, uint8_t val, int chan_mask) const