USBMIDI.h

00001 /* @license The MIT License
00002  * Copyright (c) 2011 mux, simon
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *  
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *  
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00020  * THE SOFTWARE.
00021  */
00022 
00023 #ifndef MBED_USBMIDI_H
00024 #define MBED_USBMIDI_H
00025 
00026 #include "MIDIMessage.h"
00027 
00028 /** USBMIDI interface class for sending and receiving MIDI messages over USB */ 
00029 class USBMIDI {
00030 public:
00031 
00032     /** Create the USBMIDI interface */
00033     USBMIDI();
00034     
00035     /** Send a MIDIMessage
00036      * @param m The MIDIMessage to send
00037      */    
00038     void write(MIDIMessage m);
00039         
00040     /** Check if it possible to send a MIDIMessage
00041      * @returns True if there's an empty buffer for sending a MIDIMessage, otherwise False
00042      */                
00043     bool writeable();
00044 
00045     /** Attach a callback for when a MIDIEvent is received */
00046     void attach(void (*fptr)(MIDIMessage));
00047     
00048 }; 
00049 
00050 #endif