1 /* This file is part of Evoral.
2 * Copyright (C) 2008 Dave Robillard <http://drobilla.net>
3 * Copyright (C) 2000-2008 Paul Davis
5 * Evoral is free software; you can redistribute it and/or modify it under the
6 * terms of the GNU General Public License as published by the Free Software
7 * Foundation; either version 2 of the License, or (at your option) any later
10 * Evoral is distributed in the hope that it will be useful, but WITHOUT ANY
11 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 #ifndef EVORAL_EVENT_HPP
20 #define EVORAL_EVENT_HPP
27 #include "evoral/types.hpp"
30 /** If this is not defined, all methods of MidiEvent are RT safe
31 * but MidiEvent will never deep copy and (depending on the scenario)
32 * may not be usable in STL containers, signals, etc.
34 #define EVORAL_EVENT_ALLOC 1
39 /** An event (much like a type generic jack_midi_event_t)
41 * Template parameter Time is the type of the time stamp used for this event.
43 template<typename Time>
45 #ifdef EVORAL_EVENT_ALLOC
46 Event(EventType type=0, Time time=0, uint32_t size=0, uint8_t* buf=NULL, bool alloc=false);
50 * If \a alloc is true, the buffer will be copied and this method
51 * is NOT REALTIME SAFE. Otherwise both events share a buffer and
52 * memory management semantics are the caller's problem.
54 Event(const Event& copy, bool alloc);
58 inline const Event& operator=(const Event& copy) {
60 _original_time = copy._original_time;
61 _nominal_time = copy._nominal_time;
64 if (copy._size > _size) {
65 _buf = (uint8_t*)::realloc(_buf, copy._size);
67 memcpy(_buf, copy._buf, copy._size);
80 inline void shallow_copy(const Event& copy) {
88 _original_time = copy._nominal_time;
89 _nominal_time = copy._nominal_time;
94 inline void set(uint8_t* buf, uint32_t size, Time t) {
97 _buf = (uint8_t*) ::realloc(_buf, size);
99 memcpy (_buf, buf, size);
109 inline bool operator==(const Event& other) const {
110 if (_type != other._type)
113 if (_nominal_time != other._nominal_time)
116 if (_original_time != other._original_time)
119 if (_size != other._size)
122 if (_buf == other._buf)
125 for (uint32_t i=0; i < _size; ++i)
126 if (_buf[i] != other._buf[i])
132 inline bool operator!=(const Event& other) const { return ! operator==(other); }
134 inline bool owns_buffer() const { return _owns_buf; }
136 inline void set_buffer(uint32_t size, uint8_t* buf, bool own) {
146 inline void realloc(uint32_t size) {
149 _buf = (uint8_t*) ::realloc(_buf, size);
151 _buf = (uint8_t*) ::malloc(size);
158 inline void clear() {
168 inline void set_buffer(uint8_t* buf) { _buf = buf; }
170 #endif // EVORAL_EVENT_ALLOC
172 inline EventType event_type() const { return _type; }
173 inline void set_event_type(EventType t) { _type = t; }
174 inline Time time() const { return _nominal_time; }
175 inline Time& time() { return _nominal_time; }
176 inline Time original_time() const { return _original_time; }
177 inline Time& original_time() { return _original_time; }
178 inline uint32_t size() const { return _size; }
179 inline uint32_t& size() { return _size; }
181 inline const uint8_t* buffer() const { return _buf; }
182 inline uint8_t*& buffer() { return _buf; }
185 EventType _type; /**< Type of event (application relative, NOT MIDI 'type') */
186 Time _original_time; /**< Sample index (or beat time) at which event is valid */
187 Time _nominal_time; /**< Quantized version of _time, used in preference */
188 uint32_t _size; /**< Number of uint8_ts of data in \a buffer */
189 uint8_t* _buf; /**< Raw MIDI data */
191 #ifdef EVORAL_EVENT_ALLOC
192 bool _owns_buf; /**< Whether buffer is locally allocated */
197 } // namespace Evoral
200 template<typename Time>
201 std::ostream& operator<<(std::ostream& o, const Evoral::Event<Time>& ev) {
202 o << "Event type = " << ev.event_type() << " @ " << ev.time();
204 for (uint32_t n = 0; n < ev.size(); ++n) {
205 o << ' ' << (int) ev.buffer()[n];
212 #endif // EVORAL_EVENT_HPP