core: Add Player Mode option

This option specifies whether to emulate flashplayer (release mode)
or flashplayerdebugger (debug mode).

Author: kjarosh

core/src/context.rs

@@ -41,6 +41,7 @@ use crate::stub::StubCollection;
 use crate::tag_utils::{SwfMovie, SwfSlice};
 use crate::timer::Timers;
 use crate::vminterface::Instantiator;
+use crate::PlayerMode;
 use core::fmt;
 use gc_arena::{Collect, Mutation};
 use rand::rngs::SmallRng;
@@ -84,6 +85,8 @@ pub struct UpdateContext<'gc> {
     /// variables.
     pub player_version: u8,
 
+    pub player_mode: PlayerMode,
+
     /// Requests that the player re-renders after this execution (e.g. due to `updateAfterEvent`).
     pub needs_render: &'gc mut bool,
 

core/src/lib.rs

@@ -68,7 +68,7 @@ pub use events::PlayerEvent;
 pub use font::DefaultFont;
 pub use indexmap;
 pub use loader::LoadBehavior;
-pub use player::{Player, PlayerBuilder, PlayerRuntime, StaticCallstack};
+pub use player::{Player, PlayerBuilder, PlayerMode, PlayerRuntime, StaticCallstack};
 pub use ruffle_render::backend::ViewportDimensions;
 pub use swf;
 pub use swf::Color;

core/src/player.rs

@@ -298,6 +298,9 @@ pub struct Player {
     #[allow(unused)]
     player_runtime: PlayerRuntime,
 
+    /// Whether we're emulating the release or the debug build.
+    player_mode: PlayerMode,
+
     swf: Arc<SwfMovie>,
 
     run_state: RunState,
@@ -2179,6 +2182,7 @@ impl Player {
 
             let mut update_context = UpdateContext {
                 player_version: this.player_version,
+                player_mode: this.player_mode,
                 swf: &mut this.swf,
                 library,
                 rng: &mut this.rng,
@@ -2454,6 +2458,7 @@ pub struct PlayerBuilder {
     gamepad_button_mapping: HashMap<GamepadButton, KeyCode>,
     player_version: Option<u8>,
     player_runtime: PlayerRuntime,
+    player_mode: PlayerMode,
     quality: StageQuality,
     page_url: Option<String>,
     frame_rate: Option<f64>,
@@ -2505,6 +2510,7 @@ impl PlayerBuilder {
             gamepad_button_mapping: HashMap::new(),
             player_version: None,
             player_runtime: PlayerRuntime::default(),
+            player_mode: PlayerMode::default(),
             quality: StageQuality::High,
             page_url: None,
             frame_rate: None,
@@ -2679,6 +2685,12 @@ impl PlayerBuilder {
         self
     }
 
+    /// Configures the player mode (default is `PlayerMode::Release`)
+    pub fn with_player_mode(mut self, mode: PlayerMode) -> Self {
+        self.player_mode = mode;
+        self
+    }
+
     // Configure the embedding page's URL (if applicable)
     pub fn with_page_url(mut self, page_url: Option<String>) -> Self {
         self.page_url = page_url;
@@ -2859,6 +2871,7 @@ impl PlayerBuilder {
                 instance_counter: 0,
                 player_version,
                 player_runtime: self.player_runtime,
+                player_mode: self.player_mode,
                 run_state: if self.autoplay {
                     RunState::Playing
                 } else {
@@ -3043,3 +3056,11 @@ impl FromStr for PlayerRuntime {
         Ok(player_runtime)
     }
 }
+
+#[derive(Default, Clone, Copy, Debug, Eq, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Deserialize))]
+pub enum PlayerMode {
+    #[default]
+    Release,
+    Debug,
+}