1 /* This file is part of Evoral.
2 * Copyright (C) 2008 David 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
26 #include "evoral/visibility.h"
27 #include "evoral/MIDIEvent.hpp"
31 /** An abstract (protocol agnostic) note.
33 * Currently a note is defined as (on event, length, off event).
35 template<typename Time>
37 class LIBEVORAL_LOCAL Note {
39 class LIBEVORAL_TEMPLATE_API Note {
42 Note(uint8_t chan=0, Time time=Time(), Time len=Time(), uint8_t note=0, uint8_t vel=0x40);
43 Note(const Note<Time>& copy);
46 const Note<Time>& operator=(const Note<Time>& copy);
48 inline bool operator==(const Note<Time>& other) {
49 return time() == other.time() &&
50 note() == other.note() &&
51 length() == other.length() &&
52 velocity() == other.velocity() &&
53 off_velocity() == other.off_velocity() &&
54 channel() == other.channel();
57 inline event_id_t id() const { return _on_event.id(); }
58 void set_id (event_id_t);
60 inline Time time() const { return _on_event.time(); }
61 inline Time end_time() const { return _off_event.time(); }
62 inline uint8_t note() const { return _on_event.note(); }
63 inline uint8_t velocity() const { return _on_event.velocity(); }
64 inline uint8_t off_velocity() const { return _off_event.velocity(); }
65 inline Time length() const { return _off_event.time() - _on_event.time(); }
66 inline uint8_t channel() const {
67 assert(_on_event.channel() == _off_event.channel());
68 return _on_event.channel();
72 inline int clamp(int val, int low, int high) {
73 return std::min (std::max (val, low), high);
77 inline void set_time(Time t) {
78 _off_event.set_time(t + length());
79 _on_event.set_time(t);
81 inline void set_note(uint8_t n) {
82 const uint8_t nn = clamp(n, 0, 127);
83 _on_event.buffer()[1] = nn;
84 _off_event.buffer()[1] = nn;
86 inline void set_velocity(uint8_t n) {
87 _on_event.buffer()[2] = clamp(n, 0, 127);
89 inline void set_off_velocity(uint8_t n) {
90 _off_event.buffer()[2] = clamp(n, 0, 127);
92 inline void set_length(Time l) {
93 _off_event.set_time(_on_event.time() + l);
95 inline void set_channel(uint8_t c) {
96 const uint8_t cc = clamp(c, 0, 16);
97 _on_event.set_channel(cc);
98 _off_event.set_channel(cc);
101 inline Event<Time>& on_event() { return _on_event; }
102 inline const Event<Time>& on_event() const { return _on_event; }
103 inline Event<Time>& off_event() { return _off_event; }
104 inline const Event<Time>& off_event() const { return _off_event; }
107 // Event buffers are self-contained
108 MIDIEvent<Time> _on_event;
109 MIDIEvent<Time> _off_event;
112 template<typename Time>
113 /*LIBEVORAL_API*/ std::ostream& operator<<(std::ostream& o, const Evoral::Note<Time>& n) {
114 o << "Note #" << n.id() << ": pitch = " << (int) n.note()
115 << " @ " << n.time() << " .. " << n.end_time()
116 << " velocity " << (int) n.velocity()
117 << " chn " << (int) n.channel();
121 } // namespace Evoral
124 #include "../src/Note.impl"
127 #endif // EVORAL_NOTE_HPP