Diff: USBMIDI.h

Revision:

1:ff74eabe02cd

Parent:

0:56b095524cf2

Child:

2:10d694d6ccdc

diff -r 56b095524cf2 -r ff74eabe02cd USBMIDI.h
--- a/USBMIDI.h	Sun Feb 06 17:26:29 2011 +0000
+++ b/USBMIDI.h	Sun Feb 20 13:10:05 2011 +0000
@@ -1,26 +1,50 @@
+/** @license The MIT License
+ * Copyright (c) 2011 mux, simon
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *  
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *  
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
 #ifndef MBED_USBMIDI_H
 #define MBED_USBMIDI_H
 
 #include "MIDIMessage.h"
 
+/** USBMIDI interface class for sending and receiving MIDI messages over USB */ 
 class USBMIDI {
 public:
-	USBMIDI() {}
-	~USBMIDI() {}
-		
-	// write messages
-	void write(MIDIMessage m) {}
-	int writeable() { return 0; }
-		
-	// read messages
-	MIDIMessage read() { return MIDIMessage::NoteOn(0); }
-	int readable() { return 0; }
-		
-	// notification of incoming message
-	void attach(void (*fptr)(void)) {}
-	
-	template <class T>
-	void attach(T *tptr, void (T::*mptr)(void)) {}
+
+    /** Create the USBMIDI interface */
+    USBMIDI();
+    
+    /** Send a MIDIMessage
+     * @param m The MIDIMessage to send
+     */    
+    void write(MIDIMessage m);
+        
+    /** Check if it possible to send a MIDIMessage
+     * @returns True if there's an empty buffer for sending a MIDIMessage, otherwise False
+     */                
+    bool writeable();
+
+    /** Attach a callback for when a MIDIEvent is received */
+    void attach(void (*fptr)(MIDIMessage));
+    
 }; 
 
 #endif