*/
#include "pbd/compose.h"
+#include "pbd/enumwriter.h"
+#include "pbd/error.h"
#include "ardour/debug.h"
#include "ardour/midi_ring_buffer.h"
#include "ardour/event_type_map.h"
using namespace std;
-using namespace ARDOUR;
using namespace PBD;
+namespace ARDOUR {
+
/** Read a block of MIDI events from this buffer into a MidiBuffer.
*
* Timestamps of events returned are relative to start (i.e. event with stamp 0
*/
template<typename T>
size_t
-MidiRingBuffer<T>::read(MidiBuffer& dst, nframes_t start, nframes_t end, nframes_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;
}
T ev_time;
- Evoral::EventType ev_type;
uint32_t ev_size;
+ size_t count = 0;
+ const size_t prefix_size = sizeof(T) + sizeof(Evoral::EventType) + sizeof(uint32_t);
- /* 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----------------------------->
-
- | | |
- start_of_loop start end_of_loop
-
- The MidiDiskstream::read method which will have happened before this checks for
- loops ending, and helpfully inserts a magic LoopEvent into the ringbuffer. After this,
- the MidiDiskstream continues to write events with their proper session frame times,
- so after the LoopEvent event times will go backwards (ie non-monotonically).
-
- Once we hit end_of_loop, we need to fake it to make it look as though the loop has been
- immediately repeated. Say that an event E after the end_of_loop in the ringbuffer
- has time E_t, which is a time in session frames. Its offset from the start
- of the loop will be E_t - start_of_loop. Its `faked' time will therefore be
- end_of_loop + E_t - start_of_loop. And so its port-buffer-relative time (for
- writing to the MidiBuffer) will be end_of_loop + E_t - start_of_loop - start.
-
- The subtraction of start is already taken care of, so if we see a LoopEvent, we'll
- set up loop_offset to equal end_of_loop - start_of_loop, so that given an event
- time E_t in the ringbuffer we can get the port-buffer-relative time as
- E_t + offset - start.
- */
+ while (this->read_space() >= prefix_size) {
- frameoffset_t loop_offset = 0;
+ uint8_t peekbuf[prefix_size];
- size_t count = 0;
+ /* this cannot fail, because we've already verified that there
+ is prefix_space to read
+ */
+ this->peek (peekbuf, prefix_size);
- while (this->read_space() >= sizeof(T) + sizeof(Evoral::EventType) + sizeof(uint32_t)) {
+ ev_time = *(reinterpret_cast<T*>((uintptr_t)peekbuf));
+ ev_size = *(reinterpret_cast<uint32_t*>((uintptr_t)(peekbuf + sizeof(T) + sizeof (Evoral::EventType))));
- this->full_peek(sizeof(T), (uint8_t*)&ev_time);
+ if (this->read_space() < ev_size) {
+ break;;
+ }
- if (ev_time + loop_offset >= end) {
+ if (ev_time >= end) {
DEBUG_TRACE (DEBUG::MidiDiskstreamIO, string_compose ("MRB event @ %1 past end @ %2\n", ev_time, end));
break;
- } else if (ev_time + loop_offset < start) {
+ } else if (ev_time < start) {
DEBUG_TRACE (DEBUG::MidiDiskstreamIO, string_compose ("MRB event @ %1 before start @ %2\n", ev_time, start));
break;
} else {
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;
- }
-
- // This event marks a loop end (i.e. the next event's timestamp will be non-monotonic)
- if (ev_type == LoopEventType) {
- assert (ev_size == sizeof (framepos_t));
- nframes_t loop_start;
- read_contents (ev_size, (uint8_t *) &loop_start);
-
- loop_offset = ev_time - loop_start;
- continue;
- }
+ ev_time -= start;
+ ev_time += offset;
- ev_time += loop_offset;
+ /* 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);
uint8_t status;
- success = this->full_peek(sizeof(uint8_t), &status);
- 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
- continue;
+ bool r = this->peek (&status, sizeof(uint8_t));
+ assert (r); // If this failed, buffer is corrupt, all hope is lost
+
+ /* 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;
}
- }
-
- 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
+ error << "MRB: Unable to reserve space in buffer, event skipped" << endmsg;
+ this->increment_read_ptr (ev_size); // Advance read pointer to next event
continue;
}
// write MIDI buffer contents
- success = read_contents (ev_size, write_loc);
+ bool 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_ENABLED (DEBUG::MidiDiskstreamIO)) {
+ 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_channel_event(status) && get_channel_mode() == ForceChannel) {
- write_loc[0] = (write_loc[0] & 0xF0) | (get_channel_mask() & 0x0F);
- }
+ _tracker.track(write_loc);
++count;
} else {
cerr << "WARNING: error reading event contents from MIDI ring" << endl;
return count;
}
+
+template<typename T>
+size_t
+MidiRingBuffer<T>::skip_to(framepos_t start)
+{
+ if (this->read_space() == 0) {
+ return 0;
+ }
+
+ T ev_time;
+ uint32_t ev_size;
+ size_t count = 0;
+ const size_t prefix_size = sizeof(T) + sizeof(Evoral::EventType) + sizeof(uint32_t);
+
+ while (this->read_space() >= prefix_size) {
+
+ uint8_t peekbuf[prefix_size];
+ this->peek (peekbuf, prefix_size);
+
+ ev_time = *(reinterpret_cast<T*>((uintptr_t)peekbuf));
+ ev_size = *(reinterpret_cast<uint32_t*>((uintptr_t)(peekbuf + sizeof(T) + sizeof (Evoral::EventType))));
+
+ if (ev_time >= start) {
+ return count;
+ }
+
+ if (this->read_space() < ev_size) {
+ continue;
+ }
+
+ this->increment_read_ptr (prefix_size);
+
+ uint8_t status;
+ bool r = this->peek (&status, sizeof(uint8_t));
+ assert (r); // If this failed, buffer is corrupt, all hope is lost
+
+ ++count;
+
+ /* TODO investigate and think:
+ *
+ * Does it makes sense to keep track of notes
+ * that are skipped (because they're either too late
+ * (underrun) or never used (read-ahead, loop) ?
+ *
+ * skip_to() is called on the rinbuffer between
+ * disk and process. it seems wrong to track them
+ * (a potential synth never sees skipped notes, either)
+ * but there may be more to this.
+ */
+
+ if (ev_size >= 8) {
+ this->increment_read_ptr (ev_size);
+ } else {
+ // we only track note on/off, 8 bytes are plenty.
+ uint8_t write_loc[8];
+ bool success = read_contents (ev_size, write_loc);
+ if (success) {
+ _tracker.track(write_loc);
+ }
+ }
+ }
+ return count;
+}
+
+
+
+template<typename T>
+void
+MidiRingBuffer<T>::flush (framepos_t /*start*/, framepos_t end)
+{
+ 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;
+ uint32_t ev_size;
+ 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 = *(reinterpret_cast<T*>((uintptr_t)peekbuf));
+
+ if (ev_time >= end) {
+ break;
+ }
+
+ ev_size = *(reinterpret_cast<uint32_t*>((uintptr_t)(peekbuf + sizeof(T) + sizeof (Evoral::EventType))));
+ this->increment_read_ptr (prefix_size);
+ this->increment_read_ptr (ev_size);
+ }
+}
+
template<typename T>
void
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<typename T>
+void
+MidiRingBuffer<T>::resolve_tracker (MidiBuffer& dst, framepos_t t)
+{
+ _tracker.resolve_notes (dst, t);
+}
+
+template<typename T>
+void
+MidiRingBuffer<T>::resolve_tracker (Evoral::EventSink<framepos_t>& dst, framepos_t t)
+{
+ _tracker.resolve_notes(dst, t);
+}
-template class MidiRingBuffer<nframes_t>;
+template class MidiRingBuffer<framepos_t>;
+} // namespace ARDOUR