Merge pull request #37 from orchetect/dev

Refactored MIDI packet read
orchetect · Sep 3, 2021 · 8d9cc7b · 8d9cc7b
2 parents 1eb158b + 9414dc7
commit 8d9cc7b
Show file tree

Hide file tree

Showing 9 changed files with 120 additions and 96 deletions.
diff --git a/Sources/MIDIKit/IO/Core MIDI/MIDIEventList/MIDIEventList MKUnsafeSequence.swift b/Sources/MIDIKit/IO/Core MIDI/MIDIEventList/MIDIEventList MKUnsafeSequence.swift
diff --git a/Sources/MIDIKit/IO/Core MIDI/MIDIEventList/MIDIEventList PacketPointers.swift b/Sources/MIDIKit/IO/Core MIDI/MIDIEventList/MIDIEventList PacketPointers.swift
@@ -0,0 +1,26 @@
+//
+//  MIDIEventList PacketPointers.swift
+//  MIDIKit • https://github.com/orchetect/MIDIKit
+//
+
+import Foundation
+import CoreMIDI
+
+@available(macOS 11, iOS 14, macCatalyst 14, tvOS 14, watchOS 7, *)
+extension UnsafePointer where Pointee == MIDIEventList {
+
+    @inline(__always)
+    func packetsPointers() -> [UnsafePointer<MIDIEventPacket>] {
+
+        Array(unsafeSequence())
+
+    }
+
+    @inline(__always)
+    func packets() -> [MIDI.Packet.UniversalPacketData] {
+
+        unsafeSequence().map { MIDI.Packet.UniversalPacketData($0) }
+
+    }
+
+}
diff --git a/Sources/MIDIKit/IO/Core MIDI/MIDIPacketLIst/MIDIPacketList MKUnsafeSequence.swift b/Sources/MIDIKit/IO/Core MIDI/MIDIPacketLIst/MIDIPacketList MKUnsafeSequence.swift
@@ -9,7 +9,7 @@ import CoreMIDI
 extension UnsafePointer where Pointee == MIDIPacketList {
 
     /// MIDIKit backwards-compatible implementation of Core MIDI's `MIDIPacketList.UnsafeSequence`
-    public func mkUnsafeSequence() -> MIDIPacketList.MKUnsafeSequence {
+    internal func mkUnsafeSequence() -> MIDIPacketList.MKUnsafeSequence {
 
         MIDIPacketList.MKUnsafeSequence(self)
 
@@ -20,7 +20,7 @@ extension UnsafePointer where Pointee == MIDIPacketList {
 extension MIDIPacketList {
 
     /// MIDIKit backwards-compatible implementation of Core MIDI's `MIDIPacketList.UnsafeSequence`
-    public struct MKUnsafeSequence: Sequence {
+    internal struct MKUnsafeSequence: Sequence {
 
         public typealias Element = UnsafePointer<MIDIPacket>
 
@@ -33,6 +33,9 @@ extension MIDIPacketList {
                 pointers.append(unwrappedPtr)
             }
 
+            assert(pointers.count == midiPacketListPtr.pointee.numPackets,
+                   "Packet count does not match iterated count.")
+
         }
 
         public func makeIterator() -> Iterator {

diff --git a/Sources/MIDIKit/IO/Core MIDI/MIDIPacketLIst/MIDIPacketList PacketPointers.swift b/Sources/MIDIKit/IO/Core MIDI/MIDIPacketLIst/MIDIPacketList PacketPointers.swift
@@ -0,0 +1,29 @@
+//
+//  MIDIPacketList PacketPointers.swift
+//  MIDIKit • https://github.com/orchetect/MIDIKit
+//
+
+import Foundation
+import CoreMIDI
+
+extension UnsafePointer where Pointee == MIDIPacketList {
+
+    func packetsPointers() -> [UnsafePointer<MIDIPacket>] {
+
+        // prefer newer Core MIDI API if platform supports it
+
+        if #available(macOS 10.15, iOS 13.0, macCatalyst 13.0, *) {
+            return Array(unsafeSequence())
+        } else {
+            return mkUnsafeSequence().pointers
+        }
+
+    }
+
+    func packets() -> [MIDI.Packet.PacketData] {
+
+        packetsPointers().map { MIDI.Packet.PacketData($0) }
+
+    }
+
+}
diff --git a/Sources/MIDIKit/IO/ReceiveHandler/Handlers/Events.swift b/Sources/MIDIKit/IO/ReceiveHandler/Handlers/Events.swift
@@ -22,9 +22,8 @@ extension MIDI.IO.ReceiveHandler {
             _ srcConnRefCon: UnsafeMutableRawPointer?
         ) {
 
-            for midiPacketPacketPtr in packetListPtr.mkUnsafeSequence() {
-                let packetData = MIDI.Packet.PacketData(midiPacketPacketPtr)
-                let events = midi1Parser.parsedEvents(in: packetData)
+            for midiPacket in packetListPtr.packets() {
+                let events = midi1Parser.parsedEvents(in: midiPacket)
                 handler(events)
             }
 
@@ -36,9 +35,8 @@ extension MIDI.IO.ReceiveHandler {
             _ srcConnRefCon: UnsafeMutableRawPointer?
         ) {
 
-            for universalMIDIPacketPtr in eventListPtr.mkSequence() {
-                let universalPacketData = MIDI.Packet.UniversalPacketData(universalMIDIPacketPtr)
-                let events = midi2Parser.parsedEvents(in: universalPacketData)
+            for midiPacket in eventListPtr.packets() {
+                let events = midi2Parser.parsedEvents(in: midiPacket)
                 handler(events)
             }
 

diff --git a/Sources/MIDIKit/IO/ReceiveHandler/Handlers/EventsLogging.swift b/Sources/MIDIKit/IO/ReceiveHandler/Handlers/EventsLogging.swift
@@ -27,9 +27,8 @@ extension MIDI.IO.ReceiveHandler {
             _ srcConnRefCon: UnsafeMutableRawPointer?
         ) {
 
-            for midiPacketPacketPtr in packetListPtr.mkUnsafeSequence() {
-                let packetData = MIDI.Packet.PacketData(midiPacketPacketPtr)
-                let events = midi1Parser.parsedEvents(in: packetData)
+            for midiPacket in packetListPtr.packets() {
+                let events = midi1Parser.parsedEvents(in: midiPacket)
                 logEvents(events)
             }
 
@@ -41,9 +40,8 @@ extension MIDI.IO.ReceiveHandler {
             _ srcConnRefCon: UnsafeMutableRawPointer?
         ) {
 
-            for universalMIDIPacketPtr in eventListPtr.mkSequence() {
-                let universalPacketData = MIDI.Packet.UniversalPacketData(universalMIDIPacketPtr)
-                let events = midi2Parser.parsedEvents(in: universalPacketData)
+            for midiPacket in eventListPtr.packets() {
+                let events = midi2Parser.parsedEvents(in: midiPacket)
                 logEvents(events)
             }
 

diff --git a/Sources/MIDIKit/IO/ReceiveHandler/Handlers/RawData.swift b/Sources/MIDIKit/IO/ReceiveHandler/Handlers/RawData.swift
@@ -19,9 +19,8 @@ extension MIDI.IO.ReceiveHandler {
             _ srcConnRefCon: UnsafeMutableRawPointer?
         ) {
 
-            for midiPacketPacketPtr in packetListPtr.mkUnsafeSequence() {
-                let packetData = MIDI.Packet.PacketData(midiPacketPacketPtr)
-                let typeErasedPacket = MIDI.Packet.packet(packetData)
+            for midiPacket in packetListPtr.packets() {
+                let typeErasedPacket = MIDI.Packet.packet(midiPacket)
                 handler(typeErasedPacket)
             }
 
@@ -33,9 +32,8 @@ extension MIDI.IO.ReceiveHandler {
             _ srcConnRefCon: UnsafeMutableRawPointer?
         ) {
 
-            for universalMIDIPacketPtr in eventListPtr.mkSequence() { 
-                let universalPacketData = MIDI.Packet.UniversalPacketData(universalMIDIPacketPtr)
-                let typeErasedPacket = MIDI.Packet.universalPacket(universalPacketData)
+            for midiPacket in eventListPtr.packets() {
+                let typeErasedPacket = MIDI.Packet.universalPacket(midiPacket)
                 handler(typeErasedPacket)
             }
 

diff --git a/Sources/MIDIKit/IO/ReceiveHandler/Handlers/RawDataLogging.swift b/Sources/MIDIKit/IO/ReceiveHandler/Handlers/RawDataLogging.swift
@@ -26,9 +26,8 @@ extension MIDI.IO.ReceiveHandler {
             _ srcConnRefCon: UnsafeMutableRawPointer?
         ) {
 
-            for midiPacketPacketPtr in packetListPtr.mkUnsafeSequence() {
-                let packetData = MIDI.Packet.PacketData(midiPacketPacketPtr)
-                handleBytes(packetData.bytes)
+            for midiPacket in packetListPtr.packets() {
+                handleBytes(midiPacket.bytes)
             }
 
         }
@@ -39,9 +38,8 @@ extension MIDI.IO.ReceiveHandler {
             _ srcConnRefCon: UnsafeMutableRawPointer?
         ) {
 
-            for universalMIDIPacketPtr in eventListPtr.mkSequence() {
-                let universalPacketData = MIDI.Packet.UniversalPacketData(universalMIDIPacketPtr)
-                handleBytes(universalPacketData.bytes)
+            for midiPacket in eventListPtr.packets() {
+                handleBytes(midiPacket.bytes)
             }
 
         }

diff --git a/Sources/MIDIKit/Packet/UniversalPacketData/UniversalPacketData.swift b/Sources/MIDIKit/Packet/UniversalPacketData/UniversalPacketData.swift
@@ -33,6 +33,14 @@ extension MIDI.Packet {
 
         }
 
+        /// Universal MIDI Packet
+        @available(macOS 11, iOS 14, macCatalyst 14, tvOS 14, watchOS 7, *)
+        @inline(__always) public init(_ eventPacketPtr: UnsafePointer<MIDIEventPacket>) {
+
+            self = Self.packetUnwrapper(eventPacketPtr)
+
+        }
+
         /// Universal MIDI Packet
         @available(macOS 11, iOS 14, macCatalyst 14, tvOS 14, watchOS 7, *)
         @inline(__always) public init(_ eventPacket: MIDIEventPacket) {
@@ -48,6 +56,42 @@ extension MIDI.Packet {
 @available(macOS 11, iOS 14, macCatalyst 14, tvOS 14, watchOS 7, *)
 extension MIDI.Packet.UniversalPacketData {
 
+    @inline(__always) fileprivate
+    static func packetUnwrapper(
+        _ eventPacketPtr: UnsafePointer<MIDIEventPacket>
+    ) -> MIDI.Packet.UniversalPacketData {
+
+        let wordCollection = MIDIEventPacket.WordCollection(eventPacketPtr)
+
+        guard wordCollection.count > 0 else {
+            return MIDI.Packet.UniversalPacketData(
+                words: [],
+                timeStamp: eventPacketPtr.pointee.timeStamp
+            )
+        }
+
+        guard wordCollection.count <= 64 else {
+            assertionFailure("Received MIDIEventPacket reporting \(wordCollection.count) words.")
+            return MIDI.Packet.UniversalPacketData(
+                words: [],
+                timeStamp: eventPacketPtr.pointee.timeStamp
+            )
+        }
+
+        var words: [UInt32] = []
+        words.reserveCapacity(wordCollection.count)
+
+        for word in wordCollection {
+            words.append(word)
+        }
+
+        return MIDI.Packet.UniversalPacketData(
+            words: words,
+            timeStamp: eventPacketPtr.pointee.timeStamp
+        )
+
+    }
+
     @inline(__always) fileprivate
     static func packetUnwrapper(
         _ eventPacket: MIDIEventPacket