2 Copyright (C) 2006-2009 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.
20 #ifndef __ardour_midi_buffer_h__
21 #define __ardour_midi_buffer_h__
23 #include "evoral/midi_util.h"
24 #include "evoral/EventSink.hpp"
26 #include "midi++/event.h"
28 #include "ardour/buffer.h"
29 #include "ardour/parameter_types.h"
34 /** Buffer containing 8-bit unsigned char (MIDI) data. */
35 class LIBARDOUR_API MidiBuffer : public Buffer, public Evoral::EventSink<framepos_t>
38 typedef framepos_t TimeType;
40 MidiBuffer(size_t capacity);
43 void silence (framecnt_t nframes, framecnt_t offset = 0);
44 void read_from (const Buffer& src, framecnt_t nframes, frameoffset_t dst_offset = 0, frameoffset_t src_offset = 0);
45 void merge_from (const Buffer& src, framecnt_t nframes, frameoffset_t dst_offset = 0, frameoffset_t src_offset = 0);
47 void copy(const MidiBuffer& copy);
48 void copy(MidiBuffer const * const);
50 bool push_back(const Evoral::MIDIEvent<TimeType>& event);
51 bool push_back(TimeType time, size_t size, const uint8_t* data);
53 uint8_t* reserve(TimeType time, size_t size);
56 size_t size() const { return _size; }
57 bool empty() const { return _size == 0; }
59 bool insert_event(const Evoral::MIDIEvent<TimeType>& event);
60 bool merge_in_place(const MidiBuffer &other);
62 /** EventSink interface for non-RT use (export, bounce). */
63 uint32_t write(TimeType time, Evoral::EventType type, uint32_t size, const uint8_t* buf);
65 template<typename BufferType, typename EventType>
69 iterator_base<BufferType, EventType>(BufferType& b, framecnt_t o)
70 : buffer(&b), offset(o) {}
72 iterator_base<BufferType, EventType>(const iterator_base<BufferType,EventType>& o)
73 : buffer (o.buffer), offset(o.offset) {}
75 inline iterator_base<BufferType,EventType> operator= (const iterator_base<BufferType,EventType>& o) {
83 inline EventType operator*() const {
84 uint8_t* ev_start = buffer->_data + offset + sizeof(TimeType);
85 int event_size = Evoral::midi_event_size(ev_start);
86 assert(event_size >= 0);
87 return EventType(midi_parameter_type(*ev_start),
88 *((TimeType*)(buffer->_data + offset)),
89 event_size, ev_start);
92 inline EventType operator*() {
93 uint8_t* ev_start = buffer->_data + offset + sizeof(TimeType);
94 int event_size = Evoral::midi_event_size(ev_start);
95 assert(event_size >= 0);
96 return EventType(midi_parameter_type(*ev_start),
97 *(reinterpret_cast<TimeType*>((uintptr_t)(buffer->_data + offset))),
98 event_size, ev_start);
101 inline TimeType * timeptr() {
102 return reinterpret_cast<TimeType*>((uintptr_t)(buffer->_data + offset));
105 inline iterator_base<BufferType, EventType>& operator++() {
106 uint8_t* ev_start = buffer->_data + offset + sizeof(TimeType);
107 int event_size = Evoral::midi_event_size(ev_start);
108 assert(event_size >= 0);
109 offset += sizeof(TimeType) + event_size;
113 inline bool operator!=(const iterator_base<BufferType, EventType>& other) const {
114 return (buffer != other.buffer) || (offset != other.offset);
117 inline bool operator==(const iterator_base<BufferType, EventType>& other) const {
118 return (buffer == other.buffer) && (offset == other.offset);
125 typedef iterator_base< MidiBuffer, Evoral::MIDIEvent<TimeType> > iterator;
126 typedef iterator_base< const MidiBuffer, const Evoral::MIDIEvent<TimeType> > const_iterator;
128 iterator begin() { return iterator(*this, 0); }
129 iterator end() { return iterator(*this, _size); }
131 const_iterator begin() const { return const_iterator(*this, 0); }
132 const_iterator end() const { return const_iterator(*this, _size); }
134 iterator erase(const iterator& i) {
135 assert (i.buffer == this);
136 uint8_t* ev_start = _data + i.offset + sizeof (TimeType);
137 int event_size = Evoral::midi_event_size (ev_start);
139 if (event_size < 0) {
140 /* unknown size, sysex: return end() */
144 size_t total_data_deleted = sizeof(TimeType) + event_size;
146 if (i.offset + total_data_deleted > _size) {
151 /* we need to avoid the temporary malloc that memmove would do,
152 so copy by hand. remember: this is small amounts of data ...
155 for (a = i.offset, b = i.offset + total_data_deleted; b < _size; ++b, ++a) {
159 _size -= total_data_deleted;
161 /* all subsequent iterators are now invalid, and the one we
162 * return should refer to the event we copied, which was after
163 * the one we just erased.
166 return iterator (*this, i.offset);
169 uint8_t* data() const { return _data; }
172 * returns true if the message with the second argument as its MIDI
173 * status byte should preceed the message with the first argument as
174 * its MIDI status byte.
176 static bool second_simultaneous_midi_byte_is_first (uint8_t, uint8_t);
179 friend class iterator_base< MidiBuffer, Evoral::MIDIEvent<TimeType> >;
180 friend class iterator_base< const MidiBuffer, const Evoral::MIDIEvent<TimeType> >;
182 uint8_t* _data; ///< timestamp, event, timestamp, event, ...
186 } // namespace ARDOUR
188 #endif // __ardour_midi_buffer_h__