libs/ardour/midi_buffer.cc

   1 /*
   2     Copyright (C) 2006-2007 Paul Davis
   3     Author: David Robillard
   4
   5     This program is free software; you can redistribute it and/or modify it
   6     under the terms of the GNU General Public License as published by the Free
   7     Software Foundation; either version 2 of the License, or (at your option)
   8     any later version.
   9
  10     This program is distributed in the hope that it will be useful, but WITHOUT
  11     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13     for more details.
  14
  15     You should have received a copy of the GNU General Public License along
  16     with this program; if not, write to the Free Software Foundation, Inc.,
  17     675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #include <iostream>
  21
  22 #include "pbd/malign.h"
  23 #include "pbd/compose.h"
  24 #include "pbd/debug.h"
  25
  26 #include "ardour/debug.h"
  27 #include "ardour/midi_buffer.h"
  28
  29 using namespace std;
  30 using namespace ARDOUR;
  31 using namespace PBD;
  32
  33 // FIXME: mirroring for MIDI buffers?
  34 MidiBuffer::MidiBuffer(size_t capacity)
  35         : Buffer(DataType::MIDI, capacity)
  36         , _data(0)
  37 {
  38         if (capacity) {
  39                 resize(_capacity);
  40                 silence(_capacity);
  41         }
  42 }
  43
  44 MidiBuffer::~MidiBuffer()
  45 {
  46         free(_data);
  47 }
  48
  49 void
  50 MidiBuffer::resize(size_t size)
  51 {
  52         assert(size > 0);
  53
  54         if (size < _capacity) {
  55                 return;
  56         }
  57
  58         free(_data);
  59
  60         _size = 0;
  61         _capacity = size;
  62         cache_aligned_malloc ((void**) &_data, _capacity);
  63
  64         assert(_data);
  65 }
  66
  67 void
  68 MidiBuffer::copy(const MidiBuffer& copy)
  69 {
  70         assert(_capacity >= copy._size);
  71         _size = copy._size;
  72         memcpy(_data, copy._data, copy._size);
  73 }
  74
  75
  76 /** Read events from @a src starting at time @a offset into the START of this buffer, for
  77  * time duration @a nframes.  Relative time, where 0 = start of buffer.
  78  *
  79  * Note that offset and nframes refer to sample time, NOT buffer offsets or event counts.
  80  */
  81 void
  82 MidiBuffer::read_from (const Buffer& src, framecnt_t nframes, framecnt_t dst_offset, framecnt_t src_offset)
  83 {
  84         assert (src.type() == DataType::MIDI);
  85         assert (&src != this);
  86
  87         const MidiBuffer& msrc = (MidiBuffer&) src;
  88
  89         assert (_capacity >= msrc.size());
  90
  91         if (dst_offset == 0) {
  92                 clear ();
  93                 assert (_size == 0);
  94         }
  95
  96         /* XXX use dst_offset somehow */
  97
  98         for (MidiBuffer::const_iterator i = msrc.begin(); i != msrc.end(); ++i) {
  99                 const Evoral::MIDIEvent<TimeType> ev(*i, false);
 100                 if (ev.time() >= src_offset && ev.time() < (nframes+src_offset)) {
 101                         push_back (ev);
 102                 } else {
 103                         cerr << "MIDI event @ " <<  ev.time() << " skipped, not within range "
 104                              << src_offset << " .. " << (nframes + src_offset) << endl;
 105                 }
 106         }
 107
 108         _silent = src.silent();
 109 }
 110
 111 void
 112 MidiBuffer::merge_from (const Buffer& src, framecnt_t /*nframes*/, framecnt_t /*dst_offset*/, framecnt_t /*src_offset*/)
 113 {
 114         const MidiBuffer* mbuf = dynamic_cast<const MidiBuffer*>(&src);
 115         assert (mbuf);
 116         assert (mbuf != this);
 117
 118         /* XXX use nframes, and possible offsets */
 119         merge_in_place (*mbuf);
 120 }
 121
 122 /** Push an event into the buffer.
 123  *
 124  * Note that the raw MIDI pointed to by ev will be COPIED and unmodified.
 125  * That is, the caller still owns it, if it needs freeing it's Not My Problem(TM).
 126  * Realtime safe.
 127  * @return false if operation failed (not enough room)
 128  */
 129 bool
 130 MidiBuffer::push_back(const Evoral::MIDIEvent<TimeType>& ev)
 131 {
 132         const size_t stamp_size = sizeof(TimeType);
 133         /*cerr << "MidiBuffer: pushing event @ " << ev.time()
 134                 << " size = " << ev.size() << endl;*/
 135
 136         if (_size + stamp_size + ev.size() >= _capacity) {
 137                 cerr << "MidiBuffer::push_back failed (buffer is full)" << endl;
 138                 return false;
 139         }
 140
 141         if (!Evoral::midi_event_is_valid(ev.buffer(), ev.size())) {
 142                 cerr << "WARNING: MidiBuffer ignoring illegal MIDI event" << endl;
 143                 return false;
 144         }
 145
 146         push_back(ev.time(), ev.size(), ev.buffer());
 147
 148         return true;
 149 }
 150
 151
 152 /** Push an event into the buffer.
 153  * @return false if operation failed (not enough room)
 154  */
 155 bool
 156 MidiBuffer::push_back(TimeType time, size_t size, const uint8_t* data)
 157 {
 158         const size_t stamp_size = sizeof(TimeType);
 159
 160 #ifndef NDEBUG
 161         if (DEBUG::MidiIO & PBD::debug_bits) {
 162                 DEBUG_STR_DECL(a);
 163                 DEBUG_STR_APPEND(a, string_compose ("midibuffer %1 push event @ %2 sz %3 ", this, time, size));
 164                 for (size_t i=0; i < size; ++i) {
 165                         DEBUG_STR_APPEND(a,hex);
 166                         DEBUG_STR_APPEND(a,"0x");
 167                         DEBUG_STR_APPEND(a,(int)data[i]);
 168                         DEBUG_STR_APPEND(a,' ');
 169                 }
 170                 DEBUG_STR_APPEND(a,'\n');
 171                 DEBUG_TRACE (DEBUG::MidiIO, DEBUG_STR(a).str());
 172         }
 173 #endif
 174
 175         if (_size + stamp_size + size >= _capacity) {
 176                 cerr << "MidiBuffer::push_back failed (buffer is full)" << endl;
 177                 return false;
 178         }
 179
 180         if (!Evoral::midi_event_is_valid(data, size)) {
 181                 cerr << "WARNING: MidiBuffer ignoring illegal MIDI event" << endl;
 182                 return false;
 183         }
 184
 185         uint8_t* const write_loc = _data + _size;
 186         *((TimeType*)write_loc) = time;
 187         memcpy(write_loc + stamp_size, data, size);
 188
 189         _size += stamp_size + size;
 190         _silent = false;
 191
 192         return true;
 193 }
 194
 195
 196 /** Push an event into the buffer.
 197  *
 198  * Note that the raw MIDI pointed to by ev will be COPIED and unmodified.
 199  * That is, the caller still owns it, if it needs freeing it's Not My Problem(TM).
 200  * Realtime safe.
 201  * @return false if operation failed (not enough room)
 202  */
 203 bool
 204 MidiBuffer::push_back(const jack_midi_event_t& ev)
 205 {
 206         const size_t stamp_size = sizeof(TimeType);
 207         if (_size + stamp_size + ev.size >= _capacity) {
 208                 cerr << "MidiBuffer::push_back failed (buffer is full)" << endl;
 209                 return false;
 210         }
 211
 212         if (!Evoral::midi_event_is_valid(ev.buffer, ev.size)) {
 213                 cerr << "WARNING: MidiBuffer ignoring illegal MIDI event" << endl;
 214                 return false;
 215         }
 216
 217         uint8_t* const write_loc = _data + _size;
 218         *((TimeType*)write_loc) = ev.time;
 219         memcpy(write_loc + stamp_size, ev.buffer, ev.size);
 220
 221         _size += stamp_size + ev.size;
 222         _silent = false;
 223
 224         return true;
 225 }
 226
 227
 228 /** Reserve space for a new event in the buffer.
 229  *
 230  * This call is for copying MIDI directly into the buffer, the data location
 231  * (of sufficient size to write \a size bytes) is returned, or 0 on failure.
 232  * This call MUST be immediately followed by a write to the returned data
 233  * location, or the buffer will be corrupted and very nasty things will happen.
 234  */
 235 uint8_t*
 236 MidiBuffer::reserve(TimeType time, size_t size)
 237 {
 238         const size_t stamp_size = sizeof(TimeType);
 239         if (_size + stamp_size + size >= _capacity) {
 240                 return 0;
 241         }
 242
 243         // write timestamp
 244         uint8_t* write_loc = _data + _size;
 245         *((TimeType*)write_loc) = time;
 246
 247         // move write_loc to begin of MIDI buffer data to write to
 248         write_loc += stamp_size;
 249
 250         _size += stamp_size + size;
 251         _silent = false;
 252
 253         return write_loc;
 254 }
 255
 256
 257 void
 258 MidiBuffer::silence (framecnt_t /*nframes*/, framecnt_t /*offset*/)
 259 {
 260         /* XXX iterate over existing events, find all in range given by offset & nframes,
 261            and delete them.
 262         */
 263
 264         _size = 0;
 265         _silent = true;
 266 }
 267
 268 /** Merge \a other into this buffer.  Realtime safe. */
 269 bool
 270 MidiBuffer::merge_in_place(const MidiBuffer &other)
 271 {
 272         if (other.size() == 0) {
 273                 return true;
 274         }
 275
 276         if (_size == 0) {
 277                 copy(other);
 278                 return true;
 279         }
 280
 281         if (_size + other.size() > _capacity) {
 282                 cerr << "MidiBuffer::merge failed (no space)" << endl;
 283                 return false;
 284         }
 285
 286 #ifndef NDEBUG
 287 #ifdef  TEST_MIDI_MERGE
 288         size_t   test_orig_us_size   = _size;
 289         size_t   test_orig_them_size = other._size;
 290         TimeType test_time           = 0;
 291         size_t   test_us_count       = 0;
 292         size_t   test_them_count     = 0;
 293         for (iterator i = begin(); i != end(); ++i) {
 294                 assert(Evoral::midi_event_is_valid((*i).buffer(), (*i).size()));
 295                 assert((*i).time() >= test_time);
 296                 test_time = (*i).time();
 297                 ++test_us_count;
 298         }
 299         test_time = 0;
 300         for (const_iterator i = other.begin(); i != other.end(); ++i) {
 301                 assert(Evoral::midi_event_is_valid((*i).buffer(), (*i).size()));
 302                 assert((*i).time() >= test_time);
 303                 test_time = (*i).time();
 304                 ++test_them_count;
 305         }
 306 #endif
 307 #endif
 308
 309         const_iterator them = other.begin();
 310         iterator us = begin();
 311
 312         while (them != other.end()) {
 313
 314                 size_t sz = 0;
 315                 ssize_t src = -1;
 316
 317                 /* gather up total size of events that are earlier than
 318                    the event referenced by "us"
 319                 */
 320
 321                 while (them != other.end() && (*them).time() < (*us).time()) {
 322                         if (src == -1) {
 323                                 src = them.offset;
 324                         }
 325                         sz += sizeof (TimeType) + (*them).size();
 326                         ++them;
 327                 }
 328
 329 #if 0
 330                 if (us != end())
 331                         cerr << "us @ " << (*us).time() << endl;
 332                 if (them != other.end())
 333                         cerr << "them @ " << (*them).time() << endl;
 334 #endif
 335
 336                 if (sz) {
 337                         assert(src >= 0);
 338                         /* move existing */
 339                         memmove (_data + us.offset + sz, _data + us.offset, _size - us.offset);
 340                         /* increase _size */
 341                         _size += sz;
 342                         assert(_size <= _capacity);
 343                         /* insert new stuff */
 344                         memcpy  (_data + us.offset, other._data + src, sz);
 345                         /* update iterator to our own events. this is a miserable hack */
 346                         us.offset += sz;
 347                 } else {
 348
 349                         /* advance past our own events to get to the correct insertion
 350                            point for the next event(s) from "other"
 351                         */
 352
 353                         while (us != end() && (*us).time() < (*them).time()) {
 354                                 ++us;
 355                         }
 356                 }
 357
 358                 if (!(us != end())) {
 359                         /* just append the rest of other */
 360                         memcpy (_data + us.offset, other._data + them.offset, other._size - them.offset);
 361                         _size += other._size - them.offset;
 362                         break;
 363                 }
 364         }
 365
 366 #ifndef NDEBUG
 367 #ifdef  TEST_MIDI_MERGE
 368         assert(_size == test_orig_us_size + test_orig_them_size);
 369         size_t test_final_count = 0;
 370         test_time = 0;
 371         for (iterator i = begin(); i != end(); ++i) {
 372                 // cerr << "CHECK " << test_final_count << " / " << test_us_count + test_them_count << endl;
 373                 assert(Evoral::midi_event_is_valid((*i).buffer(), (*i).size()));
 374                 assert((*i).time() >= test_time);
 375                 test_time = (*i).time();
 376                 ++test_final_count;
 377         }
 378         assert(test_final_count = test_us_count + test_them_count);
 379 #endif
 380 #endif
 381
 382         return true;
 383 }
 384
 385 /** Clear, and merge \a a and \a b into this buffer.
 386  *
 387  * \return true if complete merge was successful
 388  */
 389 bool
 390 MidiBuffer::merge(const MidiBuffer& a, const MidiBuffer& b)
 391 {
 392         _size = 0;
 393
 394         if (this == &a) {
 395             return merge_in_place(b);
 396         } else if (this == &b) {
 397             return merge_in_place(a);
 398         }
 399
 400         const_iterator ai = a.begin();
 401         const_iterator bi = b.begin();
 402
 403         resize(a.size() + b.size());
 404         while (ai != a.end() && bi != b.end()) {
 405                 if ((*ai).time() < (*bi).time()) {
 406                         memcpy(_data + _size, (*ai).buffer(), (*ai).size());
 407                         _size += (*ai).size();
 408                         ++ai;
 409                 } else {
 410                         memcpy(_data + _size, (*bi).buffer(), (*bi).size());
 411                         _size += (*bi).size();
 412                         ++bi;
 413                 }
 414         }
 415
 416         while (ai != a.end()) {
 417                 memcpy(_data + _size, (*ai).buffer(), (*ai).size());
 418                 _size += (*ai).size();
 419                 ++ai;
 420         }
 421
 422         while (bi != b.end()) {
 423                 memcpy(_data + _size, (*bi).buffer(), (*bi).size());
 424                 _size += (*bi).size();
 425                 ++bi;
 426         }
 427
 428         return true;
 429 }
 430