2 Copyright (C) 2006-2008 Paul Davis
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.
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.
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.
19 #include "pbd/compose.h"
20 #include "pbd/enumwriter.h"
21 #include "pbd/error.h"
23 #include "ardour/debug.h"
24 #include "ardour/midi_ring_buffer.h"
25 #include "ardour/midi_buffer.h"
26 #include "ardour/event_type_map.h"
33 /** Read a block of MIDI events from this buffer into a MidiBuffer.
35 * Timestamps of events returned are relative to start (i.e. event with stamp 0
36 * occurred at start), with offset added.
40 MidiRingBuffer<T>::read (MidiBuffer& dst, framepos_t start, framepos_t end, framecnt_t offset, bool stop_on_overflow_in_dst)
42 if (this->read_space() == 0) {
49 const size_t prefix_size = sizeof(T) + sizeof(Evoral::EventType) + sizeof(uint32_t);
51 while (this->read_space() >= prefix_size) {
53 uint8_t peekbuf[prefix_size];
55 /* this cannot fail, because we've already verified that there
56 is prefix_space to read
58 this->peek (peekbuf, prefix_size);
60 ev_time = *(reinterpret_cast<T*>((uintptr_t)peekbuf));
61 ev_size = *(reinterpret_cast<uint32_t*>((uintptr_t)(peekbuf + sizeof(T) + sizeof (Evoral::EventType))));
63 if (this->read_space() < ev_size) {
68 DEBUG_TRACE (DEBUG::MidiRingBuffer, string_compose ("MRB event @ %1 past end @ %2\n", ev_time, end));
70 } else if (ev_time < start) {
71 DEBUG_TRACE (DEBUG::MidiRingBuffer, string_compose ("MRB event @ %1 before start @ %2\n", ev_time, start));
74 DEBUG_TRACE (DEBUG::MidiRingBuffer, string_compose ("MRB event @ %1 in range %2 .. %3\n", ev_time, start, end));
80 /* we're good to go ahead and read the data now but since we
81 * have the prefix data already, just skip over that
83 this->increment_read_ptr (prefix_size);
86 bool r = this->peek (&status, sizeof(uint8_t));
87 assert (r); // If this failed, buffer is corrupt, all hope is lost
89 /* lets see if we are going to be able to write this event into dst.
91 uint8_t* write_loc = dst.reserve (ev_time, ev_size);
93 if (stop_on_overflow_in_dst) {
94 DEBUG_TRACE (DEBUG::MidiRingBuffer, string_compose ("MidiRingBuffer: overflow in destination MIDI buffer, stopped after %1 events\n", count));
97 error << "MRB: Unable to reserve space in buffer, event skipped" << endmsg;
98 this->increment_read_ptr (ev_size); // Advance read pointer to next event
102 // write MIDI buffer contents
104 bool success = read_contents (ev_size, write_loc);
106 if (DEBUG_ENABLED (DEBUG::MidiRingBuffer)) {
108 DEBUG_STR_APPEND(a, string_compose ("wrote MidiEvent to Buffer (time=%1, start=%2 offset=%3) ", ev_time, start, offset));
109 for (size_t i=0; i < ev_size; ++i) {
110 DEBUG_STR_APPEND(a,hex);
111 DEBUG_STR_APPEND(a,"0x");
112 DEBUG_STR_APPEND(a,(int)write_loc[i]);
113 DEBUG_STR_APPEND(a,' ');
115 DEBUG_STR_APPEND(a,'\n');
116 DEBUG_TRACE (DEBUG::MidiRingBuffer, DEBUG_STR(a).str());
120 _tracker.track(write_loc);
123 cerr << "WARNING: error reading event contents from MIDI ring" << endl;
132 MidiRingBuffer<T>::skip_to(framepos_t start)
134 if (this->read_space() == 0) {
141 const size_t prefix_size = sizeof(T) + sizeof(Evoral::EventType) + sizeof(uint32_t);
143 while (this->read_space() >= prefix_size) {
145 uint8_t peekbuf[prefix_size];
146 this->peek (peekbuf, prefix_size);
148 ev_time = *(reinterpret_cast<T*>((uintptr_t)peekbuf));
149 ev_size = *(reinterpret_cast<uint32_t*>((uintptr_t)(peekbuf + sizeof(T) + sizeof (Evoral::EventType))));
151 if (ev_time >= start) {
155 if (this->read_space() < ev_size) {
159 this->increment_read_ptr (prefix_size);
162 bool r = this->peek (&status, sizeof(uint8_t));
163 assert (r); // If this failed, buffer is corrupt, all hope is lost
167 /* TODO investigate and think:
169 * Does it makes sense to keep track of notes
170 * that are skipped (because they're either too late
171 * (underrun) or never used (read-ahead, loop) ?
173 * skip_to() is called on the rinbuffer between
174 * disk and process. it seems wrong to track them
175 * (a potential synth never sees skipped notes, either)
176 * but there may be more to this.
180 this->increment_read_ptr (ev_size);
182 // we only track note on/off, 8 bytes are plenty.
183 uint8_t write_loc[8];
184 bool success = read_contents (ev_size, write_loc);
186 _tracker.track(write_loc);
197 MidiRingBuffer<T>::flush (framepos_t /*start*/, framepos_t end)
199 const size_t prefix_size = sizeof(T) + sizeof(Evoral::EventType) + sizeof(uint32_t);
201 while (this->read_space() >= prefix_size) {
202 uint8_t peekbuf[prefix_size];
207 success = this->peek (peekbuf, prefix_size);
208 /* this cannot fail, because we've already verified that there
209 is prefix_space to read
213 ev_time = *(reinterpret_cast<T*>((uintptr_t)peekbuf));
215 if (ev_time >= end) {
219 ev_size = *(reinterpret_cast<uint32_t*>((uintptr_t)(peekbuf + sizeof(T) + sizeof (Evoral::EventType))));
220 this->increment_read_ptr (prefix_size);
221 this->increment_read_ptr (ev_size);
227 MidiRingBuffer<T>::dump(ostream& str)
231 if ((rspace = this->read_space()) == 0) {
232 str << this << " MRB::dump: empty\n";
237 Evoral::EventType ev_type;
240 RingBufferNPT<uint8_t>::rw_vector vec;
241 RingBufferNPT<uint8_t>::get_read_vector (&vec);
243 if (vec.len[0] == 0) {
247 str << this << ": Dump size = " << vec.len[0] + vec.len[1]
248 << " r@ " << RingBufferNPT<uint8_t>::get_read_ptr()
249 << " w@" << RingBufferNPT<uint8_t>::get_write_ptr() << endl;
252 uint8_t *buf = new uint8_t[vec.len[0] + vec.len[1]];
253 memcpy (buf, vec.buf[0], vec.len[0]);
256 memcpy (buf+vec.len[1], vec.buf[1], vec.len[1]);
260 const uint8_t* end = buf + vec.len[0] + vec.len[1];
264 memcpy (&ev_time, data, sizeof (T));
266 str << "\ttime " << ev_time;
269 str << "(incomplete)\n ";
273 memcpy (&ev_type, data, sizeof (ev_type));
274 data += sizeof (ev_type);
275 str << " type " << ev_type;
278 str << "(incomplete)\n";
282 memcpy (&ev_size, data, sizeof (ev_size));
283 data += sizeof (ev_size);
284 str << " size " << ev_size;
287 str << "(incomplete)\n";
291 for (uint32_t i = 0; i != ev_size && data < end; ++i) {
292 str << ' ' << hex << (int) data[i] << dec;
305 MidiRingBuffer<T>::reset_tracker ()
312 MidiRingBuffer<T>::resolve_tracker (MidiBuffer& dst, framepos_t t)
314 _tracker.resolve_notes (dst, t);
319 MidiRingBuffer<T>::resolve_tracker (Evoral::EventSink<framepos_t>& dst, framepos_t t)
321 _tracker.resolve_notes(dst, t);
324 template class MidiRingBuffer<framepos_t>;
326 } // namespace ARDOUR