Merge pull request #168 from SDWebImage/feature_playbackmode

Update with the playbackMode support for `WebImage` and `AnimatedImage`

Author: dreampiggy

README.md

@@ -160,6 +160,7 @@ var body: some View {
     // The initial value of binding should be true
     .customLoopCount(1) // Custom loop count
     .playbackRate(2.0) // Playback speed rate
+    .playbackMode(.bounce) // Playback normally to the end, then reversely back to the start
     // `WebImage` supports advanced control just like `AnimatedImage`, but without the progressive animation support
 }
 ```

SDWebImageSwiftUI/Classes/AnimatedImage.swift

@@ -84,6 +84,7 @@ final class AnimatedImageConfiguration: ObservableObject {
     var pausable: Bool?
     var purgeable: Bool?
     var playbackRate: Double?
+    var playbackMode: SDAnimatedImagePlaybackMode?
     // These configurations only useful for web image loading
     var indicator: SDWebImageIndicator?
     var transition: SDWebImageTransition?
@@ -253,7 +254,7 @@ public struct AnimatedImage : PlatformViewRepresentable {
             } else {
                 // This is a hack because of iOS 13's SwiftUI bug, the @Published does not trigger another `updateUIView` call
                 // Here I have to use UIKit/AppKit API to triger the same effect (the window change implicitly cause re-render)
-                if let hostingView = AnimatedImage.findHostingView(from: view) {
+                if let hostingView = view.findHostingView() {
                     if let _ = hostingView.window {
                         #if os(macOS)
                         hostingView.viewDidMoveToWindow()
@@ -542,17 +543,13 @@ public struct AnimatedImage : PlatformViewRepresentable {
         } else {
             view.wrapped.playbackRate = 1.0
         }
-    }
-    
-    private static func findHostingView(from entry: PlatformView) -> PlatformView? {
-        var superview = entry.superview
-        while let s = superview {
-            if NSStringFromClass(type(of: s)).contains("HostingView") {
-                return s
-            }
-            superview = s.superview
+        
+        // Playback Mode
+        if let playbackMode = imageConfiguration.playbackMode {
+            view.wrapped.playbackMode = playbackMode
+        } else {
+            view.wrapped.playbackMode = .normal
         }
-        return nil
     }
 }
 
@@ -717,6 +714,13 @@ extension AnimatedImage {
         self.imageConfiguration.playbackRate = playbackRate
         return self
     }
+    
+    /// Control the animation playback mode. Default is .normal
+    /// - Parameter playbackMode: The playback mode, including normal order, reverse order, bounce order and reversed bounce order.
+    public func playbackMode(_ playbackMode: SDAnimatedImagePlaybackMode) -> AnimatedImage {
+        self.imageConfiguration.playbackMode = playbackMode
+        return self
+    }
 }
 
 // Completion Handler

SDWebImageSwiftUI/Classes/ImagePlayer.swift

@@ -26,6 +26,9 @@ public final class ImagePlayer : ObservableObject {
     /// Animation playback rate
     public var playbackRate: Double = 1.0
 
+    /// Animation playback mode
+    public var playbackMode: SDAnimatedImagePlaybackMode = .normal
+    
     deinit {
         player?.stopPlaying()
         currentFrame = nil
@@ -71,10 +74,11 @@ public final class ImagePlayer : ObservableObject {
                     imagePlayer.maxBufferSize = maxBufferSize
                 }
                 if let customLoopCount = customLoopCount {
-                    imagePlayer.totalLoopCount = UInt(customLoopCount)
+                    imagePlayer.totalLoopCount = customLoopCount
                 }
                 imagePlayer.runLoopMode = runLoopMode
                 imagePlayer.playbackRate = playbackRate
+                imagePlayer.playbackMode = playbackMode
 
                 self.player = imagePlayer
 

SDWebImageSwiftUI/Classes/ImageViewWrapper.swift

@@ -114,6 +114,20 @@ extension PlatformView {
         self.leadingAnchor.constraint(equalTo: superview.leadingAnchor, constant: 0).isActive = true
         self.trailingAnchor.constraint(equalTo: superview.trailingAnchor, constant: 0).isActive = true
     }
+    
+    /// Finding the HostingView for UIKit/AppKit View.
+    /// - Parameter entry: The entry platform view
+    /// - Returns: The hosting view.
+    func findHostingView() -> PlatformView? {
+        var superview = self.superview
+        while let s = superview {
+            if NSStringFromClass(type(of: s)).contains("HostingView") {
+                return s
+            }
+            superview = s.superview
+        }
+        return nil
+    }
 }
 
 #endif

SDWebImageSwiftUI/Classes/WebImage.swift

@@ -399,6 +399,13 @@ extension WebImage {
         self.imagePlayer.playbackRate = playbackRate
         return self
     }
+    
+    /// Control the animation playback mode. Default is .normal
+    /// - Parameter playbackMode: The playback mode, including normal order, reverse order, bounce order and reversed bounce order.
+    public func playbackMode(_ playbackMode: SDAnimatedImagePlaybackMode) -> WebImage {
+        self.imagePlayer.playbackMode = playbackMode
+        return self
+    }
 }
 
 #if DEBUG