1 /*
2 Copyright 2012 David Robillard <http://drobilla.net>
3
4 Permission to use, copy, modify, and/or distribute this software for any
5 purpose with or without fee is hereby granted, provided that the above
6 copyright notice and this permission notice appear in all copies.
7
8 THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 */
16
17 /**
18 @file midi.h
19 C definitions for the LV2 MIDI extension <http://lv2plug.in/ns/ext/midi>.
20 */
21
22 #ifndef LV2_MIDI_H
23 #define LV2_MIDI_H
24
25 #include <stdint.h>
26
27 #ifdef __cplusplus
28 extern "C" {
29 #else
30 # include <stdbool.h>
31 #endif
32
33 #define LV2_MIDI_URI "http://lv2plug.in/ns/ext/midi"
34 #define LV2_MIDI_PREFIX LV2_MIDI_URI "#"
35
36 #define LV2_MIDI__ActiveSense LV2_MIDI_PREFIX "ActiveSense"
37 #define LV2_MIDI__Aftertouch LV2_MIDI_PREFIX "Aftertouch"
38 #define LV2_MIDI__Bender LV2_MIDI_PREFIX "Bender"
39 #define LV2_MIDI__ChannelPressure LV2_MIDI_PREFIX "ChannelPressure"
40 #define LV2_MIDI__Chunk LV2_MIDI_PREFIX "Chunk"
41 #define LV2_MIDI__Clock LV2_MIDI_PREFIX "Clock"
42 #define LV2_MIDI__Continue LV2_MIDI_PREFIX "Continue"
43 #define LV2_MIDI__Controller LV2_MIDI_PREFIX "Controller"
44 #define LV2_MIDI__MidiEvent LV2_MIDI_PREFIX "MidiEvent"
45 #define LV2_MIDI__NoteOff LV2_MIDI_PREFIX "NoteOff"
46 #define LV2_MIDI__NoteOn LV2_MIDI_PREFIX "NoteOn"
47 #define LV2_MIDI__ProgramChange LV2_MIDI_PREFIX "ProgramChange"
48 #define LV2_MIDI__QuarterFrame LV2_MIDI_PREFIX "QuarterFrame"
49 #define LV2_MIDI__Reset LV2_MIDI_PREFIX "Reset"
50 #define LV2_MIDI__SongPosition LV2_MIDI_PREFIX "SongPosition"
51 #define LV2_MIDI__SongSelect LV2_MIDI_PREFIX "SongSelect"
52 #define LV2_MIDI__Start LV2_MIDI_PREFIX "Start"
53 #define LV2_MIDI__Stop LV2_MIDI_PREFIX "Stop"
54 #define LV2_MIDI__SystemCommon LV2_MIDI_PREFIX "SystemCommon"
55 #define LV2_MIDI__SystemExclusive LV2_MIDI_PREFIX "SystemExclusive"
56 #define LV2_MIDI__SystemMessage LV2_MIDI_PREFIX "SystemMessage"
57 #define LV2_MIDI__SystemRealtime LV2_MIDI_PREFIX "SystemRealtime"
58 #define LV2_MIDI__Tick LV2_MIDI_PREFIX "Tick"
59 #define LV2_MIDI__TuneRequest LV2_MIDI_PREFIX "TuneRequest"
60 #define LV2_MIDI__VoiceMessage LV2_MIDI_PREFIX "VoiceMessage"
61 #define LV2_MIDI__benderValue LV2_MIDI_PREFIX "benderValue"
62 #define LV2_MIDI__binding LV2_MIDI_PREFIX "binding"
63 #define LV2_MIDI__byteNumber LV2_MIDI_PREFIX "byteNumber"
64 #define LV2_MIDI__channel LV2_MIDI_PREFIX "channel"
65 #define LV2_MIDI__chunk LV2_MIDI_PREFIX "chunk"
66 #define LV2_MIDI__controllerNumber LV2_MIDI_PREFIX "controllerNumber"
67 #define LV2_MIDI__controllerValue LV2_MIDI_PREFIX "controllerValue"
68 #define LV2_MIDI__noteNumber LV2_MIDI_PREFIX "noteNumber"
69 #define LV2_MIDI__pressure LV2_MIDI_PREFIX "pressure"
70 #define LV2_MIDI__programNumber LV2_MIDI_PREFIX "programNumber"
71 #define LV2_MIDI__property LV2_MIDI_PREFIX "property"
72 #define LV2_MIDI__songNumber LV2_MIDI_PREFIX "songNumber"
73 #define LV2_MIDI__songPosition LV2_MIDI_PREFIX "songPosition"
74 #define LV2_MIDI__status LV2_MIDI_PREFIX "status"
75 #define LV2_MIDI__statusMask LV2_MIDI_PREFIX "statusMask"
76 #define LV2_MIDI__velocity LV2_MIDI_PREFIX "velocity"
77
78 /**
79 MIDI Message Type.
80
81 This includes both voice messages (which have a channel) and system messages
82 (which do not), as well as a sentinel value for invalid messages. To get
83 the type of a message suitable for use in a switch statement, use
84 lv2_midi_get_type() on the status byte.
85 */
86 typedef enum {
87 LV2_MIDI_MSG_INVALID = 0, /**< Invalid Message */
88 LV2_MIDI_MSG_NOTE_OFF = 0x80, /**< Note Off */
89 LV2_MIDI_MSG_NOTE_ON = 0x90, /**< Note On */
90 LV2_MIDI_MSG_NOTE_PRESSURE = 0xA0, /**< Note Pressure */
91 LV2_MIDI_MSG_CONTROLLER = 0xB0, /**< Controller */
92 LV2_MIDI_MSG_PGM_CHANGE = 0xC0, /**< Program Change */
93 LV2_MIDI_MSG_CHANNEL_PRESSURE = 0xD0, /**< Channel Pressure */
94 LV2_MIDI_MSG_BENDER = 0xE0, /**< Pitch Bender */
95 LV2_MIDI_MSG_SYSTEM_EXCLUSIVE = 0xF0, /**< System Exclusive Begin */
96 LV2_MIDI_MSG_MTC_QUARTER = 0xF1, /**< MTC Quarter Frame */
97 LV2_MIDI_MSG_SONG_POS = 0xF2, /**< Song Position */
98 LV2_MIDI_MSG_SONG_SELECT = 0xF3, /**< Song Select */
99 LV2_MIDI_MSG_TUNE_REQUEST = 0xF6, /**< Tune Request */
100 LV2_MIDI_MSG_CLOCK = 0xF8, /**< Clock */
101 LV2_MIDI_MSG_START = 0xFA, /**< Start */
102 LV2_MIDI_MSG_CONTINUE = 0xFB, /**< Continue */
103 LV2_MIDI_MSG_STOP = 0xFC, /**< Stop */
104 LV2_MIDI_MSG_ACTIVE_SENSE = 0xFE, /**< Active Sensing */
105 LV2_MIDI_MSG_RESET = 0xFF /**< Reset */
106 } LV2_Midi_Message_Type;
107
108 /**
109 Standard MIDI Controller Numbers.
110 */
111 typedef enum {
112 LV2_MIDI_CTL_MSB_BANK = 0x00, /**< Bank Selection */
113 LV2_MIDI_CTL_MSB_MODWHEEL = 0x01, /**< Modulation */
114 LV2_MIDI_CTL_MSB_BREATH = 0x02, /**< Breath */
115 LV2_MIDI_CTL_MSB_FOOT = 0x04, /**< Foot */
116 LV2_MIDI_CTL_MSB_PORTAMENTO_TIME = 0x05, /**< Portamento Time */
117 LV2_MIDI_CTL_MSB_DATA_ENTRY = 0x06, /**< Data Entry */
118 LV2_MIDI_CTL_MSB_MAIN_VOLUME = 0x07, /**< Main Volume */
119 LV2_MIDI_CTL_MSB_BALANCE = 0x08, /**< Balance */
120 LV2_MIDI_CTL_MSB_PAN = 0x0A, /**< Panpot */
121 LV2_MIDI_CTL_MSB_EXPRESSION = 0x0B, /**< Expression */
122 LV2_MIDI_CTL_MSB_EFFECT1 = 0x0C, /**< Effect1 */
123 LV2_MIDI_CTL_MSB_EFFECT2 = 0x0D, /**< Effect2 */
124 LV2_MIDI_CTL_MSB_GENERAL_PURPOSE1 = 0x10, /**< General Purpose 1 */
125 LV2_MIDI_CTL_MSB_GENERAL_PURPOSE2 = 0x11, /**< General Purpose 2 */
126 LV2_MIDI_CTL_MSB_GENERAL_PURPOSE3 = 0x12, /**< General Purpose 3 */
127 LV2_MIDI_CTL_MSB_GENERAL_PURPOSE4 = 0x13, /**< General Purpose 4 */
128 LV2_MIDI_CTL_LSB_BANK = 0x20, /**< Bank Selection */
129 LV2_MIDI_CTL_LSB_MODWHEEL = 0x21, /**< Modulation */
130 LV2_MIDI_CTL_LSB_BREATH = 0x22, /**< Breath */
131 LV2_MIDI_CTL_LSB_FOOT = 0x24, /**< Foot */
132 LV2_MIDI_CTL_LSB_PORTAMENTO_TIME = 0x25, /**< Portamento Time */
133 LV2_MIDI_CTL_LSB_DATA_ENTRY = 0x26, /**< Data Entry */
134 LV2_MIDI_CTL_LSB_MAIN_VOLUME = 0x27, /**< Main Volume */
135 LV2_MIDI_CTL_LSB_BALANCE = 0x28, /**< Balance */
136 LV2_MIDI_CTL_LSB_PAN = 0x2A, /**< Panpot */
137 LV2_MIDI_CTL_LSB_EXPRESSION = 0x2B, /**< Expression */
138 LV2_MIDI_CTL_LSB_EFFECT1 = 0x2C, /**< Effect1 */
139 LV2_MIDI_CTL_LSB_EFFECT2 = 0x2D, /**< Effect2 */
140 LV2_MIDI_CTL_LSB_GENERAL_PURPOSE1 = 0x30, /**< General Purpose 1 */
141 LV2_MIDI_CTL_LSB_GENERAL_PURPOSE2 = 0x31, /**< General Purpose 2 */
142 LV2_MIDI_CTL_LSB_GENERAL_PURPOSE3 = 0x32, /**< General Purpose 3 */
143 LV2_MIDI_CTL_LSB_GENERAL_PURPOSE4 = 0x33, /**< General Purpose 4 */
144 LV2_MIDI_CTL_SUSTAIN = 0x40, /**< Sustain Pedal */
145 LV2_MIDI_CTL_PORTAMENTO = 0x41, /**< Portamento */
146 LV2_MIDI_CTL_SOSTENUTO = 0x42, /**< Sostenuto */
147 LV2_MIDI_CTL_SOFT_PEDAL = 0x43, /**< Soft Pedal */
148 LV2_MIDI_CTL_LEGATO_FOOTSWITCH = 0x44, /**< Legato Foot Switch */
149 LV2_MIDI_CTL_HOLD2 = 0x45, /**< Hold2 */
150 LV2_MIDI_CTL_SC1_SOUND_VARIATION = 0x46, /**< SC1 Sound Variation */
151 LV2_MIDI_CTL_SC2_TIMBRE = 0x47, /**< SC2 Timbre */
152 LV2_MIDI_CTL_SC3_RELEASE_TIME = 0x48, /**< SC3 Release Time */
153 LV2_MIDI_CTL_SC4_ATTACK_TIME = 0x49, /**< SC4 Attack Time */
154 LV2_MIDI_CTL_SC5_BRIGHTNESS = 0x4A, /**< SC5 Brightness */
155 LV2_MIDI_CTL_SC6 = 0x4B, /**< SC6 */
156 LV2_MIDI_CTL_SC7 = 0x4C, /**< SC7 */
157 LV2_MIDI_CTL_SC8 = 0x4D, /**< SC8 */
158 LV2_MIDI_CTL_SC9 = 0x4E, /**< SC9 */
159 LV2_MIDI_CTL_SC10 = 0x4F, /**< SC10 */
160 LV2_MIDI_CTL_GENERAL_PURPOSE5 = 0x50, /**< General Purpose 5 */
161 LV2_MIDI_CTL_GENERAL_PURPOSE6 = 0x51, /**< General Purpose 6 */
162 LV2_MIDI_CTL_GENERAL_PURPOSE7 = 0x52, /**< General Purpose 7 */
163 LV2_MIDI_CTL_GENERAL_PURPOSE8 = 0x53, /**< General Purpose 8 */
164 LV2_MIDI_CTL_PORTAMENTO_CONTROL = 0x54, /**< Portamento Control */
165 LV2_MIDI_CTL_E1_REVERB_DEPTH = 0x5B, /**< E1 Reverb Depth */
166 LV2_MIDI_CTL_E2_TREMOLO_DEPTH = 0x5C, /**< E2 Tremolo Depth */
167 LV2_MIDI_CTL_E3_CHORUS_DEPTH = 0x5D, /**< E3 Chorus Depth */
168 LV2_MIDI_CTL_E4_DETUNE_DEPTH = 0x5E, /**< E4 Detune Depth */
169 LV2_MIDI_CTL_E5_PHASER_DEPTH = 0x5F, /**< E5 Phaser Depth */
170 LV2_MIDI_CTL_DATA_INCREMENT = 0x60, /**< Data Increment */
171 LV2_MIDI_CTL_DATA_DECREMENT = 0x61, /**< Data Decrement */
172 LV2_MIDI_CTL_NRPN_LSB = 0x62, /**< Non-registered Parameter Number */
173 LV2_MIDI_CTL_NRPN_MSB = 0x63, /**< Non-registered Parameter Number */
174 LV2_MIDI_CTL_RPN_LSB = 0x64, /**< Registered Parameter Number */
175 LV2_MIDI_CTL_RPN_MSB = 0x65, /**< Registered Parameter Number */
176 LV2_MIDI_CTL_ALL_SOUNDS_OFF = 0x78, /**< All Sounds Off */
177 LV2_MIDI_CTL_RESET_CONTROLLERS = 0x79, /**< Reset Controllers */
178 LV2_MIDI_CTL_LOCAL_CONTROL_SWITCH = 0x7A, /**< Local Control Switch */
179 LV2_MIDI_CTL_ALL_NOTES_OFF = 0x7B, /**< All Notes Off */
180 LV2_MIDI_CTL_OMNI_OFF = 0x7C, /**< Omni Off */
181 LV2_MIDI_CTL_OMNI_ON = 0x7D, /**< Omni On */
182 LV2_MIDI_CTL_MONO1 = 0x7E, /**< Mono1 */
183 LV2_MIDI_CTL_MONO2 = 0x7F /**< Mono2 */
184 } LV2_Midi_Controller;
185
186 /**
187 Return true iff `msg` is a MIDI voice message (which has a channel).
188 */
189 static inline bool
lv2_midi_is_voice_message(const uint8_t * msg)190 lv2_midi_is_voice_message(const uint8_t* msg)
191 {
192 return msg[0] >= 0x80 && msg[0] < 0xF0;
193 }
194
195 /**
196 Return true iff `msg` is a MIDI system message (which has no channel).
197 */
198 static inline bool
lv2_midi_is_system_message(const uint8_t * msg)199 lv2_midi_is_system_message(const uint8_t* msg)
200 {
201 switch (msg[0]) {
202 case 0xF4:
203 case 0xF5:
204 case 0xF7:
205 case 0xF9:
206 case 0xFD:
207 return false;
208 default:
209 return (msg[0] & 0xF0) == 0xF0;
210 }
211 }
212
213 /**
214 Return the type of a MIDI message.
215 @param msg Pointer to the start (status byte) of a MIDI message.
216 */
217 static inline LV2_Midi_Message_Type
lv2_midi_message_type(const uint8_t * msg)218 lv2_midi_message_type(const uint8_t* msg)
219 {
220 if (lv2_midi_is_voice_message(msg)) {
221 return (LV2_Midi_Message_Type)(msg[0] & 0xF0);
222 } else if (lv2_midi_is_system_message(msg)) {
223 return (LV2_Midi_Message_Type)msg[0];
224 } else {
225 return LV2_MIDI_MSG_INVALID;
226 }
227 }
228
229 #ifdef __cplusplus
230 } /* extern "C" */
231 #endif
232
233 #endif /* LV2_MIDI_H */
234