Animation.cpp 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864
  1. /*
  2. * Copyright (c) 2023-2024, Matthew Olsson <mattco@serenityos.org>.
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <AK/TemporaryChange.h>
  7. #include <LibWeb/Animations/Animation.h>
  8. #include <LibWeb/Animations/AnimationEffect.h>
  9. #include <LibWeb/Animations/AnimationPlaybackEvent.h>
  10. #include <LibWeb/Animations/DocumentTimeline.h>
  11. #include <LibWeb/Bindings/Intrinsics.h>
  12. #include <LibWeb/DOM/Document.h>
  13. #include <LibWeb/HTML/Scripting/TemporaryExecutionContext.h>
  14. #include <LibWeb/HTML/Window.h>
  15. #include <LibWeb/WebIDL/ExceptionOr.h>
  16. #include <LibWeb/WebIDL/Promise.h>
  17. namespace Web::Animations {
  18. JS_DEFINE_ALLOCATOR(Animation);
  19. // https://www.w3.org/TR/web-animations-1/#dom-animation-animation
  20. JS::NonnullGCPtr<Animation> Animation::create(JS::Realm& realm, JS::GCPtr<AnimationEffect> effect, JS::GCPtr<AnimationTimeline> timeline)
  21. {
  22. auto& vm = realm.vm();
  23. // 1. Let animation be a new Animation object.
  24. auto animation = realm.heap().allocate<Animation>(realm, realm);
  25. // 2. Run the procedure to set the timeline of an animation on animation passing timeline as the new timeline or, if
  26. // a timeline argument is missing, passing the default document timeline of the Document associated with the
  27. // Window that is the current global object.
  28. if (vm.argument_count() < 2) {
  29. auto& window = verify_cast<HTML::Window>(HTML::current_global_object());
  30. timeline = window.associated_document().timeline();
  31. }
  32. animation->set_timeline(timeline);
  33. // 3. Run the procedure to set the associated effect of an animation on animation passing source as the new effect.
  34. animation->set_effect(effect);
  35. return animation;
  36. }
  37. WebIDL::ExceptionOr<JS::NonnullGCPtr<Animation>> Animation::construct_impl(JS::Realm& realm, JS::GCPtr<AnimationEffect> effect, JS::GCPtr<AnimationTimeline> timeline)
  38. {
  39. return create(realm, effect, timeline);
  40. }
  41. // https://www.w3.org/TR/web-animations-1/#animation-set-the-associated-effect-of-an-animation
  42. void Animation::set_effect(JS::GCPtr<AnimationEffect> new_effect)
  43. {
  44. // Setting this attribute updates the object’s associated effect using the procedure to set the associated effect of
  45. // an animation.
  46. // 1. Let old effect be the current associated effect of animation, if any.
  47. auto old_effect = m_effect;
  48. // 2. If new effect is the same object as old effect, abort this procedure.
  49. if (new_effect == old_effect)
  50. return;
  51. // 3. If animation has a pending pause task, reschedule that task to run as soon as animation is ready.
  52. // 4. If animation has a pending play task, reschedule that task to run as soon as animation is ready to play ne
  53. // effect.
  54. // Note: There is no real difference between "pending" and "as soon as possible", so this step is a no-op.
  55. // 5. If new effect is not null and if new effect is the associated effect of another animation, previous animation,
  56. // run the procedure to set the associated effect of an animation (this procedure) on previous animation passing
  57. // null as new effect.
  58. if (new_effect && new_effect->associated_animation() != this) {
  59. if (auto animation = new_effect->associated_animation())
  60. animation->set_effect({});
  61. }
  62. // 6. Let the associated effect of animation be new effect.
  63. if (new_effect)
  64. new_effect->set_associated_animation(this);
  65. if (m_effect)
  66. m_effect->set_associated_animation({});
  67. m_effect = new_effect;
  68. // 7. Run the procedure to update an animation’s finished state for animation with the did seek flag set to false,
  69. // and the synchronously notify flag set to false.
  70. update_finished_state(DidSeek::No, SynchronouslyNotify::No);
  71. }
  72. // https://www.w3.org/TR/web-animations-1/#animation-set-the-timeline-of-an-animation
  73. void Animation::set_timeline(JS::GCPtr<AnimationTimeline> new_timeline)
  74. {
  75. // Setting this attribute updates the object’s timeline using the procedure to set the timeline of an animation.
  76. // 1. Let old timeline be the current timeline of animation, if any.
  77. auto old_timeline = m_timeline;
  78. // 2. If new timeline is the same object as old timeline, abort this procedure.
  79. if (new_timeline == old_timeline)
  80. return;
  81. // 3. Let the timeline of animation be new timeline.
  82. if (m_timeline)
  83. m_timeline->disassociate_with_animation(*this);
  84. m_timeline = new_timeline;
  85. m_timeline->associate_with_animation(*this);
  86. // 4. If the start time of animation is resolved, make animation’s hold time unresolved.
  87. if (m_start_time.has_value())
  88. m_hold_time = {};
  89. // 5. Run the procedure to update an animation’s finished state for animation with the did seek flag set to false,
  90. // and the synchronously notify flag set to false.
  91. update_finished_state(DidSeek::No, SynchronouslyNotify::No);
  92. }
  93. // https://www.w3.org/TR/web-animations-1/#dom-animation-starttime
  94. // https://www.w3.org/TR/web-animations-1/#set-the-start-time
  95. void Animation::set_start_time(Optional<double> const& new_start_time)
  96. {
  97. // Setting this attribute updates the start time using the procedure to set the start time of this object to the new
  98. // value.
  99. // 1. Let timeline time be the current time value of the timeline that animation is associated with. If there is no
  100. // timeline associated with animation or the associated timeline is inactive, let the timeline time be
  101. // unresolved.
  102. auto timeline_time = m_timeline && !m_timeline->is_inactive() ? m_timeline->current_time() : Optional<double> {};
  103. // 2. If timeline time is unresolved and new start time is resolved, make animation’s hold time unresolved.
  104. if (!timeline_time.has_value() && new_start_time.has_value())
  105. m_hold_time = {};
  106. // 3. Let previous current time be animation’s current time.
  107. auto previous_current_time = current_time();
  108. // 4. Apply any pending playback rate on animation.
  109. apply_any_pending_playback_rate();
  110. // 5. Set animation’s start time to new start time.
  111. m_start_time = new_start_time;
  112. // 6. Update animation’s hold time based on the first matching condition from the following,
  113. // -> If new start time is resolved,
  114. if (new_start_time.has_value()) {
  115. // If animation’s playback rate is not zero, make animation’s hold time unresolved.
  116. if (m_playback_rate != 0.0)
  117. m_hold_time = {};
  118. }
  119. // -> Otherwise (new start time is unresolved),
  120. else {
  121. // Set animation’s hold time to previous current time even if previous current time is unresolved.
  122. m_hold_time = previous_current_time;
  123. }
  124. // 7. If animation has a pending play task or a pending pause task, cancel that task and resolve animation’s current
  125. // ready promise with animation.
  126. if (pending()) {
  127. m_pending_play_task = TaskState::None;
  128. m_pending_pause_task = TaskState::None;
  129. WebIDL::resolve_promise(realm(), current_ready_promise(), this);
  130. }
  131. // 8. Run the procedure to update an animation’s finished state for animation with the did seek flag set to true,
  132. // and the synchronously notify flag set to false.
  133. update_finished_state(DidSeek::Yes, SynchronouslyNotify::No);
  134. }
  135. // https://www.w3.org/TR/web-animations-1/#animation-current-time
  136. Optional<double> Animation::current_time() const
  137. {
  138. // The current time is calculated from the first matching condition from below:
  139. // -> If the animation’s hold time is resolved,
  140. if (m_hold_time.has_value()) {
  141. // The current time is the animation’s hold time.
  142. return m_hold_time.value();
  143. }
  144. // -> If any of the following are true:
  145. // - the animation has no associated timeline, or
  146. // - the associated timeline is inactive, or
  147. // - the animation’s start time is unresolved.
  148. if (!m_timeline || m_timeline->is_inactive() || !m_start_time.has_value()) {
  149. // The current time is an unresolved time value.
  150. return {};
  151. }
  152. // -> Otherwise,
  153. // current time = (timeline time - start time) × playback rate
  154. // Where timeline time is the current time value of the associated timeline. The playback rate value is defined
  155. // in §4.4.15 Speed control.
  156. return (m_timeline->current_time().value() - m_start_time.value()) * playback_rate();
  157. }
  158. // https://www.w3.org/TR/web-animations-1/#animation-set-the-current-time
  159. WebIDL::ExceptionOr<void> Animation::set_current_time(Optional<double> const& seek_time)
  160. {
  161. // 1. Run the steps to silently set the current time of animation to seek time.
  162. TRY(silently_set_current_time(seek_time));
  163. // 2. If animation has a pending pause task, synchronously complete the pause operation by performing the following
  164. // steps:
  165. if (m_pending_pause_task == TaskState::Scheduled) {
  166. // 1. Set animation’s hold time to seek time.
  167. m_hold_time = seek_time;
  168. // 2. Apply any pending playback rate to animation.
  169. apply_any_pending_playback_rate();
  170. // 3. Make animation’s start time unresolved.
  171. m_start_time = {};
  172. // 4. Cancel the pending pause task.
  173. m_pending_pause_task = TaskState::None;
  174. // 5 Resolve animation’s current ready promise with animation.
  175. WebIDL::resolve_promise(realm(), current_ready_promise(), this);
  176. }
  177. // 3. Run the procedure to update an animation’s finished state for animation with the did seek flag set to true,
  178. // and the synchronously notify flag set to false.
  179. update_finished_state(DidSeek::Yes, SynchronouslyNotify::No);
  180. return {};
  181. }
  182. // https://www.w3.org/TR/web-animations-1/#dom-animation-playbackrate
  183. // https://www.w3.org/TR/web-animations-1/#set-the-playback-rate
  184. WebIDL::ExceptionOr<void> Animation::set_playback_rate(double new_playback_rate)
  185. {
  186. // Setting this attribute follows the procedure to set the playback rate of this object to the new value.
  187. // 1. Clear any pending playback rate on animation.
  188. m_pending_playback_rate = {};
  189. // 2. Let previous time be the value of the current time of animation before changing the playback rate.
  190. auto previous_time = current_time();
  191. // 3. Let previous playback rate be the current effective playback rate of animation.
  192. auto previous_playback_rate = playback_rate();
  193. // 4. Set the playback rate to new playback rate.
  194. m_playback_rate = new_playback_rate;
  195. // 5. Perform the steps corresponding to the first matching condition from the following, if any:
  196. // -> If animation is associated with a monotonically increasing timeline and the previous time is resolved,
  197. if (m_timeline && m_timeline->is_monotonically_increasing() && previous_time.has_value()) {
  198. // set the current time of animation to previous time.
  199. TRY(set_current_time(previous_time));
  200. }
  201. // -> If animation is associated with a non-null timeline that is not monotonically increasing, the start time of
  202. // animation is resolved, associated effect end is not infinity, and either:
  203. // - the previous playback rate < 0 and the new playback rate ≥ 0, or
  204. // - the previous playback rate ≥ 0 and the new playback rate < 0,
  205. else if (m_timeline && !m_timeline->is_monotonically_increasing() && m_start_time.has_value() && !isinf(associated_effect_end()) && ((previous_playback_rate < 0.0 && new_playback_rate >= 0.0) || (previous_playback_rate >= 0 && new_playback_rate < 0))) {
  206. // Set animation’s start time to the result of evaluating associated effect end - start time for animation.
  207. m_start_time = associated_effect_end() - m_start_time.value();
  208. }
  209. return {};
  210. }
  211. // https://www.w3.org/TR/web-animations-1/#animation-play-state
  212. Bindings::AnimationPlayState Animation::play_state() const
  213. {
  214. // The play state of animation, animation, at a given moment is the state corresponding to the first matching
  215. // condition from the following:
  216. // -> All of the following conditions are true:
  217. // - The current time of animation is unresolved, and
  218. // - the start time of animation is unresolved, and
  219. // - animation does not have either a pending play task or a pending pause task,
  220. auto current_time = this->current_time();
  221. if (!current_time.has_value() && !m_start_time.has_value() && !pending()) {
  222. // → idle
  223. return Bindings::AnimationPlayState::Idle;
  224. }
  225. // -> Either of the following conditions are true:
  226. // - animation has a pending pause task, or
  227. // - both the start time of animation is unresolved and it does not have a pending play task,
  228. if (m_pending_pause_task == TaskState::Scheduled || (!m_start_time.has_value() && m_pending_play_task == TaskState::None)) {
  229. // → paused
  230. return Bindings::AnimationPlayState::Paused;
  231. }
  232. // -> For animation, current time is resolved and either of the following conditions are true:
  233. // - animation’s effective playback rate > 0 and current time ≥ associated effect end; or
  234. // - animation’s effective playback rate < 0 and current time ≤ 0,
  235. auto effective_playback_rate = this->effective_playback_rate();
  236. if (current_time.has_value() && ((effective_playback_rate > 0.0 && current_time.value() >= associated_effect_end()) || (effective_playback_rate < 0.0 && current_time.value() <= 0.0))) {
  237. // → finished
  238. return Bindings::AnimationPlayState::Finished;
  239. }
  240. // -> Otherwise,
  241. // → running
  242. return Bindings::AnimationPlayState::Running;
  243. }
  244. // https://www.w3.org/TR/web-animations-1/#dom-animation-play
  245. WebIDL::ExceptionOr<void> Animation::play()
  246. {
  247. // Begins or resumes playback of the animation by running the procedure to play an animation passing true as the
  248. // value of the auto-rewind flag.
  249. return play_an_animation(AutoRewind::Yes);
  250. }
  251. // https://www.w3.org/TR/web-animations-1/#play-an-animation
  252. WebIDL::ExceptionOr<void> Animation::play_an_animation(AutoRewind auto_rewind)
  253. {
  254. // 1. Let aborted pause be a boolean flag that is true if animation has a pending pause task, and false otherwise.
  255. auto aborted_pause = m_pending_pause_task == TaskState::Scheduled;
  256. // 2. Let has pending ready promise be a boolean flag that is initially false.
  257. auto has_pending_ready_promise = false;
  258. // 3. Let seek time be a time value that is initially unresolved.
  259. Optional<double> seek_time;
  260. // 4. If the auto-rewind flag is true, perform the steps corresponding to the first matching condition from the
  261. // following, if any:
  262. if (auto_rewind == AutoRewind::Yes) {
  263. auto playback_rate = this->playback_rate();
  264. auto current_time = this->current_time();
  265. auto associated_effect_end = this->associated_effect_end();
  266. // -> If animation’s effective playback rate ≥ 0, and animation’s current time is either:
  267. // - unresolved, or
  268. // - less than zero, or
  269. // - greater than or equal to associated effect end,
  270. if (playback_rate >= 0.0 && (!current_time.has_value() || current_time.value() < 0.0 || current_time.value() >= associated_effect_end)) {
  271. // Set seek time to zero.
  272. seek_time = 0.0;
  273. }
  274. // -> If animation’s effective playback rate < 0, and animation’s current time is either:
  275. // - unresolved, or
  276. // - less than or equal to zero, or
  277. // - greater than associated effect end,
  278. else if (playback_rate < 0.0 && (!current_time.has_value() || current_time.value() <= 0.0 || current_time.value() > associated_effect_end)) {
  279. // -> If associated effect end is positive infinity,
  280. if (isinf(associated_effect_end) && associated_effect_end > 0.0) {
  281. // throw an "InvalidStateError" DOMException and abort these steps.
  282. return WebIDL::InvalidStateError::create(realm(), "Cannot rewind an animation with an infinite effect end"_fly_string);
  283. }
  284. // -> Otherwise,
  285. // Set seek time to animation’s associated effect end.
  286. seek_time = associated_effect_end;
  287. }
  288. }
  289. // 5. If the following three conditions are all satisfied:
  290. // - seek time is unresolved, and
  291. // - animation’s start time is unresolved, and
  292. // - animation’s current time is unresolved,
  293. if (!seek_time.has_value() && !m_start_time.has_value() && !current_time().has_value()) {
  294. // set seek time to zero.
  295. seek_time = 0.0;
  296. }
  297. // 6. Let has finite timeline be true if animation has an associated timeline that is not monotonically increasing.
  298. auto has_finite_timeline = m_timeline && !m_timeline->is_monotonically_increasing();
  299. // 7. If seek time is resolved,
  300. if (seek_time.has_value()) {
  301. // -> If has finite timeline is true,
  302. if (has_finite_timeline) {
  303. // 1. Set animation’s start time to seek time.
  304. m_start_time = seek_time;
  305. // 2. Let animation’s hold time be unresolved.
  306. m_hold_time = {};
  307. // 3. Apply any pending playback rate on animation.
  308. apply_any_pending_playback_rate();
  309. }
  310. // Otherwise,
  311. else {
  312. // Set animation’s hold time to seek time.
  313. m_hold_time = seek_time;
  314. }
  315. }
  316. // 8. If animation’s hold time is resolved, let its start time be unresolved.
  317. if (m_hold_time.has_value())
  318. m_start_time = {};
  319. // 9. If animation has a pending play task or a pending pause task,
  320. if (pending()) {
  321. // 1. Cancel that task.
  322. m_pending_play_task = TaskState::None;
  323. m_pending_pause_task = TaskState::None;
  324. // 2. Set has pending ready promise to true.
  325. has_pending_ready_promise = true;
  326. }
  327. // 10. If the following four conditions are all satisfied:
  328. // - animation’s hold time is unresolved, and
  329. // - seek time is unresolved, and
  330. // - aborted pause is false, and
  331. // - animation does not have a pending playback rate,
  332. if (!m_hold_time.has_value() && !seek_time.has_value() && !aborted_pause && !m_pending_playback_rate.has_value()) {
  333. // abort this procedure.
  334. return {};
  335. }
  336. // 11. If has pending ready promise is false, let animation’s current ready promise be a new promise in the relevant
  337. // Realm of animation.
  338. if (!has_pending_ready_promise)
  339. m_current_ready_promise = WebIDL::create_promise(realm());
  340. // 12. Schedule a task to run as soon as animation is ready. The task shall perform the following steps:
  341. //
  342. // Note: Steps omitted, set run_pending_play_task()
  343. //
  344. // So long as the above task is scheduled but has yet to run, animation is described as having a pending play
  345. // task. While the task is running, however, animation does not have a pending play task.
  346. //
  347. // If a user agent determines that animation is immediately ready, it may schedule the above task as a microtask
  348. // such that it runs at the next microtask checkpoint, but it must not perform the task synchronously.
  349. m_pending_play_task = TaskState::Scheduled;
  350. // 13. Run the procedure to update an animation’s finished state for animation with the did seek flag set to false,
  351. // and the synchronously notify flag set to false.
  352. update_finished_state(DidSeek::No, SynchronouslyNotify::No);
  353. return {};
  354. }
  355. // https://www.w3.org/TR/web-animations-1/#animation-time-to-timeline-time
  356. Optional<double> Animation::convert_an_animation_time_to_timeline_time(Optional<double> time) const
  357. {
  358. // 1. If time is unresolved, return time.
  359. if (!time.has_value())
  360. return time;
  361. // 2. If time is infinity, return an unresolved time value.
  362. if (isinf(time.value()))
  363. return {};
  364. // 3. If animation’s playback rate is zero, return an unresolved time value.
  365. if (m_playback_rate == 0.0)
  366. return {};
  367. // 4. If animation’s start time is unresolved, return an unresolved time value.
  368. if (!m_start_time.has_value())
  369. return {};
  370. // 5. Return the result of calculating: time × (1 / playback rate) + start time (where playback rate and start time
  371. // are the playback rate and start time of animation, respectively).
  372. return (time.value() * (1.0 / m_playback_rate)) + m_start_time.value();
  373. }
  374. // https://www.w3.org/TR/web-animations-1/#animation-time-to-origin-relative-time
  375. Optional<double> Animation::convert_a_timeline_time_to_an_origin_relative_time(Optional<double> time) const
  376. {
  377. // 1. Let timeline time be the result of converting time from an animation time to a timeline time.
  378. auto timeline_time = convert_an_animation_time_to_timeline_time(time);
  379. // 2. If timeline time is unresolved, return time.
  380. if (!timeline_time.has_value())
  381. return time;
  382. // 3. If animation is not associated with a timeline, return an unresolved time value.
  383. if (!m_timeline)
  384. return {};
  385. // 4. If animation is associated with an inactive timeline, return an unresolved time value.
  386. if (m_timeline->is_inactive())
  387. return {};
  388. // 5. If there is no procedure to convert a timeline time to an origin-relative time for the timeline associated
  389. // with animation, return an unresolved time value.
  390. if (!m_timeline->can_convert_a_timeline_time_to_an_origin_relative_time())
  391. return {};
  392. // 6. Return the result of converting timeline time to an origin-relative time using the procedure defined for the
  393. // timeline associated with animation.
  394. return m_timeline->convert_a_timeline_time_to_an_origin_relative_time(timeline_time);
  395. }
  396. // https://www.w3.org/TR/web-animations-1/#animation-document-for-timing
  397. JS::GCPtr<DOM::Document> Animation::document_for_timing() const
  398. {
  399. // An animation’s document for timing is the Document with which its timeline is associated. If an animation is not
  400. // associated with a timeline, or its timeline is not associated with a document, then it has no document for
  401. // timing.
  402. if (!m_timeline)
  403. return {};
  404. return m_timeline->associated_document();
  405. }
  406. void Animation::notify_timeline_time_did_change()
  407. {
  408. update_finished_state(DidSeek::No, SynchronouslyNotify::Yes);
  409. // Act on the pending play or pause task
  410. if (m_pending_pause_task == TaskState::Scheduled) {
  411. m_pending_pause_task = TaskState::None;
  412. // FIXME:
  413. // run_pending_pause_task();
  414. }
  415. if (m_pending_play_task == TaskState::Scheduled) {
  416. m_pending_play_task = TaskState::None;
  417. run_pending_play_task();
  418. }
  419. }
  420. void Animation::effect_timing_changed(Badge<AnimationEffect>)
  421. {
  422. update_finished_state(DidSeek::No, SynchronouslyNotify::Yes);
  423. }
  424. // https://www.w3.org/TR/web-animations-1/#associated-effect-end
  425. double Animation::associated_effect_end() const
  426. {
  427. // The associated effect end of an animation is equal to the end time of the animation’s associated effect. If the
  428. // animation has no associated effect, the associated effect end is zero.
  429. return m_effect ? m_effect->end_time() : 0.0;
  430. }
  431. // https://www.w3.org/TR/web-animations-1/#effective-playback-rate
  432. double Animation::effective_playback_rate() const
  433. {
  434. // The effective playback rate of an animation is its pending playback rate, if set, otherwise it is the animation’s
  435. // playback rate.
  436. return m_pending_playback_rate.has_value() ? m_pending_playback_rate.value() : m_playback_rate;
  437. }
  438. // https://www.w3.org/TR/web-animations-1/#apply-any-pending-playback-rate
  439. void Animation::apply_any_pending_playback_rate()
  440. {
  441. // 1. If animation does not have a pending playback rate, abort these steps.
  442. if (!m_pending_playback_rate.has_value())
  443. return;
  444. // 2. Set animation’s playback rate to its pending playback rate.
  445. m_playback_rate = m_pending_playback_rate.value();
  446. // 3. Clear animation’s pending playback rate.
  447. m_pending_playback_rate = {};
  448. }
  449. // https://www.w3.org/TR/web-animations-1/#animation-silently-set-the-current-time
  450. WebIDL::ExceptionOr<void> Animation::silently_set_current_time(Optional<double> seek_time)
  451. {
  452. // 1. If seek time is an unresolved time value, then perform the following steps.
  453. if (!seek_time.has_value()) {
  454. // 1. If the current time is resolved, then throw a TypeError.
  455. if (current_time().has_value()) {
  456. return WebIDL::SimpleException {
  457. WebIDL::SimpleExceptionType::TypeError,
  458. "Cannot change an animation's current time from a resolve value to an unresolved value"sv
  459. };
  460. }
  461. // 2. Abort these steps.
  462. return {};
  463. }
  464. // 2. Update either animation’s hold time or start time as follows:
  465. // -> If any of the following conditions are true:
  466. // - animation’s hold time is resolved, or
  467. // - animation’s start time is unresolved, or
  468. // - animation has no associated timeline or the associated timeline is inactive, or
  469. // - animation’s playback rate is 0,
  470. if (m_hold_time.has_value() || !m_start_time.has_value() || !m_timeline || m_timeline->is_inactive() || m_playback_rate == 0.0) {
  471. // Set animation’s hold time to seek time.
  472. m_hold_time = seek_time;
  473. }
  474. // -> Otherwise,
  475. else {
  476. // Set animation’s start time to the result of evaluating timeline time - (seek time / playback rate) where
  477. // timeline time is the current time value of timeline associated with animation.
  478. m_start_time = m_timeline->current_time().value() - (seek_time.value() / m_playback_rate);
  479. }
  480. // 3. If animation has no associated timeline or the associated timeline is inactive, make animation’s start time
  481. // unresolved.
  482. if (!m_timeline || m_timeline->is_inactive())
  483. m_start_time = {};
  484. // 4. Make animation’s previous current time unresolved.
  485. m_previous_current_time = {};
  486. return {};
  487. }
  488. // https://www.w3.org/TR/web-animations-1/#update-an-animations-finished-state
  489. void Animation::update_finished_state(DidSeek did_seek, SynchronouslyNotify synchronously_notify)
  490. {
  491. // 1. Let the unconstrained current time be the result of calculating the current time substituting an unresolved
  492. // time value for the hold time if did seek is false. If did seek is true, the unconstrained current time is
  493. // equal to the current time.
  494. //
  495. // Note: This is required to accommodate timelines that may change direction. Without this definition, a once-
  496. // finished animation would remain finished even when its timeline progresses in the opposite direction.
  497. Optional<double> unconstrained_current_time;
  498. if (did_seek == DidSeek::No) {
  499. TemporaryChange change(m_hold_time, {});
  500. unconstrained_current_time = current_time();
  501. } else {
  502. unconstrained_current_time = current_time();
  503. }
  504. // 2. If all three of the following conditions are true,
  505. // - the unconstrained current time is resolved, and
  506. // - animation’s start time is resolved, and
  507. // - animation does not have a pending play task or a pending pause task,
  508. if (unconstrained_current_time.has_value() && m_start_time.has_value() && !pending()) {
  509. // then update animation’s hold time based on the first matching condition for animation from below, if any:
  510. // -> If playback rate > 0 and unconstrained current time is greater than or equal to associated effect end,
  511. auto associated_effect_end = this->associated_effect_end();
  512. if (m_playback_rate > 0.0 && unconstrained_current_time.value() >= associated_effect_end) {
  513. // If did seek is true, let the hold time be the value of unconstrained current time.
  514. if (did_seek == DidSeek::Yes) {
  515. m_hold_time = unconstrained_current_time;
  516. }
  517. // If did seek is false, let the hold time be the maximum value of previous current time and associated
  518. // effect end. If the previous current time is unresolved, let the hold time be associated effect end.
  519. else if (m_previous_current_time.has_value()) {
  520. m_hold_time = max(m_previous_current_time.value(), associated_effect_end);
  521. } else {
  522. m_hold_time = associated_effect_end;
  523. }
  524. }
  525. // -> If playback rate < 0 and unconstrained current time is less than or equal to 0,
  526. else if (m_playback_rate < 0.0 && unconstrained_current_time.value() <= 0.0) {
  527. // If did seek is true, let the hold time be the value of unconstrained current time.
  528. if (did_seek == DidSeek::Yes) {
  529. m_hold_time = unconstrained_current_time;
  530. }
  531. // If did seek is false, let the hold time be the minimum value of previous current time and zero. If the
  532. // previous current time is unresolved, let the hold time be zero.
  533. else if (m_previous_current_time.has_value()) {
  534. m_hold_time = min(m_previous_current_time.value(), 0.0);
  535. } else {
  536. m_hold_time = 0.0;
  537. }
  538. }
  539. // -> If playback rate ≠ 0, and animation is associated with an active timeline,
  540. else if (m_playback_rate != 0.0 && m_timeline && !m_timeline->is_inactive()) {
  541. // Perform the following steps:
  542. // 1. If did seek is true and the hold time is resolved, let animation’s start time be equal to the result
  543. // of evaluating timeline time - (hold time / playback rate) where timeline time is the current time
  544. // value of timeline associated with animation.
  545. if (did_seek == DidSeek::Yes && m_hold_time.has_value())
  546. m_start_time = m_timeline->current_time().value() - (m_hold_time.value() / m_playback_rate);
  547. // 2. Let the hold time be unresolved.
  548. m_hold_time = {};
  549. }
  550. }
  551. // 3. Set the previous current time of animation be the result of calculating its current time.
  552. m_previous_current_time = current_time();
  553. // 4. Let current finished state be true if the play state of animation is finished. Otherwise, let it be false.
  554. auto current_finished_state = play_state() == Bindings::AnimationPlayState::Finished;
  555. // 5. If current finished state is true and the current finished promise is not yet resolved, perform the following
  556. // steps:
  557. if (current_finished_state && !m_current_finished_promise_resolved) {
  558. // 1. Let finish notification steps refer to the following procedure:
  559. JS::SafeFunction<void()> finish_notification_steps = [&]() {
  560. if (m_should_abort_finish_notification_microtask) {
  561. m_should_abort_finish_notification_microtask = false;
  562. m_has_finish_notification_microtask_scheduled = false;
  563. return;
  564. }
  565. // 1. If animation’s play state is not equal to finished, abort these steps.
  566. if (play_state() != Bindings::AnimationPlayState::Finished)
  567. return;
  568. // 2. Resolve animation’s current finished promise object with animation.
  569. WebIDL::resolve_promise(realm(), current_finished_promise(), this);
  570. m_current_finished_promise_resolved = true;
  571. // 3. Create an AnimationPlaybackEvent, finishEvent.
  572. // 4. Set finishEvent’s type attribute to finish.
  573. // 5. Set finishEvent’s currentTime attribute to the current time of animation.
  574. auto& realm = this->realm();
  575. AnimationPlaybackEventInit init;
  576. init.current_time = current_time();
  577. auto finish_event = heap().allocate<AnimationPlaybackEvent>(realm, realm, "finish"_fly_string, init);
  578. // 6. Set finishEvent’s timelineTime attribute to the current time of the timeline with which animation is
  579. // associated. If animation is not associated with a timeline, or the timeline is inactive, let
  580. // timelineTime be null.
  581. if (m_timeline && !m_timeline->is_inactive())
  582. finish_event->set_timeline_time(m_timeline->current_time());
  583. else
  584. finish_event->set_timeline_time({});
  585. // 7. If animation has a document for timing, then append finishEvent to its document for timing's pending
  586. // animation event queue along with its target, animation. For the scheduled event time, use the result
  587. // of converting animation’s associated effect end to an origin-relative time.
  588. if (auto document_for_timing = this->document_for_timing()) {
  589. document_for_timing->append_pending_animation_event({ .event = finish_event,
  590. .target = *this,
  591. .scheduled_event_time = convert_a_timeline_time_to_an_origin_relative_time(associated_effect_end()) });
  592. }
  593. // Otherwise, queue a task to dispatch finishEvent at animation. The task source for this task is the DOM
  594. // manipulation task source.
  595. else {
  596. HTML::queue_global_task(HTML::Task::Source::DOMManipulation, realm.global_object(), [this, finish_event]() {
  597. dispatch_event(finish_event);
  598. });
  599. }
  600. m_has_finish_notification_microtask_scheduled = false;
  601. };
  602. // 2. If synchronously notify is true, cancel any queued microtask to run the finish notification steps for this
  603. // animation, and run the finish notification steps immediately.
  604. if (synchronously_notify == SynchronouslyNotify::Yes) {
  605. m_should_abort_finish_notification_microtask = false;
  606. finish_notification_steps();
  607. m_should_abort_finish_notification_microtask = true;
  608. }
  609. // Otherwise, if synchronously notify is false, queue a microtask to run finish notification steps for
  610. // animation unless there is already a microtask queued to run those steps for animation.
  611. else {
  612. if (!m_has_finish_notification_microtask_scheduled)
  613. HTML::queue_a_microtask({}, move(finish_notification_steps));
  614. m_has_finish_notification_microtask_scheduled = true;
  615. m_should_abort_finish_notification_microtask = false;
  616. }
  617. }
  618. // 6. If current finished state is false and animation’s current finished promise is already resolved, set
  619. // animation’s current finished promise to a new promise in the relevant Realm of animation.
  620. if (!current_finished_state && m_current_finished_promise_resolved) {
  621. m_current_finished_promise = WebIDL::create_promise(realm());
  622. m_current_finished_promise_resolved = false;
  623. }
  624. // Invalidate the style of our target element, if applicable
  625. if (m_effect) {
  626. if (auto target = m_effect->target())
  627. target->invalidate_style();
  628. }
  629. }
  630. // Step 12 of https://www.w3.org/TR/web-animations-1/#playing-an-animation-section
  631. void Animation::run_pending_play_task()
  632. {
  633. // 1. Assert that at least one of animation’s start time or hold time is resolved.
  634. VERIFY(m_start_time.has_value() || m_hold_time.has_value());
  635. // 2. Let ready time be the time value of the timeline associated with animation at the moment when animation became
  636. // ready.
  637. // FIXME: Ideally we would save the time before the update_finished_state call in play_an_animation() and use that
  638. // as the ready time, as step 2 indicates, however at that point the timeline will not have had it's current
  639. // time updated by the Document, so the time we would save would be incorrect if there are no other
  640. // animations running.
  641. auto ready_time = m_timeline->current_time();
  642. // Note: The timeline being active is a precondition for this method to be called
  643. VERIFY(ready_time.has_value());
  644. // 3. Perform the steps corresponding to the first matching condition below, if any:
  645. // -> If animation’s hold time is resolved,
  646. if (m_hold_time.has_value()) {
  647. // 1. Apply any pending playback rate on animation.
  648. apply_any_pending_playback_rate();
  649. // 2. Let new start time be the result of evaluating ready time - hold time / playback rate for animation. If
  650. // the playback rate is zero, let new start time be simply ready time.
  651. auto new_start_time = m_playback_rate != 0.0 ? ready_time.value() - (m_hold_time.value() / m_playback_rate) : ready_time;
  652. // 3. Set the start time of animation to new start time.
  653. m_start_time = new_start_time;
  654. // 4. If animation’s playback rate is not 0, make animation’s hold time unresolved.
  655. if (m_playback_rate != 0.0)
  656. m_hold_time = {};
  657. }
  658. // -> If animation’s start time is resolved and animation has a pending playback rate,
  659. else if (m_start_time.has_value() && m_pending_playback_rate.has_value()) {
  660. // 1. Let current time to match be the result of evaluating (ready time - start time) × playback rate for
  661. // animation.
  662. auto current_time_to_match = (ready_time.value() - m_start_time.value()) * m_playback_rate;
  663. // 2. Apply any pending playback rate on animation.
  664. apply_any_pending_playback_rate();
  665. // 3. If animation’s playback rate is zero, let animation’s hold time be current time to match.
  666. if (m_playback_rate == 0.0)
  667. m_hold_time = current_time_to_match;
  668. // 4. Let new start time be the result of evaluating ready time - current time to match / playback rate for
  669. // animation. If the playback rate is zero, let new start time be simply ready time.
  670. auto new_start_time = m_playback_rate != 0.0 ? ready_time.value() - (current_time_to_match / m_playback_rate) : ready_time;
  671. // 5. Set the start time of animation to new start time.
  672. m_start_time = new_start_time;
  673. }
  674. // 4. Resolve animation’s current ready promise with animation.
  675. HTML::TemporaryExecutionContext execution_context { Bindings::host_defined_environment_settings_object(realm()) };
  676. WebIDL::resolve_promise(realm(), current_ready_promise(), this);
  677. // 5. Run the procedure to update an animation’s finished state for animation with the did seek flag set to false,
  678. // and the synchronously notify flag set to false.
  679. update_finished_state(DidSeek::No, SynchronouslyNotify::No);
  680. }
  681. void Animation::run_pending_pause_task()
  682. {
  683. // FIXME: Implement
  684. }
  685. JS::NonnullGCPtr<WebIDL::Promise> Animation::current_ready_promise() const
  686. {
  687. if (!m_current_ready_promise) {
  688. // The current ready promise is initially a resolved Promise created using the procedure to create a new
  689. // resolved Promise with the animation itself as its value and created in the relevant Realm of the animation.
  690. m_current_ready_promise = WebIDL::create_resolved_promise(realm(), this);
  691. }
  692. return *m_current_ready_promise;
  693. }
  694. JS::NonnullGCPtr<WebIDL::Promise> Animation::current_finished_promise() const
  695. {
  696. if (!m_current_finished_promise) {
  697. // The current finished promise is initially a pending Promise object.
  698. m_current_finished_promise = WebIDL::create_promise(realm());
  699. }
  700. return *m_current_finished_promise;
  701. }
  702. Animation::Animation(JS::Realm& realm)
  703. : DOM::EventTarget(realm)
  704. {
  705. }
  706. void Animation::initialize(JS::Realm& realm)
  707. {
  708. Base::initialize(realm);
  709. set_prototype(&Bindings::ensure_web_prototype<Bindings::AnimationPrototype>(realm, "Animation"_fly_string));
  710. }
  711. void Animation::visit_edges(Cell::Visitor& visitor)
  712. {
  713. Base::visit_edges(visitor);
  714. visitor.visit(m_effect);
  715. visitor.visit(m_timeline);
  716. visitor.visit(m_current_ready_promise);
  717. visitor.visit(m_current_finished_promise);
  718. }
  719. }