2 Copyright (C) 2006 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 #ifndef __ardour_midi_ring_buffer_h__
20 #define __ardour_midi_ring_buffer_h__
25 #include "ardour/event_ring_buffer.h"
26 #include "ardour/libardour_visibility.h"
27 #include "ardour/types.h"
28 #include "ardour/midi_state_tracker.h"
34 /** A RingBuffer for (MIDI) events.
36 * This is simply a wrapper around a raw ringbuffer which writes/reads events
37 * as flat placked blobs.
38 * The buffer looks like this:
40 * [timestamp][type][size][size bytes of raw MIDI][timestamp][type][size](etc...)
43 class /*LIBARDOUR_API*/ MidiRingBuffer : public EventRingBuffer<T> {
45 /** @param size Size in bytes. */
46 MidiRingBuffer(size_t size) : EventRingBuffer<T>(size) {}
48 inline bool read_prefix(T* time, Evoral::EventType* type, uint32_t* size);
49 inline bool read_contents(uint32_t size, uint8_t* buf);
51 size_t read(MidiBuffer& dst, framepos_t start, framepos_t end, framecnt_t offset=0, bool stop_on_overflow_in_destination=false);
52 size_t skip_to(framepos_t start);
54 void dump(std::ostream& dst);
55 void flush (framepos_t start, framepos_t end);
57 void reset_tracker ();
58 void resolve_tracker (MidiBuffer& dst, framepos_t);
59 void resolve_tracker (Evoral::EventSink<framepos_t>& dst, framepos_t);
62 MidiStateTracker _tracker;
66 /** Read the time and size of an event. This call MUST be immediately proceeded
67 * by a call to read_contents (or the read pointer will be garbage).
71 MidiRingBuffer<T>::read_prefix(T* time, Evoral::EventType* type, uint32_t* size)
73 if (PBD::RingBufferNPT<uint8_t>::read((uint8_t*)time, sizeof(T)) != sizeof (T)) {
77 if (PBD::RingBufferNPT<uint8_t>::read((uint8_t*)type, sizeof(Evoral::EventType)) != sizeof (Evoral::EventType)) {
81 if (PBD::RingBufferNPT<uint8_t>::read((uint8_t*)size, sizeof(uint32_t)) != sizeof (uint32_t)) {
89 /** Read the content of an event. This call MUST be immediately preceded
90 * by a call to read_prefix (or the returned even will be garbage).
94 MidiRingBuffer<T>::read_contents(uint32_t size, uint8_t* buf)
96 return PBD::RingBufferNPT<uint8_t>::read(buf, size) == size;
101 #endif // __ardour_midi_ring_buffer_h__