Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2019 Google Inc. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license that can be |
| 5 | * found in the LICENSE file. |
| 6 | */ |
| 7 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 8 | #include "modules/skottie/src/Layer.h" |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 9 | |
Florin Malita | a3936c8 | 2020-01-06 12:17:27 -0500 | [diff] [blame] | 10 | #include "modules/skottie/src/Camera.h" |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 11 | #include "modules/skottie/src/Composition.h" |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 12 | #include "modules/skottie/src/SkottieJson.h" |
| 13 | #include "modules/skottie/src/effects/Effects.h" |
Florin Malita | 5f1108c | 2019-07-03 10:09:31 -0400 | [diff] [blame] | 14 | #include "modules/skottie/src/effects/MotionBlurEffect.h" |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 15 | #include "modules/sksg/include/SkSGClipEffect.h" |
| 16 | #include "modules/sksg/include/SkSGDraw.h" |
| 17 | #include "modules/sksg/include/SkSGGroup.h" |
| 18 | #include "modules/sksg/include/SkSGMaskEffect.h" |
| 19 | #include "modules/sksg/include/SkSGMerge.h" |
| 20 | #include "modules/sksg/include/SkSGPaint.h" |
| 21 | #include "modules/sksg/include/SkSGPath.h" |
| 22 | #include "modules/sksg/include/SkSGRect.h" |
| 23 | #include "modules/sksg/include/SkSGRenderEffect.h" |
| 24 | #include "modules/sksg/include/SkSGRenderNode.h" |
| 25 | #include "modules/sksg/include/SkSGTransform.h" |
| 26 | |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 27 | namespace skottie { |
| 28 | namespace internal { |
| 29 | |
| 30 | namespace { |
| 31 | |
Florin Malita | 8b70f4d | 2020-04-23 18:58:21 -0400 | [diff] [blame] | 32 | static constexpr size_t kNullLayerType = 3; |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 33 | |
| 34 | struct MaskInfo { |
| 35 | SkBlendMode fBlendMode; // used when masking with layers/blending |
| 36 | sksg::Merge::Mode fMergeMode; // used when clipping |
| 37 | bool fInvertGeometry; |
| 38 | }; |
| 39 | |
| 40 | const MaskInfo* GetMaskInfo(char mode) { |
| 41 | static constexpr MaskInfo k_add_info = |
| 42 | { SkBlendMode::kSrcOver , sksg::Merge::Mode::kUnion , false }; |
| 43 | static constexpr MaskInfo k_int_info = |
| 44 | { SkBlendMode::kSrcIn , sksg::Merge::Mode::kIntersect , false }; |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 45 | static constexpr MaskInfo k_sub_info = |
Florin Malita | a524ea2 | 2020-07-20 10:51:07 -0400 | [diff] [blame^] | 46 | { SkBlendMode::kDstOut , sksg::Merge::Mode::kDifference, true }; |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 47 | static constexpr MaskInfo k_dif_info = |
Florin Malita | cd11a51 | 2020-07-15 17:04:46 -0400 | [diff] [blame] | 48 | { SkBlendMode::kXor , sksg::Merge::Mode::kXOR , false }; |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 49 | |
| 50 | switch (mode) { |
| 51 | case 'a': return &k_add_info; |
| 52 | case 'f': return &k_dif_info; |
| 53 | case 'i': return &k_int_info; |
| 54 | case 's': return &k_sub_info; |
| 55 | default: break; |
| 56 | } |
| 57 | |
| 58 | return nullptr; |
| 59 | } |
| 60 | |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 61 | class MaskAdapter final : public AnimatablePropertyContainer { |
| 62 | public: |
| 63 | MaskAdapter(const skjson::ObjectValue& jmask, const AnimationBuilder& abuilder, SkBlendMode bm) |
Florin Malita | a524ea2 | 2020-07-20 10:51:07 -0400 | [diff] [blame^] | 64 | : fMaskPaint(sksg::Color::Make(SK_ColorBLACK)) |
| 65 | , fBlendMode(bm) { |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 66 | fMaskPaint->setAntiAlias(true); |
Florin Malita | a524ea2 | 2020-07-20 10:51:07 -0400 | [diff] [blame^] | 67 | if (!this->requires_isolation()) { |
| 68 | // We can mask at draw time. |
| 69 | fMaskPaint->setBlendMode(bm); |
| 70 | } |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 71 | |
| 72 | this->bind(abuilder, jmask["o"], fOpacity); |
| 73 | |
| 74 | if (this->bind(abuilder, jmask["f"], fFeather)) { |
| 75 | fMaskFilter = sksg::BlurImageFilter::Make(); |
| 76 | } |
| 77 | } |
| 78 | |
| 79 | bool hasEffect() const { |
| 80 | return !this->isStatic() |
| 81 | || fOpacity < 100 |
Florin Malita | 6509bc7 | 2020-03-12 11:11:26 -0400 | [diff] [blame] | 82 | || fFeather != SkV2{0,0}; |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 83 | } |
| 84 | |
| 85 | sk_sp<sksg::RenderNode> makeMask(sk_sp<sksg::Path> mask_path) const { |
Florin Malita | a524ea2 | 2020-07-20 10:51:07 -0400 | [diff] [blame^] | 86 | sk_sp<sksg::RenderNode> mask = sksg::Draw::Make(std::move(mask_path), fMaskPaint); |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 87 | |
| 88 | // Optional mask blur (feather). |
Florin Malita | a524ea2 | 2020-07-20 10:51:07 -0400 | [diff] [blame^] | 89 | mask = sksg::ImageFilterEffect::Make(std::move(mask), fMaskFilter); |
| 90 | |
| 91 | if (this->requires_isolation()) { |
| 92 | mask = sksg::LayerEffect::Make(std::move(mask), fBlendMode); |
| 93 | } |
| 94 | |
| 95 | return mask; |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 96 | } |
| 97 | |
| 98 | private: |
| 99 | void onSync() override { |
| 100 | fMaskPaint->setOpacity(fOpacity * 0.01f); |
| 101 | if (fMaskFilter) { |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 102 | // Close enough to AE. |
| 103 | static constexpr SkScalar kFeatherToSigma = 0.38f; |
Florin Malita | 6509bc7 | 2020-03-12 11:11:26 -0400 | [diff] [blame] | 104 | fMaskFilter->setSigma({fFeather.x * kFeatherToSigma, |
| 105 | fFeather.y * kFeatherToSigma}); |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 106 | } |
| 107 | } |
| 108 | |
Florin Malita | a524ea2 | 2020-07-20 10:51:07 -0400 | [diff] [blame^] | 109 | bool requires_isolation() const { |
| 110 | SkASSERT(fBlendMode == SkBlendMode::kSrc || |
| 111 | fBlendMode == SkBlendMode::kSrcOver || |
| 112 | fBlendMode == SkBlendMode::kSrcIn || |
| 113 | fBlendMode == SkBlendMode::kDstOut || |
| 114 | fBlendMode == SkBlendMode::kXor); |
| 115 | |
| 116 | // Some mask modes touch pixels outside the immediate draw geometry. |
| 117 | // These require a layer. |
| 118 | switch (fBlendMode) { |
| 119 | case (SkBlendMode::kSrcIn): return true; |
| 120 | default: return false; |
| 121 | } |
| 122 | SkUNREACHABLE; |
| 123 | } |
| 124 | |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 125 | const sk_sp<sksg::PaintNode> fMaskPaint; |
Florin Malita | a524ea2 | 2020-07-20 10:51:07 -0400 | [diff] [blame^] | 126 | const SkBlendMode fBlendMode; |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 127 | sk_sp<sksg::BlurImageFilter> fMaskFilter; // optional "feather" |
| 128 | |
Florin Malita | 6509bc7 | 2020-03-12 11:11:26 -0400 | [diff] [blame] | 129 | Vec2Value fFeather = {0,0}; |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 130 | ScalarValue fOpacity = 100; |
| 131 | }; |
| 132 | |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 133 | sk_sp<sksg::RenderNode> AttachMask(const skjson::ArrayValue* jmask, |
| 134 | const AnimationBuilder* abuilder, |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 135 | sk_sp<sksg::RenderNode> childNode) { |
| 136 | if (!jmask) return childNode; |
| 137 | |
| 138 | struct MaskRecord { |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 139 | sk_sp<sksg::Path> mask_path; // for clipping and masking |
| 140 | sk_sp<MaskAdapter> mask_adapter; // for masking |
| 141 | sksg::Merge::Mode merge_mode; // for clipping |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 142 | }; |
| 143 | |
| 144 | SkSTArray<4, MaskRecord, true> mask_stack; |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 145 | bool has_effect = false; |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 146 | |
| 147 | for (const skjson::ObjectValue* m : *jmask) { |
| 148 | if (!m) continue; |
| 149 | |
| 150 | const skjson::StringValue* jmode = (*m)["mode"]; |
| 151 | if (!jmode || jmode->size() != 1) { |
| 152 | abuilder->log(Logger::Level::kError, &(*m)["mode"], "Invalid mask mode."); |
| 153 | continue; |
| 154 | } |
| 155 | |
| 156 | const auto mode = *jmode->begin(); |
| 157 | if (mode == 'n') { |
| 158 | // "None" masks have no effect. |
| 159 | continue; |
| 160 | } |
| 161 | |
| 162 | const auto* mask_info = GetMaskInfo(mode); |
| 163 | if (!mask_info) { |
| 164 | abuilder->log(Logger::Level::kWarning, nullptr, "Unsupported mask mode: '%c'.", mode); |
| 165 | continue; |
| 166 | } |
| 167 | |
Florin Malita | fd91f6d | 2019-07-25 11:41:07 -0400 | [diff] [blame] | 168 | auto mask_path = abuilder->attachPath((*m)["pt"]); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 169 | if (!mask_path) { |
| 170 | abuilder->log(Logger::Level::kError, m, "Could not parse mask path."); |
| 171 | continue; |
| 172 | } |
| 173 | |
Florin Malita | a524ea2 | 2020-07-20 10:51:07 -0400 | [diff] [blame^] | 174 | auto mask_blend_mode = mask_info->fBlendMode; |
| 175 | auto mask_merge_mode = mask_info->fMergeMode; |
| 176 | auto mask_inverted = ParseDefault<bool>((*m)["inv"], false); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 177 | |
Florin Malita | a524ea2 | 2020-07-20 10:51:07 -0400 | [diff] [blame^] | 178 | if (mask_stack.empty()) { |
| 179 | // First mask adjustments: |
| 180 | // - always draw in source mode |
| 181 | // - invert geometry if needed |
| 182 | mask_blend_mode = SkBlendMode::kSrc; |
| 183 | mask_merge_mode = sksg::Merge::Mode::kMerge; |
| 184 | mask_inverted = mask_inverted != mask_info->fInvertGeometry; |
| 185 | } |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 186 | |
Florin Malita | a524ea2 | 2020-07-20 10:51:07 -0400 | [diff] [blame^] | 187 | mask_path->setFillType(mask_inverted ? SkPathFillType::kInverseWinding |
| 188 | : SkPathFillType::kWinding); |
| 189 | |
| 190 | auto mask_adapter = sk_make_sp<MaskAdapter>(*m, *abuilder, mask_blend_mode); |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 191 | abuilder->attachDiscardableAdapter(mask_adapter); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 192 | |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 193 | has_effect |= mask_adapter->hasEffect(); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 194 | |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 195 | mask_stack.push_back({ std::move(mask_path), |
| 196 | std::move(mask_adapter), |
Florin Malita | a524ea2 | 2020-07-20 10:51:07 -0400 | [diff] [blame^] | 197 | mask_merge_mode }); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 198 | } |
| 199 | |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 200 | |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 201 | if (mask_stack.empty()) |
| 202 | return childNode; |
| 203 | |
| 204 | // If the masks are fully opaque, we can clip. |
| 205 | if (!has_effect) { |
| 206 | sk_sp<sksg::GeometryNode> clip_node; |
| 207 | |
| 208 | if (mask_stack.count() == 1) { |
| 209 | // Single path -> just clip. |
| 210 | clip_node = std::move(mask_stack.front().mask_path); |
| 211 | } else { |
| 212 | // Multiple clip paths -> merge. |
| 213 | std::vector<sksg::Merge::Rec> merge_recs; |
| 214 | merge_recs.reserve(SkToSizeT(mask_stack.count())); |
| 215 | |
| 216 | for (auto& mask : mask_stack) { |
Florin Malita | a524ea2 | 2020-07-20 10:51:07 -0400 | [diff] [blame^] | 217 | merge_recs.push_back({std::move(mask.mask_path), mask.merge_mode }); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 218 | } |
| 219 | clip_node = sksg::Merge::Make(std::move(merge_recs)); |
| 220 | } |
| 221 | |
| 222 | return sksg::ClipEffect::Make(std::move(childNode), std::move(clip_node), true); |
| 223 | } |
| 224 | |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 225 | // Complex masks (non-opaque or blurred) turn into a mask node stack. |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 226 | sk_sp<sksg::RenderNode> maskNode; |
| 227 | if (mask_stack.count() == 1) { |
| 228 | // no group needed for single mask |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 229 | const auto rec = mask_stack.front(); |
| 230 | maskNode = rec.mask_adapter->makeMask(std::move(rec.mask_path)); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 231 | } else { |
| 232 | std::vector<sk_sp<sksg::RenderNode>> masks; |
| 233 | masks.reserve(SkToSizeT(mask_stack.count())); |
| 234 | for (auto& rec : mask_stack) { |
Florin Malita | af99f3e | 2020-02-03 12:09:15 -0500 | [diff] [blame] | 235 | masks.push_back(rec.mask_adapter->makeMask(std::move(rec.mask_path))); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 236 | } |
| 237 | |
| 238 | maskNode = sksg::Group::Make(std::move(masks)); |
| 239 | } |
| 240 | |
| 241 | return sksg::MaskEffect::Make(std::move(childNode), std::move(maskNode)); |
| 242 | } |
| 243 | |
Florin Malita | bb7d95f | 2020-03-26 15:58:56 -0400 | [diff] [blame] | 244 | class LayerController final : public Animator { |
Florin Malita | 5f1108c | 2019-07-03 10:09:31 -0400 | [diff] [blame] | 245 | public: |
Florin Malita | bb7d95f | 2020-03-26 15:58:56 -0400 | [diff] [blame] | 246 | LayerController(AnimatorScope&& layer_animators, |
Florin Malita | 5f1108c | 2019-07-03 10:09:31 -0400 | [diff] [blame] | 247 | sk_sp<sksg::RenderNode> layer, |
| 248 | size_t tanim_count, float in, float out) |
| 249 | : fLayerAnimators(std::move(layer_animators)) |
| 250 | , fLayerNode(std::move(layer)) |
| 251 | , fTransformAnimatorsCount(tanim_count) |
| 252 | , fIn(in) |
| 253 | , fOut(out) {} |
| 254 | |
| 255 | protected: |
Florin Malita | 01f2ce0 | 2020-03-31 05:44:28 -0400 | [diff] [blame] | 256 | StateChanged onSeek(float t) override { |
Florin Malita | c4fae74 | 2020-02-27 15:50:04 -0500 | [diff] [blame] | 257 | // in/out may be inverted for time-reversed layers |
| 258 | const auto active = (t >= fIn && t < fOut) || (t > fOut && t <= fIn); |
Florin Malita | 5f1108c | 2019-07-03 10:09:31 -0400 | [diff] [blame] | 259 | |
Florin Malita | 01f2ce0 | 2020-03-31 05:44:28 -0400 | [diff] [blame] | 260 | bool changed = false; |
Florin Malita | 5f1108c | 2019-07-03 10:09:31 -0400 | [diff] [blame] | 261 | if (fLayerNode) { |
Florin Malita | 01f2ce0 | 2020-03-31 05:44:28 -0400 | [diff] [blame] | 262 | changed |= (fLayerNode->isVisible() != active); |
Florin Malita | 5f1108c | 2019-07-03 10:09:31 -0400 | [diff] [blame] | 263 | fLayerNode->setVisible(active); |
| 264 | } |
| 265 | |
| 266 | // When active, dispatch ticks to all layer animators. |
| 267 | // When inactive, we must still dispatch ticks to the layer transform animators |
| 268 | // (active child layers depend on transforms being updated). |
| 269 | const auto dispatch_count = active ? fLayerAnimators.size() |
| 270 | : fTransformAnimatorsCount; |
| 271 | for (size_t i = 0; i < dispatch_count; ++i) { |
Florin Malita | 01f2ce0 | 2020-03-31 05:44:28 -0400 | [diff] [blame] | 272 | changed |= fLayerAnimators[i]->seek(t); |
Florin Malita | 5f1108c | 2019-07-03 10:09:31 -0400 | [diff] [blame] | 273 | } |
Florin Malita | 0147de4 | 2020-03-27 09:49:03 -0400 | [diff] [blame] | 274 | |
Florin Malita | 01f2ce0 | 2020-03-31 05:44:28 -0400 | [diff] [blame] | 275 | return changed; |
Florin Malita | 5f1108c | 2019-07-03 10:09:31 -0400 | [diff] [blame] | 276 | } |
| 277 | |
| 278 | private: |
Florin Malita | bb7d95f | 2020-03-26 15:58:56 -0400 | [diff] [blame] | 279 | const AnimatorScope fLayerAnimators; |
Florin Malita | 5f1108c | 2019-07-03 10:09:31 -0400 | [diff] [blame] | 280 | const sk_sp<sksg::RenderNode> fLayerNode; |
| 281 | const size_t fTransformAnimatorsCount; |
| 282 | const float fIn, |
| 283 | fOut; |
| 284 | }; |
| 285 | |
Florin Malita | bb7d95f | 2020-03-26 15:58:56 -0400 | [diff] [blame] | 286 | class MotionBlurController final : public Animator { |
Florin Malita | 5f1108c | 2019-07-03 10:09:31 -0400 | [diff] [blame] | 287 | public: |
| 288 | explicit MotionBlurController(sk_sp<MotionBlurEffect> mbe) |
| 289 | : fMotionBlurEffect(std::move(mbe)) {} |
| 290 | |
| 291 | protected: |
| 292 | // When motion blur is present, time ticks are not passed to layer animators |
| 293 | // but to the motion blur effect. The effect then drives the animators/scene-graph |
| 294 | // during reval and render phases. |
Florin Malita | 01f2ce0 | 2020-03-31 05:44:28 -0400 | [diff] [blame] | 295 | StateChanged onSeek(float t) override { |
Florin Malita | 5f1108c | 2019-07-03 10:09:31 -0400 | [diff] [blame] | 296 | fMotionBlurEffect->setT(t); |
Florin Malita | 0147de4 | 2020-03-27 09:49:03 -0400 | [diff] [blame] | 297 | return true; |
Florin Malita | 5f1108c | 2019-07-03 10:09:31 -0400 | [diff] [blame] | 298 | } |
| 299 | |
| 300 | private: |
| 301 | const sk_sp<MotionBlurEffect> fMotionBlurEffect; |
| 302 | }; |
| 303 | |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 304 | } // namespace |
| 305 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 306 | LayerBuilder::LayerBuilder(const skjson::ObjectValue& jlayer) |
| 307 | : fJlayer(jlayer) |
Florin Malita | 6a414b2 | 2020-05-25 11:46:50 -0400 | [diff] [blame] | 308 | , fIndex (ParseDefault<int>(jlayer["ind" ], -1)) |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 309 | , fParentIndex(ParseDefault<int>(jlayer["parent"], -1)) |
Florin Malita | 6a414b2 | 2020-05-25 11:46:50 -0400 | [diff] [blame] | 310 | , fType (ParseDefault<int>(jlayer["ty" ], -1)) |
| 311 | , fAutoOrient (ParseDefault<int>(jlayer["ao" ], 0)) { |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 312 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 313 | if (this->isCamera() || ParseDefault<int>(jlayer["ddd"], 0)) { |
| 314 | fFlags |= Flags::kIs3D; |
Florin Malita | 60c84fd | 2019-07-02 18:02:54 -0400 | [diff] [blame] | 315 | } |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 316 | } |
| 317 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 318 | LayerBuilder::~LayerBuilder() = default; |
| 319 | |
| 320 | bool LayerBuilder::isCamera() const { |
| 321 | static constexpr int kCameraLayerType = 13; |
| 322 | |
| 323 | return fType == kCameraLayerType; |
| 324 | } |
| 325 | |
| 326 | sk_sp<sksg::Transform> LayerBuilder::buildTransform(const AnimationBuilder& abuilder, |
| 327 | CompositionBuilder* cbuilder) { |
| 328 | // Depending on the leaf node type, we treat the whole transform chain as either 2D or 3D. |
| 329 | const auto transform_chain_type = this->is3D() ? TransformType::k3D |
| 330 | : TransformType::k2D; |
| 331 | fLayerTransform = this->getTransform(abuilder, cbuilder, transform_chain_type); |
| 332 | |
| 333 | return fLayerTransform; |
| 334 | } |
| 335 | |
| 336 | sk_sp<sksg::Transform> LayerBuilder::getTransform(const AnimationBuilder& abuilder, |
| 337 | CompositionBuilder* cbuilder, |
| 338 | TransformType ttype) { |
| 339 | const auto cache_valid_mask = (1ul << ttype); |
| 340 | if (!(fFlags & cache_valid_mask)) { |
| 341 | // Set valid flag upfront to break cycles. |
| 342 | fFlags |= cache_valid_mask; |
| 343 | |
| 344 | const AnimationBuilder::AutoPropertyTracker apt(&abuilder, fJlayer); |
| 345 | AnimationBuilder::AutoScope ascope(&abuilder, std::move(fLayerScope)); |
| 346 | fTransformCache[ttype] = this->doAttachTransform(abuilder, cbuilder, ttype); |
| 347 | fLayerScope = ascope.release(); |
| 348 | fTransformAnimatorCount = fLayerScope.size(); |
Florin Malita | d9e8586 | 2019-10-17 13:46:33 -0400 | [diff] [blame] | 349 | } |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 350 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 351 | return fTransformCache[ttype]; |
| 352 | } |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 353 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 354 | sk_sp<sksg::Transform> LayerBuilder::getParentTransform(const AnimationBuilder& abuilder, |
| 355 | CompositionBuilder* cbuilder, |
| 356 | TransformType ttype) { |
| 357 | if (auto* parent_builder = cbuilder->layerBuilder(fParentIndex)) { |
| 358 | // Explicit parent layer. |
| 359 | return parent_builder->getTransform(abuilder, cbuilder, ttype); |
| 360 | } |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 361 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 362 | if (ttype == TransformType::k3D) { |
| 363 | // During camera transform attachment, cbuilder->getCameraTransform() is null. |
| 364 | // This prevents camera->camera transform chain cycles. |
| 365 | SkASSERT(!this->isCamera() || !cbuilder->getCameraTransform()); |
| 366 | |
| 367 | // 3D transform chains are implicitly rooted onto the camera. |
| 368 | return cbuilder->getCameraTransform(); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 369 | } |
| 370 | |
| 371 | return nullptr; |
| 372 | } |
| 373 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 374 | sk_sp<sksg::Transform> LayerBuilder::doAttachTransform(const AnimationBuilder& abuilder, |
| 375 | CompositionBuilder* cbuilder, |
| 376 | TransformType ttype) { |
| 377 | const skjson::ObjectValue* jtransform = fJlayer["ks"]; |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 378 | if (!jtransform) { |
| 379 | return nullptr; |
| 380 | } |
| 381 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 382 | auto parent_transform = this->getParentTransform(abuilder, cbuilder, ttype); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 383 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 384 | if (this->isCamera()) { |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 385 | // parent_transform applies to the camera itself => it pre-composes inverted to the |
| 386 | // camera/view/adapter transform. |
| 387 | // |
| 388 | // T_camera' = T_camera x Inv(parent_transform) |
| 389 | // |
Florin Malita | e7bd58f | 2020-01-27 11:58:49 -0500 | [diff] [blame] | 390 | return abuilder.attachCamera(fJlayer, |
| 391 | *jtransform, |
| 392 | sksg::Transform::MakeInverse(std::move(parent_transform)), |
| 393 | cbuilder->fSize); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 394 | } |
| 395 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 396 | return this->is3D() |
Florin Malita | 6a414b2 | 2020-05-25 11:46:50 -0400 | [diff] [blame] | 397 | ? abuilder.attachMatrix3D(*jtransform, std::move(parent_transform), fAutoOrient) |
| 398 | : abuilder.attachMatrix2D(*jtransform, std::move(parent_transform), fAutoOrient); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 399 | } |
| 400 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 401 | bool LayerBuilder::hasMotionBlur(const CompositionBuilder* cbuilder) const { |
| 402 | return cbuilder->fMotionBlurSamples > 1 |
| 403 | && cbuilder->fMotionBlurAngle > 0 |
| 404 | && ParseDefault(fJlayer["mb"], false); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 405 | } |
| 406 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 407 | sk_sp<sksg::RenderNode> LayerBuilder::buildRenderTree(const AnimationBuilder& abuilder, |
Florin Malita | 46a331b | 2019-12-12 15:43:53 -0500 | [diff] [blame] | 408 | CompositionBuilder* cbuilder, |
| 409 | const LayerBuilder* prev_layer) { |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 410 | AnimationBuilder::LayerInfo layer_info = { |
Florin Malita | 6cc4953 | 2019-12-05 09:06:22 -0500 | [diff] [blame] | 411 | cbuilder->fSize, |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 412 | ParseDefault<float>(fJlayer["ip"], 0.0f), |
| 413 | ParseDefault<float>(fJlayer["op"], 0.0f), |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 414 | }; |
Florin Malita | c4fae74 | 2020-02-27 15:50:04 -0500 | [diff] [blame] | 415 | if (SkScalarNearlyEqual(layer_info.fInPoint, layer_info.fOutPoint)) { |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 416 | abuilder.log(Logger::Level::kError, nullptr, |
| 417 | "Invalid layer in/out points: %f/%f.", |
| 418 | layer_info.fInPoint, layer_info.fOutPoint); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 419 | return nullptr; |
| 420 | } |
| 421 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 422 | const AnimationBuilder::AutoPropertyTracker apt(&abuilder, fJlayer); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 423 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 424 | using LayerBuilder = |
| 425 | sk_sp<sksg::RenderNode> (AnimationBuilder::*)(const skjson::ObjectValue&, |
| 426 | AnimationBuilder::LayerInfo*) const; |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 427 | |
| 428 | // AE is annoyingly inconsistent in how effects interact with layer transforms: depending on |
| 429 | // the layer type, effects are applied before or after the content is transformed. |
| 430 | // |
| 431 | // Empirically, pre-rendered layers (for some loose meaning of "pre-rendered") are in the |
| 432 | // former category (effects are subject to transformation), while the remaining types are in |
| 433 | // the latter. |
| 434 | enum : uint32_t { |
| 435 | kTransformEffects = 1, // The layer transform also applies to its effects. |
| 436 | }; |
| 437 | |
| 438 | static constexpr struct { |
Florin Malita | 60c84fd | 2019-07-02 18:02:54 -0400 | [diff] [blame] | 439 | LayerBuilder fBuilder; |
| 440 | uint32_t fFlags; |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 441 | } gLayerBuildInfo[] = { |
Florin Malita | 8b70f4d | 2020-04-23 18:58:21 -0400 | [diff] [blame] | 442 | { &AnimationBuilder::attachPrecompLayer, kTransformEffects }, // 'ty': 0 -> precomp |
| 443 | { &AnimationBuilder::attachSolidLayer , kTransformEffects }, // 'ty': 1 -> solid |
Florin Malita | 71c3141 | 2020-05-07 16:44:18 -0400 | [diff] [blame] | 444 | { &AnimationBuilder::attachFootageLayer, kTransformEffects }, // 'ty': 2 -> image |
Florin Malita | 8b70f4d | 2020-04-23 18:58:21 -0400 | [diff] [blame] | 445 | { &AnimationBuilder::attachNullLayer , 0 }, // 'ty': 3 -> null |
| 446 | { &AnimationBuilder::attachShapeLayer , 0 }, // 'ty': 4 -> shape |
| 447 | { &AnimationBuilder::attachTextLayer , 0 }, // 'ty': 5 -> text |
| 448 | { nullptr , 0 }, // 'ty': 6 -> audio |
| 449 | { nullptr , 0 }, // 'ty': 7 -> pholderVideo |
| 450 | { nullptr , 0 }, // 'ty': 8 -> imageSeq |
Florin Malita | 71c3141 | 2020-05-07 16:44:18 -0400 | [diff] [blame] | 451 | { &AnimationBuilder::attachFootageLayer, kTransformEffects }, // 'ty': 9 -> video |
Florin Malita | 8b70f4d | 2020-04-23 18:58:21 -0400 | [diff] [blame] | 452 | { nullptr , 0 }, // 'ty': 10 -> pholderStill |
| 453 | { nullptr , 0 }, // 'ty': 11 -> guide |
| 454 | { nullptr , 0 }, // 'ty': 12 -> adjustment |
| 455 | { &AnimationBuilder::attachNullLayer , 0 }, // 'ty': 13 -> camera |
| 456 | { nullptr , 0 }, // 'ty': 14 -> light |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 457 | }; |
| 458 | |
Florin Malita | 8b70f4d | 2020-04-23 18:58:21 -0400 | [diff] [blame] | 459 | // Treat all hidden layers as null. |
| 460 | const auto type = ParseDefault<bool>(fJlayer["hd"], false) |
| 461 | ? kNullLayerType |
| 462 | : SkToSizeT(fType); |
| 463 | |
| 464 | if (type >= SK_ARRAY_COUNT(gLayerBuildInfo)) { |
Florin Malita | 60c84fd | 2019-07-02 18:02:54 -0400 | [diff] [blame] | 465 | return nullptr; |
| 466 | } |
| 467 | |
Florin Malita | 8b70f4d | 2020-04-23 18:58:21 -0400 | [diff] [blame] | 468 | const auto& build_info = gLayerBuildInfo[type]; |
| 469 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 470 | // Switch to the layer animator scope (which at this point holds transform-only animators). |
| 471 | AnimationBuilder::AutoScope ascope(&abuilder, std::move(fLayerScope)); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 472 | |
Florin Malita | 8b70f4d | 2020-04-23 18:58:21 -0400 | [diff] [blame] | 473 | // Potentially null. |
| 474 | sk_sp<sksg::RenderNode> layer; |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 475 | |
| 476 | // Build the layer content fragment. |
Florin Malita | 8b70f4d | 2020-04-23 18:58:21 -0400 | [diff] [blame] | 477 | if (build_info.fBuilder) { |
| 478 | layer = (abuilder.*(build_info.fBuilder))(fJlayer, &layer_info); |
| 479 | } |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 480 | |
| 481 | // Clip layers with explicit dimensions. |
| 482 | float w = 0, h = 0; |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 483 | if (Parse<float>(fJlayer["w"], &w) && Parse<float>(fJlayer["h"], &h)) { |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 484 | layer = sksg::ClipEffect::Make(std::move(layer), |
| 485 | sksg::Rect::Make(SkRect::MakeWH(w, h)), |
| 486 | true); |
| 487 | } |
| 488 | |
| 489 | // Optional layer mask. |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 490 | layer = AttachMask(fJlayer["masksProperties"], &abuilder, std::move(layer)); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 491 | |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 492 | // Does the transform apply to effects also? |
| 493 | // (AE quirk: it doesn't - except for solid layers) |
| 494 | const auto transform_effects = (build_info.fFlags & kTransformEffects); |
| 495 | |
| 496 | // Attach the transform before effects, when needed. |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 497 | if (fLayerTransform && !transform_effects) { |
| 498 | layer = sksg::TransformEffect::Make(std::move(layer), fLayerTransform); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 499 | } |
| 500 | |
| 501 | // Optional layer effects. |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 502 | if (const skjson::ArrayValue* jeffects = fJlayer["ef"]) { |
| 503 | layer = EffectBuilder(&abuilder, layer_info.fSize).attachEffects(*jeffects, |
| 504 | std::move(layer)); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 505 | } |
| 506 | |
| 507 | // Attach the transform after effects, when needed. |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 508 | if (fLayerTransform && transform_effects) { |
| 509 | layer = sksg::TransformEffect::Make(std::move(layer), std::move(fLayerTransform)); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 510 | } |
| 511 | |
Florin Malita | ae58199 | 2020-03-24 21:18:42 -0400 | [diff] [blame] | 512 | // Optional layer styles. |
| 513 | if (const skjson::ArrayValue* jstyles = fJlayer["sy"]) { |
| 514 | layer = EffectBuilder(&abuilder, layer_info.fSize).attachStyles(*jstyles, std::move(layer)); |
| 515 | } |
| 516 | |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 517 | // Optional layer opacity. |
| 518 | // TODO: de-dupe this "ks" lookup with matrix above. |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 519 | if (const skjson::ObjectValue* jtransform = fJlayer["ks"]) { |
| 520 | layer = abuilder.attachOpacity(*jtransform, std::move(layer)); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 521 | } |
| 522 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 523 | const auto has_animators = !abuilder.fCurrentAnimatorScope->empty(); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 524 | |
Florin Malita | bb7d95f | 2020-03-26 15:58:56 -0400 | [diff] [blame] | 525 | sk_sp<Animator> controller = sk_make_sp<LayerController>(ascope.release(), |
| 526 | layer, |
| 527 | fTransformAnimatorCount, |
| 528 | layer_info.fInPoint, |
| 529 | layer_info.fOutPoint); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 530 | |
Florin Malita | 5f1108c | 2019-07-03 10:09:31 -0400 | [diff] [blame] | 531 | // Optional motion blur. |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 532 | if (layer && has_animators && this->hasMotionBlur(cbuilder)) { |
Florin Malita | 5f1108c | 2019-07-03 10:09:31 -0400 | [diff] [blame] | 533 | // Wrap both the layer node and the controller. |
| 534 | auto motion_blur = MotionBlurEffect::Make(std::move(controller), std::move(layer), |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 535 | cbuilder->fMotionBlurSamples, |
| 536 | cbuilder->fMotionBlurAngle, |
| 537 | cbuilder->fMotionBlurPhase); |
Florin Malita | 5f24018 | 2019-07-23 17:28:53 -0400 | [diff] [blame] | 538 | controller = sk_make_sp<MotionBlurController>(motion_blur); |
Florin Malita | 5f1108c | 2019-07-03 10:09:31 -0400 | [diff] [blame] | 539 | layer = std::move(motion_blur); |
| 540 | } |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 541 | |
Florin Malita | c6fbedc | 2019-10-28 13:57:12 -0400 | [diff] [blame] | 542 | abuilder.fCurrentAnimatorScope->push_back(std::move(controller)); |
Florin Malita | 60c84fd | 2019-07-02 18:02:54 -0400 | [diff] [blame] | 543 | |
Florin Malita | 46a331b | 2019-12-12 15:43:53 -0500 | [diff] [blame] | 544 | // Stash the content tree in case it is needed for later mattes. |
| 545 | fContentTree = layer; |
| 546 | |
| 547 | if (ParseDefault<bool>(fJlayer["td"], false)) { |
| 548 | // |layer| is a track matte. We apply it as a mask to the next layer. |
Florin Malita | 60c84fd | 2019-07-02 18:02:54 -0400 | [diff] [blame] | 549 | return nullptr; |
| 550 | } |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 551 | |
Florin Malita | 46a331b | 2019-12-12 15:43:53 -0500 | [diff] [blame] | 552 | // Optional matte. |
| 553 | size_t matte_mode; |
| 554 | if (prev_layer && Parse(fJlayer["tt"], &matte_mode)) { |
| 555 | static constexpr sksg::MaskEffect::Mode gMatteModes[] = { |
Florin Malita | 59e72b7 | 2019-10-16 08:51:09 -0400 | [diff] [blame] | 556 | sksg::MaskEffect::Mode::kAlphaNormal, // tt: 1 |
| 557 | sksg::MaskEffect::Mode::kAlphaInvert, // tt: 2 |
| 558 | sksg::MaskEffect::Mode::kLumaNormal, // tt: 3 |
| 559 | sksg::MaskEffect::Mode::kLumaInvert, // tt: 4 |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 560 | }; |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 561 | |
Florin Malita | 46a331b | 2019-12-12 15:43:53 -0500 | [diff] [blame] | 562 | if (matte_mode > 0 && matte_mode <= SK_ARRAY_COUNT(gMatteModes)) { |
| 563 | // The current layer is masked with the previous layer *content*. |
Florin Malita | 512eb94 | 2019-10-28 21:22:42 -0400 | [diff] [blame] | 564 | layer = sksg::MaskEffect::Make(std::move(layer), |
Florin Malita | 46a331b | 2019-12-12 15:43:53 -0500 | [diff] [blame] | 565 | prev_layer->fContentTree, |
| 566 | gMatteModes[matte_mode - 1]); |
| 567 | } else { |
| 568 | abuilder.log(Logger::Level::kError, nullptr, |
| 569 | "Unknown track matte mode: %zu\n", matte_mode); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 570 | } |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 571 | } |
| 572 | |
Florin Malita | 46a331b | 2019-12-12 15:43:53 -0500 | [diff] [blame] | 573 | // Finally, attach an optional blend mode. |
| 574 | // NB: blend modes are never applied to matte sources (layer content only). |
| 575 | return abuilder.attachBlendMode(fJlayer, std::move(layer)); |
Florin Malita | 45dc1f0 | 2019-07-01 13:57:43 -0400 | [diff] [blame] | 576 | } |
| 577 | |
| 578 | } // namespace internal |
| 579 | } // namespace skottie |