@amazon-devices/kepler-graphics 2.3.3

package/dist/types/GraphicsTypes.d.ts

@@ -0,0 +1,350 @@
+import { Double } from '@amazon-devices/keplerscript-turbomodule-api';
+import { Int32 } from 'react-native-tscodegen-types';
+/**
+ * Interface for unsubscribing listener.
+ */
+export interface ISubscription {
+    /**
+     * Helps to unsubscribe a registered callback listener.
+     */
+    unsubscribe: () => void;
+}
+/**
+ * Defines Different color space types in a display.
+ */
+export declare enum ColorSpace {
+    /**
+     * Invalid color space type
+     */
+    INVALID = 1,
+    /**
+     * Color space type is automatic i.e display server is free to choose any color space. This is default.
+     */
+    AUTO = 2,
+    /**
+     * display server is requested to use RGB color space
+     */
+    RGB = 3,
+    /**
+     * display server is requested to use YCbCr color space
+     */
+    YCBCR = 4
+}
+/**
+ * Defines all possible color depths in a display.
+ */
+export declare enum ColorDepth {
+    /**
+     * Unknown color depth type
+     */
+    COLORDEPTH_UNKNOWN = 1,
+    /**
+     * Color depth type is automatic i.e display server is free to choose any. This is default.
+     */
+    COLORDEPTH_AUTO = 2,
+    /**
+     * Display server is free to choose any color depth up to 8 bits per channel.
+     */
+    COLORDEPTH_8 = 3,
+    /**
+     * Display server is free to choose any color depth up to 10 bits per channel.
+     */
+    COLORDEPTH_10 = 4,
+    /**
+     * Display server is free to choose any color depth up to 12 bits per channel.
+     */
+    COLORDEPTH_12 = 5
+}
+/**
+ * Defines values for High dynamic range mode for display
+ */
+export declare enum HdrMode {
+    /**
+     * High dynamic range is disabled
+     */
+    DISABLED = 0,
+    /**
+     * High dynamic range mode usage depends on current settings.
+     */
+    ADAPTIVE = 1,
+    /**
+     * always use high dynamic range mode
+     */
+    ALWAYS = 2
+}
+/**
+ * Defines list of supported underlying HDR technologies
+ */
+export declare enum HdrType {
+    /**
+     * No HDR is supported
+     */
+    NONE = 1,
+    /**
+     * HDR10 Display
+     */
+    HDR10 = 2,
+    /**
+     * HDR10+ Display
+     */
+    HDR10_PLUS = 3,
+    /**
+     * Hybrid Log-Gamma HDR display.
+     */
+    HLG = 4,
+    /**
+     * Dolby Vision high dynamic range (HDR) display.
+     */
+    DOLBY_VISION = 5
+}
+/**
+ * Defines list of Color gamut types.
+ */
+export declare enum ColorGamut {
+    /**
+     * sRGB standard which has same color primaries of REC.709 or BT.709 standard
+     */
+    SRGB = "srgb",
+    /**
+     * DCI P3 Color Space color gamut
+     */
+    P3 = "p3",
+    /**
+     *  ITU-R Recommendation BT.2020 (REC.2020)  color gamut.
+     */
+    REC_2020 = "rec2020"
+}
+/**
+ * Defines list of display Transfer Functions
+ */
+export declare enum TransferFunction {
+    /**
+     * sRGB standard transfer function.
+     */
+    SRGB = "srgb",
+    /**
+     * Perceptual Quantizer transfer function.
+     */
+    PQ = "pq",
+    /**
+     * Hybrid Log Gamma transfer function.
+     */
+    HLG = "hlg"
+}
+/**
+ * Defines all possible low latency mode (LLM) states that could be supported by a display.
+ */
+export declare enum LlmState {
+    /**
+     * LLM state Auto - display subsystem is free to choose any LLM state.
+     */
+    LLM_AUTO = 1,
+    /**
+     * LLM state ON - display subsystem is instructed to enable LLM unconditionally and allows it to enable
+     * one of the supported low latency modes.
+     */
+    LLM_ON = 2,
+    /**
+     * LLM state OFF - display subsystem is instructed to disable LLM unconditionally.
+     */
+    LLM_OFF = 3
+}
+/**
+ * Defines all possible HDCP levels that could be supported by a display.
+ */
+export declare enum HdcpLevel {
+    /**
+     * Invalid HDCP level
+     */
+    INVALID = 1,
+    /**
+     * HDCP level Version 1.0
+     */
+    V_1_0 = 2,
+    /**
+     * HDCP level Version 2.0
+     */
+    V_2_0 = 3,
+    /**
+     * HDCP level Version 2.1
+     */
+    V_2_1 = 4,
+    /**
+     * HDCP level Version 2.2
+     */
+    V_2_2 = 5,
+    /**
+     * HDCP level Version 2.3
+     */
+    V_2_3 = 6,
+    /**
+     * HDCP level Version 2.4
+     */
+    V_2_4 = 7
+}
+/**
+ * Buffer Pixel Format specifies the memory layout and bits used to store the
+ * data within the buffer.
+ */
+export declare enum BufferPixelFormat {
+    /**
+     * Buffer format is unknown or customized format.
+     */
+    UNKNOWN = "UNKNOWN",
+    YUYV = "YUYV",
+    YVU420 = "YV12",
+    NV12 = "NV12",
+    YUV420 = "YU12",
+    FLEX_YCbCr_420_888 = "9999",
+    FLEX_YCbCr_420_101010 = "8888",
+    UYVY = "UYVY",
+    RGB888 = "RG24",
+    ARGB8888 = "AR24"
+}
+export interface IDisplayConfig {
+    /**
+     * Width in pixels for this config
+     */
+    readonly widthInPixels: Int32;
+    /**
+     * Height in pixels for this config
+     */
+    readonly heightInPixels: Int32;
+    /**
+     * Physical/native screen density expressed as dots-per-inch (DPI)
+     */
+    readonly screenDensityInDpi: Int32;
+    /**
+     * Maximum  HDCP (High-bandwidth Digital Content Protection) level supported on
+     * this display config
+     */
+    readonly maxHdcpLevel: HdcpLevel;
+    /**
+     * List of all supported refresh rates in mHz (millihertz) for this mode
+     * HDR types are correlated with refresh rates. For each refresh rate, there
+     * is a corresponding HDR type support information.
+     */
+    supportedRefreshRatesInMillihertz: Array<Int32>;
+    /**
+     * List of all supported HdrType for this config
+     * HDR types are correlated with refresh rates. For each refresh rate, there
+     * is a corresponding HDR type support information.
+     */
+    supportedHdrType: Array<HdrType>;
+}
+/**
+ * Interface that handles the overscan border data.
+ * Each border value is expressed as percentage of the display
+ * width or height. The valid range of values for each border
+ * is 0 to 0.15, where 0 means no overscan and 0.15 refers to
+ * 15% overscan in a side.
+ */
+export interface IOverscanBorder {
+    /**
+     * Left border as a fraction of the display width.
+     */
+    left: Double;
+    /**
+     * Top border as a fraction of the display height.
+     */
+    top: Double;
+    /**
+     * Right border as a fraction of the display width.
+     */
+    right: Double;
+    /**
+     * Bottom border as a fraction of the display height.
+     */
+    bottom: Double;
+}
+/**
+ * Listener interface for different display events
+ */
+export interface IDisplayListener {
+    /**
+     * Triggered when the mode of the display is changed.
+     * @param config the new display config.
+     */
+    onConfigChange: (config: IDisplayConfig) => void;
+    /**
+     * Triggered when refresh rate for the display is changed.
+     * @param refreshRate the new refresh rate in mHz (millihertz)
+     */
+    onRefreshRateChange: (refreshRateInrMillihertz: Int32) => void;
+    /**
+     * Triggered when color depth of the display is changed.
+     * @param colorDepth the new color depth for the display.
+     */
+    onColorDepthChange: (colorDepth: ColorDepth) => void;
+    /**
+     * Triggered when color space of the display is changed.
+     * @param colorSpace the new color space for the display.
+     */
+    onColorSpaceChange: (colorSpace: ColorSpace) => void;
+    /**
+     * Triggered when HDCP level of the display is changed.
+     * @param level the new HDCP level.
+     */
+    onHdcpLevelChange: (level: HdcpLevel) => void;
+    /**
+     * Triggered when auto config switch state of the display is changed.
+     * @param state the new state of auto config switch state.
+     */
+    onAutoConfigSwitchStateChange: (state: boolean) => void;
+    /**
+     * Triggered when multiple refresh rate (MRR) state of the display is changed.
+     * @param state the new MRR state, true means enabled
+     */
+    onMultipleRefreshRateStateChange: (state: boolean) => void;
+    /**
+     * Triggered when low latency mode (LLM) state of the display is changed.
+     * @param state the new LLM state
+     */
+    onLowLatencyModeStateChange: (state: LlmState) => void;
+    /**
+     * Triggered when HDR mode of the display is changed.
+     * @param hdr_mode new changed HDR mode
+     */
+    onHdrModeChange: (hdr_mode: HdrMode) => void;
+    /**
+     * Triggered when sink state of the display is changed.
+     * @param active new sink state, true means active
+     */
+    onSinkStateChange?: (active: boolean) => void;
+}
+/**
+ * Listener interface for DisplayController events.
+ * NOTE: Currently only primary display hot plug events are supported in this
+ * turbomodule.
+ */
+export interface IDisplayControllerListener {
+    /**
+     * Triggered when a new display is added.
+     * @param id An unique identifier of the display being added.
+     */
+    onAddDisplay: (id: Int32) => void;
+    /**
+     * Triggered when a display is removed.
+     * When a display is removed then the "Display" object should not be
+     * used to do any operation rather it should wait for onAddDisplay() event
+     * and then use the "Display" object, otherwise the "Display" object behaviour
+     * is undefined.
+     * @param id An unique identifier for the primary display being removed.
+     */
+    onRemoveDisplay: (id: Int32) => void;
+}
+/**
+ * Listener interface for DisplayManager events.
+ */
+export interface IDisplayManagerListener {
+    /**
+     * Callback triggered when a commit operation is successful
+     * @param id Unique identifier of commit state.
+     */
+    onCommitSuccess: (id: Int32) => void;
+    /**
+     * Callback triggered when a commit operation fails.
+     * @param id Unique identifier of commit state.
+     */
+    onCommitFailure: (id: Int32) => void;
+}

package/dist/types/GraphicsTypes.js

@@ -0,0 +1,221 @@
+"use strict";
+/*
+ * Copyright (c) 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * PROPRIETARY/CONFIDENTIAL
+ *
+ * Use is subject to license terms.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BufferPixelFormat = exports.HdcpLevel = exports.LlmState = exports.TransferFunction = exports.ColorGamut = exports.HdrType = exports.HdrMode = exports.ColorDepth = exports.ColorSpace = void 0;
+/**
+ * Defines Different color space types in a display.
+ */
+var ColorSpace;
+(function (ColorSpace) {
+    /**
+     * Invalid color space type
+     */
+    ColorSpace[ColorSpace["INVALID"] = 1] = "INVALID";
+    /**
+     * Color space type is automatic i.e display server is free to choose any color space. This is default.
+     */
+    ColorSpace[ColorSpace["AUTO"] = 2] = "AUTO";
+    /**
+     * display server is requested to use RGB color space
+     */
+    ColorSpace[ColorSpace["RGB"] = 3] = "RGB";
+    /**
+     * display server is requested to use YCbCr color space
+     */
+    ColorSpace[ColorSpace["YCBCR"] = 4] = "YCBCR";
+})(ColorSpace = exports.ColorSpace || (exports.ColorSpace = {}));
+;
+/**
+ * Defines all possible color depths in a display.
+ */
+var ColorDepth;
+(function (ColorDepth) {
+    /**
+     * Unknown color depth type
+     */
+    ColorDepth[ColorDepth["COLORDEPTH_UNKNOWN"] = 1] = "COLORDEPTH_UNKNOWN";
+    /**
+     * Color depth type is automatic i.e display server is free to choose any. This is default.
+     */
+    ColorDepth[ColorDepth["COLORDEPTH_AUTO"] = 2] = "COLORDEPTH_AUTO";
+    /**
+     * Display server is free to choose any color depth up to 8 bits per channel.
+     */
+    ColorDepth[ColorDepth["COLORDEPTH_8"] = 3] = "COLORDEPTH_8";
+    /**
+     * Display server is free to choose any color depth up to 10 bits per channel.
+     */
+    ColorDepth[ColorDepth["COLORDEPTH_10"] = 4] = "COLORDEPTH_10";
+    /**
+     * Display server is free to choose any color depth up to 12 bits per channel.
+     */
+    ColorDepth[ColorDepth["COLORDEPTH_12"] = 5] = "COLORDEPTH_12";
+})(ColorDepth = exports.ColorDepth || (exports.ColorDepth = {}));
+;
+/**
+ * Defines values for High dynamic range mode for display
+ */
+var HdrMode;
+(function (HdrMode) {
+    /**
+     * High dynamic range is disabled
+     */
+    HdrMode[HdrMode["DISABLED"] = 0] = "DISABLED";
+    /**
+     * High dynamic range mode usage depends on current settings.
+     */
+    HdrMode[HdrMode["ADAPTIVE"] = 1] = "ADAPTIVE";
+    /**
+     * always use high dynamic range mode
+     */
+    HdrMode[HdrMode["ALWAYS"] = 2] = "ALWAYS";
+})(HdrMode = exports.HdrMode || (exports.HdrMode = {}));
+;
+/**
+ * Defines list of supported underlying HDR technologies
+ */
+var HdrType;
+(function (HdrType) {
+    /**
+     * No HDR is supported
+     */
+    HdrType[HdrType["NONE"] = 1] = "NONE";
+    /**
+     * HDR10 Display
+     */
+    HdrType[HdrType["HDR10"] = 2] = "HDR10";
+    /**
+     * HDR10+ Display
+     */
+    HdrType[HdrType["HDR10_PLUS"] = 3] = "HDR10_PLUS";
+    /**
+     * Hybrid Log-Gamma HDR display.
+     */
+    HdrType[HdrType["HLG"] = 4] = "HLG";
+    /**
+     * Dolby Vision high dynamic range (HDR) display.
+     */
+    HdrType[HdrType["DOLBY_VISION"] = 5] = "DOLBY_VISION";
+})(HdrType = exports.HdrType || (exports.HdrType = {}));
+;
+/**
+ * Defines list of Color gamut types.
+ */
+var ColorGamut;
+(function (ColorGamut) {
+    /**
+     * sRGB standard which has same color primaries of REC.709 or BT.709 standard
+     */
+    ColorGamut["SRGB"] = "srgb";
+    /**
+     * DCI P3 Color Space color gamut
+     */
+    ColorGamut["P3"] = "p3";
+    /**
+     *  ITU-R Recommendation BT.2020 (REC.2020)  color gamut.
+     */
+    ColorGamut["REC_2020"] = "rec2020";
+})(ColorGamut = exports.ColorGamut || (exports.ColorGamut = {}));
+;
+/**
+ * Defines list of display Transfer Functions
+ */
+var TransferFunction;
+(function (TransferFunction) {
+    /**
+     * sRGB standard transfer function.
+     */
+    TransferFunction["SRGB"] = "srgb";
+    /**
+     * Perceptual Quantizer transfer function.
+     */
+    TransferFunction["PQ"] = "pq";
+    /**
+     * Hybrid Log Gamma transfer function.
+     */
+    TransferFunction["HLG"] = "hlg";
+})(TransferFunction = exports.TransferFunction || (exports.TransferFunction = {}));
+;
+/**
+ * Defines all possible low latency mode (LLM) states that could be supported by a display.
+ */
+var LlmState;
+(function (LlmState) {
+    /**
+     * LLM state Auto - display subsystem is free to choose any LLM state.
+     */
+    LlmState[LlmState["LLM_AUTO"] = 1] = "LLM_AUTO";
+    /**
+     * LLM state ON - display subsystem is instructed to enable LLM unconditionally and allows it to enable
+     * one of the supported low latency modes.
+     */
+    LlmState[LlmState["LLM_ON"] = 2] = "LLM_ON";
+    /**
+     * LLM state OFF - display subsystem is instructed to disable LLM unconditionally.
+     */
+    LlmState[LlmState["LLM_OFF"] = 3] = "LLM_OFF";
+})(LlmState = exports.LlmState || (exports.LlmState = {}));
+;
+/**
+ * Defines all possible HDCP levels that could be supported by a display.
+ */
+var HdcpLevel;
+(function (HdcpLevel) {
+    /**
+     * Invalid HDCP level
+     */
+    HdcpLevel[HdcpLevel["INVALID"] = 1] = "INVALID";
+    /**
+     * HDCP level Version 1.0
+     */
+    HdcpLevel[HdcpLevel["V_1_0"] = 2] = "V_1_0";
+    /**
+     * HDCP level Version 2.0
+     */
+    HdcpLevel[HdcpLevel["V_2_0"] = 3] = "V_2_0";
+    /**
+     * HDCP level Version 2.1
+     */
+    HdcpLevel[HdcpLevel["V_2_1"] = 4] = "V_2_1";
+    /**
+     * HDCP level Version 2.2
+     */
+    HdcpLevel[HdcpLevel["V_2_2"] = 5] = "V_2_2";
+    /**
+     * HDCP level Version 2.3
+     */
+    HdcpLevel[HdcpLevel["V_2_3"] = 6] = "V_2_3";
+    /**
+     * HDCP level Version 2.4
+     */
+    HdcpLevel[HdcpLevel["V_2_4"] = 7] = "V_2_4";
+})(HdcpLevel = exports.HdcpLevel || (exports.HdcpLevel = {}));
+;
+/**
+ * Buffer Pixel Format specifies the memory layout and bits used to store the
+ * data within the buffer.
+ */
+var BufferPixelFormat;
+(function (BufferPixelFormat) {
+    /**
+     * Buffer format is unknown or customized format.
+     */
+    BufferPixelFormat["UNKNOWN"] = "UNKNOWN";
+    BufferPixelFormat["YUYV"] = "YUYV";
+    BufferPixelFormat["YVU420"] = "YV12";
+    BufferPixelFormat["NV12"] = "NV12";
+    BufferPixelFormat["YUV420"] = "YU12";
+    BufferPixelFormat["FLEX_YCbCr_420_888"] = "9999";
+    BufferPixelFormat["FLEX_YCbCr_420_101010"] = "8888";
+    BufferPixelFormat["UYVY"] = "UYVY";
+    BufferPixelFormat["RGB888"] = "RG24";
+    BufferPixelFormat["ARGB8888"] = "AR24";
+})(BufferPixelFormat = exports.BufferPixelFormat || (exports.BufferPixelFormat = {}));
+;
+;

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+import { ColorSpace, ColorDepth, HdrMode, HdrType, LlmState, HdcpLevel, BufferPixelFormat, ColorGamut, TransferFunction, IDisplayConfig, IOverscanBorder, IDisplayListener, IDisplayControllerListener, ISubscription, IDisplayManagerListener } from './GraphicsTypes';
+export { ColorDepth, ColorSpace, HdrMode, HdrType, LlmState, HdcpLevel, BufferPixelFormat, ColorGamut, TransferFunction, type IDisplayConfig, type IOverscanBorder, type IDisplayListener, type IDisplayControllerListener, type ISubscription, type IDisplayManagerListener, };

package/dist/types/index.js

@@ -0,0 +1,20 @@
+"use strict";
+/*
+ * Copyright (c) 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * PROPRIETARY/CONFIDENTIAL
+ *
+ * Use is subject to license terms.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransferFunction = exports.ColorGamut = exports.BufferPixelFormat = exports.HdcpLevel = exports.LlmState = exports.HdrType = exports.HdrMode = exports.ColorSpace = exports.ColorDepth = void 0;
+const GraphicsTypes_1 = require("./GraphicsTypes");
+Object.defineProperty(exports, "ColorSpace", { enumerable: true, get: function () { return GraphicsTypes_1.ColorSpace; } });
+Object.defineProperty(exports, "ColorDepth", { enumerable: true, get: function () { return GraphicsTypes_1.ColorDepth; } });
+Object.defineProperty(exports, "HdrMode", { enumerable: true, get: function () { return GraphicsTypes_1.HdrMode; } });
+Object.defineProperty(exports, "HdrType", { enumerable: true, get: function () { return GraphicsTypes_1.HdrType; } });
+Object.defineProperty(exports, "LlmState", { enumerable: true, get: function () { return GraphicsTypes_1.LlmState; } });
+Object.defineProperty(exports, "HdcpLevel", { enumerable: true, get: function () { return GraphicsTypes_1.HdcpLevel; } });
+Object.defineProperty(exports, "BufferPixelFormat", { enumerable: true, get: function () { return GraphicsTypes_1.BufferPixelFormat; } });
+Object.defineProperty(exports, "ColorGamut", { enumerable: true, get: function () { return GraphicsTypes_1.ColorGamut; } });
+Object.defineProperty(exports, "TransferFunction", { enumerable: true, get: function () { return GraphicsTypes_1.TransferFunction; } });

package/kepler-compatibility.json

@@ -0,0 +1,8 @@
+{
+  "versions": {
+    "2.3.0": "/com.amazon.kepler.kepler_graphics_2@IKeplerGraphics_1",
+    "2.3.1": "/com.amazon.kepler.kepler_graphics_2@IKeplerGraphics_1",
+    "2.3.2": "/com.amazon.kepler.kepler_graphics_2@IKeplerGraphics_1",
+    "2.3.3": "/com.amazon.kepler.kepler_graphics_2@IKeplerGraphics_1",
+  }
+}

package/kepler-transformed-package-info.json

@@ -0,0 +1,3 @@
+{
+  "sourcePackageRef": "@amzn/kepler-graphics"
+}

package/package.json

@@ -0,0 +1 @@
+{"name": "@amazon-devices/kepler-graphics", "version": "2.3.3", "main": "dist/index.js", "types": "dist/index.d.ts", "files": ["dist", "react-native.config.js", "kepler-compatibility.json", "SystemModules", "SystemBundles", "kepler-transformed-package-info.json"], "scripts": {"clean": "rm -rf node_modules buildinfo.json dist bvm", "test": "jest --colors", "lint": "eslint src tst --ext .ts,.tsx", "lint:fix": "eslint src tst --ext .ts,.tsx --fix", "compile": "tsc -p tsconfig-build.json", "docgen": "npx typedoc --basePath src/ -entryPointStrategy expand --excludePrivate --excludeProtected --excludeInternal --excludeNotDocumented --disableSources --hideGenerator src/", "build": "npm-run-all compile docgen", "release": "npm-run-all lint test compile docgen", "prepublishOnly": "KEPLER_NPM_COMMAND=npm-pretty-much react-native build-system-bundle-kepler"}, "dependencies": {"@amazon-devices/keplerscript-turbomodule-api": "^1.0.0", "react-native-tscodegen-types": "0.66.0"}, "devDependencies": {"@babel/core": "^7.20.0", "@babel/runtime": "^7.20.0", "@react-native/eslint-config": "0.72.2", "@types/jest": "^28.0.0", "@typescript-eslint/eslint-plugin": "^5.30.0", "babel-jest": "^28.0.0", "eslint": "^8.12.0", "@jest/globals": "^28.0.0", "jest": "^28.0.0", "metro-react-native-babel-preset": "^0.76.5", "npm-run-all": "^4.1.5", "prettier": "^2.6.2", "ts-jest": "^28.0.0", "typedoc": "^0.25.x", "typescript": "4.8.4", "@amazon-devices/kepler-cli-platform": "^0", "@react-native-community/cli": "^11.2.0"}, "kepler": {"projectType": "turbomodule", "targets": ["tv", "auto"], "toolchain": "clang", "features": ["vega"]}, "license": "See license in LICENSE"}

package/react-native.config.js

@@ -0,0 +1,16 @@
+module.exports = {
+    dependency: {
+        platforms: {
+            kepler: {
+                autolink: {
+                    'amazonkeplergraphicslib': { // The key is the public name of your library
+                        libraryName: 'libkeplerscript-graphics-lib-2.so', // the filename of your library including the filename extension
+                        linkDynamic: true, // True to load when called, false to load on app start
+                        turbomodules: ['AmazonGraphicsTurboModule'], // The names of registered Turbo Modules (this is the string used when registering in both JS and C++
+                        components: []
+                    },
+                },
+            },
+        },
+    },
+};