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
  27 namespace ARDOUR {
  28
  29
  30 /* FIXME: this is probably too much inlined code */
  31
  32
  33 /** A RingBuffer.
  34  * Read/Write realtime safe.
  35  * Single-reader Single-writer thread safe.
  36  *
  37  * This is Raul::RingBuffer, lifted for MIDIRingBuffer to inherit from as it works
  38  * a bit differently than PBD::Ringbuffer.  This could/should be replaced with
  39  * the PBD ringbuffer to decrease code size, but this code is tested and known to
  40  * work, so here it sits for now...
  41  *
  42  * Ignore this class, use MidiRingBuffer.
  43  */
  44 template <typename T>
  45 class MidiRingBufferBase {
  46 public:
  47
  48         /** @param size Size in bytes.
  49          */
  50         MidiRingBufferBase(size_t size)
  51                 : _size(size)
  52                 , _buf(new T[size])
  53         {
  54                 reset();
  55                 assert(read_space() == 0);
  56                 assert(write_space() == size - 1);
  57         }
  58
  59         virtual ~MidiRingBufferBase() {
  60                 delete[] _buf;
  61         }
  62
  63         /** Reset(empty) the ringbuffer.
  64          * NOT thread safe.
  65          */
  66         void reset() {
  67                 g_atomic_int_set(&_write_ptr, 0);
  68                 g_atomic_int_set(&_read_ptr, 0);
  69         }
  70
  71         size_t write_space() const {
  72
  73                 const size_t w = g_atomic_int_get(&_write_ptr);
  74                 const size_t r = g_atomic_int_get(&_read_ptr);
  75
  76                 if (w > r) {
  77                         return ((r - w + _size) % _size) - 1;
  78                 } else if (w < r) {
  79                         return (r - w) - 1;
  80                 } else {
  81                         return _size - 1;
  82                 }
  83         }
  84
  85         size_t read_space() const {
  86
  87                 const size_t w = g_atomic_int_get(&_write_ptr);
  88                 const size_t r = g_atomic_int_get(&_read_ptr);
  89
  90                 if (w > r) {
  91                         return w - r;
  92                 } else {
  93                         return (w - r + _size) % _size;
  94                 }
  95         }
  96
  97         size_t capacity() const { return _size; }
  98
  99         size_t peek(size_t size, T* dst);
 100         bool   full_peek(size_t size, T* dst);
 101
 102         size_t read(size_t size, T* dst);
 103         bool   full_read(size_t size, T* dst);
 104
 105         bool   skip(size_t size);
 106
 107         void   write(size_t size, const T* src);
 108
 109 protected:
 110         mutable int _write_ptr;
 111         mutable int _read_ptr;
 112
 113         size_t _size; ///< Size (capacity) in bytes
 114         T*     _buf;  ///< size, event, size, event...
 115 };
 116
 117
 118 /** Peek at the ringbuffer (read w/o advancing read pointer).
 119  *
 120  * Note that a full read may not be done if the data wraps around.
 121  * Caller must check return value and call again if necessary, or use the
 122  * full_peek method which does this automatically.
 123  */
 124 template<typename T>
 125 size_t
 126 MidiRingBufferBase<T>::peek(size_t size, T* dst)
 127 {
 128         const size_t priv_read_ptr = g_atomic_int_get(&_read_ptr);
 129
 130         const size_t read_size = (priv_read_ptr + size < _size)
 131                         ? size
 132                         : _size - priv_read_ptr;
 133
 134         memcpy(dst, &_buf[priv_read_ptr], read_size);
 135
 136         return read_size;
 137 }
 138
 139
 140 template<typename T>
 141 bool
 142 MidiRingBufferBase<T>::full_peek(size_t size, T* dst)
 143 {
 144         if (read_space() < size)
 145                 return false;
 146
 147         const size_t read_size = peek(size, dst);
 148
 149         if (read_size < size)
 150                 peek(size - read_size, dst + read_size);
 151
 152         return true;
 153 }
 154
 155
 156 /** Read from the ringbuffer.
 157  *
 158  * Note that a full read may not be done if the data wraps around.
 159  * Caller must check return value and call again if necessary, or use the
 160  * full_read method which does this automatically.
 161  */
 162 template<typename T>
 163 size_t
 164 MidiRingBufferBase<T>::read(size_t size, T* dst)
 165 {
 166         const size_t priv_read_ptr = g_atomic_int_get(&_read_ptr);
 167
 168         const size_t read_size = (priv_read_ptr + size < _size)
 169                         ? size
 170                         : _size - priv_read_ptr;
 171
 172         memcpy(dst, &_buf[priv_read_ptr], read_size);
 173
 174         g_atomic_int_set(&_read_ptr, (priv_read_ptr + read_size) % _size);
 175
 176         return read_size;
 177 }
 178
 179
 180 template<typename T>
 181 bool
 182 MidiRingBufferBase<T>::full_read(size_t size, T* dst)
 183 {
 184         if (read_space() < size)
 185                 return false;
 186
 187         const size_t read_size = read(size, dst);
 188
 189         if (read_size < size)
 190                 read(size - read_size, dst + read_size);
 191
 192         return true;
 193 }
 194
 195
 196 template<typename T>
 197 bool
 198 MidiRingBufferBase<T>::skip(size_t size)
 199 {
 200         if (read_space() < size) {
 201                 std::cerr << "WARNING: Attempt to skip past end of MIDI ring buffer" << std::endl;
 202                 return false;
 203         }
 204
 205         const size_t priv_read_ptr = g_atomic_int_get(&_read_ptr);
 206         g_atomic_int_set(&_read_ptr, (priv_read_ptr + size) % _size);
 207
 208         return true;
 209 }
 210
 211
 212
 213 template<typename T>
 214 inline void
 215 MidiRingBufferBase<T>::write(size_t size, const T* src)
 216 {
 217         const size_t priv_write_ptr = g_atomic_int_get(&_write_ptr);
 218
 219         if (priv_write_ptr + size <= _size) {
 220                 memcpy(&_buf[priv_write_ptr], src, size);
 221                 g_atomic_int_set(&_write_ptr, (priv_write_ptr + size) % _size);
 222         } else {
 223                 const size_t this_size = _size - priv_write_ptr;
 224                 assert(this_size < size);
 225                 assert(priv_write_ptr + this_size <= _size);
 226                 memcpy(&_buf[priv_write_ptr], src, this_size);
 227                 memcpy(&_buf[0], src+this_size, size - this_size);
 228                 g_atomic_int_set(&_write_ptr, size - this_size);
 229         }
 230 }
 231
 232
 233 /* ******************************************************************** */
 234
 235
 236 /** A MIDI RingBuffer.
 237  *
 238  * This is timestamps and MIDI packed sequentially into a single buffer, similarly
 239  * to LV2 MIDI.  The buffer looks like this:
 240  *
 241  * [timestamp][size][size bytes of raw MIDI][timestamp][size][etc..]
 242  */
 243 class MidiRingBuffer : public MidiRingBufferBase<Byte> {
 244 public:
 245         /** @param size Size in bytes.
 246          */
 247         MidiRingBuffer(size_t size)
 248                 : MidiRingBufferBase<Byte>(size), _channel_mask(0x0000FFFF)
 249         {}
 250
 251         size_t write(double time, size_t size, const Byte* buf);
 252         bool   read(double* time, size_t* size, Byte* buf);
 253
 254         bool   read_prefix(double* time, size_t* size);
 255         bool   read_contents(size_t size, Byte* buf);
 256
 257         size_t read(MidiBuffer& dst, nframes_t start, nframes_t end, nframes_t offset=0);
 258
 259         /** Set the channel filtering mode.
 260          * @param mask If mode is FilterChannels, each bit represents a midi channel:
 261          *     bit 0 = channel 0, bit 1 = channel 1 etc. the read and write methods will only
 262          *     process events whose channel bit is 1.
 263          *     If mode is ForceChannel, mask is simply a channel number which all events will
 264          *     be forced to while reading.
 265          */
 266         void set_channel_mode(ChannelMode mode, uint16_t mask) {
 267                 g_atomic_int_set(&_channel_mask, ((uint16_t)mode << 16) | mask);
 268         }
 269
 270         ChannelMode get_channel_mode() const {
 271                 return static_cast<ChannelMode>((g_atomic_int_get(&_channel_mask) & 0xFFFF0000) >> 16);
 272         }
 273
 274         uint16_t get_channel_mask() const {
 275                 return static_cast<ChannelMode>((g_atomic_int_get(&_channel_mask) & 0x0000FFFF));
 276         }
 277
 278 protected:
 279         inline bool is_channel_event(Byte event_type_byte) {
 280                 // mask out channel information
 281                 event_type_byte &= 0xF0;
 282                 // midi channel events range from 0x80 to 0xE0
 283                 return (0x80 <= event_type_byte) && (event_type_byte <= 0xE0);
 284         }
 285
 286 private:
 287         volatile uint32_t _channel_mask; // 16 bits mode, 16 bits mask
 288 };
 289
 290
 291 inline bool
 292 MidiRingBuffer::read(double* time, size_t* size, Byte* buf)
 293 {
 294         bool success = MidiRingBufferBase<Byte>::full_read(sizeof(double), (Byte*)time);
 295         if (success)
 296                 success = MidiRingBufferBase<Byte>::full_read(sizeof(size_t), (Byte*)size);
 297         if (success)
 298                 success = MidiRingBufferBase<Byte>::full_read(*size, buf);
 299
 300         return success;
 301 }
 302
 303
 304 /** Read the time and size of an event.  This call MUST be immediately proceeded
 305  * by a call to read_contents (or the read pointer will be garabage).
 306  */
 307 inline bool
 308 MidiRingBuffer::read_prefix(double* time, size_t* size)
 309 {
 310         bool success = MidiRingBufferBase<Byte>::full_read(sizeof(double), (Byte*)time);
 311         if (success)
 312                 success = MidiRingBufferBase<Byte>::full_read(sizeof(size_t), (Byte*)size);
 313
 314         return success;
 315 }
 316
 317
 318 /** Read the contenst of an event.  This call MUST be immediately preceeded
 319  * by a call to read_prefix (or the returned even will be garabage).
 320  */
 321 inline bool
 322 MidiRingBuffer::read_contents(size_t size, Byte* buf)
 323 {
 324         return MidiRingBufferBase<Byte>::full_read(size, buf);
 325 }
 326
 327
 328 inline size_t
 329 MidiRingBuffer::write(double time, size_t size, const Byte* buf)
 330 {
 331         /*fprintf(stderr, "MRB %p write (t = %f) ", this, time);
 332         for (size_t i = 0; i < size; ++i)
 333                 fprintf(stderr, "%X", (char)buf[i]);
 334         fprintf(stderr, "\n");*/
 335
 336         assert(size > 0);
 337
 338         // Don't write event if it doesn't match channel filter
 339         if (is_channel_event(buf[0]) && get_channel_mode() == FilterChannels) {
 340                 Byte channel = buf[0] & 0x0F;
 341                 if ( !(get_channel_mask() & (1L << channel)) )
 342                         return 0;
 343         }
 344
 345         if (write_space() < (sizeof(double) + sizeof(size_t) + size)) {
 346                 return 0;
 347         } else {
 348                 MidiRingBufferBase<Byte>::write(sizeof(double), (Byte*)&time);
 349                 MidiRingBufferBase<Byte>::write(sizeof(size_t), (Byte*)&size);
 350                 if (is_channel_event(buf[0]) && get_channel_mode() == ForceChannel) {
 351                         assert(size == 2 || size == 3);
 352                         Byte tmp_buf[3];
 353                         // Force event to channel
 354                         tmp_buf[0] = (buf[0] & 0xF0) | (get_channel_mask() & 0x0F);
 355                         tmp_buf[1] = buf[1];
 356                         if (size == 3) {
 357                                 tmp_buf[2] = buf[2];
 358                         }
 359                         MidiRingBufferBase<Byte>::write(size, tmp_buf);
 360                 } else {
 361                         MidiRingBufferBase<Byte>::write(size, buf);
 362                 }
 363                 return size;
 364         }
 365
 366 }
 367
 368
 369 /** Read a block of MIDI events from buffer.
 370  *
 371  * Timestamps of events returned are relative to start (ie event with stamp 0
 372  * occurred at start), with offset added.
 373  */
 374 inline size_t
 375 MidiRingBuffer::read(MidiBuffer& dst, nframes_t start, nframes_t end, nframes_t offset)
 376 {
 377         if (read_space() == 0)
 378                 return 0;
 379
 380         double   ev_time;
 381         uint32_t ev_size;
 382
 383         size_t count = 0;
 384
 385         //printf("---- MRB read %u .. %u + %u\n", start, end, offset);
 386
 387         while (read_space() > sizeof(double) + sizeof(size_t)) {
 388
 389                 full_peek(sizeof(double), (Byte*)&ev_time);
 390
 391                 if (ev_time > end)
 392                         break;
 393
 394                 bool success = MidiRingBufferBase<Byte>::full_read(sizeof(double), (Byte*)&ev_time);
 395                 if (success) {
 396                         success = MidiRingBufferBase<Byte>::full_read(sizeof(size_t), (Byte*)&ev_size);
 397                 }
 398
 399                 if (!success) {
 400                         std::cerr << "MRB: READ ERROR (time/size)" << std::endl;
 401                         continue;
 402                 }
 403
 404                 Byte status;
 405                 success = full_peek(sizeof(Byte), &status);
 406                 assert(success); // If this failed, buffer is corrupt, all hope is lost
 407
 408                 // Ignore event if it doesn't match channel filter
 409                 if (is_channel_event(status) && get_channel_mode() == FilterChannels) {
 410                         const Byte channel = status & 0x0F;
 411                         if ( !(get_channel_mask() & (1L << channel)) ) {
 412                                 skip(ev_size); // Advance read pointer to next event
 413                                 continue;
 414                         }
 415                 }
 416
 417                 if (ev_time >= start) {
 418
 419                         /*std::cerr << "MRB " << this << " - Reading event, time = "
 420                                 << ev_time << " - " << start << " => " << ev_time - start
 421                                 << ", size = " << ev_size << std::endl;*/
 422
 423                         ev_time -= start;
 424
 425                         Byte* write_loc = dst.reserve(ev_time, ev_size);
 426                         if (write_loc == NULL) {
 427                                 std::cerr << "MRB: Unable to reserve space in buffer, event skipped";
 428                                 continue;
 429                         }
 430
 431                         success = MidiRingBufferBase<Byte>::full_read(ev_size, write_loc);
 432
 433                         if (success) {
 434                                 if (is_channel_event(status) && get_channel_mode() == ForceChannel) {
 435                                         write_loc[0] = (write_loc[0] & 0xF0) | (get_channel_mask() & 0x0F);
 436                                 }
 437                                 ++count;
 438                                 //printf("MRB - read event at time %lf\n", ev_time);
 439                         } else {
 440                                 std::cerr << "MRB: READ ERROR (data)" << std::endl;
 441                         }
 442
 443                 } else {
 444                         printf("MRB (start %u) - Skipping event at (too early) time %f\n", start, ev_time);
 445                 }
 446         }
 447
 448         //printf("(R) read space: %zu\n", read_space());
 449
 450         return count;
 451 }
 452
 453
 454 } // namespace ARDOUR
 455
 456 #endif // __ardour_midi_ring_buffer_h__
 457