lottie-ios 4.3.4 → 4.4.0

package/Sources/Public/Animation/LottieAnimationHelpers.swift

@@ -50,7 +50,7 @@ extension LottieAnimation {
 
     /// Check cache for animation
     if
-      let animationCache = animationCache,
+      let animationCache,
       let animation = animationCache.animation(forKey: cacheKey)
     {
       /// If found, return the animation.
@@ -82,7 +82,7 @@ extension LottieAnimation {
   {
     /// Check cache for animation
     if
-      let animationCache = animationCache,
+      let animationCache,
       let animation = animationCache.animation(forKey: filepath)
     {
       return animation
@@ -119,7 +119,7 @@ extension LottieAnimation {
 
     /// Check cache for animation
     if
-      let animationCache = animationCache,
+      let animationCache,
       let animation = animationCache.animation(forKey: cacheKey)
     {
       /// If found, return the animation.
@@ -160,7 +160,7 @@ extension LottieAnimation {
     case .dictionaryBased:
       let json = try JSONSerialization.jsonObject(with: data)
       guard let dict = json as? [String: Any] else {
-        throw InitializableError.invalidInput
+        throw InitializableError.invalidInput()
       }
       return try LottieAnimation(dictionary: dict)
     }
@@ -201,7 +201,7 @@ extension LottieAnimation {
     closure: @escaping LottieAnimation.DownloadClosure,
     animationCache: AnimationCacheProvider? = LottieAnimationCache.shared)
   {
-    if let animationCache = animationCache, let animation = animationCache.animation(forKey: url.absoluteString) {
+    if let animationCache, let animation = animationCache.animation(forKey: url.absoluteString) {
       closure(animation)
     } else {
       let task = session.dataTask(with: url) { data, _, error in
@@ -316,4 +316,6 @@ extension LottieAnimation {
 /// This retroactive conformance is safe because Sendable is a marker protocol that doesn't
 /// include any runtime component. Multiple modules in the same package graph can provide this
 /// conformance without causing any conflicts.
+///
+// swiftlint:disable:next no_unchecked_sendable
 extension Foundation.Bundle: @unchecked Sendable { }

package/Sources/Public/Animation/LottieAnimationLayer.swift

@@ -3,7 +3,6 @@
 //  Lottie
 //
 
-import Foundation
 import QuartzCore
 
 // MARK: - LottieAnimationLayer
@@ -32,7 +31,7 @@ public class LottieAnimationLayer: CALayer {
     self.logger = logger
     super.init()
     makeAnimationLayer(usingEngine: configuration.renderingEngine)
-    if let animation = animation {
+    if let animation {
       frame = animation.bounds
     }
   }
@@ -58,7 +57,7 @@ public class LottieAnimationLayer: CALayer {
     loopMode = dotLottieAnimation?.configuration.loopMode ?? .playOnce
     animationSpeed = CGFloat(dotLottieAnimation?.configuration.speed ?? 1)
     makeAnimationLayer(usingEngine: configuration.renderingEngine)
-    if let animation = animation {
+    if let animation {
       frame = animation.bounds
     }
   }
@@ -104,7 +103,7 @@ public class LottieAnimationLayer: CALayer {
   ///
   /// - Parameter completion: An optional completion closure to be called when the animation completes playing.
   open func play(completion: LottieCompletionBlock? = nil) {
-    guard let animation = animation else { return }
+    guard let animation else { return }
 
     defer {
       currentPlaybackMode = .playing(.fromProgress(nil, toProgress: 1, loopMode: loopMode))
@@ -136,7 +135,7 @@ public class LottieAnimationLayer: CALayer {
     loopMode: LottieLoopMode? = nil,
     completion: LottieCompletionBlock? = nil)
   {
-    guard let animation = animation else { return }
+    guard let animation else { return }
 
     defer {
       currentPlaybackMode = .playing(.fromProgress(fromProgress, toProgress: toProgress, loopMode: loopMode ?? self.loopMode))
@@ -148,7 +147,7 @@ public class LottieAnimationLayer: CALayer {
     }
 
     removeCurrentAnimationIfNecessary()
-    if let loopMode = loopMode {
+    if let loopMode {
       /// Set the loop mode, if one was supplied
       self.loopMode = loopMode
     }
@@ -181,7 +180,7 @@ public class LottieAnimationLayer: CALayer {
     }
 
     removeCurrentAnimationIfNecessary()
-    if let loopMode = loopMode {
+    if let loopMode {
       /// Set the loop mode, if one was supplied
       self.loopMode = loopMode
     }
@@ -228,12 +227,12 @@ public class LottieAnimationLayer: CALayer {
       return
     }
 
-    guard let animation = animation, let markers = animation.markerMap, let to = markers[toMarker] else {
+    guard let animation, let markers = animation.markerMap, let to = markers[toMarker] else {
       return
     }
 
     removeCurrentAnimationIfNecessary()
-    if let loopMode = loopMode {
+    if let loopMode {
       /// Set the loop mode, if one was supplied
       self.loopMode = loopMode
     }
@@ -331,7 +330,7 @@ public class LottieAnimationLayer: CALayer {
       // If the completion handler is called with `completed: false` (which typically means
       // that another animation was played by calling some `play` method),
       // we should cancel the marker sequence and not play the next marker.
-      guard completed, let self = self else {
+      guard completed, let self else {
         completion?(false)
         return
       }
@@ -488,7 +487,7 @@ public class LottieAnimationLayer: CALayer {
 
   /// A closure called when the animation layer has been loaded.
   /// Will inform the receiver the type of rendering engine that is used for the layer.
-  public var animationLayerDidLoad:((_ animationLayer: LottieAnimationLayer, _ renderingEngine: RenderingEngineOption) -> Void)?
+  public var animationLayerDidLoad: ((_ animationLayer: LottieAnimationLayer, _ renderingEngine: RenderingEngineOption) -> Void)?
 
   /// The configuration that this `LottieAnimationView` uses when playing its animation
   public var configuration: LottieConfiguration {
@@ -549,7 +548,7 @@ public class LottieAnimationLayer: CALayer {
     didSet {
       makeAnimationLayer(usingEngine: configuration.renderingEngine)
 
-      if let animation = animation {
+      if let animation {
         animationLoaded?(self, animation)
       }
     }
@@ -584,7 +583,7 @@ public class LottieAnimationLayer: CALayer {
   /// ```
   public var animationLoaded: ((_ animationLayer: LottieAnimationLayer, _ animation: LottieAnimation) -> Void)? {
     didSet {
-      if let animation = animation {
+      if let animation {
         animationLoaded?(self, animation)
       }
     }
@@ -662,7 +661,7 @@ public class LottieAnimationLayer: CALayer {
   /// Note 2: If `animation` is nil, setting this will fallback to 0
   public var currentProgress: AnimationProgressTime {
     set {
-      if let animation = animation {
+      if let animation {
         currentFrame = animation.frameTime(forProgress: newValue)
         currentPlaybackMode = .paused(at: .progress(newValue))
       } else {
@@ -670,7 +669,7 @@ public class LottieAnimationLayer: CALayer {
       }
     }
     get {
-      if let animation = animation {
+      if let animation {
         return animation.progressTime(forFrame: currentFrame)
       } else {
         return 0
@@ -684,7 +683,7 @@ public class LottieAnimationLayer: CALayer {
   /// Note 2: If `animation` is nil, setting this will fallback to 0
   public var currentTime: TimeInterval {
     set {
-      if let animation = animation {
+      if let animation {
         currentFrame = animation.frameTime(forTime: newValue)
         currentPlaybackMode = .paused(at: .time(newValue))
       } else {
@@ -692,7 +691,7 @@ public class LottieAnimationLayer: CALayer {
       }
     }
     get {
-      if let animation = animation {
+      if let animation {
         return animation.time(forFrame: currentFrame)
       } else {
         return 0
@@ -721,7 +720,7 @@ public class LottieAnimationLayer: CALayer {
 
   /// Returns the current animation frame while an animation is playing.
   public var realtimeAnimationProgress: AnimationProgressTime {
-    if let animation = animation {
+    if let animation {
       return animation.progressTime(forFrame: realtimeAnimationFrame)
     }
     return 0
@@ -754,7 +753,7 @@ public class LottieAnimationLayer: CALayer {
       return engine
 
     case .automatic:
-      guard let animationLayer = animationLayer else {
+      guard let animationLayer else {
         return nil
       }
 
@@ -893,7 +892,7 @@ public class LottieAnimationLayer: CALayer {
   /// - Parameter toLayerAt: The keypath used to find the layer.
   public func convert(_ rect: CGRect, toLayerAt keypath: AnimationKeypath?) -> CGRect? {
     guard let animationLayer = rootAnimationLayer else { return nil }
-    guard let keypath = keypath else {
+    guard let keypath else {
       return convert(rect, to: animationLayer)
     }
     guard let sublayer = animationLayer.layer(for: keypath) else {
@@ -914,7 +913,7 @@ public class LottieAnimationLayer: CALayer {
   /// - Parameter toLayerAt: The keypath used to find the layer.
   public func convert(_ point: CGPoint, toLayerAt keypath: AnimationKeypath?) -> CGPoint? {
     guard let animationLayer = rootAnimationLayer else { return nil }
-    guard let keypath = keypath else {
+    guard let keypath else {
       return convert(point, to: animationLayer)
     }
     guard let sublayer = animationLayer.layer(for: keypath) else {
@@ -934,7 +933,7 @@ public class LottieAnimationLayer: CALayer {
   public func setNodeIsEnabled(isEnabled: Bool, keypath: AnimationKeypath) {
     guard let animationLayer = rootAnimationLayer else { return }
     let nodes = animationLayer.animatorNodes(for: keypath)
-    if let nodes = nodes {
+    if let nodes {
       for node in nodes {
         node.isEnabled = isEnabled
       }
@@ -951,7 +950,7 @@ public class LottieAnimationLayer: CALayer {
   ///
   /// Returns the Progress Time for the marker named. Returns nil if no marker found.
   public func progressTime(forMarker named: String) -> AnimationProgressTime? {
-    guard let animation = animation else {
+    guard let animation else {
       return nil
     }
     return animation.progressTime(forMarker: named)
@@ -966,7 +965,7 @@ public class LottieAnimationLayer: CALayer {
   ///
   /// Returns the Frame Time for the marker named. Returns nil if no marker found.
   public func frameTime(forMarker named: String) -> AnimationFrameTime? {
-    guard let animation = animation else {
+    guard let animation else {
       return nil
     }
     return animation.frameTime(forMarker: named)
@@ -981,7 +980,7 @@ public class LottieAnimationLayer: CALayer {
   ///
   /// - Returns: The duration frame time for the marker, or `nil` if no marker found.
   public func durationFrameTime(forMarker named: String) -> AnimationFrameTime? {
-    guard let animation = animation else {
+    guard let animation else {
       return nil
     }
     return animation.durationFrameTime(forMarker: named)
@@ -1074,7 +1073,7 @@ public class LottieAnimationLayer: CALayer {
 
   /// Updates an in flight animation.
   func updateInFlightAnimation() {
-    guard let animationContext = animationContext else { return }
+    guard let animationContext else { return }
 
     guard animationContext.closure.animationState != .complete else {
       // Tried to re-add an already completed animation. Cancel.
@@ -1146,7 +1145,7 @@ public class LottieAnimationLayer: CALayer {
       rootAnimationLayer = nil
     }
 
-    guard let animation = animation else {
+    guard let animation else {
       return
     }
     let rootAnimationLayer: RootAnimationLayer?
@@ -1294,7 +1293,7 @@ public class LottieAnimationLayer: CALayer {
     // was being used by the previous Core Animation layer
     self.currentFrame = currentFrame
 
-    if let animationContext = animationContext {
+    if let animationContext {
       // `AnimationContext.closure` (`AnimationCompletionDelegate`) is a reference type
       // that is the animation layer's `CAAnimationDelegate`, and holds a reference to
       // the animation layer. Reusing a single instance across different animation layers
@@ -1328,25 +1327,12 @@ public class LottieAnimationLayer: CALayer {
 
   /// Adds animation to animation layer and sets the delegate. If animation layer or animation are nil, exits.
   fileprivate func addNewAnimationForContext(_ animationContext: AnimationContext) {
-    guard let animationlayer = rootAnimationLayer, let animation = animation else {
+    guard let animationlayer = rootAnimationLayer, let animation else {
       return
     }
 
     self.animationContext = animationContext
 
-    switch currentRenderingEngine {
-    case .mainThread:
-      // On the CALayer side, just play all animations immediately. The UIView side
-      // will handle queueing animations.
-      break
-
-    case .coreAnimation, nil:
-      // The Core Animation engine automatically batches animation setup to happen
-      // in `CALayer.display()`, which won't be called until the layer is on-screen,
-      // so we don't need to defer animation setup at this layer.
-      break
-    }
-
     animationID = animationID + 1
     _activeAnimationName = LottieAnimationLayer.animationName + String(animationID)
 
@@ -1495,7 +1481,7 @@ public class LottieAnimationLayer: CALayer {
 
   /// Plays the marker that corresponds to the current "reduced motion" mode if present.
   private func playReducedMotionAnimation(completion: LottieCompletionBlock?) {
-    guard let reducedMotionMarker = reducedMotionMarker else { return }
+    guard let reducedMotionMarker else { return }
 
     // `play(marker:)` calls the `play(fromFrame:toFrame:)` method which calls this
     // `playReducedMotionAnimation` method when `shouldOverrideWithReducedMotionAnimation`

package/Sources/Public/Animation/LottieAnimationView.swift

@@ -5,7 +5,6 @@
 //  Created by Brandon Withrow on 1/23/19.
 //
 
-import Foundation
 import QuartzCore
 
 // MARK: - LottieBackgroundBehavior
@@ -115,7 +114,7 @@ open class LottieAnimationView: LottieAnimationViewBase {
     self.logger = logger
     super.init(frame: .zero)
     commonInit()
-    if let animation = animation {
+    if let animation {
       frame = animation.bounds
     }
   }
@@ -139,7 +138,7 @@ open class LottieAnimationView: LottieAnimationViewBase {
     self.logger = logger
     super.init(frame: .zero)
     commonInit()
-    if let animation = animation {
+    if let animation {
       frame = animation.bounds
     }
   }
@@ -438,7 +437,7 @@ open class LottieAnimationView: LottieAnimationViewBase {
   /// ```
   public var animationLoaded: ((_ animationView: LottieAnimationView, _ animation: LottieAnimation) -> Void)? {
     didSet {
-      if let animation = animation {
+      if let animation {
         animationLoaded?(self, animation)
       }
     }
@@ -835,14 +834,14 @@ open class LottieAnimationView: LottieAnimationViewBase {
     viewLayer?.addSublayer(lottieAnimationLayer)
 
     lottieAnimationLayer.animationLoaded = { [weak self] _, animation in
-      guard let self = self else { return }
+      guard let self else { return }
       self.animationLoaded?(self, animation)
       self.invalidateIntrinsicContentSize()
       self.setNeedsLayout()
     }
 
     lottieAnimationLayer.animationLayerDidLoad = { [weak self] _, _ in
-      guard let self = self else { return }
+      guard let self else { return }
       self.invalidateIntrinsicContentSize()
       self.setNeedsLayout()
     }
@@ -855,7 +854,7 @@ open class LottieAnimationView: LottieAnimationViewBase {
     let xform: CATransform3D
     var shouldForceUpdates = false
 
-    if let viewportFrame = viewportFrame {
+    if let viewportFrame {
       setNeedsLayout()
       shouldForceUpdates = contentMode == .redraw
 

package/Sources/Public/Animation/LottieAnimationViewInitializers.swift

@@ -62,14 +62,14 @@ extension LottieAnimationView {
     animationCache: AnimationCacheProvider? = LottieAnimationCache.shared,
     configuration: LottieConfiguration = .shared)
   {
-    if let animationCache = animationCache, let animation = animationCache.animation(forKey: url.absoluteString) {
+    if let animationCache, let animation = animationCache.animation(forKey: url.absoluteString) {
       self.init(animation: animation, imageProvider: imageProvider, configuration: configuration)
       closure(nil)
     } else {
       self.init(animation: nil, imageProvider: imageProvider, configuration: configuration)
 
       LottieAnimation.loadedFrom(url: url, session: session, closure: { animation in
-        if let animation = animation {
+        if let animation {
           self.animation = animation
           closure(nil)
         } else {
@@ -166,7 +166,7 @@ extension LottieAnimationView {
     session: URLSession = .shared,
     completion: ((LottieAnimationView, Error?) -> Void)? = nil)
   {
-    if let dotLottieCache = dotLottieCache, let lottie = dotLottieCache.file(forKey: url.absoluteString) {
+    if let dotLottieCache, let lottie = dotLottieCache.file(forKey: url.absoluteString) {
       self.init(dotLottie: lottie, animationId: animationId, configuration: configuration)
       completion?(self, nil)
     } else {

package/Sources/Public/Animation/LottiePlaybackMode.swift

@@ -205,3 +205,56 @@ public enum LottieMarkerPosition: Hashable {
   case start
   case end
 }
+
+extension LottiePlaybackMode {
+  /// Returns a copy of this `PlaybackMode` with the `LottieLoopMode` updated to the given value
+  func loopMode(_ updatedLoopMode: LottieLoopMode) -> LottiePlaybackMode {
+    switch self {
+    case .playing(let playbackMode):
+      return .playing(playbackMode.loopMode(updatedLoopMode))
+
+    case .fromProgress(let fromProgress, toProgress: let toProgress, _):
+      return .playing(.fromProgress(
+        fromProgress,
+        toProgress: toProgress,
+        loopMode: updatedLoopMode))
+
+    case .fromFrame(let fromFrame, toFrame: let toFrame, _):
+      return .playing(.fromFrame(
+        fromFrame,
+        toFrame: toFrame,
+        loopMode: updatedLoopMode))
+
+    case .fromMarker(let fromMarker, let toMarker, let playEndMarkerFrame, _):
+      return .playing(.fromMarker(
+        fromMarker,
+        toMarker: toMarker,
+        playEndMarkerFrame: playEndMarkerFrame,
+        loopMode: updatedLoopMode))
+
+    case .marker(let marker, _):
+      return .playing(.marker(marker, loopMode: updatedLoopMode))
+
+    case .pause, .paused, .progress(_), .time(_), .frame(_), .markers:
+      return self
+    }
+  }
+}
+
+extension LottiePlaybackMode.PlaybackMode {
+  /// Returns a copy of this `PlaybackMode` with the `LottieLoopMode` updated to the given value
+  func loopMode(_ updatedLoopMode: LottieLoopMode) -> LottiePlaybackMode.PlaybackMode {
+    switch self {
+    case .fromProgress(let fromProgress, let toProgress, _):
+      return .fromProgress(fromProgress, toProgress: toProgress, loopMode: updatedLoopMode)
+    case .fromFrame(let fromFrame, let toFrame, _):
+      return .fromFrame(fromFrame, toFrame: toFrame, loopMode: updatedLoopMode)
+    case .fromMarker(let fromMarker, let toMarker, let playEndMarkerFrame, _):
+      return .fromMarker(fromMarker, toMarker: toMarker, playEndMarkerFrame: playEndMarkerFrame, loopMode: updatedLoopMode)
+    case .marker(let marker, _):
+      return .marker(marker, loopMode: updatedLoopMode)
+    case .markers:
+      return self
+    }
+  }
+}