[LottieGen] Added new AnimationController API support for LottieGen (#488)

Author: aborziak-ms

Lottie-Windows/Lottie-Windows-Uwp/Lottie-Windows-Uwp.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <TargetFramework>uap10.0.16299</TargetFramework>
     <OutputType>winmdobj</OutputType>
-    
+
 
     <PackageId>CommunityToolkit.Uwp.Lottie</PackageId>
     <PackageTags>UWP Toolkit Windows Animations Lottie XAML</PackageTags>

build/Install-WindowsSdkISO.ps1

@@ -242,6 +242,11 @@ if ($InstallWindowsSDK)
     # Note: there is a delay from Windows SDK announcements to availability via the static link
     $uri = "https://go.microsoft.com/fwlink/?prd=11966&pver=1.0&plcid=0x409&clcid=0x409&ar=Flight&sar=Sdsurl&o1=$buildNumber"
 
+    if ($buildNumber -eq "22621")
+    {
+        $uri = "https://go.microsoft.com/fwlink/p/?linkid=2196240"
+    }
+
     if ($env:TEMP -eq $null)
     {
         $env:TEMP = Join-Path $env:SystemDrive 'temp'

source/Lottie/AnimatedVisualFactory.cs

@@ -33,6 +33,7 @@ sealed class AnimatedVisualFactory
         Loader? _loader;
         WinCompData.Visual? _wincompDataRootVisual;
         WinCompData.CompositionPropertySet? _wincompDataThemingPropertySet;
+        IEnumerable<WinCompData.AnimationController>? _wincompDataAnimationControllers;
         CompositionPropertySet? _themingPropertySet;
         double _width;
         double _height;
@@ -62,6 +63,7 @@ internal void SetRootVisual(WinCompData.Visual rootVisual)
                                                 CompositionObjectNodes.
                                                 Where(n => n.Object is WinCompData.CompositionPropertySet cps && cps.Owner is null).
                                                 Select(n => (WinCompData.CompositionPropertySet)n.Object).FirstOrDefault();
+            _wincompDataAnimationControllers = graph.CompositionObjectNodes.Where(n => (n.Object is WinCompData.AnimationController) && ((WinCompData.AnimationController)n.Object).IsCustom).Select(n => (WinCompData.AnimationController)n.Object);
         }
 
         internal bool CanInstantiate => _wincompDataRootVisual is not null;
@@ -84,7 +86,10 @@ internal void SetRootVisual(WinCompData.Visual rootVisual)
                 var instantiator = new Instantiator(compositor, surfaceResolver: LoadImageFromUri);
 
                 // _wincompDataRootVisual is not null is implied by CanInstantiate.
-                var result = new DisposableAnimatedVisual((Visual)instantiator.GetInstance(_wincompDataRootVisual!))
+                Visual rootVisual = (Visual)instantiator.GetInstance(_wincompDataRootVisual!);
+                IEnumerable<AnimationController> animationControllers = _wincompDataAnimationControllers!.Select(o => (AnimationController)instantiator.GetInstance(o));
+
+                var result = new DisposableAnimatedVisual(rootVisual, animationControllers)
                 {
                     Size = new System.Numerics.Vector2((float)_width, (float)_height),
                     Duration = _duration,

source/Lottie/DisposableAnimatedVisual.cs

@@ -5,6 +5,7 @@
 #nullable enable
 
 using System;
+using System.Collections.Generic;
 using System.Numerics;
 using Microsoft.UI.Xaml.Controls;
 
@@ -18,13 +19,20 @@ namespace CommunityToolkit.WinUI.Lottie
 {
     sealed class DisposableAnimatedVisual : IAnimatedVisual, IDisposable
     {
-        internal DisposableAnimatedVisual(Visual rootVisual)
+        internal DisposableAnimatedVisual(Visual rootVisual, IEnumerable<AnimationController> customAnimationControllers)
         {
             RootVisual = rootVisual;
+            CustomAnimationControllers = customAnimationControllers;
         }
 
         public Visual RootVisual { get; }
 
+        /// <summary>
+        /// Keeps references to all custom AnimationController objects.
+        /// We need references because otherwise they will be destroyed from dwm.
+        /// </summary>
+        public IEnumerable<AnimationController> CustomAnimationControllers { get; }
+
         public TimeSpan Duration { get; set; }
 
         public Vector2 Size { get; set; }

source/Lottie/Instantiator.cs

@@ -402,16 +402,27 @@ void StartAnimations(Wd.CompositionObject source, Wc.CompositionObject target)
             foreach (var animator in source.Animators)
             {
                 var animation = GetCompositionAnimation(animator.Animation);
-                target.StartAnimation(animator.AnimatedProperty, animation);
-                var controller = animator.Controller;
-                if (controller is not null)
+                if (animator.Controller is null || !animator.Controller.IsCustom)
                 {
-                    var animationController = GetAnimationController(controller);
-                    if (controller.IsPaused)
+                    target.StartAnimation(animator.AnimatedProperty, animation);
+                    var controller = animator.Controller;
+                    if (controller is not null)
                     {
-                        animationController.Pause();
+                        var animationController = GetAnimationController(controller);
+                        if (controller.IsPaused)
+                        {
+                            animationController.Pause();
+                        }
                     }
                 }
+                else
+                {
+                    throw new InvalidOperationException("LottieViewer and Instantiator does not support custom AnimationControllers yet");
+                    /*
+                    We should retarget to SDK 22621 to support this
+                    target.StartAnimation(animator.AnimatedProperty, animation, GetAnimationController(animator.Controller));
+                    */
+                }
             }
         }
 
@@ -422,9 +433,25 @@ Wc.AnimationController GetAnimationController(Wd.AnimationController obj)
                 return result;
             }
 
-            var targetObject = GetCompositionObject(obj.TargetObject);
+            if (obj.IsCustom)
+            {
+                throw new InvalidOperationException("LottieViewer and Instantiator does not support custom AnimationControllers yet");
+                /*
+                We should retarget to SDK 22621 to support this
+                result = CacheAndInitializeCompositionObject(obj, _c.CreateAnimationController());
+
+                if (obj.IsPaused)
+                {
+                    result.Pause();
+                }
+                */
+            }
+            else
+            {
+                var targetObject = GetCompositionObject(obj.TargetObject!);
+                result = CacheAndInitializeCompositionObject(obj, targetObject.TryGetAnimationController(obj.TargetProperty));
+            }
 
-            result = CacheAndInitializeCompositionObject(obj, targetObject.TryGetAnimationController(obj.TargetProperty));
             StartAnimations(obj, result);
             return result;
         }

source/Lottie/Loader.cs

@@ -219,17 +219,20 @@ static uint GetCurrentUapVersion()
         {
             // Start testing on version 2. We know that at least version 1 is supported because
             // we are running in UAP code.
-            var versionToTest = 2u;
+            var versionToTest = 1u;
 
             // Keep querying until IsApiContractPresent fails to find the version.
-            while (ApiInformation.IsApiContractPresent("Windows.Foundation.UniversalApiContract", (ushort)versionToTest))
+            while (ApiInformation.IsApiContractPresent("Windows.Foundation.UniversalApiContract", (ushort)(versionToTest + 1)))
             {
                 // Keep looking ...
                 versionToTest++;
             }
 
+            // TODO: we do not support UAP above 14 in Lottie-Windows yet, only in LottieGen.
+            versionToTest = Math.Min(versionToTest, 14);
+
             // Query failed on versionToTest. Return the previous version.
-            return versionToTest - 1;
+            return versionToTest;
         }
 
         // Specializes the Stopwatch to do just the one thing we need of it - get the time

source/Lottie/LottieVisualSource.cs

@@ -6,6 +6,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Runtime.InteropServices.WindowsRuntime;
 using System.Threading.Tasks;
 using CommunityToolkit.WinUI.Lottie;

source/LottieToWinComp/Animate.cs

@@ -43,6 +43,13 @@ public static void WithKeyFrame(
             Debug.Assert(scale <= 1, "Precondition");
             Debug.Assert(animation.KeyFrameCount > 0, "Precondition");
 
+            if (scale == 1.0 && offset == 0.0 && context.ObjectFactory.IsUapApiAvailable(nameof(AnimationController)) && context.RootProgressController is not null)
+            {
+                // Special case when we can use root AnimationController (no time stretch, no time offset)
+                compObject.StartAnimation(target, animation, context.RootProgressController!);
+                return;
+            }
+
             var state = context.GetStateCache<StateCache>();
 
             // Start the animation ...

source/LottieToWinComp/CompositionObjectFactory.cs

@@ -86,6 +86,12 @@ internal uint GetUapVersionForApi(string apiName)
                 case nameof(PathKeyFrameAnimation):
                     return 11;
 
+                // AnimationController class was introduced in version 6, but
+                // it became possible to create it explicitly only after verstion 15
+                // with compositor.CreateAnimationController() method
+                case nameof(AnimationController):
+                    return 15;
+
                 default:
                     throw new InvalidOperationException();
             }
@@ -304,5 +310,11 @@ void ConsumeVersionFeature(uint uapVersion)
 
             HighestUapVersionUsed = Math.Max(HighestUapVersionUsed, uapVersion);
         }
+
+        internal AnimationController CreateAnimationControllerList()
+        {
+            ConsumeVersionFeature(GetUapVersionForApi(nameof(AnimationController)));
+            return _compositor.CreateAnimationController();
+        }
     }
 }

source/LottieToWinComp/TranslationContext.cs

@@ -150,6 +150,11 @@ internal static TranslationResult TryTranslateLottieComposition(
         /// </summary>
         public ContainerVisual? RootVisual { get; private set; }
 
+        /// <summary>
+        /// AnimationController that has Progress property bound to RootVisual.Progress property.
+        /// </summary>
+        public AnimationController? RootProgressController { get; private set; }
+
         /// <summary>
         /// True iff theme property bindings are enabled.
         /// </summary>
@@ -223,6 +228,16 @@ void Translate()
             // Add the master progress property to the visual.
             RootVisual.Properties.InsertScalar(ProgressPropertyName, 0);
 
+            // AnimationController that has Progress value bound to RootVisual.Progress
+            if (ObjectFactory.IsUapApiAvailable(nameof(AnimationController)))
+            {
+                RootProgressController = ObjectFactory.CreateAnimationControllerList();
+                var rootProgressAnimation = context.ObjectFactory.CreateExpressionAnimation(ExpressionFactory.RootProgress);
+                rootProgressAnimation.SetReferenceParameter(ExpressionFactory.RootName, RootVisual);
+                RootProgressController.Pause();
+                RootProgressController.StartAnimation("Progress", rootProgressAnimation);
+            }
+
             // Add the translations of each layer to the root visual. This will recursively
             // add the tranlation of the layers in precomps.
             var contentsChildren = RootVisual.Children;