Merge branch 'develop' into sequencer-thread-safety

Author: aure

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,4 +2,4 @@
 
 Try to make sure your changes conform to the [Swift API Design Guidelines](https://swift.org/documentation/api-design-guidelines/). If you have 40 minutes you'd like to have well-spent, watch [Modern Swift API Design](https://developer.apple.com/videos/play/wwdc2019/415/) from WWDC 2019.
 
-Ready to send us a pull request? Please make sure your request is based on the a `develop` branch of the repository since `main` should only hold stable releases.
+Ready to send us a pull request? Please make sure your request is based on the `develop` branch of the repository since `main` should only hold stable releases.

README.md

@@ -11,7 +11,7 @@
 
 </div>
 
-This extension to AudioKit contains all of the AudioKit features that rely on C/C++ DSP. 
+This extension to AudioKit contains all of the AudioKit features that rely on C/C++ DSP.
 
 ## Documentation
 

Sources/AudioKitEX/Sequencing/Sequence.swift

@@ -40,12 +40,9 @@ extension Array where Element == SequenceEvent {
         return self.sorted(by: { (event1:SequenceEvent, event2:SequenceEvent) -> Bool in
             let event1Beat = event1.beat
             let event2Beat = event2.beat
-            let simultaneous = (event1Beat == event2Beat) && (event1.data1 == event2.data1)
-            if isNoteOn(event1.status) && isNoteOff(event2.status) && simultaneous {
-                return false
-            }
-            if isNoteOff(event1.status) && isNoteOn(event2.status) && simultaneous {
-                return true
+            if event1Beat == event2Beat {
+                if isNoteOn(event1.status) && isNoteOff(event2.status) { return false }
+                if isNoteOff(event1.status) && isNoteOn(event2.status) { return true }
             }
             return event1Beat < event2Beat
         })
@@ -64,7 +61,7 @@ extension Array where Element == SequenceEvent {
 public struct NoteEventSequence: Equatable {
     /// Array of sequence notes
     public var notes: [SequenceNote]
-    /// Array of sequenc events
+    /// Array of sequence events
     public var events: [SequenceEvent]
 
     /// Initialize with notes and events
@@ -115,7 +112,7 @@ public struct NoteEventSequence: Equatable {
         notes.removeAll { $0.noteOn.beat == position }
     }
 
-    /// Remove all occurences of a certain MIDI Note nUmber
+    /// Remove all occurrences of a certain MIDI Note nUmber
     /// - Parameter noteNumber: Note to remove
     public mutating func removeAllInstancesOf(noteNumber: MIDINoteNumber) {
         notes.removeAll { $0.noteOn.data1 == noteNumber }

Sources/AudioKitEX/Sequencing/Sequencer.swift

@@ -173,7 +173,7 @@ open class Sequencer {
         stop()
     }
 
-    /// Retrived a track for a given node
+    /// Retrieved a track for a given node
     /// - Parameter node: Node you want to access the tack for
     /// - Returns: Track associated with the given node
     public func getTrackFor(node: Node) -> SequencerTrack? {

Sources/AudioKitEX/Sequencing/SequencerTrack.swift

@@ -72,7 +72,7 @@ open class SequencerTrack {
         akSequencerEngineStopPlayingNotes(engine)
     }
 
-    /// Set the current position to the start ofthe track
+    /// Set the current position to the start of the track
     public func rewind() {
         seek(to: 0)
     }

Sources/CAudioKitEX/Nodes/CallbackInstrumentDSP.mm

@@ -13,21 +13,26 @@
     // MARK: Member Functions
 
     RingBuffer<AUMIDIEvent> midiBuffer;
-    NSTimer* timer;
+    dispatch_source_t timer;
 
     CallbackInstrumentDSP() {
         // Hopefully this polling interval is ok.
-        timer = [NSTimer timerWithTimeInterval:0.01
-                                       repeats:true
-                                         block:^(NSTimer * _Nonnull timer) {
+        static dispatch_once_t onceToken;
+        static dispatch_queue_t timerQueue;
+        dispatch_once(&onceToken, ^{
+            timerQueue = dispatch_queue_create("audio.kit.timer.queue", DISPATCH_QUEUE_CONCURRENT);
+        });
+        timer = dispatch_source_create(DISPATCH_SOURCE_TYPE_TIMER, 0, 0, timerQueue);
+        dispatch_source_set_timer(timer, DISPATCH_TIME_NOW, 0.01 * NSEC_PER_SEC, 0);
+        dispatch_source_set_event_handler(timer, ^{
             consumer();
-        }];
-        NSRunLoop *runner = [NSRunLoop currentRunLoop];
-        [runner addTimer:timer forMode: NSDefaultRunLoopMode];
+        });
+        dispatch_resume(timer);
     }
 
     ~CallbackInstrumentDSP() {
-        [timer invalidate];
+        dispatch_source_cancel(timer);
+        timer = nil;
     }
 
     void process(FrameRange range) override {

Sources/CAudioKitEX/include/CAudioKit.h

@@ -29,7 +29,7 @@ FOUNDATION_EXPORT const unsigned char AudioKitVersionString[];
 #import "ParameterRamper.h"
 #import "ParameterAutomation.h"
 
-// Swift/ObjC/C/C++ Inter-operability
+// Swift/ObjC/C/C++ Interoperability
 #import "Interop.h"
 
 CF_EXTERN_C_BEGIN

Sources/CAudioKitEX/include/DebugDSP.h

@@ -9,7 +9,7 @@
 extern "C" {
 #endif
 
-/// Activate or deactive DSP kernel debugging.
+/// Activate or deactivate DSP kernel debugging.
 void DebugDSPSetActive(bool active);
 
 /// Update the hash at the selected slot with a new value.

Sources/CAudioKitEX/include/ParameterRamper.h

@@ -16,7 +16,6 @@
 #import <atomic>
 
 class ParameterRamper {
-    float clampLow, clampHigh;
     std::atomic<float> _uiValue{0};
     float _goal;
     float inverseSlope;

Tests/AudioKitEXTests/SequenceTests.swift

@@ -52,5 +52,55 @@ class NoteEventSequenceTests: XCTestCase {
         XCTAssertEqual(seq.notes[1].noteOn.data1, 62)
     }
 
+    func testNoteOffAlwaysBeforeNoteOnInBeatTimeOrdered() {
+        let noteOn = SequenceEvent(status: noteOnByte, data1: 60, data2: 0, beat: 0)
+        let noteOff = SequenceEvent(status: noteOffByte, data1: 60, data2: 0, beat: 0)
+        let otherNoteOn = SequenceEvent(status: noteOnByte, data1: 61, data2: 0, beat: 0)
+
+        let sequences = [
+            [noteOn, noteOff, otherNoteOn],
+            [noteOn, otherNoteOn, noteOff],
+            [noteOff, noteOn , otherNoteOn],
+            [noteOff, otherNoteOn, noteOn],
+            [otherNoteOn, noteOn, noteOff],
+            [otherNoteOn, noteOff, noteOn]
+        ]
+
+        for sequence in sequences {
+            let ordered = sequence.beatTimeOrdered()
+            XCTAssertLessThan(ordered.firstIndex(of: noteOff)!, ordered.firstIndex(of: noteOn)!)
+        }
+    }
+
+    func testEarlierNoteBeforeInBeatTimeOrderedForSameNoteSameStatus() {
+        let earlier = SequenceEvent(status: noteOnByte, data1: 60, data2: 0, beat: 0)
+        let later = SequenceEvent(status: noteOnByte, data1: 60, data2: 0, beat: 1)
+
+        let sequences = [
+            [earlier, later],
+            [later, earlier],
+        ]
+
+        for sequence in sequences {
+            let ordered = sequence.beatTimeOrdered()
+            XCTAssertLessThan(ordered.firstIndex(of: earlier)!, ordered.firstIndex(of: later)!)
+        }
+    }
+
+    func testEarlierNoteBeforeInBeatTimeOrderedForSameNoteDifferentStatus() {
+        let earlier = SequenceEvent(status: noteOnByte, data1: 60, data2: 0, beat: 0)
+        let later = SequenceEvent(status: noteOffByte, data1: 60, data2: 0, beat: 1)
+
+        let sequences = [
+            [earlier, later],
+            [later, earlier],
+        ]
+
+        for sequence in sequences {
+            let ordered = sequence.beatTimeOrdered()
+            XCTAssertLessThan(ordered.firstIndex(of: earlier)!, ordered.firstIndex(of: later)!)
+        }
+    }
+
 }
 #endif