2 Copyright (C) 2006-2007 Paul Davis
3 Author: David Robillard
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)
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
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.
22 #include "pbd/malign.h"
23 #include "pbd/compose.h"
24 #include "pbd/debug.h"
25 #include "pbd/stacktrace.h"
27 #include "ardour/debug.h"
28 #include "ardour/midi_buffer.h"
31 using namespace ARDOUR;
34 // FIXME: mirroring for MIDI buffers?
35 MidiBuffer::MidiBuffer(size_t capacity)
36 : Buffer (DataType::MIDI)
45 MidiBuffer::~MidiBuffer()
51 MidiBuffer::resize(size_t size)
53 if (_data && size < _capacity) {
65 cache_aligned_malloc ((void**) &_data, size);
74 MidiBuffer::copy(const MidiBuffer& copy)
76 assert(_capacity >= copy._size);
78 memcpy(_data, copy._data, copy._size);
82 /** Read events from @a src starting at time @a offset into the START of this buffer, for
83 * time duration @a nframes. Relative time, where 0 = start of buffer.
85 * Note that offset and nframes refer to sample time, NOT buffer offsets or event counts.
88 MidiBuffer::read_from (const Buffer& src, framecnt_t nframes, framecnt_t dst_offset, framecnt_t src_offset)
90 assert (src.type() == DataType::MIDI);
91 assert (&src != this);
93 const MidiBuffer& msrc = (const MidiBuffer&) src;
95 assert (_capacity >= msrc.size());
97 if (dst_offset == 0) {
102 /* XXX use dst_offset somehow */
104 for (MidiBuffer::const_iterator i = msrc.begin(); i != msrc.end(); ++i) {
105 const Evoral::MIDIEvent<TimeType> ev(*i, false);
106 if (ev.time() >= src_offset && ev.time() < (nframes+src_offset)) {
109 cerr << "MIDI event @ " << ev.time() << " skipped, not within range "
110 << src_offset << " .. " << (nframes + src_offset) << endl;
114 _silent = src.silent();
118 MidiBuffer::merge_from (const Buffer& src, framecnt_t /*nframes*/, framecnt_t /*dst_offset*/, framecnt_t /*src_offset*/)
120 const MidiBuffer* mbuf = dynamic_cast<const MidiBuffer*>(&src);
122 assert (mbuf != this);
124 /* XXX use nframes, and possible offsets */
125 merge_in_place (*mbuf);
128 /** Push an event into the buffer.
130 * Note that the raw MIDI pointed to by ev will be COPIED and unmodified.
131 * That is, the caller still owns it, if it needs freeing it's Not My Problem(TM).
133 * @return false if operation failed (not enough room)
136 MidiBuffer::push_back(const Evoral::MIDIEvent<TimeType>& ev)
138 const size_t stamp_size = sizeof(TimeType);
140 if (_size + stamp_size + ev.size() >= _capacity) {
141 cerr << "MidiBuffer::push_back failed (buffer is full)" << endl;
142 PBD::stacktrace (cerr, 20);
146 if (!Evoral::midi_event_is_valid(ev.buffer(), ev.size())) {
147 cerr << "WARNING: MidiBuffer ignoring illegal MIDI event" << endl;
151 push_back(ev.time(), ev.size(), ev.buffer());
157 /** Push an event into the buffer.
158 * @return false if operation failed (not enough room)
161 MidiBuffer::push_back(TimeType time, size_t size, const uint8_t* data)
163 const size_t stamp_size = sizeof(TimeType);
166 if (DEBUG_ENABLED(DEBUG::MidiIO)) {
168 DEBUG_STR_APPEND(a, string_compose ("midibuffer %1 push event @ %2 sz %3 ", this, time, size));
169 for (size_t i=0; i < size; ++i) {
170 DEBUG_STR_APPEND(a,hex);
171 DEBUG_STR_APPEND(a,"0x");
172 DEBUG_STR_APPEND(a,(int)data[i]);
173 DEBUG_STR_APPEND(a,' ');
175 DEBUG_STR_APPEND(a,'\n');
176 DEBUG_TRACE (DEBUG::MidiIO, DEBUG_STR(a).str());
180 if (_size + stamp_size + size >= _capacity) {
181 cerr << "MidiBuffer::push_back2 failed (buffer is full; _size = " << _size << " capacity "
182 << _capacity << " stamp " << stamp_size << " size = " << size << ")" << endl;
183 PBD::stacktrace (cerr, 20);
187 if (!Evoral::midi_event_is_valid(data, size)) {
188 cerr << "WARNING: MidiBuffer ignoring illegal MIDI event" << endl;
192 uint8_t* const write_loc = _data + _size;
193 *(reinterpret_cast<TimeType*>((uintptr_t)write_loc)) = time;
194 memcpy(write_loc + stamp_size, data, size);
196 _size += stamp_size + size;
203 MidiBuffer::insert_event(const Evoral::MIDIEvent<TimeType>& ev)
206 return push_back(ev);
209 const size_t stamp_size = sizeof(TimeType);
210 const size_t bytes_to_merge = stamp_size + ev.size();
212 if (_size + bytes_to_merge >= _capacity) {
213 cerr << "MidiBuffer::push_back failed (buffer is full)" << endl;
214 PBD::stacktrace (cerr, 20);
218 TimeType t = ev.time();
220 ssize_t insert_offset = -1;
221 for (MidiBuffer::iterator m = begin(); m != end(); ++m) {
222 if ((*m).time() < t) {
225 if ((*m).time() == t) {
226 const uint8_t our_midi_status_byte = *(_data + m.offset + sizeof (TimeType));
227 if (second_simultaneous_midi_byte_is_first (ev.type(), our_midi_status_byte)) {
231 insert_offset = m.offset;
234 if (insert_offset == -1) {
235 return push_back(ev);
238 // don't use memmove - it may use malloc(!)
239 // memmove (_data + insert_offset + bytes_to_merge, _data + insert_offset, _size - insert_offset);
240 for (ssize_t a = _size + bytes_to_merge - 1, b = _size - 1; b >= insert_offset; --b, --a) {
244 uint8_t* const write_loc = _data + insert_offset;
245 *(reinterpret_cast<TimeType*>((uintptr_t)write_loc)) = t;
246 memcpy(write_loc + stamp_size, ev.buffer(), ev.size());
248 _size += bytes_to_merge;
254 MidiBuffer::write(TimeType time, Evoral::EventType type, uint32_t size, const uint8_t* buf)
256 insert_event(Evoral::MIDIEvent<TimeType>(type, time, size, const_cast<uint8_t*>(buf)));
260 /** Reserve space for a new event in the buffer.
262 * This call is for copying MIDI directly into the buffer, the data location
263 * (of sufficient size to write \a size bytes) is returned, or 0 on failure.
264 * This call MUST be immediately followed by a write to the returned data
265 * location, or the buffer will be corrupted and very nasty things will happen.
268 MidiBuffer::reserve(TimeType time, size_t size)
270 const size_t stamp_size = sizeof(TimeType);
271 if (_size + stamp_size + size >= _capacity) {
276 uint8_t* write_loc = _data + _size;
277 *(reinterpret_cast<TimeType*>((uintptr_t)write_loc)) = time;
279 // move write_loc to begin of MIDI buffer data to write to
280 write_loc += stamp_size;
282 _size += stamp_size + size;
290 MidiBuffer::silence (framecnt_t /*nframes*/, framecnt_t /*offset*/)
292 /* XXX iterate over existing events, find all in range given by offset & nframes,
301 MidiBuffer::second_simultaneous_midi_byte_is_first (uint8_t a, uint8_t b)
303 bool b_first = false;
305 /* two events at identical times. we need to determine
306 the order in which they should occur.
319 if ((a) >= 0xf0 || (b) >= 0xf0 || ((a & 0xf) != (b & 0xf))) {
321 /* if either message is not a channel message, or if the channels are
322 * different, we don't care about the type.
330 case MIDI_CMD_CONTROL:
334 case MIDI_CMD_PGM_CHANGE:
336 case MIDI_CMD_CONTROL:
338 case MIDI_CMD_PGM_CHANGE:
339 case MIDI_CMD_NOTE_OFF:
340 case MIDI_CMD_NOTE_ON:
341 case MIDI_CMD_NOTE_PRESSURE:
342 case MIDI_CMD_CHANNEL_PRESSURE:
343 case MIDI_CMD_BENDER:
348 case MIDI_CMD_NOTE_OFF:
350 case MIDI_CMD_CONTROL:
351 case MIDI_CMD_PGM_CHANGE:
353 case MIDI_CMD_NOTE_OFF:
354 case MIDI_CMD_NOTE_ON:
355 case MIDI_CMD_NOTE_PRESSURE:
356 case MIDI_CMD_CHANNEL_PRESSURE:
357 case MIDI_CMD_BENDER:
362 case MIDI_CMD_NOTE_ON:
364 case MIDI_CMD_CONTROL:
365 case MIDI_CMD_PGM_CHANGE:
366 case MIDI_CMD_NOTE_OFF:
368 case MIDI_CMD_NOTE_ON:
369 case MIDI_CMD_NOTE_PRESSURE:
370 case MIDI_CMD_CHANNEL_PRESSURE:
371 case MIDI_CMD_BENDER:
375 case MIDI_CMD_NOTE_PRESSURE:
377 case MIDI_CMD_CONTROL:
378 case MIDI_CMD_PGM_CHANGE:
379 case MIDI_CMD_NOTE_OFF:
380 case MIDI_CMD_NOTE_ON:
382 case MIDI_CMD_NOTE_PRESSURE:
383 case MIDI_CMD_CHANNEL_PRESSURE:
384 case MIDI_CMD_BENDER:
389 case MIDI_CMD_CHANNEL_PRESSURE:
391 case MIDI_CMD_CONTROL:
392 case MIDI_CMD_PGM_CHANGE:
393 case MIDI_CMD_NOTE_OFF:
394 case MIDI_CMD_NOTE_ON:
395 case MIDI_CMD_NOTE_PRESSURE:
397 case MIDI_CMD_CHANNEL_PRESSURE:
398 case MIDI_CMD_BENDER:
402 case MIDI_CMD_BENDER:
404 case MIDI_CMD_CONTROL:
405 case MIDI_CMD_PGM_CHANGE:
406 case MIDI_CMD_NOTE_OFF:
407 case MIDI_CMD_NOTE_ON:
408 case MIDI_CMD_NOTE_PRESSURE:
409 case MIDI_CMD_CHANNEL_PRESSURE:
411 case MIDI_CMD_BENDER:
421 /** Merge \a other into this buffer. Realtime safe. */
423 MidiBuffer::merge_in_place (const MidiBuffer &other)
425 if (other.size() && size()) {
426 DEBUG_TRACE (DEBUG::MidiIO, string_compose ("merge in place, sizes %1/%2\n", size(), other.size()));
429 if (other.size() == 0) {
438 if (size() + other.size() > _capacity) {
442 const_iterator them = other.begin();
443 iterator us = begin();
445 while (them != other.end()) {
447 size_t bytes_to_merge;
448 ssize_t merge_offset;
450 /* gather up total size of events that are earlier than
451 the event referenced by "us"
457 while (them != other.end() && (*them).time() < (*us).time()) {
458 if (merge_offset == -1) {
459 merge_offset = them.offset;
461 bytes_to_merge += sizeof (TimeType) + (*them).size();
465 /* "them" now points to either:
467 * 1) an event that has the same or later timestamp than the
468 * event pointed to by "us"
472 * 2) the end of the "other" buffer
474 * if "sz" is non-zero, there is data to be merged from "other"
475 * into this buffer before we do anything else, corresponding
476 * to the events from "other" that we skipped while advancing
480 if (bytes_to_merge) {
481 assert(merge_offset >= 0);
483 memmove (_data + us.offset + bytes_to_merge, _data + us.offset, _size - us.offset);
485 _size += bytes_to_merge;
486 assert (_size <= _capacity);
487 /* insert new stuff */
488 memcpy (_data + us.offset, other._data + merge_offset, bytes_to_merge);
489 /* update iterator to our own events. this is a miserable hack */
490 us.offset += bytes_to_merge;
493 /* if we're at the end of the other buffer, we're done */
495 if (them == other.end()) {
499 /* if we have two messages messages with the same timestamp. we
500 * must order them correctly.
503 if ((*us).time() == (*them).time()) {
505 DEBUG_TRACE (DEBUG::MidiIO,
506 string_compose ("simultaneous MIDI events discovered during merge, times %1/%2 status %3/%4\n",
507 (*us).time(), (*them).time(),
508 (int) *(_data + us.offset + sizeof (TimeType)),
509 (int) *(other._data + them.offset + sizeof (TimeType))));
511 uint8_t our_midi_status_byte = *(_data + us.offset + sizeof (TimeType));
512 uint8_t their_midi_status_byte = *(other._data + them.offset + sizeof (TimeType));
513 bool them_first = second_simultaneous_midi_byte_is_first (our_midi_status_byte, their_midi_status_byte);
515 DEBUG_TRACE (DEBUG::MidiIO, string_compose ("other message came first ? %1\n", them_first));
518 /* skip past our own event */
522 bytes_to_merge = sizeof (TimeType) + (*them).size();
524 /* move our remaining events later in the buffer by
525 * enough to fit the one message we're going to merge
528 memmove (_data + us.offset + bytes_to_merge, _data + us.offset, _size - us.offset);
530 _size += bytes_to_merge;
531 assert(_size <= _capacity);
532 /* insert new stuff */
533 memcpy (_data + us.offset, other._data + them.offset, bytes_to_merge);
534 /* update iterator to our own events. this is a miserable hack */
535 us.offset += bytes_to_merge;
536 /* 'us' is now an iterator to the event right after the
537 new ones that we merged
540 /* need to skip the event pointed to by 'us'
541 since its at the same time as 'them'
542 (still), and we'll enter
550 /* we merged one event from the other buffer, so
551 * advance the iterator there.
558 /* advance past our own events to get to the correct insertion
559 point for the next event(s) from "other"
562 while (us != end() && (*us).time() <= (*them).time()) {
567 /* check to see if we reached the end of this buffer while
568 * looking for the insertion point.
573 /* just append the rest of other and we're done*/
575 memcpy (_data + us.offset, other._data + them.offset, other._size - them.offset);
576 _size += other._size - them.offset;
577 assert(_size <= _capacity);