@4players/odin-plugin-web 1.0.0-alpha.13 → 1.0.0-alpha.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4players/odin-plugin-web",
-  "version": "1.0.0-alpha.13",
+  "version": "1.0.0-alpha.15",
   "description": "A backend plugin providing the custom WebAssembly audio processing module for ODIN web clients",
   "homepage": "https://www.4players.io",
   "repository": {
@@ -11,36 +11,43 @@
   "main": "./lib/plugin/index.js",
   "types": "./lib/plugin/index.d.ts",
   "scripts": {
-    "clean": "rm -rf build lib",
+    "clean": "rimraf build lib",
     "configure": "npm-run-all -pl configure:*",
     "configure:shared": "emcmake cmake -B build/shared -DCMAKE_BUILD_TYPE=Release -DSHARED_MEMORY=1 -S .",
     "configure:unshared": "emcmake cmake -B build/unshared -DCMAKE_BUILD_TYPE=Release -S .",
-    "build": "npm-run-all -s configure build:wasm build:plugin build:worker",
+    "build": "npm-run-all -s configure build:genversion build:wasm build:plugin build:worker",
+    "build:genversion": "genversion -se src/version.ts",
     "build:wasm": "npm-run-all -pl build:wasm:* && node install-wasm.js",
     "build:wasm:shared": "emmake cmake --build build/shared",
     "build:wasm:unshared": "emmake cmake --build build/unshared",
     "build:worker": "ts-node src/build.ts && tsc -b ./tsconfig.worker.json",
-    "build:plugin": "tsc",
+    "build:plugin": "tsc --build --verbose --force",
     "format": "prettier 'src/**/*.ts' --write",
     "lint": "eslint . --ext .ts",
-    "test": "npm --prefix test run serve"
+    "test": "npm --prefix test run start",
+    "bundle": "npm run build && esbuild lib/plugin/index.js --bundle --outfile=dist/plugin.js"
   },
   "dependencies": {
-    "@4players/odin-common": "~1.7.0"
+    "@4players/odin-common": "~2.4.12"
   },
   "devDependencies": {
-    "@types/node": "~20.11.0",
-    "@typescript-eslint/eslint-plugin": "~7.2.0",
-    "@typescript-eslint/parser": "~7.2.0",
-    "esbuild": "~0.20.0",
+    "@types/node": "~20.12.0",
+    "@typescript-eslint/eslint-plugin": "~7.7.0",
+    "@typescript-eslint/parser": "~7.7.0",
+    "esbuild": "^0.20.2",
     "eslint": "~8.57.0",
     "eslint-config-semistandard": "~17.0.0",
     "eslint-plugin-import": "~2.29.0",
     "eslint-plugin-node": "~11.1.0",
     "eslint-plugin-promise": "~6.1.0",
+    "genversion": "^3.2.0",
     "npm-run-all2": "~6.1.0",
     "prettier": "~3.2.0",
+    "rimraf": "~5.0.0",
     "ts-node": "~10.9.0",
-    "typescript": "~5.3.0"
+    "typescript": "~5.4.0"
+  },
+  "peerDependencies": {
+    "zod": "*"
   }
 }

package/lib/plugin/audioController.js

@@ -1,513 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { Strand, assert, failure, sleep, success, } from '@4players/odin-common';
-import { createCaptureWorker, createPlaybackWorker } from '../worker';
-import { Silence, } from '../worker/common';
-const defaultVad = {
-    voiceActivity: {
-        attackThreshold: 0.9,
-        releaseThreshold: 0.8,
-    },
-    volumeGate: {
-        attackThreshold: -30,
-        releaseThreshold: -40,
-    },
-};
-const defaultApm = {
-    echoCanceller: false,
-    highPassFilter: false,
-    preAmplifier: false,
-    captureLevelAdjustment: false,
-    noiseSuppression: 'None',
-    transientSuppressor: false,
-    gainController: false,
-};
-export class AudioContextCollection {
-    constructor(audioContextFactory) {
-        this.audioContextFactory = audioContextFactory;
-        this.entries = [];
-    }
-    acquire(sampleRate) {
-        return __awaiter(this, void 0, void 0, function* () {
-            for (const entry of this.entries) {
-                if (entry.sampleRate === sampleRate) {
-                    entry.references += 1;
-                    return entry.audioContext;
-                }
-                else if (entry.sampleRate === undefined) {
-                    const audioContext = entry.audioContext;
-                    if (audioContext.sampleRate === sampleRate) {
-                        entry.references += 1;
-                        return entry.audioContext;
-                    }
-                }
-            }
-            const entry = {
-                sampleRate,
-                audioContext: yield this.audioContextFactory(sampleRate),
-                references: 1,
-            };
-            this.entries.push(entry);
-            return entry.audioContext;
-        });
-    }
-    release(audioContext) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const index = this.entries.findIndex((entry) => entry.audioContext === audioContext);
-            if (index < 0)
-                return;
-            this.entries[index].references -= 1;
-            if (this.entries[index].references <= 0) {
-                const context = this.entries[index].audioContext;
-                this.entries.splice(index, 1);
-                yield context.close();
-            }
-        });
-    }
-    close() {
-        for (const entry of this.entries) {
-            entry.audioContext.close();
-        }
-    }
-}
-let hasAudioPermissions = false;
-export class AudioController {
-    create(audioContexts, sink) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return new AudioController(audioContexts, sink);
-        });
-    }
-    constructor(audioContexts, sink) {
-        this.audioContexts = audioContexts;
-        this.sink = sink;
-        this.globalVolume = 1;
-        this.playbacks = new Map();
-        this.setPlaybackStrand = new Strand();
-    }
-    receivePacket(connectionId, packet) {
-        var _a;
-        (_a = this.playbackWorker) === null || _a === void 0 ? void 0 : _a.receivePacket(connectionId, packet);
-    }
-    createAudioPlayback(parameters) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let entry = this.playbacks.get(parameters.uid);
-            let volume = parameters.volume;
-            if (entry === undefined) {
-                volume = volume !== null && volume !== void 0 ? volume : 1;
-                const playback = new AudioPlayback(this, parameters.uid);
-                entry = { id: undefined, volume, playback };
-                this.playbacks.set(parameters.uid, entry);
-            }
-            if (volume !== undefined) {
-                entry.playback.setVolume(volume);
-            }
-            return entry.playback;
-        });
-    }
-    createAudioCapture(parameters) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const capture = new AudioCapture(this, parameters);
-            yield capture.setDevice(parameters);
-            return capture;
-        });
-    }
-    enumerateDevices() {
-        return __awaiter(this, void 0, void 0, function* () {
-            hasAudioPermissions = yield this._requestMediaPermissions();
-            const mediaDeviceInfos = yield navigator.mediaDevices.enumerateDevices();
-            const devices = [];
-            let outputDeviceIndex = 0;
-            let inputDeviceIndex = 0;
-            for (const mediaDeviceInfo of mediaDeviceInfos) {
-                if (mediaDeviceInfo.kind === 'audioinput') {
-                    if (inputDeviceIndex === 0) {
-                        devices.push(new Device(mediaDeviceInfo, true));
-                    }
-                    else {
-                        devices.push(new Device(mediaDeviceInfo, false));
-                    }
-                    inputDeviceIndex++;
-                }
-                if (mediaDeviceInfo.kind === 'audiooutput') {
-                    if (outputDeviceIndex === 0) {
-                        devices.push(new Device(mediaDeviceInfo, true));
-                    }
-                    else {
-                        devices.push(new Device(mediaDeviceInfo, false));
-                    }
-                    outputDeviceIndex++;
-                }
-            }
-            return devices;
-        });
-    }
-    /**
-     * Requests audio and video browser permissions. Optionally, requests either audio or video permissions.
-     * @private
-     * @throws
-     */
-    _requestMediaPermissions() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (hasAudioPermissions)
-                return true;
-            const constraints = {};
-            constraints.audio = {
-                sampleRate: undefined,
-                deviceId: '',
-                autoGainControl: false,
-                noiseSuppression: false,
-                advanced: undefined,
-                aspectRatio: undefined,
-                echoCancellation: false,
-                channelCount: 0,
-                facingMode: undefined,
-                frameRate: 0,
-            };
-            console.log('Plugin _requestMediaPermissions: ', constraints);
-            try {
-                const ms = yield navigator.mediaDevices.getUserMedia(constraints);
-                ms === null || ms === void 0 ? void 0 : ms.getTracks().forEach((track) => {
-                    track.stop();
-                    ms.removeTrack(track);
-                });
-            }
-            catch (e) {
-                console.error(`Requesting permissions for ${'audio'} failed.`);
-                console.error(e);
-                return false;
-            }
-            return true;
-        });
-    }
-    playbackSetDevice(device) {
-        return this.setPlaybackStrand.enqueue(() => __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            let deviceId = (_a = device === null || device === void 0 ? void 0 : device.device.deviceId) !== null && _a !== void 0 ? _a : '';
-            if (deviceId === 'default') {
-                deviceId = '';
-            }
-            let audioContext;
-            if (this.playbackWorker === undefined) {
-                audioContext = yield this.audioContexts.acquire(48000);
-                console.log('playbackSetDevice: this.audioContexts.acquire(48000)');
-                this.playbackWorker = yield createPlaybackWorker(audioContext);
-                this.playbackWorker.setGlobalVolume(this.globalVolume);
-            }
-            else {
-                console.log('this.playbackWorker.audioContext');
-                audioContext = this.playbackWorker.audioContext;
-            }
-            console.log('playbackSetDevice audioContext: ', audioContext);
-            if ((audioContext === null || audioContext === void 0 ? void 0 : audioContext.setSinkId) !== undefined &&
-                device &&
-                (audioContext === null || audioContext === void 0 ? void 0 : audioContext.state) === 'running') {
-                console.log('Browser audioContext.setSinkId');
-                yield audioContext.setSinkId(deviceId);
-            }
-        }));
-    }
-    playbackSetGlobalVolume(value) {
-        var _a;
-        this.globalVolume = value === 'muted' ? 0 : value;
-        (_a = this.playbackWorker) === null || _a === void 0 ? void 0 : _a.setGlobalVolume(this.globalVolume);
-    }
-    playbackStart(uid, id) {
-        var _a;
-        const entry = this.playbacks.get(uid);
-        if (entry === undefined)
-            return;
-        if (entry.id !== undefined) {
-            this.playbackStop(uid, entry.id);
-        }
-        entry.id = id;
-        (_a = this.playbackWorker) === null || _a === void 0 ? void 0 : _a.addMedias(id.connectionId, [id.mediaId]);
-        this.playbackSetVolume(uid, entry.volume);
-    }
-    playbackStop(uid, id) {
-        var _a;
-        const entry = this.playbacks.get(uid);
-        if (entry === undefined)
-            return;
-        if (entry.id !== id)
-            console.error('playback mediaId out of sync!');
-        entry.id = undefined;
-        (_a = this.playbackWorker) === null || _a === void 0 ? void 0 : _a.removeMedias(id.connectionId, [id.mediaId]);
-    }
-    playbackGetActivity(uid) {
-        var _a, _b;
-        const entry = this.playbacks.get(uid);
-        if ((entry === null || entry === void 0 ? void 0 : entry.id) === undefined)
-            return Silence;
-        return (_b = (_a = this.playbackWorker) === null || _a === void 0 ? void 0 : _a.getActivity(entry.id)) !== null && _b !== void 0 ? _b : Silence;
-    }
-    playbackSetVolume(uid, volume) {
-        var _a;
-        const entry = this.playbacks.get(uid);
-        if (entry === undefined)
-            return;
-        entry.volume = volume === 'muted' ? 0 : volume;
-        if (entry.id !== undefined) {
-            (_a = this.playbackWorker) === null || _a === void 0 ? void 0 : _a.setVolume(entry.id, entry.volume);
-        }
-    }
-    playbackGetVolume(uid) {
-        var _a;
-        const entry = this.playbacks.get(uid);
-        return (_a = entry === null || entry === void 0 ? void 0 : entry.volume) !== null && _a !== void 0 ? _a : 1;
-    }
-    closePlayback(uid) {
-        const entry = this.playbacks.get(uid);
-        if (entry === undefined)
-            return;
-        if (entry.id !== undefined)
-            this.playbackStop(uid, entry.id);
-        this.playbacks.delete(uid);
-    }
-    close() {
-        var _a;
-        (_a = this.playbackWorker) === null || _a === void 0 ? void 0 : _a.close();
-        this.audioContexts.close();
-    }
-}
-export class Device {
-    constructor(device, isDefault = false) {
-        this.device = device;
-        this.isDefault = isDefault;
-    }
-    get type() {
-        switch (this.device.kind) {
-            case 'audioinput':
-                return 'AudioCapture';
-            case 'audiooutput':
-                return 'AudioPlayback';
-            default:
-                assert(false, 'not supported device');
-        }
-    }
-    get name() {
-        return this.device.label;
-    }
-}
-export class AudioPlayback {
-    get volume() {
-        return this.controller.playbackGetVolume(this.uid);
-    }
-    get activity() {
-        return this.controller.playbackGetActivity(this.uid);
-    }
-    constructor(controller, uid) {
-        this.controller = controller;
-        this.uid = uid;
-    }
-    start(id) {
-        this.controller.playbackStart(this.uid, id);
-    }
-    stop(id) {
-        this.controller.playbackStop(this.uid, id);
-    }
-    setVolume(value) {
-        this.controller.playbackSetVolume(this.uid, value);
-    }
-    close() {
-        this.controller.closePlayback(this.uid);
-    }
-}
-export class AudioCapture {
-    get vad() {
-        return this._Vad;
-    }
-    get apm() {
-        return this._Apm;
-    }
-    get volume() {
-        return this._Volume;
-    }
-    get activity() {
-        var _a, _b;
-        return (_b = (_a = this._Capture) === null || _a === void 0 ? void 0 : _a.worker.activity) !== null && _b !== void 0 ? _b : Silence;
-    }
-    get speechProbability() {
-        var _a, _b;
-        return (_b = (_a = this._Capture) === null || _a === void 0 ? void 0 : _a.worker.speechProbability) !== null && _b !== void 0 ? _b : 0;
-    }
-    get deviceId() {
-        var _a, _b;
-        return (_b = (_a = this._deviceParameters) === null || _a === void 0 ? void 0 : _a.device) === null || _b === void 0 ? void 0 : _b.device.deviceId;
-    }
-    constructor(controller, parameters) {
-        this.controller = controller;
-        this._Medias = new Map();
-        this._Vad = defaultVad;
-        this._Apm = defaultApm;
-        this._Volume = 1;
-        if (parameters.apm) {
-            this.setApm(parameters.apm);
-        }
-        if (parameters.vad) {
-            this.setVad(parameters.vad);
-        }
-        if (parameters.volume) {
-            this.setVolume(parameters.volume);
-        }
-    }
-    start(room, media, uid) {
-        var _a;
-        let entry = this._Medias.get(media.connectionId);
-        if (entry === undefined) {
-            this._Medias.set(media.connectionId, (entry = new Set()));
-        }
-        if (entry.has(media.mediaId))
-            return;
-        entry.add(media.mediaId);
-        if (((_a = room.mainConnection) === null || _a === void 0 ? void 0 : _a.id) === media.connectionId) {
-            room
-                .typedRequest('StartMedia', {
-                media_id: media.mediaId,
-                properties: { kind: 'audio', uid },
-            })
-                .catch((reason) => console.error(`StartMedia got rejected; ${reason}`));
-        }
-        this._UpdateMedias();
-    }
-    stop(room, media) {
-        var _a;
-        const entry = this._Medias.get(media.connectionId);
-        if (!(entry === null || entry === void 0 ? void 0 : entry.delete(media.mediaId)))
-            return;
-        if (((_a = room.mainConnection) === null || _a === void 0 ? void 0 : _a.id) === media.connectionId) {
-            room
-                .typedRequest('StopMedia', { media_id: media.mediaId })
-                .catch((reason) => console.error(`StopMedia got rejected; ${reason}`));
-        }
-        this._UpdateMedias();
-    }
-    setVad(value) {
-        this._Vad = value;
-        if (this._Capture) {
-            this._Capture.worker.setVad(value);
-        }
-    }
-    setApm(config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this._Apm = config;
-            if (this._deviceParameters) {
-                yield this.setDevice(this._deviceParameters);
-            }
-        });
-    }
-    setDevice(parameters) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            const rollbackParams = this._deviceParameters;
-            this._deviceParameters = parameters;
-            if (this._Volume === 'muted') {
-                return;
-            }
-            const device = yield openCaptureDevice(this.controller, parameters, this._Apm);
-            if (device.type !== 'Success') {
-                console.error(`unable to open capture device; ${device.reason}`);
-                this._deviceParameters = rollbackParams;
-                return;
-            }
-            if (this._Capture !== undefined) {
-                stopMediaStream(this._Capture.source.mediaStream);
-                this._Capture.source.disconnect(this._Capture.worker.worklet);
-            }
-            if (this._Capture === undefined ||
-                this._Capture.worker.worklet.context !== device.value.context) {
-                (_a = this._Capture) === null || _a === void 0 ? void 0 : _a.worker.close();
-                this._Capture = {
-                    worker: yield createCaptureWorker(device.value.context, this.controller.sink),
-                    source: device.value,
-                };
-                yield this._UpdateMedias();
-                this.setVolume(this.volume);
-                this.setVad(this.vad);
-            }
-            else {
-                this._Capture.source = device.value;
-            }
-            this._Capture.source.connect(this._Capture.worker.worklet);
-            return success();
-        });
-    }
-    setVolume(value) {
-        var _a;
-        this._Volume = value;
-        if (value === 'muted') {
-            this.close();
-        }
-        else {
-            if (!this._Capture && this._deviceParameters) {
-                this.setDevice(this._deviceParameters);
-            }
-            (_a = this._Capture) === null || _a === void 0 ? void 0 : _a.worker.setVolume(value);
-        }
-    }
-    close() {
-        if (this._Capture !== undefined) {
-            this._Capture.worker.close();
-            stopMediaStream(this._Capture.source.mediaStream);
-            this._Capture.source.disconnect(this._Capture.worker.worklet);
-            this.controller.audioContexts.release(this._Capture.source.context);
-        }
-        this._Capture = undefined;
-    }
-    _UpdateMedias() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this._Capture !== undefined) {
-                const connections = Array.from(this._Medias).map(([key, value]) => {
-                    return { id: key, mediaIds: Array.from(value) };
-                });
-                this._Capture.worker.setMedias(connections);
-            }
-        });
-    }
-}
-function stopMediaStream(ms) {
-    ms.getTracks().forEach((track) => {
-        track.stop();
-        ms.removeTrack(track);
-    });
-}
-function openCaptureDevice(controller, parameters, apm) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const deviceId = parameters.device
-            ? { exact: parameters.device.device.deviceId }
-            : undefined;
-        let stream;
-        try {
-            const result = yield Promise.race([
-                navigator.mediaDevices.getUserMedia({
-                    audio: {
-                        echoCancellation: apm.echoCanceller,
-                        noiseSuppression: apm.noiseSuppression !== 'None',
-                        autoGainControl: apm.gainController,
-                        // @ts-ignore chrome fix
-                        echoCancellationType: 'system',
-                        // sampleRate: 48000,
-                        deviceId,
-                    },
-                }),
-                sleep(30000, 'timeout'),
-            ]);
-            if (result === 'timeout')
-                return failure('getUserMedia; timeout');
-            hasAudioPermissions = true;
-            stream = result;
-        }
-        catch (reason) {
-            return failure(`getUserMedia; ${reason}`);
-        }
-        const sampleRate = stream.getAudioTracks()[0].getSettings().sampleRate;
-        const context = yield controller.audioContexts.acquire(sampleRate);
-        return success(context.createMediaStreamSource(stream));
-    });
-}