added Picture-in-Picture support

Author: swiftuiux

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

@@ -95,14 +95,23 @@ public enum PlaybackCommand: Equatable {
     /// 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)
-
+    
+    #if os(iOS)
+    case startPiP
+    
+    case stopPiP
+    #endif
+    
     public static func == (lhs: PlaybackCommand, rhs: PlaybackCommand) -> Bool {
         switch (lhs, rhs) {
         case (.idle, .idle), (.play, .play), (.pause, .pause), (.begin, .begin), (.end, .end),
              (.mute, .mute), (.unmute, .unmute), (.loop, .loop), (.unloop, .unloop),
              (.removeAllFilters, .removeAllFilters), (.removeAllVectors, .removeAllVectors):
             return true
-
+        #if os(iOS)
+        case (.startPiP, .startPiP), (.stopPiP, .stopPiP):
+            return true
+        #endif
         case (.seek(let lhsTime, let lhsPlay), .seek(let rhsTime, let rhsPlay)):
             return lhsTime == rhsTime && lhsPlay == rhsPlay
 

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

@@ -62,6 +62,10 @@ public enum PlayerEvent: Equatable {
 
 
     case boundsChanged(CGRect)
+    
+    case startedPiP
+    
+    case stoppedPiP
 }
 
 extension PlayerEvent: CustomStringConvertible {
@@ -85,6 +89,10 @@ extension PlayerEvent: CustomStringConvertible {
             return "\(e.description)"
         case .boundsChanged(let bounds):
             return "Bounds changed \(bounds)"
+        case .startedPiP:
+            return "Started PiP"
+        case .stoppedPiP:
+            return "Stopped PiP"
         }
     }
 }

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

@@ -42,6 +42,9 @@ public enum Setting: Equatable, SettingsConvertible{
     /// Subtitles
     case subtitles(String)
 
+    /// Support Picture-in-Picture
+    case pictureInPicture
+    
     /// A CMTime value representing the interval at which the player's current time should be published.
     /// If set, the player will publish periodic time updates based on this interval.
     case timePublishing(CMTime)

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

@@ -22,6 +22,9 @@ public enum VPErrors: Error, CustomStringConvertible, Sendable{
     /// Error case for when settings are not unique.
     case settingsNotUnique
 
+    /// Picture-in-Picture (PiP)  is not supported
+    case notSupportedPiP
+    
     /// A description of the error, suitable for display.
     public var description: String {
         switch self {
@@ -30,6 +33,9 @@ public enum VPErrors: Error, CustomStringConvertible, Sendable{
             case .sourceNotFound(let name):
                 return "Source not found: \(name)"
 
+            case .notSupportedPiP:
+                return "Picture-in-Picture (PiP) is not supported on this device."
+            
             /// Returns a description indicating that the settings are not unique.
             case .settingsNotUnique:
                 return "Settings are not unique"

Sources/swiftui-loop-videoplayer/protocol/helpers/PlayerDelegateProtocol.swift

@@ -7,13 +7,16 @@
 
 import Foundation
 import AVFoundation
+#if os(iOS)
+import AVKit
+#endif
 
 /// Protocol to handle player-related errors.
 ///
 /// Conforming to this protocol allows a class to respond to error events that occur within a media player context.
 @available(iOS 14, macOS 11, tvOS 14, *)
 @MainActor
-public protocol PlayerDelegateProtocol: AnyObject {
+public protocol PlayerDelegateProtocol: AnyObject{
     /// Called when an error is encountered within the media player.
     ///
     /// This method provides a way for delegate objects to respond to error conditions, allowing them to handle or
@@ -69,4 +72,10 @@ public protocol PlayerDelegateProtocol: AnyObject {
     /// - Parameter bounds: The new bounds of the main layer where we keep the video player and all vector layers. This allows a developer to recalculate and update all vector layers that lie in the CompositeLayer.
 
     func boundsDidChange(to bounds: CGRect)
+    
+#if os(iOS)
+    func pictureInPictureControllerDidStartPictureInPicture(_ pictureInPictureController: AVPictureInPictureController)
+    
+    func pictureInPictureControllerDidStopPictureInPicture(_ pictureInPictureController: AVPictureInPictureController)
+#endif
 }

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

@@ -8,6 +8,7 @@
 import AVFoundation
 #if canImport(CoreImage)
 import CoreImage
+import AVKit
 #endif
 
 /// Defines an abstract player protocol to be implemented by player objects, ensuring main-thread safety and compatibility with specific OS versions.
@@ -18,6 +19,10 @@ public protocol AbstractPlayer: AnyObject {
 
     // MARK: - Properties
 
+    #if os(iOS)
+    var pipController: AVPictureInPictureController? { get set }
+    #endif
+    
     /// An optional property that stores the current video settings.
     ///
     /// This property holds an instance of `VideoSettings` or nil if no settings have been configured yet.
@@ -445,4 +450,25 @@ extension AbstractPlayer{
         }
         #endif
     }
+    
+    #if os(iOS)
+    func startPiP() {
+        guard let pipController = pipController else { return }
+
+        if !pipController.isPictureInPictureActive {
+            pipController.startPictureInPicture()
+
+        }
+    }
+    
+    func stopPiP() {
+        guard let pipController = pipController else { return }
+
+        if pipController.isPictureInPictureActive {
+            // Stop PiP
+            pipController.stopPictureInPicture()
+        }
+    }
+    
+    #endif
 }

Sources/swiftui-loop-videoplayer/protocol/player/ExtPlayerProtocol.swift

@@ -63,7 +63,9 @@ public protocol ExtPlayerProtocol: AbstractPlayer, LayerMakerProtocol{
     ///   - item: The AVPlayerItem to observe for status changes.
     ///   - player: The AVQueuePlayer to observe for errors.
     func setupObservers(for player: AVQueuePlayer)
-
+    
+    /// Handles errors
+    func onError(_ error : VPErrors)
 }
 
 internal extension ExtPlayerProtocol {
@@ -193,7 +195,7 @@ internal extension ExtPlayerProtocol {
 
     /// Handles errors
     /// - Parameter error: An instance of `VPErrors` representing the error to be handled.
-    private func onError(_ error : VPErrors){
+    func onError(_ error : VPErrors){
         delegate?.didReceiveError(error)
     }
 
@@ -351,6 +353,10 @@ internal extension ExtPlayerProtocol {
             addVectorLayer(builder: builder, clear: clear)
         case .removeAllVectors:
             removeAllVectors()
+        #if os(iOS)
+        case .startPiP: startPiP()
+        case .stopPiP: stopPiP()
+        #endif
         default : return
         }
     }

Sources/swiftui-loop-videoplayer/settings/PictureInPicture .swift

@@ -0,0 +1,25 @@
+//
+//  PictureInPicture .swift
+//
+//
+//  Created by Igor Shelopaev on 21.01.25.
+//
+
+import Foundation
+
+
+/// Represents a settings structure that enables looping functionality, conforming to `SettingsConvertible`.
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, *)
+public struct PictureInPicture : SettingsConvertible{
+    
+    // MARK: - Life circle
+    
+    /// Initializes a new instance
+    public init() {}
+    
+    /// Fetch settings
+    @_spi(Private)
+    public func asSettings() -> [Setting] {
+        [.pictureInPicture]
+    }
+}

Sources/swiftui-loop-videoplayer/utils/VideoSettings.swift

@@ -26,6 +26,9 @@ public struct VideoSettings: Equatable{
     /// Loop video
     public let loop: Bool
 
+    /// Loop video
+    public let pictureInPicture: Bool
+    
     /// Mute video
     public let mute: Bool
 
@@ -63,11 +66,12 @@ public struct VideoSettings: Equatable{
     ///   - notAutoPlay: A Boolean indicating whether the video should not auto-play.
     ///   - timePublishing: A `CMTime` value representing the interval for time publishing updates, or `nil`.
     ///   - gravity: The `AVLayerVideoGravity` value defining how the video should be displayed in its layer.
-    public init(name: String, ext: String, subtitles: String, loop: Bool, mute: Bool, notAutoPlay: Bool, timePublishing: CMTime?, gravity: AVLayerVideoGravity, enableVector : Bool = false) {
+    public init(name: String, ext: String, subtitles: String, loop: Bool, pictureInPicture: Bool, mute: Bool, notAutoPlay: Bool, timePublishing: CMTime?, gravity: AVLayerVideoGravity, enableVector : Bool = false) {
         self.name = name
         self.ext = ext
         self.subtitles = subtitles
         self.loop = loop
+        self.pictureInPicture = pictureInPicture
         self.mute = mute
         self.notAutoPlay = notAutoPlay
         self.timePublishing = timePublishing
@@ -95,6 +99,8 @@ public struct VideoSettings: Equatable{
 
         loop = settings.contains(.loop)
 
+        pictureInPicture = settings.contains(.pictureInPicture)
+        
         mute = settings.contains(.mute)
 
         notAutoPlay = settings.contains(.notAutoPlay)
@@ -108,7 +114,7 @@ public extension VideoSettings {
 
     /// Returns a new instance of VideoSettings with loop set to false and notAutoPlay set to true, keeping other settings unchanged.
     var settingsWithAutoPlay : VideoSettings {
-        VideoSettings(name: self.name, ext: self.ext, subtitles: self.subtitles, loop: self.loop, mute: self.mute, notAutoPlay: false, timePublishing: self.timePublishing, gravity: self.gravity, enableVector: self.vector)
+        VideoSettings(name: self.name, ext: self.ext, subtitles: self.subtitles, loop: self.loop, pictureInPicture: self.pictureInPicture, mute: self.mute, notAutoPlay: false, timePublishing: self.timePublishing, gravity: self.gravity, enableVector: self.vector)
     }
 
     func getAssets()-> AVURLAsset?{

Sources/swiftui-loop-videoplayer/view/helpers/PlayerCoordinator.swift

@@ -8,6 +8,9 @@
 import SwiftUI
 import Combine
 import AVFoundation
+#if os(iOS)
+import AVKit
+#endif
 
 @MainActor
 internal class PlayerCoordinator: NSObject, PlayerDelegateProtocol {
@@ -119,4 +122,22 @@ internal class PlayerCoordinator: NSObject, PlayerDelegateProtocol {
     func boundsDidChange(to bounds: CGRect) {
         eventPublisher.send(.boundsChanged(bounds))
     }
+
+}
+
+#if os(iOS)
+extension PlayerCoordinator: AVPictureInPictureControllerDelegate{
+    
+    nonisolated func pictureInPictureControllerDidStartPictureInPicture(_ pictureInPictureController: AVPictureInPictureController) {
+        Task{ @MainActor in
+            eventPublisher.send(.startedPiP)
+        }
+    }
+    
+    nonisolated func pictureInPictureControllerDidStopPictureInPicture(_ pictureInPictureController: AVPictureInPictureController) {
+        Task{ @MainActor in
+            eventPublisher.send(.stoppedPiP)
+        }
+    }
 }
+#endif