@henols/c64-re-tools 2.0.0-rc.6 → 2.0.0-rc.7

package/src/protocol/vice.ts

@@ -259,6 +259,8 @@ export interface Rectangle {
 export interface ScreenComparison {
   match: boolean;
   mismatchingPixels: number;
+  /** Pixels compared: the frame minus the masked ones; always at least 1. */
+  comparedPixels: number;
   mismatchRatio: number;
   /** Absent when no pixel differs. */
   bounds?: Rectangle;
@@ -310,6 +312,8 @@ export interface MachineStatus {
   window: boolean;
   /** Present only while the C64 CPU is stopped. */
   pc?: number;
+  /** Present, true, while a cartridge from an autostart is attached. */
+  cartridge?: true;
 }
 
 export interface MemoryReadParams {
@@ -417,7 +421,8 @@ export interface ViceOperations {
   /** Attachment: the PRG bytes, load address first. */
   programLoad: { params: { address?: number }; result: { state: RunState; loadAddress: number; size: number } };
   /** Attachment: the program or image bytes; `type` is the file's extension. `index` is VICE's file number: 0 loads "*", 1 is the first directory entry. */
-  autostart: { params: { type: string; index: number; run: boolean }; result: { state: RunState } };
+  /** `emulatorFlaw`: for a tape image, a known flaw of the host's VICE version that a tape load meets (D56). */
+  autostart: { params: { type: string; index: number; run: boolean }; result: { state: RunState; emulatorFlaw?: string } };
   /** Attachment: the disk image bytes; `type` is the file's extension. */
   diskAttach: { params: { type: string }; result: { attached: boolean } };
   /** pc is the reset vector when run is false: the CPU stops there. */
@@ -966,7 +971,8 @@ export function validateViceResult<O extends ViceOperation>(op: O, value: unknow
         isOneOf(VIDEO_STANDARDS, value.videoStandard) &&
         typeof value.warp === "boolean" &&
         typeof value.window === "boolean" &&
-        (value.pc === undefined || isInteger(value.pc, 0, 0xffff));
+        (value.pc === undefined || isInteger(value.pc, 0, 0xffff)) &&
+        (value.cartridge === undefined || value.cartridge === true);
       if (!ok) throw new ProtocolError("status result is malformed");
       break;
     }
@@ -1052,6 +1058,7 @@ export function validateViceResult<O extends ViceOperation>(op: O, value: unknow
     case "autostart": {
       if (!isOneOf(RUN_STATES, value.state)) throw new ProtocolError(`${op} result is malformed`);
       if (op === "reset" && value.pc !== undefined && !isInteger(value.pc, 0, 0xffff)) throw new ProtocolError("reset result is malformed");
+      if (op === "autostart" && !(value.emulatorFlaw === undefined || typeof value.emulatorFlaw === "string")) throw new ProtocolError("autostart result is malformed");
       break;
     }
     case "programLoad": {
@@ -1082,6 +1089,8 @@ export function validateViceResult<O extends ViceOperation>(op: O, value: unknow
       const ok =
         typeof value.match === "boolean" &&
         isInteger(value.mismatchingPixels, 0, 1 << 20) &&
+        isInteger(value.comparedPixels, 1, 1 << 20) &&
+        (value.mismatchingPixels as number) <= (value.comparedPixels as number) &&
         typeof value.mismatchRatio === "number" &&
         value.mismatchRatio >= 0 &&
         value.mismatchRatio <= 1 &&