1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* This Source Code Form is subject to the terms of the Mozilla Public
3 * License, v. 2.0. If a copy of the MPL was not distributed with this
4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6 #include "nsSMILCompositor.h"
7 #include "nsSMILCSSProperty.h"
8 #include "nsCSSProps.h"
9 #include "nsHashKeys.h"
11 // PLDHashEntryHdr methods
13 nsSMILCompositor::KeyEquals(KeyTypePointer aKey
) const
15 return aKey
&& aKey
->Equals(mKey
);
18 /*static*/ PLDHashNumber
19 nsSMILCompositor::HashKey(KeyTypePointer aKey
)
21 // Combine the 3 values into one numeric value, which will be hashed.
22 // NOTE: We right-shift one of the pointers by 2 to get some randomness in
23 // its 2 lowest-order bits. (Those shifted-off bits will always be 0 since
24 // our pointers will be word-aligned.)
25 return (NS_PTR_TO_UINT32(aKey
->mElement
.get()) >> 2) +
26 NS_PTR_TO_UINT32(aKey
->mAttributeName
.get()) +
27 (aKey
->mIsCSS
? 1 : 0);
30 // Cycle-collection support
32 nsSMILCompositor::Traverse(nsCycleCollectionTraversalCallback
* aCallback
)
37 NS_CYCLE_COLLECTION_NOTE_EDGE_NAME(*aCallback
, "Compositor mKey.mElement");
38 aCallback
->NoteXPCOMChild(mKey
.mElement
);
43 nsSMILCompositor::AddAnimationFunction(nsSMILAnimationFunction
* aFunc
)
46 mAnimationFunctions
.AppendElement(aFunc
);
51 nsSMILCompositor::ComposeAttribute()
56 // FIRST: Get the nsISMILAttr (to grab base value from, and to eventually
57 // give animated value to)
58 nsAutoPtr
<nsISMILAttr
> smilAttr(CreateSMILAttr());
60 // Target attribute not found (or, out of memory)
63 if (mAnimationFunctions
.IsEmpty()) {
64 // No active animation functions. (We can still have a nsSMILCompositor in
65 // that case if an animation function has *just* become inactive)
66 smilAttr
->ClearAnimValue();
70 // SECOND: Sort the animationFunctions, to prepare for compositing.
71 nsSMILAnimationFunction::Comparator comparator
;
72 mAnimationFunctions
.Sort(comparator
);
74 // THIRD: Step backwards through animation functions to find out
75 // which ones we actually care about.
76 uint32_t firstFuncToCompose
= GetFirstFuncToAffectSandwich();
78 // FOURTH: Get & cache base value
79 nsSMILValue sandwichResultValue
;
80 if (!mAnimationFunctions
[firstFuncToCompose
]->WillReplace()) {
81 sandwichResultValue
= smilAttr
->GetBaseValue();
83 UpdateCachedBaseValue(sandwichResultValue
);
85 if (!mForceCompositing
) {
89 // FIFTH: Compose animation functions
90 uint32_t length
= mAnimationFunctions
.Length();
91 for (uint32_t i
= firstFuncToCompose
; i
< length
; ++i
) {
92 mAnimationFunctions
[i
]->ComposeResult(*smilAttr
, sandwichResultValue
);
94 if (sandwichResultValue
.IsNull()) {
95 smilAttr
->ClearAnimValue();
99 // SIXTH: Set the animated value to the final composited result.
100 nsresult rv
= smilAttr
->SetAnimValue(sandwichResultValue
);
102 NS_WARNING("nsISMILAttr::SetAnimValue failed");
107 nsSMILCompositor::ClearAnimationEffects()
109 if (!mKey
.mElement
|| !mKey
.mAttributeName
)
112 nsAutoPtr
<nsISMILAttr
> smilAttr(CreateSMILAttr());
114 // Target attribute not found (or, out of memory)
117 smilAttr
->ClearAnimValue();
120 // Protected Helper Functions
121 // --------------------------
123 nsSMILCompositor::CreateSMILAttr()
126 nsCSSProperty propId
=
127 nsCSSProps::LookupProperty(nsDependentAtomString(mKey
.mAttributeName
),
128 nsCSSProps::eEnabledForAllContent
);
129 if (nsSMILCSSProperty::IsPropertyAnimatable(propId
)) {
130 return new nsSMILCSSProperty(propId
, mKey
.mElement
.get());
133 return mKey
.mElement
->GetAnimatedAttr(mKey
.mAttributeNamespaceID
,
134 mKey
.mAttributeName
);
140 nsSMILCompositor::GetFirstFuncToAffectSandwich()
143 for (i
= mAnimationFunctions
.Length(); i
> 0; --i
) {
144 nsSMILAnimationFunction
* curAnimFunc
= mAnimationFunctions
[i
-1];
145 // In the following, the lack of short-circuit behavior of |= means that we
146 // will ALWAYS run UpdateCachedTarget (even if mForceCompositing is true)
147 // but only call HasChanged and WasSkippedInPrevSample if necessary. This
148 // is important since we need UpdateCachedTarget to run in order to detect
149 // changes to the target in subsequent samples.
151 curAnimFunc
->UpdateCachedTarget(mKey
) ||
152 curAnimFunc
->HasChanged() ||
153 curAnimFunc
->WasSkippedInPrevSample();
155 if (curAnimFunc
->WillReplace()) {
160 // Mark remaining animation functions as having been skipped so if we later
161 // use them we'll know to force compositing.
162 // Note that we only really need to do this if something has changed
163 // (otherwise we would have set the flag on a previous sample) and if
164 // something has changed mForceCompositing will be true.
165 if (mForceCompositing
) {
166 for (uint32_t j
= i
; j
> 0; --j
) {
167 mAnimationFunctions
[j
-1]->SetWasSkipped();
174 nsSMILCompositor::UpdateCachedBaseValue(const nsSMILValue
& aBaseValue
)
176 if (!mCachedBaseValue
) {
177 // We don't have last sample's base value cached. Assume it's changed.
178 mCachedBaseValue
= new nsSMILValue(aBaseValue
);
179 NS_WARN_IF_FALSE(mCachedBaseValue
, "failed to cache base value (OOM?)");
180 mForceCompositing
= true;
181 } else if (*mCachedBaseValue
!= aBaseValue
) {
182 // Base value has changed since last sample.
183 *mCachedBaseValue
= aBaseValue
;
184 mForceCompositing
= true;