Daniel Bartlett / USBDevice

USBDevice

Fork of USBDevice by mbed official

USBMIDI/USBMIDI.h@10:378e9df8157a, 2013-04-05 (annotated)

Committer:
DanBUK
Date:
Fri Apr 05 07:09:26 2013 +0000
Revision:
10:378e9df8157a
Parent:
1:80ab0d068708 
Making this look like an Apple USB keyboard, saves identification...

Who changed what in which revision?

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