Patrick Pollet / USBDevice

usb device

USBMIDI/USBMIDI.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 USBMIDI_H
ppo 0:c1e89c49eae5 20 #define USBMIDI_H
ppo 0:c1e89c49eae5 21
ppo 0:c1e89c49eae5 22 /* These headers are included for child class. */
ppo 0:c1e89c49eae5 23 #include "USBEndpoints.h"
ppo 0:c1e89c49eae5 24 #include "USBDescriptor.h"
ppo 0:c1e89c49eae5 25 #include "USBDevice_Types.h"
ppo 0:c1e89c49eae5 26
ppo 0:c1e89c49eae5 27 #include "USBDevice.h"
ppo 0:c1e89c49eae5 28 #include "MIDIMessage.h"
ppo 0:c1e89c49eae5 29
ppo 0:c1e89c49eae5 30 #define DEFAULT_CONFIGURATION (1)
ppo 0:c1e89c49eae5 31
ppo 0:c1e89c49eae5 32 /**
ppo 0:c1e89c49eae5 33 * USBMIDI example
ppo 0:c1e89c49eae5 34 *
ppo 0:c1e89c49eae5 35 * @code
ppo 0:c1e89c49eae5 36 * #include "mbed.h"
ppo 0:c1e89c49eae5 37 * #include "USBMIDI.h"
ppo 0:c1e89c49eae5 38 *
ppo 0:c1e89c49eae5 39 * USBMIDI midi;
ppo 0:c1e89c49eae5 40 *
ppo 0:c1e89c49eae5 41 * int main() {
ppo 0:c1e89c49eae5 42 * while (1) {
ppo 0:c1e89c49eae5 43 * for(int i=48; i<83; i++) { // send some messages!
ppo 0:c1e89c49eae5 44 * midi.write(MIDIMessage::NoteOn(i));
ppo 0:c1e89c49eae5 45 * wait(0.25);
ppo 0:c1e89c49eae5 46 * midi.write(MIDIMessage::NoteOff(i));
ppo 0:c1e89c49eae5 47 * wait(0.5);
ppo 0:c1e89c49eae5 48 * }
ppo 0:c1e89c49eae5 49 * }
ppo 0:c1e89c49eae5 50 * }
ppo 0:c1e89c49eae5 51 * @endcode
ppo 0:c1e89c49eae5 52 */
ppo 0:c1e89c49eae5 53 class USBMIDI: public USBDevice {
ppo 0:c1e89c49eae5 54 public:
ppo 0:c1e89c49eae5 55
ppo 0:c1e89c49eae5 56 /**
ppo 0:c1e89c49eae5 57 * Constructor
ppo 0:c1e89c49eae5 58 *
ppo 0:c1e89c49eae5 59 * @param vendor_id Your vendor_id
ppo 0:c1e89c49eae5 60 * @param product_id Your product_id
ppo 0:c1e89c49eae5 61 * @param product_release Your preoduct_release
ppo 0:c1e89c49eae5 62 */
ppo 0:c1e89c49eae5 63 USBMIDI(uint16_t vendor_id = 0x0700, uint16_t product_id = 0x0101, uint16_t product_release = 0x0001);
ppo 0:c1e89c49eae5 64
ppo 0:c1e89c49eae5 65 /**
ppo 0:c1e89c49eae5 66 * Send a MIDIMessage
ppo 0:c1e89c49eae5 67 *
ppo 0:c1e89c49eae5 68 * @param m The MIDIMessage to send
ppo 0:c1e89c49eae5 69 */
ppo 0:c1e89c49eae5 70 void write(MIDIMessage m);
ppo 0:c1e89c49eae5 71
ppo 0:c1e89c49eae5 72 /**
ppo 0:c1e89c49eae5 73 * Attach a callback for when a MIDIEvent is received
ppo 0:c1e89c49eae5 74 *
ppo 0:c1e89c49eae5 75 * @param fptr function pointer
ppo 0:c1e89c49eae5 76 */
ppo 0:c1e89c49eae5 77 void attach(void (*fptr)(MIDIMessage));
ppo 0:c1e89c49eae5 78
ppo 0:c1e89c49eae5 79
ppo 0:c1e89c49eae5 80 protected:
ppo 0:c1e89c49eae5 81 virtual bool EP2_OUT_callback();
ppo 0:c1e89c49eae5 82 virtual bool USBCallback_setConfiguration(uint8_t configuration);
ppo 0:c1e89c49eae5 83 /*
ppo 0:c1e89c49eae5 84 * Get string product descriptor
ppo 0:c1e89c49eae5 85 *
ppo 0:c1e89c49eae5 86 * @returns pointer to the string product descriptor
ppo 0:c1e89c49eae5 87 */
ppo 0:c1e89c49eae5 88 virtual uint8_t * stringIproductDesc();
ppo 0:c1e89c49eae5 89
ppo 0:c1e89c49eae5 90 /*
ppo 0:c1e89c49eae5 91 * Get string interface descriptor
ppo 0:c1e89c49eae5 92 *
ppo 0:c1e89c49eae5 93 * @returns pointer to the string interface descriptor
ppo 0:c1e89c49eae5 94 */
ppo 0:c1e89c49eae5 95 virtual uint8_t * stringIinterfaceDesc();
ppo 0:c1e89c49eae5 96
ppo 0:c1e89c49eae5 97 /*
ppo 0:c1e89c49eae5 98 * Get configuration descriptor
ppo 0:c1e89c49eae5 99 *
ppo 0:c1e89c49eae5 100 * @returns pointer to the configuration descriptor
ppo 0:c1e89c49eae5 101 */
ppo 0:c1e89c49eae5 102 virtual uint8_t * configurationDesc();
ppo 0:c1e89c49eae5 103
ppo 0:c1e89c49eae5 104 private:
ppo 0:c1e89c49eae5 105 void (*midi_evt)(MIDIMessage);
ppo 0:c1e89c49eae5 106
ppo 0:c1e89c49eae5 107 };
ppo 0:c1e89c49eae5 108
ppo 0:c1e89c49eae5 109 #endif