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, framecnt_t dst_offset = 0, framecnt_t src_offset = 0);
45 void merge_from (const Buffer& src, framecnt_t nframes, framecnt_t dst_offset = 0, framecnt_t src_offset = 0);
47 void copy(const MidiBuffer& copy);
49 bool push_back(const Evoral::MIDIEvent<TimeType>& event);
50 bool push_back(TimeType time, size_t size, const uint8_t* data);
52 uint8_t* reserve(TimeType time, size_t size);
55 size_t size() const { return _size; }
56 bool empty() const { return _size == 0; }
58 bool insert_event(const Evoral::MIDIEvent<TimeType>& event);
59 bool merge_in_place(const MidiBuffer &other);
61 /** EventSink interface for non-RT use (export, bounce). */
62 uint32_t write(TimeType time, Evoral::EventType type, uint32_t size, const uint8_t* buf);
64 template<typename BufferType, typename EventType>
68 iterator_base<BufferType, EventType>(BufferType& b, framecnt_t o)
69 : buffer(&b), offset(o) {}
71 iterator_base<BufferType, EventType>(const iterator_base<BufferType,EventType>& o)
72 : buffer (o.buffer), offset(o.offset) {}
74 inline iterator_base<BufferType,EventType> operator= (const iterator_base<BufferType,EventType>& o) {
82 inline EventType operator*() const {
83 uint8_t* ev_start = buffer->_data + offset + sizeof(TimeType);
84 int event_size = Evoral::midi_event_size(ev_start);
85 assert(event_size >= 0);
86 return EventType(midi_parameter_type(*ev_start),
87 *((TimeType*)(buffer->_data + offset)),
88 event_size, ev_start);
91 inline EventType operator*() {
92 uint8_t* ev_start = buffer->_data + offset + sizeof(TimeType);
93 int event_size = Evoral::midi_event_size(ev_start);
94 assert(event_size >= 0);
95 return EventType(midi_parameter_type(*ev_start),
96 *(reinterpret_cast<TimeType*>((uintptr_t)(buffer->_data + offset))),
97 event_size, ev_start);
100 inline TimeType * timeptr() {
101 return reinterpret_cast<TimeType*>((uintptr_t)(buffer->_data + offset));
104 inline iterator_base<BufferType, EventType>& operator++() {
105 uint8_t* ev_start = buffer->_data + offset + sizeof(TimeType);
106 int event_size = Evoral::midi_event_size(ev_start);
107 assert(event_size >= 0);
108 offset += sizeof(TimeType) + event_size;
112 inline bool operator!=(const iterator_base<BufferType, EventType>& other) const {
113 return (buffer != other.buffer) || (offset != other.offset);
116 inline bool operator==(const iterator_base<BufferType, EventType>& other) const {
117 return (buffer == other.buffer) && (offset == other.offset);
124 typedef iterator_base< MidiBuffer, Evoral::MIDIEvent<TimeType> > iterator;
125 typedef iterator_base< const MidiBuffer, const Evoral::MIDIEvent<TimeType> > const_iterator;
127 iterator begin() { return iterator(*this, 0); }
128 iterator end() { return iterator(*this, _size); }
130 const_iterator begin() const { return const_iterator(*this, 0); }
131 const_iterator end() const { return const_iterator(*this, _size); }
133 iterator erase(const iterator& i) {
134 assert (i.buffer == this);
135 uint8_t* ev_start = _data + i.offset + sizeof (TimeType);
136 int event_size = Evoral::midi_event_size (ev_start);
138 if (event_size < 0) {
139 /* unknown size, sysex: return end() */
143 size_t total_data_deleted = sizeof(TimeType) + event_size;
145 if (i.offset + total_data_deleted > _size) {
150 /* we need to avoid the temporary malloc that memmove would do,
151 so copy by hand. remember: this is small amounts of data ...
154 for (a = i.offset, b = i.offset + total_data_deleted; b < _size; ++b, ++a) {
158 _size -= total_data_deleted;
160 /* all subsequent iterators are now invalid, and the one we
161 * return should refer to the event we copied, which was after
162 * the one we just erased.
165 return iterator (*this, i.offset);
168 uint8_t* data() const { return _data; }
171 * returns true if the message with the second argument as its MIDI
172 * status byte should preceed the message with the first argument as
173 * its MIDI status byte.
175 static bool second_simultaneous_midi_byte_is_first (uint8_t, uint8_t);
178 friend class iterator_base< MidiBuffer, Evoral::MIDIEvent<TimeType> >;
179 friend class iterator_base< const MidiBuffer, const Evoral::MIDIEvent<TimeType> >;
181 uint8_t* _data; ///< timestamp, event, timestamp, event, ...
185 } // namespace ARDOUR
187 #endif // __ardour_midi_buffer_h__