Move EventRingBuffer to libardour.
[ardour.git] / libs / ardour / ardour / midi_ring_buffer.h
index 8bd426028339f4a266c294d3981f69a76ae7921a..15e4d2689bafe9134a760779090e9121fecf066c 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2006 Paul Davis 
+    Copyright (C) 2006 Paul Davis
 
     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
 
 #include <iostream>
 #include <algorithm>
-#include <ardour/types.h>
-#include <ardour/buffer.h>
-#include <ardour/event_type_map.h>
-#include <evoral/EventSink.hpp>
-#include <evoral/EventRingBuffer.hpp>
+
+#include "ardour/event_ring_buffer.h"
+#include "ardour/libardour_visibility.h"
+#include "ardour/types.h"
+#include "ardour/midi_state_tracker.h"
 
 namespace ARDOUR {
 
+class MidiBuffer;
 
 /** A RingBuffer for (MIDI) events.
  *
@@ -38,178 +39,61 @@ namespace ARDOUR {
  *
  * [timestamp][type][size][size bytes of raw MIDI][timestamp][type][size](etc...)
  */
-class MidiRingBuffer : public Evoral::EventRingBuffer {
+template<typename T>
+class /*LIBARDOUR_API*/ MidiRingBuffer : public EventRingBuffer<T> {
 public:
-       /** @param size Size in bytes.
-        */
-       MidiRingBuffer(size_t size)
-               : Evoral::EventRingBuffer(size)
-               , _channel_mask(0x0000FFFF)
-       {}
-
-       inline bool read_prefix(Evoral::EventTime* time, Evoral::EventType* type, uint32_t* size);
+       /** @param size Size in bytes. */
+       MidiRingBuffer(size_t size) : EventRingBuffer<T>(size) {}
+
+       inline bool read_prefix(T* time, Evoral::EventType* type, uint32_t* size);
        inline bool read_contents(uint32_t size, uint8_t* buf);
 
-       size_t read(MidiBuffer& dst, nframes_t start, nframes_t end, nframes_t offset=0);
-       
-       /** Set the channel filtering mode.
-        * @param mask If mode is FilterChannels, each bit represents a midi channel:
-        *     bit 0 = channel 0, bit 1 = channel 1 etc. the read and write methods will only
-        *     process events whose channel bit is 1.
-        *     If mode is ForceChannel, mask is simply a channel number which all events will
-        *     be forced to while reading.
-        */
-       void set_channel_mode(ChannelMode mode, uint16_t mask) {
-               g_atomic_int_set(&_channel_mask, ((uint16_t)mode << 16) | mask);
-       }
+       size_t read(MidiBuffer& dst, framepos_t start, framepos_t end, framecnt_t offset=0, bool stop_on_overflow_in_destination=false);
+
+       void dump(std::ostream& dst);
+       void flush (framepos_t start, framepos_t end);
+
+       void reset_tracker ();
+       void loop_resolve (MidiBuffer& dst, framepos_t);
 
-       ChannelMode get_channel_mode() const {
-               return static_cast<ChannelMode>((g_atomic_int_get(&_channel_mask) & 0xFFFF0000) >> 16);
-       }
-       
-       uint16_t get_channel_mask() const {
-               return static_cast<ChannelMode>((g_atomic_int_get(&_channel_mask) & 0x0000FFFF));
-       }
-       
-protected:
-       inline bool is_channel_event(uint8_t event_type_byte) {
-               // mask out channel information
-               event_type_byte &= 0xF0;
-               // midi channel events range from 0x80 to 0xE0
-               return (0x80 <= event_type_byte) && (event_type_byte <= 0xE0);
-       }
-       
 private:
-       volatile uint32_t _channel_mask; // 16 bits mode, 16 bits mask
+       MidiStateTracker _tracker;
 };
 
 
 /** Read the time and size of an event.  This call MUST be immediately proceeded
- * by a call to read_contents (or the read pointer will be garabage).
+ * by a call to read_contents (or the read pointer will be garbage).
  */
+template<typename T>
 inline bool
-MidiRingBuffer::read_prefix(Evoral::EventTime* time, Evoral::EventType* type, uint32_t* size)
+MidiRingBuffer<T>::read_prefix(T* time, Evoral::EventType* type, uint32_t* size)
 {
-       bool success = Evoral::EventRingBuffer::full_read(sizeof(Evoral::EventTime), (uint8_t*)time);
-       if (success)
-               success = Evoral::EventRingBuffer::full_read(sizeof(Evoral::EventType), (uint8_t*)type);
-       if (success)
-               success = Evoral::EventRingBuffer::full_read(sizeof(uint32_t), (uint8_t*)size);
+       if (PBD::RingBufferNPT<uint8_t>::read((uint8_t*)time, sizeof(T)) != sizeof (T)) {
+               return false;
+       }
 
-       return success;
-}
+       if (PBD::RingBufferNPT<uint8_t>::read((uint8_t*)type, sizeof(Evoral::EventType)) != sizeof (Evoral::EventType)) {
+               return false;
+       }
 
+       if (PBD::RingBufferNPT<uint8_t>::read((uint8_t*)size, sizeof(uint32_t)) != sizeof (uint32_t)) {
+               return false;
+       }
 
-/** Read the contenst of an event.  This call MUST be immediately preceeded
- * by a call to read_prefix (or the returned even will be garabage).
- */
-inline bool
-MidiRingBuffer::read_contents(uint32_t size, uint8_t* buf)
-{
-       return Evoral::EventRingBuffer::full_read(size, buf);
+       return true;
 }
 
 
-/** Read a block of MIDI events from buffer.
- *
- * Timestamps of events returned are relative to start (ie event with stamp 0
- * occurred at start), with offset added.
+/** Read the content of an event.  This call MUST be immediately preceded
+ * by a call to read_prefix (or the returned even will be garbage).
  */
-inline size_t
-MidiRingBuffer::read(MidiBuffer& dst, nframes_t start, nframes_t end, nframes_t offset)
+template<typename T>
+inline bool
+MidiRingBuffer<T>::read_contents(uint32_t size, uint8_t* buf)
 {
-       if (read_space() == 0) {
-               //std::cerr << "MRB: NO READ SPACE" << std::endl;
-               return 0;
-       }
-
-       Evoral::EventTime ev_time;
-       Evoral::EventType ev_type;
-       uint32_t          ev_size;
-
-       size_t count = 0;
-
-       //std::cerr << "MRB read " << start << " .. " << end << " + " << offset << std::endl;
-
-       while (read_space() >= sizeof(Evoral::EventTime) + sizeof(Evoral::EventType) + sizeof(uint32_t)) {
-
-               full_peek(sizeof(Evoral::EventTime), (uint8_t*)&ev_time);
-
-               if (ev_time > end) {
-                       //std::cerr << "MRB: PAST END (" << ev_time << " : " << end << ")" << std::endl;
-                       break;
-               } else if (ev_time < start) {
-                       //std::cerr << "MRB (start " << start << ") - Skipping event at (too early) time " << ev_time << std::endl;
-                       break;
-               }
-
-               bool success = read_prefix(&ev_time, &ev_type, &ev_size);
-               if (!success) {
-                       std::cerr << "WARNING: error reading event prefix from MIDI ring" << std::endl;
-                       continue;
-               }
-
-               // This event marks a loop happening. this means that
-               // the next events timestamp will be non-monotonic.
-               if (ev_type == LoopEventType) {
-                       ev_time -= start;
-                       ev_time += offset;
-                       Evoral::MIDIEvent loopevent(LoopEventType, ev_time); 
-                       dst.push_back(loopevent);
-
-                       
-                       // We can safely return, without reading the data, because
-                       // a LoopEvent does not have data.
-                       return count + 1;
-               }
-
-               uint8_t status;
-               success = 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)) ) {
-                               //std::cerr << "MRB skipping event due to channel mask" << std::endl;
-                               skip(ev_size); // Advance read pointer to next event
-                               continue;
-                       }
-               }
-
-               //std::cerr << "MRB " << this << " - Reading event, time = "
-               //      << ev_time << " - " << start << " => " << ev_time - start
-               //      << ", size = " << ev_size << std::endl;
-
-               assert(ev_time >= start);
-               ev_time -= start;
-               ev_time += offset;
-
-               uint8_t* write_loc = dst.reserve(ev_time, ev_size);
-               if (write_loc == NULL) {
-                       //std::cerr << "MRB: Unable to reserve space in buffer, event skipped";
-                       continue;
-               }
-
-               success = Evoral::EventRingBuffer::full_read(ev_size, write_loc);
-
-               if (success) {
-                       if (is_channel_event(status) && get_channel_mode() == ForceChannel) {
-                               write_loc[0] = (write_loc[0] & 0xF0) | (get_channel_mask() & 0x0F);
-                       }
-                       ++count;
-                       //std::cerr << "MRB - read event at time " << ev_time << std::endl;
-               } else {
-                       std::cerr << "WARNING: error reading event contents from MIDI ring" << std::endl;
-               }
-       }
-       
-       //std::cerr << "MTB read space: " << read_space() << std::endl;
-
-       return count;
+       return PBD::RingBufferNPT<uint8_t>::read(buf, size) == size;
 }
 
-
 } // namespace ARDOUR
 
 #endif // __ardour_midi_ring_buffer_h__