agora-electron-sdk 0.0.0-dev.1

package/js/Renderer/YUVCanvasRenderer/index.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.YUVCanvasRenderer = void 0;
+const IRenderer_1 = require("../IRenderer");
+const YUVBuffer = require('yuv-buffer');
+const YUVCanvas = require('yuv-canvas');
+class YUVCanvasRenderer extends IRenderer_1.IRenderer {
+    bind(element) {
+        super.bind(element);
+        this.frameSink = YUVCanvas.attach(this.canvas, {
+            webGL: false,
+        });
+    }
+    drawFrame({ width, height, yStride, uStride, vStride, yBuffer, uBuffer, vBuffer, rotation, alphaBuffer, }) {
+        this.rotateCanvas({ width, height, rotation });
+        this.updateRenderMode();
+        if (!this.frameSink)
+            return;
+        const frame = YUVBuffer.frame(YUVBuffer.format({
+            width,
+            height,
+            chromaWidth: width / 2,
+            chromaHeight: height / 2,
+            cropLeft: yStride - width,
+        }), {
+            bytes: yBuffer,
+            stride: yStride,
+        }, {
+            bytes: uBuffer,
+            stride: uStride,
+        }, {
+            bytes: vBuffer,
+            stride: vStride,
+        });
+        frame.a = alphaBuffer;
+        this.frameSink.drawFrame(frame);
+        super.drawFrame();
+    }
+    rotateCanvas({ width, height, rotation }) {
+        super.rotateCanvas({ width, height, rotation });
+        if (!this.canvas)
+            return;
+        this.canvas.style.transform += ` rotateZ(${rotation}deg)`;
+    }
+}
+exports.YUVCanvasRenderer = YUVCanvasRenderer;

package/js/Renderer/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./IRenderer"), exports);

package/js/Types.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.codecMapping = exports.IPCMessageType = exports.RendererType = exports.VideoFallbackStrategy = void 0;
+const AgoraBase_1 = require("./Private/AgoraBase");
+/**
+ * @ignore
+ */
+var VideoFallbackStrategy;
+(function (VideoFallbackStrategy) {
+    /**
+     * @ignore
+     */
+    VideoFallbackStrategy[VideoFallbackStrategy["PerformancePriority"] = 0] = "PerformancePriority";
+    /**
+     * @ignore
+     */
+    VideoFallbackStrategy[VideoFallbackStrategy["BandwidthPriority"] = 1] = "BandwidthPriority";
+})(VideoFallbackStrategy = exports.VideoFallbackStrategy || (exports.VideoFallbackStrategy = {}));
+/**
+ * @ignore
+ */
+var RendererType;
+(function (RendererType) {
+    /**
+     * @ignore
+     */
+    RendererType[RendererType["WEBGL"] = 1] = "WEBGL";
+    /**
+     * @ignore
+     */
+    RendererType[RendererType["SOFTWARE"] = 2] = "SOFTWARE";
+    /**
+     * @ignore
+     */
+    RendererType[RendererType["WEBCODECSRENDERER"] = 3] = "WEBCODECSRENDERER";
+})(RendererType = exports.RendererType || (exports.RendererType = {}));
+/**
+ * @ignore
+ */
+var IPCMessageType;
+(function (IPCMessageType) {
+    /**
+     * @ignore
+     */
+    IPCMessageType["AGORA_IPC_GET_GPU_INFO"] = "AGORA_IPC_GET_GPU_INFO";
+})(IPCMessageType = exports.IPCMessageType || (exports.IPCMessageType = {}));
+/**
+ * @ignore
+ */
+exports.codecMapping = [
+    {
+        codec: 'avc1.64e01f',
+        type: AgoraBase_1.VideoCodecType.VideoCodecH264,
+        profile: 'h264',
+    },
+    {
+        codec: 'hvc1.1.6.L5.90',
+        type: AgoraBase_1.VideoCodecType.VideoCodecH265,
+        profile: 'hevc',
+    },
+    { codec: 'vp8', type: AgoraBase_1.VideoCodecType.VideoCodecVp8, profile: 'vp8' },
+    {
+        codec: 'vp09.00.50.08',
+        type: AgoraBase_1.VideoCodecType.VideoCodecVp9,
+        profile: 'vp9',
+    },
+];

package/js/Utils.js

@@ -0,0 +1,187 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgoraEnv = exports.getContextByCanvas = exports.isSupportWebGL = exports.classMix = exports.objsKeysToLowerCase = exports.logDebug = exports.logInfo = exports.logError = exports.logWarn = exports.parseIntPtr2Number = exports.DEBUG_TAG = exports.TAG = void 0;
+const Types_1 = require("./Types");
+/**
+ * @ignore
+ */
+exports.TAG = '[Agora]: ';
+/**
+ * @ignore
+ */
+exports.DEBUG_TAG = '[Agora Debug]: ';
+/**
+ * @ignore
+ */
+function parseIntPtr2Number(value) {
+    try {
+        let bigIntVal = BigInt(value);
+        if (bigIntVal > 2n ** 63n - 1n) {
+            bigIntVal -= 2n ** 64n;
+        }
+        return Number(bigIntVal);
+    }
+    catch (e) {
+        return value;
+    }
+}
+exports.parseIntPtr2Number = parseIntPtr2Number;
+/**
+ * @ignore
+ */
+const logWarn = (msg, ...optParams) => {
+    if (!exports.AgoraEnv.enableLogging) {
+        return;
+    }
+    console.warn(`${exports.TAG} ${msg}`, ...optParams);
+};
+exports.logWarn = logWarn;
+/**
+ * @ignore
+ */
+const logError = (msg, ...optParams) => {
+    if (!exports.AgoraEnv.enableLogging) {
+        return;
+    }
+    console.error(`${exports.TAG} ${msg}`, ...optParams);
+};
+exports.logError = logError;
+const getCurrentTime = () => {
+    const date = new Date();
+    const year = date.getFullYear().toString().slice(-2);
+    const month = (date.getMonth() + 1).toString().padStart(2, '0');
+    const day = date.getDate().toString().padStart(2, '0');
+    const hours = date.getHours().toString().padStart(2, '0');
+    const minutes = date.getMinutes().toString().padStart(2, '0');
+    const seconds = date.getSeconds().toString().padStart(2, '0');
+    const milliseconds = date.getMilliseconds().toString().padStart(3, '0');
+    return `${month}/${day}/${year} ${hours}:${minutes}:${seconds}:${milliseconds}`;
+};
+/**
+ * @ignore
+ */
+const logInfo = (msg, ...optParams) => {
+    if (!exports.AgoraEnv.enableLogging) {
+        return;
+    }
+    console.info(`[${getCurrentTime()}]${exports.TAG} ${msg}`, ...optParams);
+};
+exports.logInfo = logInfo;
+/**
+ * @ignore
+ */
+const logDebug = (msg, ...optParams) => {
+    if (!exports.AgoraEnv.enableLogging || !exports.AgoraEnv.enableDebugLogging) {
+        return;
+    }
+    console.debug(`${exports.DEBUG_TAG} ${msg}`, ...optParams);
+};
+exports.logDebug = logDebug;
+/**
+ * @ignore
+ */
+const objsKeysToLowerCase = (array) => {
+    array.forEach((obj) => {
+        for (const key in obj) {
+            if (Object.prototype.hasOwnProperty.call(obj, key)) {
+                const element = obj[key];
+                obj[key.toLocaleLowerCase()] = element;
+            }
+        }
+    });
+};
+exports.objsKeysToLowerCase = objsKeysToLowerCase;
+/**
+ * @ignore
+ */
+function classMix(...mixins) {
+    class MixClass {
+        constructor() {
+            for (let mixin of mixins) {
+                copyProperties(this, new mixin()); // Copy instance properties
+            }
+        }
+    }
+    for (let mixin of mixins) {
+        copyProperties(MixClass, mixin); // Copy static properties
+        copyProperties(MixClass.prototype, mixin.prototype); // Copy prototype properties
+    }
+    return MixClass;
+}
+exports.classMix = classMix;
+function copyProperties(target, source) {
+    for (let key of Reflect.ownKeys(source)) {
+        if (key !== 'constructor' && key !== 'prototype' && key !== 'name') {
+            let desc = Object.getOwnPropertyDescriptor(source, key);
+            Object.defineProperty(target, key, desc);
+        }
+    }
+}
+/**
+ * @ignore
+ */
+function isSupportWebGL() {
+    let flag = false;
+    const canvas = document.createElement('canvas');
+    try {
+        const getContext = (contextNames = ['webgl2', 'webgl', 'experimental-webgl']) => {
+            for (let i = 0; i < contextNames.length; i++) {
+                const contextName = contextNames[i];
+                const context = canvas?.getContext(contextName);
+                if (context) {
+                    return context;
+                }
+            }
+            return null;
+        };
+        let gl = getContext();
+        flag = !!gl;
+        gl?.getExtension('WEBGL_lose_context')?.loseContext();
+        gl = null;
+        (0, exports.logInfo)('Your browser support webGL');
+    }
+    catch (e) {
+        (0, exports.logWarn)('Your browser may not support webGL');
+        flag = false;
+    }
+    return flag;
+}
+exports.isSupportWebGL = isSupportWebGL;
+/**
+ * @ignore
+ */
+function getContextByCanvas(
+// eslint-disable-next-line auto-import/auto-import
+canvas) {
+    const contextNames = ['webgl2', 'webgl', 'experimental-webgl'];
+    for (const contextName of contextNames) {
+        //@ts-ignore
+        const context = canvas.getContext(contextName, {
+            depth: true,
+            stencil: true,
+            alpha: false,
+            antialias: false,
+            premultipliedAlpha: true,
+            preserveDrawingBuffer: true,
+            powerPreference: 'default',
+            failIfMajorPerformanceCaveat: false,
+        });
+        if (context) {
+            return context;
+        }
+    }
+    return null;
+}
+exports.getContextByCanvas = getContextByCanvas;
+/**
+ * @ignore
+ */
+exports.AgoraEnv = {
+    enableLogging: true,
+    enableDebugLogging: false,
+    webEnvReady: true,
+    enableWebCodecsDecoder: false,
+    encodeAlpha: false,
+    videoFallbackStrategy: Types_1.VideoFallbackStrategy.PerformancePriority,
+    maxDecodeRetryCount: 50,
+};

package/package.json

@@ -0,0 +1,167 @@
+{
+  "name": "agora-electron-sdk",
+  "version": "0.0.0-dev.1",
+  "description": "agora-electron-sdk",
+  "main": "js/AgoraSdk",
+  "types": "types/AgoraSdk.d.ts",
+  "source": "ts/AgoraSdk",
+  "files": [
+    "js",
+    "ts",
+    "types",
+    "scripts",
+    "!scripts/terra",
+    "!scripts/publishCN",
+    "!scripts/internal",
+    "gulpfile.js",
+    "CHANGELOG.md",
+    "!**/__tests__"
+  ],
+  "scripts": {
+    "postinstall": "npm run checkElectron",
+    "totalBuild": "cross-env-shell gulp totalBuild \\\"--INIT_CWD=$INIT_CWD\\\"",
+    "build": "cross-env-shell gulp build \\\"--INIT_CWD=$INIT_CWD\\\"",
+    "clean": "cross-env-shell gulp clean \\\"--INIT_CWD=$INIT_CWD\\\"",
+    "checkElectron": "cross-env-shell gulp checkElectron \\\"--INIT_CWD=$INIT_CWD\\\"",
+    "syncLib": "cross-env-shell gulp syncLib \\\"--INIT_CWD=$INIT_CWD\\\"",
+    "buildJS": "cross-env-shell gulp buildJS \\\"--INIT_CWD=$INIT_CWD\\\"",
+    "zipBuild": "cross-env-shell gulp zipBuild \\\"--INIT_CWD=$INIT_CWD\\\"",
+    "prepack": "cross-env-shell npm run buildJS \\\"--INIT_CWD=$INIT_CWD\\\"",
+    "build_mac_debug": "cmake-js rebuild --CDCMAKE_BUILD_TYPE=Debug --CDCMAKE_OSX_ARCHITECTURES=\"arm64;x86_64\" -G Xcode",
+    "build_mac_release": "cmake-js rebuild --CDCMAKE_BUILD_TYPE=Release --CDCMAKE_OSX_ARCHITECTURES=\"arm64;x86_64\" -G Xcode",
+    "build_windows_win32_debug": "cmake-js rebuild --arch=ia32 --CDCMAKE_OSX_ARCHITECTURES=\"i386\" --CDCMAKE_BUILD_TYPE=Debug -G \"Visual Studio 16 2019\" ",
+    "build_windows_win32_release": "cmake-js rebuild --arch=ia32 --CDCMAKE_OSX_ARCHITECTURES=\"i386\" --CDCMAKE_BUILD_TYPE=Release",
+    "build_windows_x64_debug": "cmake-js rebuild --arch=x64 --CDCMAKE_OSX_ARCHITECTURES=\"x86_64\" --CDCMAKE_BUILD_TYPE=Debug -G \"Visual Studio 16 2019\"",
+    "build_windows_x64_release": "cmake-js rebuild --arch=x64 --CDCMAKE_OSX_ARCHITECTURES=\"x86_64\" --CDCMAKE_BUILD_TYPE=Release",
+    "build_linux_debug": "cmake-js rebuild --arch=x64 --CDCMAKE_BUILD_TYPE=Debug -G \"Unix Makefiles\"",
+    "build_linux_release": "cmake-js rebuild --arch=x64 --CDCMAKE_BUILD_TYPE=Release -G \"Unix Makefiles\"",
+    "test": "jest",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "install": "cross-env-shell gulp NPM_Install \\\"--INIT_CWD=$INIT_CWD\\\"",
+    "release": "release-it",
+    "example": "yarn --cwd example",
+    "example:prepare": "yarn example && cross-env-shell gulp checkElectron \\\"--INIT_CWD=$INIT_CWD/example\\\" \"--electron_path=$INIT_CWD/example/node_modules/electron/dist\"",
+    "bootstrap": "yarn config set agora-electron-sdk-pre-built 0 && yarn example && yarn install && yarn patch-package && yarn build:ts-interface && yarn totalBuild && yarn link && yarn example link agora-electron-sdk && yarn config delete agora-electron-sdk-pre-built && yarn example:prepare",
+    "build:ts-interface": "ts-interface-builder ts/Private/*.ts -o ts/Private/ti/"
+  },
+  "keywords": [
+    "electron",
+    "windows",
+    "mac"
+  ],
+  "repository": "https://github.com/AgoraIO-Extensions/Electron-SDK",
+  "author": "Agora.io",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/AgoraIO-Extensions/Electron-SDK/issues"
+  },
+  "homepage": "https://github.com/AgoraIO-Extensions/Electron-SDK#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@babel/preset-env": "^7.21.5",
+    "@babel/preset-typescript": "^7.21.5",
+    "@commitlint/config-conventional": "^17.0.2",
+    "@evilmartians/lefthook": "^1.2.2",
+    "@release-it/conventional-changelog": "^5.0.0",
+    "@types/dom-webcodecs": "^0.1.11",
+    "@types/node": "^22.8.2",
+    "@types/jest": "^28.1.2",
+    "@types/json-bigint": "^1.0.1",
+    "@types/lodash.isequal": "^4.5.6",
+    "@typescript-eslint/eslint-plugin": "^5.30.5",
+    "@typescript-eslint/parser": "^5.30.5",
+    "cmake-js": "6.3.2",
+    "commitlint": "^17.0.2",
+    "eslint": "^8.4.1",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-auto-import": "^0.1.1",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jest": "^26.9.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-react": "^7.30.1",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "gulp-zip": "^5.1.0",
+    "jest": "^28.1.1",
+    "patch-package": "^6.5.0",
+    "prettier": "^2.0.5",
+    "release-it": "^15.0.0",
+    "ts-interface-builder": "^0.3.3",
+    "typescript": "^4.5.2"
+  },
+  "engines": {
+    "node": ">= 14.0.0"
+  },
+  "jest": {
+    "setupFilesAfterEnv": [
+      "<rootDir>/ts/__tests__/setup.ts"
+    ],
+    "modulePathIgnorePatterns": [
+      "<rootDir>/ts/__tests__/setup.ts",
+      "<rootDir>/example/node_modules",
+      "<rootDir>/js/",
+      "<rootDir>/types/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": "angular",
+        "infile": "CHANGELOG.md"
+      }
+    }
+  },
+  "dependencies": {
+    "buffer": "^6.0.3",
+    "cross-env": "^7.0.3",
+    "node-fetch": "^2.7.0",
+    "extract-zip": "^2.0.1",
+    "eventemitter3": "^5.0.1",
+    "fs-extra": "^11.1.1",
+    "gulp": "^5.0.0",
+    "json-bigint": "^1.0.0",
+    "jsonfile": "^6.1.0",
+    "lodash.isequal": "^4.5.0",
+    "minimist": "^1.2.8",
+    "shelljs": "^0.8.5",
+    "semver": "^7.6.0",
+    "ts-interface-checker": "^1.0.2",
+    "winston": "^3.11.0",
+    "yuv-buffer": "1.0.0",
+    "yuv-canvas": "1.2.6",
+    "archive-type": "^4.0.0",
+    "content-disposition": "^0.5.2",
+    "decompress": "^4.2.1",
+    "ext-name": "^5.0.0",
+    "file-type": "^11.1.0",
+    "filenamify": "^3.0.0",
+    "get-stream": "^4.1.0",
+    "got": "^11.8.5",
+    "make-dir": "^5.0.0",
+    "p-event": "^2.1.0",
+    "pify": "^4.0.1"
+  },
+  "agora_electron": {
+    "iris_sdk_win": "https://download.agora.io/sdk/release/iris_4.5.1-build.1_DCG_Windows_Video_Standalone_20250305_1103_622.zip",
+    "iris_sdk_mac": "https://download.agora.io/sdk/release/iris_4.5.1-build.1_DCG_Mac_Video_Standalone_20250305_1105_590.zip",
+    "native_sdk_win": "https://download.agora.io/sdk/release/Agora_Native_SDK_for_Windows_v4.5.1_FULL.zip",
+    "native_sdk_mac": "https://download.agora.io/sdk/release/Agora_Native_SDK_for_Mac_v4.5.1_FULL.zip"
+  }
+}

package/scripts/bootstrap.js

@@ -0,0 +1,29 @@
+const child_process = require('child_process');
+const os = require('os');
+const path = require('path');
+
+const root = path.resolve(__dirname, '..');
+const args = process.argv.slice(2);
+const options = {
+  cwd: process.cwd(),
+  env: process.env,
+  stdio: 'inherit',
+  encoding: 'utf-8',
+};
+
+if (os.type() === 'Windows_NT') {
+  options.shell = true;
+}
+
+let result;
+
+if (process.cwd() !== root || args.length) {
+  // We're not in the root of the project, or additional arguments were passed
+  // In this case, forward the command to `yarn`
+  result = child_process.spawnSync('yarn', args, options);
+} else {
+  // If `yarn` is run without arguments, perform bootstrap
+  result = child_process.spawnSync('yarn', ['bootstrap'], options);
+}
+
+process.exitCode = result.status;

package/scripts/build.js

@@ -0,0 +1,37 @@
+const { exec, error } = require('shelljs');
+
+const getConfig = require('./getConfig');
+const logger = require('./logger');
+const { getOS } = require('./util');
+
+const { debug, arch } = getConfig();
+
+const build = async (cb) => {
+  let scriptStr;
+  switch (getOS()) {
+    case 'mac':
+      scriptStr = debug ? 'build_mac_debug' : 'build_mac_release';
+      break;
+    case 'win32':
+      if (arch === 'x64') {
+        scriptStr = debug
+          ? 'build_windows_x64_debug'
+          : 'build_windows_x64_release';
+      } else {
+        scriptStr = debug
+          ? 'build_windows_win32_debug'
+          : 'build_windows_win32_release';
+      }
+      break;
+    default:
+      break;
+  }
+  scriptStr = `npm run ${scriptStr}`;
+  logger.info(`Will to run: ${scriptStr}`);
+  await exec(scriptStr, { silent: false });
+  const err = error();
+  if (err) throw err;
+  cb();
+};
+
+module.exports = build;

package/scripts/buildJS.js

@@ -0,0 +1,14 @@
+const { exec } = require('shelljs');
+
+const { cleanDir, typesDir, jsDir } = require('./clean');
+const logger = require('./logger');
+
+const buildJS = async (cb) => {
+  logger.info('Build js from typescript');
+  await cleanDir(jsDir);
+  await cleanDir(typesDir);
+  await exec('tsc -p tsconfig.build.json', { silent: false });
+  cb();
+};
+
+module.exports = buildJS;

package/scripts/checkElectron.js

@@ -0,0 +1,43 @@
+const path = require('path');
+
+const { cleanDir } = require('./clean');
+const download = require('./download');
+
+const getConfig = require('./getConfig');
+const logger = require('./logger');
+
+const config = getConfig();
+const { electron_version, arch, platform } = config;
+let { electron_path } = config;
+const checkElectron = async (cb) => {
+  logger.info(`start sync electron`);
+  if (!electron_version || platform !== 'darwin') {
+    cb();
+    logger.info('electron_version is not set or os is not mac, skip sync');
+    return;
+  }
+
+  if (!electron_path) {
+    try {
+      electron_path = require.resolve('electron');
+    } catch (error) {
+      logger.info('Electron is not installed, skip sync');
+      cb();
+      return;
+    }
+  }
+  let tp = path.join(electron_path, `../dist`);
+  let downloadUrl = `https://download.agora.io/sdk/release/electron-v${electron_version}-${platform}-${arch}.zip`;
+  logger.info(`Downloading:${downloadUrl}`);
+  await cleanDir(tp);
+
+  await download(downloadUrl, tp, {
+    extract: true,
+  });
+
+  logger.info(`Finish download:${downloadUrl}`);
+  logger.info(`sync electron success`);
+  cb();
+};
+
+module.exports = checkElectron;

package/scripts/clean.js

@@ -0,0 +1,16 @@
+const path = require('path');
+
+const fs = require('fs-extra');
+
+const logger = require('./logger');
+
+exports.destIrisSDKDir = path.join(__dirname, `../iris`);
+exports.destNativeSDKDir = path.join(__dirname, `../native`);
+exports.buildDir = path.resolve(__dirname, '../build');
+exports.jsDir = path.resolve(__dirname, '../js');
+exports.typesDir = path.resolve(__dirname, '../types');
+
+exports.cleanDir = async (dir) => {
+  await fs.remove(dir);
+  logger.info(`clean:${dir}`);
+};