do not allow smf_source's reads to stomp on cached read_end position in parent class...
[ardour.git] / libs / evoral / evoral / midi_util.h
index 3d6ac095bb7facf92ea954841bdd04e155e1fab6..6dee8945469670e718d5b6e60381a7bd498e05a7 100644 (file)
 #ifndef EVORAL_MIDI_UTIL_H
 #define EVORAL_MIDI_UTIL_H
 
+#include <stdint.h>
+#include <stdbool.h>
+#include <string>
+#include <sys/types.h>
 #include <assert.h>
-
 #include "evoral/midi_events.h"
 
 namespace Evoral {
 
+
 /** Return the size of the given event including the status byte,
- * or -1 if unknown (eg sysex)
+ * or -1 if unknown (e.g. sysex)
  */
 static inline int
-midi_event_size(unsigned char status)
+midi_event_size(uint8_t status)
 {
        // if we have a channel event
        if (status >= 0x80 && status < 0xF0) {
@@ -68,23 +72,25 @@ midi_event_size(unsigned char status)
        return -1;
 }
 
-/** Return the size of the given event including the status byte
- * (which must be the first byte in \a buffer),
- * or -1 if unknown (eg sysex)
+/** Return the size of the given event including the status byte,
+ * or -1 if event is illegal.
  */
 static inline int
-midi_event_size(uint8_t* buffer)
+midi_event_size(const uint8_t* buffer)
 {
        uint8_t status = buffer[0];
        
-       // if we have a channel event
+       // Mask off channel if applicable
        if (status >= 0x80 && status < 0xF0) {
-               status &= 0xF0; // mask off the channel
+               status &= 0xF0;
        }
-       
+
+       // see http://www.midi.org/techspecs/midimessages.php
        if (status == MIDI_CMD_COMMON_SYSEX) {
                int end;
-               for (end = 1; buffer[end] != MIDI_CMD_COMMON_SYSEX_END; end++) {}
+               for (end = 1; buffer[end] != MIDI_CMD_COMMON_SYSEX_END; end++) {
+                       assert((buffer[end] & 0x80) == 0);
+               }
                assert(buffer[end] == MIDI_CMD_COMMON_SYSEX_END);
                return end + 1;
        } else {
@@ -92,6 +98,25 @@ midi_event_size(uint8_t* buffer)
        }
 }
 
+/** Return true iff the given buffer is a valid MIDI event.
+ * \a len must be exactly correct for the contents of \a buffer
+ */
+static inline bool
+midi_event_is_valid(const uint8_t* buffer, size_t len)
+{
+       uint8_t status = buffer[0];
+       if (status < 0x80) {
+               return false;
+       }
+       const int size = midi_event_size(buffer);
+       if (size < 0 || (size_t)size != len) {
+               return false;
+       }
+       return true;
+}
+
+std::string midi_note_name (uint8_t noteval);
+
 } // namespace Evoral
 
 #endif // EVORAL_MIDI_UTIL_H