Note.h

Go to the documentation of this file.

/*
 * Copyright (C) 2008-2016 David Robillard <d@drobilla.net>
 * Copyright (C) 2009-2014 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2014 John Emmas <john@creativepost.co.uk>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#ifndef EVORAL_NOTE_HPP
#define EVORAL_NOTE_HPP
 
#include <algorithm>
#include <assert.h>
#include <glib.h>
#include <stdint.h>
 
#include "evoral/visibility.h"
#include "evoral/Event.h"
 
namespace Evoral {
 
template<typename Time>
#ifdef COMPILER_MSVC
class LIBEVORAL_LOCAL Note {
#else
class LIBEVORAL_TEMPLATE_API Note {
#endif
public:
        Note(uint8_t chan=0, Time time=Time(), Time len=Time(), uint8_t note=0, uint8_t vel=0x40);
        Note(const Note<Time>& copy);
        ~Note();
 
        inline bool operator==(const Note<Time>& other) {
                return time() == other.time() &&
                        note() == other.note() &&
                        length() == other.length() &&
                        velocity() == other.velocity() &&
                        off_velocity() == other.off_velocity() &&
                        channel()  == other.channel();
        }
 
        inline event_id_t id() const { return _on_event.id(); }
        void set_id (event_id_t);
 
        inline Time    time()         const { return _on_event.time(); }
        inline Time    end_time()     const { return _off_event.time(); }
        inline uint8_t note()         const { return _on_event.note(); }
        inline uint8_t velocity()     const { return _on_event.velocity(); }
        inline uint8_t off_velocity() const { return _off_event.velocity(); }
        inline Time    length()       const { return _off_event.time() - _on_event.time(); }
        inline uint8_t channel()      const {
                assert(_on_event.channel() == _off_event.channel());
                return _on_event.channel();
        }
 
private:
        const Note<Time>& operator=(const Note<Time>& copy);  // undefined (unsafe)
 
        inline uint8_t clamp(int val, int low, int high) {
                const int r = std::min (std::max (val, low), high);
                assert (r < 256 && r >= 0);
                return (uint8_t) r;
        }
 
public:
        inline void set_time(Time t) {
                _off_event.set_time(t + length());
                _on_event.set_time(t);
        }
        inline void set_note(uint8_t n) {
                const uint8_t nn = clamp(n, 0, 127);
                _on_event.buffer()[1] = nn;
                _off_event.buffer()[1] = nn;
        }
        inline void set_velocity(uint8_t n) {
                _on_event.buffer()[2] = clamp(n, 0, 127);
        }
        inline void set_off_velocity(uint8_t n) {
                _off_event.buffer()[2] = clamp(n, 0, 127);
        }
        inline void set_length(Time l) {
                _off_event.set_time(_on_event.time() + l);
        }
        inline void set_channel(uint8_t c) {
                const uint8_t cc = clamp(c, 0, 16);
                _on_event.set_channel(cc);
                _off_event.set_channel(cc);
        }
 
        inline       Event<Time>& on_event()        { return _on_event; }
        inline const Event<Time>& on_event()  const { return _on_event; }
        inline       Event<Time>& off_event()       { return _off_event; }
        inline const Event<Time>& off_event() const { return _off_event; }
 
private:
        // Event buffers are self-contained
        Event<Time> _on_event;
        Event<Time> _off_event;
};
 
template<typename Time>
/*LIBEVORAL_API*/ std::ostream& operator<<(std::ostream& o, const Evoral::Note<Time>& n) {
        o << "Note #" << n.id() << ": pitch = " << (int) n.note()
          << " @ " << n.time() << " .. " << n.end_time()
          << " velocity " << (int) n.velocity()
          << " chn " << (int) n.channel();
        return o;
}
 
} // namespace Evoral
 
#ifdef COMPILER_MSVC
#include "../src/Note.impl"
#endif
 
#endif // EVORAL_NOTE_HPP