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         void   write(size_t size, const T* src);
 106
 107 protected:
 108         mutable gint _write_ptr;
 109         mutable gint _read_ptr;
 110
 111         size_t _size; ///< Size (capacity) in bytes
 112         T*  _buf;  ///< size, event, size, event...
 113 };
 114
 115
 116 /** Peek at the ringbuffer (read w/o advancing read pointer).
 117  *
 118  * Note that a full read may not be done if the data wraps around.
 119  * Caller must check return value and call again if necessary, or use the
 120  * full_peek method which does this automatically.
 121  */
 122 template<typename T>
 123 size_t
 124 MidiRingBufferBase<T>::peek(size_t size, T* dst)
 125 {
 126         const size_t priv_read_ptr = g_atomic_int_get(&_read_ptr);
 127
 128         const size_t read_size = (priv_read_ptr + size < _size)
 129                         ? size
 130                         : _size - priv_read_ptr;
 131
 132         memcpy(dst, &_buf[priv_read_ptr], read_size);
 133
 134         return read_size;
 135 }
 136
 137
 138 template<typename T>
 139 bool
 140 MidiRingBufferBase<T>::full_peek(size_t size, T* dst)
 141 {
 142         if (read_space() < size)
 143                 return false;
 144
 145         const size_t read_size = peek(size, dst);
 146
 147         if (read_size < size)
 148                 peek(size - read_size, dst + read_size);
 149
 150         return true;
 151 }
 152
 153
 154 /** Read from the ringbuffer.
 155  *
 156  * Note that a full read may not be done if the data wraps around.
 157  * Caller must check return value and call again if necessary, or use the
 158  * full_read method which does this automatically.
 159  */
 160 template<typename T>
 161 size_t
 162 MidiRingBufferBase<T>::read(size_t size, T* dst)
 163 {
 164         const size_t priv_read_ptr = g_atomic_int_get(&_read_ptr);
 165
 166         const size_t read_size = (priv_read_ptr + size < _size)
 167                         ? size
 168                         : _size - priv_read_ptr;
 169
 170         memcpy(dst, &_buf[priv_read_ptr], read_size);
 171
 172         g_atomic_int_set(&_read_ptr, (priv_read_ptr + read_size) % _size);
 173
 174         return read_size;
 175 }
 176
 177
 178 template<typename T>
 179 bool
 180 MidiRingBufferBase<T>::full_read(size_t size, T* dst)
 181 {
 182         if (read_space() < size)
 183                 return false;
 184
 185         const size_t read_size = read(size, dst);
 186
 187         if (read_size < size)
 188                 read(size - read_size, dst + read_size);
 189
 190         return true;
 191 }
 192
 193
 194 template<typename T>
 195 inline void
 196 MidiRingBufferBase<T>::write(size_t size, const T* src)
 197 {
 198         const size_t priv_write_ptr = g_atomic_int_get(&_write_ptr);
 199
 200         if (priv_write_ptr + size <= _size) {
 201                 memcpy(&_buf[priv_write_ptr], src, size);
 202         g_atomic_int_set(&_write_ptr, (priv_write_ptr + size) % _size);
 203         } else {
 204                 const size_t this_size = _size - priv_write_ptr;
 205                 assert(this_size < size);
 206                 assert(priv_write_ptr + this_size <= _size);
 207                 memcpy(&_buf[priv_write_ptr], src, this_size);
 208                 memcpy(&_buf[0], src+this_size, size - this_size);
 209         g_atomic_int_set(&_write_ptr, size - this_size);
 210         }
 211 }
 212
 213
 214 /* ******************************************************************** */
 215
 216
 217 /** A MIDI RingBuffer.
 218  *
 219  * This is timestamps and MIDI packed sequentially into a single buffer, similarly
 220  * to LV2 MIDI.  The buffer looks like this:
 221  *
 222  * [timestamp][size][size bytes of raw MIDI][timestamp][size][etc..]
 223  */
 224 class MidiRingBuffer : public MidiRingBufferBase<Byte> {
 225 public:
 226
 227         /** @param size Size in bytes.
 228          */
 229         MidiRingBuffer(size_t size)
 230                 : MidiRingBufferBase<Byte>(size), _channel_mask(0xFFFF), _force_channel(-1)
 231         {}
 232
 233         size_t write(double time, size_t size, const Byte* buf);
 234         bool   read(double* time, size_t* size, Byte* buf);
 235
 236         bool   read_prefix(double* time, size_t* size);
 237         bool   read_contents(size_t size, Byte* buf);
 238
 239         size_t read(MidiBuffer& dst, nframes_t start, nframes_t end, nframes_t offset=0);
 240
 241         /**
 242          * @param channel_mask each bit in channel_mask represents a midi channel: bit 0 = channel 0,
 243          *                     bit 1 = channel 1 etc. the read and write methods will only allow
 244          *                     events to pass, whose channel bit is 1.
 245          */
 246         void      set_channel_mask(uint16_t channel_mask) { g_atomic_int_set(&_channel_mask, channel_mask); }
 247         uint16_t  get_channel_mask() { return g_atomic_int_get(&_channel_mask); }
 248
 249         /**
 250          * @param channel if negative, forcing channels is deactivated and filtering channels
 251          *                is activated, if positive, the LSB of channel is the channel number
 252          *                of the channel all events are forced into and filtering is deactivated
 253          */
 254         void      set_force_channel(int8_t channel) { g_atomic_int_set(&_force_channel, channel); }
 255         int8_t    get_force_channel() { return g_atomic_int_get(&_force_channel); }
 256
 257 protected:
 258         inline bool is_channel_event(Byte event_type_byte) {
 259                 // mask out channel information
 260                 event_type_byte &= 0xF0;
 261                 // midi channel events range from 0x80 to 0xE0
 262                 return (0x80 <= event_type_byte) && (event_type_byte <= 0xE0);
 263         }
 264
 265 private:
 266         volatile uint16_t _channel_mask;
 267         volatile int8_t   _force_channel;
 268 };
 269
 270
 271 inline bool
 272 MidiRingBuffer::read(double* time, size_t* size, Byte* buf)
 273 {
 274         bool success = MidiRingBufferBase<Byte>::full_read(sizeof(double), (Byte*)time);
 275         if (success)
 276                 success = MidiRingBufferBase<Byte>::full_read(sizeof(size_t), (Byte*)size);
 277         if (success)
 278                 success = MidiRingBufferBase<Byte>::full_read(*size, buf);
 279
 280         return success;
 281 }
 282
 283
 284 /** Read the time and size of an event.  This call MUST be immediately proceeded
 285  * by a call to read_contents (or the read pointer will be garabage).
 286  */
 287 inline bool
 288 MidiRingBuffer::read_prefix(double* time, size_t* size)
 289 {
 290         bool success = MidiRingBufferBase<Byte>::full_read(sizeof(double), (Byte*)time);
 291         if (success)
 292                 success = MidiRingBufferBase<Byte>::full_read(sizeof(size_t), (Byte*)size);
 293
 294         return success;
 295 }
 296
 297
 298 /** Read the contenst of an event.  This call MUST be immediately preceeded
 299  * by a call to read_prefix (or the returned even will be garabage).
 300  */
 301 inline bool
 302 MidiRingBuffer::read_contents(size_t size, Byte* buf)
 303 {
 304         return MidiRingBufferBase<Byte>::full_read(size, buf);
 305 }
 306
 307
 308 inline size_t
 309 MidiRingBuffer::write(double time, size_t size, const Byte* buf)
 310 {
 311         //printf("MRB - write %#X %d %d with time %lf\n",
 312         //              buf[0], buf[1], buf[2], time);
 313
 314         assert(size > 0);
 315
 316         if(is_channel_event(buf[0]) && (g_atomic_int_get(&_force_channel) < 0)) {
 317                 // filter events for channels
 318                 Byte channel_nr = buf[0] & 0x0F;
 319                 if( !(g_atomic_int_get(&_channel_mask) & (1L << channel_nr)) )  {
 320                         return 0;
 321                 }
 322         }
 323
 324         if (write_space() < (sizeof(double) + sizeof(size_t) + size)) {
 325                 return 0;
 326         } else {
 327                 MidiRingBufferBase<Byte>::write(sizeof(double), (Byte*)&time);
 328                 MidiRingBufferBase<Byte>::write(sizeof(size_t), (Byte*)&size);
 329                 if(is_channel_event(buf[0]) && (g_atomic_int_get(&_force_channel) >= 0)) {
 330                         assert(size == 3);
 331                         Byte tmp_buf[3];
 332                         //force event into channel
 333                         tmp_buf[0] = (buf[0] & 0xF0) | (g_atomic_int_get(&_force_channel) & 0x0F);
 334                         tmp_buf[1] = buf[1];
 335                         tmp_buf[2] = buf[2];
 336                         MidiRingBufferBase<Byte>::write(size, tmp_buf);
 337                 } else {
 338                         MidiRingBufferBase<Byte>::write(size, buf);
 339                 }
 340                 return size;
 341         }
 342
 343 }
 344
 345
 346 /** Read a block of MIDI events from buffer.
 347  *
 348  * Timestamps of events returned are relative to start (ie event with stamp 0
 349  * occurred at start), with offset added.
 350  */
 351 inline size_t
 352 MidiRingBuffer::read(MidiBuffer& dst, nframes_t start, nframes_t end, nframes_t offset)
 353 {
 354         if (read_space() == 0)
 355                 return 0;
 356
 357         MIDI::Event ev;
 358
 359         size_t count = 0;
 360
 361         //printf("MRB - read %u .. %u + %u\n", start, end, offset);
 362
 363         while (read_space() > sizeof(double) + sizeof(size_t)) {
 364
 365                 full_peek(sizeof(double), (Byte*)&ev.time());
 366
 367                 if (ev.time() > end)
 368                         break;
 369
 370                 bool success = MidiRingBufferBase<Byte>::full_read(sizeof(double), (Byte*)&ev.time());
 371                 if (success) {
 372                         success = MidiRingBufferBase<Byte>::full_read(sizeof(size_t), (Byte*)&ev.size());
 373                 }
 374
 375                 if (!success) {
 376                         std::cerr << "MRB: READ ERROR (time/size)" << std::endl;
 377                         continue;
 378                 }
 379
 380                 Byte first_event_byte;
 381                 if(success) {
 382                         success = full_peek(sizeof(Byte), &first_event_byte);
 383                 }
 384
 385                 // could this ever happen???
 386                 if (!success) {
 387                         std::cerr << "MRB: PEEK ERROR (first event byte)" << std::endl;
 388                         continue;
 389                 }
 390
 391                 // filter events for channels
 392                 // filtering is only active, if forcing channels is not active
 393                 if(is_channel_event(first_event_byte) && (g_atomic_int_get(&_force_channel) < 0)) {
 394                         Byte channel_nr = first_event_byte & 0x0F;
 395                         if( !(g_atomic_int_get(&_channel_mask) & (1L << channel_nr)) )  {
 396                                 continue;
 397                         }
 398                 }
 399
 400                 if (ev.time() >= start) {
 401                         ev.time() -= start;
 402                         // TODO: Right now there come MIDI Events with empty buffer
 403                         if(!ev.buffer()) {
 404                                 std::cerr << "MidiRingBuffer::read WARNING: Skipping MIDI Event with NULL buffer pointer "
 405                                      << " and length " << int(ev.size()) << std::endl;
 406                                 continue;
 407                         }
 408
 409                         Byte* write_loc = dst.reserve(ev.time(), ev.size());
 410
 411                         success = MidiRingBufferBase<Byte>::full_read(ev.size(), write_loc);
 412
 413                         if (success) {
 414                                 if(is_channel_event(first_event_byte) && (g_atomic_int_get(&_force_channel) >= 0)) {
 415                                         write_loc[0] = (write_loc[0] & 0xF0) | (g_atomic_int_get(&_force_channel) & 0x0F);
 416                                 }
 417                                 ++count;
 418                                 //printf("MRB - read event at time %lf\n", ev.time());
 419                         } else {
 420                                 std::cerr << "MRB: READ ERROR (data)" << std::endl;
 421                         }
 422
 423                 } else {
 424                         printf("MRB - SKIPPING EVENT AT TIME %f\n", ev.time());
 425                 }
 426         }
 427
 428         //printf("(R) read space: %zu\n", read_space());
 429
 430         return count;
 431 }
 432
 433
 434 } // namespace ARDOUR
 435
 436 #endif // __ardour_midi_ring_buffer_h__
 437