avm2: implement get and set of displayobject filters (ruffle-rs#8623)

Author: wsxarcher

core/src/avm2/globals/flash/display/displayobject.rs

@@ -5,11 +5,11 @@ use crate::avm2::class::Class;
 use crate::avm2::method::{Method, NativeMethodImpl};
 use crate::avm2::object::{stage_allocator, Object, TObject};
 use crate::avm2::value::Value;
-use crate::avm2::ArrayObject;
 use crate::avm2::Error;
 use crate::avm2::Multiname;
 use crate::avm2::Namespace;
 use crate::avm2::QName;
+use crate::avm2::{ArrayObject, ArrayStorage};
 use crate::display_object::{DisplayObject, HitTestOptions, TDisplayObject};
 use crate::ecma_conversions::round_to_even;
 use crate::frame_lifecycle::catchup_display_object_to_frame;
@@ -239,23 +239,67 @@ pub fn set_scale_x<'gc>(
     Ok(Value::Undefined)
 }
 
-/// Implements `filters`'s getter.
 pub fn filters<'gc>(
     activation: &mut Activation<'_, 'gc, '_>,
-    _this: Option<Object<'gc>>,
+    this: Option<Object<'gc>>,
     _args: &[Value<'gc>],
 ) -> Result<Value<'gc>, Error<'gc>> {
-    log::warn!("DisplayObject.filters getter - not yet implemented");
+    if let Some(dobj) = this.and_then(|this| this.as_display_object()) {
+        return Ok(ArrayObject::from_storage(activation, dobj.filters())?.into());
+    }
     Ok(ArrayObject::empty(activation)?.into())
 }
 
-/// Implements `filters`'s setter.
+fn build_argument_type_error<'gc>(
+    activation: &mut Activation<'_, 'gc, '_>,
+) -> Result<Value<'gc>, Error<'gc>> {
+    Err(Error::AvmError(crate::avm2::error::argument_error(
+        activation,
+        "Error #2005: Parameter 0 is of the incorrect type. Should be type Filter.",
+        2005,
+    )?))
+}
+
 pub fn set_filters<'gc>(
-    _activation: &mut Activation<'_, 'gc, '_>,
-    _this: Option<Object<'gc>>,
-    _args: &[Value<'gc>],
+    activation: &mut Activation<'_, 'gc, '_>,
+    this: Option<Object<'gc>>,
+    args: &[Value<'gc>],
 ) -> Result<Value<'gc>, Error<'gc>> {
-    log::warn!("DisplayObject.filters setter - not yet implemented");
+    if let Some(dobj) = this.and_then(|this| this.as_display_object()) {
+        let new_filters = args.get(0).cloned().unwrap_or(Value::Undefined);
+
+        if matches!(new_filters, Value::Undefined | Value::Null) {
+            let new_storage = ArrayStorage::new(0);
+            dobj.set_filters(activation.context.gc_context, new_storage);
+        } else {
+            let new_filters = new_filters.coerce_to_object(activation)?;
+
+            if let Some(filters_array) = new_filters.as_array_object() {
+                if let Some(filters_storage) = filters_array.as_array_storage() {
+                    let filter_class =
+                        Multiname::new(Namespace::Package("flash.filters".into()), "BitmapFilter");
+
+                    let filter_class_object = activation.resolve_class(&filter_class)?;
+
+                    for filter in filters_storage.iter().flatten() {
+                        if matches!(filter, Value::Undefined | Value::Null) {
+                            return build_argument_type_error(activation);
+                        } else {
+                            let filter_object = filter.coerce_to_object(activation)?;
+
+                            if !filter_object.is_of_type(filter_class_object, activation) {
+                                return build_argument_type_error(activation);
+                            }
+                        }
+                    }
+                    let new_storage = ArrayStorage::from_storage(filters_storage.iter().collect());
+
+                    dobj.set_filters(activation.context.gc_context, new_storage);
+                }
+            }
+        }
+    }
+
     Ok(Value::Undefined)
 }
 

core/src/display_object.rs

@@ -1,7 +1,8 @@
 use crate::avm1::{Object as Avm1Object, TObject as Avm1TObject, Value as Avm1Value};
 use crate::avm2::{
-    Activation as Avm2Activation, Avm2, Error as Avm2Error, EventObject as Avm2EventObject,
-    Multiname as Avm2Multiname, Object as Avm2Object, TObject as Avm2TObject, Value as Avm2Value,
+    Activation as Avm2Activation, ArrayStorage as Avm2ArrayStorage, Avm2, Error as Avm2Error,
+    EventObject as Avm2EventObject, Multiname as Avm2Multiname, Object as Avm2Object,
+    TObject as Avm2TObject, Value as Avm2Value,
 };
 use crate::context::{RenderContext, UpdateContext};
 use crate::drawing::Drawing;
@@ -59,6 +60,7 @@ pub struct DisplayObjectBase<'gc> {
     #[collect(require_static)]
     transform: Transform,
     name: AvmString<'gc>,
+    filters: Avm2ArrayStorage<'gc>,
     clip_depth: Depth,
 
     // Cached transform properties `_xscale`, `_yscale`, `_rotation`.
@@ -122,6 +124,7 @@ impl<'gc> Default for DisplayObjectBase<'gc> {
             depth: Default::default(),
             transform: Default::default(),
             name: Default::default(),
+            filters: Avm2ArrayStorage::new(0),
             clip_depth: Default::default(),
             rotation: Degrees::from_radians(0.0),
             scale_x: Percent::from_unit(1.0),
@@ -306,6 +309,14 @@ impl<'gc> DisplayObjectBase<'gc> {
         self.name = name;
     }
 
+    fn filters(&self) -> Avm2ArrayStorage<'gc> {
+        Avm2ArrayStorage::from_storage(self.filters.iter().collect())
+    }
+
+    fn set_filters(&mut self, filters: Avm2ArrayStorage<'gc>) {
+        self.filters = filters;
+    }
+
     fn alpha(&self) -> f64 {
         f64::from(self.color_transform().a_mult)
     }
@@ -928,6 +939,14 @@ pub trait TDisplayObject<'gc>:
         self.base_mut(gc_context).set_name(name)
     }
 
+    fn filters(&self) -> Avm2ArrayStorage<'gc> {
+        self.base().filters()
+    }
+
+    fn set_filters(&self, gc_context: MutationContext<'gc, '_>, filters: Avm2ArrayStorage<'gc>) {
+        self.base_mut(gc_context).set_filters(filters)
+    }
+
     /// Returns the dot-syntax path to this display object, e.g. `_level0.foo.clip`
     fn path(&self) -> WString {
         if let Some(parent) = self.avm1_parent() {

tests/tests/regression_tests.rs

@@ -248,6 +248,7 @@ swf_tests! {
     (as3_dictionary_in, "avm2/dictionary_in", 1),
     (as3_dictionary_namespaces, "avm2/dictionary_namespaces", 1),
     (as3_displayobject_alpha, "avm2/displayobject_alpha", 1),
+    (as3_displayobject_filters, "avm2/displayobject_filters", 1),
     (as3_displayobject_blendmode, "avm2/displayobject_blendmode", 1, img = true),
     (as3_displayobject_hittestobject, "avm2/displayobject_hittestobject", 1),
     (as3_displayobject_hittestpoint, "avm2/displayobject_hittestpoint", 2),

tests/tests/swfs/avm2/displayobject_filters/Test.as

@@ -0,0 +1,36 @@
+package {
+	import flash.display.Sprite;
+	import flash.filters.BlurFilter;
+	public class Test extends Sprite {
+		public function Test() {
+			trace("///this.filters.length == 0");
+			trace(this.filters.length == 0)
+			trace("///this.filters === this.filters");
+			trace(this.filters === this.filters);
+			trace("///this.filters = [new BlurFilter()]")
+			this.filters = [new BlurFilter()];
+			trace("///this.filters.length == 1");
+			trace(this.filters.length == 1)
+			trace("///this.filters = undefined")
+			this.filters = undefined;
+			trace("///this.filters.length == 0")
+			trace(this.filters.length == 0)
+			trace("///this.filters = null")
+			this.filters = null;
+			trace("///this.filters.length == 0")
+			trace(this.filters.length == 0)
+			try {
+				trace("///this.filters = [1, 2, 3]")
+				this.filters = [1, 2, 3];
+			} catch (e: Error) {
+				trace("Caught error: " + e);
+			}
+			try {
+				trace("///this.filters = [new BlurFilter(), undefined]")
+				this.filters = [new BlurFilter(), undefined];
+			} catch (e: Error) {
+				trace("Caught error: " + e);
+			}
+		}
+	}
+}

tests/tests/swfs/avm2/displayobject_filters/output.txt

@@ -0,0 +1,17 @@
+///this.filters.length == 0
+true
+///this.filters === this.filters
+false
+///this.filters = [new BlurFilter()]
+///this.filters.length == 1
+true
+///this.filters = undefined
+///this.filters.length == 0
+true
+///this.filters = null
+///this.filters.length == 0
+true
+///this.filters = [1, 2, 3]
+Caught error: ArgumentError: Error #2005: Parameter 0 is of the incorrect type. Should be type Filter.
+///this.filters = [new BlurFilter(), undefined]
+Caught error: ArgumentError: Error #2005: Parameter 0 is of the incorrect type. Should be type Filter.