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_NOTE_HPP
20 #define EVORAL_NOTE_HPP
24 #include "evoral/MIDIEvent.hpp"
28 /** An abstract (protocol agnostic) note.
30 * Currently a note is defined as (on event, length, off event).
32 template<typename Time>
35 Note(uint8_t chan=0, Time time=0, Time len=0, uint8_t note=0, uint8_t vel=0x40);
36 Note(const Note<Time>& copy);
39 const Note<Time>& operator=(const Note<Time>& copy);
41 inline bool operator==(const Note<Time>& other) {
42 return musical_time_equal (time(), other.time()) &&
43 note() == other.note() &&
44 musical_time_equal (length(), other.length()) &&
45 velocity() == other.velocity() &&
46 off_velocity() == other.off_velocity() &&
47 channel() == other.channel();
50 inline event_id_t id() const { return _on_event.id(); }
51 void set_id (event_id_t);
53 inline Time time() const { return _on_event.time(); }
54 inline Time end_time() const { return _off_event.time(); }
55 inline uint8_t note() const { return _on_event.note(); }
56 inline uint8_t velocity() const { return _on_event.velocity(); }
57 inline uint8_t off_velocity() const { return _off_event.velocity(); }
58 inline Time length() const { return _off_event.time() - _on_event.time(); }
59 inline uint8_t channel() const {
60 assert(_on_event.channel() == _off_event.channel());
61 return _on_event.channel();
64 inline void set_time(Time t) { _off_event.time() = t + length(); _on_event.time() = t; }
65 inline void set_note(uint8_t n) { _on_event.buffer()[1] = n; _off_event.buffer()[1] = n; }
66 inline void set_velocity(uint8_t n) { _on_event.buffer()[2] = n; }
67 inline void set_off_velocity(uint8_t n) { _off_event.buffer()[2] = n; }
68 inline void set_length(Time l) { _off_event.time() = _on_event.time() + l; }
69 inline void set_channel(uint8_t c) { _on_event.set_channel(c); _off_event.set_channel(c); }
71 inline Event<Time>& on_event() { return _on_event; }
72 inline const Event<Time>& on_event() const { return _on_event; }
73 inline Event<Time>& off_event() { return _off_event; }
74 inline const Event<Time>& off_event() const { return _off_event; }
77 // Event buffers are self-contained
78 MIDIEvent<Time> _on_event;
79 MIDIEvent<Time> _off_event;
84 template<typename Time>
85 std::ostream& operator<<(std::ostream& o, const Evoral::Note<Time>& n) {
86 o << "Note #" << n.id() << ": pitch = " << (int) n.note()
87 << " @ " << n.time() << " .. " << n.end_time()
88 << " velocity " << (int) n.velocity()
89 << " chn " << (int) n.channel();
93 #endif // EVORAL_NOTE_HPP