added new playback commands

Author: swiftuiux

Sources/swiftui-loop-videoplayer/enum/PlaybackCommand.swift

@@ -64,6 +64,15 @@ public enum PlaybackCommand: Equatable {
     /// Command to remove all applied filters from the video playback.
     case removeAllFilters
 
+    /// Represents a command to create and possibly clear existing vectors using a shape layer builder.
+    /// - Parameters:
+    ///   - builder: An instance conforming to `ShapeLayerBuilderProtocol` which will provide the shape layer.
+    ///   - clear: A Boolean value that determines whether existing vector graphics should be cleared before applying the new vector. Defaults to `false`.
+    case addVector(any ShapeLayerBuilderProtocol, clear: Bool = false)
+
+    /// Represents a command to remove all vector graphics from the current view or context.
+    case removeAllVectors
+    
     /// Command to select a specific audio track based on language code.
     /// - Parameter languageCode: The language code (e.g., "en" for English) of the desired audio track.
     case audioTrack(languageCode: String)
@@ -72,7 +81,7 @@ public enum PlaybackCommand: Equatable {
         switch (lhs, rhs) {
         case (.play, .play), (.pause, .pause), (.begin, .begin), (.end, .end),
              (.mute, .mute), (.unmute, .unmute), (.loop, .loop), (.unloop, .unloop),
-             (.removeAllFilters, .removeAllFilters):
+             (.removeAllFilters, .removeAllFilters), (.removeAllVectors, .removeAllVectors):
             return true
 
         case (.seek(let lhsTime), .seek(let rhsTime)):
@@ -98,6 +107,8 @@ public enum PlaybackCommand: Equatable {
 
         case (.filter(let lhsFilter, let lhsClear), .filter(let rhsFilter, let rhsClear)):
             return lhsFilter == rhsFilter && lhsClear == rhsClear
+        case let (.addVector(lhsBuilder, lhsClear), .addVector(rhsBuilder, rhsClear)):
+            return lhsBuilder.id == rhsBuilder.id && lhsClear == rhsClear
         default:
             return false
         }

Sources/swiftui-loop-videoplayer/protocol/vector/ShapeLayerBuilderProtocol.swift

@@ -0,0 +1,27 @@
+//
+//  ShapeLayerProtocol.swift
+//
+//
+//  Created by Igor  on 13.08.24.
+//
+
+import QuartzCore
+import CoreGraphics
+
+/// A protocol defining a builder for creating shape layers with a unique identifier.
+///
+/// Conforming types will be able to construct a CAShapeLayer based on provided frame, bounds, and center.
+@available(iOS 14, macOS 11, tvOS 14, *)
+public protocol ShapeLayerBuilderProtocol: Identifiable {
+    
+    var id : UUID { get }
+    
+    /// Builds a CAShapeLayer using specified geometry.
+    ///
+    /// - Parameters:
+    ///   - geometry: A tuple containing frame, bounds, and center as `CGRect` and `CGPoint`.
+    /// - Returns: A configured `CAShapeLayer`.
+    @MainActor
+    func build(with geometry: (frame: CGRect, bounds: CGRect)) -> CAShapeLayer
+    
+}

Sources/swiftui-loop-videoplayer/protocol/view/AbstractPlayer.swift

@@ -357,62 +357,5 @@ extension AbstractPlayer{
         }
         #endif
     }
-    
-    /// Sets the playback command for the video player.
-    /// - Parameter value: The `PlaybackCommand` to set. This can be one of the following:
-    ///   - `play`: Command to play the video.
-    ///   - `pause`: Command to pause the video.
-    ///   - `seek(to:)`: Command to seek to a specific time in the video.
-    ///   - `begin`: Command to position the video at the beginning.
-    ///   - `end`: Command to position the video at the end.
-    ///   - `mute`: Command to mute the video.
-    ///   - `unmute`: Command to unmute the video.
-    ///   - `volume`: Command to adjust the volume of the video playback.
-    ///   - `subtitles`: Command to set subtitles to a specified language or turn them off.
-    ///   - `playbackSpeed`: Command to adjust the playback speed of the video.
-    ///   - `loop`: Command to enable looping of the video playback.
-    ///   - `unloop`: Command to disable looping of the video playback.
-    ///   - `brightness`: Command to adjust the brightness of the video playback.
-    ///   - `contrast`: Command to adjust the contrast of the video playback.
-    ///   - `filter`: Command to apply a specific Core Image filter to the video.
-    ///   - `removeAllFilters`: Command to remove all applied filters from the video playback.
-    ///   - `audioTrack`: Command to select a specific audio track based on language code.
-    func setCommand(_ value: PlaybackCommand) {
-        switch value {
-        case .play:
-            play()
-        case .pause:
-            pause()
-        case .seek(to: let time):
-            seek(to: time)
-        case .begin:
-            seekToStart()
-        case .end:
-            seekToEnd()
-        case .mute:
-            mute()
-        case .unmute:
-            unmute()
-        case .volume(let volume):
-            setVolume(volume)
-        case .subtitles(let language):
-            setSubtitles(to: language)
-        case .playbackSpeed(let speed):
-            setPlaybackSpeed(speed)
-        case .loop:
-            loop()
-        case .unloop:
-            unloop()
-        case .brightness(let brightness):
-            adjustBrightness(to: brightness)
-        case .contrast(let contrast):
-            adjustContrast(to: contrast)
-        case .filter(let value, let clear):
-            applyFilter(value, clear)
-        case .removeAllFilters:
-            removeAllFilters()
-        case .audioTrack(let languageCode):
-            selectAudioTrack(languageCode: languageCode)
-        }
-    }
+
 }

Sources/swiftui-loop-videoplayer/protocol/view/LoopingPlayerProtocol.swift

@@ -18,16 +18,16 @@ import AppKit
 /// handle errors, and notify a delegate of important events.
 @available(iOS 14, macOS 11, tvOS 14, *)
 @MainActor
-public protocol LoopingPlayerProtocol: AbstractPlayer{   
-
-    var playerLayer : AVPlayerLayer { get }
+public protocol LoopingPlayerProtocol: AbstractPlayer, LayerMakerProtocol{
 
     #if canImport(UIKit)
         var layer : CALayer { get }
     #elseif canImport(AppKit)
         var layer : CALayer? { get set }
         var wantsLayer : Bool { get set }
     #endif
+    
+    var playerLayer : AVPlayerLayer { get }
 
     /// The delegate to be notified about errors encountered by the player.
     var delegate: PlayerErrorDelegate? { get set }
@@ -143,13 +143,16 @@ extension LoopingPlayerProtocol {
         #if canImport(UIKit)
         playerLayer.backgroundColor = UIColor.clear.cgColor
         layer.addSublayer(playerLayer)
+        layer.addSublayer(compositeLayer)
         #elseif canImport(AppKit)
         playerLayer.backgroundColor = NSColor.clear.cgColor
-        layer = CALayer()
-        layer?.addSublayer(playerLayer)
-        wantsLayer = true
+        let layer = CALayer()
+        layer.addSublayer(playerLayer)
+        layer.addSublayer(compositeLayer)
+        self.layer = layer
+        self.wantsLayer = true
         #endif
-        
+        compositeLayer.frame = CGRect(x: 0, y: 0, width: bounds.width, height: bounds.height)
         loop()
         player.play()
     }
@@ -199,4 +202,69 @@ extension LoopingPlayerProtocol {
         guard let error = player.error else { return }
         delegate?.didReceiveError(.remoteVideoError(error))
     }
+    
+    func setCommand(_ value: PlaybackCommand) {
+        /// Sets the playback command for the video player.
+        /// - Parameter value: The `PlaybackCommand` to set. This can be one of the following:
+        ///   - `play`: Command to play the video.
+        ///   - `pause`: Command to pause the video.
+        ///   - `seek(to:)`: Command to seek to a specific time in the video.
+        ///   - `begin`: Command to position the video at the beginning.
+        ///   - `end`: Command to position the video at the end.
+        ///   - `mute`: Command to mute the video.
+        ///   - `unmute`: Command to unmute the video.
+        ///   - `volume`: Command to adjust the volume of the video playback.
+        ///   - `subtitles`: Command to set subtitles to a specified language or turn them off.
+        ///   - `playbackSpeed`: Command to adjust the playback speed of the video.
+        ///   - `loop`: Command to enable looping of the video playback.
+        ///   - `unloop`: Command to disable looping of the video playback.
+        ///   - `brightness`: Command to adjust the brightness of the video playback.
+        ///   - `contrast`: Command to adjust the contrast of the video playback.
+        ///   - `filter`: Command to apply a specific Core Image filter to the video.
+        ///   - `removeAllFilters`: Command to remove all applied filters from the video playback.
+        ///   - `audioTrack`: Command to select a specific audio track based on language code.
+        ///   - `vector`: Sets a vector graphic operation on the video player.
+        ///   - `removeAllVectors`: Clears all vector graphics from the video player.
+        switch value {
+        case .play:
+            play()
+        case .pause:
+            pause()
+        case .seek(to: let time):
+            seek(to: time)
+        case .begin:
+            seekToStart()
+        case .end:
+            seekToEnd()
+        case .mute:
+            mute()
+        case .unmute:
+            unmute()
+        case .volume(let volume):
+            setVolume(volume)
+        case .subtitles(let language):
+            setSubtitles(to: language)
+        case .playbackSpeed(let speed):
+            setPlaybackSpeed(speed)
+        case .loop:
+            loop()
+        case .unloop:
+            unloop()
+        case .brightness(let brightness):
+            adjustBrightness(to: brightness)
+        case .contrast(let contrast):
+            adjustContrast(to: contrast)
+        case .filter(let value, let clear):
+            applyFilter(value, clear)
+        case .removeAllFilters:
+            removeAllFilters()
+        case .audioTrack(let languageCode):
+            selectAudioTrack(languageCode: languageCode)
+        case .addVector(let builder, let clear):
+            addVectorLayer(builder: builder, clear: clear)
+        case .removeAllVectors:
+            removeAllVectors()
+        }
+    }
+
 }

Sources/swiftui-loop-videoplayer/protocol/view/VectorLayerProtocol.swift

@@ -0,0 +1,49 @@
+//
+//  VectorLayerProtocol.swift
+//
+//
+//  Created by Igor Shelopaev on 13.08.24.
+//
+
+#if canImport(UIKit)
+import UIKit
+#elseif canImport(AppKit)
+import AppKit
+#endif
+import QuartzCore
+
+@available(iOS 14, macOS 11, tvOS 14, *)
+@MainActor
+public protocol LayerMakerProtocol{
+    
+    var compositeLayer : CALayer{ get }
+    
+    var frame: CGRect { get set }
+    
+    var bounds : CGRect { get set }
+    
+    func addVectorLayer(builder : any ShapeLayerBuilderProtocol, clear: Bool)
+    
+    func removeAllVectors()
+}
+
+extension LayerMakerProtocol{
+    
+    @MainActor
+    /// Sets a vector graphic operation on the video player.
+    /// - Parameters:
+    ///   - builder: An instance conforming to `ShapeLayerBuilderProtocol` to provide the shape layer.
+    ///   - clear: A Boolean value indicating whether to clear existing vector graphics before applying the new one. Defaults to `false`.
+    func addVectorLayer(builder : any ShapeLayerBuilderProtocol, clear: Bool){
+        if clear{ removeAllVectors() }
+        let layer = builder.build(with: (frame, bounds))
+        compositeLayer.addSublayer(layer)
+    }
+    
+    @MainActor
+    /// Clears all vector graphics from the video player.
+    func removeAllVectors(){
+            compositeLayer.sublayers?.forEach { $0.removeFromSuperlayer() }
+    }
+    
+}

Sources/swiftui-loop-videoplayer/view/loop/player/ios/LoopingPlayerUIView.swift

@@ -27,6 +27,8 @@ class LoopingPlayerUIView: UIView, LoopingPlayerProtocol {
     /// `contrast` indicates the level of contrast adjustment for the video content.
     internal var contrast: Float = 1
 
+    internal let compositeLayer = CALayer()
+    
     /// The AVPlayerLayer that displays the video content.
     internal let playerLayer = AVPlayerLayer()
 
@@ -52,7 +54,7 @@ class LoopingPlayerUIView: UIView, LoopingPlayerProtocol {
     ///   - gravity: The AVLayerVideoGravity to be applied to the video layer.
     required init(asset: AVURLAsset, gravity: AVLayerVideoGravity) {
         super.init(frame: .zero)
-        setupPlayerComponents(asset: asset, gravity: gravity)
+        setupPlayerComponents(asset: asset, gravity: gravity)        
     }
 
     required init?(coder: NSCoder) {

Sources/swiftui-loop-videoplayer/view/loop/player/mac/LoopingPlayerNSView.swift

@@ -29,6 +29,8 @@ class LoopingPlayerNSView: NSView, LoopingPlayerProtocol {
     /// `contrast` indicates the level of contrast adjustment for the video content.
     internal var contrast: Float = 1
 
+    internal let compositeLayer = CALayer()
+    
     /// The AVPlayerLayer that displays the video content.
     internal let playerLayer = AVPlayerLayer()