cf4ca543bd
When we iterate over a render list (in order to call `enter_frame`, `construct_frame, etc.) we need to be sure that we iterate over all of the original `DisplayObjects` in the list, even if the list is modified during iteration (e.g. some ActionScript code calls `parent.addChildAt`). Previously, `RenderIter` would repeatedly call `child_by_index` on the original `DisplayObjectContainer`, up to the original child count. If new DisplayObjects were inserted into the list during iteration, we could miss some of the original DisplayObjects in the list (as they are now at a greater position in the list). To solve this, we now store the render list as an `Rc<Vec>`, and use `Rc::make_mut` to modify it. See the comments for more details. |
||
|---|---|---|
| .. | ||
| input-format | ||
| tests | ||
| Cargo.toml | ||
| README.md | ||
README.md
SWF Regression Tests
Inside tests/swfs is a large collection of automated tests that are based around running a swf and seeing what happens.
To create a test, make a directory that looks like the following, at minimum:
- directory/
- test.swf
- test.toml
- output.txt
As best practice, please also include any source used to make the swf - such as test.fla and any actionscript files.
Test Structure
test.toml
Except for num_frames, every other field and section is optional.
num_frames = 1 # The amount of frames of the swf to run
sleep_to_meet_frame_rate = false # If true, slow the tick rate to match the movies requested fps rate
ignore = false # If true, ignore this test. Please comment why, ideally link to an issue, so we know what's up
output_path = "output.txt" # Path (relative to the directory containing test.toml) to the expected output
# Sometimes floating point math doesn't exactly 100% match between flash and rust.
# If you encounter this in a test, the following section will change the output testing from "exact" to "approximate"
# (when it comes to floating point numbers, at least.)
[approximations]
number_patterns = [] # A list of regex patterns with capture groups to additionally treat as approximate numbers
epsilon = 0.0 # The upper bound of any rounding errors. Default is the difference between 1.0 and the next largest representable number
max_relative = 0.0 # The default relative tolerance for testing values that are far-apart. Default is the difference between 1.0 and the next largest representable number
# Options for the player used to run this swf
[player_options]
max_execution_duration = { secs = 15, nanos = 0} # How long can actionscript execute for before being forcefully stopped
viewport_dimensions = { width = 100, height = 100, scale_factor = 1 } # The size of the player. Defaults to the swfs stage size
with_renderer = { optional = false, sample_count = 4, exclude_warp = false } # If this test requires a renderer to run. Optional will enable the renderer where available.
with_audio = false # If this test requires an audio backend to run.
with_video = false # If this test requires a video decoder backend to run.
# Whether or not to compare the image rendered with an expected image
# The comparison part of a test is optional and only runs when `imgtests` feature is enabled
# This requires a render to be setup for this test
[image_comparison]
tolerance = 0 # The tolerance per pixel channel to be considered "the same". Increase as needed with tests that aren't pixel perfect across platforms.
max_outliers = 0 # Maximum number of outliers allowed over the given tolerance levels. Increase as needed with tests that aren't pixel perfect across platforms.