Merge branch 'master' into stable

joamag · Sep 2, 2024 · e8523de · e8523de
2 parents 09375c9 + 1e849c3
commit e8523de
Show file tree

Hide file tree

Showing 14 changed files with 198 additions and 41 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 *
 
+## [0.10.13] - 2024-09-02
+
+### Changed
+
+* Bumped EmuKit to improve Web runtime performance
+
 ## [0.10.12] - 2024-08-30
 
 ### Fixed

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "boytacean"
 description = "A Game Boy emulator that is written in Rust."
-version = "0.10.12"
+version = "0.10.13"
 authors = ["João Magalhães <[email protected]>"]
 license = "Apache-2.0"
 repository = "https://github.com/joamag/boytacean"
@@ -25,9 +25,9 @@ cpulog = []
 gen-mock = []
 
 [dependencies]
-boytacean-common = { path = "crates/common", version = "0.10.12" }
-boytacean-encoding = { path = "crates/encoding", version = "0.10.12" }
-boytacean-hashing = { path = "crates/hashing", version = "0.10.12" }
+boytacean-common = { path = "crates/common", version = "0.10.13" }
+boytacean-encoding = { path = "crates/encoding", version = "0.10.13" }
+boytacean-hashing = { path = "crates/hashing", version = "0.10.13" }
 wasm-bindgen = { version = "0.2", optional = true }
 js-sys = { version = "0.3", optional = true }
 pyo3 = { version = "0.20", optional = true }
@@ -67,7 +67,7 @@ members = [
     "crates/encoding",
     "crates/hashing"
 ]
-package = { version = "0.10.12", authors = ["João Magalhães <[email protected]>"], edition = "2021" }
+package = { version = "0.10.13", authors = ["João Magalhães <[email protected]>"], edition = "2021" }
 
 [package.metadata.docs.rs]
 features = ["wasm", "gen-mock"]

diff --git a/crates/common/Cargo.toml b/crates/common/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "boytacean-common"
 description = "Commons library for Boytacen."
-version = "0.10.12"
+version = "0.10.13"
 authors = ["João Magalhães <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

diff --git a/crates/common/src/error.rs b/crates/common/src/error.rs
@@ -21,6 +21,7 @@ pub enum Error {
     InvalidKey,
     RomSize,
     IncompatibleBootRom,
+    NotImplemented,
     MissingOption(String),
     IoError(String),
     InvalidParameter(String),
@@ -33,7 +34,8 @@ impl Error {
             Error::InvalidData => String::from("Invalid data format"),
             Error::InvalidKey => String::from("Invalid key"),
             Error::RomSize => String::from("Invalid ROM size"),
-            Error::IncompatibleBootRom => String::from("Incompatible Boot ROM"),
+            Error::IncompatibleBootRom => String::from("Incompatible boot ROM"),
+            Error::NotImplemented => String::from("Not implemented"),
             Error::MissingOption(option) => format!("Missing option: {option}"),
             Error::IoError(message) => format!("IO error: {message}"),
             Error::InvalidParameter(message) => format!("Invalid parameter: {message}"),
@@ -48,7 +50,8 @@ impl error::Error for Error {
             Error::InvalidData => "Invalid data format",
             Error::InvalidKey => "Invalid key",
             Error::RomSize => "Invalid ROM size",
-            Error::IncompatibleBootRom => "Incompatible Boot ROM",
+            Error::IncompatibleBootRom => "Incompatible boot ROM",
+            Error::NotImplemented => "Not implemented",
             Error::MissingOption(_) => "Missing option",
             Error::IoError(_) => "IO error",
             Error::InvalidParameter(_) => "Invalid parameter",

diff --git a/crates/encoding/Cargo.toml b/crates/encoding/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "boytacean-encoding"
 description = "Codecs library for Boytacen."
-version = "0.10.12"
+version = "0.10.13"
 authors = ["João Magalhães <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"
@@ -10,8 +10,8 @@ edition = "2021"
 simd = ["boytacean-hashing/simd"]
 
 [dependencies]
-boytacean-common = { path = "../common", version = "0.10.12" }
-boytacean-hashing = { path = "../hashing", version = "0.10.12" }
+boytacean-common = { path = "../common", version = "0.10.13" }
+boytacean-hashing = { path = "../hashing", version = "0.10.13" }
 
 [[bin]]
 name = "zippy"

diff --git a/crates/hashing/Cargo.toml b/crates/hashing/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "boytacean-hashing"
 description = "Hashing library for Boytacen."
-version = "0.10.12"
+version = "0.10.13"
 authors = ["João Magalhães <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"
@@ -10,4 +10,4 @@ edition = "2021"
 simd = []
 
 [dependencies]
-boytacean-common = { path = "../common", version = "0.10.12" }
+boytacean-common = { path = "../common", version = "0.10.13" }
diff --git a/frontends/libretro/Cargo.toml b/frontends/libretro/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "boytacean-libretro"
-version = "0.10.12"
+version = "0.10.13"
 authors = ["João Magalhães <[email protected]>"]
 description = "A Libretro frontend for Boytacen"
 license = "Apache-2.0"
@@ -17,4 +17,4 @@ pedantic = ["boytacean/pedantic"]
 cpulog = ["boytacean/cpulog"]
 
 [dependencies]
-boytacean = { path = "../..", version = "0.10.12" }
+boytacean = { path = "../..", version = "0.10.13" }
diff --git a/frontends/libretro/res/boytacean_libretro.info b/frontends/libretro/res/boytacean_libretro.info
@@ -6,7 +6,7 @@ corename = "Boytacean"
 categories = "Emulator"
 license = "Apache-2."
 permissions = ""
-display_version = "0.10.12"
+display_version = "0.10.13"
 
 # Hardware Information
 manufacturer = "Nintendo"

diff --git a/frontends/sdl/Cargo.toml b/frontends/sdl/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "boytacean-sdl"
-version = "0.10.12"
+version = "0.10.13"
 authors = ["João Magalhães <[email protected]>"]
 description = "An SDL frontend for Boytacen"
 license = "Apache-2.0"
@@ -15,8 +15,8 @@ pedantic = ["boytacean/pedantic"]
 cpulog = ["boytacean/cpulog"]
 
 [dependencies]
-boytacean = { path = "../..", version = "0.10.12" }
-boytacean-common = { path = "../../crates/common", version = "0.10.12" }
+boytacean = { path = "../..", version = "0.10.13" }
+boytacean-common = { path = "../../crates/common", version = "0.10.13" }
 clap = { version = "4", features = ["derive"] }
 image = "0.24"
 chrono = "0.4"

diff --git a/frontends/web/package.json b/frontends/web/package.json
@@ -1,6 +1,6 @@
 {
     "name": "boytacean-web",
-    "version": "0.10.12",
+    "version": "0.10.13",
     "description": "The web version of Boytacean",
     "repository": {
         "type": "git",
@@ -24,7 +24,7 @@
         "@typescript-eslint/eslint-plugin": "^7.18.0",
         "@typescript-eslint/parser": "^7.18.0",
         "buffer": "^6.0.3",
-        "emukit": "^0.10.12",
+        "emukit": "^0.10.13",
         "eslint": "^8.57.0",
         "eslint-plugin-import": "^2.29.1",
         "eslint-plugin-react-hooks": "^4.6.2",

diff --git a/frontends/web/ts/gb.ts b/frontends/web/ts/gb.ts
@@ -17,7 +17,9 @@ import {
     RomInfo,
     SaveState,
     SectionInfo,
-    Size
+    Size,
+    TickParams,
+    Validation
 } from "emukit";
 import { loadAsync } from "jszip";
 
@@ -30,6 +32,7 @@ import {
     GameBoySpeed,
     Info,
     PadKey,
+    SaveStateFormat,
     StateManager
 } from "../lib/boytacean";
 import info from "../package.json";
@@ -189,20 +192,17 @@ export class GameboyEmulator extends EmulatorLogic implements Emulator {
      * - Triggers the frame event in case there's a frame to be processed.
      * - Triggers the audio event, allowing the deferred retrieval of the audio buffer.
      * - Flushes the RAM to the local storage in case the cartridge is battery backed.
+     *
+     * @params params The parameters to be used in the tick operation.
      */
-    async tick() {
+    async tick(params: TickParams) {
         // in case the reference to the system is not set then
         // returns the control flow immediately (not possible to tick)
         if (!this.gameBoy) return;
 
-        // calculates the number of cycles that are going to be
-        // processed in the current tick operation, this value is
-        // calculated using the logic and visual frequencies and
-        // the current Game Boy multiplier (DMG vs CGB)
-        const tickCycles = Math.round(
-            (this.logicFrequency * (this.gameBoy?.multiplier() ?? 1)) /
-                this.visualFrequency
-        );
+        // uses the Game Boy multiplier to re-calculate the number
+        // of cycles to be used for the tick
+        const tickCycles = params.cycles * (this.gameBoy?.multiplier() ?? 1);
 
         // calculates the target cycles for clocking in the current
         // tick operation, this is the ideal value and the concrete
@@ -218,7 +218,7 @@ export class GameboyEmulator extends EmulatorLogic implements Emulator {
         );
         const executedCycles = Number(this.clockFrame.cycles);
         if (this.clockFrame.frames > 0) {
-            this.trigger("frame");
+            this.trigger("frame", { count: this.clockFrame.frames });
         }
 
         // triggers the audio event, meaning that the audio should be
@@ -470,6 +470,7 @@ export class GameboyEmulator extends EmulatorLogic implements Emulator {
                       Feature.RomTypeInfo,
                       Feature.Cyclerate,
                       Feature.Animationrate,
+                      Feature.SkippedTicks,
                       Feature.EmulationSpeed
                   ]
                 : [])
@@ -535,6 +536,10 @@ export class GameboyEmulator extends EmulatorLogic implements Emulator {
         return ["gb", "gbc", "zip"];
     }
 
+    get stateExts(): string[] {
+        return ["sav", ...Array.from({ length: 10 }, (_, i) => `s${i + 1}`)];
+    }
+
     get pixelFormat(): PixelFormat {
         return PixelFormat.RGB;
     }
@@ -738,12 +743,26 @@ export class GameboyEmulator extends EmulatorLogic implements Emulator {
 
     async buildState(index: number, data: Uint8Array): Promise<SaveState> {
         try {
-            const state = StateManager.read_bos_auto_wa(data);
+            let state = null;
+            const format = StateManager.format_wa(data);
+            switch (format) {
+                case SaveStateFormat.Bos:
+                case SaveStateFormat.Bosc:
+                    state = StateManager.read_bos_auto_wa(data);
+                    break;
+                case SaveStateFormat.Bess:
+                    state = StateManager.read_bess_wa(data);
+                    break;
+                default:
+                    throw new Error(`Invalid state format ${format}`);
+            }
+            const timestamp = Number(state.timestamp_wa());
             return {
                 index: index,
-                timestamp: Number(state.timestamp_wa()),
+                timestamp: timestamp > 0 ? timestamp : undefined,
                 agent: state.agent_wa(),
                 model: state.model_wa(),
+                title: state.title_wa(),
                 format: StateManager.format_str_wa(data),
                 size: data.length,
                 thumbnail: state.has_image_wa()
@@ -758,6 +777,10 @@ export class GameboyEmulator extends EmulatorLogic implements Emulator {
         }
     }
 
+    async validateState(data: Uint8Array, validation: Validation) {
+        StateManager.validate_wa(data, validation.title);
+    }
+
     pauseVideo() {
         this.gameBoy?.set_ppu_enabled(false);
     }

diff --git a/setup.py b/setup.py
@@ -27,7 +27,7 @@
 
 setuptools.setup(
     name="boytacean",
-    version="0.10.12",
+    version="0.10.13",
     author="João Magalhães",
     author_email="[email protected]",
     description="A Game Boy emulator that is written in Rust",

diff --git a/src/gb.rs b/src/gb.rs
@@ -141,6 +141,12 @@ impl From<&str> for GameBoyMode {
     }
 }
 
+impl From<GameBoyMode> for String {
+    fn from(value: GameBoyMode) -> Self {
+        value.to_string(Some(true))
+    }
+}
+
 #[cfg_attr(feature = "wasm", wasm_bindgen)]
 #[derive(Clone, Copy, PartialEq, Eq)]
 pub enum GameBoySpeed {