Brandon Yee / Mbed 2 deprecated Slingshot

Slingshot Controller

Dependencies:   ADXL345 DebounceIn USBDevice mbed

USBDevice/USBMIDI/USBMIDI.h@1:2721dc2acc2c, 2012-10-17 (annotated)

Committer:
Brandon
Date:
Wed Oct 17 16:33:04 2012 +0000
Revision:
1:2721dc2acc2c
Parent:
0:cf17ea89fd09 
Updated comments, added names, cleaned old code.

Who changed what in which revision?

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