libs/ardour/ardour/midi_ring_buffer.h

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19 #ifndef __ardour_midi_ring_buffer_h__
  20 #define __ardour_midi_ring_buffer_h__
  21
  22 #include <iostream>
  23 #include <algorithm>
  24 #include <ardour/types.h>
  25 #include <ardour/buffer.h>
  26 #include <evoral/EventSink.hpp>
  27 #include <evoral/EventRingBuffer.hpp>
  28
  29 namespace ARDOUR {
  30
  31
  32 /** A RingBuffer for (MIDI) events.
  33  *
  34  * This is simply a wrapper around a raw ringbuffer which writes/reads events
  35  * as flat placked blobs.
  36  * The buffer looks like this:
  37  *
  38  * [timestamp][type][size][size bytes of raw MIDI][timestamp][type][size](etc...)
  39  */
  40 class MidiRingBuffer : public Evoral::EventRingBuffer {
  41 public:
  42         /** @param size Size in bytes.
  43          */
  44         MidiRingBuffer(size_t size)
  45                 : Evoral::EventRingBuffer(size)
  46                 , _channel_mask(0x0000FFFF)
  47         {}
  48
  49         inline bool read_prefix(EventTime* time, EventType* type, uint32_t* size);
  50         inline bool read_contents(uint32_t size, uint8_t* buf);
  51
  52         size_t read(MidiBuffer& dst, nframes_t start, nframes_t end, nframes_t offset=0);
  53
  54         /** Set the channel filtering mode.
  55          * @param mask If mode is FilterChannels, each bit represents a midi channel:
  56          *     bit 0 = channel 0, bit 1 = channel 1 etc. the read and write methods will only
  57          *     process events whose channel bit is 1.
  58          *     If mode is ForceChannel, mask is simply a channel number which all events will
  59          *     be forced to while reading.
  60          */
  61         void set_channel_mode(ChannelMode mode, uint16_t mask) {
  62                 g_atomic_int_set(&_channel_mask, ((uint16_t)mode << 16) | mask);
  63         }
  64
  65         ChannelMode get_channel_mode() const {
  66                 return static_cast<ChannelMode>((g_atomic_int_get(&_channel_mask) & 0xFFFF0000) >> 16);
  67         }
  68
  69         uint16_t get_channel_mask() const {
  70                 return static_cast<ChannelMode>((g_atomic_int_get(&_channel_mask) & 0x0000FFFF));
  71         }
  72
  73 protected:
  74         inline bool is_channel_event(uint8_t event_type_byte) {
  75                 // mask out channel information
  76                 event_type_byte &= 0xF0;
  77                 // midi channel events range from 0x80 to 0xE0
  78                 return (0x80 <= event_type_byte) && (event_type_byte <= 0xE0);
  79         }
  80
  81 private:
  82         volatile uint32_t _channel_mask; // 16 bits mode, 16 bits mask
  83 };
  84
  85
  86 /** Read the time and size of an event.  This call MUST be immediately proceeded
  87  * by a call to read_contents (or the read pointer will be garabage).
  88  */
  89 inline bool
  90 MidiRingBuffer::read_prefix(EventTime* time, EventType* type, uint32_t* size)
  91 {
  92         bool success = Evoral::EventRingBuffer::full_read(sizeof(EventTime), (uint8_t*)time);
  93         if (success)
  94                 success = Evoral::EventRingBuffer::full_read(sizeof(EventType), (uint8_t*)type);
  95         if (success)
  96                 success = Evoral::EventRingBuffer::full_read(sizeof(uint32_t), (uint8_t*)size);
  97
  98         return success;
  99 }
 100
 101
 102 /** Read the contenst of an event.  This call MUST be immediately preceeded
 103  * by a call to read_prefix (or the returned even will be garabage).
 104  */
 105 inline bool
 106 MidiRingBuffer::read_contents(uint32_t size, uint8_t* buf)
 107 {
 108         return Evoral::EventRingBuffer::full_read(size, buf);
 109 }
 110
 111
 112 /** Read a block of MIDI events from buffer.
 113  *
 114  * Timestamps of events returned are relative to start (ie event with stamp 0
 115  * occurred at start), with offset added.
 116  */
 117 inline size_t
 118 MidiRingBuffer::read(MidiBuffer& dst, nframes_t start, nframes_t end, nframes_t offset)
 119 {
 120         if (read_space() == 0) {
 121                 //std::cerr << "MRB: NO READ SPACE" << std::endl;
 122                 return 0;
 123         }
 124
 125         EventTime ev_time;
 126         EventType ev_type;
 127         uint32_t  ev_size;
 128
 129         size_t count = 0;
 130
 131         //std::cerr << "MRB read " << start << " .. " << end << " + " << offset << std::endl;
 132
 133         while (read_space() > sizeof(EventTime) + sizeof(EventType) + sizeof(uint32_t)) {
 134
 135                 full_peek(sizeof(EventTime), (uint8_t*)&ev_time);
 136
 137                 if (ev_time > end) {
 138                         //std::cerr << "MRB: PAST END (" << ev_time << " : " << end << ")" << std::endl;
 139                         break;
 140                 }
 141
 142                 bool success = read_prefix(&ev_time, &ev_type, &ev_size);
 143                 if (!success) {
 144                         //std::cerr << "MRB: READ ERROR (time/type/size)" << std::endl;
 145                         continue;
 146                 }
 147
 148                 uint8_t status;
 149                 success = full_peek(sizeof(uint8_t), &status);
 150                 assert(success); // If this failed, buffer is corrupt, all hope is lost
 151
 152                 // Ignore event if it doesn't match channel filter
 153                 if (is_channel_event(status) && get_channel_mode() == FilterChannels) {
 154                         const uint8_t channel = status & 0x0F;
 155                         if ( !(get_channel_mask() & (1L << channel)) ) {
 156                                 //std::cerr << "MRB skipping event due to channel mask" << std::endl;
 157                                 skip(ev_size); // Advance read pointer to next event
 158                                 continue;
 159                         }
 160                 }
 161
 162                 if (ev_time >= start) {
 163
 164                         //std::cerr << "MRB " << this << " - Reading event, time = "
 165                         //      << ev_time << " - " << start << " => " << ev_time - start
 166                         //      << ", size = " << ev_size << std::endl;
 167
 168                         ev_time -= start;
 169
 170                         uint8_t* write_loc = dst.reserve(ev_time, ev_size);
 171                         if (write_loc == NULL) {
 172                                 //std::cerr << "MRB: Unable to reserve space in buffer, event skipped";
 173                                 continue;
 174                         }
 175
 176                         success = Evoral::EventRingBuffer::full_read(ev_size, write_loc);
 177
 178                         if (success) {
 179                                 if (is_channel_event(status) && get_channel_mode() == ForceChannel) {
 180                                         write_loc[0] = (write_loc[0] & 0xF0) | (get_channel_mask() & 0x0F);
 181                                 }
 182                                 ++count;
 183                                 //std::cerr << "MRB - read event at time " << ev_time << std::endl;
 184                         } else {
 185                                 //std::cerr << "MRB: READ ERROR (data)" << std::endl;
 186                         }
 187
 188                 } else {
 189                         //std::cerr << "MRB (start " << start << ") - Skipping event at (too early) time " << ev_time << std::endl;
 190                 }
 191         }
 192
 193         //std::cerr << "MTB read space: " << read_space() << std::endl;
 194
 195         return count;
 196 }
 197
 198
 199 } // namespace ARDOUR
 200
 201 #endif // __ardour_midi_ring_buffer_h__
 202