@emu198x/zx-spectrum 0.4.0 → 0.4.2

package/README.md

@@ -47,6 +47,7 @@ the browser will blur the pixels.
 | `tick(elapsedMs)` | Run elapsed real time and draw. Returns frames run. |
 | `loadSnapshot(bytes, format)` | Load a `.sna` or `.z80` snapshot. |
 | `load(slot, kind, bytes)` | Load media — for example a tape into `tape-1`. |
+| `autoload(maxBootFrames)` | Load the tape in `tape-1`: type `LOAD ""` and press play. A machine that has already run is reset first; the tape stays in. |
 | `keyDown(code)` / `keyUp(code)` | Feed a DOM `KeyboardEvent.code`. |
 | `setAudioEnabled(on)` | Start or stop audio. |
 | `configureAudio(rate, channels, capacity)` | Match the page's `AudioContext`. |
@@ -73,7 +74,10 @@ The permission is Cliff Lawson's, for Amstrad plc, on comp.sys.sinclair,
 31 August 1999:
 <https://web.archive.org/web/20180828125931/http://www.worldofspectrum.org/permits/amstrad-roms.txt>
 
-The ROM image is included unmodified, and no charge is made for it. The
+The ROM image is included unmodified, and no charge is made for it. Versions
+0.1.0 to 0.4.0 carried a 48K image with 272 bytes changed in the ROM's unused
+area, from address `0x386E`; use 0.4.1 or later, which carries the unmodified
+image (SHA1 `5ea7c2b824672e914525d1d5c419d71b84a426a2`). The
 permission covers the Sinclair 48K and 128K ROMs and Amstrad's +2/+2A/+3
 machines. It does not extend to the ZX80, ZX81, Interface 1 or 2, Timex
 machines, or Spectrum clones.

package/emu198x_spectrum_web.d.ts

@@ -27,6 +27,9 @@ export class Spectrum {
      * the editor prompt to be repainted before it is read, and for the 128K
      * family's loader to be listening before the tape rolls.
      *
+     * A machine that has already run is reset first, keeping the tape, so
+     * choosing a tape works however the machine has been used (#1569).
+     *
      * Returns the number of frames spent waiting for boot. Load a tape first.
      *
      * # Errors
@@ -43,7 +46,7 @@ export class Spectrum {
     /**
      * Builds a 48K attached to `canvas`, from ROM bytes the page supplies.
      *
-     * Async even though nothing here awaits: restoring the GPU path (#1436)
+     * Async even though nothing here awaits: adopting the GPU path (#1414)
      * needs an adapter, and acquiring one is async. Shipping this synchronous
      * would make that a breaking change for every consumer.
      *
@@ -137,6 +140,10 @@ export class Spectrum {
      * Width and height of the machine's picture, as `[width, height]`.
      */
     frameSize(): Uint32Array;
+    /**
+     * Frame period derived from the machine profile.
+     */
+    frame_ms(): number;
     /**
      * Presses a key, from a DOM `KeyboardEvent.code`.
      *
@@ -206,6 +213,10 @@ export class Spectrum {
      * Rejects ranges extending beyond the 64 KiB address space.
      */
     readMemory(address: number, length: number): Uint8Array;
+    /**
+     * Restores compatible machine state, clearing pending host input/audio.
+     */
+    restore_state(bytes: Uint8Array): void;
     /**
      * Returns the executed routine events and whether the stop was reached.
      *
@@ -230,6 +241,10 @@ export class Spectrum {
      * outside the code, and ROM boot or prompt failures.
      */
     runCode(bytes: Uint8Array, origin: number, entry: number): void;
+    /**
+     * Exports the current machine state.
+     */
+    save_state(): Uint8Array;
     /**
      * Returns captured writes (including ROM writes) and saturation status.
      * Consumers can select the program's PC range without inventing a trace.
@@ -242,6 +257,12 @@ export class Spectrum {
      * Starts or stops machine audio.
      */
     setAudioEnabled(enabled: boolean): void;
+    /**
+     * Advances exactly one frame without drawing to a canvas.
+     * # Errors
+     * Returns the runtime's execution error.
+     */
+    step(): void;
     /**
      * Runs the machine for `elapsed_ms` of real time and draws the result.
      *
@@ -290,6 +311,7 @@ export interface InitOutput {
     readonly spectrum_enableScreenWriteTrace: (a: number, b: number, c: number) => [number, number];
     readonly spectrum_frameRgba: (a: number) => [number, number];
     readonly spectrum_frameSize: (a: number) => [number, number];
+    readonly spectrum_frame_ms: (a: number) => number;
     readonly spectrum_keyDown: (a: number, b: number, c: number) => number;
     readonly spectrum_keyUp: (a: number, b: number, c: number) => number;
     readonly spectrum_load: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number];
@@ -297,11 +319,14 @@ export interface InitOutput {
     readonly spectrum_mediaSlots: (a: number) => [number, number];
     readonly spectrum_query: (a: number, b: number, c: number) => [number, number, number, number];
     readonly spectrum_readMemory: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly spectrum_restore_state: (a: number, b: number, c: number) => [number, number];
     readonly spectrum_routineTrace: (a: number) => [number, number, number, number];
     readonly spectrum_runBasic: (a: number, b: number, c: number) => [number, number];
     readonly spectrum_runCode: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly spectrum_save_state: (a: number) => [number, number, number, number];
     readonly spectrum_screenWriteTrace: (a: number) => [number, number, number, number];
     readonly spectrum_setAudioEnabled: (a: number, b: number) => void;
+    readonly spectrum_step: (a: number) => [number, number];
     readonly spectrum_tick: (a: number, b: number) => [number, number, number];
     readonly wasm_bindgen_d6cb7d81ec28c0ae___convert__closures_____invoke___wasm_bindgen_d6cb7d81ec28c0ae___JsValue__core_f0fd674eaa06beef___result__Result_____wasm_bindgen_d6cb7d81ec28c0ae___JsError___true_: (a: number, b: number, c: any) => [number, number];
     readonly wasm_bindgen_d6cb7d81ec28c0ae___convert__closures_____invoke___js_sys_e5668971ffde892f___Function_fn_wasm_bindgen_d6cb7d81ec28c0ae___JsValue_____wasm_bindgen_d6cb7d81ec28c0ae___sys__Undefined___js_sys_e5668971ffde892f___Function_fn_wasm_bindgen_d6cb7d81ec28c0ae___JsValue_____wasm_bindgen_d6cb7d81ec28c0ae___sys__Undefined_______true_: (a: number, b: number, c: any, d: any) => void;

package/emu198x_spectrum_web.js

@@ -45,6 +45,9 @@ export class Spectrum {
      * the editor prompt to be repainted before it is read, and for the 128K
      * family's loader to be listening before the tape rolls.
      *
+     * A machine that has already run is reset first, keeping the tape, so
+     * choosing a tape works however the machine has been used (#1569).
+     *
      * Returns the number of frames spent waiting for boot. Load a tape first.
      *
      * # Errors
@@ -74,7 +77,7 @@ export class Spectrum {
     /**
      * Builds a 48K attached to `canvas`, from ROM bytes the page supplies.
      *
-     * Async even though nothing here awaits: restoring the GPU path (#1436)
+     * Async even though nothing here awaits: adopting the GPU path (#1414)
      * needs an adapter, and acquiring one is async. Shipping this synchronous
      * would make that a breaking change for every consumer.
      *
@@ -253,6 +256,14 @@ export class Spectrum {
         wasm.__wbindgen_free(ret[0], ret[1] * 4, 4);
         return v1;
     }
+    /**
+     * Frame period derived from the machine profile.
+     * @returns {number}
+     */
+    frame_ms() {
+        const ret = wasm.spectrum_frame_ms(this.__wbg_ptr);
+        return ret;
+    }
     /**
      * Presses a key, from a DOM `KeyboardEvent.code`.
      *
@@ -401,6 +412,18 @@ export class Spectrum {
         wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
         return v1;
     }
+    /**
+     * Restores compatible machine state, clearing pending host input/audio.
+     * @param {Uint8Array} bytes
+     */
+    restore_state(bytes) {
+        const ptr0 = passArray8ToWasm0(bytes, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.spectrum_restore_state(this.__wbg_ptr, ptr0, len0);
+        if (ret[1]) {
+            throw takeFromExternrefTable0(ret[0]);
+        }
+    }
     /**
      * Returns the executed routine events and whether the stop was reached.
      *
@@ -461,6 +484,19 @@ export class Spectrum {
             throw takeFromExternrefTable0(ret[0]);
         }
     }
+    /**
+     * Exports the current machine state.
+     * @returns {Uint8Array}
+     */
+    save_state() {
+        const ret = wasm.spectrum_save_state(this.__wbg_ptr);
+        if (ret[3]) {
+            throw takeFromExternrefTable0(ret[2]);
+        }
+        var v1 = getArrayU8FromWasm0(ret[0], ret[1]).slice();
+        wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
+        return v1;
+    }
     /**
      * Returns captured writes (including ROM writes) and saturation status.
      * Consumers can select the program's PC range without inventing a trace.
@@ -494,6 +530,17 @@ export class Spectrum {
     setAudioEnabled(enabled) {
         wasm.spectrum_setAudioEnabled(this.__wbg_ptr, enabled);
     }
+    /**
+     * Advances exactly one frame without drawing to a canvas.
+     * # Errors
+     * Returns the runtime's execution error.
+     */
+    step() {
+        const ret = wasm.spectrum_step(this.__wbg_ptr);
+        if (ret[1]) {
+            throw takeFromExternrefTable0(ret[0]);
+        }
+    }
     /**
      * Runs the machine for `elapsed_ms` of real time and draws the result.
      *
@@ -659,7 +706,7 @@ function __wbg_get_imports() {
             return ret;
         },
         __wbindgen_cast_0000000000000001: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 30, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
+            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 29, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
             const ret = makeMutClosure(arg0, arg1, wasm_bindgen_d6cb7d81ec28c0ae___convert__closures_____invoke___wasm_bindgen_d6cb7d81ec28c0ae___JsValue__core_f0fd674eaa06beef___result__Result_____wasm_bindgen_d6cb7d81ec28c0ae___JsError___true_);
             return ret;
         },

package/package.json

@@ -2,7 +2,7 @@
   "name": "@emu198x/zx-spectrum",
   "type": "module",
   "description": "ZX Spectrum in the browser, published to npm as @emu198x/zx-spectrum",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "license": "SEE LICENSE IN README.md",
   "repository": {
     "type": "git",