Add MediaPlayerFrameDescription change decoder

Author: Dev1an

Sources/Atem/MediaPool.swift

@@ -0,0 +1,37 @@
+//
+//  File.swift
+//  
+//
+//  Created by Damiaan on 05/12/2020.
+//
+
+public enum MediaPool {
+	public enum Bank: RawRepresentable {
+		public typealias RawValue = UInt8
+
+		case still
+		case clip(index: UInt8)
+
+		public init?(rawValue: UInt8) {
+			switch rawValue {
+			case 0: self = .still
+			case 1...4:
+				self = .clip(index: rawValue - 1)
+			default:
+				return nil
+			}
+		}
+
+		public var rawValue: UInt8 {
+			switch self {
+				case .still: return 0
+				case .clip(let index): return index + 1
+			}
+		}
+	}
+
+	public struct ID {
+		let bank: Bank
+		let frame: UInt16
+	}
+}

Sources/Atem/Messages/Actions.swift

@@ -305,6 +305,8 @@ extension Message.Did {
 	}
 }
 
+// MARK: Tally lights
+
 extension Message.Did {
 	/// Informs a controller that the some tally lights might have changed.
 	public struct ChangeSourceTallies: SerializableMessage {
@@ -351,6 +353,8 @@ extension Message.Did {
 	}
 }
 
+// MARK: Key DVE
+
 import Foundation
 extension Message.Do {
 	@available(OSX 10.12, iOS 10.0, *)
@@ -411,3 +415,38 @@ extension Message.Do {
 		}
 	}
 }
+
+// MARK: Change Media Player
+
+public extension Message.Did {
+	struct ChangeMediaPlayerFrameDescription: DeserializableMessage {
+		public static let title = Message.Title(string: "MPfe")
+
+		public let id: MediaPool.ID
+		public let name: String
+
+		public init(with bytes: ArraySlice<UInt8>) throws {
+			let bank = bytes[relative: Position.bank]
+			let frameIndex = UInt16(from: bytes[relative: Position.frameIndex])
+			id = .init(bank: try .decode(from: bank), frame: frameIndex)
+
+			// Read name
+			let nameLength = UInt16(from: bytes[relative: Position.nameLength])
+			let nameBytes = bytes[relative: Position.name( Int(nameLength) )]
+			guard let decodedName = String(bytes: nameBytes, encoding: .utf8) else {
+				throw Message.Error.stringNotDecodable(nameBytes)
+			}
+			name = decodedName
+		}
+
+		public var debugDescription: String { "Media player \(id): '\(name)'" }
+
+		enum Position {
+			static let bank = 0
+			static let frameIndex = 2..<4
+			static let nameLength = 22..<24
+			static let name = { length in nameLength.endIndex ..< nameLength.endIndex + length }
+		}
+	}
+}
+

Sources/Atem/Messages/Message.swift

@@ -36,6 +36,7 @@ public enum Message {
 		case serialising
 		case stringTooLong(String, Int)
 		case titleNotDeserializable
+		case stringNotDecodable(ArraySlice<UInt8>)
 		case unknownModel(UInt8)
 
 		var localizedDescription: String {
@@ -48,6 +49,8 @@ public enum Message {
 				return "Message.Error: serialising"
 			case .unknownModel(let modelNumber):
 				return "Message error: unknown model \(modelNumber)"
+			case .stringNotDecodable(let bytes):
+				return "Message error: unable to decode \(bytes) as UTF8"
 			}
 		}
 	}

Sources/Atem/UploadManager.swift

@@ -21,7 +21,7 @@ public class UploadManager {
 
 	init() {}
 
-	func createTransfer(store: UInt16, frameNumber: UInt16, data: Data, uncompressedSize: UInt32, mode: Do.StartDataTransfer.Mode, name optionalName: String? = nil, description: String = "") -> Do.StartDataTransfer {
+	func createTransfer(store: UInt16, frameNumber: UInt16, data: Data, uncompressedSize: UInt32, mode: Do.StartDataTransfer.Mode, hash: [UInt8] = .init(repeating: 1, count: 16), name optionalName: String? = nil, description: String = "") -> Do.StartDataTransfer {
 
 		let id = transferCounter
 		transferCounter += 1
@@ -30,7 +30,7 @@ public class UploadManager {
 
 		let transfer = Transfer(
 			start: Do.StartDataTransfer(transferID: id, store: store, frameNumber: frameNumber, size: uncompressedSize, mode: mode),
-			description: Do.SetFileDescription(transferID: id, name: name, description: description),
+			description: Do.SetFileDescription(transferID: id, name: name, description: description, hash: hash),
 			data: data
 		)