[LottieGen] Refactored effects, added cache for factories (#507)

Author: aborziak-ms

source/Lottie/Instantiator.cs

@@ -1066,15 +1066,34 @@ Wc.CompositionEffectBrush GetCompositionEffectBrush(Wd.CompositionEffectBrush ob
                 return result;
             }
 
-            IEnumerable<Wd.CompositionEffectSourceParameter> sources;
+            // Create and initialize the effect brush.
+            var effectBrush = GetCompositionEffectFactory(obj.GetEffectFactory()).CreateBrush();
+            result = CacheAndInitializeCompositionObject(obj, effectBrush);
+
+            // Set the sources.
+            foreach (var source in obj.GetEffectFactory().Effect.Sources)
+            {
+                result.SetSourceParameter(source.Name, GetCompositionBrush(obj.GetSourceParameter(source.Name)));
+            }
+
+            StartAnimations(obj, result);
+            return result;
+        }
+
+        Wc.CompositionEffectFactory GetCompositionEffectFactory(Wd.CompositionEffectFactory obj)
+        {
+            if (GetExisting<Wc.CompositionEffectFactory>(obj, out var result))
+            {
+                return result;
+            }
+
             IGraphicsEffect graphicsEffect;
 
-            var wdEffect = obj.GetEffect();
-            switch (wdEffect.Type)
+            switch (obj.Effect.Type)
             {
                 case Wd.Mgce.GraphicsEffectType.CompositeEffect:
                     {
-                        var effect = (Wd.Mgce.CompositeEffect)wdEffect;
+                        var effect = (Wd.Mgce.CompositeEffect)obj.Effect;
 
                         // Create the effect.
                         var resultEffect = new Mgce.CompositeEffect
@@ -1088,51 +1107,33 @@ Wc.CompositionEffectBrush GetCompositionEffectBrush(Wd.CompositionEffectBrush ob
                         }
 
                         graphicsEffect = resultEffect;
-                        sources = effect.Sources;
                     }
 
                     break;
                 case Wd.Mgce.GraphicsEffectType.GaussianBlurEffect:
                     {
-                        var effect = (Wd.Mgce.GaussianBlurEffect)wdEffect;
+                        var effect = (Wd.Mgce.GaussianBlurEffect)obj.Effect;
 
                         // Create the effect.
                         var resultEffect = new Mgce.GaussianBlurEffect();
 
-                        if (effect.BlurAmount.HasValue)
-                        {
-                            resultEffect.BlurAmount = effect.BlurAmount.Value;
-                        }
+                        resultEffect.BlurAmount = effect.BlurAmount;
+
+                        resultEffect.Source = new Wc.CompositionEffectSourceParameter(effect.Sources.First().Name);
 
                         graphicsEffect = resultEffect;
-                        if (effect.Source is null)
-                        {
-                            sources = Array.Empty<Wd.CompositionEffectSourceParameter>();
-                        }
-                        else
-                        {
-                            resultEffect.Source = new Wc.CompositionEffectSourceParameter(effect.Source.Name);
-                            sources = new[] { effect.Source };
-                        }
                     }
 
                     break;
                 default:
                     throw new InvalidOperationException();
             }
 
-            // Create and initialize the effect brush.
-            var effectBrush = _c.CreateEffectFactory(graphicsEffect).CreateBrush();
-            result = CacheAndInitializeCompositionObject(obj, effectBrush);
+            var factory = _c.CreateEffectFactory(graphicsEffect);
 
-            // Set the sources.
-            foreach (var source in sources)
-            {
-                result.SetSourceParameter(source.Name, GetCompositionBrush(obj.GetSourceParameter(source.Name)));
-            }
+            Cache(obj, factory);
 
-            StartAnimations(obj, result);
-            return result;
+            return factory;
         }
 
         Wc.CompositionSpriteShape GetCompositionSpriteShape(Wd.CompositionSpriteShape obj)

source/LottieToWinComp/CompositionObjectFactory.cs

@@ -288,7 +288,8 @@ internal CompositionVisualSurface CreateVisualSurface()
 
         internal CompositionSurfaceBrush CreateSurfaceBrush(ICompositionSurface surface) => _compositor.CreateSurfaceBrush(surface);
 
-        internal CompositionEffectFactory CreateEffectFactory(GraphicsEffectBase effect) => _compositor.CreateEffectFactory(effect);
+        // Get cached factory instead of creating from compositor.
+        internal CompositionEffectFactory CreateEffectFactory(GraphicsEffectBase effect) => CompositionEffectFactory.GetFactoryCached(effect);
 
         // Call this when consuming a feature that is only available in UAP versions > 7.
         void ConsumeVersionFeature(uint uapVersion)

source/LottieToWinComp/Effects.cs

@@ -115,6 +115,8 @@ public static Visual ApplyDropShadow(
                 return source;
             }
 
+            source.BorderMode = CompositionBorderMode.Soft;
+
             Debug.Assert(dropShadowEffect.IsEnabled, "Precondition");
             Debug.Assert(context is PreCompLayerContext || context is ShapeLayerContext, "Precondition");
 
@@ -403,15 +405,13 @@ public static Visual ApplyGaussianBlur(
 
             var surfaceBrush = factory.CreateSurfaceBrush(visualSurface);
 
-            var effect = new WinCompData.Mgce.GaussianBlurEffect();
-
             var blurriness = Optimizer.TrimAnimatable(context, gaussianBlurEffect.Blurriness);
             if (blurriness.IsAnimated)
             {
                 context.Issues.AnimatedLayerEffectParameters("Gaussian blur");
             }
 
-            effect.BlurAmount = ConvertTo.Float(blurriness.InitialValue / 10.0);
+            var effect = new WinCompData.Mgce.GaussianBlurEffect(ConvertTo.Float(blurriness.InitialValue / 3.33), new CompositionEffectSourceParameter("source"));
 
             // We only support HorizontalAndVertical blur dimension.
             var blurDimensions = Optimizer.TrimAnimatable(context, gaussianBlurEffect.BlurDimensions);
@@ -426,8 +426,6 @@ public static Visual ApplyGaussianBlur(
                 context.Issues.UnsupportedLayerEffectParameter("gaussian blur", "blur dimension", value.Value.ToString());
             }
 
-            effect.Source = new CompositionEffectSourceParameter("source");
-
             var effectBrush = factory.CreateEffectFactory(effect).CreateBrush();
             effectBrush.SetSourceParameter("source", surfaceBrush);
 

source/LottieToWinComp/Masks.cs

@@ -434,11 +434,7 @@ static SpriteVisual CompositeVisuals(
             destinationVisualSurface.SourceOffset = ConvertTo.Vector2(offset);
             var destinationVisualSurfaceBrush = objectFactory.CreateSurfaceBrush(destinationVisualSurface);
 
-            var compositeEffect = new CompositeEffect();
-            compositeEffect.Mode = compositeMode;
-
-            compositeEffect.Sources.Add(new CompositionEffectSourceParameter("destination"));
-            compositeEffect.Sources.Add(new CompositionEffectSourceParameter("source"));
+            var compositeEffect = new CompositeEffect(compositeMode, new List<CompositionEffectSourceParameter>(new CompositionEffectSourceParameter[] { new CompositionEffectSourceParameter("destination"), new CompositionEffectSourceParameter("source") }));
 
             var compositionEffectFactory = objectFactory.CreateEffectFactory(compositeEffect);
             var effectBrush = compositionEffectFactory.CreateBrush();

source/UIData/Tools/ObjectGraph.cs

@@ -217,6 +217,9 @@ sealed class ObjectGraph<T> : Graph
                 case CompositionObjectType.Vector4KeyFrameAnimation:
                     VisitVector4KeyFrameAnimation((Vector4KeyFrameAnimation)obj, node);
                     break;
+                case CompositionObjectType.CompositionEffectFactory:
+                    VisitCompositionEffectFactory((CompositionEffectFactory)obj, node);
+                    break;
                 default:
                     throw new InvalidOperationException();
             }
@@ -664,33 +667,22 @@ bool VisitCompositionContainerShape(CompositionContainerShape obj, T node)
             return true;
         }
 
+        bool VisitCompositionEffectFactory(CompositionEffectFactory obj, T node)
+        {
+            return VisitCompositionObject(obj, node);
+        }
+
         bool VisitCompositionEffectBrush(CompositionEffectBrush obj, T node)
         {
             VisitCompositionBrush(obj, node);
 
-            var effect = obj.GetEffect();
-
-            switch (effect.Type)
-            {
-                case GraphicsEffectType.CompositeEffect:
-                    foreach (var source in ((CompositeEffect)effect).Sources)
-                    {
-                        Reference(node, obj.GetSourceParameter(source.Name));
-                    }
+            var effectFactory = obj.GetEffectFactory();
 
-                    break;
-                case GraphicsEffectType.GaussianBlurEffect:
-                    {
-                        var source = ((GaussianBlurEffect)effect).Source;
-                        if (source is not null)
-                        {
-                            Reference(node, obj.GetSourceParameter(source.Name));
-                        }
-                    }
+            Reference(node, effectFactory);
 
-                    break;
-                default:
-                    throw new InvalidOperationException();
+            foreach (var source in effectFactory.Effect.Sources)
+            {
+                Reference(node, obj.GetSourceParameter(source.Name));
             }
 
             return true;

source/UIData/Tools/Optimizer.cs

@@ -512,6 +512,7 @@ CompositionObject GetCompositionObject(CompositionObject obj) =>
                 CompositionObjectType.Vector2KeyFrameAnimation => GetVector2KeyFrameAnimation((Vector2KeyFrameAnimation)obj),
                 CompositionObjectType.Vector3KeyFrameAnimation => GetVector3KeyFrameAnimation((Vector3KeyFrameAnimation)obj),
                 CompositionObjectType.Vector4KeyFrameAnimation => GetVector4KeyFrameAnimation((Vector4KeyFrameAnimation)obj),
+                CompositionObjectType.CompositionEffectFactory => GetCompositionEffectFactory((CompositionEffectFactory)obj),
                 _ => throw new InvalidOperationException(),
             };
 
@@ -984,63 +985,32 @@ LoadedImageSurface GetLoadedImageSurface(LoadedImageSurface obj)
             return result;
         }
 
-        CompositionEffectBrush GetCompositionEffectBrush(CompositionEffectBrush obj)
+        CompositionEffectFactory GetCompositionEffectFactory(CompositionEffectFactory obj)
         {
             if (GetExisting(obj, out var result))
             {
                 return result;
             }
 
-            IEnumerable<CompositionEffectSourceParameter> sources;
-            GraphicsEffectBase newEffect;
-
-            var effectBase = obj.GetEffect();
-            switch (effectBase.Type)
-            {
-                case GraphicsEffectType.CompositeEffect:
-                    {
-                        var effect = (CompositeEffect)effectBase;
-
-                        var newCompositeEffect = new CompositeEffect
-                        {
-                            Mode = effect.Mode,
-                        };
-
-                        foreach (var source in effect.Sources)
-                        {
-                            newCompositeEffect.Sources.Add(source);
-                        }
-
-                        newEffect = newCompositeEffect;
-                        sources = effect.Sources;
-                    }
-
-                    break;
-                case GraphicsEffectType.GaussianBlurEffect:
-                    {
-                        var effect = (GaussianBlurEffect)effectBase;
-
-                        newEffect = new GaussianBlurEffect
-                        {
-                            BlurAmount = effect.BlurAmount,
-                            Source = effect.Source,
-                        };
+            result = CacheAndInitializeCompositionObject(obj, _c.CreateEffectFactory(obj.Effect));
 
-                        sources = effect.Source is null
-                                        ? Array.Empty<CompositionEffectSourceParameter>()
-                                        : new[] { effect.Source };
-                    }
+            return result;
+        }
 
-                    break;
-                default:
-                    throw new InvalidOperationException();
+        CompositionEffectBrush GetCompositionEffectBrush(CompositionEffectBrush obj)
+        {
+            if (GetExisting(obj, out var result))
+            {
+                return result;
             }
 
-            var effectBrush = _c.CreateEffectFactory(newEffect).CreateBrush();
+            var effectFactory = GetCompositionEffectFactory(obj.GetEffectFactory());
+            var effectBrush = effectFactory.CreateBrush();
+
             result = CacheAndInitializeCompositionObject(obj, effectBrush);
 
             // Set the sources.
-            foreach (var source in sources)
+            foreach (var source in effectFactory.Effect.Sources)
             {
                 result.SetSourceParameter(source.Name, GetCompositionBrush(obj.GetSourceParameter(source.Name)));
             }

source/UIData/Tools/Stats.cs

@@ -151,6 +151,9 @@ public Stats(CompositionObject? root)
                     case CompositionObjectType.Vector4KeyFrameAnimation:
                         Vector4KeyFrameAnimationCount++;
                         break;
+                    case CompositionObjectType.CompositionEffectFactory:
+                        EffectFactoryCount++;
+                        break;
                     default:
                         throw new InvalidOperationException();
                 }
@@ -181,6 +184,8 @@ public Stats(CompositionObject? root)
 
         public int EffectBrushCount { get; }
 
+        public int EffectFactoryCount { get; }
+
         public int EllipseGeometryCount { get; }
 
         public int GeometricClipCount { get; }

source/UIDataCodeGen/CodeGen/CSharp/CSharpInstantiatorGenerator.cs

@@ -956,15 +956,9 @@ protected override string WriteGaussianBlurEffectFactory(CodeBuilder builder, Ga
             var effectVariable = "gaussianBlurEffect";
             builder.WriteLine($"var {effectVariable} = new GaussianBlurEffect();");
 
-            if (effect.BlurAmount.HasValue)
-            {
-                builder.WriteLine($"{effectVariable}.BlurAmount = {_s.Float(effect.BlurAmount.Value)};");
-            }
+            builder.WriteLine($"{effectVariable}.BlurAmount = {_s.Float(effect.BlurAmount)};");
 
-            if (effect.Source is not null)
-            {
-                builder.WriteLine($"{effectVariable}.Source = new CompositionEffectSourceParameter({_s.String(effect.Source.Name)});");
-            }
+            builder.WriteLine($"{effectVariable}.Source = new CompositionEffectSourceParameter({_s.String(effect.Sources.First().Name)});");
 
             return effectVariable;
         }

source/UIDataCodeGen/CodeGen/Cppwinrt/CppwinrtInstantiatorGenerator.cs

@@ -778,15 +778,9 @@ protected override string WriteGaussianBlurEffectFactory(CodeBuilder builder, Ga
         {
             var effectVariable = "gaussianBlurEffect";
             builder.WriteLine($"auto {effectVariable} = winrt::make_self<GaussianBlurEffect>();");
-            if (effect.BlurAmount.HasValue)
-            {
-                builder.WriteLine($"{effectVariable}->BlurAmount({_s.Float(effect.BlurAmount.Value)});");
-            }
+            builder.WriteLine($"{effectVariable}->BlurAmount({_s.Float(effect.BlurAmount)});");
 
-            if (effect.Source is not null)
-            {
-                builder.WriteLine($"{effectVariable}->Source(CompositionEffectSourceParameter(L\"{effect.Source.Name}\"));");
-            }
+            builder.WriteLine($"{effectVariable}->Source(CompositionEffectSourceParameter(L\"{effect.Sources.First().Name}\"));");
 
             return $"*{effectVariable}";
         }

source/UIDataCodeGen/CodeGen/Cx/CxInstantiatorGenerator.cs

@@ -646,16 +646,10 @@ protected override string WriteGaussianBlurEffectFactory(CodeBuilder builder, Ga
         {
             var effectVariable = "gaussianBlurEffect";
             builder.WriteLine($"ComPtr<GaussianBlurEffect> {effectVariable}(new GaussianBlurEffect());");
-            if (effect.BlurAmount.HasValue)
-            {
-                builder.WriteLine($"{effectVariable}->put_BlurAmount({_s.Float(effect.BlurAmount.Value)});");
-            }
+            builder.WriteLine($"{effectVariable}->put_BlurAmount({_s.Float(effect.BlurAmount)});");
 
-            if (effect.Source is not null)
-            {
-                builder.WriteLine($"auto sourceParameter = ref new CompositionEffectSourceParameter({_s.String(effect.Source.Name)});");
-                builder.WriteLine($"{effectVariable}->put_Source(reinterpret_cast<ABI::Windows::Graphics::Effects::IGraphicsEffectSource*>(sourceParameter));");
-            }
+            builder.WriteLine($"auto sourceParameter = ref new CompositionEffectSourceParameter({_s.String(effect.Sources.First().Name)});");
+            builder.WriteLine($"{effectVariable}->put_Source(reinterpret_cast<ABI::Windows::Graphics::Effects::IGraphicsEffectSource*>(sourceParameter));");
 
             return $"reinterpret_cast<Windows::Graphics::Effects::IGraphicsEffect^>({effectVariable}.Get())";
         }