avm1: Adjust clip removal logic for rewinds

Co-authored-by: Mike Welsh <mwelsh@gmail.com>

Author: jarca0123

core/src/avm1/globals/movie_clip.rs

@@ -799,6 +799,7 @@ fn attach_movie<'gc>(
         .library_for_movie(movie_clip.movie())
         .and_then(|l| l.instantiate_by_export_name(export_name, activation.gc()))
     {
+        new_clip.set_placed_by_avm1_script(true);
         // Set name and attach to parent.
         new_clip.set_name(activation.gc(), new_instance_name);
         movie_clip.replace_at_depth(activation.context, new_clip, depth);
@@ -840,6 +841,7 @@ fn create_empty_movie_clip<'gc>(
     // Create empty movie clip.
     let swf_movie = movie_clip.movie();
     let new_clip = MovieClip::new(swf_movie, activation.gc());
+    new_clip.set_placed_by_avm1_script(true);
 
     // Set name and attach to parent.
     new_clip.set_name(activation.gc(), new_instance_name);
@@ -928,14 +930,14 @@ fn duplicate_movie_clip<'gc>(
     // `duplicateMovieClip` method uses biased depth compared to `CloneSprite`.
     let depth = depth.wrapping_add(AVM_DEPTH_BIAS);
 
-    let new_clip = clone_sprite(movie_clip, activation.context, name, depth, init_object);
-
-    // On SWF<6 undefined is returned.
-    if activation.swf_version() < 6 {
-        return Ok(Value::Undefined);
+    if let Some(new_clip) = clone_sprite(movie_clip, activation.context, name, depth, init_object) {
+        // On SWF<6 undefined is returned.
+        if activation.swf_version() < 6 {
+            return Ok(Value::Undefined);
+        }
+        return Ok(new_clip.object());
     }
-
-    Ok(new_clip.map_or(Value::Undefined, |clip| clip.object()))
+    Ok(Value::Undefined)
 }
 
 pub fn clone_sprite<'gc>(
@@ -973,7 +975,7 @@ pub fn clone_sprite<'gc>(
     // Set name and attach to parent.
     new_clip.set_name(context.gc(), target);
     parent.replace_at_depth(context, new_clip.into(), depth);
-
+    new_clip.set_placed_by_avm1_script(true);
     // Copy display properties from previous clip to new clip.
     new_clip.set_matrix(movie_clip.base().matrix());
     new_clip.set_color_transform(movie_clip.base().color_transform());

core/src/display_object.rs

@@ -199,6 +199,7 @@ pub struct DisplayObjectBase<'gc> {
     parent: Lock<Option<DisplayObject<'gc>>>,
     place_frame: Cell<u16>,
     depth: Cell<Depth>,
+    ratio: Cell<u16>,
     name: Lock<Option<AvmString<'gc>>>,
     clip_depth: Cell<Depth>,
 
@@ -277,6 +278,7 @@ impl Default for DisplayObjectBase<'_> {
             parent: Default::default(),
             place_frame: Default::default(),
             depth: Default::default(),
+            ratio: Default::default(),
             name: Lock::new(None),
             clip_depth: Default::default(),
             matrix: Default::default(),
@@ -722,6 +724,14 @@ impl<'gc> DisplayObjectBase<'gc> {
         self.set_flag(DisplayObjectFlags::PLACED_BY_SCRIPT, value);
     }
 
+    fn set_placed_by_avm1_script(&self, value: bool) {
+        self.set_flag(DisplayObjectFlags::PLACED_BY_AVM1_SCRIPT, value);
+    }
+
+    fn placed_by_avm1_script(&self) -> bool {
+        self.contains_flag(DisplayObjectFlags::PLACED_BY_AVM1_SCRIPT)
+    }
+
     fn is_bitmap_cached_preference(&self) -> bool {
         self.contains_flag(DisplayObjectFlags::CACHE_AS_BITMAP)
     }
@@ -1439,6 +1449,17 @@ pub trait TDisplayObject<'gc>:
         }
     }
 
+    #[no_dynamic]
+    fn ratio(self) -> u16 {
+        self.base().ratio.get()
+    }
+
+    #[no_dynamic]
+    fn set_ratio(self, ratio: u16) {
+        self.base().ratio.set(ratio);
+        self.invalidate_cached_bitmap();
+    }
+
     /// The X axis scale for this display object in local space.
     /// Returned by the `_xscale`/`scaleX` ActionScript properties.
     #[no_dynamic]
@@ -2034,6 +2055,16 @@ pub trait TDisplayObject<'gc>:
         self.base().set_placed_by_script(value)
     }
 
+    #[no_dynamic]
+    fn placed_by_avm1_script(self) -> bool {
+        self.base().placed_by_avm1_script()
+    }
+
+    #[no_dynamic]
+    fn set_placed_by_avm1_script(self, value: bool) {
+        self.base().set_placed_by_avm1_script(value);
+    }
+
     /// Whether this display object has been instantiated by the timeline.
     /// When this flag is set, attempts to change the object's name from AVM2
     /// throw an exception.
@@ -2321,6 +2352,8 @@ pub trait TDisplayObject<'gc>:
                     morph_shape.set_ratio(ratio);
                 } else if let Some(video) = self.as_video() {
                     video.seek(context, ratio.into());
+                } else {
+                    self.set_ratio(ratio);
                 }
             }
             if let Some(is_bitmap_cached) = place_object.is_bitmap_cached {
@@ -2762,6 +2795,8 @@ bitflags! {
 
         /// Whether this object has matrix3D (used for stubbing).
         const HAS_MATRIX3D_STUB        = 1 << 14;
+
+        const PLACED_BY_AVM1_SCRIPT    = 1 << 15;
     }
 }
 

core/src/display_object/morph_shape.rs

@@ -11,7 +11,7 @@ use gc_arena::lock::Lock;
 use gc_arena::{Collect, Gc, Mutation};
 use ruffle_render::backend::ShapeHandle;
 use ruffle_render::commands::CommandHandler;
-use std::cell::{Cell, RefCell, RefMut};
+use std::cell::{RefCell, RefMut};
 use std::sync::Arc;
 use swf::{Fixed16, Fixed8};
 
@@ -35,7 +35,6 @@ pub struct MorphShapeData<'gc> {
     shared: Lock<Gc<'gc, MorphShapeShared>>,
     /// The AVM2 representation of this MorphShape.
     object: Lock<Option<Avm2Object<'gc>>>,
-    ratio: Cell<u16>,
 }
 
 impl<'gc> MorphShape<'gc> {
@@ -50,18 +49,17 @@ impl<'gc> MorphShape<'gc> {
             MorphShapeData {
                 base: Default::default(),
                 shared: Lock::new(Gc::new(gc_context, shared)),
-                ratio: Cell::new(0),
                 object: Lock::new(None),
             },
         ))
     }
 
     pub fn ratio(self) -> u16 {
-        self.0.ratio.get()
+        self.base().ratio.get()
     }
 
     pub fn set_ratio(self, ratio: u16) {
-        self.0.ratio.set(ratio);
+        self.base().ratio.set(ratio);
         self.invalidate_cached_bitmap();
     }
 }
@@ -121,7 +119,7 @@ impl<'gc> TDisplayObject<'gc> for MorphShape<'gc> {
     }
 
     fn render_self(self, context: &mut RenderContext) {
-        let ratio = self.0.ratio.get();
+        let ratio = self.ratio();
         let shared = self.0.shared.get();
         let shape_handle = shared.get_shape(context, context.library, ratio);
         context
@@ -130,7 +128,7 @@ impl<'gc> TDisplayObject<'gc> for MorphShape<'gc> {
     }
 
     fn self_bounds(self) -> Rectangle<Twips> {
-        let ratio = self.0.ratio.get();
+        let ratio = self.ratio();
         let shared = self.0.shared.get();
         let frame = shared.get_frame(ratio);
         frame.bounds

core/src/display_object/movie_clip.rs

@@ -1,4 +1,5 @@
 //! `MovieClip` display object and support code.
+use crate::avm1::globals::AVM_DEPTH_BIAS;
 use crate::avm1::Avm1;
 use crate::avm1::{Activation as Avm1Activation, ActivationIdentifier};
 use crate::avm1::{NativeObject as Avm1NativeObject, Object as Avm1Object, Value as Avm1Value};
@@ -1567,6 +1568,58 @@ impl<'gc> MovieClip<'gc> {
         }
         let hit_target_frame = self.0.current_frame() == frame;
 
+        fn survives_rewind(old_object: DisplayObject<'_>, new_params: &swf::PlaceObject) -> bool {
+            if !old_object.movie().is_action_script_3()
+                && old_object.placed_by_avm1_script()
+                && old_object.depth() < AVM_DEPTH_BIAS
+            {
+                return false;
+            }
+            let id = match new_params.action {
+                swf::PlaceObjectAction::Place(id) | swf::PlaceObjectAction::Replace(id) => id,
+                _ => 0,
+            };
+            let ratio_equals = match new_params.ratio {
+                Some(ratio) => old_object.ratio() == ratio,
+                None => true,
+            };
+
+            let clip_depth_equals = match new_params.clip_depth {
+                Some(clip_depth) => old_object.clip_depth() == clip_depth as Depth,
+                None => true,
+            };
+
+            let color_transform_equals = match new_params.color_transform {
+                Some(color_transform) => old_object.base().color_transform() == color_transform,
+                None => true,
+            };
+
+            let base_matrix_equals = match new_params.matrix {
+                Some(matrix) => old_object.base().matrix() == matrix.into(),
+                None => true,
+            };
+
+            match old_object {
+                DisplayObject::MorphShape(_)
+                | DisplayObject::Graphic(_)
+                | DisplayObject::Text(_) => {
+                    ratio_equals
+                        && old_object.id() == id
+                        && clip_depth_equals
+                        && base_matrix_equals
+                        && color_transform_equals
+                }
+                DisplayObject::Avm1Button(_)
+                | DisplayObject::Avm2Button(_)
+                | DisplayObject::EditText(_)
+                | DisplayObject::Bitmap(_)
+                | DisplayObject::Video(_) => {
+                    ratio_equals && old_object.id() == id && clip_depth_equals
+                }
+                _ => ratio_equals,
+            }
+        }
+
         if is_rewind {
             // Remove all display objects that were created after the
             // destination frame.
@@ -1577,10 +1630,29 @@ impl<'gc> MovieClip<'gc> {
             // TODO: We want to do something like self.children.retain here,
             // but BTreeMap::retain does not exist.
             // TODO: Should AS3 children ignore GOTOs?
+            let final_placements: std::collections::HashMap<Depth, &GotoPlaceObject<'_>> =
+                goto_commands.iter().map(|cmd| (cmd.depth(), cmd)).collect();
+
             let children: SmallVec<[_; 16]> = self
                 .iter_render_list()
-                .filter(|clip| clip.place_frame() > frame)
+                .filter(|child| {
+                    let is_candidate_for_removal = if self.movie().is_action_script_3() {
+                        child.place_frame() > frame || child.placed_by_script()
+                    } else {
+                        child.depth() < AVM_DEPTH_BIAS
+                    };
+
+                    if !is_candidate_for_removal && child.as_morph_shape().is_none() {
+                        return false;
+                    }
+                    if let Some(final_placement) = final_placements.get(&child.depth()) {
+                        !survives_rewind(*child, &final_placement.place_object)
+                    } else {
+                        true
+                    }
+                })
                 .collect();
+
             for child in children {
                 if !child.placed_by_script() {
                     self.remove_child(context, child);

tests/tests/swfs/avm1/rewind_depth/test.toml

@@ -1,3 +1 @@
 num_frames = 6
-# FIXME - Ruffle doesn't handle AVM1 'goto's correctly
-known_failure = true

tests/tests/swfs/from_shumway/avm1/duplicateMovieClip/dontremove/test.toml

@@ -1,4 +1,3 @@
 # Test adapted from Shumway at https://github.com/mozilla/shumway/tree/master/test/swfs/avm1/duplicatemovieclip
 
 num_frames = 4
-known_failure = true # https://github.com/ruffle-rs/ruffle/issues/12270

tests/tests/swfs/timeline/nav/morph_shape/test.toml

@@ -1,4 +1,3 @@
 # Test adapted from Shumway at https://github.com/mozilla/shumway/tree/master/test/swfs/timeline/nav
 
 num_frames = 3
-known_failure = true # https://github.com/ruffle-rs/ruffle/issues/12143

tests/tests/swfs/timeline/nav/ratio2/test.toml

@@ -1,4 +1,3 @@
 # Test adapted from Shumway at https://github.com/mozilla/shumway/tree/master/test/swfs/timeline/nav
 
 num_frames = 3
-known_failure = true # https://github.com/ruffle-rs/ruffle/issues/12144

tests/tests/swfs/timeline/nav/ratio3/test.toml

@@ -1,4 +1,3 @@
 # Test adapted from Shumway at https://github.com/mozilla/shumway/tree/master/test/swfs/timeline/nav
 
 num_frames = 3
-known_failure = true # https://github.com/ruffle-rs/ruffle/issues/12145