Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

libraries/USBDevice/USBMIDI/MIDIMessage.h@0:6c56fb4bc5f0, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:27:58 2016 +0000
Revision:
0:6c56fb4bc5f0
Moving to library for sharing updates

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nexpaq 0:6c56fb4bc5f0 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
nexpaq 0:6c56fb4bc5f0 2 *
nexpaq 0:6c56fb4bc5f0 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
nexpaq 0:6c56fb4bc5f0 4 * and associated documentation files (the "Software"), to deal in the Software without
nexpaq 0:6c56fb4bc5f0 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
nexpaq 0:6c56fb4bc5f0 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
nexpaq 0:6c56fb4bc5f0 7 * Software is furnished to do so, subject to the following conditions:
nexpaq 0:6c56fb4bc5f0 8 *
nexpaq 0:6c56fb4bc5f0 9 * The above copyright notice and this permission notice shall be included in all copies or
nexpaq 0:6c56fb4bc5f0 10 * substantial portions of the Software.
nexpaq 0:6c56fb4bc5f0 11 *
nexpaq 0:6c56fb4bc5f0 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
nexpaq 0:6c56fb4bc5f0 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
nexpaq 0:6c56fb4bc5f0 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
nexpaq 0:6c56fb4bc5f0 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
nexpaq 0:6c56fb4bc5f0 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
nexpaq 0:6c56fb4bc5f0 17 */
nexpaq 0:6c56fb4bc5f0 18
nexpaq 0:6c56fb4bc5f0 19 #ifndef MIDIMESSAGE_H
nexpaq 0:6c56fb4bc5f0 20 #define MIDIMESSAGE_H
nexpaq 0:6c56fb4bc5f0 21
nexpaq 0:6c56fb4bc5f0 22 #include "mbed.h"
nexpaq 0:6c56fb4bc5f0 23
nexpaq 0:6c56fb4bc5f0 24 #define MAX_MIDI_MESSAGE_SIZE 256 // Max message size. SysEx can be up to 65536 but 256 should be fine for most usage
nexpaq 0:6c56fb4bc5f0 25
nexpaq 0:6c56fb4bc5f0 26 // MIDI Message Format
nexpaq 0:6c56fb4bc5f0 27 //
nexpaq 0:6c56fb4bc5f0 28 // [ msg(4) | channel(4) ] [ 0 | n(7) ] [ 0 | m(7) ]
nexpaq 0:6c56fb4bc5f0 29 //
nexpaq 0:6c56fb4bc5f0 30 // MIDI Data Messages (Channel Specific)
nexpaq 0:6c56fb4bc5f0 31 //
nexpaq 0:6c56fb4bc5f0 32 // Message msg n m
nexpaq 0:6c56fb4bc5f0 33 // ---------------------------------------------
nexpaq 0:6c56fb4bc5f0 34 // Note Off 0x8 Key Velocity
nexpaq 0:6c56fb4bc5f0 35 // Note On 0x9 Key Velocity
nexpaq 0:6c56fb4bc5f0 36 // Polyphonic Aftertouch 0xA Key Pressure
nexpaq 0:6c56fb4bc5f0 37 // Control Change 0xB Controller Value
nexpaq 0:6c56fb4bc5f0 38 // Program Change 0xC Program -
nexpaq 0:6c56fb4bc5f0 39 // Channel Aftertouch 0xD Pressure -
nexpaq 0:6c56fb4bc5f0 40 // Pitch Wheel 0xE LSB MSB
nexpaq 0:6c56fb4bc5f0 41
nexpaq 0:6c56fb4bc5f0 42 #define CABLE_NUM (0<<4)
nexpaq 0:6c56fb4bc5f0 43
nexpaq 0:6c56fb4bc5f0 44 /** A MIDI message container */
nexpaq 0:6c56fb4bc5f0 45 class MIDIMessage {
nexpaq 0:6c56fb4bc5f0 46 public:
nexpaq 0:6c56fb4bc5f0 47 MIDIMessage() : length(4) {}
nexpaq 0:6c56fb4bc5f0 48
nexpaq 0:6c56fb4bc5f0 49 MIDIMessage(uint8_t *buf) : length(4) {
nexpaq 0:6c56fb4bc5f0 50 for (int i = 0; i < 4; i++)
nexpaq 0:6c56fb4bc5f0 51 data[i] = buf[i];
nexpaq 0:6c56fb4bc5f0 52 }
nexpaq 0:6c56fb4bc5f0 53
nexpaq 0:6c56fb4bc5f0 54 // New constructor, buf is a true MIDI message (not USBMidi message) and buf_len true message length.
nexpaq 0:6c56fb4bc5f0 55 MIDIMessage(uint8_t *buf, int buf_len) {
nexpaq 0:6c56fb4bc5f0 56 length=buf_len+1;
nexpaq 0:6c56fb4bc5f0 57 // first byte keeped for retro-compatibility
nexpaq 0:6c56fb4bc5f0 58 data[0]=0;
nexpaq 0:6c56fb4bc5f0 59
nexpaq 0:6c56fb4bc5f0 60 for (int i = 0; i < buf_len; i++)
nexpaq 0:6c56fb4bc5f0 61 data[i+1] = buf[i];
nexpaq 0:6c56fb4bc5f0 62 }
nexpaq 0:6c56fb4bc5f0 63
nexpaq 0:6c56fb4bc5f0 64 // create messages
nexpaq 0:6c56fb4bc5f0 65
nexpaq 0:6c56fb4bc5f0 66 /** Create a NoteOff message
nexpaq 0:6c56fb4bc5f0 67 * @param key Key ID
nexpaq 0:6c56fb4bc5f0 68 * @param velocity Key velocity (0-127, default = 127)
nexpaq 0:6c56fb4bc5f0 69 * @param channel Key channel (0-15, default 0)
nexpaq 0:6c56fb4bc5f0 70 * @returns A MIDIMessage
nexpaq 0:6c56fb4bc5f0 71 */
nexpaq 0:6c56fb4bc5f0 72 static MIDIMessage NoteOff(int key, int velocity = 127, int channel = 0) {
nexpaq 0:6c56fb4bc5f0 73 MIDIMessage msg;
nexpaq 0:6c56fb4bc5f0 74 msg.data[0] = CABLE_NUM | 0x08;
nexpaq 0:6c56fb4bc5f0 75 msg.data[1] = 0x80 | (channel & 0x0F);
nexpaq 0:6c56fb4bc5f0 76 msg.data[2] = key & 0x7F;
nexpaq 0:6c56fb4bc5f0 77 msg.data[3] = velocity & 0x7F;
nexpaq 0:6c56fb4bc5f0 78 return msg;
nexpaq 0:6c56fb4bc5f0 79 }
nexpaq 0:6c56fb4bc5f0 80
nexpaq 0:6c56fb4bc5f0 81 /** Create a NoteOn message
nexpaq 0:6c56fb4bc5f0 82 * @param key Key ID
nexpaq 0:6c56fb4bc5f0 83 * @param velocity Key velocity (0-127, default = 127)
nexpaq 0:6c56fb4bc5f0 84 * @param channel Key channel (0-15, default 0)
nexpaq 0:6c56fb4bc5f0 85 * @returns A MIDIMessage
nexpaq 0:6c56fb4bc5f0 86 */
nexpaq 0:6c56fb4bc5f0 87 static MIDIMessage NoteOn(int key, int velocity = 127, int channel = 0) {
nexpaq 0:6c56fb4bc5f0 88 MIDIMessage msg;
nexpaq 0:6c56fb4bc5f0 89 msg.data[0] = CABLE_NUM | 0x09;
nexpaq 0:6c56fb4bc5f0 90 msg.data[1] = 0x90 | (channel & 0x0F);
nexpaq 0:6c56fb4bc5f0 91 msg.data[2] = key & 0x7F;
nexpaq 0:6c56fb4bc5f0 92 msg.data[3] = velocity & 0x7F;
nexpaq 0:6c56fb4bc5f0 93 return msg;
nexpaq 0:6c56fb4bc5f0 94 }
nexpaq 0:6c56fb4bc5f0 95
nexpaq 0:6c56fb4bc5f0 96 /** Create a PolyPhonic Aftertouch message
nexpaq 0:6c56fb4bc5f0 97 * @param key Key ID
nexpaq 0:6c56fb4bc5f0 98 * @param pressure Aftertouch pressure (0-127)
nexpaq 0:6c56fb4bc5f0 99 * @param channel Key channel (0-15, default 0)
nexpaq 0:6c56fb4bc5f0 100 * @returns A MIDIMessage
nexpaq 0:6c56fb4bc5f0 101 */
nexpaq 0:6c56fb4bc5f0 102 static MIDIMessage PolyphonicAftertouch(int key, int pressure, int channel = 0) {
nexpaq 0:6c56fb4bc5f0 103 MIDIMessage msg;
nexpaq 0:6c56fb4bc5f0 104 msg.data[0] = CABLE_NUM | 0x0A;
nexpaq 0:6c56fb4bc5f0 105 msg.data[1] = 0xA0 | (channel & 0x0F);
nexpaq 0:6c56fb4bc5f0 106 msg.data[2] = key & 0x7F;
nexpaq 0:6c56fb4bc5f0 107 msg.data[3] = pressure & 0x7F;
nexpaq 0:6c56fb4bc5f0 108 return msg;
nexpaq 0:6c56fb4bc5f0 109 }
nexpaq 0:6c56fb4bc5f0 110
nexpaq 0:6c56fb4bc5f0 111 /** Create a Control Change message
nexpaq 0:6c56fb4bc5f0 112 * @param control Controller ID
nexpaq 0:6c56fb4bc5f0 113 * @param value Controller value (0-127)
nexpaq 0:6c56fb4bc5f0 114 * @param channel Controller channel (0-15, default 0)
nexpaq 0:6c56fb4bc5f0 115 * @returns A MIDIMessage
nexpaq 0:6c56fb4bc5f0 116 */
nexpaq 0:6c56fb4bc5f0 117 static MIDIMessage ControlChange(int control, int value, int channel = 0) {
nexpaq 0:6c56fb4bc5f0 118 MIDIMessage msg;
nexpaq 0:6c56fb4bc5f0 119 msg.data[0] = CABLE_NUM | 0x0B;
nexpaq 0:6c56fb4bc5f0 120 msg.data[1] = 0xB0 | (channel & 0x0F);
nexpaq 0:6c56fb4bc5f0 121 msg.data[2] = control & 0x7F;
nexpaq 0:6c56fb4bc5f0 122 msg.data[3] = value & 0x7F;
nexpaq 0:6c56fb4bc5f0 123 return msg;
nexpaq 0:6c56fb4bc5f0 124 }
nexpaq 0:6c56fb4bc5f0 125
nexpaq 0:6c56fb4bc5f0 126 /** Create a Program Change message
nexpaq 0:6c56fb4bc5f0 127 * @param program Program ID
nexpaq 0:6c56fb4bc5f0 128 * @param channel Channel (0-15, default 0)
nexpaq 0:6c56fb4bc5f0 129 * @returns A MIDIMessage
nexpaq 0:6c56fb4bc5f0 130 */
nexpaq 0:6c56fb4bc5f0 131 static MIDIMessage ProgramChange(int program, int channel = 0) {
nexpaq 0:6c56fb4bc5f0 132 MIDIMessage msg;
nexpaq 0:6c56fb4bc5f0 133 msg.data[0] = CABLE_NUM | 0x0C;
nexpaq 0:6c56fb4bc5f0 134 msg.data[1] = 0xC0 | (channel & 0x0F);
nexpaq 0:6c56fb4bc5f0 135 msg.data[2] = program & 0x7F;
nexpaq 0:6c56fb4bc5f0 136 msg.data[3] = 0x00;
nexpaq 0:6c56fb4bc5f0 137 return msg;
nexpaq 0:6c56fb4bc5f0 138 }
nexpaq 0:6c56fb4bc5f0 139
nexpaq 0:6c56fb4bc5f0 140 /** Create a Channel Aftertouch message
nexpaq 0:6c56fb4bc5f0 141 * @param pressure Pressure
nexpaq 0:6c56fb4bc5f0 142 * @param channel Key channel (0-15, default 0)
nexpaq 0:6c56fb4bc5f0 143 * @returns A MIDIMessage
nexpaq 0:6c56fb4bc5f0 144 */
nexpaq 0:6c56fb4bc5f0 145 static MIDIMessage ChannelAftertouch(int pressure, int channel = 0) {
nexpaq 0:6c56fb4bc5f0 146 MIDIMessage msg;
nexpaq 0:6c56fb4bc5f0 147 msg.data[0] = CABLE_NUM | 0x0D;
nexpaq 0:6c56fb4bc5f0 148 msg.data[1] = 0xD0 | (channel & 0x0F);
nexpaq 0:6c56fb4bc5f0 149 msg.data[2] = pressure & 0x7F;
nexpaq 0:6c56fb4bc5f0 150 msg.data[3] = 0x00;
nexpaq 0:6c56fb4bc5f0 151 return msg;
nexpaq 0:6c56fb4bc5f0 152 }
nexpaq 0:6c56fb4bc5f0 153
nexpaq 0:6c56fb4bc5f0 154 /** Create a Pitch Wheel message
nexpaq 0:6c56fb4bc5f0 155 * @param pitch Pitch (-8192 - 8191, default = 0)
nexpaq 0:6c56fb4bc5f0 156 * @param channel Channel (0-15, default 0)
nexpaq 0:6c56fb4bc5f0 157 * @returns A MIDIMessage
nexpaq 0:6c56fb4bc5f0 158 */
nexpaq 0:6c56fb4bc5f0 159 static MIDIMessage PitchWheel(int pitch = 0, int channel = 0) {
nexpaq 0:6c56fb4bc5f0 160 MIDIMessage msg;
nexpaq 0:6c56fb4bc5f0 161 int p = pitch + 8192; // 0 - 16383, 8192 is center
nexpaq 0:6c56fb4bc5f0 162 msg.data[0] = CABLE_NUM | 0x0E;
nexpaq 0:6c56fb4bc5f0 163 msg.data[1] = 0xE0 | (channel & 0x0F);
nexpaq 0:6c56fb4bc5f0 164 msg.data[2] = p & 0x7F;
nexpaq 0:6c56fb4bc5f0 165 msg.data[3] = (p >> 7) & 0x7F;
nexpaq 0:6c56fb4bc5f0 166 return msg;
nexpaq 0:6c56fb4bc5f0 167 }
nexpaq 0:6c56fb4bc5f0 168
nexpaq 0:6c56fb4bc5f0 169 /** Create an All Notes Off message
nexpaq 0:6c56fb4bc5f0 170 * @param channel Channel (0-15, default 0)
nexpaq 0:6c56fb4bc5f0 171 * @returns A MIDIMessage
nexpaq 0:6c56fb4bc5f0 172 */
nexpaq 0:6c56fb4bc5f0 173 static MIDIMessage AllNotesOff(int channel = 0) {
nexpaq 0:6c56fb4bc5f0 174 return ControlChange(123, 0, channel);
nexpaq 0:6c56fb4bc5f0 175 }
nexpaq 0:6c56fb4bc5f0 176
nexpaq 0:6c56fb4bc5f0 177 /** Create a SysEx message
nexpaq 0:6c56fb4bc5f0 178 * @param data SysEx data (including 0xF0 .. 0xF7)
nexpaq 0:6c56fb4bc5f0 179 * @param len SysEx data length
nexpaq 0:6c56fb4bc5f0 180 * @returns A MIDIMessage
nexpaq 0:6c56fb4bc5f0 181 */
nexpaq 0:6c56fb4bc5f0 182 static MIDIMessage SysEx(uint8_t *data, int len) {
nexpaq 0:6c56fb4bc5f0 183 MIDIMessage msg=MIDIMessage(data,len);
nexpaq 0:6c56fb4bc5f0 184 return msg;
nexpaq 0:6c56fb4bc5f0 185 }
nexpaq 0:6c56fb4bc5f0 186
nexpaq 0:6c56fb4bc5f0 187 // decode messages
nexpaq 0:6c56fb4bc5f0 188
nexpaq 0:6c56fb4bc5f0 189 /** MIDI Message Types */
nexpaq 0:6c56fb4bc5f0 190 enum MIDIMessageType {
nexpaq 0:6c56fb4bc5f0 191 ErrorType,
nexpaq 0:6c56fb4bc5f0 192 NoteOffType,
nexpaq 0:6c56fb4bc5f0 193 NoteOnType,
nexpaq 0:6c56fb4bc5f0 194 PolyphonicAftertouchType,
nexpaq 0:6c56fb4bc5f0 195 ControlChangeType,
nexpaq 0:6c56fb4bc5f0 196 ProgramChangeType,
nexpaq 0:6c56fb4bc5f0 197 ChannelAftertouchType,
nexpaq 0:6c56fb4bc5f0 198 PitchWheelType,
nexpaq 0:6c56fb4bc5f0 199 AllNotesOffType,
nexpaq 0:6c56fb4bc5f0 200 SysExType
nexpaq 0:6c56fb4bc5f0 201 };
nexpaq 0:6c56fb4bc5f0 202
nexpaq 0:6c56fb4bc5f0 203 /** Read the message type
nexpaq 0:6c56fb4bc5f0 204 * @returns MIDIMessageType
nexpaq 0:6c56fb4bc5f0 205 */
nexpaq 0:6c56fb4bc5f0 206 MIDIMessageType type() {
nexpaq 0:6c56fb4bc5f0 207 switch((data[1] >> 4) & 0xF) {
nexpaq 0:6c56fb4bc5f0 208 case 0x8: return NoteOffType;
nexpaq 0:6c56fb4bc5f0 209 case 0x9: return NoteOnType;
nexpaq 0:6c56fb4bc5f0 210 case 0xA: return PolyphonicAftertouchType;
nexpaq 0:6c56fb4bc5f0 211 case 0xB:
nexpaq 0:6c56fb4bc5f0 212 if(controller() < 120) { // standard controllers
nexpaq 0:6c56fb4bc5f0 213 return ControlChangeType;
nexpaq 0:6c56fb4bc5f0 214 } else if(controller() == 123) {
nexpaq 0:6c56fb4bc5f0 215 return AllNotesOffType;
nexpaq 0:6c56fb4bc5f0 216 } else {
nexpaq 0:6c56fb4bc5f0 217 return ErrorType; // unsupported atm
nexpaq 0:6c56fb4bc5f0 218 }
nexpaq 0:6c56fb4bc5f0 219 case 0xC: return ProgramChangeType;
nexpaq 0:6c56fb4bc5f0 220 case 0xD: return ChannelAftertouchType;
nexpaq 0:6c56fb4bc5f0 221 case 0xE: return PitchWheelType;
nexpaq 0:6c56fb4bc5f0 222 case 0xF: return SysExType;
nexpaq 0:6c56fb4bc5f0 223 default: return ErrorType;
nexpaq 0:6c56fb4bc5f0 224 }
nexpaq 0:6c56fb4bc5f0 225 }
nexpaq 0:6c56fb4bc5f0 226
nexpaq 0:6c56fb4bc5f0 227 /** Read the channel number */
nexpaq 0:6c56fb4bc5f0 228 int channel() {
nexpaq 0:6c56fb4bc5f0 229 return (data[1] & 0x0F);
nexpaq 0:6c56fb4bc5f0 230 }
nexpaq 0:6c56fb4bc5f0 231
nexpaq 0:6c56fb4bc5f0 232 /** Read the key ID */
nexpaq 0:6c56fb4bc5f0 233 int key() {
nexpaq 0:6c56fb4bc5f0 234 return (data[2] & 0x7F);
nexpaq 0:6c56fb4bc5f0 235 }
nexpaq 0:6c56fb4bc5f0 236
nexpaq 0:6c56fb4bc5f0 237 /** Read the velocity */
nexpaq 0:6c56fb4bc5f0 238 int velocity() {
nexpaq 0:6c56fb4bc5f0 239 return (data[3] & 0x7F);
nexpaq 0:6c56fb4bc5f0 240 }
nexpaq 0:6c56fb4bc5f0 241
nexpaq 0:6c56fb4bc5f0 242 /** Read the controller value */
nexpaq 0:6c56fb4bc5f0 243 int value() {
nexpaq 0:6c56fb4bc5f0 244 return (data[3] & 0x7F);
nexpaq 0:6c56fb4bc5f0 245 }
nexpaq 0:6c56fb4bc5f0 246
nexpaq 0:6c56fb4bc5f0 247 /** Read the aftertouch pressure */
nexpaq 0:6c56fb4bc5f0 248 int pressure() {
nexpaq 0:6c56fb4bc5f0 249 if(type() == PolyphonicAftertouchType) {
nexpaq 0:6c56fb4bc5f0 250 return (data[3] & 0x7F);
nexpaq 0:6c56fb4bc5f0 251 } else {
nexpaq 0:6c56fb4bc5f0 252 return (data[2] & 0x7F);
nexpaq 0:6c56fb4bc5f0 253 }
nexpaq 0:6c56fb4bc5f0 254 }
nexpaq 0:6c56fb4bc5f0 255
nexpaq 0:6c56fb4bc5f0 256 /** Read the controller number */
nexpaq 0:6c56fb4bc5f0 257 int controller() {
nexpaq 0:6c56fb4bc5f0 258 return (data[2] & 0x7F);
nexpaq 0:6c56fb4bc5f0 259 }
nexpaq 0:6c56fb4bc5f0 260
nexpaq 0:6c56fb4bc5f0 261 /** Read the program number */
nexpaq 0:6c56fb4bc5f0 262 int program() {
nexpaq 0:6c56fb4bc5f0 263 return (data[2] & 0x7F);
nexpaq 0:6c56fb4bc5f0 264 }
nexpaq 0:6c56fb4bc5f0 265
nexpaq 0:6c56fb4bc5f0 266 /** Read the pitch value */
nexpaq 0:6c56fb4bc5f0 267 int pitch() {
nexpaq 0:6c56fb4bc5f0 268 int p = ((data[3] & 0x7F) << 7) | (data[2] & 0x7F);
nexpaq 0:6c56fb4bc5f0 269 return p - 8192; // 0 - 16383, 8192 is center
nexpaq 0:6c56fb4bc5f0 270 }
nexpaq 0:6c56fb4bc5f0 271
nexpaq 0:6c56fb4bc5f0 272 uint8_t data[MAX_MIDI_MESSAGE_SIZE+1];
nexpaq 0:6c56fb4bc5f0 273 uint8_t length;
nexpaq 0:6c56fb4bc5f0 274 };
nexpaq 0:6c56fb4bc5f0 275
nexpaq 0:6c56fb4bc5f0 276 #endif