Compile cleanly with clang.
[ardour.git] / libs / evoral / evoral / MIDIEvent.hpp
1 /* This file is part of Evoral.
2  * Copyright (C) 2008 David 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_MIDI_EVENT_HPP
20 #define EVORAL_MIDI_EVENT_HPP
21
22 #include <cmath>
23 #include <boost/shared_ptr.hpp>
24 #include "evoral/Event.hpp"
25 #include "evoral/midi_events.h"
26 #ifdef EVORAL_MIDI_XML
27 class XMLNode;
28 #endif
29
30 namespace Evoral {
31
32 /** MIDI helper functions for an Event.
33  *
34  * This class contains no data, an Evoral::Event can be cast to a MIDIEvent
35  * but the application must make sure the Event actually contains
36  * valid MIDI data for these functions to make sense.
37  */
38 template<typename Time>
39 class MIDIEvent : public Event<Time> {
40 public:
41         MIDIEvent(EventType type=0, Time time=0, uint32_t size=0, uint8_t* buf=NULL, bool alloc=false)
42                 : Event<Time>(type, time, size, buf, alloc)
43         {}
44
45         MIDIEvent(const Event<Time>& copy, bool alloc)
46                 : Event<Time>(copy, alloc)
47         {}
48
49 #ifdef EVORAL_MIDI_XML
50         /** Event from XML ala http://www.midi.org/dtds/MIDIEvents10.dtd */
51         MIDIEvent(const XMLNode& event);
52
53         /** Event to XML ala http://www.midi.org/dtds/MIDIEvents10.dtd */
54         boost::shared_ptr<XMLNode> to_xml() const;
55 #endif
56
57         inline uint8_t  type()                  const { return (this->_buf[0] & 0xF0); }
58         inline void     set_type(uint8_t type)        { this->_buf[0] =   (0x0F & this->_buf[0])
59                                                                         | (0xF0 & type); }
60         inline uint8_t  channel()               const { return (this->_buf[0] & 0x0F); }
61         inline void     set_channel(uint8_t channel)  { this->_buf[0] =   (0xF0 & this->_buf[0])
62                                                                         | (0x0F & channel); }
63         inline bool     is_note_on()            const { return (type() == MIDI_CMD_NOTE_ON); }
64         inline bool     is_note_off()           const { return (type() == MIDI_CMD_NOTE_OFF); }
65         inline bool     is_cc()                 const { return (type() == MIDI_CMD_CONTROL); }
66         inline bool     is_pitch_bender()       const { return (type() == MIDI_CMD_BENDER); }
67         inline bool     is_pgm_change()         const { return (type() == MIDI_CMD_PGM_CHANGE); }
68         inline bool     is_note()               const { return (is_note_on() || is_note_off()); }
69         inline bool     is_aftertouch()         const { return (type() == MIDI_CMD_NOTE_PRESSURE); }
70         inline bool     is_channel_pressure()   const { return (type() == MIDI_CMD_CHANNEL_PRESSURE); }
71         inline uint8_t  note()                  const { return (this->_buf[1]); }
72         inline void     set_note(uint8_t n)           { this->_buf[1] = n; }
73         inline uint8_t  velocity()              const { return (this->_buf[2]); }
74         inline void     set_velocity(uint8_t value)   { this->_buf[2] = value; }
75         inline void     scale_velocity(float factor)  {
76                 if (factor < 0) factor = 0;
77                 this->_buf[2] = (uint8_t) lrintf (this->_buf[2]*factor);
78                 if (this->_buf[2] > 127) this->_buf[2] = 127;
79         }
80         inline uint8_t  cc_number()             const { return (this->_buf[1]); }
81         inline void     set_cc_number(uint8_t number) { this->_buf[1] = number; }
82         inline uint8_t  cc_value()              const { return (this->_buf[2]); }
83         inline void     set_cc_value(uint8_t value)   { this->_buf[2] = value; }
84         inline uint8_t  pitch_bender_lsb()      const { return (this->_buf[1]); }
85         inline uint8_t  pitch_bender_msb()      const { return (this->_buf[2]); }
86         inline uint16_t pitch_bender_value()    const { return ( ((0x7F & this->_buf[2]) << 7)
87                                                                 | (0x7F & this->_buf[1]) ); }
88         inline uint8_t  pgm_number()            const { return (this->_buf[1]); }
89         inline void     set_pgm_number(uint8_t number){ this->_buf[1] = number; }
90         inline uint8_t  aftertouch()            const { return (this->_buf[1]); }
91         inline uint8_t  channel_pressure()      const { return (this->_buf[1]); }
92         inline bool     is_channel_event()      const { return (0x80 <= type()) && (type() <= 0xE0); }
93         inline bool     is_smf_meta_event()     const { return this->_buf[0] == 0xFF; }
94         inline bool     is_sysex()              const { return this->_buf[0] == 0xF0
95                                                             || this->_buf[0] == 0xF7; }
96         inline bool     is_spp()                const { return this->_buf[0] == 0xF2 && this->size() == 1; }
97         inline bool     is_mtc_quarter()        const { return this->_buf[0] == 0xF1 && this->size() == 1; }
98         inline bool     is_mtc_full()           const { 
99                 return this->size() == 10 && this->_buf[0] == 0xf0 && this->_buf[1] == 0x7f && 
100                         this->_buf[3] == 0x01 && this->_buf[4] == 0x01;
101         }
102 };
103
104 } // namespace Evoral
105
106 #endif // EVORAL_MIDI_EVENT_HPP