GHI Electronics / Mbed 2 deprecated Official_mBot

The preloaded firmware shipped on the mBot.

Dependencies:   mbed

Fork of Official_mBot by Fred Parker

USBDevice/USBMIDI/USBMIDI.h@1:ffd9a51e7d35, 2014-11-25 (annotated)

Committer:
jeffknaggs
Date:
Tue Nov 25 14:49:40 2014 +0000
Revision:
1:ffd9a51e7d35
Parent:
0:865d42c46692 
Initial commit.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jeffknaggs 0:865d42c46692 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
jeffknaggs 0:865d42c46692 2 *
jeffknaggs 0:865d42c46692 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
jeffknaggs 0:865d42c46692 4 * and associated documentation files (the "Software"), to deal in the Software without
jeffknaggs 0:865d42c46692 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
jeffknaggs 0:865d42c46692 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
jeffknaggs 0:865d42c46692 7 * Software is furnished to do so, subject to the following conditions:
jeffknaggs 0:865d42c46692 8 *
jeffknaggs 0:865d42c46692 9 * The above copyright notice and this permission notice shall be included in all copies or
jeffknaggs 0:865d42c46692 10 * substantial portions of the Software.
jeffknaggs 0:865d42c46692 11 *
jeffknaggs 0:865d42c46692 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
jeffknaggs 0:865d42c46692 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
jeffknaggs 0:865d42c46692 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
jeffknaggs 0:865d42c46692 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
jeffknaggs 0:865d42c46692 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
jeffknaggs 0:865d42c46692 17 */
jeffknaggs 0:865d42c46692 18
jeffknaggs 0:865d42c46692 19 #ifndef USBMIDI_H
jeffknaggs 0:865d42c46692 20 #define USBMIDI_H
jeffknaggs 0:865d42c46692 21
jeffknaggs 0:865d42c46692 22 /* These headers are included for child class. */
jeffknaggs 0:865d42c46692 23 #include "USBEndpoints.h"
jeffknaggs 0:865d42c46692 24 #include "USBDescriptor.h"
jeffknaggs 0:865d42c46692 25 #include "USBDevice_Types.h"
jeffknaggs 0:865d42c46692 26
jeffknaggs 0:865d42c46692 27 #include "USBDevice.h"
jeffknaggs 0:865d42c46692 28 #include "MIDIMessage.h"
jeffknaggs 0:865d42c46692 29
jeffknaggs 0:865d42c46692 30 #define DEFAULT_CONFIGURATION (1)
jeffknaggs 0:865d42c46692 31
jeffknaggs 0:865d42c46692 32 /**
jeffknaggs 0:865d42c46692 33 * USBMIDI example
jeffknaggs 0:865d42c46692 34 *
jeffknaggs 0:865d42c46692 35 * @code
jeffknaggs 0:865d42c46692 36 * #include "mbed.h"
jeffknaggs 0:865d42c46692 37 * #include "USBMIDI.h"
jeffknaggs 0:865d42c46692 38 *
jeffknaggs 0:865d42c46692 39 * USBMIDI midi;
jeffknaggs 0:865d42c46692 40 *
jeffknaggs 0:865d42c46692 41 * int main() {
jeffknaggs 0:865d42c46692 42 * while (1) {
jeffknaggs 0:865d42c46692 43 * for(int i=48; i<83; i++) { // send some messages!
jeffknaggs 0:865d42c46692 44 * midi.write(MIDIMessage::NoteOn(i));
jeffknaggs 0:865d42c46692 45 * wait(0.25);
jeffknaggs 0:865d42c46692 46 * midi.write(MIDIMessage::NoteOff(i));
jeffknaggs 0:865d42c46692 47 * wait(0.5);
jeffknaggs 0:865d42c46692 48 * }
jeffknaggs 0:865d42c46692 49 * }
jeffknaggs 0:865d42c46692 50 * }
jeffknaggs 0:865d42c46692 51 * @endcode
jeffknaggs 0:865d42c46692 52 */
jeffknaggs 0:865d42c46692 53 class USBMIDI: public USBDevice {
jeffknaggs 0:865d42c46692 54 public:
jeffknaggs 0:865d42c46692 55
jeffknaggs 0:865d42c46692 56 /**
jeffknaggs 0:865d42c46692 57 * Constructor
jeffknaggs 0:865d42c46692 58 *
jeffknaggs 0:865d42c46692 59 * @param vendor_id Your vendor_id
jeffknaggs 0:865d42c46692 60 * @param product_id Your product_id
jeffknaggs 0:865d42c46692 61 * @param product_release Your preoduct_release
jeffknaggs 0:865d42c46692 62 */
jeffknaggs 0:865d42c46692 63 USBMIDI(uint16_t vendor_id = 0x0700, uint16_t product_id = 0x0101, uint16_t product_release = 0x0001);
jeffknaggs 0:865d42c46692 64
jeffknaggs 0:865d42c46692 65 /**
jeffknaggs 0:865d42c46692 66 * Send a MIDIMessage
jeffknaggs 0:865d42c46692 67 *
jeffknaggs 0:865d42c46692 68 * @param m The MIDIMessage to send
jeffknaggs 0:865d42c46692 69 */
jeffknaggs 0:865d42c46692 70 void write(MIDIMessage m);
jeffknaggs 0:865d42c46692 71
jeffknaggs 0:865d42c46692 72 /**
jeffknaggs 0:865d42c46692 73 * Attach a callback for when a MIDIEvent is received
jeffknaggs 0:865d42c46692 74 *
jeffknaggs 0:865d42c46692 75 * @param fptr function pointer
jeffknaggs 0:865d42c46692 76 */
jeffknaggs 0:865d42c46692 77 void attach(void (*fptr)(MIDIMessage));
jeffknaggs 0:865d42c46692 78
jeffknaggs 0:865d42c46692 79
jeffknaggs 0:865d42c46692 80 protected:
jeffknaggs 0:865d42c46692 81 virtual bool EP2_OUT_callback();
jeffknaggs 0:865d42c46692 82 virtual bool USBCallback_setConfiguration(uint8_t configuration);
jeffknaggs 0:865d42c46692 83 /*
jeffknaggs 0:865d42c46692 84 * Get string product descriptor
jeffknaggs 0:865d42c46692 85 *
jeffknaggs 0:865d42c46692 86 * @returns pointer to the string product descriptor
jeffknaggs 0:865d42c46692 87 */
jeffknaggs 0:865d42c46692 88 virtual uint8_t * stringIproductDesc();
jeffknaggs 0:865d42c46692 89
jeffknaggs 0:865d42c46692 90 /*
jeffknaggs 0:865d42c46692 91 * Get string interface descriptor
jeffknaggs 0:865d42c46692 92 *
jeffknaggs 0:865d42c46692 93 * @returns pointer to the string interface descriptor
jeffknaggs 0:865d42c46692 94 */
jeffknaggs 0:865d42c46692 95 virtual uint8_t * stringIinterfaceDesc();
jeffknaggs 0:865d42c46692 96
jeffknaggs 0:865d42c46692 97 /*
jeffknaggs 0:865d42c46692 98 * Get configuration descriptor
jeffknaggs 0:865d42c46692 99 *
jeffknaggs 0:865d42c46692 100 * @returns pointer to the configuration descriptor
jeffknaggs 0:865d42c46692 101 */
jeffknaggs 0:865d42c46692 102 virtual uint8_t * configurationDesc();
jeffknaggs 0:865d42c46692 103
jeffknaggs 0:865d42c46692 104 private:
jeffknaggs 0:865d42c46692 105 void (*midi_evt)(MIDIMessage);
jeffknaggs 0:865d42c46692 106
jeffknaggs 0:865d42c46692 107 };
jeffknaggs 0:865d42c46692 108
jeffknaggs 0:865d42c46692 109 #endif