MIDIEvent.NoteOn: midi1ZeroVelocityAsNoteOff now defaults to false

Author: orchetect

Sources/MIDIKitCore/Events/MIDIEvent/Channel Voice/Note/NoteOn/NoteOn.swift

@@ -26,7 +26,7 @@ extension MIDIEvent {
         /// UMP Group (`0x0 ... 0xF`)
         public var group: UInt4 = 0x0
 
-        /// For MIDI 1.0, transmit velocity of 0 as a Note Off event.
+        /// For MIDI 1.0, translate velocity of 0 as a Note Off event.
         public var midi1ZeroVelocityAsNoteOff: Bool = true
 
         /// Channel Voice Message: Note On
@@ -38,15 +38,15 @@ extension MIDIEvent {
         ///   - channel: Channel Number (`0x0 ... 0xF`)
         ///   - attribute: MIDI 2.0 Channel Voice Attribute
         ///   - group: UMP Group (`0x0 ... 0xF`)
-        ///   - midi1ZeroVelocityAsNoteOff: For MIDI 1.0, transmit velocity of 0 as a Note Off
+        ///   - midi1ZeroVelocityAsNoteOff: For MIDI 1.0, translate velocity of 0 as a Note Off
         /// event.
         public init(
             note: UInt7,
             velocity: MIDIEvent.NoteVelocity,
             attribute: MIDIEvent.NoteAttribute = .none,
             channel: UInt4,
             group: UInt4 = 0x0,
-            midi1ZeroVelocityAsNoteOff: Bool = true
+            midi1ZeroVelocityAsNoteOff: Bool = false
         ) {
             self.note = MIDINote(note)
             self.velocity = velocity
@@ -65,15 +65,15 @@ extension MIDIEvent {
         ///   - channel: Channel Number (`0x0 ... 0xF`)
         ///   - attribute: MIDI 2.0 Channel Voice Attribute
         ///   - group: UMP Group (`0x0 ... 0xF`)
-        ///   - midi1ZeroVelocityAsNoteOff: For MIDI 1.0, transmit velocity of 0 as a Note Off
+        ///   - midi1ZeroVelocityAsNoteOff: For MIDI 1.0, translate velocity of 0 as a Note Off
         /// event.
         public init(
             note: MIDINote,
             velocity: MIDIEvent.NoteVelocity,
             attribute: MIDIEvent.NoteAttribute = .none,
             channel: UInt4,
             group: UInt4 = 0x0,
-            midi1ZeroVelocityAsNoteOff: Bool = true
+            midi1ZeroVelocityAsNoteOff: Bool = false
         ) {
             self.note = note
             self.velocity = velocity
@@ -119,14 +119,14 @@ extension MIDIEvent {
     ///   - channel: Channel Number (`0x0 ... 0xF`)
     ///   - attribute: MIDI 2.0 Channel Voice Attribute
     ///   - group: UMP Group (`0x0 ... 0xF`)
-    ///   - midi1ZeroVelocityAsNoteOff: For MIDI 1.0, transmit velocity of 0 as a Note Off event.
+    ///   - midi1ZeroVelocityAsNoteOff: For MIDI 1.0, translate velocity of 0 as a Note Off event.
     public static func noteOn(
         _ note: UInt7,
         velocity: NoteVelocity,
         attribute: NoteAttribute = .none,
         channel: UInt4,
         group: UInt4 = 0x0,
-        midi1ZeroVelocityAsNoteOff: Bool = true
+        midi1ZeroVelocityAsNoteOff: Bool = false
     ) -> Self {
         .noteOn(
             .init(
@@ -149,14 +149,14 @@ extension MIDIEvent {
     ///   - channel: Channel Number (`0x0 ... 0xF`)
     ///   - attribute: MIDI 2.0 Channel Voice Attribute
     ///   - group: UMP Group (`0x0 ... 0xF`)
-    ///   - midi1ZeroVelocityAsNoteOff: For MIDI 1.0, transmit velocity of 0 as a Note Off event.
+    ///   - midi1ZeroVelocityAsNoteOff: For MIDI 1.0, translate velocity of 0 as a Note Off event.
     public static func noteOn(
         _ note: MIDINote,
         velocity: NoteVelocity,
         attribute: NoteAttribute = .none,
         channel: UInt4,
         group: UInt4 = 0x0,
-        midi1ZeroVelocityAsNoteOff: Bool = true
+        midi1ZeroVelocityAsNoteOff: Bool = false
     ) -> Self {
         .noteOn(
             .init(

Tests/MIDIKitSMFTests/Event/Events/Event Note On Tests.swift

@@ -69,29 +69,43 @@ final class Event_NoteOn_Tests: XCTestCase {
         XCTAssertEqual(event.channel, 0)
     }
 
-    func testMIDI1SMFRawBytes_Velocity0_Defaulted() {
+    func testMIDI1SMFRawBytes_Velocity0_NoTranslation() {
         let event = MIDIFileEvent.NoteOn(
             note: 60,
             velocity: .midi1(0x00),
-            channel: 0
+            channel: 0,
+            midi1ZeroVelocityAsNoteOff: false
         )
 
         let bytes: [UInt8] = event.midi1SMFRawBytes()
 
-        XCTAssertEqual(bytes, [0x80, 0x3C, 0x00]) // interpreted as Note Off
+        XCTAssertEqual(bytes, [0x90, 0x3C, 0x00])
     }
 
     func testMIDI1SMFRawBytes_Velocity0_TranslateOff() {
         let event = MIDIFileEvent.NoteOn(
             note: 60,
             velocity: .midi1(0x00),
             channel: 0,
-            midi1ZeroVelocityAsNoteOff: false
+            midi1ZeroVelocityAsNoteOff: true
         )
 
         let bytes: [UInt8] = event.midi1SMFRawBytes()
 
-        XCTAssertEqual(bytes, [0x90, 0x3C, 0x00])
+        XCTAssertEqual(bytes, [0x80, 0x3C, 0x00]) // interpreted as Note Off
+    }
+    
+    func testMIDI1SMFRawBytes_Velocity1_TranslateOff() {
+        let event = MIDIFileEvent.NoteOn(
+            note: 60,
+            velocity: .midi1(0x01),
+            channel: 0,
+            midi1ZeroVelocityAsNoteOff: true
+        )
+        
+        let bytes: [UInt8] = event.midi1SMFRawBytes()
+        
+        XCTAssertEqual(bytes, [0x90, 0x3C, 0x01])
     }
 }