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
  28 /** An abstract (protocol agnostic) note.
  29  *
  30  * Currently a note is defined as (on event, length, off event).
  31  */
  32 template<typename Time>
  33 class Note {
  34 public:
  35         Note(uint8_t chan=0, Time time=0, EventLength len=0, uint8_t note=0, uint8_t vel=0x40);
  36         Note(const Note<Time>& copy);
  37         ~Note();
  38
  39         const Note<Time>& operator=(const Note<Time>& copy);
  40
  41         inline bool operator==(const Note<Time>& other) {
  42                 return time() == other.time() &&
  43                  note() == other.note() &&
  44                  length() == other.length() &&
  45                  velocity() == other.velocity() &&
  46                  channel()  == other.channel();
  47         }
  48
  49         inline Time        time()     const { return _on_event.time(); }
  50         inline Time        end_time() const { return _off_event.time(); }
  51         inline uint8_t     note()     const { return _on_event.note(); }
  52         inline uint8_t     velocity() const { return _on_event.velocity(); }
  53         inline EventLength length()   const { return _off_event.time() - _on_event.time(); }
  54         inline uint8_t     channel()  const {
  55                 assert(_on_event.channel() == _off_event.channel());
  56             return _on_event.channel();
  57         }
  58
  59         inline void set_time(Time t)          { _off_event.time() = t + length(); _on_event.time() = t; }
  60         inline void set_note(uint8_t n)       { _on_event.buffer()[1] = n; _off_event.buffer()[1] = n; }
  61         inline void set_velocity(uint8_t n)   { _on_event.buffer()[2] = n; }
  62         inline void set_length(EventLength l) { _off_event.time() = _on_event.time() + l; }
  63         inline void set_channel(uint8_t c)    { _on_event.set_channel(c);  _off_event.set_channel(c); }
  64
  65         inline       Event<Time>& on_event()        { return _on_event; }
  66         inline const Event<Time>& on_event()  const { return _on_event; }
  67         inline       Event<Time>& off_event()       { return _off_event; }
  68         inline const Event<Time>& off_event() const { return _off_event; }
  69
  70 private:
  71         // Event buffers are self-contained
  72         MIDIEvent<Time> _on_event;
  73         MIDIEvent<Time> _off_event;
  74 };
  75
  76
  77 } // namespace Evoral
  78
  79 #endif // EVORAL_NOTE_HPP
  80