libs/evoral/evoral/Note.hpp

   1 /* This file is part of Evoral.
   2  * Copyright (C) 2008 Dave Robillard <http://drobilla.net>
   3  * Copyright (C) 2000-2008 Paul Davis
   4  *
   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
   8  * version.
   9  *
  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.
  13  *
  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
  17  */
  18
  19 #ifndef EVORAL_NOTE_HPP
  20 #define EVORAL_NOTE_HPP
  21
  22 #include <stdint.h>
  23 #include "evoral/MIDIEvent.hpp"
  24
  25 namespace Evoral {
  26
  27 /** An abstract (protocol agnostic) note.
  28  *
  29  * Currently a note is defined as (on event, length, off event).
  30  */
  31 template<typename Time>
  32 class Note {
  33 public:
  34         Note(uint8_t chan=0, Time time=0, Time len=0, uint8_t note=0, uint8_t vel=0x40);
  35         Note(const Note<Time>& copy);
  36         ~Note();
  37
  38         const Note<Time>& operator=(const Note<Time>& copy);
  39
  40         inline bool operator==(const Note<Time>& other) {
  41                 return musical_time_equal (time(), other.time()) &&
  42                         note() == other.note() &&
  43                         musical_time_equal (length(), other.length()) &&
  44                         velocity() == other.velocity() &&
  45                         channel()  == other.channel();
  46         }
  47
  48         inline Time        time()     const { return _on_event.time(); }
  49         inline Time        end_time() const { return _off_event.time(); }
  50         inline uint8_t     note()     const { return _on_event.note(); }
  51         inline uint8_t     velocity() const { return _on_event.velocity(); }
  52         inline Time        length()   const { return _off_event.time() - _on_event.time(); }
  53         inline uint8_t     channel()  const {
  54                 assert(_on_event.channel() == _off_event.channel());
  55             return _on_event.channel();
  56         }
  57
  58         inline void set_time(Time t)        { _off_event.time() = t + length(); _on_event.time() = t; }
  59         inline void set_note(uint8_t n)     { _on_event.buffer()[1] = n; _off_event.buffer()[1] = n; }
  60         inline void set_velocity(uint8_t n) { _on_event.buffer()[2] = n; }
  61         inline void set_length(Time l)      { _off_event.time() = _on_event.time() + l; }
  62         inline void set_channel(uint8_t c)  { _on_event.set_channel(c);  _off_event.set_channel(c); }
  63
  64         inline       Event<Time>& on_event()        { return _on_event; }
  65         inline const Event<Time>& on_event()  const { return _on_event; }
  66         inline       Event<Time>& off_event()       { return _off_event; }
  67         inline const Event<Time>& off_event() const { return _off_event; }
  68
  69 private:
  70         // Event buffers are self-contained
  71         MIDIEvent<Time> _on_event;
  72         MIDIEvent<Time> _off_event;
  73 };
  74
  75 } // namespace Evoral
  76
  77 template<typename Time>
  78 std::ostream& operator<<(std::ostream& o, const Evoral::Note<Time>& n) {
  79         o << "Note: pitch = " << (int) n.note()
  80           << " @ " << n.time() << " .. " << n.end_time()
  81           << " velocity " << (int) n.velocity()
  82           << " chn " << (int) n.channel();
  83         return o;
  84 }
  85
  86 #endif // EVORAL_NOTE_HPP
  87