a grab bag of changes correcting and improving the way MIDI note on/off tracking...
[ardour.git] / libs / ardour / midi_ring_buffer.cc
index b25154fefb3d088bed3884893f416ba808457509..4ad563eec9e9803dec3283ad4e5fbcc185c1830f 100644 (file)
@@ -17,6 +17,7 @@
 */
 
 #include "pbd/compose.h"
+#include "pbd/error.h"
 
 #include "ardour/debug.h"
 #include "ardour/midi_ring_buffer.h"
@@ -34,7 +35,7 @@ using namespace PBD;
  */
 template<typename T>
 size_t
-MidiRingBuffer<T>::read(MidiBuffer& dst, framepos_t start, framepos_t end, framecnt_t offset)
+MidiRingBuffer<T>::read(MidiBuffer& dst, framepos_t start, framepos_t end, framecnt_t offset, bool stop_on_overflow_in_dst)
 {
        if (this->read_space() == 0) {
                return 0;
@@ -47,8 +48,8 @@ MidiRingBuffer<T>::read(MidiBuffer& dst, framepos_t start, framepos_t end, frame
        /* If we see the end of a loop during this read, we must write the events after it
           to the MidiBuffer with adjusted times.  The situation is as follows:
 
-           session frames----------------------------->
-          
+          session frames----------------------------->
+
                     |                            |                    |
                start_of_loop                   start              end_of_loop
 
@@ -74,9 +75,22 @@ MidiRingBuffer<T>::read(MidiBuffer& dst, framepos_t start, framepos_t end, frame
 
        size_t count = 0;
 
-       while (this->read_space() >= sizeof(T) + sizeof(Evoral::EventType) + sizeof(uint32_t)) {
+       const size_t prefix_size = sizeof(T) + sizeof(Evoral::EventType) + sizeof(uint32_t);
+
+       while (this->read_space() >= prefix_size) {
+
+               uint8_t peekbuf[prefix_size];
+               bool success;
 
-               this->full_peek(sizeof(T), (uint8_t*)&ev_time);
+               success = this->peek (peekbuf, prefix_size);
+               /* this cannot fail, because we've already verified that there
+                  is prefix_space to read
+               */
+               assert (success);
+
+               ev_time = *((T*) peekbuf);
+               ev_type = *((Evoral::EventType*)(peekbuf + sizeof (T)));
+               ev_size = *((uint32_t*)(peekbuf + sizeof(T) + sizeof (Evoral::EventType)));
 
                if (ev_time + loop_offset >= end) {
                        DEBUG_TRACE (DEBUG::MidiDiskstreamIO, string_compose ("MRB event @ %1 past end @ %2\n", ev_time, end));
@@ -88,48 +102,55 @@ MidiRingBuffer<T>::read(MidiBuffer& dst, framepos_t start, framepos_t end, frame
                        DEBUG_TRACE (DEBUG::MidiDiskstreamIO, string_compose ("MRB event @ %1 in range %2 .. %3\n", ev_time, start, end));
                }
 
-               bool success = read_prefix(&ev_time, &ev_type, &ev_size);
-               if (!success) {
-                       cerr << "WARNING: error reading event prefix from MIDI ring" << endl;
-                       continue;
-               }
+               assert(ev_time >= start);
+
+               ev_time -= start;
+               ev_time += offset;
 
-               // This event marks a loop end (i.e. the next event's timestamp will be non-monotonic)
+               // This event marks a loop end (i.e. the next event's timestamp
+               // will be non-monotonic). Don't write it into the buffer - the
+               // significance of this event ends here.
+               
                if (ev_type == LoopEventType) {
                        assert (ev_size == sizeof (framepos_t));
                        framepos_t loop_start;
                        read_contents (ev_size, (uint8_t *) &loop_start);
-
                        loop_offset = ev_time - loop_start;
+                       _tracker.resolve_notes (dst, ev_time);
                        continue;
                }
 
+               /* we're good to go ahead and read the data now but since we
+                * have the prefix data already, just skip over that
+                */
+               this->increment_read_ptr (prefix_size);
                ev_time += loop_offset;
 
                uint8_t status;
-               success = this->full_peek(sizeof(uint8_t), &status);
+               success = this->peek (&status, sizeof(uint8_t));
                assert(success); // If this failed, buffer is corrupt, all hope is lost
 
                // Ignore event if it doesn't match channel filter
                if (is_channel_event(status) && get_channel_mode() == FilterChannels) {
                        const uint8_t channel = status & 0x0F;
                        if (!(get_channel_mask() & (1L << channel))) {
-                               // cerr << "MRB skipping event due to channel mask" << endl;
-                               this->skip(ev_size); // Advance read pointer to next event
+                               DEBUG_TRACE (DEBUG::MidiDiskstreamIO, string_compose ("MRB skipping event (%3 bytes) due to channel mask (mask = %1 chn = %2)\n",
+                                                                                     get_channel_mask(), (int) channel, ev_size));
+                               this->increment_read_ptr (ev_size); // Advance read pointer to next event
                                continue;
                        }
                }
 
-               assert(ev_time >= start);
-               
-               ev_time -= start;
-               ev_time += offset;
-
-               // write the timestamp to address (write_loc - 1)
-               uint8_t* write_loc = dst.reserve(ev_time, ev_size);
-               if (write_loc == NULL) {
-                       cerr << "MRB: Unable to reserve space in buffer, event skipped";
-                       this->skip (ev_size); // Advance read pointer to next event
+               /* lets see if we are going to be able to write this event into dst.
+                */
+               uint8_t* write_loc = dst.reserve (ev_time, ev_size);
+               if (write_loc == 0) {
+                       if (stop_on_overflow_in_dst) {
+                               DEBUG_TRACE (DEBUG::MidiDiskstreamIO, string_compose ("MidiRingBuffer: overflow in destination MIDI buffer, stopped after %1 events\n", count));
+                               break;
+                       }
+                       error << "MRB: Unable to reserve space in buffer, event skipped" << endmsg;
+                       this->increment_read_ptr (ev_size); // Advance read pointer to next event
                        continue;
                }
 
@@ -137,19 +158,28 @@ MidiRingBuffer<T>::read(MidiBuffer& dst, framepos_t start, framepos_t end, frame
                success = read_contents (ev_size, write_loc);
 
 #ifndef NDEBUG
-                DEBUG_STR_DECL(a);
-                DEBUG_STR_APPEND(a, string_compose ("wrote MidiEvent to Buffer (time=%1, start=%2 offset=%3)", ev_time, start, offset));
-               for (size_t i=0; i < ev_size; ++i) {
-                       DEBUG_STR_APPEND(a,hex);
-                       DEBUG_STR_APPEND(a,"0x");
-                       DEBUG_STR_APPEND(a,(int)write_loc[i]);
-                        DEBUG_STR_APPEND(a,' ');
+               if (DEBUG::MidiDiskstreamIO && PBD::debug_bits) {
+                       DEBUG_STR_DECL(a);
+                       DEBUG_STR_APPEND(a, string_compose ("wrote MidiEvent to Buffer (time=%1, start=%2 offset=%3)", ev_time, start, offset));
+                       for (size_t i=0; i < ev_size; ++i) {
+                               DEBUG_STR_APPEND(a,hex);
+                               DEBUG_STR_APPEND(a,"0x");
+                               DEBUG_STR_APPEND(a,(int)write_loc[i]);
+                               DEBUG_STR_APPEND(a,' ');
+                       }
+                       DEBUG_STR_APPEND(a,'\n');
+                       DEBUG_TRACE (DEBUG::MidiDiskstreamIO, DEBUG_STR(a).str());
                }
-                DEBUG_STR_APPEND(a,'\n');
-                DEBUG_TRACE (DEBUG::MidiDiskstreamIO, DEBUG_STR(a).str());
 #endif
 
                if (success) {
+
+                       if (is_note_on(write_loc[0]) ) {
+                               _tracker.add (write_loc[1], write_loc[0] & 0xf);
+                       } else if (is_note_off(write_loc[0])) {
+                               _tracker.remove (write_loc[1], write_loc[0] & 0xf);
+                       }
+                       
                        if (is_channel_event(status) && get_channel_mode() == ForceChannel) {
                                write_loc[0] = (write_loc[0] & 0xF0) | (get_channel_mask() & 0x0F);
                        }
@@ -161,6 +191,7 @@ MidiRingBuffer<T>::read(MidiBuffer& dst, framepos_t start, framepos_t end, frame
 
        return count;
 }
+
 template<typename T>
 void
 MidiRingBuffer<T>::dump(ostream& str)
@@ -175,70 +206,76 @@ MidiRingBuffer<T>::dump(ostream& str)
        T                 ev_time;
        Evoral::EventType ev_type;
        uint32_t          ev_size;
-       size_t read_ptr = g_atomic_int_get (&this->_read_ptr);
 
-       str << "Dump @ " << read_ptr << endl;
+       RingBufferNPT<uint8_t>::rw_vector vec;
+       RingBufferNPT<uint8_t>::get_read_vector (&vec);
 
-       while (1) {
-               uint8_t* wp;
-               uint8_t* data;
-               size_t write_ptr;
+       if (vec.len[0] == 0) {
+               return;
+       }
 
-#define space(r,w) ((w > r) ? (w - r) : ((w - r + this->_size) % this->_size))
+       str << this << ": Dump size = " << vec.len[0] + vec.len[1]
+           << " r@ " << RingBufferNPT<uint8_t>::get_read_ptr()
+           << " w@" << RingBufferNPT<uint8_t>::get_write_ptr() << endl;
 
-               write_ptr  = g_atomic_int_get (&this->_write_ptr);
-               if (space (read_ptr, write_ptr) < sizeof (T)) {
-                       break;
-               }
 
-               wp = &this->_buf[read_ptr];
-               memcpy (&ev_time, wp, sizeof (T));
-               read_ptr = (read_ptr + sizeof (T)) % this->_size;
-               str << "time " << ev_time;
+       uint8_t *buf = new uint8_t[vec.len[0] + vec.len[1]];
+       memcpy (buf, vec.buf[0], vec.len[0]);
+
+       if (vec.len[1]) {
+               memcpy (buf+vec.len[1], vec.buf[1], vec.len[1]);
+       }
+
+       uint8_t* data = buf;
+       const uint8_t* end = buf + vec.len[0] + vec.len[1];
+
+       while (data < end) {
 
-               write_ptr  = g_atomic_int_get (&this->_write_ptr);
-               if (space (read_ptr, write_ptr) < sizeof (ev_type)) {
+               memcpy (&ev_time, data, sizeof (T));
+               data += sizeof (T);
+               str << "\ttime " << ev_time;
+
+               if (data >= end) {
+                       str << "(incomplete)\n ";
                        break;
                }
 
-               wp = &this->_buf[read_ptr];
-               memcpy (&ev_type, wp, sizeof (ev_type));
-               read_ptr = (read_ptr + sizeof (ev_type)) % this->_size;
+               memcpy (&ev_type, data, sizeof (ev_type));
+               data += sizeof (ev_type);
                str << " type " << ev_type;
 
-               write_ptr  = g_atomic_int_get (&this->_write_ptr);
-               if (space (read_ptr, write_ptr) < sizeof (ev_size)) {
-                       str << "!OUT!\n";
+               if (data >= end) {
+                       str << "(incomplete)\n";
                        break;
                }
 
-               wp = &this->_buf[read_ptr];
-               memcpy (&ev_size, wp, sizeof (ev_size));
-               read_ptr = (read_ptr + sizeof (ev_size)) % this->_size;
+               memcpy (&ev_size, data, sizeof (ev_size));
+               data += sizeof (ev_size);
                str << " size " << ev_size;
 
-               write_ptr  = g_atomic_int_get (&this->_write_ptr);
-               if (space (read_ptr, write_ptr) < ev_size) {
-                       str << "!OUT!\n";
+               if (data >= end) {
+                       str << "(incomplete)\n";
                        break;
                }
 
-               data = new uint8_t[ev_size];
-
-               wp = &this->_buf[read_ptr];
-               memcpy (data, wp, ev_size);
-               read_ptr = (read_ptr + ev_size) % this->_size;
-
-               for (uint32_t i = 0; i != ev_size; ++i) {
+               for (uint32_t i = 0; i != ev_size && data < end; ++i) {
                        str << ' ' << hex << (int) data[i] << dec;
                }
 
-               str << endl;
+               data += ev_size;
 
-               delete [] data;
+               str << endl;
        }
+
+       delete [] buf;
 }
 
+template<typename T>
+void
+MidiRingBuffer<T>::reset_tracker ()
+{
+       _tracker.reset ();
+}
 
 template class MidiRingBuffer<framepos_t>;