Upload Input Inspection and Standardization 1 (#17)

Add scaffolding

Add initializers

Add internal and external state mapping

Remove duplicate status enum and add inline docs to external status

Add inline API docs to PHAsset-based MuxUpload constructor

Consolidate all `MuxUpload` options into a single struct `UploadOptions`

Declare asynchronous MuxUpload constructor in PHAsset extension

Place extension methods into dedicated directories

Polish inline API documentation

Add option variants as static members: defaults, disabled inputStandardization

Deprecate existing initializer, normally this API should be removed prior to GA, but since it
was the only initializer exposed up to this point removing it would break everybody. Instead deprecate and remove at a later date.

Store all upload-related options in UploadInfo

Use correct starting byte parameter when restarting upload

Hardcode request options when exporting AVAsset from PhotosKit

Update API doc with lifecycle details and note the placeholder implementation

Fix parameter name

Start method fixes: remove force unwrap and add missing start calls

chunkSize -> chunkSizeInBytes

Author: andrewjl-mux

Sources/MuxUploadSDK/InputInspection/UploadInputInspectionWorker.swift

@@ -0,0 +1,14 @@
+//
+//  UploadInputInspectionWorker.swift
+//  
+
+import AVFoundation
+import Foundation
+
+class UploadInputInspectionWorker {
+
+    var sourceInput: AVAsset?
+
+
+
+}

Sources/MuxUploadSDK/InputInspection/UploadInputInspector.swift

@@ -0,0 +1,12 @@
+//
+//  UploadInputInspector.swift
+//
+
+import AVFoundation
+import Foundation
+
+class UploadInputInspector {
+    
+}
+
+

Sources/MuxUploadSDK/InputStandardization/UploadInputStandardizationWorker.swift

@@ -0,0 +1,13 @@
+//
+//  UploadInputStandardizationWorker.swift
+//  
+
+import AVFoundation
+import Foundation
+
+class UploadInputStandardizationWorker {
+
+    var sourceInput: AVAsset?
+
+    var standardizedInput: AVAsset?
+}

Sources/MuxUploadSDK/InputStandardization/UploadInputStandardizer.swift

@@ -0,0 +1,10 @@
+//
+//  UploadInputStandardizer.swift
+//  
+
+import AVFoundation
+import Foundation
+
+class UploadInputStandardizer {
+    
+}

Sources/MuxUploadSDK/InternalUtilities/UploadInput.swift

@@ -0,0 +1,94 @@
+//
+//  UploadInput.swift
+//
+
+import AVFoundation
+import Foundation
+
+// Internal representation of the upload input as it is
+// undergoing non-standard
+struct UploadInput {
+
+    internal enum Status {
+        case ready(AVAsset, UploadInfo)
+        case started(AVAsset, UploadInfo)
+        case underInspection(AVAsset, UploadInfo)
+        case standardizing(AVAsset, UploadInfo)
+        case standardizationSucceeded(AVAsset, UploadInfo)
+        case standardizationFailed(AVAsset, UploadInfo)
+        case awaitingUploadConfirmation(UploadInfo)
+        case uploadInProgress(UploadInfo)
+        case uploadPaused(UploadInfo)
+        case uploadSucceeded(UploadInfo)
+        case uploadFailed(UploadInfo)
+    }
+
+    var status: Status
+
+    var sourceAsset: AVAsset {
+        switch status {
+        case .ready(let sourceAsset, _):
+            return sourceAsset
+        case .started(let sourceAsset, _):
+            return sourceAsset
+        case .underInspection(let sourceAsset, _):
+            return sourceAsset
+        case .standardizing(let sourceAsset, _):
+            return sourceAsset
+        case .standardizationSucceeded(let sourceAsset, _):
+            return sourceAsset
+        case .standardizationFailed(let sourceAsset, _):
+            return sourceAsset
+        case .awaitingUploadConfirmation(let uploadInfo):
+            return uploadInfo.sourceAsset()
+        case .uploadInProgress(let uploadInfo):
+            return uploadInfo.sourceAsset()
+        case .uploadSucceeded(let uploadInfo):
+            return uploadInfo.sourceAsset()
+        case .uploadFailed(let uploadInfo):
+            return uploadInfo.sourceAsset()
+        case .uploadPaused(let uploadInfo):
+            return uploadInfo.sourceAsset()
+        }
+    }
+
+    var uploadInfo: UploadInfo {
+        switch status {
+        case .ready(_, let uploadInfo):
+            return uploadInfo
+        case .started(_, let uploadInfo):
+            return uploadInfo
+        case .underInspection(_, let uploadInfo):
+            return uploadInfo
+        case .standardizing(_, let uploadInfo):
+            return uploadInfo
+        case .standardizationSucceeded(_, let uploadInfo):
+            return uploadInfo
+        case .standardizationFailed(_, let uploadInfo):
+            return uploadInfo
+        case .awaitingUploadConfirmation(let uploadInfo):
+            return uploadInfo
+        case .uploadInProgress(let uploadInfo):
+            return uploadInfo
+        case .uploadPaused(let uploadInfo):
+            return uploadInfo
+        case .uploadSucceeded(let uploadInfo):
+            return uploadInfo
+        case .uploadFailed(let uploadInfo):
+            return uploadInfo
+        }
+    }
+}
+
+extension UploadInput.Status: Equatable {
+
+}
+
+extension UploadInput {
+    init(
+        asset: AVAsset,
+        info: UploadInfo
+    ) {
+        self.status = .ready(asset, info)
+    }
+}

Sources/MuxUploadSDK/PublicAPI/AVFoundation+MuxUpload/MuxUpload+AVFoundation.swift

@@ -0,0 +1,37 @@
+//
+//  MuxUpload+AVFoundation.swift
+//
+
+import AVFoundation
+import Foundation
+
+extension MuxUpload {
+
+    /// Initializes a MuxUpload from an ``AVAsset``
+    ///
+    /// - Parameters:
+    ///    - uploadURL: the URL of your direct upload, see
+    ///    the [direct upload guide](https://docs.mux.com/api-reference#video/operation/create-direct-upload)
+    ///     - inputAsset: the asset containing audiovisual
+    ///     media to be used as the input for the direct
+    ///     upload
+    ///     - options: options used to control the direct
+    ///    upload of the input to Mux
+    public convenience init(
+        uploadURL: URL,
+        inputAsset: AVAsset,
+        options: UploadOptions
+    ) {
+        self.init(
+            input: UploadInput(
+                asset: inputAsset,
+                info: UploadInfo(
+                    uploadURL: uploadURL,
+                    options: options
+                )
+            ),
+            uploadManager: .shared
+        )
+    }
+
+}