blob: 30d53abb1b7503a853f2274c91a50fd0f5ad171d [file] [log] [blame]
/*
* Copyright (C) 2013 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef THIRD_PARTY_BLINK_RENDERER_CORE_ANIMATION_COMPOSITOR_ANIMATIONS_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_ANIMATION_COMPOSITOR_ANIMATIONS_H_
#include <memory>
#include "third_party/blink/renderer/core/animation/effect_model.h"
#include "third_party/blink/renderer/core/animation/timing.h"
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/platform/animation/timing_function.h"
#include "third_party/blink/renderer/platform/graphics/compositor_element_id.h"
#include "third_party/blink/renderer/platform/wtf/allocator.h"
#include "third_party/blink/renderer/platform/wtf/vector.h"
namespace blink {
class Animation;
class CompositorAnimation;
class Element;
class KeyframeEffectModelBase;
class CORE_EXPORT CompositorAnimations {
STATIC_ONLY(CompositorAnimations);
public:
struct FailureCode {
const bool can_composite;
const bool web_developer_actionable;
const String reason;
static FailureCode None() { return FailureCode(true, false, String()); }
static FailureCode Actionable(const String& reason) {
return FailureCode(false, true, reason);
}
static FailureCode NonActionable(const String& reason) {
return FailureCode(false, false, reason);
}
bool Ok() const { return can_composite; }
bool operator==(const FailureCode& other) const {
return can_composite == other.can_composite &&
web_developer_actionable == other.web_developer_actionable &&
reason == other.reason;
}
private:
FailureCode(bool can_composite,
bool web_developer_actionable,
const String& reason)
: can_composite(can_composite),
web_developer_actionable(web_developer_actionable),
reason(reason) {}
};
static FailureCode CheckCanStartAnimationOnCompositor(
const Timing&,
const Element&,
const Animation*,
const EffectModel&,
const base::Optional<CompositorElementIdSet>& composited_element_ids,
double animation_playback_rate);
static void CancelIncompatibleAnimationsOnCompositor(const Element&,
const Animation&,
const EffectModel&);
static void StartAnimationOnCompositor(
const Element&,
int group,
base::Optional<double> start_time,
double time_offset,
const Timing&,
const Animation*,
CompositorAnimation&,
const EffectModel&,
Vector<int>& started_keyframe_model_ids,
double animation_playback_rate);
static void CancelAnimationOnCompositor(const Element&,
CompositorAnimation*,
int id);
static void PauseAnimationForTestingOnCompositor(const Element&,
const Animation&,
int id,
double pause_time);
static void AttachCompositedLayers(Element&, CompositorAnimation*);
struct CompositorTiming {
Timing::PlaybackDirection direction;
AnimationTimeDelta scaled_duration;
double scaled_time_offset;
double adjusted_iteration_count;
double playback_rate;
Timing::FillMode fill_mode;
double iteration_start;
};
static bool ConvertTimingForCompositor(const Timing&,
double time_offset,
CompositorTiming& out,
double animation_playback_rate);
static void GetAnimationOnCompositor(
const Element&,
const Timing&,
int group,
base::Optional<double> start_time,
double time_offset,
const KeyframeEffectModelBase&,
Vector<std::unique_ptr<CompositorKeyframeModel>>& animations,
double animation_playback_rate);
private:
static FailureCode CheckCanStartEffectOnCompositor(
const Timing&,
const Element&,
const Animation*,
const EffectModel&,
const base::Optional<CompositorElementIdSet>& composited_element_ids,
double animation_playback_rate);
static FailureCode CheckCanStartElementOnCompositor(const Element&);
friend class AnimationCompositorAnimationsTest;
FRIEND_TEST_ALL_PREFIXES(AnimationCompositorAnimationsTest,
CanStartElementOnCompositorTransformSPv2);
FRIEND_TEST_ALL_PREFIXES(AnimationCompositorAnimationsTest,
CanStartElementOnCompositorEffectSPv2);
FRIEND_TEST_ALL_PREFIXES(AnimationCompositorAnimationsTest,
CanStartElementOnCompositorEffect);
FRIEND_TEST_ALL_PREFIXES(AnimationCompositorAnimationsTest,
CannotStartElementOnCompositorEffectSVG);
FRIEND_TEST_ALL_PREFIXES(AnimationCompositorAnimationsTest,
CancelIncompatibleCompositorAnimations);
};
} // namespace blink
#endif