Pass render time in environment value (#1)

Author: finnvoor

.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+.build/
+/.swiftpm
+/Packages
+xcuserdata/
+DerivedData/
+.swiftpm/configuration/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc
+

Config.xcconfig

@@ -1,2 +1,2 @@
-MARKETING_VERSION = 0.0.1
-CURRENT_PROJECT_VERSION = 1
+MARKETING_VERSION = 0.0.2
+CURRENT_PROJECT_VERSION = 2

Package.swift

@@ -0,0 +1,10 @@
+// swift-tools-version: 6.0
+
+import PackageDescription
+
+let package = Package(
+    name: "SwiftUIFX",
+    platforms: [.macOS(.v11)],
+    products: [.library(name: "SwiftUIFX", type: .dynamic, targets: ["SwiftUIFX"])],
+    targets: [.target(name: "SwiftUIFX")]
+)

Plugin/Extensions/CMTime+Extensions.swift

@@ -0,0 +1,27 @@
+import CoreMedia
+
+extension CMTime: Codable {
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        let value = try container.decode(CMTimeValue.self, forKey: .value)
+        let timescale = try container.decode(CMTimeScale.self, forKey: .timescale)
+        let flags = try CMTimeFlags(rawValue: container.decode(UInt32.self, forKey: .flags))
+        let epoch = try container.decode(CMTimeEpoch.self, forKey: .epoch)
+        self.init(value: value, timescale: timescale, flags: flags, epoch: epoch)
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(value, forKey: .value)
+        try container.encode(timescale, forKey: .timescale)
+        try container.encode(flags.rawValue, forKey: .flags)
+        try container.encode(epoch, forKey: .epoch)
+    }
+
+    private enum CodingKeys: CodingKey {
+        case value
+        case timescale
+        case flags
+        case epoch
+    }
+}

Plugin/Extensions/CMTimeRange+Extensions.swift

@@ -0,0 +1,21 @@
+import CoreMedia
+
+extension CMTimeRange: Codable {
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        let start = try container.decode(CMTime.self, forKey: .start)
+        let duration = try container.decode(CMTime.self, forKey: .duration)
+        self.init(start: start, duration: duration)
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(start, forKey: .start)
+        try container.encode(duration, forKey: .duration)
+    }
+
+    private enum CodingKeys: CodingKey {
+        case start
+        case duration
+    }
+}

Plugin/Extensions/FxTimingAPI_v4+Extensions.swift

@@ -0,0 +1,33 @@
+import CoreMedia
+
+extension FxTimingAPI_v4 {
+    func timelineTime(fromInputTime inputTime: CMTime) -> CMTime {
+        var timelineTime: CMTime = .zero
+        self.timelineTime(&timelineTime, fromInputTime: inputTime)
+        return timelineTime
+    }
+
+    var inPointTimeOfTimeline: CMTime {
+        var inPointTime: CMTime = .zero
+        self.inPointTimeOfTimeline(forEffect: &inPointTime)
+        return inPointTime
+    }
+
+    var outPointTimeOfTimeline: CMTime {
+        var outPointTime: CMTime = .zero
+        self.outPointTimeOfTimeline(forEffect: &outPointTime)
+        return outPointTime
+    }
+
+    var startTime: CMTime {
+        var startTime: CMTime = .zero
+        self.startTime(forEffect: &startTime)
+        return startTime
+    }
+
+    var duration: CMTime {
+        var duration: CMTime = .zero
+        durationTime(forEffect: &duration)
+        return duration
+    }
+}

Plugin/Extensions/PROAPIAccessing+Extensions.swift

@@ -0,0 +1,13 @@
+extension PROAPIAccessing {
+    var parameterCreationAPI: FxParameterCreationAPI_v5 {
+        api(for: FxParameterCreationAPI_v5.self) as! FxParameterCreationAPI_v5
+    }
+
+    var parameterRetrievalAPI: FxParameterRetrievalAPI_v6 {
+        api(for: FxParameterRetrievalAPI_v6.self) as! FxParameterRetrievalAPI_v6
+    }
+
+    var timingAPI: FxTimingAPI_v4 {
+        api(for: FxTimingAPI_v4.self) as! FxTimingAPI_v4
+    }
+}

Plugin/Generators/SwiftUIViewGenerator.swift

@@ -1,4 +1,5 @@
 import SwiftUI
+import SwiftUIFX
 
 // MARK: - SwiftUIViewGenerator
 
@@ -13,14 +14,14 @@ import SwiftUI
     }
 
     override func addParameters() throws {
-        parameterCreationAPI.addStringParameter(
+        apiManager.parameterCreationAPI.addStringParameter(
             withName: "Package Path (Drag & Drop)",
             parameterID: 1,
             defaultValue: "",
             parameterFlags: FxParameterFlags(kFxParameterFlag_DEFAULT)
         )
 
-        parameterCreationAPI.addPushButton(
+        apiManager.parameterCreationAPI.addPushButton(
             withName: "Compile",
             parameterID: 2,
             selector: #selector(SwiftUIViewGenerator.compile),
@@ -32,15 +33,38 @@ import SwiftUI
         compile()
     }
 
+    override func pluginState(
+        at renderTime: CMTime,
+        quality _: UInt
+    ) throws -> Data? {
+        try JSONEncoder().encode(State(
+            timelineTime: apiManager.timingAPI.timelineTime(fromInputTime: renderTime),
+            timelineTimeRange: .init(
+                start: apiManager.timingAPI.inPointTimeOfTimeline,
+                end: apiManager.timingAPI.outPointTimeOfTimeline
+            ),
+            generatorTimeRange: .init(
+                start: apiManager.timingAPI.timelineTime(fromInputTime: apiManager.timingAPI.startTime),
+                duration: apiManager.timingAPI.timelineTime(fromInputTime: apiManager.timingAPI.duration)
+            )
+        ))
+    }
+
     override func renderDestinationImage(
         sourceImages: [CIImage],
-        pluginState _: Data?,
+        pluginState: Data?,
         at _: CMTime
-    ) -> CIImage {
+    ) throws -> CIImage {
         guard let view else { return .clear }
+
+        let state = try JSONDecoder().decode(State.self, from: pluginState ?? Data())
+
         return DispatchQueue.main.sync {
             let renderer = ImageRenderer(
                 content: view
+                    .environment(\.timelineTime, state.timelineTime)
+                    .environment(\.timelineTimeRange, state.timelineTimeRange)
+                    .environment(\.generatorTimeRange, state.generatorTimeRange)
                     .frame(width: sourceImages[0].extent.width, height: sourceImages[0].extent.height)
             )
             renderer.proposedSize = .init(sourceImages[0].extent.size)
@@ -53,10 +77,20 @@ import SwiftUI
     private var view: AnyView?
 }
 
+// MARK: SwiftUIViewGenerator.State
+
+extension SwiftUIViewGenerator {
+    struct State: Codable {
+        let timelineTime: CMTime
+        let timelineTimeRange: CMTimeRange
+        let generatorTimeRange: CMTimeRange
+    }
+}
+
 extension SwiftUIViewGenerator {
     @objc func compile() {
         var packagePath: NSString = ""
-        parameterRetrievalAPI.getStringParameterValue(&packagePath, fromParameter: 1)
+        apiManager.parameterRetrievalAPI.getStringParameterValue(&packagePath, fromParameter: 1)
         let package = URL(filePath: packagePath as String)
 
         guard !(packagePath as String).isEmpty else { return }

Plugin/TileableEffect.swift

@@ -11,19 +11,20 @@ class TileableEffect: NSObject, FxTileableEffect {
 
     // MARK: Internal
 
+    let apiManager: PROAPIAccessing
+
     var properties: [String: Any] {
         [
             kFxPropertyKey_MayRemapTime: false,
             kFxPropertyKey_VariesWhenParamsAreStatic: false
         ]
     }
 
-    var parameterCreationAPI: FxParameterCreationAPI_v5 {
-        apiManager.api(for: FxParameterCreationAPI_v5.self) as! FxParameterCreationAPI_v5
-    }
-
-    var parameterRetrievalAPI: FxParameterRetrievalAPI_v6 {
-        apiManager.api(for: FxParameterRetrievalAPI_v6.self) as! FxParameterRetrievalAPI_v6
+    func pluginState(
+        at _: CMTime,
+        quality _: UInt
+    ) throws -> Data? {
+        nil
     }
 
     func destinationImageRect(
@@ -49,13 +50,12 @@ class TileableEffect: NSObject, FxTileableEffect {
         sourceImages: [CIImage],
         pluginState _: Data?,
         at _: CMTime
-    ) -> CIImage {
+    ) throws -> CIImage {
         sourceImages.first ?? .clear
     }
 
     // MARK: Private
 
-    private let apiManager: PROAPIAccessing
     private let context = CIContext()
 }
 
@@ -70,11 +70,18 @@ extension TileableEffect {
         properties?.pointee = self.properties as NSDictionary
     }
 
-    func pluginState(
-        _: AutoreleasingUnsafeMutablePointer<NSData>?,
-        at _: CMTime,
-        quality _: UInt
-    ) throws {}
+    final func pluginState(
+        _ pluginState: AutoreleasingUnsafeMutablePointer<NSData>?,
+        at renderTime: CMTime,
+        quality qualityLevel: UInt
+    ) throws {
+        if let state = try self.pluginState(
+            at: renderTime,
+            quality: qualityLevel
+        ) {
+            pluginState?.pointee = state as NSData
+        }
+    }
 
     final func destinationImageRect(
         _ destinationImageRect: UnsafeMutablePointer<FxRect>,
@@ -122,7 +129,7 @@ extension TileableEffect {
             )
         }
 
-        var renderedImage = renderDestinationImage(
+        var renderedImage = try renderDestinationImage(
             sourceImages: sourceImages,
             pluginState: pluginState,
             at: renderTime

README.md

@@ -42,3 +42,34 @@ struct MyView: View {
 6. Select the generator, navigate to the generator inspector, and drag the top level directory of your Swift package into the "Package Path" text field.
 7. Press the "Compile" button to compile your view. It should now be displayed in your video timeline.
 8. Any time you make a change to your package you will need to press the "Compile" button again.
+
+### Environment Values
+
+To access environment values in your SwiftUI view:
+1. Add SwiftUIFX as a dependency of your package.
+```swift
+let package = Package(
+    name: "MyVideoOverlay",
+    platforms: [.macOS(.v13)],
+    products: [.library(name: "MyVideoOverlay", type: .dynamic, targets: ["MyVideoOverlay"])],
+    dependencies: [.package(url: "https://github.com/finnvoor/SwiftUIFX.git", branch: "main")],
+    targets: [.target(name: "MyVideoOverlay", dependencies: [.product(name: "SwiftUIFX", package: "SwiftUIFX")])]
+)
+```
+2. Import SwiftUIFX in your SwiftUI view.
+```swift
+import SwiftUIFX
+```
+3. Access the environment value using the `Environment` property wrapper.
+```swift
+@Environment(\.timelineTime) var timelineTime: CMTime
+@Environment(\.timelineTimeRange) var timelineTimeRange: CMTimeRange
+@Environment(\.generatorTimeRange) var generatorTimeRange: CMTimeRange
+```
+
+### Development
+
+1. Clone the repository.
+2. Run `swift build -c release --arch arm64 --arch x86_64` at the top level of the repository.
+3. Change the code sign identity in the build script phases of Plugin ("Copy and Code Sign FxPlug.framework" and "Copy and Code Sign PluginManager.framework"). 
+4. Open `SwiftUIFX.xcodeproj`.

Sources/SwiftUIFX/EnvironmentValues+Extensions.swift

@@ -0,0 +1,8 @@
+import CoreMedia
+import SwiftUI
+
+public extension EnvironmentValues {
+    @Entry var timelineTime: CMTime = .zero
+    @Entry var timelineTimeRange: CMTimeRange = .zero
+    @Entry var generatorTimeRange: CMTimeRange = .zero
+}