/* vim: set shiftwidth=2 tabstop=8 autoindent cindent expandtab: */ /* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ #include "AnimationCommon.h" #include "nsTransitionManager.h" #include "nsAnimationManager.h" #include "ActiveLayerTracker.h" #include "gfxPlatform.h" #include "nsRuleData.h" #include "nsCSSPropertySet.h" #include "nsCSSValue.h" #include "nsCycleCollectionParticipant.h" #include "nsStyleContext.h" #include "nsIFrame.h" #include "nsLayoutUtils.h" #include "mozilla/LookAndFeel.h" #include "Layers.h" #include "FrameLayerBuilder.h" #include "nsDisplayList.h" #include "mozilla/MemoryReporting.h" #include "RestyleManager.h" #include "nsStyleSet.h" #include "nsStyleChangeList.h" using mozilla::layers::Layer; using mozilla::dom::AnimationPlayer; using mozilla::dom::Animation; namespace mozilla { /* static */ bool IsGeometricProperty(nsCSSProperty aProperty) { switch (aProperty) { case eCSSProperty_bottom: case eCSSProperty_height: case eCSSProperty_left: case eCSSProperty_right: case eCSSProperty_top: case eCSSProperty_width: return true; default: return false; } } namespace css { CommonAnimationManager::CommonAnimationManager(nsPresContext *aPresContext) : mPresContext(aPresContext) { PR_INIT_CLIST(&mElementCollections); } CommonAnimationManager::~CommonAnimationManager() { NS_ABORT_IF_FALSE(!mPresContext, "Disconnect should have been called"); } void CommonAnimationManager::Disconnect() { // Content nodes might outlive the transition or animation manager. RemoveAllElementCollections(); mPresContext = nullptr; } void CommonAnimationManager::RemoveAllElementCollections() { while (!PR_CLIST_IS_EMPTY(&mElementCollections)) { AnimationPlayerCollection* head = static_cast( PR_LIST_HEAD(&mElementCollections)); head->Destroy(); } } AnimationPlayerCollection* CommonAnimationManager::GetAnimationsForCompositor(nsIContent* aContent, nsIAtom* aElementProperty, nsCSSProperty aProperty) { if (!aContent->MayHaveAnimations()) return nullptr; AnimationPlayerCollection* collection = static_cast( aContent->GetProperty(aElementProperty)); if (!collection || !collection->HasAnimationOfProperty(aProperty) || !collection->CanPerformOnCompositorThread( AnimationPlayerCollection::CanAnimate_AllowPartial)) { return nullptr; } // This animation can be done on the compositor. // Mark the frame as active, in case we are able to throttle this animation. nsIFrame* frame = nsLayoutUtils::GetStyleFrame(collection->mElement); if (frame) { if (aProperty == eCSSProperty_opacity) { ActiveLayerTracker::NotifyAnimated(frame, eCSSProperty_opacity); } else if (aProperty == eCSSProperty_transform) { ActiveLayerTracker::NotifyAnimated(frame, eCSSProperty_transform); } } return collection; } /* * nsISupports implementation */ NS_IMPL_ISUPPORTS(CommonAnimationManager, nsIStyleRuleProcessor) nsRestyleHint CommonAnimationManager::HasStateDependentStyle(StateRuleProcessorData* aData) { return nsRestyleHint(0); } nsRestyleHint CommonAnimationManager::HasStateDependentStyle(PseudoElementStateRuleProcessorData* aData) { return nsRestyleHint(0); } bool CommonAnimationManager::HasDocumentStateDependentStyle(StateRuleProcessorData* aData) { return false; } nsRestyleHint CommonAnimationManager::HasAttributeDependentStyle(AttributeRuleProcessorData* aData) { return nsRestyleHint(0); } /* virtual */ bool CommonAnimationManager::MediumFeaturesChanged(nsPresContext* aPresContext) { return false; } /* virtual */ size_t CommonAnimationManager::SizeOfExcludingThis(mozilla::MallocSizeOf aMallocSizeOf) const { // Measurement of the following members may be added later if DMD finds it is // worthwhile: // - mElementCollections // // The following members are not measured // - mPresContext, because it's non-owning return 0; } /* virtual */ size_t CommonAnimationManager::SizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const { return aMallocSizeOf(this) + SizeOfExcludingThis(aMallocSizeOf); } void CommonAnimationManager::AddStyleUpdatesTo(RestyleTracker& aTracker) { PRCList* next = PR_LIST_HEAD(&mElementCollections); while (next != &mElementCollections) { AnimationPlayerCollection* collection = static_cast(next); next = PR_NEXT_LINK(next); dom::Element* elementToRestyle = collection->GetElementToRestyle(); if (elementToRestyle) { nsRestyleHint rshint = collection->IsForTransitions() ? eRestyle_CSSTransitions : eRestyle_CSSAnimations; aTracker.AddPendingRestyle(elementToRestyle, rshint, nsChangeHint(0)); } } } /* static */ bool CommonAnimationManager::ExtractComputedValueForTransition( nsCSSProperty aProperty, nsStyleContext* aStyleContext, StyleAnimationValue& aComputedValue) { bool result = StyleAnimationValue::ExtractComputedValue(aProperty, aStyleContext, aComputedValue); if (aProperty == eCSSProperty_visibility) { NS_ABORT_IF_FALSE(aComputedValue.GetUnit() == StyleAnimationValue::eUnit_Enumerated, "unexpected unit"); aComputedValue.SetIntValue(aComputedValue.GetIntValue(), StyleAnimationValue::eUnit_Visibility); } return result; } NS_IMPL_ISUPPORTS(AnimValuesStyleRule, nsIStyleRule) /* virtual */ void AnimValuesStyleRule::MapRuleInfoInto(nsRuleData* aRuleData) { nsStyleContext *contextParent = aRuleData->mStyleContext->GetParent(); if (contextParent && contextParent->HasPseudoElementData()) { // Don't apply transitions or animations to things inside of // pseudo-elements. // FIXME (Bug 522599): Add tests for this. return; } for (uint32_t i = 0, i_end = mPropertyValuePairs.Length(); i < i_end; ++i) { PropertyValuePair &cv = mPropertyValuePairs[i]; if (aRuleData->mSIDs & nsCachedStyleData::GetBitForSID( nsCSSProps::kSIDTable[cv.mProperty])) { nsCSSValue *prop = aRuleData->ValueFor(cv.mProperty); if (prop->GetUnit() == eCSSUnit_Null) { #ifdef DEBUG bool ok = #endif StyleAnimationValue::UncomputeValue(cv.mProperty, cv.mValue, *prop); NS_ABORT_IF_FALSE(ok, "could not store computed value"); } } } } #ifdef DEBUG /* virtual */ void AnimValuesStyleRule::List(FILE* out, int32_t aIndent) const { for (int32_t index = aIndent; --index >= 0; ) fputs(" ", out); fputs("[anim values] { ", out); for (uint32_t i = 0, i_end = mPropertyValuePairs.Length(); i < i_end; ++i) { const PropertyValuePair &pair = mPropertyValuePairs[i]; nsAutoString value; StyleAnimationValue::UncomputeValue(pair.mProperty, pair.mValue, value); fprintf(out, "%s: %s; ", nsCSSProps::GetStringValue(pair.mProperty).get(), NS_ConvertUTF16toUTF8(value).get()); } fputs("}\n", out); } #endif } /* end sub-namespace css */ bool AnimationPlayerCollection::CanAnimatePropertyOnCompositor( const dom::Element *aElement, nsCSSProperty aProperty, CanAnimateFlags aFlags) { bool shouldLog = nsLayoutUtils::IsAnimationLoggingEnabled(); if (!gfxPlatform::OffMainThreadCompositingEnabled()) { if (shouldLog) { nsCString message; message.AppendLiteral("Performance warning: Compositor disabled"); LogAsyncAnimationFailure(message); } return false; } nsIFrame* frame = nsLayoutUtils::GetStyleFrame(aElement); if (IsGeometricProperty(aProperty)) { if (shouldLog) { nsCString message; message.AppendLiteral("Performance warning: Async animation of geometric property '"); message.Append(nsCSSProps::GetStringValue(aProperty)); message.AppendLiteral("' is disabled"); LogAsyncAnimationFailure(message, aElement); } return false; } if (aProperty == eCSSProperty_transform) { if (frame->Preserves3D() && frame->Preserves3DChildren()) { if (shouldLog) { nsCString message; message.AppendLiteral("Gecko bug: Async animation of 'preserve-3d' transforms is not supported. See bug 779598"); LogAsyncAnimationFailure(message, aElement); } return false; } if (frame->IsSVGTransformed()) { if (shouldLog) { nsCString message; message.AppendLiteral("Gecko bug: Async 'transform' animations of frames with SVG transforms is not supported. See bug 779599"); LogAsyncAnimationFailure(message, aElement); } return false; } if (aFlags & CanAnimate_HasGeometricProperty) { if (shouldLog) { nsCString message; message.AppendLiteral("Performance warning: Async animation of 'transform' not possible due to presence of geometric properties"); LogAsyncAnimationFailure(message, aElement); } return false; } } bool enabled = nsLayoutUtils::AreAsyncAnimationsEnabled(); if (!enabled && shouldLog) { nsCString message; message.AppendLiteral("Performance warning: Async animations are disabled"); LogAsyncAnimationFailure(message); } bool propertyAllowed = (aProperty == eCSSProperty_transform) || (aProperty == eCSSProperty_opacity) || (aFlags & CanAnimate_AllowPartial); return enabled && propertyAllowed; } /* static */ bool AnimationPlayerCollection::IsCompositorAnimationDisabledForFrame( nsIFrame* aFrame) { void* prop = aFrame->Properties().Get(nsIFrame::RefusedAsyncAnimation()); return bool(reinterpret_cast(prop)); } bool AnimationPlayerCollection::CanPerformOnCompositorThread( CanAnimateFlags aFlags) const { nsIFrame* frame = nsLayoutUtils::GetStyleFrame(mElement); if (!frame) { return false; } if (mElementProperty != nsGkAtoms::transitionsProperty && mElementProperty != nsGkAtoms::animationsProperty) { if (nsLayoutUtils::IsAnimationLoggingEnabled()) { nsCString message; message.AppendLiteral("Gecko bug: Async animation of pseudoelements" " not supported. See bug 771367 ("); message.Append(nsAtomCString(mElementProperty)); message.Append(")"); LogAsyncAnimationFailure(message, mElement); } return false; } for (size_t playerIdx = mPlayers.Length(); playerIdx-- != 0; ) { const AnimationPlayer* player = mPlayers[playerIdx]; if (!player->IsRunning() || !player->GetSource()) { continue; } const Animation* anim = player->GetSource(); for (size_t propIdx = 0, propEnd = anim->Properties().Length(); propIdx != propEnd; ++propIdx) { if (IsGeometricProperty(anim->Properties()[propIdx].mProperty)) { aFlags = CanAnimateFlags(aFlags | CanAnimate_HasGeometricProperty); break; } } } bool existsProperty = false; for (size_t playerIdx = mPlayers.Length(); playerIdx-- != 0; ) { const AnimationPlayer* player = mPlayers[playerIdx]; if (!player->IsRunning() || !player->GetSource()) { continue; } const Animation* anim = player->GetSource(); existsProperty = existsProperty || anim->Properties().Length() > 0; for (size_t propIdx = 0, propEnd = anim->Properties().Length(); propIdx != propEnd; ++propIdx) { const AnimationProperty& prop = anim->Properties()[propIdx]; if (!CanAnimatePropertyOnCompositor(mElement, prop.mProperty, aFlags) || IsCompositorAnimationDisabledForFrame(frame)) { return false; } } } // No properties to animate if (!existsProperty) { return false; } return true; } bool AnimationPlayerCollection::HasAnimationOfProperty( nsCSSProperty aProperty) const { for (size_t playerIdx = mPlayers.Length(); playerIdx-- != 0; ) { const Animation* anim = mPlayers[playerIdx]->GetSource(); if (anim && anim->HasAnimationOfProperty(aProperty) && !anim->IsFinishedTransition()) { return true; } } return false; } mozilla::dom::Element* AnimationPlayerCollection::GetElementToRestyle() const { if (IsForElement()) { return mElement; } nsIFrame* primaryFrame = mElement->GetPrimaryFrame(); if (!primaryFrame) { return nullptr; } nsIFrame* pseudoFrame; if (IsForBeforePseudo()) { pseudoFrame = nsLayoutUtils::GetBeforeFrame(primaryFrame); } else if (IsForAfterPseudo()) { pseudoFrame = nsLayoutUtils::GetAfterFrame(primaryFrame); } else { MOZ_ASSERT(false, "unknown mElementProperty"); return nullptr; } if (!pseudoFrame) { return nullptr; } return pseudoFrame->GetContent()->AsElement(); } /* static */ void AnimationPlayerCollection::LogAsyncAnimationFailure(nsCString& aMessage, const nsIContent* aContent) { if (aContent) { aMessage.AppendLiteral(" ["); aMessage.Append(nsAtomCString(aContent->Tag())); nsIAtom* id = aContent->GetID(); if (id) { aMessage.AppendLiteral(" with id '"); aMessage.Append(nsAtomCString(aContent->GetID())); aMessage.Append('\''); } aMessage.Append(']'); } aMessage.Append('\n'); printf_stderr("%s", aMessage.get()); } /*static*/ void AnimationPlayerCollection::PropertyDtor(void *aObject, nsIAtom *aPropertyName, void *aPropertyValue, void *aData) { AnimationPlayerCollection* collection = static_cast(aPropertyValue); #ifdef DEBUG NS_ABORT_IF_FALSE(!collection->mCalledPropertyDtor, "can't call dtor twice"); collection->mCalledPropertyDtor = true; #endif delete collection; } void AnimationPlayerCollection::Tick() { for (size_t playerIdx = 0, playerEnd = mPlayers.Length(); playerIdx != playerEnd; playerIdx++) { mPlayers[playerIdx]->Tick(); } } void AnimationPlayerCollection::EnsureStyleRuleFor(TimeStamp aRefreshTime, EnsureStyleRuleFlags aFlags) { if (!mNeedsRefreshes) { mStyleRuleRefreshTime = aRefreshTime; return; } // If we're performing animations on the compositor thread, then we can skip // most of the work in this method. But even if we are throttled, then we // have to do the work if an animation is ending in order to get correct end // of animation behaviour (the styles of the animation disappear, or the fill // mode behaviour). This loop checks for any finishing animations and forces // the style recalculation if we find any. if (aFlags == EnsureStyleRule_IsThrottled) { for (size_t playerIdx = mPlayers.Length(); playerIdx-- != 0; ) { AnimationPlayer* player = mPlayers[playerIdx]; // Skip player with no source content, finished transitions, or animations // whose @keyframes rule is empty. if (!player->GetSource() || player->GetSource()->IsFinishedTransition() || player->GetSource()->Properties().IsEmpty()) { continue; } // The GetComputedTiming() call here handles pausing. But: // FIXME: avoid recalculating every time when paused. ComputedTiming computedTiming = player->GetSource()->GetComputedTiming(); // XXX We shouldn't really be using LastNotification() as a general // indicator that the animation has finished, it should be reserved for // events. If we use it differently in the future this use might need // changing. if (!player->mIsRunningOnCompositor || (computedTiming.mPhase == ComputedTiming::AnimationPhase_After && player->GetSource()->LastNotification() != Animation::LAST_NOTIFICATION_END)) { aFlags = EnsureStyleRule_IsNotThrottled; break; } } } if (aFlags == EnsureStyleRule_IsThrottled) { return; } // mStyleRule may be null and valid, if we have no style to apply. if (mStyleRuleRefreshTime.IsNull() || mStyleRuleRefreshTime != aRefreshTime) { mStyleRuleRefreshTime = aRefreshTime; mStyleRule = nullptr; // We'll set mNeedsRefreshes to true below in all cases where we need them. mNeedsRefreshes = false; // FIXME(spec): assume that properties in higher animations override // those in lower ones. // Therefore, we iterate from last animation to first. nsCSSPropertySet properties; for (size_t playerIdx = mPlayers.Length(); playerIdx-- != 0; ) { AnimationPlayer* player = mPlayers[playerIdx]; if (!player->GetSource() || player->GetSource()->IsFinishedTransition()) { continue; } // The GetComputedTiming() call here handles pausing. But: // FIXME: avoid recalculating every time when paused. ComputedTiming computedTiming = player->GetSource()->GetComputedTiming(); if ((computedTiming.mPhase == ComputedTiming::AnimationPhase_Before || computedTiming.mPhase == ComputedTiming::AnimationPhase_Active) && !player->IsPaused()) { mNeedsRefreshes = true; } // If the time fraction is null, we don't have fill data for the current // time so we shouldn't animate. // Likewise, if the player has no source content. if (computedTiming.mTimeFraction == ComputedTiming::kNullTimeFraction) { continue; } NS_ABORT_IF_FALSE(0.0 <= computedTiming.mTimeFraction && computedTiming.mTimeFraction <= 1.0, "timing fraction should be in [0-1]"); const Animation* anim = player->GetSource(); for (size_t propIdx = 0, propEnd = anim->Properties().Length(); propIdx != propEnd; ++propIdx) { const AnimationProperty& prop = anim->Properties()[propIdx]; NS_ABORT_IF_FALSE(prop.mSegments[0].mFromKey == 0.0, "incorrect first from key"); NS_ABORT_IF_FALSE(prop.mSegments[prop.mSegments.Length() - 1].mToKey == 1.0, "incorrect last to key"); if (properties.HasProperty(prop.mProperty)) { // A later animation already set this property. continue; } properties.AddProperty(prop.mProperty); NS_ABORT_IF_FALSE(prop.mSegments.Length() > 0, "property should not be in animations if it " "has no segments"); // FIXME: Maybe cache the current segment? const AnimationPropertySegment *segment = prop.mSegments.Elements(), *segmentEnd = segment + prop.mSegments.Length(); while (segment->mToKey < computedTiming.mTimeFraction) { NS_ABORT_IF_FALSE(segment->mFromKey < segment->mToKey, "incorrect keys"); ++segment; if (segment == segmentEnd) { NS_ABORT_IF_FALSE(false, "incorrect time fraction"); break; // in order to continue in outer loop (just below) } NS_ABORT_IF_FALSE(segment->mFromKey == (segment-1)->mToKey, "incorrect keys"); } if (segment == segmentEnd) { continue; } NS_ABORT_IF_FALSE(segment->mFromKey < segment->mToKey, "incorrect keys"); NS_ABORT_IF_FALSE(segment >= prop.mSegments.Elements() && size_t(segment - prop.mSegments.Elements()) < prop.mSegments.Length(), "out of array bounds"); if (!mStyleRule) { // Allocate the style rule now that we know we have animation data. mStyleRule = new css::AnimValuesStyleRule(); } double positionInSegment = (computedTiming.mTimeFraction - segment->mFromKey) / (segment->mToKey - segment->mFromKey); double valuePosition = segment->mTimingFunction.GetValue(positionInSegment); StyleAnimationValue *val = mStyleRule->AddEmptyValue(prop.mProperty); #ifdef DEBUG bool result = #endif StyleAnimationValue::Interpolate(prop.mProperty, segment->mFromValue, segment->mToValue, valuePosition, *val); NS_ABORT_IF_FALSE(result, "interpolate must succeed now"); } } } } bool AnimationPlayerCollection::CanThrottleTransformChanges(TimeStamp aTime) { if (!nsLayoutUtils::AreAsyncAnimationsEnabled()) { return false; } // If we know that the animation cannot cause overflow, // we can just disable flushes for this animation. // If we don't show scrollbars, we don't care about overflow. if (LookAndFeel::GetInt(LookAndFeel::eIntID_ShowHideScrollbars) == 0) { return true; } // If this animation can cause overflow, we can throttle some of the ticks. if ((aTime - mStyleRuleRefreshTime) < TimeDuration::FromMilliseconds(200)) { return true; } // If the nearest scrollable ancestor has overflow:hidden, // we don't care about overflow. nsIScrollableFrame* scrollable = nsLayoutUtils::GetNearestScrollableFrame( nsLayoutUtils::GetStyleFrame(mElement)); if (!scrollable) { return true; } ScrollbarStyles ss = scrollable->GetScrollbarStyles(); if (ss.mVertical == NS_STYLE_OVERFLOW_HIDDEN && ss.mHorizontal == NS_STYLE_OVERFLOW_HIDDEN && scrollable->GetLogicalScrollPosition() == nsPoint(0, 0)) { return true; } return false; } bool AnimationPlayerCollection::CanThrottleAnimation(TimeStamp aTime) { nsIFrame* frame = nsLayoutUtils::GetStyleFrame(mElement); if (!frame) { return false; } bool hasTransform = HasAnimationOfProperty(eCSSProperty_transform); bool hasOpacity = HasAnimationOfProperty(eCSSProperty_opacity); if (hasOpacity) { Layer* layer = FrameLayerBuilder::GetDedicatedLayer( frame, nsDisplayItem::TYPE_OPACITY); if (!layer || mAnimationGeneration > layer->GetAnimationGeneration()) { return false; } } if (!hasTransform) { return true; } Layer* layer = FrameLayerBuilder::GetDedicatedLayer( frame, nsDisplayItem::TYPE_TRANSFORM); if (!layer || mAnimationGeneration > layer->GetAnimationGeneration()) { return false; } return CanThrottleTransformChanges(aTime); } void AnimationPlayerCollection::UpdateAnimationGeneration( nsPresContext* aPresContext) { mAnimationGeneration = aPresContext->RestyleManager()->GetAnimationGeneration(); } bool AnimationPlayerCollection::HasCurrentAnimations() const { for (size_t playerIdx = mPlayers.Length(); playerIdx-- != 0; ) { if (mPlayers[playerIdx]->HasCurrentSource()) { return true; } } return false; } bool AnimationPlayerCollection::HasCurrentAnimationsForProperty(nsCSSProperty aProperty) const { for (size_t playerIdx = mPlayers.Length(); playerIdx-- != 0; ) { const Animation* anim = mPlayers[playerIdx]->GetSource(); if (anim && anim->IsCurrent() && anim->HasAnimationOfProperty(aProperty)) { return true; } } return false; } }