Merge pull request #6 from dsmurfin/receiver

Add receiver functionality

Author: dsmurfin

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Dan Murfin
+Copyright (c) 2023 Dan Murfin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Package.swift

@@ -6,8 +6,8 @@ import PackageDescription
 let package = Package(
     name: "sACNKit",
     platforms: [
-        .iOS(.v10),
-        .macOS(.v10_14),
+        .iOS(.v12),
+        .macOS(.v11),
     ],
     products: [
         .library(

README.md

@@ -1,3 +1,23 @@
 # sACNKit
 
-A description of this package.
+An implementation of ANSI E1.31-2018 Entertainment Technology Lightweight streaming protocol for transport of DMX512 using ACN (sACN)
+
+## Source
+
+`sACNSource`
+
+## Receiver
+
+`sACNReceiverGroup`
+
+`sACNReceiver`
+
+## Discovery Receiver
+
+`sACNDiscoveryReceiver`
+
+## Advanced
+
+`sACNReceiverRaw`
+
+`sACNMerger`

Sources/sACNKit/Layers/DMPLayer.swift

@@ -1,7 +1,7 @@
 //
 //  DMPLayer.swift
 //
-//  Copyright (c) 2022 Daniel Murfin
+//  Copyright (c) 2023 Daniel Murfin
 //
 //  Permission is hereby granted, free of charge, to any person obtaining a copy
 //  of this software and associated documentation files (the "Software"), to deal
@@ -27,16 +27,17 @@ import Foundation
 /// DMP Layer
 ///
 /// Implements the DMP Layer and handles creation and parsing.
-///
 struct DMPLayer {
 
     /// The flags and length. 0x720b: 20b = 523 (starting octet 115) = 638
+    /// This must only be used for constructing packets as received packets may have differing lengths.
     private static let flagsAndLength = Data([0x72, 0x0b])
 
     /// The address type and data type, first property address (DMX512-A START Code is at DMP address 0), and address increment.
     private static let addressPropertyBlock = Data([0xa1, 0x00, 0x00, 0x00, 0x01])
 
     /// The number of slots in the message (plus the START Code).
+    /// This must only be used for constructing packets as received packets may have differing lengths.
     private static let propertyValueCount = Data([0x02, 0x01])
 
     /// DMP Layer Vectors
@@ -62,19 +63,8 @@ struct DMPLayer {
         case propertyValues = 10
     }
 
-    /// DMP Layer DMX512-A START Codes
-    ///
-    /// Enumerates the data offset for each field in this layer.
-    ///
-    enum STARTCode: UInt8 {
-        /// Contains dmx level data.
-        case null = 0x00
-        /// Contains per-slot priority data.
-        case perAddressPriority = 0xdd
-    }
-    
     /// The start code for this message.
-    var startCode: STARTCode
+    var startCode: DMX.STARTCode
 
     /// The values for this message.
     var values: [UInt8]
@@ -87,7 +77,7 @@ struct DMPLayer {
     ///
     /// - Returns: A `DMPLayer` as a `Data` object.
     ///
-    static func createAsData(startCode: STARTCode, values: [UInt8]) -> Data {
+    static func createAsData(startCode: DMX.STARTCode, values: [UInt8]) -> Data {
         var data = Data()
         data.append(contentsOf: DMPLayer.flagsAndLength)
         data.append(Vector.setProperty.rawValue.data)
@@ -111,8 +101,8 @@ struct DMPLayer {
         guard data.count > Offset.propertyValues.rawValue+1 else { throw DMPLayerValidationError.lengthOutOfRange }
 
         // the flags and length
-        guard data[Offset.flagsAndLength.rawValue..<Offset.vector.rawValue] == Self.flagsAndLength else {
-            throw DMPLayerValidationError.invalidFlagsAndLength
+        guard let flagsAndLength = data.toFlagsAndLength(atOffset: Offset.flagsAndLength.rawValue), flagsAndLength.length == data.count-Offset.flagsAndLength.rawValue else {
+            throw DataFramingLayerValidationError.invalidFlagsAndLength
         }
         // the vector for this layer
         guard let vector: UInt8 = data.toUInt8(atOffset: Offset.vector.rawValue) else {
@@ -129,15 +119,15 @@ struct DMPLayer {
         guard let propertyValueCount: UInt16 = data.toUInt16(atOffset: Offset.propertyValueCount.rawValue) else {
             throw DMPLayerValidationError.unableToParse(field: "Property Value Count")
         }
-        guard propertyValueCount < 513 else {
+        guard propertyValueCount <= 513 && data.count >= Offset.propertyValues.rawValue + Int(propertyValueCount) else {
             throw DMPLayerValidationError.invalidPropertyValueCount(propertyValueCount)
         }
         // the START Code
-        guard let code: UInt8 = data.toUInt8(atOffset: Offset.propertyValues.rawValue), let STARTCode = STARTCode(rawValue: code) else {
+        guard let code: UInt8 = data.toUInt8(atOffset: Offset.propertyValues.rawValue), let STARTCode = DMX.STARTCode(rawValue: code) else {
             throw DMPLayerValidationError.unableToParse(field: "START Code")
         }
         let propertyValuesOffset = Offset.propertyValues.rawValue+1
-        let values = data.subdata(in: propertyValuesOffset..<propertyValuesOffset+Int(propertyValueCount)).bytes
+        let values = data.subdata(in: propertyValuesOffset..<propertyValuesOffset+Int(propertyValueCount-1)).bytes
 
         return Self(startCode: STARTCode, values: values)
     }

Sources/sACNKit/Layers/DataFramingLayer.swift

@@ -1,7 +1,7 @@
 //
 //  DataFramingLayer.swift
 //
-//  Copyright (c) 2022 Daniel Murfin
+//  Copyright (c) 2023 Daniel Murfin
 //
 //  Permission is hereby granted, free of charge, to any person obtaining a copy
 //  of this software and associated documentation files (the "Software"), to deal
@@ -27,10 +27,10 @@ import Foundation
 /// Data Framing Layer
 ///
 /// Implements the Data Framing Layer and handles creation and parsing.
-///
 struct DataFramingLayer {
 
     /// The flags and length. 0x7258: 258 = 600 (starting octet 38) = 638.
+    /// This must only be used for constructing packets as received packets may have differing lengths.
     private static let flagsAndLength = Data([0x72, 0x58])
 
     /// Data Framing Layer Vectors
@@ -73,22 +73,22 @@ struct DataFramingLayer {
     private var vector: Vector
 
     /// A name for this source, such as a user specified human-readable string, or serial number for the device.
-    var sourceName: String
+    private (set) var sourceName: String
 
     /// The priority of this source.
-    var priority: UInt8
+    private (set) var priority: UInt8
 
     /// The sequence number for this message.
-    var sequenceNumber: UInt8
+    private (set) var sequenceNumber: UInt8
 
     /// The options for this message.
-    var options: Options
+    private (set) var options: Options
 
     /// The unvierse number for this message.
-    var universe: UInt16
+    private (set) var universe: UInt16
 
     /// The data contained in the layer.
-    private var data: Data
+    private (set) var data: Data
 
     /// Creates a Framing Layer as Data.
     ///
@@ -123,7 +123,7 @@ struct DataFramingLayer {
         guard data.count > Offset.data.rawValue else { throw DataFramingLayerValidationError.lengthOutOfRange }
 
         // the flags and length
-        guard data[Offset.flagsAndLength.rawValue..<Offset.vector.rawValue] == Self.flagsAndLength else {
+        guard let flagsAndLength = data.toFlagsAndLength(atOffset: Offset.flagsAndLength.rawValue), flagsAndLength.length == data.count-Offset.flagsAndLength.rawValue else {
             throw DataFramingLayerValidationError.invalidFlagsAndLength
         }
         // the vector for this layer
@@ -158,10 +158,9 @@ struct DataFramingLayer {
         guard let universe: UInt16 = data.toUInt16(atOffset: Offset.universe.rawValue) else {
             throw DataFramingLayerValidationError.unableToParse(field: "Universe Number")
         }
-        guard Universe.dataUniverseNumbers.contains(universe) else {
+        guard SourceUniverse.dataUniverseNumbers.contains(universe) else {
             throw DataFramingLayerValidationError.invalidUniverse(universe)
         }
-
         // layer data
         let data = data.subdata(in: Offset.data.rawValue..<data.count)
 

Sources/sACNKit/Layers/RootLayer.swift

@@ -1,7 +1,7 @@
 //
 //  RootLayer.swift
 //
-//  Copyright (c) 2022 Daniel Murfin
+//  Copyright (c) 2023 Daniel Murfin
 //
 //  Permission is hereby granted, free of charge, to any person obtaining a copy
 //  of this software and associated documentation files (the "Software"), to deal
@@ -27,7 +27,6 @@ import Foundation
 /// Root Layer
 ///
 /// Implements the Root Layer and handles creation and parsing.
-///
 struct RootLayer {
 
     /// The offset at which length counting starts.
@@ -42,8 +41,9 @@ struct RootLayer {
     /// The packet identifier which begins every sACN message.
     private static let packetIdentifier = Data([0x41, 0x53, 0x43, 0x2d, 0x45, 0x31, 0x2e, 0x31, 0x37, 0x00, 0x00, 0x00])
 
-    /// The flags and length. 0x726e: 26e = 622 (starting octet 16) = 638.
-    private static let flagsAndLength = Data([0x72, 0x6e])
+    /// The flags and length for a data framing layer message. 0x726e: 26e = 622 (starting octet 16) = 638.
+    /// This must only be used for constructing data packets as received packets may have differing lengths.
+    private static let dataFlagsAndLength = Data([0x72, 0x6e])
 
     /// Root Layer Vectors
     ///
@@ -52,7 +52,7 @@ struct RootLayer {
     enum Vector: UInt32 {
         /// Contains a  `DataFramingLayer`.
         case data = 0x00000004
-        /// Contains a  `ExtendedFramingLayer`.
+        /// Contains an  `ExtendedFramingLayer`.
         case extended = 0x00000008
     }
 
@@ -71,13 +71,13 @@ struct RootLayer {
     }
 
     /// The vector describing the data in the layer.
-    private var vector: Vector
+    private (set) var vector: Vector
 
     /// A globally unique identifier (UUID) representing the `Source`, compliant with RFC 4122.
-    var cid: UUID
+    private (set) var cid: UUID
 
     /// The data contained in the layer.
-    private var data: Data
+    private (set) var data: Data
 
     /// Creates a Root Layer as Data.
     ///
@@ -92,7 +92,7 @@ struct RootLayer {
         data.append(contentsOf: RootLayer.preambleSize)
         data.append(contentsOf: RootLayer.postambleSize)
         data.append(contentsOf: RootLayer.packetIdentifier)
-        data.append(contentsOf: RootLayer.flagsAndLength)
+        data.append(contentsOf: RootLayer.dataFlagsAndLength)
         data.append(vector.rawValue.data)
         data.append(cid.data)
         return data
@@ -123,8 +123,7 @@ struct RootLayer {
             throw RootLayerValidationError.invalidPacketIdentifier
         }
         // the flags and length
-        // TODO: This needs to be checked for universe discovery
-        guard data[Offset.flagsAndLength.rawValue..<Offset.vector.rawValue] == Self.flagsAndLength else {
+        guard let flagsAndLength = data.toFlagsAndLength(atOffset: Offset.flagsAndLength.rawValue), flagsAndLength.length == data.count-Offset.flagsAndLength.rawValue else {
             throw RootLayerValidationError.invalidFlagsAndLength
         }
         // the vector for this message
@@ -150,7 +149,7 @@ struct RootLayer {
 ///
 /// Extensions for modifying fields within an existing `RootLayer` stored as `Data`.
 ///
-internal extension Data {
+extension Data {
     /// Replaces the `RootLayer` Flags and Length.
     ///
     /// - Parameters:

Sources/sACNKit/Layers/UniverseDiscoveryFramingLayer.swift

@@ -1,7 +1,7 @@
 //
 //  UniverseDiscoveryFramingLayer.swift
 //
-//  Copyright (c) 2022 Daniel Murfin
+//  Copyright (c) 2023 Daniel Murfin
 //
 //  Permission is hereby granted, free of charge, to any person obtaining a copy
 //  of this software and associated documentation files (the "Software"), to deal
@@ -27,7 +27,6 @@ import Foundation
 /// Universe Discovery Framing Layer
 ///
 /// Implements the Universe Discovery Framing Layer and handles creation and parsing.
-///
 struct UniverseDiscoveryFramingLayer {
 
     /// Universe Discovery Layer Vectors
@@ -47,17 +46,18 @@ struct UniverseDiscoveryFramingLayer {
         case flagsAndLength = 0
         case vector = 2
         case sourceName = 6
-        case data = 70
+        case reserved = 70
+        case data = 74
     }
 
     /// The vector describing the data in the layer.
-    private var vector: Vector
+    private (set) var vector: Vector
 
     /// A name for this source, such as a user specified human-readable string, or serial number for the device.
-    var sourceName: String
+    private (set) var sourceName: String
 
     /// The data contained in the layer.
-    private var data: Data
+    private (set) var data: Data
 
     /// Creates a Framing Layer as Data.
     ///
@@ -88,11 +88,7 @@ struct UniverseDiscoveryFramingLayer {
         guard data.count > Offset.data.rawValue else { throw UniverseDiscoveryFramingLayerValidationError.lengthOutOfRange }
 
         // the flags and length
-        guard let flagsAndLength = data.toUInt16(atOffset: Offset.flagsAndLength.rawValue) else {
-            throw UniverseDiscoveryFramingLayerValidationError.unableToParse(field: "Flags And Length")
-        }
-        // TODO: Validate length and get universes being advertised
-        guard let length = FlagsAndLength.toLength(from: flagsAndLength) else {
+        guard let flagsAndLength = data.toFlagsAndLength(atOffset: Offset.flagsAndLength.rawValue), flagsAndLength.length == data.count-Offset.flagsAndLength.rawValue else {
             throw UniverseDiscoveryFramingLayerValidationError.invalidFlagsAndLength
         }
         // the vector for this layer

Sources/sACNKit/Layers/UniverseDiscoveryLayer.swift

@@ -1,7 +1,7 @@
 //
 //  UniverseDiscoveryLayer.swift
 //
-//  Copyright (c) 2022 Daniel Murfin
+//  Copyright (c) 2023 Daniel Murfin
 //
 //  Permission is hereby granted, free of charge, to any person obtaining a copy
 //  of this software and associated documentation files (the "Software"), to deal
@@ -27,7 +27,6 @@ import Foundation
 /// Universe Discovery Layer
 ///
 /// Implements the Universe Discovery Layer and handles creation and parsing.
-///
 struct UniverseDiscoveryLayer {
 
     /// The maximum number of universe numbers to include in this layer.
@@ -98,9 +97,9 @@ struct UniverseDiscoveryLayer {
         guard data.count >= Offset.listOfUniverses.rawValue else { throw UniverseDiscoveryLayerValidationError.lengthOutOfRange }
 
         // the flags and length
-        guard let _ = data.toUInt16(atOffset: Offset.flagsAndLength.rawValue) else {
-            throw UniverseDiscoveryLayerValidationError.unableToParse(field: "Flags And Length")
-        }
+        guard let flagsAndLength = data.toFlagsAndLength(atOffset: Offset.flagsAndLength.rawValue), flagsAndLength.length == data.count-Offset.flagsAndLength.rawValue else {
+            throw UniverseDiscoveryLayerValidationError.invalidFlagsAndLength
+        }        
         // the vector for this layer
         guard let vector: UInt32 = data.toUInt32(atOffset: Offset.vector.rawValue) else {
             throw UniverseDiscoveryLayerValidationError.unableToParse(field: "Vector")