Make (MIDI) event time stamp type a template parameter.
[ardour.git] / libs / ardour / ardour / midi_buffer.h
1 /*
2     Copyright (C) 2006-2009 Paul Davis 
3     Author: Dave Robillard
4     
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)
8     any later version.
9     
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
13     for more details.
14     
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.
18 */
19
20 #ifndef __ardour_midi_buffer_h__
21 #define __ardour_midi_buffer_h__
22
23 #include <evoral/midi_util.h>
24 #include <midi++/event.h>
25 #include <ardour/buffer.h>
26 #include <ardour/event_type_map.h>
27
28 namespace ARDOUR {
29
30
31 /** Buffer containing 8-bit unsigned char (MIDI) data. */
32 class MidiBuffer : public Buffer
33 {
34 public:
35         typedef double TimeType;
36
37         MidiBuffer(size_t capacity);
38         ~MidiBuffer();
39
40         void silence(nframes_t dur, nframes_t offset=0);
41         
42         void read_from(const Buffer& src, nframes_t nframes, nframes_t offset);
43         
44         void copy(const MidiBuffer& copy);
45
46         bool     push_back(const Evoral::MIDIEvent<TimeType>& event);
47         bool     push_back(const jack_midi_event_t& event);
48         uint8_t* reserve(double time, size_t size);
49
50         void resize(size_t);
51
52         bool merge(const MidiBuffer& a, const MidiBuffer& b);
53         bool merge_in_place(const MidiBuffer &other);
54         
55         template<typename B, typename E>
56         struct iterator_base {
57                 iterator_base<B,E>(B& b, size_t o) : buffer(b), offset(o) {}
58                 inline E operator*() const {
59                         uint8_t* ev_start = buffer._data + offset + sizeof(TimeType);
60                         return E(EventTypeMap::instance().midi_event_type(*ev_start),
61                                         *(TimeType*)(buffer._data + offset),
62                                         Evoral::midi_event_size(*ev_start) + 1, ev_start);
63                 }
64                 inline iterator_base<B,E>& operator++() {
65                         uint8_t* ev_start = buffer._data + offset + sizeof(TimeType);
66                         offset += sizeof(TimeType) + Evoral::midi_event_size(*ev_start) + 1;
67                         return *this;
68                 }
69                 inline bool operator!=(const iterator_base<B,E>& other) const {
70                         return (&buffer != &other.buffer) || (offset != other.offset);
71                 }
72                 B&     buffer;
73                 size_t offset;
74         };
75         
76         typedef iterator_base< MidiBuffer, Evoral::MIDIEvent<TimeType> >             iterator;
77         typedef iterator_base< const MidiBuffer, const Evoral::MIDIEvent<TimeType> > const_iterator;
78
79         iterator begin() { return iterator(*this, 0); }
80         iterator end()   { return iterator(*this, _size); }
81
82         const_iterator begin() const { return const_iterator(*this, 0); }
83         const_iterator end()   const { return const_iterator(*this, _size); }
84
85 private:
86         friend class iterator_base< MidiBuffer, Evoral::MIDIEvent<TimeType> >;
87         friend class iterator_base< const MidiBuffer, const Evoral::MIDIEvent<TimeType> >;
88         
89         size_t   _size; ///< Size in bytes of used portion of _data
90         uint8_t* _data; ///< timestamp, event, timestamp, event, ...
91 };
92
93
94 } // namespace ARDOUR
95
96 #endif // __ardour_midi_buffer_h__