Added additional support for multiple animations in DotLottie

Example/iOS/ViewControllers/AnimationPreviewViewController.swift

@@ -240,6 +240,21 @@ class AnimationPreviewViewController: UIViewController {
                 updateAnimation()
               }),
           ]),
+
+        UIMenu(
+          title: "Navigate...",
+          children: [
+            UIAction(
+              title: "Next Animation",
+              handler: { [unowned self] _ in
+                nextAnimation()
+              }),
+            UIAction(
+              title: "Previous Animation",
+              handler: { [unowned self] _ in
+                previousAnimation()
+              }),
+          ]),
       ]))
   }
 
@@ -249,4 +264,15 @@ class AnimationPreviewViewController: UIViewController {
     configureSettingsMenu()
   }
 
+  private func nextAnimation() {
+    animationView.nextAnimation()
+    animationView.play()
+    configureSettingsMenu()
+  }
+
+  private func previousAnimation() {
+    animationView.previousAnimation()
+    animationView.play()
+    configureSettingsMenu()
+  }
 }

Lottie.xcodeproj/project.pbxproj

@@ -649,6 +649,9 @@
 		6C4878602901D8C70005AF07 /* DotLottieImageProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C48785F2901D8C70005AF07 /* DotLottieImageProvider.swift */; };
 		6C4878612901D8C70005AF07 /* DotLottieImageProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C48785F2901D8C70005AF07 /* DotLottieImageProvider.swift */; };
 		6C4878622901D8C70005AF07 /* DotLottieImageProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C48785F2901D8C70005AF07 /* DotLottieImageProvider.swift */; };
+		6C49605C2A33452900BDF3CB /* DotLottieAnimationMode.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C49605B2A33452900BDF3CB /* DotLottieAnimationMode.swift */; };
+		6C49605D2A33452900BDF3CB /* DotLottieAnimationMode.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C49605B2A33452900BDF3CB /* DotLottieAnimationMode.swift */; };
+		6C49605E2A33452900BDF3CB /* DotLottieAnimationMode.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C49605B2A33452900BDF3CB /* DotLottieAnimationMode.swift */; };
 		6CC544932902FF7D00212722 /* DotLottieCache.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C48785529017D1D0005AF07 /* DotLottieCache.swift */; };
 		6D0E635F28246BD0007C5DB6 /* Difference in Frameworks */ = {isa = PBXBuildFile; productRef = 6D0E635E28246BD0007C5DB6 /* Difference */; };
 		6D99D6432823790700E5205B /* LegacyGradientFillRenderer.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6D99D6422823790700E5205B /* LegacyGradientFillRenderer.swift */; };
@@ -918,6 +921,7 @@
 		6C48785529017D1D0005AF07 /* DotLottieCache.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DotLottieCache.swift; sourceTree = "<group>"; };
 		6C4878592901811D0005AF07 /* DotLottieFileHelpers.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DotLottieFileHelpers.swift; sourceTree = "<group>"; };
 		6C48785F2901D8C70005AF07 /* DotLottieImageProvider.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DotLottieImageProvider.swift; sourceTree = "<group>"; };
+		6C49605B2A33452900BDF3CB /* DotLottieAnimationMode.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DotLottieAnimationMode.swift; sourceTree = "<group>"; };
 		6D99D6422823790700E5205B /* LegacyGradientFillRenderer.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LegacyGradientFillRenderer.swift; sourceTree = "<group>"; };
 		6DB3BDB528243FA5002A276D /* ValueProvidersTests.swift */ = {isa = PBXFileReference; indentWidth = 2; lastKnownFileType = sourcecode.swift; path = ValueProvidersTests.swift; sourceTree = "<group>"; tabWidth = 2; };
 		6DB3BDB7282454A6002A276D /* DictionaryInitializable.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DictionaryInitializable.swift; sourceTree = "<group>"; };
@@ -1660,6 +1664,7 @@
 				6C4877FB28FF20140005AF07 /* DotLottieManifest.swift */,
 				6C4877E428FF20140005AF07 /* DotLottieUtils.swift */,
 				6C4877E228FF20140005AF07 /* DotLottieAnimation.swift */,
+				6C49605B2A33452900BDF3CB /* DotLottieAnimationMode.swift */,
 				6C48784A29008ACF0005AF07 /* DotLottieConfiguration.swift */,
 				6C48785F2901D8C70005AF07 /* DotLottieImageProvider.swift */,
 				6CFA1077290B12B900873A98 /* ZipFoundation */,
@@ -2015,6 +2020,7 @@
 				2EAF5AD727A0798700E00531 /* Vectors.swift in Sources */,
 				2E9C95E22822F43100677516 /* Group.swift in Sources */,
 				2E9C97112822F43100677516 /* Keyframes+combined.swift in Sources */,
+				6C49605C2A33452900BDF3CB /* DotLottieAnimationMode.swift in Sources */,
 				0887347B28F0CCDD00458627 /* LottieAnimationView.swift in Sources */,
 				2EAF5AD127A0798700E00531 /* AnimatedControl.swift in Sources */,
 				2E9C966F2822F43100677516 /* LayerTextProvider.swift in Sources */,
@@ -2262,6 +2268,7 @@
 				2EAF5AD827A0798700E00531 /* Vectors.swift in Sources */,
 				2E9C95E32822F43100677516 /* Group.swift in Sources */,
 				2E9C97122822F43100677516 /* Keyframes+combined.swift in Sources */,
+				6C49605D2A33452900BDF3CB /* DotLottieAnimationMode.swift in Sources */,
 				0887347C28F0CCDD00458627 /* LottieAnimationView.swift in Sources */,
 				2EAF5AD227A0798700E00531 /* AnimatedControl.swift in Sources */,
 				2E9C96702822F43100677516 /* LayerTextProvider.swift in Sources */,
@@ -2485,6 +2492,7 @@
 				2EAF5AD927A0798700E00531 /* Vectors.swift in Sources */,
 				2E9C95E42822F43100677516 /* Group.swift in Sources */,
 				2E9C97132822F43100677516 /* Keyframes+combined.swift in Sources */,
+				6C49605E2A33452900BDF3CB /* DotLottieAnimationMode.swift in Sources */,
 				0887347D28F0CCDD00458627 /* LottieAnimationView.swift in Sources */,
 				2EAF5AD327A0798700E00531 /* AnimatedControl.swift in Sources */,
 				2E9C96712822F43100677516 /* LayerTextProvider.swift in Sources */,

Sources/Private/Model/DotLottie/DotLottieAnimation.swift

@@ -20,12 +20,15 @@ struct DotLottieAnimation: Codable {
   /// 1 or -1
   var direction: Int? = 1
 
+  /// Auto plays animation
+  var autoplay: Bool? = false
+
   /// mode - "bounce" | "normal"
-  var mode: String? = "normal"
+  var mode: DotLottieAnimationMode? = .normal
 
   /// Loop mode for animation
   var loopMode: LottieLoopMode {
-    mode == "bounce" ? .autoReverse : ((loop ?? false) ? .loop : .playOnce)
+    mode == .bounce ? .autoReverse : ((loop ?? false) ? .loop : .playOnce)
   }
 
   /// Animation speed

Sources/Private/Model/DotLottie/DotLottieAnimationMode.swift

@@ -0,0 +1,13 @@
+//
+//  DotLottieAnimationMode.swift
+//  Lottie
+//
+//  Created by Evandro Hoffmann on 09/06/23.
+//
+
+import Foundation
+
+enum DotLottieAnimationMode: String, Codable {
+  case normal
+  case bounce
+}

Sources/Private/Model/DotLottie/DotLottieConfiguration.swift

@@ -12,4 +12,5 @@ struct DotLottieConfiguration {
   var imageProvider: AnimationImageProvider?
   var loopMode: LottieLoopMode
   var speed: Double
+  var autoplay: Bool
 }

Sources/Public/Animation/LottieAnimationView.swift

@@ -648,15 +648,54 @@ open class LottieAnimationView: LottieAnimationViewBase {
     from dotLottieFile: DotLottieFile)
   {
     guard let dotLottieAnimation = dotLottieFile.animation(for: animationId) else { return }
+    loadAnimation(dotLottieAnimation, from: dotLottieFile)
+  }
 
-    loopMode = dotLottieAnimation.configuration.loopMode
-    animationSpeed = CGFloat(dotLottieAnimation.configuration.speed)
-
-    if let imageProvider = dotLottieAnimation.configuration.imageProvider {
-      self.imageProvider = imageProvider
-    }
+  /// Sets the lottie file backing the animation view. Setting this will clear the
+  /// view's contents, completion blocks and current state. The new animation will
+  /// be loaded up and set to the beginning of its timeline.
+  /// The loopMode, animationSpeed and imageProvider will be set according
+  /// to lottie file settings
+  /// - Parameters:
+  ///   - animationIndex: Internal animation index to play. Optional
+  ///   Defaults to play first animation in file.
+  ///   - dotLottieFile: Lottie file to play
+  public func loadAnimation(
+    animationIndex: Int,
+    from dotLottieFile: DotLottieFile)
+  {
+    guard let dotLottieAnimation = dotLottieFile.animation(for: animationIndex) else { return }
+    loadAnimation(dotLottieAnimation, from: dotLottieFile)
+  }
 
-    animation = dotLottieAnimation.animation
+  /// Exclusive for DotLottie animations. This will be ignored if playing json animation.
+  /// Plays the next animation in the array.
+  /// If there are no next animations, will loop back to the first animation in the array.
+  /// If there is only one animation, will reset to the beginning of the current animation.
+  /// Setting this will clear the view's contents, completion blocks and current state.
+  /// The new animation will be loaded up and set to the beginning of its timeline.
+  /// The loopMode, animationSpeed and imageProvider will be set according
+  /// to lottie file settings
+  public func nextAnimation() {
+    guard
+      let activeDotLottieFile, let activeDotLottieAnimationID,
+      let dotLottieAnimation = activeDotLottieFile.nextAnimation(after: activeDotLottieAnimationID) else { return }
+    loadAnimation(dotLottieAnimation, from: activeDotLottieFile)
+  }
+
+  /// Exclusive for DotLottie animations. This will be ignored if playing json animation.
+  /// Plays the previous animation in the array.
+  /// If there are no previous animations, will loop back to the last animation in the array.
+  /// If there is only one animation, will reset to the beginning of the current animation.
+  /// Setting this will clear the view's contents, completion blocks and current state.
+  /// The new animation will be loaded up and set to the beginning of its timeline.
+  /// The loopMode, animationSpeed and imageProvider will be set according
+  /// to lottie file settings
+  public func previousAnimation() {
+    guard
+      let activeDotLottieFile, let activeDotLottieAnimationID,
+      let dotLottieAnimation = activeDotLottieFile.previousAnimation(before: activeDotLottieAnimationID) else { return }
+    loadAnimation(dotLottieAnimation, from: activeDotLottieFile)
   }
 
   /// Reloads the images supplied to the animation from the `imageProvider`
@@ -1103,6 +1142,30 @@ open class LottieAnimationView: LottieAnimationViewBase {
     addNewAnimationForContext(newContext)
   }
 
+  /// Loads view with given DotLottie animation. Setting this will clear the
+  /// view's contents, completion blocks and current state. The new animation will
+  /// be loaded up and set to the beginning of its timeline.
+  /// The loopMode, animationSpeed and imageProvider will be set according
+  /// to lottie file settings
+  /// - Parameter dotLottieAnimation: DotLottieFile.Animation to load the view
+  /// - Parameter dotLottieFile: Lottie file to play
+  func loadAnimation(_ dotLottieAnimation: DotLottieFile.Animation, from dotLottieFile: DotLottieFile) {
+    loopMode = dotLottieAnimation.configuration.loopMode
+    animationSpeed = CGFloat(dotLottieAnimation.configuration.speed)
+
+    if let imageProvider = dotLottieAnimation.configuration.imageProvider {
+      self.imageProvider = imageProvider
+    }
+
+    animation = dotLottieAnimation.animation
+    activeDotLottieFile = dotLottieFile
+    activeDotLottieAnimationID = dotLottieAnimation.configuration.id
+
+    if dotLottieAnimation.configuration.autoplay {
+      play()
+    }
+  }
+
   // MARK: Fileprivate
 
   /// Context describing the animation that is currently playing in this `LottieAnimationView`
@@ -1115,6 +1178,9 @@ open class LottieAnimationView: LottieAnimationViewBase {
 
   fileprivate var waitingToPlayAnimation = false
 
+  fileprivate var activeDotLottieFile: DotLottieFile?
+  fileprivate var activeDotLottieAnimationID: String?
+
   fileprivate var activeAnimationName: String {
     switch animationLayer?.primaryAnimationKey {
     case .specific(let animationKey):
@@ -1347,6 +1413,8 @@ open class LottieAnimationView: LottieAnimationViewBase {
     animationLayer?.removeAnimation(forKey: activeAnimationName)
     updateAnimationFrame(pauseFrame)
     animationContext = nil
+    activeDotLottieFile = nil
+    activeDotLottieAnimationID = nil
   }
 
   /// Adds animation to animation layer and sets the delegate. If animation layer or animation are nil, exits.

Sources/Public/DotLottie/DotLottieFile.swift

@@ -60,6 +60,42 @@ public final class DotLottieFile {
     }
   }
 
+  /// The `LottieAnimation` and `DotLottieConfiguration` for the given animation index in this file
+  func animation(for index: Int) -> DotLottieFile.Animation? {
+    guard index < animations.count else { return nil }
+    return animations[index]
+  }
+
+  /// Returns the next animation in the array. Returns the first animation in case it's the last index
+  /// The next `LottieAnimation` and `DotLottieConfiguration`
+  func nextAnimation(after animationId: String) -> DotLottieFile.Animation? {
+    guard let index = animations.firstIndex(where: { animationId == $0.configuration.id }) else {
+      return nil
+    }
+
+    let nextIndex = index + 1
+    if nextIndex < animations.count {
+      return animations[nextIndex]
+    }
+
+    return animations.first
+  }
+
+  /// Returns the previous animation in the array. Returns the first animation in case it's the last index
+  /// The next `LottieAnimation` and `DotLottieConfiguration`
+  func previousAnimation(before animationId: String) -> DotLottieFile.Animation? {
+    guard let index = animations.firstIndex(where: { animationId == $0.configuration.id }) else {
+      return nil
+    }
+
+    let previousIndex = index - 1
+    if previousIndex > 0 {
+      return animations[previousIndex]
+    }
+
+    return animations.last
+  }
+
   // MARK: Private
 
   private static let manifestFileName = "manifest.json"
@@ -104,7 +140,8 @@ public final class DotLottieFile {
         id: dotLottieAnimation.id,
         imageProvider: imageProvider,
         loopMode: dotLottieAnimation.loopMode,
-        speed: dotLottieAnimation.animationSpeed)
+        speed: dotLottieAnimation.animationSpeed,
+        autoplay: dotLottieAnimation.autoplay ?? false)
 
       return DotLottieFile.Animation(
         animation: animation,

Tests/__Snapshots__/AutomaticEngineTests/testAutomaticEngineDetection.DotLottie-multiple_animations.txt

@@ -0,0 +1 @@
+Supports Core Animation engine