Implemented roDeviceInfoEvent (#429)

* Improved `roDeviceInfo`

* Implemented `roDeviceInfoEvent`

* Prevent CLI to print syslog messages

* Static analysis fix

* Prettier fix

* Fixed Event and test cases

* Reformatted test case

* Removed unused import

src/api/index.ts

@@ -529,6 +529,8 @@ function workerCallback(event: MessageEvent) {
         addVideo(event.data.videoPath, new Blob([event.data.videoData], { type: "video/mp4" }));
     } else if (typeof event.data.displayEnabled === "boolean") {
         setDisplayState(event.data.displayEnabled);
+    } else if (typeof event.data.captionsMode === "string") {
+        deviceData.captionsMode = event.data.captionsMode;
     } else if (isAppData(event.data)) {
         notifyAll("launch", { app: event.data.id, params: event.data.params ?? new Map() });
     } else if (isNDKStart(event.data)) {

src/cli/index.ts

@@ -477,7 +477,7 @@ function handleStringMessage(message: string) {
         if (msg !== AppExitReason.FINISHED) {
             process.exitCode = 1;
         }
-    } else if (!["start", "debug", "reset", "video", "audio"].includes(mType)) {
+    } else if (!["start", "debug", "reset", "video", "audio", "syslog"].includes(mType)) {
         console.info(chalk.blueBright(message.trimEnd()));
     }
 }

src/core/brsTypes/components/BrsObjects.ts

@@ -160,7 +160,7 @@ export const BrsObjects = new BrsObjectsMap([
         1,
     ],
     ["roAppInfo", (_: Interpreter) => new RoAppInfo()],
-    ["roDeviceInfo", (_: Interpreter) => new RoDeviceInfo()],
+    ["roDeviceInfo", (interpreter: Interpreter) => new RoDeviceInfo(interpreter)],
     ["roRemoteInfo", (_: Interpreter) => new RoRemoteInfo()],
     ["roAppMemoryMonitor", (_: Interpreter) => new RoAppMemoryMonitor()],
     ["roAudioPlayer", (interpreter: Interpreter) => new RoAudioPlayer(interpreter)],

src/core/brsTypes/components/RoAppManager.ts

@@ -298,7 +298,8 @@ export class RoAppManager extends BrsComponent implements BrsValue {
             args: [new StdlibArgument("disabled", ValueKind.Boolean)],
             returns: ValueKind.Void,
         },
-        impl: (_: Interpreter, disabled: BrsBoolean) => {
+        impl: (interpreter: Interpreter, disabled: BrsBoolean) => {
+            interpreter.displayEnabled = !disabled.toBoolean();
             postMessage({ displayEnabled: !disabled.toBoolean() });
             return Uninitialized.Instance;
         },

src/core/brsTypes/components/RoDeviceInfoEvent.ts

@@ -0,0 +1,66 @@
+import { BrsValue, ValueKind, BrsBoolean } from "../BrsType";
+import { BrsComponent } from "./BrsComponent";
+import { BrsType, toAssociativeArray } from "..";
+import { Callable } from "../Callable";
+import { Interpreter } from "../../interpreter";
+
+export class RoDeviceInfoEvent extends BrsComponent implements BrsValue {
+    readonly kind = ValueKind.Object;
+    private readonly data: any;
+    private readonly isStatusMsg: boolean = false;
+    private readonly isCaptionModeMsg: boolean = false;
+
+    constructor(data: any) {
+        super("roDeviceInfoEvent");
+        this.data = data;
+        if (typeof data.Mode === "string") {
+            this.isCaptionModeMsg = true;
+        } else {
+            this.isStatusMsg = true;
+        }
+        this.registerMethods({
+            ifDeviceInfoEvent: [this.getInfo, this.isStatusMessage, this.isCaptionModeChanged],
+        });
+    }
+
+    toString(parent?: BrsType): string {
+        return "<Component: roDeviceInfoEvent>";
+    }
+
+    equalTo(other: BrsType) {
+        return BrsBoolean.False;
+    }
+
+    /** Checks if the device status has changed. */
+    private readonly isStatusMessage = new Callable("isStatusMessage", {
+        signature: {
+            args: [],
+            returns: ValueKind.Boolean,
+        },
+        impl: (_: Interpreter) => {
+            return BrsBoolean.from(this.isStatusMsg);
+        },
+    });
+
+    /** Indicates whether the user has changed the closed caption mode. */
+    private readonly isCaptionModeChanged = new Callable("isCaptionModeChanged", {
+        signature: {
+            args: [],
+            returns: ValueKind.Boolean,
+        },
+        impl: (_: Interpreter) => {
+            return BrsBoolean.from(this.isCaptionModeMsg);
+        },
+    });
+
+    /** Returns an roAssociativeArray with the current status of the device or the caption mode. */
+    private readonly getInfo = new Callable("getInfo", {
+        signature: {
+            args: [],
+            returns: ValueKind.Object,
+        },
+        impl: (_: Interpreter) => {
+            return toAssociativeArray(this.data);
+        },
+    });
+}

src/core/brsTypes/index.ts

@@ -33,6 +33,7 @@ import { RoInputEvent } from "./components/RoInputEvent";
 import { RoAudioPlayerEvent } from "./components/RoAudioPlayerEvent";
 import { RoVideoPlayerEvent } from "./components/RoVideoPlayerEvent";
 import { RoChannelStoreEvent } from "./components/RoChannelStoreEvent";
+import { RoDeviceInfoEvent } from "./components/RoDeviceInfoEvent";
 
 export * from "./BrsType";
 export * from "./Int32";
@@ -91,6 +92,7 @@ export * from "./components/RoLocalization";
 export * from "./components/RoRegistry";
 export * from "./components/RoRegistrySection";
 export * from "./components/RoDeviceInfo";
+export * from "./components/RoDeviceInfoEvent";
 export * from "./components/RoRemoteInfo";
 export * from "./components/RoAppMemoryMonitor";
 export * from "./components/RoFileSystem";
@@ -224,7 +226,8 @@ export function isBrsEvent(value: BrsType): value is BrsEvent {
         value instanceof RoInputEvent ||
         value instanceof RoAudioPlayerEvent ||
         value instanceof RoVideoPlayerEvent ||
-        value instanceof RoChannelStoreEvent
+        value instanceof RoChannelStoreEvent ||
+        value instanceof RoDeviceInfoEvent
     );
 }
 
@@ -236,7 +239,8 @@ export type BrsEvent =
     | RoInputEvent
     | RoAudioPlayerEvent
     | RoVideoPlayerEvent
-    | RoChannelStoreEvent;
+    | RoChannelStoreEvent
+    | RoDeviceInfoEvent;
 
 /**
  * The set of all comparable BrightScript types. Only primitive (i.e. intrinsic * and unboxed)

src/core/common.ts

@@ -28,6 +28,7 @@ export interface DeviceInfo {
     captionLanguage: string;
     clockFormat: string;
     displayMode: "480p" | "720p" | "1080p";
+    captionsMode: "Off" | "On" | "Instant replay" | "When mute";
     defaultFont: string;
     fontPath: string;
     fonts?: Map<string, any>;
@@ -63,6 +64,7 @@ export const defaultDeviceInfo: DeviceInfo = {
     captionLanguage: "eng",
     clockFormat: "12h",
     displayMode: "720p",
+    captionsMode: "Off",
     defaultFont: "Asap",
     fontPath: "../fonts/",
     fonts: new Map(),

src/core/interpreter/index.ts

@@ -165,6 +165,7 @@ export class Interpreter implements Expr.Visitor<BrsType>, Stmt.Visitor<BrsType>
         return this._creationTime;
     }
 
+    public displayEnabled: boolean = true;
     public lastRemote: number = 0;
     public lastKeyTime: number = Date.now();
     public currKeyTime: number = Date.now();