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
 148         const size_t read_size = peek(size, dst);
 149
 150         if (read_size < size) {
 151                 peek(size - read_size, dst + read_size);
 152         }
 153
 154         return true;
 155 }
 156
 157
 158 /** Read from the ringbuffer.
 159  *
 160  * Note that a full read may not be done if the data wraps around.
 161  * Caller must check return value and call again if necessary, or use the
 162  * full_read method which does this automatically.
 163  */
 164 template<typename T>
 165 size_t
 166 MidiRingBufferBase<T>::read(size_t size, T* dst)
 167 {
 168         const size_t priv_read_ptr = g_atomic_int_get(&_read_ptr);
 169
 170         const size_t read_size = (priv_read_ptr + size < _size)
 171                         ? size
 172                         : _size - priv_read_ptr;
 173
 174         memcpy(dst, &_buf[priv_read_ptr], read_size);
 175
 176         g_atomic_int_set(&_read_ptr, (priv_read_ptr + read_size) % _size);
 177
 178         return read_size;
 179 }
 180
 181
 182 template<typename T>
 183 bool
 184 MidiRingBufferBase<T>::full_read(size_t size, T* dst)
 185 {
 186         if (read_space() < size) {
 187                 return false;
 188         }
 189
 190         const size_t read_size = read(size, dst);
 191
 192         if (read_size < size) {
 193                 read(size - read_size, dst + read_size);
 194         }
 195
 196         return true;
 197 }
 198
 199
 200 template<typename T>
 201 bool
 202 MidiRingBufferBase<T>::skip(size_t size)
 203 {
 204         if (read_space() < size) {
 205                 std::cerr << "WARNING: Attempt to skip past end of MIDI ring buffer" << std::endl;
 206                 return false;
 207         }
 208
 209         const size_t priv_read_ptr = g_atomic_int_get(&_read_ptr);
 210         g_atomic_int_set(&_read_ptr, (priv_read_ptr + size) % _size);
 211
 212         return true;
 213 }
 214
 215
 216 template<typename T>
 217 inline void
 218 MidiRingBufferBase<T>::write(size_t size, const T* src)
 219 {
 220         const size_t priv_write_ptr = g_atomic_int_get(&_write_ptr);
 221
 222         if (priv_write_ptr + size <= _size) {
 223                 memcpy(&_buf[priv_write_ptr], src, size);
 224                 g_atomic_int_set(&_write_ptr, (priv_write_ptr + size) % _size);
 225         } else {
 226                 const size_t this_size = _size - priv_write_ptr;
 227                 assert(this_size < size);
 228                 assert(priv_write_ptr + this_size <= _size);
 229                 memcpy(&_buf[priv_write_ptr], src, this_size);
 230                 memcpy(&_buf[0], src+this_size, size - this_size);
 231                 g_atomic_int_set(&_write_ptr, size - this_size);
 232         }
 233 }
 234
 235
 236 /* ******************************************************************** */
 237
 238
 239 /** A MIDI RingBuffer.
 240  *
 241  * This is timestamps and MIDI packed sequentially into a single buffer, similarly
 242  * to LV2 MIDI.  The buffer looks like this:
 243  *
 244  * [timestamp][size][size bytes of raw MIDI][timestamp][size][etc..]
 245  */
 246 class MidiRingBuffer : public MidiRingBufferBase<Byte> {
 247 public:
 248         /** @param size Size in bytes.
 249          */
 250         MidiRingBuffer(size_t size)
 251                 : MidiRingBufferBase<Byte>(size), _channel_mask(0x0000FFFF)
 252         {}
 253
 254         size_t write(double time, size_t size, const Byte* buf);
 255         bool   read(double* time, size_t* size, Byte* buf);
 256
 257         bool   read_prefix(double* time, size_t* size);
 258         bool   read_contents(size_t size, Byte* buf);
 259
 260         size_t read(MidiBuffer& dst, nframes_t start, nframes_t end, nframes_t offset=0);
 261
 262         /** Set the channel filtering mode.
 263          * @param mask If mode is FilterChannels, each bit represents a midi channel:
 264          *     bit 0 = channel 0, bit 1 = channel 1 etc. the read and write methods will only
 265          *     process events whose channel bit is 1.
 266          *     If mode is ForceChannel, mask is simply a channel number which all events will
 267          *     be forced to while reading.
 268          */
 269         void set_channel_mode(ChannelMode mode, uint16_t mask) {
 270                 g_atomic_int_set(&_channel_mask, ((uint16_t)mode << 16) | mask);
 271         }
 272
 273         ChannelMode get_channel_mode() const {
 274                 return static_cast<ChannelMode>((g_atomic_int_get(&_channel_mask) & 0xFFFF0000) >> 16);
 275         }
 276
 277         uint16_t get_channel_mask() const {
 278                 return static_cast<ChannelMode>((g_atomic_int_get(&_channel_mask) & 0x0000FFFF));
 279         }
 280
 281 protected:
 282         inline bool is_channel_event(Byte event_type_byte) {
 283                 // mask out channel information
 284                 event_type_byte &= 0xF0;
 285                 // midi channel events range from 0x80 to 0xE0
 286                 return (0x80 <= event_type_byte) && (event_type_byte <= 0xE0);
 287         }
 288
 289 private:
 290         volatile uint32_t _channel_mask; // 16 bits mode, 16 bits mask
 291 };
 292
 293
 294 inline bool
 295 MidiRingBuffer::read(double* time, size_t* size, Byte* buf)
 296 {
 297         bool success = MidiRingBufferBase<Byte>::full_read(sizeof(double), (Byte*)time);
 298
 299         if (success) {
 300                 success = MidiRingBufferBase<Byte>::full_read(sizeof(size_t), (Byte*)size);
 301         }
 302         if (success) {
 303                 success = MidiRingBufferBase<Byte>::full_read(*size, buf);
 304         }
 305
 306         return success;
 307 }
 308
 309
 310 /** Read the time and size of an event.  This call MUST be immediately proceeded
 311  * by a call to read_contents (or the read pointer will be garabage).
 312  */
 313 inline bool
 314 MidiRingBuffer::read_prefix(double* time, size_t* size)
 315 {
 316         bool success = MidiRingBufferBase<Byte>::full_read(sizeof(double), (Byte*)time);
 317         if (success) {
 318                 success = MidiRingBufferBase<Byte>::full_read(sizeof(size_t), (Byte*)size);
 319         }
 320
 321         return success;
 322 }
 323
 324
 325 /** Read the contenst of an event.  This call MUST be immediately preceeded
 326  * by a call to read_prefix (or the returned even will be garabage).
 327  */
 328 inline bool
 329 MidiRingBuffer::read_contents(size_t size, Byte* buf)
 330 {
 331         return MidiRingBufferBase<Byte>::full_read(size, buf);
 332 }
 333
 334
 335 inline size_t
 336 MidiRingBuffer::write(double time, size_t size, const Byte* buf)
 337 {
 338         /*fprintf(stderr, "MRB %p write (t = %f) ", this, time);
 339         for (size_t i = 0; i < size; ++i)
 340                 fprintf(stderr, "%X", (char)buf[i]);
 341         fprintf(stderr, "\n");*/
 342
 343         assert(size > 0);
 344
 345         // Don't write event if it doesn't match channel filter
 346         if (is_channel_event(buf[0]) && get_channel_mode() == FilterChannels) {
 347                 Byte channel = buf[0] & 0x0F;
 348                 if ( !(get_channel_mask() & (1L << channel)) ) {
 349                         return 0;
 350                 }
 351         }
 352
 353         if (write_space() < (sizeof(double) + sizeof(size_t) + size)) {
 354                 return 0;
 355         } else {
 356                 MidiRingBufferBase<Byte>::write(sizeof(double), (Byte*)&time);
 357                 MidiRingBufferBase<Byte>::write(sizeof(size_t), (Byte*)&size);
 358                 if (is_channel_event(buf[0]) && get_channel_mode() == ForceChannel) {
 359                         assert(size == 2 || size == 3);
 360                         Byte tmp_buf[3];
 361                         // Force event to channel
 362                         tmp_buf[0] = (buf[0] & 0xF0) | (get_channel_mask() & 0x0F);
 363                         tmp_buf[1] = buf[1];
 364                         if (size == 3) {
 365                                 tmp_buf[2] = buf[2];
 366                         }
 367                         MidiRingBufferBase<Byte>::write(size, tmp_buf);
 368                 } else {
 369                         MidiRingBufferBase<Byte>::write(size, buf);
 370                 }
 371                 return size;
 372         }
 373
 374 }
 375
 376
 377 /** Read a block of MIDI events from buffer.
 378  *
 379  * Timestamps of events returned are relative to start (ie event with stamp 0
 380  * occurred at start), with offset added.
 381  */
 382 inline size_t
 383 MidiRingBuffer::read(MidiBuffer& dst, nframes_t start, nframes_t end, nframes_t offset)
 384 {
 385         if (read_space() == 0)
 386                 return 0;
 387
 388         double   ev_time;
 389         uint32_t ev_size;
 390
 391         size_t count = 0;
 392
 393         //printf("---- MRB read %u .. %u + %u\n", start, end, offset);
 394
 395         while (read_space() > sizeof(double) + sizeof(size_t)) {
 396
 397                 full_peek(sizeof(double), (Byte*)&ev_time);
 398
 399                 if (ev_time > end) {
 400                         break;
 401                 }
 402
 403                 bool success = MidiRingBufferBase<Byte>::full_read(sizeof(double), (Byte*)&ev_time);
 404                 if (success) {
 405                         success = MidiRingBufferBase<Byte>::full_read(sizeof(size_t), (Byte*)&ev_size);
 406                 }
 407
 408                 if (!success) {
 409                         std::cerr << "MRB: READ ERROR (time/size)" << std::endl;
 410                         continue;
 411                 }
 412
 413                 Byte status;
 414                 success = full_peek(sizeof(Byte), &status);
 415                 assert(success); // If this failed, buffer is corrupt, all hope is lost
 416
 417                 // Ignore event if it doesn't match channel filter
 418                 if (is_channel_event(status) && get_channel_mode() == FilterChannels) {
 419                         const Byte channel = status & 0x0F;
 420                         if ( !(get_channel_mask() & (1L << channel)) ) {
 421                                 skip(ev_size); // Advance read pointer to next event
 422                                 continue;
 423                         }
 424                 }
 425
 426                 if (ev_time >= start) {
 427
 428                         /*std::cerr << "MRB " << this << " - Reading event, time = "
 429                                 << ev_time << " - " << start << " => " << ev_time - start
 430                                 << ", size = " << ev_size << std::endl;*/
 431
 432                         ev_time -= start;
 433
 434                         Byte* write_loc = dst.reserve(ev_time, ev_size);
 435                         if (write_loc == NULL) {
 436                                 std::cerr << "MRB: Unable to reserve space in buffer, event skipped";
 437                                 continue;
 438                         }
 439
 440                         success = MidiRingBufferBase<Byte>::full_read(ev_size, write_loc);
 441
 442                         if (success) {
 443                                 if (is_channel_event(status) && get_channel_mode() == ForceChannel) {
 444                                         write_loc[0] = (write_loc[0] & 0xF0) | (get_channel_mask() & 0x0F);
 445                                 }
 446                                 ++count;
 447                                 //printf("MRB - read event at time %lf\n", ev_time);
 448                         } else {
 449                                 std::cerr << "MRB: READ ERROR (data)" << std::endl;
 450                         }
 451
 452                 } else {
 453                         printf("MRB (start %u) - Skipping event at (too early) time %f\n", start, ev_time);
 454                 }
 455         }
 456
 457         //printf("(R) read space: %zu\n", read_space());
 458
 459         return count;
 460 }
 461
 462
 463 } // namespace ARDOUR
 464
 465 #endif // __ardour_midi_ring_buffer_h__
 466