Patrick Pollet / USBDevice

usb device

USBMIDI/MIDIMessage.h@0:c1e89c49eae5, 2022-05-14 (annotated)

Committer:
ppo
Date:
Sat May 14 17:24:10 2022 +0000
Revision:
0:c1e89c49eae5
commit

Who changed what in which revision?

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